PEAR::AuthにPDOのContainerを追加してみる(検証中)

今作っているアプリのAPIに認証部分を作ろうと思って、PHPのPEARを探していました。
定番はPEAR::Authなのですが、データベースとの接続部分がDBだったりMDB2だったりと、
現在PDOをベースに作っているのでわざわざこれだけのために他のPEARをいれるのも・・・と思って、作りました。

もともと、AuthのContainerは自作できるような仕組みになっているらしく
拡張はできそうです。とはいえ、一番よく使われていて、文書も多いDBをベースにPDOで使えるようにという形で
作ってみました。

■PEARの独自コンテナの作り方(公式マニュアル)
http://pear.php.net/manual/ja/package.authentication.auth.storage.custom.php


■サーバのPHP情報

・PHP-5.3.3(CentOS6 のrpmです)
・PEAR1.9.4
・Auth1.6.4

■もとになるファイルを探す。

# cd /usr/share/pear/Auth/Container/
# ls
Array.php   File.php   LDAP.php  Multiple.php      PEAR.php    SAP.php        SOAP5.php
DB.php      IMAP.php   MDB.php   NetVPOPMaild.php  POP3.php    SMBPasswd.php  vpopmail.php
DBLite.php  KADM5.php  MDB2.php  PDO.php           RADIUS.php  SOAP.php



コピーして作ったPDO.php
これまだ、addUserしか確認していませんし、コメントのauthorとか書き換えていないので問題な感じです。
※呼び出し方もNGですしw。

require_once $base."/lib/pear.auth.PDO.class.php";
require_once("Auth/Auth.php");
 
$auth_container = new Auth_Container_PDO($params);
$auth_obj = new Auth($auth_container);


こんな形で呼び出しました。$baseは自分のプログラムrootとかにしておく感じですかね。名前は冗長ですが。。

Prepareを使って、SQLインジェクションに強くしようとしていますが、_prepare() でテーブル名を
クォートしてるところで、Postgresqlは”ダブルクォーテーションのはずが、なぜか’シングルクォーテーションに
なってしまって、auto_quote => false のパラメータで呼び出しています。

追記
addUser のテーブルに、usernameのカラムをUNIQUE制約つけて同じ名前を登録してみたら、
エラーが出ずにレコードが追加されないという状態に。
エラーハンドリングしたかったんだけれどなぁ。。。「同じ名前が存在しますとか」
また頑張ってみよう。

# cat PDO.php

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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 foldmethod=marker: */
 
/**
 * Storage driver for use against PDO
 *
 * PHP versions 4 and 5
 *
 * LICENSE: This source file is subject to version 3.01 of the PHP license
 * that is available through the world-wide-web at the following URI:
 * http://www.php.net/license/3_01.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   Authentication
 * @package    Auth
 * @author     Original Author Martin Jansen <mj@php.net>
 * @author     Original Author Adam Ashley <aashley@php.net>
 * @copyright  2001-2006 The PHP Group
 * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
 * @version    2011-09-05 copied from DB.php
 * @link       http://pear.php.net/package/Auth
 */
 
/**
 * Include Auth_Container base class
 */
include_once 'Auth/Container.php';
include_once 'PEAR.php';
 
/**
 * Storage driver for fetching login data from a database
 *
 * This storage driver can use all databases which are supported
 * by the PEAR DB abstraction layer to fetch login data.
 *
 * @category   Authentication
 * @package    Auth
 * @author     Original Author Martin Jansen <mj@php.net>
 * @author     Original Author Adam Ashley <aashley@php.net>
 * @copyright  2001-2006 The PHP Group
 * @license    http://www.php.net/license/3_01.txt  PHP License 3.01
 * @version    2011-09-05
 * @link       http://pear.php.net/package/Auth
 */
class Auth_Container_PDO extends Auth_Container
{
 
    // {{{ properties
 
    /**
     * Additional options for the storage container
     * @var array
     */
    var $options = array();
 
    /**
     * DB object
     * @var object
     */
    var $db = null;
    var $dsn = '';
 
    /**
     * User that is currently selected from the DB.
     * @var string
     */
    var $activeUser = '';
 
    // }}}
    // {{{ Auth_Container_DB [constructor]
 
    /**
     * Constructor of the container class
     *
     * Save the initial options passed to the container. Initiation of the DB
     * connection is no longer performed here and is only done when needed.
     *
     * @param  string Connection data or DB object
     * @return object Returns an error object if something went wrong
     */
    function Auth_Container_PDO($dsn)
    {
        $this->_setDefaults();
 
        if (is_array($dsn)) {
            $this->_parseOptions($dsn);
 
            if (empty($this->options['dsn'])) {
                PEAR::raiseError('No connection parameters specified!');
            }
        } else {
            $this->options['dsn'] = $dsn;
        }
    }
 
    // }}}
    // {{{ _connect()
 
    /**
     * Connect to database by using the given DSN string
     *
     * @access private
     * @param  string DSN string
     * @return mixed  Object on error, otherwise bool
     */
    function _connect($dsn)
    {
        $this->log('Auth_Container_PDO::_connect() called.', AUTH_LOG_DEBUG);
 
    try {
        if (is_string($dsn) || is_array($dsn)) {
            //$this->db = new PDO($dsn, $this->options['db_options']);
            $this->db = new PDO($dsn, $this->options['db_user'],$this->options['db_password']);
        } else {
            return PEAR::raiseError('The given dsn was not valid in file ' . __FILE__ . ' at line ' . __LINE__,
                                    41,
                                    PEAR_ERROR_RETURN,
                                    null,
                                    null
                                    );
        }
    }catch(PDOException $e){
        return PEAR::raiseError($e->getMessage());
    } // try
    return true;
 
    }
 
    // }}}
    // {{{ _prepare()
 
    /**
     * Prepare database connection
     *
     * This function checks if we have already opened a connection to
     * the database. If that's not the case, a new connection is opened.
     *
     * @access private
     * @return mixed True or a DB error object.
     */
    function _prepare()
    {
        try {
          $res = $this->_connect($this->options['dsn']);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());
        } // try
 
        try {
        if ($this->options['auto_quote'] && $this->db->dsn['phptype'] != 'sqlite') {
            if (strpos('.', $this->options['table']) === false) {
                // Postgresql quote is " but quote function add ' .
                $this->options['final_table'] = $this->db->quote($this->options['table']);
            } else {
                $t = explode('.', $this->options['table']);
                for ($i = 0, $count = count($t); $i < $count; $i++)
                    $t[$i] = $this->db->quote($t[$i]);
                $this->options['final_table'] = implode('.', $t);
            }
            $this->options['final_usernamecol'] = $this->db->quote($this->options['usernamecol']);
            $this->options['final_passwordcol'] = $this->db->quote($this->options['passwordcol']);
        } else {
            $this->options['final_table'] = $this->options['table'];
            $this->options['final_usernamecol'] = $this->options['usernamecol'];
            $this->options['final_passwordcol'] = $this->options['passwordcol'];
        } // if auto_quote
        }catch(Exception $e){
            return PEAR::raiseError($e->getMessage());
        } // try
        return true;
    }
 
    // }}}
    // {{{ query()
 
    /**
     * Prepare query to the database
     *
     * This function checks if we have already opened a connection to
     * the database. If that's not the case, a new connection is opened.
     * After that the query is passed to the database.
     *
     * @access public
     * @param  string Query string
     * @return mixed  a DB_result object or DB_OK on success, a DB
     *                or PEAR error on failure
     */
/*
    function query($query)
    {
        $err = $this->_prepare();
        if ($err !== true) {
            return $err;
        }
        return $this->db->query($query);
    }
*/
 
    // }}}
    // {{{ _setDefaults()
 
    /**
     * Set some default options
     *
     * @access private
     * @return void
     */
    function _setDefaults()
    {
        $this->options['table']       = 'auth';
        $this->options['usernamecol'] = 'username';
        $this->options['passwordcol'] = 'password';
        $this->options['dsn']         = '';
        $this->options['db_fields']   = '';
        $this->options['cryptType']   = 'md5';
        $this->options['db_options']  = array();
        $this->options['db_where']    = '';
        $this->options['auto_quote']  = true;
        $this->options['db_user']     = 'postgres';
        $this->options['db_password'] = '';
    }
 
    // }}}
    // {{{ _parseOptions()
 
    /**
     * Parse options passed to the container class
     *
     * @access private
     * @param  array
     */
    function _parseOptions($array)
    {
        foreach ($array as $key => $value) {
            if (isset($this->options[$key])) {
                $this->options[$key] = $value;
            }
        }
    }
 
    // }}}
    // {{{ _quoteDBFields()
 
    /**
     * Quote the db_fields option to avoid the possibility of SQL injection.
     *
     * @access private
     * @return string A properly quoted string that can be concatenated into a
     * SELECT clause.
     */
    function _quoteDBFields()
    {
        if (isset($this->options['db_fields'])) {
            if (is_array($this->options['db_fields'])) {
                if ($this->options['auto_quote']) {
                    $fields = array();
                    foreach ($this->options['db_fields'] as $field) {
                        $fields[] = $this->db->quote($field);
                    }
                    return implode(', ', $fields);
                } else {
                    return implode(', ', $this->options['db_fields']);
                }
            } else {
                if (strlen($this->options['db_fields']) > 0) {
                    if ($this->options['auto_quote']) {
                        return $this->db->quote($this->options['db_fields']);
                    } else {
                        return $this->options['db_fields'];
                    }
                }
            }
        }
 
        return '';
    }
 
    // }}}
    // {{{ fetchData()
 
    /**
     * Get user information from database
     *
     * This function uses the given username to fetch
     * the corresponding login data from the database
     * table. If an account that matches the passed username
     * and password is found, the function returns true.
     * Otherwise it returns false.
     *
     * @param   string Username
     * @param   string Password
     * @param   boolean If true password is secured using a md5 hash
     *                  the frontend and auth are responsible for making sure the container supports
     *                  challenge response password authentication
     * @return  mixed  Error object or boolean
     */
    function fetchData($username, $password, $isChallengeResponse=false)
    {
        $this->log('Auth_Container_PDO::fetchData() called.', AUTH_LOG_DEBUG);
        // Prepare for a database query
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }
 
        // Find if db_fields contains a *, if so assume all columns are selected
        if (is_string($this->options['db_fields'])
            && strstr($this->options['db_fields'], '*')) {
            $sql_from = "*";
        } else {
            $sql_from = $this->options['final_usernamecol'].
                ", ".$this->options['final_passwordcol'];
 
            if (strlen($fields = $this->_quoteDBFields()) > 0) {
                $sql_from .= ', '.$fields;
            }
        }
 
        $query = "SELECT ".$sql_from.
                " FROM ".$this->options['final_table'].
                " WHERE ".$this->options['final_usernamecol']." = :username";
 
        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $query .= " AND ".$this->options['db_where'];
        }
 
        $sth = $this->db->prepare($query);
        $sth->bindParam(':username', $username, PDO::PARAM_STR); 
 
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        try{
        $sth->execute();
        $res = $sth->fetch(PDO::FETCH_ASSOC);
        //$res = $this->db->getRow($query, null, DB_FETCHMODE_ASSOC);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());
        } // try
 
 
        if (!is_array($res)) {
            $this->activeUser = '';
            return false;
        }
 
        // Perform trimming here before the hashihg
        $password = trim($password, "\r\n");
        $res[$this->options['passwordcol']] = trim($res[$this->options['passwordcol']], "\r\n");
 
        // If using Challenge Response md5 the pass with the secret
        if ($isChallengeResponse) {
            $res[$this->options['passwordcol']] = md5($res[$this->options['passwordcol']]
                    .$this->_auth_obj->session['loginchallenege']);
 
            // UGLY cannot avoid without modifying verifyPassword
            if ($this->options['cryptType'] == 'md5') {
                $res[$this->options['passwordcol']] = md5($res[$this->options['passwordcol']]);
            }
 
            //print " Hashed Password [{$res[$this->options['passwordcol']]}]<br/>\n";
        }
 
        if ($this->verifyPassword($password,
                                  $res[$this->options['passwordcol']],
                                  $this->options['cryptType'])) {
            // Store additional field values in the session
            foreach ($res as $key => $value) {
                if ($key == $this->options['passwordcol'] ||
                    $key == $this->options['usernamecol']) {
                    continue;
                }
 
                $this->log('Storing additional field: '.$key, AUTH_LOG_DEBUG);
 
                // Use reference to the auth object if exists
                // This is because the auth session variable can change so a
                // static call to setAuthData does not make sence
                $this->_auth_obj->setAuthData($key, $value);
            }
            return true;
        }
        $this->activeUser = $res[$this->options['usernamecol']];
        return false;
    }
 
    // }}}
    // {{{ listUsers()
 
    /**
     * Returns a list of users from the container
     *
     * @return mixed
     * @access public
     */
    function listUsers()
    {
        $this->log('Auth_Container_PDO::listUsers() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }
 
        $retVal = array();
 
        // Find if db_fields contains a *, if so assume all col are selected
        if (   is_string($this->options['db_fields'])
            && strstr($this->options['db_fields'], '*')) {
            $sql_from = "*";
        } else {
            $sql_from = $this->options['final_usernamecol'].
                ", ".$this->options['final_passwordcol'];
 
            if (strlen($fields = $this->_quoteDBFields()) > 0) {
                $sql_from .= ', '.$fields;
            }
        }
 
        $query = sprintf("SELECT %s FROM %s",
                         $sql_from,
                         $this->options['final_table']
                         );
 
        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $query .= " WHERE ".$this->options['db_where'];
        }
 
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        $sth = $this->db->prepare($query);
        try{        
            $sth->execute();        
            $res = $sth->fetch(PDO::FETCH_ASSOC);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());        
        } // try
 
        foreach ($res as $user) {
            $user['username'] = $user[$this->options['usernamecol']];
            $retVal[] = $user;
        }
 
        $this->log('Found '.count($retVal).' users.', AUTH_LOG_DEBUG);
        return $retVal;
    }
 
    // }}}
    // {{{ addUser()
 
    /**
     * Add user to the storage container
     *
     * @access public
     * @param  string Username
     * @param  string Password
     * @param  mixed  Additional information that are stored in the DB
     *
     * @return mixed True on success, otherwise error object
     */
    function addUser($username, $password, $additional = "")
    {
        $this->log('Auth_Container_PDO::addUser() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }
 
        if (   isset($this->options['cryptType'])
            && $this->options['cryptType'] == 'none') {
            $cryptFunction = 'strval';
        } elseif (   isset($this->options['cryptType'])
                  && function_exists($this->options['cryptType'])) {
            $cryptFunction = $this->options['cryptType'];
        } else {
            $cryptFunction = 'md5';
        }
 
        $password = $cryptFunction($password);
 
        $additional_key   = '';
        $additional_value = '';
 
        if (is_array($additional)) {
            foreach ($additional as $key => $value) {
                if ($this->options['auto_quote']) {
                    $additional_key .= ', ' . $this->db->quote($key);
                } else {
                    $additional_key .= ', ' . $key;
                }
                $additional_value .= ", " . $value;
            }
        }
 
        $query = sprintf("INSERT INTO %s (%s, %s%s) VALUES (%s, %s%s)",
                         $this->options['final_table'],
                         $this->options['final_usernamecol'],
                         $this->options['final_passwordcol'],
                         $additional_key,
                         ':username',
                         ':password',
                         $additional_value
                         );
 
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        $sth = $this->db->prepare($query);
        $sth->bindParam(':username', $username, PDO::PARAM_STR);
        $sth->bindParam(':password', $password, PDO::PARAM_STR);
 
        try{        
            $sth->execute();        
            $res = $sth->fetch(PDO::FETCH_ASSOC);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());        
        } // try
 
        return true;
    }
 
    // }}}
    // {{{ removeUser()
 
    /**
     * Remove user from the storage container
     *
     * @access public
     * @param  string Username
     *
     * @return mixed True on success, otherwise error object
     */
    function removeUser($username)
    {
        $this->log('Auth_Container_PDO::removeUser() called.', AUTH_LOG_DEBUG);
 
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }
 
        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $where = " AND ".$this->options['db_where'];
        } else {
            $where = '';
        }
 
        $query = sprintf("DELETE FROM %s WHERE %s = %s %s",
                         $this->options['final_table'],
                         $this->options['final_usernamecol'],
                         ':username',
                         $where
                         );
 
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        $sth = $this->db->prepare($query);
        $sth->bindParam(':username', $username, PDO::PARAM_STR);
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        try{        
            $sth->execute();        
            $res = $sth->fetch(PDO::FETCH_ASSOC);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());        
        } // try
 
        return true;
    }
 
    // }}}
    // {{{ changePassword()
 
    /**
     * Change password for user in the storage container
     *
     * @param string Username
     * @param string The new password (plain text)
     */
    function changePassword($username, $password)
    {
        $this->log('Auth_Container_PDO::changePassword() called.', AUTH_LOG_DEBUG);
        $err = $this->_prepare();
        if ($err !== true) {
            return PEAR::raiseError($err->getMessage(), $err->getCode());
        }
 
        if (   isset($this->options['cryptType'])
            && $this->options['cryptType'] == 'none') {
            $cryptFunction = 'strval';
        } elseif (   isset($this->options['cryptType'])
                  && function_exists($this->options['cryptType'])) {
            $cryptFunction = $this->options['cryptType'];
        } else {
            $cryptFunction = 'md5';
        }
 
        $password = $cryptFunction($password);
 
        // check if there is an optional parameter db_where
        if ($this->options['db_where'] != '') {
            // there is one, so add it to the query
            $where = " AND ".$this->options['db_where'];
        } else {
            $where = '';
        }
 
        $query = sprintf("UPDATE %s SET %s = %s WHERE %s = %s %s",
                         $this->options['final_table'],
                         $this->options['final_passwordcol'],
                         ':password',
                         $this->options['final_usernamecol'],
                         ':username',
                         $where
                         );
 
        $this->log('Running SQL against DB: '.$query, AUTH_LOG_DEBUG);
 
        $sth = $this->db->prepare($query);
        $sth->bindParam(':username', $username, PDO::PARAM_STR);
        $sth->bindParam(':password', $password, PDO::PARAM_STR);
 
        try{        
            $sth->execute();        
            $res = $sth->fetch(PDO::FETCH_ASSOC);
        }catch(PDOException $e){
            return PEAR::raiseError($e->getMessage());        
        } // try
 
        return true;
    }
 
    // }}}
    // {{{ supportsChallengeResponse()
 
    /**
     * Determine if this container supports
     * password authentication with challenge response
     *
     * @return bool
     * @access public
     */
    function supportsChallengeResponse()
    {
        return in_array($this->options['cryptType'], array('md5', 'none', ''));
    }
 
    // }}}
    // {{{ getCryptType()
 
    /**
      * Returns the selected crypt type for this container
      */
    function getCryptType()
    {
        return($this->options['cryptType']);
    }
 
    // }}}
 
}
?>