Package org.keycloak.adapters
Class OAuthRequestAuthenticator
- java.lang.Object
-
- org.keycloak.adapters.OAuthRequestAuthenticator
-
public class OAuthRequestAuthenticator extends Object
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Field Summary
Fields Modifier and Type Field Description protected org.keycloak.adapters.spi.AuthChallengechallengeprotected KeycloakDeploymentdeploymentprotected org.keycloak.adapters.spi.HttpFacadefacadeprotected org.keycloak.representations.IDTokenidTokenprotected StringidTokenStringprotected StringrefreshTokenprotected RequestAuthenticatorreqAuthenticatorprotected intsslRedirectPortprotected StringstrippedOauthParametersRequestUriprotected org.keycloak.representations.AccessTokentokenprotected org.keycloak.adapters.spi.AdapterSessionStoretokenStoreprotected StringtokenString
-
Constructor Summary
Constructors Constructor Description OAuthRequestAuthenticator(RequestAuthenticator requestAuthenticator, org.keycloak.adapters.spi.HttpFacade facade, KeycloakDeployment deployment, int sslRedirectPort, org.keycloak.adapters.spi.AdapterSessionStore tokenStore)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.keycloak.adapters.spi.AuthOutcomeauthenticate()protected org.keycloak.adapters.spi.AuthChallengechallenge(int code, OIDCAuthenticationError.Reason reason, String description)protected org.keycloak.adapters.spi.AuthChallengecheckStateCookie()org.keycloak.adapters.spi.AuthChallengegetChallenge()protected StringgetCode()protected org.keycloak.adapters.spi.HttpFacade.CookiegetCookie(String cookieName)protected StringgetCookieValue(String cookieName)protected StringgetError()org.keycloak.representations.IDTokengetIdToken()StringgetIdTokenString()protected StringgetQueryParamValue(String paramName)protected StringgetRedirectUri(String state)StringgetRefreshToken()protected StringgetRequestUrl()protected StringgetStateCode()StringgetStrippedOauthParametersRequestUri()org.keycloak.representations.AccessTokengetToken()StringgetTokenString()protected booleanisRequestSecure()protected org.keycloak.adapters.spi.AuthChallengeloginRedirect()protected org.keycloak.adapters.spi.AuthChallengeresolveCode(String code)Start or continue the oauth login process.voidsetIdToken(org.keycloak.representations.IDToken idToken)voidsetIdTokenString(String idTokenString)voidsetStrippedOauthParametersRequestUri(String strippedOauthParametersRequestUri)protected intsslRedirectPort()protected StringstripOauthParametersFromRedirect()strip out unwanted query parameters and redirect so bookmarks don't retain oauth protocol bits
-
-
-
Field Detail
-
deployment
protected KeycloakDeployment deployment
-
reqAuthenticator
protected RequestAuthenticator reqAuthenticator
-
sslRedirectPort
protected int sslRedirectPort
-
tokenStore
protected org.keycloak.adapters.spi.AdapterSessionStore tokenStore
-
tokenString
protected String tokenString
-
idTokenString
protected String idTokenString
-
idToken
protected org.keycloak.representations.IDToken idToken
-
token
protected org.keycloak.representations.AccessToken token
-
facade
protected org.keycloak.adapters.spi.HttpFacade facade
-
challenge
protected org.keycloak.adapters.spi.AuthChallenge challenge
-
refreshToken
protected String refreshToken
-
strippedOauthParametersRequestUri
protected String strippedOauthParametersRequestUri
-
-
Constructor Detail
-
OAuthRequestAuthenticator
public OAuthRequestAuthenticator(RequestAuthenticator requestAuthenticator, org.keycloak.adapters.spi.HttpFacade facade, KeycloakDeployment deployment, int sslRedirectPort, org.keycloak.adapters.spi.AdapterSessionStore tokenStore)
-
-
Method Detail
-
getChallenge
public org.keycloak.adapters.spi.AuthChallenge getChallenge()
-
getTokenString
public String getTokenString()
-
getToken
public org.keycloak.representations.AccessToken getToken()
-
getRefreshToken
public String getRefreshToken()
-
getIdTokenString
public String getIdTokenString()
-
setIdTokenString
public void setIdTokenString(String idTokenString)
-
getIdToken
public org.keycloak.representations.IDToken getIdToken()
-
setIdToken
public void setIdToken(org.keycloak.representations.IDToken idToken)
-
getStrippedOauthParametersRequestUri
public String getStrippedOauthParametersRequestUri()
-
setStrippedOauthParametersRequestUri
public void setStrippedOauthParametersRequestUri(String strippedOauthParametersRequestUri)
-
getRequestUrl
protected String getRequestUrl()
-
isRequestSecure
protected boolean isRequestSecure()
-
getCookie
protected org.keycloak.adapters.spi.HttpFacade.Cookie getCookie(String cookieName)
-
getError
protected String getError()
-
getCode
protected String getCode()
-
sslRedirectPort
protected int sslRedirectPort()
-
getStateCode
protected String getStateCode()
-
loginRedirect
protected org.keycloak.adapters.spi.AuthChallenge loginRedirect()
-
checkStateCookie
protected org.keycloak.adapters.spi.AuthChallenge checkStateCookie()
-
authenticate
public org.keycloak.adapters.spi.AuthOutcome authenticate()
-
challenge
protected org.keycloak.adapters.spi.AuthChallenge challenge(int code, OIDCAuthenticationError.Reason reason, String description)
-
resolveCode
protected org.keycloak.adapters.spi.AuthChallenge resolveCode(String code)
Start or continue the oauth login process. if code query parameter is not present, then browser is redirected to authUrl. The redirect URL will be the URL of the current request. If code query parameter is present, then an access token is obtained by invoking a secure request to the codeUrl. If the access token is obtained, the browser is again redirected to the current request URL, but any OAuth protocol specific query parameters are removed.- Returns:
- null if an access token was obtained, otherwise a challenge is returned
-
stripOauthParametersFromRedirect
protected String stripOauthParametersFromRedirect()
strip out unwanted query parameters and redirect so bookmarks don't retain oauth protocol bits
-
-