From 853f65059a25cf121ba91f99d0650af319c4230a Mon Sep 17 00:00:00 2001 From: John Wesley Date: Fri, 8 Mar 2019 03:24:54 -0500 Subject: [PATCH] Warn user to send a password if the privatekey is password protected (#53360) * Warn user to send a password if the privatekey is password protected * Edit openssl_cert doc change * remove trailing whitespace * update openssl_csr doc to warn user of private key passphrase requirement. * Update lib/ansible/modules/crypto/openssl_csr.py Co-Authored-By: johnwesley * grammer correction, privatekey => private key --- lib/ansible/modules/crypto/openssl_certificate.py | 1 + lib/ansible/modules/crypto/openssl_csr.py | 5 +++-- lib/ansible/modules/crypto/openssl_publickey.py | 2 +- 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 9ac0306bb9..57ab1c2acc 100644 --- a/lib/ansible/modules/crypto/openssl_certificate.py +++ b/lib/ansible/modules/crypto/openssl_certificate.py @@ -77,6 +77,7 @@ options: privatekey_passphrase: description: - The passphrase for the I(privatekey_path). + - This is required if the private key is password protected. type: str selfsigned_version: diff --git a/lib/ansible/modules/crypto/openssl_csr.py b/lib/ansible/modules/crypto/openssl_csr.py index 7e0f9acbd0..e2bd819537 100644 --- a/lib/ansible/modules/crypto/openssl_csr.py +++ b/lib/ansible/modules/crypto/openssl_csr.py @@ -40,12 +40,13 @@ options: default: sha256 privatekey_path: description: - - The 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. type: path required: true privatekey_passphrase: description: - - The passphrase for the privatekey. + - The passphrase for the private key. + - This is required if the private key is password protected. type: str version: description: diff --git a/lib/ansible/modules/crypto/openssl_publickey.py b/lib/ansible/modules/crypto/openssl_publickey.py index d1e3f78cd1..1ae797f36a 100644 --- a/lib/ansible/modules/crypto/openssl_publickey.py +++ b/lib/ansible/modules/crypto/openssl_publickey.py @@ -56,7 +56,7 @@ options: required: true privatekey_passphrase: description: - - The passphrase for the privatekey. + - The passphrase for the private key. type: str version_added: "2.4" extends_documentation_fragment: