file lib.php was initially added on branch MOODLE_14_STABLE.
[moodle.git] / auth / README
CommitLineData
faebaf0f 1This directory contains authentication modules.
2
3Each of these modules describes a different way to
4check that a user has provided a correct
5
6 - username, and
7 - password.
8
9Even when external forms of authentication are being
10used, Moodle still maintains the internal "user" table
11with all the associated information about that user such
12as name, email address and so on.
13
14The active method is set by the admin on the Configuration page.
15
16
17email - authentication by email (DEFAULT METHOD)
18
19 - user fills out form with email address
20 - email sent to user with link
21 - user clicks on link in email to confirm
22 - user account is created
23 - user can log in
24
25
26none - no authentication at all .. very insecure!!
27
28 - user logs in using ANY username and password
29 - if the username doesn't already exist then
30 a new account is created
31 - when user tries to access a course they
32 are forced to set up their account details
33
88478a66 34manual - internal authentication only
35
36 - user logs in using username and password
37 - no way for user to make their own account
38
faebaf0f 39
40ldap - Uses an external LDAP server
2ee53d15 41
42 - user logs in using username and password
43 - these are checked against an LDAP server
44 - if correct, user is logged in
45 - optionally, info is copied from the LDAP
46 database to the Moodle user database
d1b4e172 47
2ee53d15 48 (see the ldap/README for more details on config etc...)
d1b4e172 49
50
51imap - Uses an external IMAP server
52
53 - user logs in using username and password
54 - these are checked against an IMAP server
55 - if correct, user is logged in
56 - if the username doesn't already exist then
57 a new account is created
58
59
df3988ea 60pop3 - Uses an external POP3 server
61
62 - user logs in using username and password
63 - these are checked against a POP3 server
64 - if correct, user is logged in
65 - if the username doesn't already exist then
66 a new account is created
67
68
69nntp - Uses an external NNTP server
70
71 - user logs in using username and password
72 - these are checked against an NNTP server
73 - if correct, user is logged in
74 - if the username doesn't already exist then
75 a new account is created
76
77
d1b4e172 78db - Uses an external database to check username/password
79
80 - user logs in using username and password
81 - these are checked against an external database
82 - if correct, user is logged in
83 - if the username doesn't already exist then
84 a new Moodle account is created