Implement access token context encoding framework #8
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,95 @@ | ||||||
| /* | ||||||
| * Copyright 2025 Red Hat, Inc. and/or its affiliates | ||||||
| * and other contributors as indicated by the @author tags. | ||||||
| * | ||||||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
| * you may not use this file except in compliance with the License. | ||||||
| * You may obtain a copy of the License at | ||||||
| * | ||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| * | ||||||
| * Unless required by applicable law or agreed to in writing, software | ||||||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||||||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
| * | ||||||
| * See the License for the specific language governing permissions and | ||||||
| * limitations under the License. | ||||||
| * | ||||||
| */ | ||||||
|
|
||||||
| package org.keycloak.protocol.oidc.encode; | ||||||
|
|
||||||
| import java.util.Objects; | ||||||
|
|
||||||
| /** | ||||||
| * Some context info about the token | ||||||
| * | ||||||
| * @author <a href="mailto:[email protected]">Marek Posolda</a> | ||||||
| */ | ||||||
| public class AccessTokenContext { | ||||||
|
|
||||||
| private final SessionType sessionType; | ||||||
| private final TokenType tokenType; | ||||||
| private final String grantType; | ||||||
| private final String rawTokenId; | ||||||
|
|
||||||
| public enum SessionType { | ||||||
| ONLINE("on"), | ||||||
| OFFLINE("of"), | ||||||
| TRANSIENT("tr"), | ||||||
| UNKNOWN("un"); | ||||||
|
|
||||||
| private final String shortcut; | ||||||
|
|
||||||
| SessionType(String shortcut) { | ||||||
| this.shortcut = shortcut; | ||||||
| } | ||||||
|
|
||||||
| public String getShortcut() { | ||||||
| return shortcut; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| public enum TokenType { | ||||||
| REGULAR("rt"), | ||||||
| LIGHTWEIGHT("lt"), | ||||||
| UNKNOWN("un"); | ||||||
|
|
||||||
| private final String shortcut; | ||||||
|
|
||||||
| TokenType(String shortcut) { | ||||||
| this.shortcut = shortcut; | ||||||
| } | ||||||
|
|
||||||
| public String getShortcut() { | ||||||
| return shortcut; | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| public AccessTokenContext(SessionType sessionType, TokenType tokenType, String grantType, String rawTokenId) { | ||||||
| Objects.requireNonNull(sessionType, "Null sessionType not allowed"); | ||||||
| Objects.requireNonNull(tokenType, "Null tokenType not allowed"); | ||||||
| Objects.requireNonNull(grantType, "Null grantType not allowed"); | ||||||
| Objects.requireNonNull(grantType, "Null rawTokenId not allowed"); | ||||||
|
There was a problem hiding this comment. syntax: Wrong parameter validated - should be
Suggested change
|
||||||
| this.sessionType = sessionType; | ||||||
| this.tokenType = tokenType; | ||||||
| this.grantType = grantType; | ||||||
| this.rawTokenId = rawTokenId; | ||||||
| } | ||||||
|
|
||||||
| public SessionType getSessionType() { | ||||||
| return sessionType; | ||||||
| } | ||||||
|
|
||||||
| public TokenType getTokenType() { | ||||||
| return tokenType; | ||||||
| } | ||||||
|
|
||||||
| public String getGrantType() { | ||||||
| return grantType; | ||||||
| } | ||||||
|
|
||||||
| public String getRawTokenId() { | ||||||
| return rawTokenId; | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /* | ||
| * Copyright 2025 Red Hat, Inc. and/or its affiliates | ||
| * and other contributors as indicated by the @author tags. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| */ | ||
|
|
||
| package org.keycloak.protocol.oidc.encode; | ||
|
|
||
| import org.keycloak.models.ClientSessionContext; | ||
| import org.keycloak.models.Constants; | ||
| import org.keycloak.models.KeycloakSession; | ||
| import org.keycloak.models.UserSessionModel; | ||
| import org.keycloak.protocol.oidc.mappers.AbstractOIDCProtocolMapper; | ||
|
|
||
| /** | ||
| * @author <a href="mailto:[email protected]">Marek Posolda</a> | ||
| */ | ||
| public class DefaultTokenContextEncoderProvider implements TokenContextEncoderProvider { | ||
|
|
||
| public static final String UNKNOWN = "na"; | ||
|
|
||
| private final KeycloakSession session; | ||
| private final DefaultTokenContextEncoderProviderFactory factory; | ||
|
|
||
| public DefaultTokenContextEncoderProvider(KeycloakSession session, | ||
| DefaultTokenContextEncoderProviderFactory factory) { | ||
| this.session = session; | ||
| this.factory = factory; | ||
| } | ||
|
|
||
| @Override | ||
| public AccessTokenContext getTokenContextFromClientSessionContext(ClientSessionContext clientSessionContext, String rawTokenId) { | ||
| AccessTokenContext.SessionType sessionType; | ||
| UserSessionModel userSession = clientSessionContext.getClientSession().getUserSession(); | ||
| if (userSession.getPersistenceState() == UserSessionModel.SessionPersistenceState.TRANSIENT) { | ||
| sessionType = AccessTokenContext.SessionType.TRANSIENT; | ||
| } else { | ||
| sessionType = userSession.isOffline() ? AccessTokenContext.SessionType.OFFLINE : AccessTokenContext.SessionType.ONLINE; | ||
| } | ||
|
|
||
| boolean useLightweightToken = AbstractOIDCProtocolMapper.getShouldUseLightweightToken(session); | ||
| AccessTokenContext.TokenType tokenType = useLightweightToken ? AccessTokenContext.TokenType.LIGHTWEIGHT : AccessTokenContext.TokenType.REGULAR; | ||
|
|
||
| String grantType = clientSessionContext.getAttribute(Constants.GRANT_TYPE, String.class); | ||
| if (grantType == null) { | ||
| grantType = UNKNOWN; | ||
| } | ||
|
|
||
| return new AccessTokenContext(sessionType, tokenType, grantType, rawTokenId); | ||
| } | ||
|
|
||
| @Override | ||
| public AccessTokenContext getTokenContextFromTokenId(String encodedTokenId) { | ||
| int indexOf = encodedTokenId.indexOf(':'); | ||
| if (indexOf == -1) { | ||
| return new AccessTokenContext(AccessTokenContext.SessionType.UNKNOWN, AccessTokenContext.TokenType.UNKNOWN, UNKNOWN, encodedTokenId); | ||
| } else { | ||
| String encodedContext = encodedTokenId.substring(0, indexOf); | ||
| String rawId = encodedTokenId.substring(indexOf + 1); | ||
|
|
||
| if (encodedContext.length() != 6) { | ||
| throw new IllegalArgumentException("Incorrect token id: '" + encodedTokenId + "'. Expected length of 6."); | ||
| } | ||
|
|
||
| // First 2 chars are "sessionType", next 2 chars "tokenType", last 2 chars "grantType" | ||
| String stShortcut = encodedContext.substring(0, 2); | ||
| String ttShortcut = encodedContext.substring(2, 4); | ||
| String gtShortcut = encodedContext.substring(4, 6); | ||
|
|
||
| AccessTokenContext.SessionType st = factory.getSessionTypeByShortcut(stShortcut); | ||
| if (st == null) { | ||
| throw new IllegalArgumentException("Incorrect token id: " + encodedTokenId + ". Unknown value '" + stShortcut + "' for session type"); | ||
| } | ||
| AccessTokenContext.TokenType tt = factory.getTokenTypeByShortcut(ttShortcut); | ||
| if (tt == null) { | ||
| throw new IllegalArgumentException("Incorrect token id: " + encodedTokenId + ". Unknown value '" + ttShortcut + "' for token type"); | ||
| } | ||
| String gt = factory.getGrantTypeByShortcut(gtShortcut); | ||
| if (gt == null) { | ||
| throw new IllegalArgumentException("Incorrect token id: " + encodedTokenId + ". Unknown value '" + gtShortcut + "' for grant type"); | ||
| } | ||
|
|
||
| return new AccessTokenContext(st, tt, gt, rawId); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public String encodeTokenId(AccessTokenContext tokenContext) { | ||
| if (tokenContext.getSessionType() == AccessTokenContext.SessionType.UNKNOWN) { | ||
| throw new IllegalStateException("Cannot encode token with unknown sessionType"); | ||
| } | ||
| if (tokenContext.getTokenType() == AccessTokenContext.TokenType.UNKNOWN) { | ||
| throw new IllegalStateException("Cannot encode token with unknown tokenType"); | ||
| } | ||
|
|
||
| String grantShort = factory.getShortcutByGrantType(tokenContext.getGrantType()); | ||
| if (grantShort == null) { | ||
| throw new IllegalStateException("Cannot encode token with unknown grantType: " + tokenContext.getGrantType()); | ||
| } | ||
|
|
||
| return tokenContext.getSessionType().getShortcut() + | ||
| tokenContext.getTokenType().getShortcut() + | ||
| grantShort + | ||
| ':' + tokenContext.getRawTokenId(); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
|
|
||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Javadoc mentions "usually like 3-letters shortcut" but some implementations use 2-letter shortcuts ("ac", "cc", "rt", "te", "pc", "ci", "ro"). Consider updating documentation to reflect actual usage pattern.