Package io.quarkus.vertx.http.runtime

Interface AuthConfig

public interface AuthConfig
Authentication mechanism and SecurityRealm name information used for configuring HTTP auth instance for the deployment.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Boolean>
    basic()
    If basic auth should be enabled.
    boolean
    form()
    If form authentication is enabled.
    boolean
    proactive()
    If this is true and credentials are present then a user will always be authenticated before the request progresses.
    boolean
    propagateSecurityIdentity()
    Propagate security identity to support its injection in Vert.x route handlers registered directly with the router.

  • Method Details

    • basic

      Optional<Boolean> basic()
      If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode.

      The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required.

    • form

      @WithDefault("false") @WithName("form.enabled") boolean form()
      If form authentication is enabled.

    • proactive

      @WithDefault("true") boolean proactive()
      If this is true and credentials are present then a user will always be authenticated before the request progresses.

      If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.

    • propagateSecurityIdentity

      @WithDefault("false") boolean propagateSecurityIdentity()
      Propagate security identity to support its injection in Vert.x route handlers registered directly with the router.