Project: KICS (Provisioning / Security & Compliance)
File: 40e1d1bf-11a9-4f63-a3a2-a8b84c602839.md

title: API Key Exposed In Global Security Scheme hide: toc: true navigation: true <style> .highlight .hll { background-color: #ff171742; } .md-content { max-width: 1100px; margin: 0 auto; } </style> Query id: 40e1d1bf-11a9-4f63-a3a2-a8b84c602839 Query name: API Key Exposed In Global Security Scheme Platform: OpenAPI Severity: <span style="color:#edd57e">Low</span> Category: Access Control URL: API Keys should not be transported over network<br> ```json title="Positive test num. 1 - json file" hl_lines="57 52 62" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "security": [ { "apiKey2": [], "apiKey3": [], "apiKey1": [] } ], "components": { "securitySchemes": { "apiKey1": { "type": "apiKey", "name": "X-API-Key", "in": "header" }, "apiKey2": { "type": "apiKey", "name": "X-API-Key", "in": "cookie" }, "apiKey3": { "name": "X-API-Key", "in": "query", "type": "apiKey" } } } } ``` ```yaml title="Positive test num. 2 - yaml file" hl_lines="35 39 31" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self security: apiKey1: [] apiKey2: [] apiKey3: [] components: securitySchemes: apiKey1: type: apiKey name: X-API-Key in: header apiKey2: type: apiKey name: X-API-Key in: cookie apiKey3: type: apiKey name: X-API-Key in: query ``` ```json title="Negative test num. 1 - json file" { "openapi": "3.0.0", "info": { "title": "Simple API Overview", "version": "1.0.0" }, "paths": { "/": { "get": { "operationId": "listVersionsv2", "summary": "List API versions", "responses": { "200": { "description": "200 response", "content": { "application/json": { "examples": { "foo": { "value": { "versions": [ { "status": "CURRENT", "updated": "2011-01-21T11:33:21Z", "id": "v2.0", "links": [ { "href": "http://127.0.0.1:8774/v2/", "rel": "self" } ] } ] } } } } } } } } } }, "security": [ { "exampleSecurity": [] } ], "components": { "securitySchemes": { "exampleSecurity": { "type": "http", "scheme": "basic" } } } } ``` ```yaml title="Negative test num. 2 - yaml file" openapi: 3.0.0 info: title: Simple API Overview version: 1.0.0 paths: "/": get: operationId: listVersionsv2 summary: List API versions responses: "200": description: 200 response content: application/json: examples: foo: value: versions: status: CURRENT updated: "2011-01-21T11:33:21Z" id: v2.0 links: href: http://127.0.0.1:8774/v2/ rel: self components: securitySchemes: OAuth2: type: oauth2 flows: authorizationCode: scopes: write: modify objects in your account read: read objects in your account authorizationUrl: https://example.com/oauth/authorize tokenUrl: https://example.com/oauth/token security: OAuth2: write read ```