]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
testing
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index 5cace0911c1f2d6cf3b6f40e0c4371a838d8b1e2..7c4da8d5f943b7b1e1cb84dd9be5de61addfafa6 100644 (file)
@@ -175,6 +175,19 @@ called in turn, and passed a CGI object. The hook should examine the
 parameters, and if it will handle this CGI request, output a page and
 terminate the program.
 
+### cgi
+
+       hook(type => "cgi", id => "foo", call => \&auth);
+
+This hook can be used to implement a different authentication method than
+the standard web form. When a user needs to be authenticated, each registered
+auth hook is called in turn, and passed a CGI object and a session object. 
+
+If the hook is able to authenticate the user, it should set the session
+object's "name" parameter to the authenticated user's name. Note that
+if the name is set to the name of a user who is not registered,
+a basic registration of the user will be automatically performed.
+
 ### savestate
 
        hook(type => "savestate", id => "foo", call => \&savestate);