HttpAuthConfig

HTTP authentication configuration for accessing protected websites.

crawler/webJavadoc: HttpAuthConfig

Notes

Configures HTTP authentication for accessing protected websites. Supports BASIC, DIGEST, NTLM, Kerberos, SPNEGO, and HTML form-based authentication methods, with optional preemptive authentication and custom form parameters.

Usage

YAML

credentials:
  password: string
  passwordKey:
    size: 0
    source: KEY
    value: string
  username: string
domain: string
formCharset: string
formParams: {}
formPasswordField: string
formSelector: string
formUsernameField: string
host:
  name: string
  port: 0
kerberosConfig:
  keytabPath: string
  krb5ConfigPath: string
  loginModuleName: string
  principal: string
  servicePrincipalName: string
  useTicketCache: false
method: FORM
preemptive: false
realm: string
url: string
workstation: string

JSON

{
  "credentials": {
    "password": "string",
    "passwordKey": {
      "size": 0,
      "source": "KEY",
      "value": "string"
    },
    "username": "string"
  },
  "domain": "string",
  "formCharset": "string",
  "formParams": {},
  "formPasswordField": "string",
  "formSelector": "string",
  "formUsernameField": "string",
  "host": {
    "name": "string",
    "port": 0
  },
  "kerberosConfig": {
    "keytabPath": "string",
    "krb5ConfigPath": "string",
    "loginModuleName": "string",
    "principal": "string",
    "servicePrincipalName": "string",
    "useTicketCache": false
  },
  "method": "FORM",
  "preemptive": false,
  "realm": "string",
  "url": "string",
  "workstation": "string"
}

XML

<authentication>
  <credentials>
    <password>string</password>
    <passwordKey>
      <size>0</size>
      <source>KEY</source>
      <value>string</value>
    </passwordKey>
    <username>string</username>
  </credentials>
  <domain>string</domain>
  <formCharset>string</formCharset>
  <formParams/>
  <formPasswordField>string</formPasswordField>
  <formSelector>string</formSelector>
  <formUsernameField>string</formUsernameField>
  <host>
    <name>string</name>
    <port>0</port>
  </host>
  <kerberosConfig>
    <keytabPath>string</keytabPath>
    <krb5ConfigPath>string</krb5ConfigPath>
    <loginModuleName>string</loginModuleName>
    <principal>string</principal>
    <servicePrincipalName>string</servicePrincipalName>
    <useTicketCache>false</useTicketCache>
  </kerberosConfig>
  <method>FORM</method>
  <preemptive>false</preemptive>
  <realm>string</realm>
  <url>string</url>
  <workstation>string</workstation>
</authentication>

Properties

Property	Type	Required	Default
credentials	Credentials	No	Credentials
domain	string	No	-
formCharset	string	No	UTF_8
formParams	Record<string, string>	No	-
formPasswordField	string	No	-
formSelector	string	No	-
formUsernameField	string	No	-
host	Host	No	-
kerberosConfig	KerberosConfig	No	-
method	enum	No	-
preemptive	boolean	No	false
realm	string	No	-
url	string	No	-
workstation	string	No	-

Property Details

credentials

Username and password to a protected website.

domain

NTLM authentication domain, if applicable.

formCharset

The authentication form character set for the form field values. Default is UTF-8.

formParams

Extra form parameters to submit with the authentication request.

formPasswordField

Name of the HTML field where the password is set. This is used only for "form" authentication.

formSelector

CSS selector that identifies the form in a login page. When set, it requires the specified form URL to be pointing to a login page containing a login form.

formUsernameField

Name of the HTML field where the username is set. This is used only for "form" authentication.

host

Host for the current authentication scope. Leave blank (default value) to indicate "any host" for the scope. Used for BASIC and DIGEST authentication.

kerberosConfig

Kerberos/SPNEGO authentication configuration. Used when the authentication method is set to KERBEROS or SPNEGO.

method

One of the supported authentication methods.

Allowed Values

• FORM
• BASIC
• DIGEST
• NTLM
• SPNEGO
• KERBEROS

preemptive

Whether to perform preemptive authentication (valid for basic authentication method).

realm

Realm name for the current authentication scope. Leave blank (default) to indicate "any realm" for the scope. Used for BASIC and DIGEST authentication.

url

URL for "form" authentication. The username and password will be posted to this URL (HTTP POST). This is used only for "form" authentication.

workstation

The NTLM authentication workstation name.