ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / passwordauth.mdwn
1 [[!template id=plugin name=passwordauth core=1 author="[[Joey]]"]]
2 [[!tag type/auth]]
3
4 This plugin lets ikiwiki prompt for a user name and password when logging
5 into the wiki. It also handles registering users, resetting passwords, and
6 changing passwords in the prefs page.
7
8 It is enabled by default, but can be turned off if you want to only use
9 some other form of authentication, such as [[httpauth]] or [[openid]].
10
11 When the `account_creation_password` configuration option is enabled with
12 a password, this plugin prompts for the password when creating an
13 account as a simplistic anti-spam measure.
14 (Some wikis edited by a particular group use an account creation password
15 as an "ask an existing member to get an account" system.)
16
17 ## password storage
18
19 Users' passwords are stored in the `.ikiwiki/userdb` file, which needs to
20 be kept safe to prevent exposure of passwords. If the
21 [[!cpan Authen::Passphrase]] perl module is installed, only hashes of the
22 passwords will be stored. This is strongly recommended.
23
24 The `password_cost` configuration option can be used to make the stored
25 password hashes be more difficult to brute force, at the expense of also
26 taking more time to check a password when a user logs into the wiki. The
27 default value is 8, max value is (currently) 31, and each step *doubles*
28 the time required.
29
30 So if you're worried about your password files leaking and being cracked,
31 you can increase the `password_cost` and make that harder. But a better
32 choice might be to not deal with user passwords at all, and instead use
33 [[openid]]!