summaryrefslogtreecommitdiffstats
path: root/Authentication
diff options
context:
space:
mode:
authorAnant Narayanan <anant@kix.in>2013-04-03 15:56:16 -0700
committerAnant Narayanan <anant@kix.in>2013-04-03 15:56:16 -0700
commit564878fccb6e1fac83d229ce1d3122fc3d915922 (patch)
tree9843ca4783ad46bafc1d4a924a22ce9df8438098 /Authentication
parent0e112c9ba6ab931622b076173aeb84b24633de64 (diff)
downloadphp-jwt-564878fccb6e1fac83d229ce1d3122fc3d915922.zip
php-jwt-564878fccb6e1fac83d229ce1d3122fc3d915922.tar.gz
php-jwt-564878fccb6e1fac83d229ce1d3122fc3d915922.tar.bz2
Some re-organization as per PEPr suggestions
Diffstat (limited to 'Authentication')
-rw-r--r--Authentication/JWT.php188
1 files changed, 188 insertions, 0 deletions
diff --git a/Authentication/JWT.php b/Authentication/JWT.php
new file mode 100644
index 0000000..fb32df1
--- /dev/null
+++ b/Authentication/JWT.php
@@ -0,0 +1,188 @@
+<?php
+
+/**
+ * JSON Web Token implementation, based on this spec:
+ * http://tools.ietf.org/html/draft-ietf-oauth-json-web-token-06
+ *
+ * @author Neuman Vong <neuman@twilio.com>
+ * @author Anant Narayanan <anant@php.net>
+ */
+class JWT
+{
+ /**
+ * Decodes a JWT string into a PHP object.
+ *
+ * @access public
+ * @param string $jwt The JWT
+ * @param string|null $key The secret key
+ * @param bool $verify Don't skip verification process
+ *
+ * @return object The JWT's payload as a PHP object
+ * @uses jsonDecode
+ * @uses urlsafeB64Decode
+ */
+ public static function decode($jwt, $key = null, $verify = true)
+ {
+ $tks = explode('.', $jwt);
+ if (count($tks) != 3) {
+ throw new UnexpectedValueException('Wrong number of segments');
+ }
+ list($headb64, $payloadb64, $cryptob64) = $tks;
+ if (null === ($header = JWT::jsonDecode(JWT::urlsafeB64Decode($headb64)))) {
+ throw new UnexpectedValueException('Invalid segment encoding');
+ }
+ if (null === $payload = JWT::jsonDecode(JWT::urlsafeB64Decode($payloadb64))) {
+ throw new UnexpectedValueException('Invalid segment encoding');
+ }
+ $sig = JWT::urlsafeB64Decode($cryptob64);
+ if ($verify) {
+ if (empty($header->alg)) {
+ throw new DomainException('Empty algorithm');
+ }
+ if ($sig != JWT::sign("$headb64.$payloadb64", $key, $header->alg)) {
+ throw new UnexpectedValueException('Signature verification failed');
+ }
+ }
+ return $payload;
+ }
+
+ /**
+ * Converts and signs a PHP object or array into a JWT string.
+ *
+ * @access public
+ * @param object|array $payload PHP object or array
+ * @param string $key The secret key
+ * @param string $algo The signing algorithm
+ *
+ * @return string A signed JWT
+ * @uses jsonEncode
+ * @uses urlsafeB64Encode
+ */
+ public static function encode($payload, $key, $algo = 'HS256')
+ {
+ $header = array('typ' => 'JWT', 'alg' => $algo);
+
+ $segments = array();
+ $segments[] = JWT::urlsafeB64Encode(JWT::jsonEncode($header));
+ $segments[] = JWT::urlsafeB64Encode(JWT::jsonEncode($payload));
+ $signing_input = implode('.', $segments);
+
+ $signature = JWT::sign($signing_input, $key, $algo);
+ $segments[] = JWT::urlsafeB64Encode($signature);
+
+ return implode('.', $segments);
+ }
+
+ /**
+ * Sign a string with a given key and algorithm.
+ *
+ * @access public
+ * @param string $msg The message to sign
+ * @param string $key The secret key
+ * @param string $method The signing algorithm
+ *
+ * @return string An encrypted message
+ */
+ public static function sign($msg, $key, $method = 'HS256')
+ {
+ $methods = array(
+ 'HS256' => 'sha256',
+ 'HS384' => 'sha384',
+ 'HS512' => 'sha512',
+ );
+ if (empty($methods[$method])) {
+ throw new DomainException('Algorithm not supported');
+ }
+ return hash_hmac($methods[$method], $msg, $key, true);
+ }
+
+ /**
+ * Decode a JSON string into a PHP object.
+ *
+ * @access public
+ * @param string $input JSON string
+ *
+ * @return object Object representation of JSON string
+ */
+ public static function jsonDecode($input)
+ {
+ $obj = json_decode($input);
+ if (function_exists('json_last_error') && $errno = json_last_error()) {
+ JWT::handleJsonError($errno);
+ } else if ($obj === null && $input !== 'null') {
+ throw new DomainException('Null result with non-null input');
+ }
+ return $obj;
+ }
+
+ /**
+ * Encode a PHP object into a JSON string.
+ *
+ * @access public
+ * @param object|array $input A PHP object or array
+ *
+ * @return string JSON representation of the PHP object or array
+ */
+ public static function jsonEncode($input)
+ {
+ $json = json_encode($input);
+ if (function_exists('json_last_error') && $errno = json_last_error()) {
+ JWT::handleJsonError($errno);
+ } else if ($json === 'null' && $input !== null) {
+ throw new DomainException('Null result with non-null input');
+ }
+ return $json;
+ }
+
+ /**
+ * Decode a string with URL-safe Base64.
+ *
+ * @access public
+ * @param string $input A Base64 encoded string
+ *
+ * @return string A decoded string
+ */
+ public static function urlsafeB64Decode($input)
+ {
+ $remainder = strlen($input) % 4;
+ if ($remainder) {
+ $padlen = 4 - $remainder;
+ $input .= str_repeat('=', $padlen);
+ }
+ return base64_decode(strtr($input, '-_', '+/'));
+ }
+
+ /**
+ * Encode a string with URL-safe Base64.
+ *
+ * @access public
+ * @param string $input The string you want encoded
+ *
+ * @return string The base64 encode of what you passed in
+ */
+ public static function urlsafeB64Encode($input)
+ {
+ return str_replace('=', '', strtr(base64_encode($input), '+/', '-_'));
+ }
+
+ /**
+ * @access private
+ * @param int $errno An error number from json_last_error()
+ *
+ * @return void
+ */
+ private static function handleJsonError($errno)
+ {
+ $messages = array(
+ JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
+ JSON_ERROR_CTRL_CHAR => 'Unexpected control character found',
+ JSON_ERROR_SYNTAX => 'Syntax error, malformed JSON'
+ );
+ throw new DomainException(isset($messages[$errno])
+ ? $messages[$errno]
+ : 'Unknown JSON error: ' . $errno
+ );
+ }
+
+}
+