Skip to content

Commit

Permalink
adding def for secure credential store
Browse files Browse the repository at this point in the history
Signed-off-by: anaxceron <[email protected]>
  • Loading branch information
anaxceron committed Jan 5, 2024
1 parent 0e8f566 commit 6a73500
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 11 deletions.
6 changes: 6 additions & 0 deletions docs/appendix/zowe-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,12 @@ A more general term used to describe a modular piece of some component. Dependin

A component may have multiple plug-ins, sometimes working together to form a single purpose or user experience, but an individual plug-in belongs to a single component. See [extension](#extension) for additional context.

#### Secure credential store

Secret storage functionality embedded in core Zowe CLI starting from Zowe V2. Securely stores configured private credentials in the credential manager used by your computer's operating system.

A separate plug-in of the same name used in Zowe V1 CLI.

#### Service

A service provides one or more APIs, and is identified by a service ID. Note that sometimes the term *service name* can be used to mean *service ID*.
Expand Down
14 changes: 8 additions & 6 deletions docs/user-guide/cli-using-team-managing-credential-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Secure credential storage

With the introduction of team profiles in Zowe CLI V2, the **Secure Credential Store (SCS) Plug-in** is deprecated. The `zowe scs` command group is obsolete.
With the introduction of team profiles in Zowe CLI V2, the **secure credential store (SCS) Plug-in** is deprecated. The `zowe scs` command group is obsolete.

Secure credential encryption is now included with the Zowe CLI core application. When a command using a profile with missing `user` and `password` information is issued, Zowe CLI V2 prompts you to enter the username and password by default. To save secure properties and values in the Secure Credential Store, use the `zowe config` command group.
Secure credential encryption is now included with the Zowe CLI core application. When a command using a profile with missing `user` and `password` information is issued, Zowe CLI V2 prompts you to enter the username and password. Both are then stored securely by default.

For other ways to store credentials securely, use the `zowe config` command group. See the following instructions.

## Configuring secure properties

Expand Down Expand Up @@ -32,17 +34,17 @@ Create a configuration file and set its secure properties (such as usernames and
```
A configuration file is created, if one does not already exist.
Additionally, the `profiles.base.properties.user` and `profiles.base.properties.password` fields are added to the base profile `secure` array for that configuration file. This stores the username and password in the Secure Credential Store.
Additionally, the `profiles.base.properties.user` and `profiles.base.properties.password` fields are added to the base profile `secure` array for that configuration file. This stores the username and password in the [secure credential store](../appendix/zowe-glossary#secure-credential-store).
3. If needed, add other fields to the secure array.
- Use a text editor or an IDE (such as Visual Studio Code) to edit the configuration file.
- Issue the `zowe config set --secure <property-path>` command to secure a specific property in a specific profile.
For example, `zowe config set profiles.base.properties.password pw123 --secure` adds the `password` property to the base profile's `secure` array and saves the password `pw123` in the Secure Credential Store.
For example, `zowe config set profiles.base.properties.password pw123 --secure` adds the `password` property to the base profile's `secure` array and saves the password `pw123` in the secure credential store.
If you issue the command for a property that is already secured, the CLI prompts you to enter a new property value.
The values for these properties are saved in the Secure Credential Store.
The values for these properties are saved in the secure credential store.
## Updating secure properties
Expand Down Expand Up @@ -70,7 +72,7 @@ Update secure credentials in an existing config profile:
3. Respond to prompts as needed. Press `Enter` to leave the value unchanged.
New values are saved in the Secure Credential Store. After the last secure value is submitted, the user returns to the system command prompt.
New values are saved in the secure credential store. After the last secure value is submitted, the user returns to the system command prompt.
## Setting secure properties programmatically
Expand Down
8 changes: 3 additions & 5 deletions docs/user-guide/cli-using-using-team-profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To update a username or password:
3. Respond to prompts as needed. Press `Enter` to leave the value unchanged.
New values are saved in the Secure Credential Store. After the last secure value is submitted, the user returns to the system command prompt.
New values are saved in the [secure credential store](../appendix/zowe-glossary#secure-credential-store). After the last secure value is submitted, the user returns to the system command prompt.
For more ways to secure credentials in config profiles, see [Managing credential security](../user-guide/cli-using-team-managing-credential-security).
Expand All @@ -65,7 +65,7 @@ Consider the following benefits of using team profiles:
## Important information about team profiles
With the introduction of team profiles, the Secure Credential Store (SCS) Plug-in is deprecated. Secure credential encryption is now handled by the the secure array in the `zowe.config.json` file.
With the introduction of team profiles, the secure credential store (SCS) Plug-in is deprecated. Secure credential encryption is now handled by the the secure array in the `zowe.config.json` file.
You can convert all of your Zowe CLI and Zowe CLI plug-ins V1 profiles to team profiles by issuing the following command:
Expand All @@ -82,6 +82,4 @@ You can continue using Zowe CLI V1 profiles with Zowe CLI V2. However, we highly
- Commands in the `zowe config` [command group](../user-guide/cli-using-understanding-core-command-groups#config) now let you manage security for any option value.
- The `zowe scs` and `zowe config` command groups were repurposed to work with team profiles.
- Zowe CLI V2 prompts you to enter the username and password securely by default.
- Zowe CLI V2 prompts you to enter the username and password securely by default.

0 comments on commit 6a73500

Please sign in to comment.