debconf: add a note about no_log usage (#70738)

debconf module exposes sensitive information to logs, console.
Add a note to user about using no_log=True to hide such
information from console.

Fixes: #32386

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde 2020-07-20 21:08:13 +05:30 committed by GitHub
parent 633c2d0522
commit 84b4387702
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 0 deletions

View file

@ -0,0 +1,2 @@
minor_changes:
- debconf - add a note about no_log=True since module might expose sensitive information to logs (https://github.com/ansible/ansible/issues/32386).

View file

@ -22,6 +22,7 @@ notes:
Use 'debconf-show <package>' on any Debian or derivative with the package Use 'debconf-show <package>' on any Debian or derivative with the package
installed to see questions/settings available. installed to see questions/settings available.
- Some distros will always record tasks involving the setting of passwords as changed. This is due to debconf-get-selections masking passwords. - Some distros will always record tasks involving the setting of passwords as changed. This is due to debconf-get-selections masking passwords.
- It is highly recommended to add I(no_log=True) to task while handling sensitive information using this module.
requirements: requirements:
- debconf - debconf
- debconf-utils - debconf-utils
@ -40,6 +41,7 @@ options:
vtype: vtype:
description: description:
- The type of the value supplied. - The type of the value supplied.
- It is highly recommended to add I(no_log=True) to task while specifying I(vtype=password).
- C(seen) was added in Ansible 2.2. - C(seen) was added in Ansible 2.2.
type: str type: str
choices: [ boolean, error, multiselect, note, password, seen, select, string, text, title ] choices: [ boolean, error, multiselect, note, password, seen, select, string, text, title ]
@ -82,6 +84,14 @@ EXAMPLES = r'''
- name: Specifying package you can register/return the list of questions and current values - name: Specifying package you can register/return the list of questions and current values
debconf: debconf:
name: tzdata name: tzdata
- name: Pre-configure tripwire site passphrase
debconf:
name: tripwire
question: tripwire/site-passphrase
value: "{{ site_passphrase }}"
vtype: password
no_log: True
''' '''
from ansible.module_utils._text import to_text from ansible.module_utils._text import to_text