All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.quarkus.oidc.OidcTenantConfig$Authentication.jdp Maven / Gradle / Ivy

    Go to download

    Secure your applications with OpenID Connect Adapter and IDP such as Keycloak

    There is a newer version: 3.17.5
    Show newest version
    #
#Wed Sep 20 11:05:02 CEST 2023
io.quarkus.oidc.OidcTenantConfig.Authentication.QUERY=Authorization response parameters are encoded in the query string added to the redirect_uri
io.quarkus.oidc.OidcTenantConfig.Authentication.cookieSameSite=SameSite attribute for the session cookie.
io.quarkus.oidc.OidcTenantConfig.Authentication.pkceRequired=Requires that a Proof Key for Code Exchange (PKCE) is used.
io.quarkus.oidc.OidcTenantConfig.Authentication.allowMultipleCodeFlows=If a state cookie is present then a `state` query parameter must also be present and both the state\ncookie name suffix and state cookie value have to match the value of the `state` query parameter when\nthe redirect path matches the current path.\nHowever, if multiple authentications are attempted from the same browser, for example, from the different\nbrowser tabs, then the currently available state cookie may represent the authentication flow\ninitiated from another tab and not related to the current request.\nDisable this property if you would like to avoid supporting multiple authorization code flows running in the same\nbrowser.
io.quarkus.oidc.OidcTenantConfig.Authentication.restorePathAfterRedirect=If this property is set to 'true' then the original request URI which was used before\nthe authentication will be restored after the user has been redirected back to the application.\n\nNote if `redirectPath` property is not set, the original request URI will be restored even if this property is\ndisabled.
io.quarkus.oidc.OidcTenantConfig.Authentication.responseMode=Authorization code flow response mode
io.quarkus.oidc.OidcTenantConfig.Authentication.redirectPath=Relative path for calculating a "redirect_uri" query parameter.\nIt has to start from a forward slash and will be appended to the request URI's host and port.\nFor example, if the current request URI is 'https\://localhost\:8080/service' then a 'redirect_uri' parameter\nwill be set to 'https\://localhost\:8080/' if this property is set to '/' and be the same as the request URI\nif this property has not been configured.\nNote the original request URI will be restored after the user has authenticated if 'restorePathAfterRedirect' is set\nto 'true'.
io.quarkus.oidc.OidcTenantConfig.Authentication.nonceRequired=Require that ID token includes a `nonce` claim which must match `nonce` authentication request query parameter.\nEnabling this property can help mitigate replay attacks.\nDo not enable this property if your OpenId Connect provider does not support setting `nonce` in ID token\nor if you work with OAuth2 provider such as `GitHub` which does not issue ID tokens.
io.quarkus.oidc.OidcTenantConfig.Authentication.javaScriptAutoRedirect=If this property is set to 'true' then a normal 302 redirect response will be returned\nif the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be\n(re)authenticated which may not be desirable for Single-page applications (SPA) since\nit automatically following the redirect may not work given that OIDC authorization endpoints typically do not support\nCORS.\n
    \nIf this property is set to 'false' then a status code of '499' will be returned to allow\nSPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found.\n'X-Requested-With' request header with its value set to either `JavaScript` or `XMLHttpRequest` is expected by\ndefault if\nthis property is enabled. You can register a custom {@linkplain JavaScriptRequestChecker} to do a custom JavaScript\nrequest check instead.
io.quarkus.oidc.OidcTenantConfig.Authentication.forwardParams=Request URL query parameters which, if present, will be added to the authentication redirect URI.
io.quarkus.oidc.OidcTenantConfig.Authentication.errorPath=Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint.\nIf the user authentication has failed then the OIDC provider will return an 'error' and an optional\n'error_description'\nparameters, instead of the expected authorization 'code'.\n\nIf this property is set then the user will be redirected to the endpoint which can return a user-friendly\nerror description page. It has to start from a forward slash and will be appended to the request URI's host and port.\nFor example, if it is set as '/error' and the current request URI is\n'https\://localhost\:8080/callback?error\=invalid_scope'\nthen a redirect will be made to 'https\://localhost\:8080/error?error\=invalid_scope'.\n\nIf this property is not set then HTTP 401 status will be returned in case of the user authentication failure.
io.quarkus.oidc.OidcTenantConfig.Authentication.forceRedirectHttpsScheme=Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy.\nThis property, if enabled, will also affect the logout `post_logout_redirect_uri` and the local redirect requests.
io.quarkus.oidc.OidcTenantConfig.Authentication.cookiePathHeader=Cookie path header parameter value which, if set, identifies the incoming HTTP header\nwhose value will be used to set a path parameter for the session, state and post logout cookies.\nIf the header is missing then the `cookie-path` property will be checked.
io.quarkus.oidc.OidcTenantConfig.Authentication.scopes=List of scopes
io.quarkus.oidc.OidcTenantConfig.Authentication.cookieForceSecure=If enabled the state, session and post logout cookies will have their 'secure' parameter set to 'true'\nwhen HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy.\nThe cookies will always be secure if HTTPS is used even if this property is set to false.
io.quarkus.oidc.OidcTenantConfig.Authentication.cookieDomain=Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies.
io.quarkus.oidc.OidcTenantConfig.Authentication.userInfoRequired=If this property is set to 'true' then an OIDC UserInfo endpoint will be called.\nThis property will be enabled if `quarkus.oidc.roles.source` is `userinfo`\nor `quarkus.oidc.token.verify-access-token-with-user-info` is `true`\nor `quarkus.oidc.authentication.id-token-required` is set to `false`,\nyou do not have to enable this property manually in these cases.
io.quarkus.oidc.OidcTenantConfig.Authentication.FORM_POST=Authorization response parameters are encoded as HTML form values that are auto-submitted in the browser\nand transmitted via the HTTP POST method using the application/x-www-form-urlencoded content type
io.quarkus.oidc.OidcTenantConfig.Authentication.verifyAccessToken=Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.\nID token is always verified on every user request as the primary token which is used\nto represent the principal and extract the roles.\nAccess token is not verified by default since it is meant to be propagated to the downstream services.\nThe verification of the access token should be enabled if it is injected as a JWT token.\n\nAccess tokens obtained as part of the code flow will always be verified if `quarkus.oidc.roles.source`\nproperty is set to `accesstoken` which means the authorization decision will be based on the roles extracted from the\naccess token.\n\nBearer access tokens are always verified.
io.quarkus.oidc.OidcTenantConfig.Authentication.extraParams=Additional properties which will be added as the query parameters to the authentication redirect URI.
io.quarkus.oidc.OidcTenantConfig.Authentication.cookiePath=Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post\nlogout cookies.\nThe `cookie-path-header` property, if set, will be checked first.
io.quarkus.oidc.OidcTenantConfig.Authentication.removeRedirectParameters=Remove the query parameters such as 'code' and 'state' set by the OIDC server on the redirect URI\nafter the user has authenticated by redirecting a user to the same URI but without the query parameters.
io.quarkus.oidc.OidcTenantConfig.Authentication.failOnMissingStateParam=Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.\n
    \nWhen either multiple authentications are disabled or the redirect URL\nmatches the original request URL, the stale state cookie might remain in the browser cache from\nthe earlier failed redirect to an OpenId Connect provider and be visible during the current request.\nFor example, if Single-page application (SPA) uses XHR to handle redirects to the provider\nwhich does not support CORS for its authorization endpoint, the browser will block it\nand the state cookie created by Quarkus will remain in the browser cache.\nQuarkus will report an authentication failure when it will detect such an old state cookie but find no matching state\nquery parameter.\n
    \nReporting HTTP 401 error is usually the right thing to do in such cases, it will minimize a risk of the\nbrowser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects.\nFor example, enabling {@link \#javaScriptAutoRedirect} or having the provider redirect to URL configured\nwith {@link \#redirectPath} may be needed to avoid such errors.\n
    \nHowever, setting this property to `false` may help if the above options are not suitable.\nIt will cause a new authentication redirect to OpenId Connect provider. Please be aware doing so may increase the\nrisk of browser redirect loops.
io.quarkus.oidc.OidcTenantConfig.Authentication.stateSecret=Secret which will be used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow\nstate.\nThis secret should be at least 32 characters long.\n
    \nIf this secret is not set, the client secret configured with\neither `quarkus.oidc.credentials.secret` or `quarkus.oidc.credentials.client-secret.value` will be checked.\nFinally, `quarkus.oidc.credentials.jwt.secret` which can be used for `client_jwt_secret` authentication will be\nchecked. Client secret will not be used as a state encryption secret if it is less than 32 characters\nlong.\n
    \nThe secret will be auto-generated if it remains uninitialized after checking all of these properties.\n
    \nError will be reported if the secret length is less than 16 characters.
io.quarkus.oidc.OidcTenantConfig.Authentication.cookieSuffix=Cookie name suffix.\nFor example, a session cookie name for the default OIDC tenant is 'q_session' but can be changed to 'q_session_test'\nif this property is set to 'test'.
io.quarkus.oidc.OidcTenantConfig.Authentication.internalIdTokenLifespan=Internal ID token lifespan.\nThis property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.
io.quarkus.oidc.OidcTenantConfig.Authentication.pkceSecret=Secret which will be used to encrypt a Proof Key for Code Exchange (PKCE) code verifier in the code flow state.\nThis secret should be at least 32 characters long.\n\n@deprecated Use {@link \#stateSecret} property instead.
io.quarkus.oidc.OidcTenantConfig.Authentication.sessionAgeExtension=Session age extension in minutes.\nThe user session age property is set to the value of the ID token life-span by default and\nthe user will be redirected to the OIDC provider to re-authenticate once the session has expired.\nIf this property is set to a non-zero value then the expired ID token can be refreshed before\nthe session has expired.\nThis property will be ignored if the `token.refresh-expired` property has not been enabled.
io.quarkus.oidc.OidcTenantConfig.Authentication.idTokenRequired=Requires that ID token is available when the authorization code flow completes.\nDisable this property only when you need to use the authorization code flow with OAuth2 providers which do not return\nID token - an internal IdToken will be generated in such cases.
io.quarkus.oidc.OidcTenantConfig.Authentication.addOpenidScope=Add the 'openid' scope automatically to the list of scopes. This is required for OpenId Connect providers\nbut will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error.




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy