Sabre\HTTP\Auth\Basic Class Reference

HTTP Basic authentication utility. More...

Inheritance diagram for Sabre\HTTP\Auth\Basic:

Collaboration diagram for Sabre\HTTP\Auth\Basic:

Public Member Functions
	getCredentials ()
	This method returns a numeric array with a username and password as the only elements. More...
	requireLogin ()
	This method sends the needed HTTP header and statuscode (401) to force the user to login. More...
Public Member Functions inherited from Sabre\HTTP\Auth\AbstractAuth
	__construct ($realm='SabreTooth', RequestInterface $request, ResponseInterface $response)
	Creates the object. More...
	requireLogin ()
	This method sends the needed HTTP header and statuscode (401) to force the user to login. More...
	getRealm ()
	Returns the HTTP realm. More...

Additional Inherited Members
Protected Attributes inherited from Sabre\HTTP\Auth\AbstractAuth
	$realm
	$request
	$response

Detailed Description

HTTP Basic authentication utility.

This class helps you setup basic auth. The process is fairly simple:

1. Instantiate the class.
2. Call getCredentials (this will return null or a user/pass pair)
3. If you didn't get valid credentials, call 'requireLogin'

Copyright

Copyright (C) fruux GmbH (https://fruux.com/)

Author

Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 18 of file Basic.php.

Member Function Documentation

getCredentials()

Sabre\HTTP\Auth\Basic::getCredentials

(

)

This method returns a numeric array with a username and password as the only elements.

If no credentials were found, this method returns null.

Returns

null|array

Definition at line 28 of file Basic.php.

References $auth.

                              {

        $auth = $this->request->getHeader('Authorization');

        if (!$auth) {
            return null;
        }

        if (strtolower(substr($auth, 0, 6)) !== 'basic ') {
            return null;
        }

        $credentials = explode(':', base64_decode(substr($auth, 6)), 2);

        if (2 !== count($credentials)) {
            return null;
        }

        return $credentials;

    }

requireLogin()

Sabre\HTTP\Auth\Basic::requireLogin

(

)

This method sends the needed HTTP header and statuscode (401) to force the user to login.

Returns

void

Definition at line 56 of file Basic.php.

                            {

        $this->response->addHeader('WWW-Authenticate', 'Basic realm="' . $this->realm . '", charset="UTF-8"');
        $this->response->setStatus(401);

    }

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/sabre/http/lib/Auth/Basic.php