AWS cloudhsm documentation change
Summary
Updated command examples to use placeholder syntax (<>) for cluster IDs, regions, endpoints, and file paths. Removed trailing whitespace and standardized path formatting in configuration examples.
Security assessment
Changes focus on documentation formatting improvements rather than addressing specific security vulnerabilities. The use of placeholders appears to be a standard documentation practice to indicate user-provided values, not a direct response to a security issue. No evidence of CVE mitigation or vulnerability disclosure referenced.
Diff
diff --git a/cloudhsm/latest/userguide/configure-tool-examples5.md b/cloudhsm/latest/userguide/configure-tool-examples5.md index 846b709c2..c548b8346 100644 --- a/cloudhsm/latest/userguide/configure-tool-examples5.md +++ b/cloudhsm/latest/userguide/configure-tool-examples5.md @@ -121,2 +113 @@ PKCS #11 library - $ sudo /opt/cloudhsm/bin/configure-pkcs11 --cluster-id cluster-1234567 - + $ sudo /opt/cloudhsm/bin/configure-pkcs11 --cluster-id <cluster-1234567> @@ -131,2 +122 @@ PKCS #11 library - "C:\Program Files\Amazon\CloudHSM\configure-pkcs11.exe" --cluster-id cluster-1234567 - + "C:\Program Files\Amazon\CloudHSM\configure-pkcs11.exe" --cluster-id <cluster-1234567> @@ -144,2 +134 @@ OpenSSL Dynamic Engine - $ sudo /opt/cloudhsm/bin/configure-dyn --cluster-id cluster-1234567 - + $ sudo /opt/cloudhsm/bin/configure-dyn --cluster-id <cluster-1234567> @@ -157,2 +146 @@ Key Storage Provider (KSP) - "C:\Program Files\Amazon\CloudHSM\configure-ksp.exe" --cluster-id cluster-1234567 - + "C:\Program Files\Amazon\CloudHSM\configure-ksp.exe" --cluster-id <cluster-1234567> @@ -170,2 +158 @@ JCE provider - $ sudo /opt/cloudhsm/bin/configure-jce --cluster-id cluster-1234567 - + $ sudo /opt/cloudhsm/bin/configure-jce --cluster-id <cluster-1234567> @@ -180,2 +167 @@ JCE provider - "C:\Program Files\Amazon\CloudHSM\configure-jce.exe" --cluster-id cluster-1234567 - + "C:\Program Files\Amazon\CloudHSM\configure-jce.exe" --cluster-id <cluster-1234567> @@ -193,2 +179 @@ CloudHSM CLI - $ sudo /opt/cloudhsm/bin/configure-cli --cluster-id cluster-1234567 - + $ sudo /opt/cloudhsm/bin/configure-cli --cluster-id <cluster-1234567> @@ -203,2 +188 @@ CloudHSM CLI - "C:\Program Files\Amazon\CloudHSM\bin\configure-cli.exe" --cluster-id cluster-1234567 - + "C:\Program Files\Amazon\CloudHSM\bin\configure-cli.exe" --cluster-id <cluster-1234567> @@ -218,2 +202 @@ PKCS #11 library - $ sudo /opt/cloudhsm/bin/configure-pkcs11 --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + $ sudo /opt/cloudhsm/bin/configure-pkcs11 --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -228,2 +211 @@ PKCS #11 library - C:\Program Files\Amazon\CloudHSM\configure-pkcs11.exe --cluster-id cluster-1234567--region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + C:\Program Files\Amazon\CloudHSM\configure-pkcs11.exe --cluster-id <cluster-1234567>--region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -241,2 +223 @@ OpenSSL Dynamic Engine - $ sudo /opt/cloudhsm/bin/configure-dyn --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + $ sudo /opt/cloudhsm/bin/configure-dyn --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -254,2 +235 @@ Key Storage Provider (KSP) - "C:\Program Files\Amazon\CloudHSM\configure-ksp.exe" --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + "C:\Program Files\Amazon\CloudHSM\configure-ksp.exe" --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -267,2 +247 @@ JCE provider - $ sudo /opt/cloudhsm/bin/configure-jce --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + $ sudo /opt/cloudhsm/bin/configure-jce --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -277,2 +256 @@ JCE provider - "C:\Program Files\Amazon\CloudHSM\configure-jce.exe" --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + "C:\Program Files\Amazon\CloudHSM\configure-jce.exe" --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -290,2 +268 @@ CloudHSM CLI - $ sudo /opt/cloudhsm/bin/configure-cli --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + $ sudo /opt/cloudhsm/bin/configure-cli --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -300,2 +277 @@ CloudHSM CLI - "C:\Program Files\Amazon\CloudHSM\configure-cli.exe" --cluster-id cluster-1234567 --region us-east-1 --endpoint https://cloudhsmv2.us-east-1.amazonaws.com - + "C:\Program Files\Amazon\CloudHSM\configure-cli.exe" --cluster-id <cluster-1234567> --region <us-east-1> --endpoint <https://cloudhsmv2.us-east-1.amazonaws.com> @@ -317,2 +293,2 @@ PKCS #11 library - $ sudo cp ssl-client.crt /opt/cloudhsm/etc - $ sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.crt </opt/cloudhsm/etc> + $ sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -323,2 +299,2 @@ PKCS #11 library - --server-client-cert-file /opt/cloudhsm/etc/ssl-client.crt \ - --server-client-key-file /opt/cloudhsm/etc/ssl-client.key + --server-client-cert-file </opt/cloudhsm/etc/ssl-client.crt> \ + --server-client-key-file </opt/cloudhsm/etc/ssl-client.key> @@ -333,2 +309,2 @@ PKCS #11 library - cp ssl-client.crt C:\ProgramData\Amazon\CloudHSM\ssl-client.crt - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.crt <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -339,2 +315,2 @@ PKCS #11 library - --server-client-cert-file C:\ProgramData\Amazon\CloudHSM\ssl-client.crt ` - --server-client-key-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --server-client-cert-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> ` + --server-client-key-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -352,2 +328,2 @@ OpenSSL Dynamic Engine - $ sudo cp ssl-client.crt /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.crt </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -358,2 +334,2 @@ OpenSSL Dynamic Engine - --server-client-cert-file /opt/cloudhsm/etc/ssl-client.crt \ - --server-client-key-file /opt/cloudhsm/etc/ssl-client.key + --server-client-cert-file </opt/cloudhsm/etc/ssl-client.crt> \ + --server-client-key-file </opt/cloudhsm/etc/ssl-client.key> @@ -371,2 +347,2 @@ Key Storage Provider (KSP) - cp ssl-client.crt C:\ProgramData\Amazon\CloudHSM\ssl-client.crt - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.crt <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -377,2 +353,2 @@ Key Storage Provider (KSP) - --server-client-cert-file C:\ProgramData\Amazon\CloudHSM\ssl-client.crt ` - --server-client-key-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --server-client-cert-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> ` + --server-client-key-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -390,2 +366,2 @@ JCE provider - $ sudo cp ssl-client.crt /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.crt </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -396,2 +372,2 @@ JCE provider - --server-client-cert-file /opt/cloudhsm/etc/ssl-client.crt \ - --server-client-key-file /opt/cloudhsm/etc/ssl-client.key + --server-client-cert-file </opt/cloudhsm/etc/ssl-client.crt> \ + --server-client-key-file </opt/cloudhsm/etc/ssl-client.key> @@ -406,2 +382,2 @@ JCE provider - cp ssl-client.crt C:\ProgramData\Amazon\CloudHSM\ssl-client.crt - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.crt <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -412,2 +388,2 @@ JCE provider - --server-client-cert-file C:\ProgramData\Amazon\CloudHSM\ssl-client.crt ` - --server-client-key-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --server-client-cert-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> ` + --server-client-key-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -425,2 +401,2 @@ CloudHSM CLI - $ sudo cp ssl-client.crt /opt/cloudhsm/etc - sudo cp ssl-client.key /opt/cloudhsm/etc + $ sudo cp ssl-client.crt </opt/cloudhsm/etc> + sudo cp ssl-client.key </opt/cloudhsm/etc> @@ -431,2 +407,2 @@ CloudHSM CLI - --server-client-cert-file /opt/cloudhsm/etc/ssl-client.crt \ - --server-client-key-file /opt/cloudhsm/etc/ssl-client.key + --server-client-cert-file </opt/cloudhsm/etc/ssl-client.crt> \ + --server-client-key-file </opt/cloudhsm/etc/ssl-client.key> @@ -441,2 +417,2 @@ CloudHSM CLI - cp ssl-client.crt C:\ProgramData\Amazon\CloudHSM\ssl-client.crt - cp ssl-client.key C:\ProgramData\Amazon\CloudHSM\ssl-client.key + cp ssl-client.crt <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> + cp ssl-client.key <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -447,2 +423,2 @@ CloudHSM CLI - --server-client-cert-file C:\ProgramData\Amazon\CloudHSM\ssl-client.crt ` - --server-client-key-file C:\ProgramData\Amazon\CloudHSM\ssl-client.key + --server-client-cert-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.crt> ` + --server-client-key-file <C:\ProgramData\Amazon\CloudHSM\ssl-client.key> @@ -464,2 +440,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> @@ -470,2 +446,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> @@ -480,2 +456,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> @@ -486,2 +462,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> @@ -499,2 +475,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> @@ -505,2 +481,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> @@ -518,2 +494,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> @@ -524,2 +500,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> @@ -537,2 +513,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> @@ -543,2 +519,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> @@ -553,2 +529,2 @@ JCE provider - cp ssl-client.pem C:\ProgramData\Amazon\CloudHSM\ssl-client.pem