This plugin authenticates users against the Unix user database. It presents a similar UI to [[plugins/passwordauth]], but simpler, as there's no need to be able to register or change one's password.
-To authenticate, either [checkpassword](http://cr.yp.to/checkpwd.html) or [pwauth](http://www.unixpapa.com/pwauth/) must be installed and configured. `checkpassword` is strongly preferred. If your web server runs as an unprivileged user -- as it darn well should! -- then `checkpassword` needs to be setuid root. Other checkpassword implementations are available, notably [checkpassword-pam](http://checkpasswd-pam.sourceforge.net/).
+To authenticate, either [checkpassword](http://cr.yp.to/checkpwd.html) or [pwauth](http://www.unixpapa.com/pwauth/) must be installed and configured. `checkpassword` is strongly preferred. If your web server runs as an unprivileged user -- as it darn well should! -- then `checkpassword` needs to be setuid root. (Or your ikiwiki CGI wrapper, I guess, but don't do that.) Other checkpassword implementations are available, notably [checkpassword-pam](http://checkpasswd-pam.sourceforge.net/).
Config variables that affect the behavior of `unixauth`:
* `unixauth_type`: defaults to unset, can be "checkpassword" or "pwauth"
* `unixauth_command`: defaults to unset, should contain the full path and any arguments
-* `unixauth_sslrequire`: defaults to 1, can be 0
-* `sslcookie`: needs to be 1 if `unixauth_sslrequire` is 1 (perhaps this should be done automatically?)
+* `unixauth_requiressl`: defaults to 1, can be 0
+* `sslcookie`: needs to be 1 if `unixauth_requiressl` is 1 (perhaps this should be done automatically?)
__Security__: [As with passwordauth](/security/#index14h2), be wary of sending usernames and passwords in cleartext. Unlike passwordauth, sniffing `unixauth` credentials can get an attacker much further than mere wiki access. Therefore, this plugin defaults to not even _displaying_ the login form fields unless we're running under SSL. Nobody should be able to do anything remotely dumb until the admin has done at least a little thinking. After that, dumb things are always possible. ;-)
+`unixauth` needs the `HTTPS` environment variable, available in ikiwiki 2.67 or later (fixed in #[502047](http://bugs.debian.org/502047)), without which it fails closed.
+
+The plugin has not been tested with newer versions of ikiwiki. [[schmonz]] hopes to have time to polish this plugin soon.
+
[[!toggle id="code" text="unixauth.pm"]]
[[!toggleable id="code" text="""
use strict;
use IkiWiki 2.00;
- sub import { #{{{
+ sub import {
+ hook(type => "getsetup", id => "unixauth", call => \&getsetup);
hook(type => "formbuilder_setup", id => "unixauth",
call => \&formbuilder_setup);
hook(type => "formbuilder", id => "unixauth",
call => \&formbuilder);
hook(type => "sessioncgi", id => "unixauth", call => \&sessioncgi);
- } # }}}
+ }
+
+ sub getsetup () {
+ return
+ unixauth_type => {
+ type => "string",
+ example => "checkpassword",
+ description => "type of authenticator; can be 'checkpassword' or 'pwauth'",
+ safe => 0,
+ rebuild => 1,
+ },
+ unixauth_command => {
+ type => "string",
+ example => "/path/to/checkpassword",
+ description => "full path and any arguments",
+ safe => 0,
+ rebuild => 1,
+ },
+ unixauth_requiressl => {
+ type => "boolean",
+ example => "1",
+ description => "require SSL? strongly recommended",
+ safe => 0,
+ rebuild => 1,
+ },
+ plugin => {
+ description => "Unix user authentication",
+ safe => 0,
+ rebuild => 1,
+ },
+ }
# Checks if a string matches a user's password, and returns true or false.
- sub checkpassword ($$;$) { #{{{
+ sub checkpassword ($$;$) {
my $user=shift;
my $password=shift;
my $field=shift || "password";
}
return $ret;
- } #}}}
+ }
- sub formbuilder_setup (@) { #{{{
+ sub formbuilder_setup (@) {
my %params=@_;
my $form=$params{form};
if (! exists $config{unixauth_requiressl}) {
$config{unixauth_requiressl} = 1;
}
- if ($config{unixauth_requiressl} && \
- (! $config{sslcookie} || ! exists $ENV{'HTTPS'})) {
- die("SSL required to login. Contact your administrator.");
+ if ($config{unixauth_requiressl}) {
+ if ((! $config{sslcookie}) || (! exists $ENV{'HTTPS'})) {
+ die("SSL required to login. Contact your administrator.<br>");
+ }
}
if ($form->title eq "signin") {
}
}
- sub formbuilder (@) { #{{{
+ sub formbuilder (@) {
my %params=@_;
my $form=$params{form};
my $user_name=$form->field('name');
}
}
- } #}}}
+ }
- sub sessioncgi ($$) { #{{{
+ sub sessioncgi ($$) {
my $q=shift;
my $session=shift;
- } #}}}
+ }
1