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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
<?php /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/** * File::Passwd::Custom * * PHP versions 4 and 5 * * LICENSE: This source file is subject to version 3.0 of the PHP license * that is available through the world-wide-web at the following URI: * http://www.php.net/license/3_0.txt. If you did not receive a copy of * the PHP License and are unable to obtain it through the web, please * send a note to license@php.net so we can mail you a copy immediately. * * @category FileFormats * @package File_Passwd * @author Michael Wallner <mike@php.net> * @copyright 2003-2005 Michael Wallner * @license http://www.php.net/license/3_0.txt PHP License 3.0 * @version CVS: $Id: Custom.php,v 1.10 2005/03/30 18:33:33 mike Exp $ * @link http://pear.php.net/package/File_Passwd */
/** * Requires File::Passwd::Common */ require_once 'File/Passwd/Common.php';
/** * Manipulate custom formatted passwd files * * Usage Example: * <code> * $cust = &File_Passwd::factory('Custom'); * $cust->setDelim('|'); * $cust->load(); * $cust->setEncFunc(array('File_Passwd', 'crypt_apr_md5')); * $cust->addUser('mike', 'pass'); * $cust->save(); * </code> * * @author Michael Wallner <mike@php.net> * @version $Revision: 1.10 $ * @access public */ class File_Passwd_Custom extends File_Passwd_Common { /** * Delimiter * * @access private * @var string */ var $_delim = ':'; /** * Encryption function * * @access private * @var string */ var $_enc = array('File_Passwd', 'crypt_md5'); /** * 'name map' * * @access private * @var array */ var $_map = array(); /** * Whether to use the 'name map' or not * * @var boolean * @access private */ var $_usemap = false;
/** * Constructor * * @access protected * @return object */ function File_Passwd_Custom($file = 'passwd') { $this->__construct($file); }
/** * Fast authentication of a certain user * * Returns a PEAR_Error if: * o file doesn't exist * o file couldn't be opened in read mode * o file couldn't be locked exclusively * o file couldn't be unlocked (only if auth fails) * o file couldn't be closed (only if auth fails) * o invalid encryption function <var>$opts[0]</var>, * or no delimiter character <var>$opts[1]</var> was provided * * @throws PEAR_Error FILE_PASSWD_E_UNDEFINED | * FILE_PASSWD_E_FILE_NOT_OPENED | * FILE_PASSWD_E_FILE_NOT_LOCKED | * FILE_PASSWD_E_FILE_NOT_UNLOCKED | * FILE_PASSWD_E_FILE_NOT_CLOSED | * FILE_PASSWD_E_INVALID_ENC_MODE * @static call this method statically for a reasonable fast authentication * @access public * @return mixed Returns &true; if authenticated, &false; if not or * <classname>PEAR_Error</classname> on failure. * @param string $file path to passwd file * @param string $user user to authenticate * @param string $pass plaintext password * @param array $otps encryption function and delimiter charachter * (in this order) */ function staticAuth($file, $user, $pass, $opts) { setType($opts, 'array'); if (count($opts) != 2 || empty($opts[1])) { return PEAR::raiseError('Insufficient options.', 0); } $line = File_Passwd_Common::_auth($file, $user, $opts[1]); if (!$line || PEAR::isError($line)) { return $line; } list(,$real)= explode($opts[1], $line); $crypted = File_Passwd_Custom::_genPass($pass, $real, $opts[0]); if (PEAR::isError($crypted)) { return $crypted; } return ($crypted === $real); }
/** * Set delimiter * * You can set a custom char to delimit the columns of a data set. * Defaults to a colon (':'). Be aware that this char mustn't be * in the values of your data sets. * * @access public * @return void * @param string $delim custom delimiting character */ function setDelim($delim = ':') { @setType($delim, 'string'); if (empty($delim)) { $this->_delim = ':'; } else { $this->_delim = $delim{0}; } } /** * Get custom delimiter * * @access public * @return string */ function getDelim() { return $this->_delim; } /** * Set encryption function * * You can set a custom encryption function to use. * The supplied function will be called by php's call_user_function(), * so you can supply an array with a method of a class/object, too * (i.e. array('File_Passwd', 'crypt_apr_md5'). * * * @throws PEAR_Error FILE_PASSWD_E_INVALID_ENC_MODE * @access public * @return mixed Returns &true; on success or * <classname>PEAR_Error</classname> on failure. * @param mixed $function callable encryption function */ function setEncFunc($function = array('File_Passwd', 'crypt_md5')) { if (!is_callable($function)) { if (is_array($function)) { $function = implode('::', $function); } return PEAR::raiseError( sprintf(FILE_PASSWD_E_INVALID_ENC_MODE_STR, $function), FILE_PASSWD_E_INVALID_ENC_MODE ); } $this->_enc = $function; return true; } /** * Get current custom encryption method * * Possible return values (examples): * o 'md5' * o 'File_Passwd::crypt_md5' * * @access public * @return string */ function getEncFunc() { if (is_array($this->_enc)) { return implode('::', $this->_enc); } return $this->_enc; } /** * Whether to use the 'name map' of the extra properties or not * * @see File_Passwd_Custom::useMap() * @see setMap() * @see getMap() * * @access public * @return boolean always true if you set a value (true/false) OR * the actual value if called without param * * @param boolean $bool whether to use the 'name map' or not */ function useMap($bool = null) { if (is_null($bool)) { return $this->_usemap; } $this->_usemap = (bool) $bool; return true; } /** * Set the 'name map' to use with the extra properties of the user * * This map is used for naming the associative array of the extra properties. * * Returns a PEAR_Error if <var>$map</var> was not of type array. * * @see getMap() * @see useMap() * * @throws PEAR_Error FILE_PASSWD_E_PARAM_MUST_BE_ARRAY * @access public * @return mixed true on success or PEAR_Error */ function setMap($map = array()) { if (!is_array($map)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_PARAM_MUST_BE_ARRAY_STR, '$map'), FILE_PASSWD_E_PARAM_MUST_BE_ARRAY ); } $this->_map = $map; return true; } /** * Get the 'name map' which is used for the extra properties of the user * * @see setMap() * @see useMap() * * @access public * @return array */ function getMap() { return $this->_map; }
/** * Apply changes an rewrite passwd file * * Returns a PEAR_Error if: * o directory in which the file should reside couldn't be created * o file couldn't be opened in write mode * o file couldn't be locked exclusively * o file couldn't be unlocked * o file couldn't be closed * * @throws PEAR_Error FILE_PASSWD_E_FILE_NOT_OPENED | * FILE_PASSWD_E_FILE_NOT_LOCKED | * FILE_PASSWD_E_FILE_NOT_UNLOCKED | * FILE_PASSWD_E_FILE_NOT_CLOSED * @access public * @return mixed Returns &true; on success or * <classname>PEAR_Error</classname> on failure. */ function save() { $content = ''; foreach ($this->_users as $user => $array){ $pass = array_shift($array); $extra = implode($this->_delim, $array); $content .= $user . $this->_delim . $pass; if (!empty($extra)) { $content .= $this->_delim . $extra; } $content .= "\n"; } return $this->_save($content); }
/** * Parse the Custom password file * * Returns a PEAR_Error if passwd file has invalid format. * * @throws PEAR_Error FILE_PASSWD_E_INVALID_FORMAT * @access public * @return mixed Returns &true; on success or * <classname>PEAR_Error</classname> on failure. */ function parse() { $this->_users = array(); foreach ($this->_contents as $line){ $parts = explode($this->_delim, $line); if (count($parts) < 2) { return PEAR::raiseError( FILE_PASSWD_E_INVALID_FORMAT_STR, FILE_PASSWD_E_INVALID_FORMAT ); } $user = array_shift($parts); $pass = array_shift($parts); $values = array(); if ($this->_usemap) { $values['pass'] = $pass; foreach ($parts as $i => $value){ if (isset($this->_map[$i])) { $values[$this->_map[$i]] = $value; } else { $values[$i+1] = $value; } } } else { $values = array_merge(array($pass), $parts); } $this->_users[$user] = $values; } $this->_contents = array(); return true; }
/** * Add an user * * The username must start with an alphabetical character and must NOT * contain any other characters than alphanumerics, the underline and dash. * * If you use the 'name map' you should also use these naming in * the supplied extra array, because your values would get mixed up * if they are in the wrong order, which is always true if you * DON'T use the 'name map'! * * So be warned and USE the 'name map'! * * Returns a PEAR_Error if: * o user already exists * o user contains illegal characters * o encryption mode is not supported * o any element of the <var>$extra</var> array contains the delimiter char * * @throws PEAR_Error FILE_PASSWD_E_EXISTS_ALREADY | * FILE_PASSWD_E_INVALID_ENC_MODE | * FILE_PASSWD_E_INVALID_CHARS * @access public * @return mixed Returns &true; on success or * <classname>PEAR_Error</classname> on failure. * @param string $user the name of the user to add * @param string $pass the password of the user to add * @param array $extra extra properties of user to add */ function addUser($user, $pass, $extra = array()) { if ($this->userExists($user)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_EXISTS_ALREADY_STR, 'User ', $user), FILE_PASSWD_E_EXISTS_ALREADY ); } if (!preg_match($this->_pcre, $user) || strstr($user, $this->_delim)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_INVALID_CHARS_STR, 'User ', $user), FILE_PASSWD_E_INVALID_CHARS ); } if (!is_array($extra)) { setType($extra, 'array'); } foreach ($extra as $e){ if (strstr($e, $this->_delim)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_INVALID_CHARS_STR, 'Property ', $e), FILE_PASSWD_E_INVALID_CHARS ); } } $pass = $this->_genPass($pass); if (PEAR::isError($pass)) { return $pass; } /** * If you don't use the 'name map' the user array will be numeric. */ if (!$this->_usemap) { array_unshift($extra, $pass); $this->_users[$user] = $extra; } else { $map = $this->_map; array_unshift($map, 'pass'); $extra['pass'] = $pass; foreach ($map as $key){ $this->_users[$user][$key] = @$extra[$key]; } } return true; }
/** * Modify properties of a certain user * * # DON'T MODIFY THE PASSWORD WITH THIS METHOD! * * You should use this method only if the 'name map' is used, too. * * Returns a PEAR_Error if: * o user doesn't exist * o any property contains the custom delimiter character * * @see changePasswd() * * @throws PEAR_Error FILE_PASSWD_E_EXISTS_NOT | * FILE_PASSWD_E_INVALID_CHARS * @access public * @return mixed true on success or PEAR_Error * @param string $user the user to modify * @param array $properties an associative array of * properties to modify */ function modUser($user, $properties = array()) { if (!$this->userExists($user)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_EXISTS_NOT_STR, 'User ', $user), FILE_PASSWD_E_EXISTS_NOT ); } if (!is_array($properties)) { setType($properties, 'array'); } foreach ($properties as $key => $value){ if (strstr($value, $this->_delim)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_INVALID_CHARS_STR, 'User ', $user), FILE_PASSWD_E_INVALID_CHARS ); } $this->_users[$user][$key] = $value; } return true; }
/** * Change the password of a certain user * * Returns a PEAR_Error if: * o user doesn't exists * o encryption mode is not supported * * @throws PEAR_Error FILE_PASSWD_E_EXISTS_NOT | * FILE_PASSWD_E_INVALID_ENC_MODE * @access public * @return mixed Returns &true; on success or * <classname>PEAR_Error</classname> on failure. * @param string $user the user whose password should be changed * @param string $pass the new plaintext password */ function changePasswd($user, $pass) { if (!$this->userExists($user)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_EXISTS_NOT_STR, 'User ', $user), FILE_PASSWD_E_EXISTS_NOT ); } $pass = $this->_genPass($pass); if (PEAR::isError($pass)) { return $pass; } if ($this->_usemap) { $this->_users[$user]['pass'] = $pass; } else { $this->_users[$user][0] = $pass; } return true; }
/** * Verify the password of a certain user * * Returns a PEAR_Error if: * o user doesn't exist * o encryption mode is not supported * * @throws PEAR_Error FILE_PASSWD_E_EXISTS_NOT | * FILE_PASSWD_E_INVALID_ENC_MODE * @access public * @return mixed Returns &true; if passwors equal, &false; if they don't * or <classname>PEAR_Error</classname> on fialure. * @param string $user the user whose password should be verified * @param string $pass the password to verify */ function verifyPasswd($user, $pass) { if (!$this->userExists($user)) { return PEAR::raiseError( sprintf(FILE_PASSWD_E_EXISTS_NOT_STR, 'User ', $user), FILE_PASSWD_E_EXISTS_NOT ); } $real = $this->_usemap ? $this->_users[$user]['pass'] : $this->_users[$user][0] ; return ($real === $this->_genPass($pass, $real)); } /** * Generate crypted password from the plaintext password * * Returns a PEAR_Error if actual encryption mode is not supported. * * @throws PEAR_Error FILE_PASSWD_E_INVALID_ENC_MODE * @access private * @return mixed Returns the crypted password or * <classname>PEAR_Error</classname> * @param string $pass the plaintext password * @param string $salt the crypted password from which to gain the salt * @param string $func the encryption function to use */ function _genPass($pass, $salt = null, $func = null) { if (is_null($func)) { $func = $this->_enc; } if (!is_callable($func)) { if (is_array($func)) { $func = implode('::', $func); } return PEAR::raiseError( sprintf(FILE_PASSWD_E_INVALID_ENC_MODE_STR, $func), FILE_PASSWD_E_INVALID_ENC_MODE ); } $return = @call_user_func($func, $pass, $salt); if (is_null($return) || $return === false) { $return = @call_user_func($func, $pass); } return $return; } } ?>
|