Configuring OAuth2 Authentication

Field

Description

Enabled

Select to enable OAuth2 authentication. Once enabled, the Flow Type field is activated.

Flow Type

OAuth2 Flow type is defined in RFC-6749.

From this dropdown, select one. There are five types:

1. Authorization Code
2. Client Credentials
3. Implicit
4. Resource Owner Password Credentials
5. Custom

Once an option has been selected, the other fields are activated.

3-Legged

Select to enable 3-Legged OAuth authentication.

Authentication

Select the authentication type required by the OAuth2 endpoint(s). The options from the dropdown are:

• None
• Form
• Basic, Digest, NTLM/Kerberos

Access Token

In this tab, you can configure the parameters required to make a request to the Access Token endpoint to retrieve the OAuth2 access token.

Authorization Code

In this tab, you can configure the parameters required to make a request to the Authorization Code endpoint to retrieve the Authorization Code.

This tab is visible only when the Flow Type selected is Authorization Code.

Response Fields

In this tab, you can set the following options:

• The Access Token is the only required field. Other parameters are optional, and may be left blank if not supported. The field name of the Access Token will be retrieved from the OAuth2 endpoint.
• The Refresh Token field is used if the OAuth2 Endpoint returns a refresh token, which Invicti will use to extend the expiration time of the current access token. If the response doesn’t contain this field, leave it blank.
• The Expire field is used if the OAuth2 Endpoint returns an expiration value that may be in seconds or in date-time. Invicti will block all requests just before the Access Token expires and tries to refresh the current one. If a refresh token is provided, it will be used. Otherwise, a new token will be requested.
• The Token Type field is the name of the header that will be sent with every request and its value will be the OAuth2 token, while Invicti crawls and attacks the target website. If no token type is provided, Invicti will default to using the Bearer as the header.
  • The Fixed option enables users to override the default (Bearer) value, if the token response is missing in the Token Type field and the authorization header type is different to the Bearer.

3-Legged Auth

Complete if the the 3-Legged checkbox above is enabled :

• Username
• Password
• Custom Scripts

OAuth2 flows that require 3-Legged authentication such as filling username/password fields, or interacting by clicking an ‘Allow’ button, are now fully supported.

If a form requires a username and password, you can provide credentials using the 3-Legged Authentication section.

Endpoint

Click to open OAuth2  Access Token Endpoint dialog and complete fields:

• URL
• Content Type
  • application/x-www-form-urlencoded
  • application/json
• Method – GET or POST

Endpoint(s) and associated parameters must be configured. Invicti automatically lists the default parameter names and values defined in the RFC-6749. Because these parameter names and values may vary between implementations, Invicti allows you to add, remove and edit them.

Name

Enter the name of the request parameter.

Value

Enter the value of the request parameter.

+ New

Select to add a custom field. There are two options: Default and Encrypted.

You can add the key and value pair. If you select Default, the key and value appear in plain text.

Select Encrypted if you want to add sensitive information, such as passwords. If selected, the value appears as *** in the scan profile while the sensitive information appears as blank in the API response.

Encoded

Select if you want Invicti to encode your input again.

Test OAuth2 Credentials

Click to test the configured settings.