[trafficserver] branch master updated: Add support for JWS to be passed as a URI path parameter in URI signing plugin

[jr...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jrushford pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/master by this push:
     new 4f5baf0  Add support for JWS to be passed as a URI path parameter in URI signing plugin
4f5baf0 is described below

commit 4f5baf097467ff6d3f76d566e57509800f2099d3
Author: Dylan Souza <dy...@comcast.com>
AuthorDate: Fri Nov 2 18:05:12 2018 +0000

    Add support for JWS to be passed as a URI path parameter in URI signing plugin
---
 plugins/experimental/uri_signing/parse.c       | 71 +++++++++++++++++---------
 plugins/experimental/uri_signing/parse.h       |  2 +-
 plugins/experimental/uri_signing/uri_signing.c |  2 +-
 3 files changed, 48 insertions(+), 27 deletions(-)

diff --git a/plugins/experimental/uri_signing/parse.c b/plugins/experimental/uri_signing/parse.c
index a53c60f..603c4ec 100644
--- a/plugins/experimental/uri_signing/parse.c
+++ b/plugins/experimental/uri_signing/parse.c
@@ -29,37 +29,64 @@
 #include <inttypes.h>
 
 cjose_jws_t *
-get_jws_from_query(const char *uri, size_t uri_ct, const char *paramName)
+get_jws_from_uri(const char *uri, size_t uri_ct, const char *paramName)
 {
-  PluginDebug("Parsing JWS from query string: %.*s", (int)uri_ct, uri);
-  const char *query = uri;
-  const char *end   = uri + uri_ct;
-  while (query != end && *query != '?') {
-    ++query;
-  }
-  if (query == end) {
+  /* Reserved characters as defined by the URI Generic Syntax RFC: https://tools.ietf.org/html/rfc3986#section-2.2 */
+  const char *reserved_string = ":/?#[]@!$&\'()*+,;=";
+
+  /* If param name ends in reserved character this will be treated as the termination symbol when parsing for package. Default is
+   * '='. */
+  char termination_symbol;
+  size_t termination_ct;
+  size_t param_ct = strlen(paramName);
+
+  if (param_ct <= 0) {
+    PluginDebug("URI signing package name cannot be empty");
     return NULL;
   }
 
-  ++query;
+  if (strchr(reserved_string, paramName[param_ct - 1])) {
+    termination_symbol = paramName[param_ct - 1];
+    termination_ct     = param_ct - 1;
+  } else {
+    termination_symbol = '=';
+    termination_ct     = param_ct;
+  }
+
+  PluginDebug("Parsing JWS from query string: %.*s", (int)uri_ct, uri);
+  const char *param = uri;
+  const char *end   = uri + uri_ct;
+  const char *key, *key_end;
+  const char *value, *value_end;
 
-  const char *key   = query, *key_end;
-  const char *value = query, *value_end;
   for (;;) {
-    while (value != end && *value != '=') {
-      ++value;
+    /* Search the URI for a reserved character. */
+    while (param != end && strchr(reserved_string, *param) == NULL) {
+      ++param;
     }
+    if (param == end) {
+      break;
+    }
+
+    ++param;
 
+    /* Parse the parameter for a key value pair separated by the termination symbol. */
+    key   = param;
+    value = param;
+    while (value != end && *value != termination_symbol) {
+      ++value;
+    }
     if (value == end) {
       break;
     }
-    key_end   = value;
-    value_end = ++value;
-    while (value_end != end && *value_end != '&') {
-      ++value_end;
-    }
+    key_end = value;
 
-    if (!strncmp(paramName, key, (size_t)(key_end - key))) {
+    /* If the Parameter key is our target parameter name, attempt to import a JWS from the value. */
+    if ((size_t)(key_end - key) == termination_ct && !strncmp(paramName, key, (size_t)(key_end - key))) {
+      value_end = ++value;
+      while (value_end != end && strchr(reserved_string, *value_end) == NULL) {
+        ++value_end;
+      }
       PluginDebug("Decoding JWS: %.*s", (int)(key_end - key), key);
       cjose_err err    = {0};
       cjose_jws_t *jws = cjose_jws_import(value, (size_t)(value_end - value), &err);
@@ -70,12 +97,6 @@ get_jws_from_query(const char *uri, size_t uri_ct, const char *paramName)
       }
       return jws;
     }
-
-    if (value_end == end) {
-      break;
-    }
-
-    key = value = value_end + 1;
   }
   PluginDebug("Unable to locate signing key in uri: %.*s", (int)uri_ct, uri);
   return NULL;
diff --git a/plugins/experimental/uri_signing/parse.h b/plugins/experimental/uri_signing/parse.h
index 8002f87..8d82c63 100644
--- a/plugins/experimental/uri_signing/parse.h
+++ b/plugins/experimental/uri_signing/parse.h
@@ -19,7 +19,7 @@
 #include <stdlib.h>
 
 struct _cjose_jws_int;
-struct _cjose_jws_int *get_jws_from_query(const char *uri, size_t uri_ct, const char *paramName);
+struct _cjose_jws_int *get_jws_from_uri(const char *uri, size_t uri_ct, const char *paramName);
 struct _cjose_jws_int *get_jws_from_cookie(const char **cookie, size_t *cookie_ct, const char *paramName);
 
 struct config;
diff --git a/plugins/experimental/uri_signing/uri_signing.c b/plugins/experimental/uri_signing/uri_signing.c
index 55ba117..e9a2a81 100644
--- a/plugins/experimental/uri_signing/uri_signing.c
+++ b/plugins/experimental/uri_signing/uri_signing.c
@@ -175,7 +175,7 @@ TSRemapDoRemap(void *ih, TSHttpTxn txnp, TSRemapRequestInfo *rri)
   if (cpi < max_cpi) {
     checkpoints[cpi++] = mark_timer(&t);
   }
-  cjose_jws_t *jws = get_jws_from_query(url, url_ct, package);
+  cjose_jws_t *jws = get_jws_from_uri(url, url_ct, package);
   if (cpi < max_cpi) {
     checkpoints[cpi++] = mark_timer(&t);
   }