Support for htpasswd command. Requires the apache2-utils package for Debian-based distros.
New in version 2014.1.0.
The functions here will load inside the webutil module. This allows other functions that don't use htpasswd to use the webutil module name.
salt.modules.htpasswd.
__virtual__
()¶Only load the module if htpasswd is installed
salt.modules.htpasswd.
useradd
(pwfile, user, password, opts=u'', runas=None)¶Add a user to htpasswd file using the htpasswd command. If the htpasswd file does not exist, it will be created.
Valid options that can be passed are:
- n Don't update file; display results on stdout.
- m Force MD5 encryption of the password (default).
- d Force CRYPT encryption of the password.
- p Do not encrypt the password (plaintext).
- s Force SHA encryption of the password.
CLI Examples:
salt '*' webutil.useradd /etc/httpd/htpasswd larry badpassword
salt '*' webutil.useradd /etc/httpd/htpasswd larry badpass opts=ns
salt.modules.htpasswd.
userdel
(pwfile, user, runas=None, all_results=False)¶Delete a user from the specified htpasswd file.
CLI Examples:
salt '*' webutil.userdel /etc/httpd/htpasswd larry
salt.modules.htpasswd.
verify
(pwfile, user, password, opts=u'', runas=None)¶Return True if the htpasswd file exists, the user has an entry, and their password matches.
Valid options that can be passed are:
- m Force MD5 encryption of the password (default).
- d Force CRYPT encryption of the password.
- p Do not encrypt the password (plaintext).
- s Force SHA encryption of the password.
CLI Examples:
salt '*' webutil.verify /etc/httpd/htpasswd larry maybepassword
salt '*' webutil.verify /etc/httpd/htpasswd larry maybepassword opts=ns
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2018.3.0