Merge pull request #137 from postmanlabs/feature/edgegrid-auth

Added EdgeGrid Authentication Method
postmanlabs · Oct 14, 2019 · e6429ea · e6429ea
2 parents 66377ee + 95cf762
commit e6429ea
Show file tree

Hide file tree

Showing 14 changed files with 390 additions and 0 deletions.
diff --git a/examples/draft-04/v1.0.0/edgegridAuthTest.json b/examples/draft-04/v1.0.0/edgegridAuthTest.json
@@ -0,0 +1,43 @@
+{
+    "id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+    "name": "edgegridAuthTest",
+    "description": "",
+    "order": [
+      "951fc3e8-c6b6-5c19-9f69-4e7499b3127f"
+    ],
+    "folders": [],
+    "timestamp": 1448876955917,
+    "owner": 0,
+    "remoteLink": "",
+    "public": false,
+    "requests": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "headers": "Authorization: EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+        "url": "https://postman-echo.com/get",
+        "preRequestScript": "",
+        "pathVariables": {},
+        "method": "GET",
+        "data": [],
+        "dataMode": "params",
+        "version": 2,
+        "currentHelper": "edgegridAuth",
+        "helperAttributes": {
+          "id": "edgegrid",
+          "accessToken": "foo",
+          "clientToken": "bar",
+          "clientSecret": "baz",
+          "baseURL": "postman-echo.com",
+          "nonce": "djnenfn",
+          "timestamp": "20191014T08:12:46+0000",
+          "headersToSign": "Host,Cache-Control"
+        },
+        "time": 1448888108375,
+        "name": "test edgegrid auth success",
+        "description": "",
+        "collectionId": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+        "responses": []
+      }
+    ]
+  }
+
diff --git a/examples/draft-04/v2.0.0/edgegridAuthTest.json b/examples/draft-04/v2.0.0/edgegridAuthTest.json
@@ -0,0 +1,45 @@
+{
+    "variables": [],
+    "info": {
+      "name": "edgegridAuthTest",
+      "_postman_id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+      "description": "",
+      "schema": "http://schema.getpostman.com/json/collection/v2.0.0/collection.json"
+    },
+    "item": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "name": "test edgegrid auth success",
+        "request": {
+          "auth": {
+            "type": "edgegrid",
+            "edgegrid": {
+              "accessToken": "foo",
+              "clientToken": "bar",
+              "clientSecret": "baz",
+              "baseURL": "postman-echo.com",
+              "nonce": "djnenfn",
+              "timestamp": "20191014T08:12:46+0000",
+              "headersToSign": "Host,Cache-Control"
+            }
+          },
+          "url": "https://postman-echo.com/get",
+          "method": "GET",
+          "header": [
+            {
+              "key": "Authorization",
+              "value": "EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+              "description": ""
+            }
+          ],
+          "data": {
+            "mode": "formdata",
+            "formdata": []
+          },
+          "description": ""
+        },
+        "response": []
+      }
+    ]
+  }
+
diff --git a/examples/draft-04/v2.1.0/edgegridAuthTest.json b/examples/draft-04/v2.1.0/edgegridAuthTest.json
@@ -0,0 +1,66 @@
+{
+    "variables": [],
+    "info": {
+      "name": "edgegridAuthTest",
+      "_postman_id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+      "description": "",
+      "schema": "http://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+    },
+    "item": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "name": "test edgegrid auth success",
+        "request": {
+          "auth": {
+            "type": "edgegrid",
+            "edgegrid": [
+              {
+                "key": "accessToken",
+                "value": "foo"
+              },
+              {
+                "key": "clientToken",
+                "value": "bar"
+              },
+              {
+                "key": "clientSecret",
+                "value": "baz"
+              },
+              {
+                "key": "baseURL",
+                "value": "postman-echo.com"
+              },
+              {
+                "key": "nonce",
+                "value": "djnenfn"
+              },
+              {
+                "key": "timestamp",
+                "value": "20191014T08:12:46+0000"
+              },
+              {
+                "key": "headersToSign",
+                "value": "Host,Cache-Control"
+              }
+            ]
+          },
+          "url": "https://postman-echo.com/get",
+          "method": "GET",
+          "header": [
+            {
+              "key": "Authorization",
+              "value": "EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+              "description": ""
+            }
+          ],
+          "data": {
+            "mode": "formdata",
+            "formdata": []
+          },
+          "description": ""
+        },
+        "response": []
+      }
+    ]
+  }
+
diff --git a/examples/draft-07/v1.0.0/edgegridAuthTest.json b/examples/draft-07/v1.0.0/edgegridAuthTest.json
@@ -0,0 +1,43 @@
+{
+    "id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+    "name": "edgegridAuthTest",
+    "description": "",
+    "order": [
+      "951fc3e8-c6b6-5c19-9f69-4e7499b3127f"
+    ],
+    "folders": [],
+    "timestamp": 1448876955917,
+    "owner": 0,
+    "remoteLink": "",
+    "public": false,
+    "requests": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "headers": "Authorization: EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+        "url": "https://postman-echo.com/get",
+        "preRequestScript": "",
+        "pathVariables": {},
+        "method": "GET",
+        "data": [],
+        "dataMode": "params",
+        "version": 2,
+        "currentHelper": "edgegridAuth",
+        "helperAttributes": {
+          "id": "edgegrid",
+          "accessToken": "foo",
+          "clientToken": "bar",
+          "clientSecret": "baz",
+          "baseURL": "postman-echo.com",
+          "nonce": "djnenfn",
+          "timestamp": "20191014T08:12:46+0000",
+          "headersToSign": "Host,Cache-Control"
+        },
+        "time": 1448888108375,
+        "name": "test edgegrid auth success",
+        "description": "",
+        "collectionId": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+        "responses": []
+      }
+    ]
+  }
+
diff --git a/examples/draft-07/v2.0.0/edgegridAuthTest.json b/examples/draft-07/v2.0.0/edgegridAuthTest.json
@@ -0,0 +1,45 @@
+{
+    "variables": [],
+    "info": {
+      "name": "edgegridAuthTest",
+      "_postman_id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+      "description": "",
+      "schema": "http://schema.getpostman.com/json/collection/v2.0.0/collection.json"
+    },
+    "item": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "name": "test edgegrid auth success",
+        "request": {
+          "auth": {
+            "type": "edgegrid",
+            "edgegrid": {
+              "accessToken": "foo",
+              "clientToken": "bar",
+              "clientSecret": "baz",
+              "baseURL": "postman-echo.com",
+              "nonce": "djnenfn",
+              "timestamp": "20191014T08:12:46+0000",
+              "headersToSign": "Host,Cache-Control"
+            }
+          },
+          "url": "https://postman-echo.com/get",
+          "method": "GET",
+          "header": [
+            {
+              "key": "Authorization",
+              "value": "EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+              "description": ""
+            }
+          ],
+          "data": {
+            "mode": "formdata",
+            "formdata": []
+          },
+          "description": ""
+        },
+        "response": []
+      }
+    ]
+  }
+
diff --git a/examples/draft-07/v2.1.0/edgegridAuthTest.json b/examples/draft-07/v2.1.0/edgegridAuthTest.json
@@ -0,0 +1,66 @@
+{
+    "variables": [],
+    "info": {
+      "name": "edgegridAuthTest",
+      "_postman_id": "d497d10e-e280-8c83-709a-a4d4ea12ad14",
+      "description": "",
+      "schema": "http://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+    },
+    "item": [
+      {
+        "id": "951fc3e8-c6b6-5c19-9f69-4e7499b3127f",
+        "name": "test edgegrid auth success",
+        "request": {
+          "auth": {
+            "type": "edgegrid",
+            "edgegrid": [
+              {
+                "key": "accessToken",
+                "value": "foo"
+              },
+              {
+                "key": "clientToken",
+                "value": "bar"
+              },
+              {
+                "key": "clientSecret",
+                "value": "baz"
+              },
+              {
+                "key": "baseURL",
+                "value": "postman-echo.com"
+              },
+              {
+                "key": "nonce",
+                "value": "djnenfn"
+              },
+              {
+                "key": "timestamp",
+                "value": "20191014T08:12:46+0000"
+              },
+              {
+                "key": "headersToSign",
+                "value": "Host,Cache-Control"
+              }
+            ]
+          },
+          "url": "https://postman-echo.com/get",
+          "method": "GET",
+          "header": [
+            {
+              "key": "Authorization",
+              "value": "EG1-HMAC-SHA256 client_token=bar;access_token=foo;timestamp=20191014T08:12:46+0000;nonce=djnenfn;signature=1Tpt1twixhLxh0tazTT+fxzI8a8Kjur1aTpQ0Xbm8Hw=",
+              "description": ""
+            }
+          ],
+          "data": {
+            "mode": "formdata",
+            "formdata": []
+          },
+          "description": ""
+        },
+        "response": []
+      }
+    ]
+  }
+
diff --git a/schemas/draft-04/v1.0.0/collection/auth.json b/schemas/draft-04/v1.0.0/collection/auth.json
@@ -12,6 +12,7 @@
         "basic",
         "bearer",
         "digest",
+        "edgegrid",
         "hawk",
         "noauth",
         "oauth1",
@@ -61,6 +62,14 @@
         "$ref": "#/definitions/auth-attribute"
       }
     },
+    "edgegrid": {
+      "type": "array",
+      "title": "EdgeGrid Authentication",
+      "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).",
+      "items": {
+        "$ref": "#/definitions/auth-attribute"
+      }
+    },
     "hawk": {
       "type": "array",
       "title": "Hawk Authentication",

diff --git a/schemas/draft-04/v1.0.0/collection/helper-attributes.json b/schemas/draft-04/v1.0.0/collection/helper-attributes.json
@@ -71,6 +71,24 @@
         "id"
       ]
     },
+    {
+      "type": "object",
+      "title": "EdgeGrid Authentication",
+      "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign.",
+      "properties": {
+        "id": {
+          "type": "string",
+          "enum": [
+            "edgegrid"
+          ],
+          "description": "This field contains the type of the helper. In this case, it is ``edgegrid``"
+        }
+      },
+      "additionalProperties": true,
+      "required": [
+        "id"
+      ]
+    },
     {
       "type": "object",
       "title": "Hawk Authentication",

diff --git a/schemas/draft-04/v2.0.0/collection/auth.json b/schemas/draft-04/v2.0.0/collection/auth.json
@@ -12,6 +12,7 @@
         "basic",
         "bearer",
         "digest",
+        "edgegrid",
         "hawk",
         "ntlm",
         "noauth",
@@ -46,6 +47,11 @@
       "title": "Digest Authentication",
       "description": "The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication). e.g. username, password, realm, nonce, nonceCount, algorithm, qop, opaque, clientNonce."
     },
+    "edgegrid": {
+      "type": "object",
+      "title": "EdgeGrid Authentication",
+      "description": "The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html). e.g. accessToken, clientToken, clientSecret, baseURL, nonce, timestamp, headersToSign."
+    },
     "hawk": {
       "type": "object",
       "title": "Hawk Authentication",