AWS transfer: Document host key storage choice and service-linked role for SFTP servers
Summary
Updates the SFTP server creation steps to require choosing a host key storage type (AWS Secrets Manager default or Service managed), explains that host key material is optional and auto-generated if omitted, describes use of the AWSServiceRoleForTransfer service-linked role to access the secret, and rewords the PROXY protocol note to preserve the client's source IP address.
Security assessment
The change documents secure storage of SFTP host key material in Secrets Manager and the IAM service-linked role used to access it, plus preserving client source IPs via PROXY protocol; this is hardening/configuration guidance with security impact, not a specific vulnerability fix.
Evidence
+When you choose **AWS Secrets Manager** storage, Transfer Family stores the host key in a Secrets Manager secret. Transfer Family uses the AWSServiceRoleForTransfer service-linked role to access the secret. If this role doesn't already exist in your account, Transfer Family creates it for you. For more information, see [Using service-linked roles for AWS Transfer Family](./using-service-linked-roles.html).
Diff
diff --git a/transfer/latest/userguide/create-server-sftp.md b/transfer/latest/userguide/create-server-sftp.md index f2b6024..033e855 100644 --- a//transfer/latest/userguide/create-server-sftp.md +++ b//transfer/latest/userguide/create-server-sftp.md @@ -103 +103,3 @@ If you choose **Create log group** , the CloudWatch console ([https://console.aw - 4. (Optional) For **Server Host Key** , enter an RSA, ED25519, or ECDSA private key that will be used to identify your server when clients connect to it over SFTP. You can also add a description to differentiate among multiple host keys. + 4. For **Server Host Key** , choose where Transfer Family stores your host key material. Choose **AWS Secrets Manager** (the default) or **Service managed**. For more information about storage types, see [Store SFTP server host keys in AWS Secrets Manager](./server-host-key-storage.html). + +Providing host key material is optional. If you don't enter an RSA, ED25519, or ECDSA private key, Transfer Family generates a host key for you. To identify your server when clients connect to it over SFTP, you can enter your own private key. You can also add a description to differentiate among multiple host keys. @@ -109 +111 @@ After you create your server, you can add additional host keys. Having multiple -The **Server Host Key** section is used only for migrating users from an existing SFTP-enabled server. +When you choose **AWS Secrets Manager** storage, Transfer Family stores the host key in a Secrets Manager secret. Transfer Family uses the AWSServiceRoleForTransfer service-linked role to access the secret. If this role doesn't already exist in your account, Transfer Family creates it for you. For more information, see [Using service-linked roles for AWS Transfer Family](./using-service-linked-roles.html). @@ -131 +133 @@ When you create your server using the console, optimized directories is enabled - * **PROXY protocol configuration** : turn on this option to preserve source IP addresses if your server endpoint sits behind a Network Load Balancer (NLB) load balancer with PROXY protocol v2 (PPv2) enabled. For more information, see [Working with Network Load Balancers](./working-with-nlb.html) and `ProxyConfig` in the [ProtocolDetails](https://docs.aws.amazon.com/transfer/latest/APIReference/API_ProtocolDetails.html) API reference. + * **PROXY protocol configuration** : turn on this option to preserve the client's source IP address if your SFTP server sits behind a Network Load Balancer (NLB) with PROXY protocol v2 (PPv2) enabled. For more information, see [Working with Network Load Balancers](./working-with-nlb.html) and `ProxyConfig` in the [ProtocolDetails](https://docs.aws.amazon.com/transfer/latest/APIReference/API_ProtocolDetails.html) API reference.