Credentials sent as cleartext

Description

Your API accepts user credentials sent in cleartext over an unencrypted channel. Attackers can easily intercept API calls and retrieve the credentials. They can then use the credentials to make other API calls.

For more details, see the OpenAPI Specification.

Example

The following is an example of how this type of risk could look in your API definition:

...  
  "schemes": [
    "http"
  ],
  ...
  "securityDefinitions": {
    "regularSecurity": {
      "type": "basic"
    }
  },
  ...
  "security": [
    {
      "regularSecurity": []
    }
  ],
  ...
}

The security field defines that the API is protected with basic authentication (username and password). The schemes field sets HTTP as the supported transportation protocol. This means that the API accepts an API call over an unencrypted HTTP connection, and expects it to have the username and password in the clear.

Possible exploit scenario

Attackers can intercept the credentials simply by listening to the network traffic in a public WiFi network. They could also use a traffic logging tool on a smartphone, computer, or browser, or sniff the traffic in the network to get the credentials.

Remediation

At the very least, set the transport protocol to HTTPS only so that all traffic is encrypted. You could also improve the security of the authentication method. The OAuth 2.0 Authorization Code flow (Access Code flow in OAS v2) is considered the most secure way to provide API authorization.

            ...
  "schemes": [
    "https"
  ],
  ...
  "securityDefinitions": {
    "OAuth2": {
      "type": "oauth2",
      "flow": "accessCode",
      "scopes": {
        "readOnly": "read objects in your account"
      },
      "authorizationUrl": "https://example.com/oauth/authorize",
      "tokenUrl": "https://example.com/oauth/token", 
    }
  },
  ...
  "security" : [
    "OAuth2": [ "readOnly" ]
  ]
}