summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelix Fontein <felix@fontein.de>2019-03-11 19:50:13 +0100
committerAlicia Cozine <879121+acozine@users.noreply.github.com>2019-03-11 13:50:13 -0500
commit63b279460707c06864badf7c198aa87f35a24641 (patch)
tree1705fa9b985c687386e3e7c6412082a5ead30554
parent96aa6babc1cfaedc9bcd6c0d4b96d2a8720f5ae2 (diff)
downloadansible-63b279460707c06864badf7c198aa87f35a24641.tar.gz
Warn user to send a password if the privatekey is password protected (#53360) (#53527)
* Warn user to send a password if the privatekey is password protected on openssl_cert and openssl_csr docs Co-Authored-By: johnwesley <johnwesley@users.noreply.github.com>
-rw-r--r--lib/ansible/modules/crypto/openssl_certificate.py1
-rw-r--r--lib/ansible/modules/crypto/openssl_csr.py5
-rw-r--r--lib/ansible/modules/crypto/openssl_publickey.py2
3 files changed, 5 insertions, 3 deletions
diff --git a/lib/ansible/modules/crypto/openssl_certificate.py b/lib/ansible/modules/crypto/openssl_certificate.py
index 9978da0b36..12a41caec6 100644
--- a/lib/ansible/modules/crypto/openssl_certificate.py
+++ b/lib/ansible/modules/crypto/openssl_certificate.py
@@ -72,6 +72,7 @@ options:
privatekey_passphrase:
description:
- The passphrase for the I(privatekey_path).
+ - This is required if the private key is password protected.
selfsigned_version:
default: 3
diff --git a/lib/ansible/modules/crypto/openssl_csr.py b/lib/ansible/modules/crypto/openssl_csr.py
index d1fc7162d9..f354ea43be 100644
--- a/lib/ansible/modules/crypto/openssl_csr.py
+++ b/lib/ansible/modules/crypto/openssl_csr.py
@@ -41,11 +41,12 @@ options:
privatekey_path:
required: true
description:
- - Path to the privatekey to use when signing the certificate signing request
+ - The path to the private key to use when signing the certificate signing request.
privatekey_passphrase:
required: false
description:
- - The passphrase for the privatekey.
+ - The passphrase for the private key.
+ - This is required if the private key is password protected.
version:
required: false
default: 1
diff --git a/lib/ansible/modules/crypto/openssl_publickey.py b/lib/ansible/modules/crypto/openssl_publickey.py
index 5a749d6bef..188f4c55ad 100644
--- a/lib/ansible/modules/crypto/openssl_publickey.py
+++ b/lib/ansible/modules/crypto/openssl_publickey.py
@@ -56,7 +56,7 @@ options:
privatekey_passphrase:
required: false
description:
- - The passphrase for the privatekey.
+ - The passphrase for the private key.
version_added: "2.4"
extends_documentation_fragment: files
'''