Protocol-Based Authentication

Some applications delegate authentication to a standard protocol, so there is no login form or custom login API to replay. Bright follows the protocol itself to get access.

Two protocol-based methods are available:

  • OpenID Connect (OAuth) - for applications that use the standard OAuth 2.0 flow with client or user secrets. Bright requests a token from the OpenID provider and embeds it in each request.
  • NTLM Authentication - for target networks that verify access rights with the NTLM protocol, using a username, a password and, optionally, a domain.

OpenID Connect (OAuth)

The OIDC (OAuth) authentication method is designed to configure the standard OAuth 2.0 flow, which requires the use of client or user secrets.

📘

Note

Currently, only the Client Credentials and Resource Owner Password grant types of OIDC are supported.

If your application is using PKCE, please use the Recorded Browser-Based Form Authentication or Manual Browser-Based Form Authentication authentication options.

From the Authentication type dropdown list, select OpenID Connect (OAuth), and then proceed to the authentication details.

Authentication Details

In this section, complete the provided fields to set up a valid authentication request for the end-point API.

FieldGuidelines
Discovery document URLProvide a discovery document URL (https://your_host/.well-known/openid-configuration) to populate endpoint URLs automatically or leave this field empty to enter endpoint URLs manually.
Grant typeFrom the drop-down list, select the grant type you need:
  • Client Credentials Grant
  • Resource Owner Password Grant
    If you select the Resource Owner Password Grant, the Username and Password fields are added to the setup flow.
Token EndpointObtain an access and/or ID token by presenting an authorization grant or refresh token.
Client IDEnter your application client ID, a unique client identifier preregistered in OpenID Provider.
Client SecretEnter your application client secret, which is used to authenticate to the Token Endpoint.
Scope(Optional) Enter a space-separated list of scopes.
Resource(Optional) Enter a line-separated list of resources.
Audience(Optional) Enter the intended recipient of the token.
Embed inSelect where to embed the token in the request.
  • If the Default option is selected, the token is embedded according to the OIDC specification. For example, a token with the Bearer prefix can be embedded in the authorization header.
  • If you select the Body option, specify the token encoder, content type, exact location in the body, and the token template string.
  • If you select the Header option, specify the token encoder, the name of the target header, and the token template string.

Valid Authentication Response

In this section, select the options you want to use during the application scanning to determine that the authenticated resource has been reached. The options define how the application responds if a full authentication flow passes successfully.

NTLM Authentication

If the target network uses the NTLM protocol to verify the user’s access rights, you need to set up an NTLM authentication object. The protocol requires a user to be authenticated by providing a username and a corresponding password. After the user’s log-in credentials are recognized, the network can check access rights and allow the user to enter.

🚧

Important

If using a Repeater, add --ntlm flag to keep an open connection between a Repeater and the target. To learn more about Command Language Syntax, see the article.

From the Authentication type dropdown list, select NTLM authentication, and then proceed to the authentication details.

Authentication Details

In this section, complete the provided fields to set up a valid authentication request for the end-point API.

FieldGuidelines
UsernameEnter the username.
PasswordEnter the password.
Domain(Optional): Enter the domain of the NTLM network you need to get access to.
Workstation(Optional): Enter your workstation name, for example, a computer name. The maximum length of a workstation name is 64 characters.

Did this page help you?