Merge pull request #4 from cdoco/develop

Add aud support array

Author: cdoco

README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <p><img src="https://jwt.io/img/logo-asset.svg" /></p>
+    <p><a target="_blank" href="https://jwt.io"><img src="https://jwt.io/img/logo-asset.svg" /></a></p>
     <p>A PHP extension for <a target="_blank" href="https://tools.ietf.org/html/rfc7519">RFC 7519 OAuth JSON Web Token (JWT)</a></p>
     <a target="_blank" href="https://travis-ci.org/cdoco/php-jwt" title="Build Status"><img src="https://travis-ci.org/cdoco/php-jwt.svg"></a>
     <img src="https://img.shields.io/badge/branch-master-brightgreen.svg?style=flat-square">
@@ -20,7 +20,7 @@ $ phpize && ./configure --with-openssl=/path/to/openssl
 $ make && make install
 ```
 
-## Quick Example
+## Quick [Example](https://github.com/cdoco/php-jwt/tree/master/example)
 
 ```php
 $key = "example-hmac-key";
@@ -55,8 +55,6 @@ $decoded_token = jwt_decode($token, $key);
 print_r($decoded_token);
 ```
 
-## [Example](https://github.com/cdoco/php-jwt/tree/master/example)
-
 ## Algorithms and Usage
 
 The JWT supports NONE, HMAC, RSASSA and ECDSA algorithms for cryptographic signing.
@@ -255,12 +253,12 @@ try {
 > The `aud` (audience) claim identifies the recipients that the JWT is intended for. Each principal intended to process the JWT MUST identify itself with a value in the audience claim. If the principal processing the claim does not identify itself with a value in the `aud` claim when this claim is present, then the JWT MUST be rejected. In the general case, the `aud` value is an array of case-sensitive strings, each containing a **StringOrURI** value. In the special case when the JWT has one audience, the `aud` value MAY be a single case-sensitive string containing a **StringOrURI** value. The interpretation of audience values is generally application specific. Use of this claim is OPTIONAL.
 
 ```php
-$payload = ['data' => 'data', 'aud' => 'Young Man'];
+$payload = ['data' => 'data', 'aud' => ['Young', 'Old']];
 
 $token = jwt_encode($payload, $hmackey, 'HS256');
 
 try {
-    $decoded_token = jwt_decode($token, $hmackey, ['aud' => 'Young Man', 'algorithm' => 'HS256']);
+    $decoded_token = jwt_decode($token, $hmackey, ['aud' => ['Young', 'Old'], 'algorithm' => 'HS256']);
 } catch (Exception $e) {
      // Handle invalid token
 }

jwt.c

@@ -229,8 +229,12 @@ char *jwt_hash_str_find_str(zval *arr, char *key)
     zval *zv = zend_hash_str_find(Z_ARRVAL_P(arr), key, strlen(key));
 
     if (zv != NULL) {
-        str = Z_STRVAL_P(zv);
-    }
+        if (Z_TYPE_P(zv) == IS_STRING) {
+            str = Z_STRVAL_P(zv);
+        } else {
+            php_error_docref(NULL, E_WARNING, "%s type must be string", key);
+        }
+    } 
 
     return str;
 }
@@ -240,34 +244,81 @@ long jwt_hash_str_find_long(zval *arr, char *key)
     zval *zv = zend_hash_str_find(Z_ARRVAL_P(arr), key, strlen(key));
 
     if (zv != NULL) {
-        return Z_LVAL_P(zv);
+        if (Z_TYPE_P(zv) == IS_LONG) {
+            return Z_LVAL_P(zv);
+        } else {
+            php_error_docref(NULL, E_WARNING, "%s type must be long", key);
+        }
     }
 
     return 0;
 }
 
+zend_array *jwt_hash_str_find_ht(zval *arr, char *key)
+{
+    zval *zv = zend_hash_str_find(Z_ARRVAL_P(arr), key, strlen(key));
+
+    if (zv != NULL) {
+        if (Z_TYPE_P(zv) == IS_ARRAY) {
+            return Z_ARRVAL_P(zv);
+        } else {
+            php_error_docref(NULL, E_WARNING, "%s type must be array", key);
+        }
+    }
+
+    return NULL;
+}
+
 int jwt_verify_claims(zval *arr, char *key, char *str)
 {
     char *rs = jwt_hash_str_find_str(arr, key);
-    if (rs && strcmp(rs, str)) {
+    if (rs && str && strcmp(rs, str)) {
         return FAILURE;
     }
 
     return 0;
 }
 
+int jwt_array_equals(zend_array *arr1, zend_array *arr2) {
+    zend_ulong i;
+    zval *value = NULL;
+
+    if (arr1 && arr2) {
+        if (zend_array_count(arr1) != zend_array_count(arr2)) {
+            return FAILURE;
+        }
+
+        ZEND_HASH_FOREACH_NUM_KEY_VAL(arr1, i, value) {
+            zval *tmp = zend_hash_index_find(arr2, i);
+
+            if (value && tmp){
+                if (Z_TYPE_P(value) == IS_STRING && Z_TYPE_P(tmp) == IS_STRING) {
+                    if (strcmp(Z_STRVAL_P(value), Z_STRVAL_P(tmp))) {
+                        return FAILURE;
+                    }
+                } else {
+                    php_error_docref(NULL, E_WARNING, "Aud each item type must be string");
+                }
+            }
+        }ZEND_HASH_FOREACH_END();
+    }
+
+    return 0;
+}
+
 int jwt_verify_body(char *body, zval *return_value)
 {
     char *err_msg = NULL;
     time_t curr_time = time((time_t*)NULL);
     zend_string *vs = jwt_b64_url_decode(body);
+
+    /* decode json to array */
     php_json_decode_ex(return_value, ZSTR_VAL(vs), ZSTR_LEN(vs), PHP_JSON_OBJECT_AS_ARRAY, 512);
     zend_string_free(vs);
 
     /* Expiration */
-    if (JWT_G(expiration) && (curr_time - JWT_G(leeway)) >= JWT_G(expiration)) {
+    if (JWT_G(expiration) && (curr_time - JWT_G(leeway)) >= JWT_G(expiration))
         err_msg = "Expired token";
-    }
 
     /* not before */
     if (JWT_G(not_before) && JWT_G(not_before) > (curr_time + JWT_G(leeway))) {
@@ -280,7 +331,7 @@ int jwt_verify_body(char *body, zval *return_value)
     }
 
     /* iss */
-    if (JWT_G(iss) && jwt_verify_claims(return_value, "iss", JWT_G(iss)))
+    if (jwt_verify_claims(return_value, "iss", JWT_G(iss)))
         err_msg = "Iss verify fail";
 
     /* iat */
@@ -294,15 +345,15 @@ int jwt_verify_body(char *body, zval *return_value)
     }
 
     /* jti */
-    if (JWT_G(jti) && jwt_verify_claims(return_value, "jti", JWT_G(jti)))
+    if (jwt_verify_claims(return_value, "jti", JWT_G(jti)))
         err_msg = "Tti verify fail";
 
     /* aud */
-    if (JWT_G(aud) && jwt_verify_claims(return_value, "aud", JWT_G(aud)))
+    if (jwt_array_equals(JWT_G(aud), jwt_hash_str_find_ht(return_value, "aud")))
         err_msg = "Aud verify fail";
 
     /* sub */
-    if (JWT_G(sub) && jwt_verify_claims(return_value, "sub", JWT_G(sub)))
+    if (jwt_verify_claims(return_value, "sub", JWT_G(sub)))
         err_msg = "Sub verify fail";
 
     if (err_msg) {
@@ -330,7 +381,7 @@ int jwt_parse_options(zval *options)
                 JWT_G(leeway) = jwt_hash_str_find_long(options, "leeway");
                 JWT_G(iss) = jwt_hash_str_find_str(options, "iss");
                 JWT_G(jti) = jwt_hash_str_find_str(options, "jti");
-                JWT_G(aud) = jwt_hash_str_find_str(options, "aud");
+                JWT_G(aud) = jwt_hash_str_find_ht(options, "aud");
                 JWT_G(sub) = jwt_hash_str_find_str(options, "sub");
             }
             break;

jwt.php

@@ -12,11 +12,12 @@
         "admin" => true
     ],
     "sub" => "1234567890",
-    "nbf" => time() + 100
+    "nbf" => time() + 1,
+    "aud" => ['yy'],
 );
 
 // default HS256 algorithm
 $token = jwt_encode($claims, $key);
 
 echo $token . PHP_EOL;
-print_r(jwt_decode($token, $key, ['leeway' => 2, "iss" => "http://example.org"]));
+print_r(jwt_decode($token, $key, ["aud" => ['yy'], 'leeway' => 2, "iss" => "http://example.org"]));

php_jwt.h

@@ -38,7 +38,7 @@ ZEND_BEGIN_MODULE_GLOBALS(jwt)
   char *iss;
   time_t iat;
   char *jti;
-  char *aud;
+  zend_array *aud;
   char *sub;
   size_t leeway;
   char *algorithm;

tests/011.phpt

@@ -0,0 +1,28 @@
+--TEST--
+Check for jwt aud claim name
+--SKIPIF--
+<?php if (!extension_loaded("jwt")) print "skip"; ?>
+--FILE--
+<?php
+$hmackey = "example-hmac-key";
+$payload = ['data' => 'data', 'aud' => ['Young', 'Old']];
+
+$token = jwt_encode($payload, $hmackey, 'HS256');
+
+try {
+    $decoded_token = jwt_decode($token, $hmackey, ['aud' => ['Young', 'Old'], 'algorithm' => 'HS256']);
+    echo "SUCCESS\n";
+} catch (Exception $e) {
+     // Handle invalid token
+}
+
+try {
+    $decoded_token = jwt_decode($token, $hmackey, ['aud' => ['Young'], 'algorithm' => 'HS256']);
+} catch (Exception $e) {
+     // Handle invalid token
+     echo "FAIL\n";
+}
+?>
+--EXPECT--
+SUCCESS
+FAIL