HttpBearerAuth.php 1.31 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rest;

use Yii;
use yii\base\Component;
use yii\web\UnauthorizedHttpException;

/**
 * HttpBearerAuth implements the authentication method based on HTTP Bearer token.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class HttpBearerAuth extends Component implements AuthInterface
{
22 23 24 25
    /**
     * @var string the HTTP authentication realm
     */
    public $realm = 'api';
Qiang Xue committed
26

27 28 29 30 31 32 33 34 35 36 37
    /**
     * @inheritdoc
     */
    public function authenticate($user, $request, $response)
    {
        $authHeader = $request->getHeaders()->get('Authorization');
        if ($authHeader !== null && preg_match("/^Bearer\\s+(.*?)$/", $authHeader, $matches)) {
            $identity = $user->loginByAccessToken($matches[1]);
            if ($identity !== null) {
                return $identity;
            }
Qiang Xue committed
38

39 40
            $this->handleFailure($response);
        }
Qiang Xue committed
41

42 43 44 45 46 47 48 49 50 51 52
        return null;
    }

    /**
     * @inheritdoc
     */
    public function handleFailure($response)
    {
        $response->getHeaders()->set('WWW-Authenticate', "Bearer realm=\"{$this->realm}\"");
        throw new UnauthorizedHttpException('You are requesting with an invalid access token.');
    }
Qiang Xue committed
53
}