AWS transfer documentation change
Summary
Updated secret creation procedure with clearer instructions for private key/password storage, added SSH key generation reference, and renumbered steps
Security assessment
Changes clarify secure handling of credentials through Secrets Manager but do not address a specific security vulnerability. Focuses on proper secret management practices.
Diff
diff --git a/transfer/latest/userguide/sftp-connector-secret-procedure.md b/transfer/latest/userguide/sftp-connector-secret-procedure.md index 109caa1bf..1422edbb6 100644 --- a//transfer/latest/userguide/sftp-connector-secret-procedure.md +++ b//transfer/latest/userguide/sftp-connector-secret-procedure.md @@ -23 +23,3 @@ When you store secrets in Secrets Manager, your AWS account incurs charges. For - 5. In the **Key/value pairs** section, choose the **Key/value** tab. + 5. Provide the key/value information for your secret: you need to provide the username, and either a private key or a password. + + 1. In the **Key/value pairs** section, choose the **Key/value** tab. @@ -27 +29 @@ When you store secrets in Secrets Manager, your AWS account incurs charges. For - * **value** – Enter the name of the user that is authorized to connect to the partner' server. + * **value** – Enter the name of the user that is authorized to connect to the partner's server. @@ -29 +31 @@ When you store secrets in Secrets Manager, your AWS account incurs charges. For - 6. If you want to provide a password, choose **Add row** , and in the **Key/value pairs** section, choose the **Key/value** tab. + 2. If you want to provide a key pair, choose **Add row** , and in the **Key/value pairs** section, choose the **Key/value** tab. @@ -31 +33 @@ When you store secrets in Secrets Manager, your AWS account incurs charges. For -Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/value** tab. + * **Key** – Enter `PrivateKey`. @@ -33 +35 @@ Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/va - * **Key** – Enter `Password`. + * **value** – paste in your private key. @@ -35 +37 @@ Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/va - * **value** – Enter the password for the user. +**Tip** : The private key data that you enter must correspond to the public key that is stored for this user on the remote SFTP server. @@ -37 +39 @@ Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/va - 7. If you want to provide a private key, see [Generate and format the SFTP connector private key](./format-sftp-connector-key.html), which describes how to enter private key data. +For details on how to generate a public/private key pair, see [Creating SSH keys on macOS, Linux, or Unix](./macOS-linux-unix-ssh.html). @@ -39 +41 @@ Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/va -###### Note + 3. If you want to provide a password, choose **Add row** , and in the **Key/value pairs** section, choose the **Key/value** tab. @@ -41 +43,3 @@ Choose **Add row** , and in the **Key/value pairs** section, choose the **Key/va -The private key data that you enter must correspond to the public key that is stored for this user in the remote SFTP server. + * **Key** – Enter `Password`. + + * **value** – Enter the password for the user. @@ -43 +47 @@ The private key data that you enter must correspond to the public key that is st - 8. Choose **Next**. + 6. Choose **Next**. @@ -45 +49 @@ The private key data that you enter must correspond to the public key that is st - 9. On the **Configure secret** page, enter a name and description for your secret. We recommend that you use a prefix of `aws/transfer/` for the name. For example, you could name your secret `aws/transfer/connector-1`. + 7. On the **Configure secret** page, enter a name and description for your secret. We recommend that you use a prefix of `aws/transfer/` for the name. For example, you could name your secret `aws/transfer/connector-1`. @@ -47 +51 @@ The private key data that you enter must correspond to the public key that is st - 10. Choose **Next** , and then accept the defaults on the **Configure rotation** page. Then choose **Next**. + 8. Choose **Next** , and then accept the defaults on the **Configure rotation** page. Then choose **Next**. @@ -49 +53 @@ The private key data that you enter must correspond to the public key that is st - 11. On the **Review** page, choose **Store** to create and store the secret. + 9. On the **Review** page, choose **Store** to create and store the secret. @@ -62 +66 @@ Configure SFTP connectors -Generate and format the SFTP connector private key +Test an SFTP connector