Documentation
Configuration
Security
Basic authentication

Basic authentication

Attach to:

Listener
Route

Basic authentication enables a simple username/password authentication mechanism.

Warning

Basic authentication is not generally recommended for production use. At a minimum, use basic authentication along with TLS encryption.

The htpasswd field specifies the username/password pairs. See the htpasswd documentation. The realm field, optionally, specifies the realm name returned in error responses.

Additionally, authentication can run in two different modes:

  • Strict: A valid username/password pair must be present.
  • Optional (default): If a username/password pair exists, validate it.
    Warning: This allows requests without a username/password pair!
basicAuth:
  mode: strict
  # Generated with `htpasswd -nb -B user1 agentgateway`
  # You can also use:
  # htpasswd:
  #   file: /path/to/htpasswd
  # With inline configuration, $ must be escaped to $$.
  htpasswd: |
    user1:$$2y$$05$$LMZ.8WGNqvagmtJz2Gw6VuiE6khXc2zc0FDTHrfWJyLT66HM8BMAa
  realm: example.com

Now to send requests, include the username and password.

curl http://user1:agentgateway@localhost:3000
JWT authenticationAPI Key authentication