data/TWiki/TWikiLoginManagerApacheLoginDotPm.txt
changeset 0 414e01d06fd5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/data/TWiki/TWikiLoginManagerApacheLoginDotPm.txt	Sat Jan 26 15:50:53 2008 +0100
     1.3 @@ -0,0 +1,51 @@
     1.4 +---+ Package =TWiki::LoginManager::ApacheLogin=
     1.5 +
     1.6 +This is login manager that you can specify in the security setup section of
     1.7 +[[%SCRIPTURL{"configure"}%][configure]]. It instructs TWiki to
     1.8 +cooperate with your web server (typically Apache) to require authentication
     1.9 +information (username & password) from users. It requires that you configure
    1.10 +your web server to demand authentication for scripts named "login" and anything
    1.11 +ending in "auth". The latter should be symlinks to existing scripts; e.g.,
    1.12 +=viewauth -> view=, =editauth -> edit=, and so on.
    1.13 +
    1.14 +See also TWikiUserAuthentication.
    1.15 +
    1.16 +Subclass of TWiki::LoginManager; see that class for documentation of the
    1.17 +methods of this class.
    1.18 +
    1.19 +
    1.20 +%TOC%
    1.21 +
    1.22 +---++ ClassMethod *new* <tt>($session)</tt>
    1.23 +
    1.24 +Construct the ApacheLogin object
    1.25 +
    1.26 +
    1.27 +
    1.28 +---++ ObjectMethod *forceAuthentication* <tt>() -> boolean</tt>
    1.29 +
    1.30 +method called when authentication is required - redirects to (...|view)auth
    1.31 +Triggered on auth fail
    1.32 +
    1.33 +
    1.34 +
    1.35 +---++ ObjectMethod *loginUrl* <tt>() -> $loginUrl</tt>
    1.36 +
    1.37 +TODO: why is this not used internally? When is it called, and why
    1.38 +Content of a login link
    1.39 +
    1.40 +
    1.41 +
    1.42 +---++ ObjectMethod *login* <tt>($query,$twiki)</tt>
    1.43 +
    1.44 +this allows the login and logon cgi-scripts to use the same code. 
    1.45 +all a logon does, is re-direct to viewauth, and apache then figures out 
    1.46 +if it needs to challenge the user
    1.47 +
    1.48 +
    1.49 +
    1.50 +---++ ObjectMethod *getUser* <tt>() -> $authUser</tt>
    1.51 +
    1.52 +returns the userLogin if stored in the apache CGI query (ie session)
    1.53 +
    1.54 +