7871027c9d
* Share the implementation of hashing for both vars_prompt and password_hash. * vars_prompt with encrypt does not require passlib for the algorithms supported by crypt. * Additional checks ensure that there is always a result. This works around issues in the crypt.crypt python function that returns None for algorithms it does not know. Some modules (like user module) interprets None as no password at all, which is misleading. * The password_hash filter supports all parameters of passlib. This allows users to provide a rounds parameter, fixing #15326. * password_hash is not restricted to the subset provided by crypt.crypt, fixing one half of #17266. * Updated documentation fixes other half of #17266. * password_hash does not hard-code the salt-length, which fixes bcrypt in connection with passlib. bcrypt requires a salt with length 22, which fixes #25347 * Salts are only generated by ansible when using crypt.crypt. Otherwise passlib generates them. * Avoids deprecated functionality of passlib with newer library versions. * When no rounds are specified for sha256/sha256_crypt and sha512/sha512_crypt always uses the default values used by crypt, i.e. 5000 rounds. Before when installed passlibs' defaults were used. passlib changes its defaults with newer library versions, leading to non idempotent behavior. NOTE: This will lead to the recalculation of existing hashes generated with passlib and without a rounds parameter. Yet henceforth the hashes will remain the same. No matter the installed passlib version. Making these hashes idempotent. Fixes #15326 Fixes #17266 Fixes #25347 except bcrypt still uses 2a, instead of the suggested 2b. * random_salt is solely handled by encrypt.py. There is no _random_salt function there anymore. Also the test moved to test_encrypt.py. * Uses pytest.skip when passlib is not available, instead of a silent return. * More checks are executed when passlib is not available. * Moves tests that require passlib into their own test-function. * Uses the six library to reraise the exception. * Fixes integration test. When no rounds are provided the defaults of crypt are used. In that case the rounds are not part of the resulting MCF output.
117 lines
3.6 KiB
ReStructuredText
117 lines
3.6 KiB
ReStructuredText
Prompts
|
|
=======
|
|
|
|
When running a playbook, you may wish to prompt the user for certain input, and can
|
|
do so with the 'vars_prompt' section.
|
|
|
|
A common use for this might be for asking for sensitive data that you do not want to record.
|
|
|
|
This has uses beyond security, for instance, you may use the same playbook for all
|
|
software releases and would prompt for a particular release version
|
|
in a push-script.
|
|
|
|
Here is a most basic example::
|
|
|
|
---
|
|
- hosts: all
|
|
remote_user: root
|
|
|
|
vars:
|
|
from: "camelot"
|
|
|
|
vars_prompt:
|
|
- name: "name"
|
|
prompt: "what is your name?"
|
|
- name: "quest"
|
|
prompt: "what is your quest?"
|
|
- name: "favcolor"
|
|
prompt: "what is your favorite color?"
|
|
|
|
|
|
.. note::
|
|
Prompts for individual ``vars_prompt`` variables will be skipped for any variable that is already defined through the command line ``--extra-vars`` option, or when running from a non-interactive session (such as cron or Ansible Tower). See :ref:`passing_variables_on_the_command_line` in the /Variables/ chapter.
|
|
|
|
If you have a variable that changes infrequently, it might make sense to
|
|
provide a default value that can be overridden. This can be accomplished using
|
|
the default argument::
|
|
|
|
vars_prompt:
|
|
|
|
- name: "release_version"
|
|
prompt: "Product release version"
|
|
default: "1.0"
|
|
|
|
An alternative form of vars_prompt allows for hiding input from the user, and may later support
|
|
some other options, but otherwise works equivalently::
|
|
|
|
vars_prompt:
|
|
|
|
- name: "some_password"
|
|
prompt: "Enter password"
|
|
private: yes
|
|
|
|
- name: "release_version"
|
|
prompt: "Product release version"
|
|
private: no
|
|
|
|
If `Passlib <https://passlib.readthedocs.io/en/stable/>`_ is installed, vars_prompt can also encrypt the
|
|
entered value so you can use it, for instance, with the user module to define a password::
|
|
|
|
vars_prompt:
|
|
|
|
- name: "my_password2"
|
|
prompt: "Enter password2"
|
|
private: yes
|
|
encrypt: "sha512_crypt"
|
|
confirm: yes
|
|
salt_size: 7
|
|
|
|
You can use any crypt scheme supported by 'Passlib':
|
|
|
|
- *des_crypt* - DES Crypt
|
|
- *bsdi_crypt* - BSDi Crypt
|
|
- *bigcrypt* - BigCrypt
|
|
- *crypt16* - Crypt16
|
|
- *md5_crypt* - MD5 Crypt
|
|
- *bcrypt* - BCrypt
|
|
- *sha1_crypt* - SHA-1 Crypt
|
|
- *sun_md5_crypt* - Sun MD5 Crypt
|
|
- *sha256_crypt* - SHA-256 Crypt
|
|
- *sha512_crypt* - SHA-512 Crypt
|
|
- *apr_md5_crypt* - Apache's MD5-Crypt variant
|
|
- *phpass* - PHPass' Portable Hash
|
|
- *pbkdf2_digest* - Generic PBKDF2 Hashes
|
|
- *cta_pbkdf2_sha1* - Cryptacular's PBKDF2 hash
|
|
- *dlitz_pbkdf2_sha1* - Dwayne Litzenberger's PBKDF2 hash
|
|
- *scram* - SCRAM Hash
|
|
- *bsd_nthash* - FreeBSD's MCF-compatible nthash encoding
|
|
|
|
However, the only parameters accepted are 'salt' or 'salt_size'. You can use your own salt using
|
|
'salt', or have one generated automatically using 'salt_size'. If nothing is specified, a salt
|
|
of size 8 will be generated.
|
|
|
|
.. versionadded:: 2.7
|
|
|
|
When Passlib is not installed the `crypt <https://docs.python.org/2/library/crypt.html>`_ library is used as fallback.
|
|
Depending on your platform at most the following crypt schemes are supported:
|
|
|
|
- *bcrypt* - BCrypt
|
|
- *md5_crypt* - MD5 Crypt
|
|
- *sha256_crypt* - SHA-256 Crypt
|
|
- *sha512_crypt* - SHA-512 Crypt
|
|
|
|
.. seealso::
|
|
|
|
:doc:`playbooks`
|
|
An introduction to playbooks
|
|
:doc:`playbooks_conditionals`
|
|
Conditional statements in playbooks
|
|
:doc:`playbooks_variables`
|
|
All about variables
|
|
`User Mailing List <https://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|
|
|
|
|
|
|