Support
Scans

Configuring OAuth2 Authentication

This document is for:
Invicti Standard, Invicti Enterprise On-Premises, Invicti Enterprise On-Demand

Invicti supports the OAuth2 Authentication mechanism, enabling you to configure scans for websites that require OAuth2 authentication.

The OAuth2 authentication mechanism in Invicti Enterprise and Invicti Standard supports all grant types that are defined in RFC-6749. In addition, Invicti has a Custom flow that is used for token based authentication, except OAuth2 flows.

OAuth2 Authentication Fields

This table lists and explains the fields in the OAuth2 Authentication section.

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.

Encoded

Select if you want Invicti to encode your input again.

This option is only available in Invicti Enterprise On-Demand and Invicti Standard.

Test OAuth2 Credentials

Click to test the configured settings.

How to Configure OAuth2 Authentication in Invicti Enterprise
  1. Log in to Invicti Enterprise.
  2. From the main menu, click Scans, then New Scan. The New Scan window is displayed.
  3. From the Authentication tab, select OAuth2. The OAuth2 section is displayed.
  4. Select the Enabled checkbox.
  5. From the Flow Type drop-down, select an option.

  1. Click the Endpoint field. The OAuth2 Authorization Code is displayed.

  1. Enter the endpoint URL and click OK.
  2. If the Authorization Code has been selected as the Flow Type above, an additional panel will be displayed to set its endpoint values. The Authorization Code will be automatically requested from its endpoint and redirected to the Access Token endpoint. The name of the code field that will be sent to the Access Token endpoint can be edited, though its value cannot (it is a dynamic value that is automatically populated by Invicti).
  3. If OAuth2 endpoints require additional authentication, such as Form or Basic, Digest, NTLM/Kerberos authentication, you must configure them from the Authentication dropdown (see Configuring Form Authentication in Invicti Standard and Configuring Basic, Digest, NTLM/Kerberos and Negotiate Authentication).

  1. Click the Response Fields tab. These fields are already populated with the default values defined in RFC-6749.
  2. Click Test OAuth2 Credentials to make sure that it works correctly.
How to Configure OAuth2 Authentication in Invicti Standard
  1. Open Invicti Standard.
  2. From the Home tab, click New. The Start a New Website or Web Service Scan dialog is displayed.
  3. Click the OAuth2 tab.
  4. Select the Enabled checkbox.
  5. From the Flow Type drop-down, select an option.

  1. In the Endpoint field, enter the endpoint URL.

  1. If the Authorization Code has been selected as the Flow Type above, an additional panel will be displayed to set its endpoint values. The Authorization Code will be automatically requested from its endpoint and redirected to the Access Token endpoint. The name of the code field that will be sent to the Access Token endpoint can be edited, though its value cannot (it is a dynamic value that is automatically populated by Invicti).

  1. If OAuth2 endpoints requires an additional authentication, such as Form or Basic, Digest, NTLM/Kerberos authentication, you must configure them from the Authentication dropdown (see Configuring Form Authentication in Invicti Standard and Configuring Basic, Digest, NTLM/Kerberos Authentication in InvictiStandard).

Interactions, such as clicking buttons, can be achieved with custom scripting support.
For further information on custom scripting, see Custom Scripts for Form Authentication in Invicti Standard.

  1. Click the Response Fields tab. These fields are already populated with the default values defined in RFC-6749.

Not found what you're looking for?

Open a ticket and our technical support team will assist you quickly.

Open a ticket This will redirect you to the ticketing system.