data/TWiki/TWikiLoginManagerApacheLoginDotPm.txt
changeset 0 414e01d06fd5
equal deleted inserted replaced
-1:000000000000 0:414e01d06fd5
       
     1 ---+ Package =TWiki::LoginManager::ApacheLogin=
       
     2 
       
     3 This is login manager that you can specify in the security setup section of
       
     4 [[%SCRIPTURL{"configure"}%][configure]]. It instructs TWiki to
       
     5 cooperate with your web server (typically Apache) to require authentication
       
     6 information (username & password) from users. It requires that you configure
       
     7 your web server to demand authentication for scripts named "login" and anything
       
     8 ending in "auth". The latter should be symlinks to existing scripts; e.g.,
       
     9 =viewauth -> view=, =editauth -> edit=, and so on.
       
    10 
       
    11 See also TWikiUserAuthentication.
       
    12 
       
    13 Subclass of TWiki::LoginManager; see that class for documentation of the
       
    14 methods of this class.
       
    15 
       
    16 
       
    17 %TOC%
       
    18 
       
    19 ---++ ClassMethod *new* <tt>($session)</tt>
       
    20 
       
    21 Construct the ApacheLogin object
       
    22 
       
    23 
       
    24 
       
    25 ---++ ObjectMethod *forceAuthentication* <tt>() -> boolean</tt>
       
    26 
       
    27 method called when authentication is required - redirects to (...|view)auth
       
    28 Triggered on auth fail
       
    29 
       
    30 
       
    31 
       
    32 ---++ ObjectMethod *loginUrl* <tt>() -> $loginUrl</tt>
       
    33 
       
    34 TODO: why is this not used internally? When is it called, and why
       
    35 Content of a login link
       
    36 
       
    37 
       
    38 
       
    39 ---++ ObjectMethod *login* <tt>($query,$twiki)</tt>
       
    40 
       
    41 this allows the login and logon cgi-scripts to use the same code. 
       
    42 all a logon does, is re-direct to viewauth, and apache then figures out 
       
    43 if it needs to challenge the user
       
    44 
       
    45 
       
    46 
       
    47 ---++ ObjectMethod *getUser* <tt>() -> $authUser</tt>
       
    48 
       
    49 returns the userLogin if stored in the apache CGI query (ie session)
       
    50 
       
    51