AWS cloudhsm documentation change
Summary
Updated documentation to use placeholder syntax (<>) for admin usernames and file paths in commands
Security assessment
Changes demonstrate security best practices by using placeholders instead of hardcoded values, but do not address a specific known vulnerability
Diff
diff --git a/cloudhsm/latest/userguide/getting-started-setup-mtls.md b/cloudhsm/latest/userguide/getting-started-setup-mtls.md index 6237a833f..269ba65f8 100644 --- a/cloudhsm/latest/userguide/getting-started-setup-mtls.md +++ b/cloudhsm/latest/userguide/getting-started-setup-mtls.md @@ -105 +100 @@ Windows - aws-cloudhsm > login --username admin --role admin + aws-cloudhsm > login --username <admin> --role admin @@ -110 +105 @@ Windows - "username": "admin", + "username": "<admin>", @@ -252,2 +237,2 @@ PKCS #11 library - $ sudo cp ssl-client.pem /opt/cloudhsm/etc - $ sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.pem </opt/cloudhsm/etc> + $ sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -258,2 +243,2 @@ PKCS #11 library - --client-cert-hsm-tls-file /opt/cloudhsm/etc/ssl-client.pem \ - --client-key-hsm-tls-file /opt/cloudhsm/etc/ssl-client.key + --client-cert-hsm-tls-file </opt/cloudhsm/etc/ssl-client.pem> \ + --client-key-hsm-tls-file </opt/cloudhsm/etc/ssl-client.key> @@ -268,2 +253,2 @@ PKCS #11 library - cp ssl-client.pem C:\ProgramData\Amazon\CloudHSM\ssl-client.pem - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.pem <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -274,2 +259,2 @@ PKCS #11 library - --client-cert-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.pem ` - --client-key-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --client-cert-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> ` + --client-key-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -287,2 +272,2 @@ OpenSSL Dynamic Engine - $ sudo cp ssl-client.pem /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.pem </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -293,2 +278,2 @@ OpenSSL Dynamic Engine - --client-cert-hsm-tls-file /opt/cloudhsm/etc/ssl-client.pem \ - --client-key-hsm-tls-file /opt/cloudhsm/etc/ssl-client.key + --client-cert-hsm-tls-file </opt/cloudhsm/etc/ssl-client.pem> \ + --client-key-hsm-tls-file </opt/cloudhsm/etc/ssl-client.key> @@ -306,2 +291,2 @@ Key Storage Provider (KSP) - cp ssl-client.pem C:\ProgramData\Amazon\CloudHSM\ssl-client.pem - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.pem <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -312,2 +297,2 @@ Key Storage Provider (KSP) - --client-cert-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.pem ` - --client-key-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --client-cert-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> ` + --client-key-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -325,2 +310,2 @@ JCE provider - $ sudo cp ssl-client.pem /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.pem </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -331,2 +316,2 @@ JCE provider - --client-cert-hsm-tls-file /opt/cloudhsm/etc/ssl-client.pem \ - --client-key-hsm-tls-file /opt/cloudhsm/etc/ssl-client.key + --client-cert-hsm-tls-file </opt/cloudhsm/etc/ssl-client.pem> \ + --client-key-hsm-tls-file </opt/cloudhsm/etc/ssl-client.key> @@ -341,2 +326,2 @@ JCE provider - cp ssl-client.pem C:\ProgramData\Amazon\CloudHSM\ssl-client.pem - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.pem <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -347,2 +332,2 @@ JCE provider - --client-cert-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.pem ` - --client-key-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --client-cert-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> ` + --client-key-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -360,2 +345,2 @@ CloudHSM CLI - $ sudo cp ssl-client.pem /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.pem </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -366,2 +351,2 @@ CloudHSM CLI - --client-cert-hsm-tls-file /opt/cloudhsm/etc/ssl-client.pem \ - --client-key-hsm-tls-file /opt/cloudhsm/etc/ssl-client.key + --client-cert-hsm-tls-file </opt/cloudhsm/etc/ssl-client.pem> \ + --client-key-hsm-tls-file </opt/cloudhsm/etc/ssl-client.key> @@ -376,2 +361,2 @@ CloudHSM CLI - cp ssl-client.pem C:\ProgramData\Amazon\CloudHSM\ssl-client.pem - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.pem <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -382,2 +367,2 @@ CloudHSM CLI - --client-cert-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.pem ` - --client-key-hsm-tls-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --client-cert-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.pem> ` + --client-key-hsm-tls-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -406 +391 @@ Windows - aws-cloudhsm > login --username admin --role admin + aws-cloudhsm > login --username <admin> --role admin @@ -411 +396 @@ Windows - "username": "admin", + "username": "<admin>",