feat: remove digest security

superfaceai · Jul 19, 2023 · e79149c · e79149c
1 parent 846e0c4
commit e79149c
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 283 deletions.
diff --git a/src/interfaces/providerjson/providerjson.schema.json b/src/interfaces/providerjson/providerjson.schema.json
@@ -13,6 +13,14 @@
                 "query"
             ],
             "type": "string"
+        },
+        "ApiKeyBodyType": {
+            "$id": "ApiKeyBodyType",
+            "description": "Body type to inject security value to.",
+            "enum": [
+                "json"
+            ],
+            "type": "string"
         }
     },
     "description": "Type decribing provider.json document.",

diff --git a/src/interfaces/providerjson/providerjson.ts b/src/interfaces/providerjson/providerjson.ts
@@ -26,7 +26,6 @@ export enum ApiKeyPlacement {
 export enum HttpScheme {
   BASIC = 'basic',
   BEARER = 'bearer',
-  DIGEST = 'digest',
 }
 
 /**

diff --git a/src/interfaces/providerjson/providerjson.utils.test.ts b/src/interfaces/providerjson/providerjson.utils.test.ts
@@ -1,5 +1,6 @@
 import { IntegrationParameter, prepareProviderParameters } from '.';
 import {
+  ApiKeyBodyType,
   ApiKeyPlacement,
   HttpScheme,
   SecurityScheme,
@@ -10,7 +11,6 @@ import {
   isApiKeySecurityScheme,
   isBasicAuthSecurityScheme,
   isBearerTokenSecurityScheme,
-  isDigestSecurityScheme,
   isValidProviderName,
   prepareSecurityValues,
 } from './providerjson.utils';
@@ -42,14 +42,6 @@ describe('ProviderJsonDocument', () => {
                 "id": "swapidev",
                 "type": "http",
                 "scheme": "basic"
-            },
-            {
-              "id": "swapidev",
-              "type": "http",
-              "scheme": "digest",
-              "statusCode": 401,
-              "challengeHeader": "www-authenticate",
-              "authorizationHeader": "authorizaation"
             }
         ],
         "defaultService": "swapidev",
@@ -81,15 +73,7 @@ describe('ProviderJsonDocument', () => {
             id: 'swapidev',
             type: 'http',
             scheme: 'basic',
-          },
-          {
-            id: 'swapidev',
-            type: 'http',
-            scheme: 'digest',
-            statusCode: 401,
-            challengeHeader: 'www-authenticate',
-            authorizationHeader: 'authorizaation',
-          },
+          }
         ],
         defaultService: 'swapidev',
         parameters: [{ name: 'userId', description: "some user's id" }],
@@ -382,7 +366,8 @@ describe('ProviderJsonDocument', () => {
           isApiKeySecurityScheme({
             id: 'swapidev',
             type: SecurityType.APIKEY,
-            in: ApiKeyPlacement.PATH,
+            in: ApiKeyPlacement.BODY,
+            bodyType: ApiKeyBodyType.JSON,
             name: 'X-API-Key',
           })
         ).toEqual(true);
@@ -392,7 +377,7 @@ describe('ProviderJsonDocument', () => {
           isApiKeySecurityScheme({
             id: 'swapidev',
             type: SecurityType.APIKEY,
-            in: ApiKeyPlacement.QUERY,
+            in: ApiKeyPlacement.PATH,
             name: 'X-API-Key',
           })
         ).toEqual(true);
@@ -401,17 +386,18 @@ describe('ProviderJsonDocument', () => {
         expect(
           isApiKeySecurityScheme({
             id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.BEARER,
+            type: SecurityType.APIKEY,
+            in: ApiKeyPlacement.QUERY,
+            name: 'X-API-Key',
           })
-        ).toEqual(false);
+        ).toEqual(true);
       }
       {
         expect(
           isApiKeySecurityScheme({
             id: 'swapidev',
             type: SecurityType.HTTP,
-            scheme: HttpScheme.BASIC,
+            scheme: HttpScheme.BEARER,
           })
         ).toEqual(false);
       }
@@ -420,7 +406,7 @@ describe('ProviderJsonDocument', () => {
           isApiKeySecurityScheme({
             id: 'swapidev',
             type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
+            scheme: HttpScheme.BASIC,
           })
         ).toEqual(false);
       }
@@ -455,15 +441,6 @@ describe('ProviderJsonDocument', () => {
           })
         ).toEqual(true);
       }
-      {
-        expect(
-          isBasicAuthSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-          })
-        ).toEqual(false);
-      }
     });
 
     it('checks BearerTokenSecurity type correctly', () => {
@@ -495,101 +472,8 @@ describe('ProviderJsonDocument', () => {
           })
         ).toEqual(false);
       }
-      {
-        expect(
-          isBearerTokenSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-          })
-        ).toEqual(false);
-      }
     });
 
-    it('checks DigestAuthSecurity type correctly', () => {
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.APIKEY,
-            in: ApiKeyPlacement.HEADER,
-            name: 'X-API-Key',
-          })
-        ).toEqual(false);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.BEARER,
-          })
-        ).toEqual(false);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.BASIC,
-          })
-        ).toEqual(false);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-          })
-        ).toEqual(true);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-            statusCode: 401,
-          })
-        ).toEqual(true);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-            statusCode: 401,
-            challengeHeader: 'test',
-          })
-        ).toEqual(true);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-            statusCode: 401,
-            challengeHeader: 'test',
-            authorizationHeader: 'auth',
-          })
-        ).toEqual(true);
-      }
-      {
-        expect(
-          isDigestSecurityScheme({
-            id: 'swapidev',
-            type: SecurityType.HTTP,
-            scheme: HttpScheme.DIGEST,
-            statusCode: undefined,
-            challengeHeader: undefined,
-            authorizationHeader: undefined,
-          })
-        ).toEqual(true);
-      }
-    });
   });
   describe('ProviderJson name check', () => {
     it('checks Provider name correctly', () => {
@@ -622,11 +506,6 @@ describe('prepareSecurityValues', () => {
       type: SecurityType.HTTP,
       scheme: HttpScheme.BASIC,
     },
-    {
-      id: 'digest',
-      type: SecurityType.HTTP,
-      scheme: HttpScheme.DIGEST,
-    },
   ];
 
   it('prepares security values', () => {
@@ -644,11 +523,6 @@ describe('prepareSecurityValues', () => {
         username: `$TEST_PROVIDER_USERNAME`,
         password: `$TEST_PROVIDER_PASSWORD`,
       },
-      {
-        id: 'digest',
-        username: `$TEST_PROVIDER_USERNAME`,
-        password: `$TEST_PROVIDER_PASSWORD`,
-      },
     ]);
   });
 

diff --git a/src/interfaces/superjson/superjson.schema.json b/src/interfaces/superjson/superjson.schema.json
@@ -733,28 +733,6 @@
                                                 "token"
                                             ],
                                             "type": "object"
-                                        },
-                                        {
-                                            "$id": "DigestSecurityValues",
-                                            "additionalProperties": false,
-                                            "description": "Security values for digest security scheme",
-                                            "properties": {
-                                                "id": {
-                                                    "type": "string"
-                                                },
-                                                "password": {
-                                                    "type": "string"
-                                                },
-                                                "username": {
-                                                    "type": "string"
-                                                }
-                                            },
-                                            "required": [
-                                                "id",
-                                                "password",
-                                                "username"
-                                            ],
-                                            "type": "object"
                                         }
                                     ],
                                     "description": "Authorization variables."