112 lines
2.0 KiB
PHP
112 lines
2.0 KiB
PHP
<?php
|
|
|
|
namespace Sabre\HTTP;
|
|
|
|
/**
|
|
* HTTP Authentication baseclass
|
|
*
|
|
* This class has the common functionality for BasicAuth and DigestAuth
|
|
*
|
|
* @copyright Copyright (C) 2007-2015 fruux GmbH (https://fruux.com/).
|
|
* @author Evert Pot (http://evertpot.com/)
|
|
* @license http://sabre.io/license/ Modified BSD License
|
|
*/
|
|
abstract class AbstractAuth {
|
|
|
|
/**
|
|
* The realm will be displayed in the dialog boxes
|
|
*
|
|
* This identifier can be changed through setRealm()
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $realm = 'SabreDAV';
|
|
|
|
/**
|
|
* HTTP response helper
|
|
*
|
|
* @var Sabre\HTTP\Response
|
|
*/
|
|
protected $httpResponse;
|
|
|
|
|
|
/**
|
|
* HTTP request helper
|
|
*
|
|
* @var Sabre\HTTP\Request
|
|
*/
|
|
protected $httpRequest;
|
|
|
|
/**
|
|
* __construct
|
|
*
|
|
*/
|
|
public function __construct() {
|
|
|
|
$this->httpResponse = new Response();
|
|
$this->httpRequest = new Request();
|
|
|
|
}
|
|
|
|
/**
|
|
* Sets an alternative HTTP response object
|
|
*
|
|
* @param Response $response
|
|
* @return void
|
|
*/
|
|
public function setHTTPResponse(Response $response) {
|
|
|
|
$this->httpResponse = $response;
|
|
|
|
}
|
|
|
|
/**
|
|
* Sets an alternative HTTP request object
|
|
*
|
|
* @param Request $request
|
|
* @return void
|
|
*/
|
|
public function setHTTPRequest(Request $request) {
|
|
|
|
$this->httpRequest = $request;
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* Sets the realm
|
|
*
|
|
* The realm is often displayed in authentication dialog boxes
|
|
* Commonly an application name displayed here
|
|
*
|
|
* @param string $realm
|
|
* @return void
|
|
*/
|
|
public function setRealm($realm) {
|
|
|
|
$this->realm = $realm;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns the realm
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getRealm() {
|
|
|
|
return $this->realm;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns an HTTP 401 header, forcing login
|
|
*
|
|
* This should be called when username and password are incorrect, or not supplied at all
|
|
*
|
|
* @return void
|
|
*/
|
|
abstract public function requireLogin();
|
|
|
|
}
|