summaryrefslogtreecommitdiff
path: root/plugins/htpasswd/README.md
blob: 66f46ca38be793e2465a7e3abf5c73a39db69dee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
htpasswd
========

This plugin can parse an Apache authentication file
generated by htpasswd.

The following hash types are supported:

- APR-MD5 (`htpasswd [-m]`, default method)
- SHA1 (`htpasswd -s`)
- Blowfish (`htpasswd -B`)
- DES (`htpasswd -d`)
- Plaintext (`htpasswd -s`)

Note that DES and Plaintext are mutually exclusive, because
the format is not readily distinguishable. Any hash that does
not match the MD5, SHA1 or Blowfish formats will be treated as
a DES hash or a plaintext password depending on configuration.

Installation
------------

This configuration must be entered into plugin_conf in config.php:

    'plugin_conf' => [
      'htpasswd_file' => '</path/to/htpasswd/file>',
      'plain' => FALSE, // optional
    ]

Each domain can use a separate file, as in:

    'plugin_conf' => [
      'htpasswd_file' => [
        'example.com' => '<com.htpasswd>',
        'example.org' => '<org.htpasswd>',
      ]
    ]