|
1 <!DOCTYPE html> |
|
2 <!-- :mode=html: --> |
|
3 <html> |
|
4 <head> |
|
5 <title>WebAuth Help</title> |
|
6 <link rel="stylesheet" type="text/css" href="images/bootstrap/css/bootstrap.min.css" /> |
|
7 <link rel="stylesheet" type="text/css" href="images/ssoinabox.css" /> |
|
8 </head> |
|
9 |
|
10 <body> |
|
11 <div class="main container"> |
|
12 <h1>SSO-in-a-Box WebAuth Service</h1> |
|
13 <p>This page serves as general information about the WebAuth service.</p> |
|
14 |
|
15 <h2>What is WebAuth?</h2> |
|
16 <p>WebAuth is the facility that makes it easy to tie a webpage into SSO-in-a-Box's central user account service.</p> |
|
17 |
|
18 <h2>I can't log in. Help!</h2> |
|
19 |
|
20 <p>The most common error messages are listed below, along with an explanation of what the error means. If you encounter an error message not listed |
|
21 below, please see the "Contact Information" heading below.</p> |
|
22 |
|
23 <h3>Error: You entered an incorrect username or password (or both).</h3> |
|
24 |
|
25 <p>Double-check your username and password. For employees, this is your first initial followed by your last name, <strong>all lowercase</strong>. |
|
26 Remember, your username and password are both case sensitive.</p> |
|
27 |
|
28 <h3>Internal error</h3> |
|
29 |
|
30 <p>This error message is sometimes seen if maintenance was performed on the login server recently. Please try accessing the service again before |
|
31 contacting the help desk.</p> |
|
32 |
|
33 <h3>Error: You took too long to log in.</h3> |
|
34 |
|
35 <p>The login page is a time-sensitive URL. Thus, bookmarking it or reusing an old login URL will not work. Instead, bookmark the page of the service |
|
36 you are trying to reach after you log in. When you open the bookmark, you will be redirected to the login page if you do not have an active |
|
37 session.</p> |
|
38 |
|
39 <h3>Error: That username may not authenticate to this service.</h3> |
|
40 |
|
41 <p>Your account is disabled. This might happen for any number of reasons, such as account suspension or password expiration.</p> |
|
42 |
|
43 <h2>As a developer, how can I use WebAuth?</h2> |
|
44 <p>A server must have WebAuth configured on it before it will be able to use Apache's standard "AuthType" directive in .htaccess to require WebAuth |
|
45 for a selection of pages. Once this is done, protecting a page or group of pages is very simple. Examples:</p> |
|
46 <pre># Protect the entire directory |
|
47 AuthType WebAuth |
|
48 Require valid-user</pre> |
|
49 <pre># Protect only certain URLs in this directory |
|
50 <FilesMatch "^(index|admin)\.php$"> |
|
51 AuthType WebAuth |
|
52 Require valid-user |
|
53 </FilesMatch></pre> |
|
54 <pre># Restrict to a whitelist of users |
|
55 AuthType WebAuth |
|
56 Require user jschmoe jdoe</pre> |
|
57 <pre># Restrict to a group |
|
58 AuthType WebAuth |
|
59 AuthDBMGroupFile /etc/apache2/ldap-groups |
|
60 Require group users</pre> |
|
61 </div> |
|
62 </body> |
|
63 </html> |