htpasswd – manage user files for basic authentication
htpasswd – manage user files for basic authentication
New in version 1.3.
Synopsis
- Add and remove username/password entries in a password file using htpasswd.
- This is used by web servers such as Apache and Nginx for basic authentication.
Requirements
The below requirements are needed on the host that executes this module.
- passlib>=1.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
attributes - added in 2.3 |
Attributes the file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr.
| |
create boolean |
|
Used with |
crypt_scheme - |
|
Encryption scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib, such as md5_crypt and sha256_crypt, which are linux passwd hashes. If you do so the password file will not be compatible with Apache or Nginx |
group - |
Name of the group that should own the file/directory, as would be fed to chown. | |
mode - |
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like | |
name - / required |
User name to add or remove
| |
owner - |
Name of the user that should own the file/directory, as would be fed to chown. | |
password - |
Password associated with user. Must be specified if user does not exist yet. | |
path - / required |
Path to the file that contains the usernames and passwords
| |
selevel - |
Default: "s0" |
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the |
serole - |
Role part of SELinux file context, | |
setype - |
Type part of SELinux file context, | |
seuser - |
User part of SELinux file context. Will default to system policy, if applicable. If set to | |
state - |
|
Whether the user entry should be present or not |
unsafe_writes boolean added in 2.2 |
|
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. |
Notes
Note
- This module depends on the passlib Python library, which needs to be installed on all target systems.
- On Debian, Ubuntu, or Fedora: install python-passlib.
- On RHEL or CentOS: Enable EPEL, then install python-passlib.
Examples
# Add a user to a password file and ensure permissions are set
- htpasswd:
path: /etc/nginx/passwdfile
name: janedoe
password: '9s36?;fyNp'
owner: root
group: www-data
mode: 0640
# Remove a user from a password file
- htpasswd:
path: /etc/apache2/passwdfile
name: foobar
state: absent
# Add a user to a password file suitable for use by libpam-pwdfile
- htpasswd:
path: /etc/mail/passwords
name: alex
password: oedu2eGh
crypt_scheme: md5_crypt
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ansible Core Team
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/htpasswd_module.html