1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<?php
/**
* auth/basic.class.php
*
* foundation authorisation class
* all auth classes should inherit from this class
*
* @author Chris Smith <chris@jalakaic.co.uk>
*/
class auth_basic {
var $success = true;
/**
* Do all authentication [ OPTIONAL ]
*
* If this function is implemented it will be used to
* authenticate a user - all other DokuWiki internals
* will not be used for authenticating, thus
* implementing the functions below becomes optional.
*
* The function can be used to authenticate against third
* party cookies or Apache auth mechanisms and replaces
* the auth_login() function
*
* The function will be called with or without a set
* username. If the Username is given it was called
* from the login form and the given credentials might
* need to be checked. If no username was given it
* the function needs to check if the user is logged in
* by other means (cookie, environment).
*
* The function needs to set some globals needed by
* DokuWiki like auth_login() does.
*
* @see auth_login()
* @author Andreas Gohr <andi@splitbrain.org>
*
* @param string $user Username
* @param string $pass Cleartext Password
* @param bool $sticky Cookie should not expire
* @return bool true on successful auth
*/
# function trustExternal($user,$pass,$sticky=false){
# global $USERINFO;
# global $conf;
# $sticky ? $sticky = true : $sticky = false; //sanity check
#
# // do the checking here
#
# // set the globals if authed
# $USERINFO['name'] = 'FIXME';
# $USERINFO['mail'] = 'FIXME';
# $USERINFO['grps'] = array('FIXME');
# $_SERVER['REMOTE_USER'] = $user;
# $_SESSION[$conf['title']]['auth']['user'] = $user;
# $_SESSION[$conf['title']]['auth']['pass'] = $pass;
# $_SESSION[$conf['title']]['auth']['info'] = $USERINFO;
# return true;
# }
/**
* Check user+password [ MUST BE OVERRIDDEN ]
*
* Checks if the given user exists and the given
* plaintext password is correct
*
* @author Andreas Gohr <andi@splitbrain.org>
* @return bool
*/
function checkPass($user,$pass){
msg("no valid authorisation system in use", -1);
return false;
}
/**
* Return user info [ MUST BE OVERRIDDEN ]
*
* Returns info about the given user needs to contain
* at least these fields:
*
* name string full name of the user
* mail string email addres of the user
* grps array list of groups the user is in
*
* @author Andreas Gohr <andi@splitbrain.org>
* @return array containing user data or false
*/
function getUserData($user) {
msg("no valid authorisation system in use", -1);
return false;
}
/**
* Create a new User [implement only where required/possible]
*
* Returns false if the user already exists, null when an error
* occured and the cleartext password of the new user if
* everything went well.
*
* The new user HAS TO be added to the default group by this
* function!
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
# function createUser($user,$pass,$name,$mail,$grps=null){
#
# msg("authorisation method does not allow creation of new users", -1);
# return null;
# }
/**
* Modify user data [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @param $user nick of the user to be changed
* @param $changes array of field/value pairs to be changed (password will be clear text)
* @return bool
*/
# function modifyUser($user, $changes) {
# msg("authorisation method does not allow modifying of user data", -1);
# return false;
# }
/**
* Delete one or more users [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @param array $users
* @return int number of users deleted
*/
# function deleteUsers($users) {
# msg("authorisation method does not allow deleting of users", -1);
# return false;
# }
/**
* Return a count of the number of user which meet $filter criteria
* [should be implemented whenever retrieveUsers is implemented]
*
* @author Chris Smith <chris@jalakai.co.uk>
*/
# function getUserCount($filter=array()) {
#
# msg("authorisation method does not provide user counts", -1);
# return 0;
# }
/**
* Bulk retrieval of user data [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @param start index of first user to be returned
* @param limit max number of users to be returned
* @param filter array of field/pattern pairs, null for no filter
* @return array of userinfo (refer getUserData for internal userinfo details)
*/
# function retrieveUsers($start=0,$limit=-1,$filter=null) {
# msg("authorisation method does not support mass retrieval of user data", -1);
# return array();
# }
/**
* Define a group [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @return bool
*/
# function addGroup($group) {
# msg("authorisation method does not support independent group creation", -1);
# return false;
# }
/**
* Retrieve groups [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @return array
*/
# function retrieveGroups($start=0,$limit=0) {
# msg("authorisation method does not support group list retrieval", -1);
# return array();
# }
/**
* Give user membership of a group [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @return bool
*/
# function joinGroup($user, $group) {
# msg("authorisation method does not support alteration of group memberships", -1);
# return false;
# }
/**
* Remove user from a group [implement only where required/possible]
*
* @author Chris Smith <chris@jalakai.co.uk>
* @return bool
*/
# function leaveGroup($user, $group) {
# msg("authorisation method does not support alteration of group memberships", -1);
# return false;
# }
}
|
