X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/bf0483ed96755bb0aee22cf5e10a6f764cd15327..56e18bc00900debc2c3f457d013f366f4d3dea98:/doc/plugins/contrib/unixauth.mdwn

diff --git a/doc/plugins/contrib/unixauth.mdwn b/doc/plugins/contrib/unixauth.mdwn
index 7442b6291..d91ed45f1 100644
--- a/doc/plugins/contrib/unixauth.mdwn
+++ b/doc/plugins/contrib/unixauth.mdwn
@@ -3,14 +3,14 @@
 
 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. ;-)
 
@@ -38,7 +38,7 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
 
 [[!toggleable id="code" text="""
 
-    #!/usr//bin/perl
+    #!/usr/bin/perl
     # Ikiwiki unixauth authentication.
     package IkiWiki::Plugin::unixauth;
     
@@ -47,6 +47,7 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
     use IkiWiki 2.00;
     
     sub import { #{{{
+        hook(type => "getsetup", id => "unixauth", call => \&getsetup);
             hook(type => "formbuilder_setup", id => "unixauth",
                 call => \&formbuilder_setup);
             hook(type => "formbuilder", id => "unixauth",
@@ -54,6 +55,36 @@ __Security__: [As with passwordauth](/security/#index14h2), be wary of sending u
         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 ($$;$) { #{{{
         my $user=shift;