Auth_Yubico Class Reference

Class for verifying Yubico One-Time-Passcodes. More...

Collaboration diagram for Auth_Yubico:

Public Member Functions
	__construct ($id, $key='')
	Constructor. More...
	getLastResponse ()
	Return the last data received from the server, if any. More...
	verify ($token)
	Verify Yubico OTP. More...

Private Attributes
	$_id
	$_key
	$_response

Detailed Description

Class for verifying Yubico One-Time-Passcodes.

Simple example: require_once 'Auth/Yubico.php'; $yubi = &new Auth_Yubico('42'); $auth = $yubi->verify("ccbbddeertkrctjkkcglfndnlihhnvekchkcctif"); if (PEAR::isError($auth)) { print "<p>Authentication failed: " . $auth->getMessage(); print "<p>Debug output from server: " . $yubi->getLastResponse(); } else { print "<p>You are authenticated!"; }

Definition at line 59 of file Yubico.php.

Constructor & Destructor Documentation

__construct()

Auth_Yubico::__construct	(		$id,
			$key = ''
	)

Constructor.

Sets up the object

Parameters

string	The client identity
string	The client MAC key (optional) @access public

Definition at line 91 of file Yubico.php.

        {
                $this->_id =  $id;
                $this->_key = base64_decode($key);
        }

References $id, and $key.

Member Function Documentation

getLastResponse()

Auth_Yubico::getLastResponse

(

)

Return the last data received from the server, if any.

Returns

string Output from server. @access public

Definition at line 103 of file Yubico.php.

        {
                return $this->_response;
        }

References $_response.

verify()

Auth_Yubico::verify

(

$token

)

Verify Yubico OTP.

Parameters

string

$token

Yubico OTP

Returns

mixed PEAR error on error, true otherwise @access public

Definition at line 117 of file Yubico.php.

        {
                $parameters = "id=" . $this->_id . "&otp=" . $token;
                // Generate signature
                if ($this->_key <> "") {
                        $signature = base64_encode(hash_hmac('sha1', $parameters, $this->_key, true));
                        $parameters .= '&h=' . $signature;
                }
                /* Support https. */
                $url = "https://api.yubico.com/wsapi/verify?" . $parameters;
 
                $responseMsg = \SimpleSAML\Utils\HTTP::fetch($url);
                
                if (!preg_match("/status=([a-zA-Z0-9_]+)/", $responseMsg, $out)) {
                        throw new Exception('Could not parse response');
                }
 
                $status = $out[1];
                
                /* Verify signature. */
                if ($this->_key <> "") {
                        $rows = explode("\r\n", $responseMsg);
            $response = array();
            foreach ($rows as $val) {
                                // = is also used in BASE64 encoding so we only replace the first = by # which is not used in BASE64
                                $val = preg_replace('/=/', '#', $val, 1);
                                $row = explode("#", $val);
                                $response[$row[0]] = (isset($row[1])) ? $row[1] : "";
                        }
 
                        $check = 'status=' . $response['status'] . '&t='. $response['t'];
                        $checksignature = base64_encode(hash_hmac('sha1', $check, $this->_key, true));
                        
                        if ($response['h'] != $checksignature) {
                                throw new Exception('Checked Signature failed');
                        }
                }
                
                if ($status != 'OK') {
                        throw new Exception('Status was not OK: ' . $status);
                }
 
                return true;
        }

References $out, $response, $row, $rows, PHPMailer\PHPMailer\$token, $url, and SimpleSAML\Utils\HTTP\fetch().

Here is the call graph for this function:

Field Documentation

$_id

Auth_Yubico::$_id

private

Definition at line 69 of file Yubico.php.

$_key

Auth_Yubico::$_key

private

Definition at line 75 of file Yubico.php.

$_response

Auth_Yubico::$_response

private

Definition at line 81 of file Yubico.php.

Referenced by getLastResponse().

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/authYubiKey/libextinc/Yubico.php