8000 Fix expires_in in internal to external token exchange · keycloak/keycloak@e7e6185 · GitHub
[go: up one dir, main page]

Skip to content

Commit e7e6185

Browse files
rmartincmposolda
authored andcommitted
Fix expires_in in internal to external token exchange
Closes #35704 Signed-off-by: rmartinc <rmartinc@redhat.com>
1 parent b633d35 commit e7e6185

4 files changed

Lines changed: 118 additions & 17 deletions

File tree

‎server-spi/src/main/java/org/keycloak/models/IdentityProviderModel.java‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ public class IdentityProviderModel implements Serializable {
5555
public static final String POST_BROKER_LOGIN_FLOW_ID = "postBrokerLoginFlowId";
5656
public static final String SEARCH = "search";
5757
public static final String SYNC_MODE = "syncMode";
58+
public static final String MIN_VALIDITY_TOKEN = "minValidityToken";
59+
public static final int DEFAULT_MIN_VALIDITY_TOKEN = 5;
5860

5961
private String internalId;
6062

@@ -344,6 +346,25 @@ public void setCaseSensitiveOriginalUsername(boolean caseSensitive) {
344346
getConfig().put(CASE_SENSITIVE_ORIGINAL_USERNAME, Boolean.valueOf(caseSensitive).toString());
345347
}
346348

349+
public void setMinValidityToken(int minValidityToken) {
350+
getConfig().put(MIN_VALIDITY_TOKEN, Integer.toString(minValidityToken));
351+
}
352+
353+
public int getMinValidityToken() {
354+
String minValidityTokenString = getConfig().get(MIN_VALIDITY_TOKEN);
355+
if (minValidityTokenString != null) {
356+
try {
357+
int minValidityToken = Integer.parseInt(minValidityTokenString);
358+
if (minValidityToken > 0) {
359+
return minValidityToken;
360+
}
361+
} catch (NumberFormatException e) {
362+
// no-op return default
363+
}
364+
}
365+
return DEFAULT_MIN_VALIDITY_TOKEN;
366+
}
367+
347368
@Override
348369
public int hashCode() {
349370
int hash = 5;

‎services/src/main/java/org/keycloak/broker/oidc/OIDCIdentityProvider.java‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,8 @@ protected Response exchangeStoredToken(UriInfo uriInfo, EventBuilder event, Clie
203203
String modelTokenString = model.getToken();
204204
AccessTokenResponse tokenResponse = JsonSerialization.readValue(modelTokenString, AccessTokenResponse.class);
205205
Integer exp = (Integer) tokenResponse.getOtherClaims().get(ACCESS_TOKEN_EXPIRATION);
206-
if (exp != null && exp < Time.currentTime()) {
206+
final int currentTime = Time.currentTime();
207+
if (exp != null && exp < currentTime + getConfig().getMinValidityToken()) {
207208
if (tokenResponse.getRefreshToken() == null) {
208209
return exchangeTokenExpired(uriInfo, authorizedClient, tokenUserSession, tokenSubject);
209210
}
@@ -219,7 +220,7 @@ protected Response exchangeStoredToken(UriInfo uriInfo, EventBuilder event, Clie
219220
}
220221
AccessTokenResponse newResponse = JsonSerialization.readValue(response, AccessTokenResponse.class);
221222
if (newResponse.getExpiresIn() > 0) {
222-
int accessTokenExpiration = Time.currentTime() + (int) newResponse.getExpiresIn();
223+
int accessTokenExpiration = currentTime + (int) newResponse.getExpiresIn();
223224
newResponse.getOtherClaims().put(ACCESS_TOKEN_EXPIRATION, accessTokenExpiration);
224225
}
225226

@@ -231,7 +232,7 @@ protected Response exchangeStoredToken(UriInfo uriInfo, EventBuilder event, Clie
231232

232233
String oldToken = tokenUserSession.getNote(FEDERATED_ACCESS_TOKEN);
233234
if (oldToken != null && oldToken.equals(tokenResponse.getToken())) {
234-
int accessTokenExpiration = newResponse.getExpiresIn() > 0 ? Time.currentTime() + (int) newResponse.getExpiresIn() : 0;
235+
int accessTokenExpiration = newResponse.getExpiresIn() > 0 ? currentTime + (int) newResponse.getExpiresIn() : 0;
235236
tokenUserSession.setNote(FEDERATED_TOKEN_EXPIRATION, Long.toString(accessTokenExpiration));
236237
tokenUserSession.setNote(FEDERATED_REFRESH_TOKEN, newResponse.getRefreshToken());
237238
tokenUserSession.setNote(FEDERATED_ACCESS_TOKEN, newResponse.getToken());
@@ -241,7 +242,7 @@ protected Response exchangeStoredToken(UriInfo uriInfo, EventBuilder event, Clie
241242
model.setToken(response);
242243
tokenResponse = newResponse;
243244
} else if (exp != null) {
244-
tokenResponse.setExpiresIn(exp - Time.currentTime());
245+
tokenResponse.setExpiresIn(exp - currentTime);
245246
}
246247
tokenResponse.setIdToken(null);
247248
tokenResponse.setRefreshToken(null);
@@ -275,7 +276,6 @@ protected SimpleHttp getRefreshTokenRequest(KeycloakSession session, String refr
275276
protected Response exchangeSessionToken(UriInfo uriInfo, EventBuilder event, ClientModel authorizedClient, UserSessionModel tokenUserSession, UserModel tokenSubject) {
276277
String refreshToken = tokenUserSession.getNote(FEDERATED_REFRESH_TOKEN);
277278
String accessToken = tokenUserSession.getNote(FEDERATED_ACCESS_TOKEN);
278-
String idToken = tokenUserSession.getNote(FEDERATED_ID_TOKEN);
279279

280280
if (accessToken == null) {
281281
event.detail(Details.REASON, "requested_issuer is not linked");
@@ -284,9 +284,10 @@ protected Response exchangeSessionToken(UriInfo uriInfo, EventBuilder event, Cli
284284
}
285285
try (VaultStringSecret vaultStringSecret = session.vault().getStringSecret(getConfig().getClientSecret())) {
286286
long expiration = Long.parseLong(tokenUserSession.getNote(FEDERATED_TOKEN_EXPIRATION));
287-
if (expiration == 0 || expiration > Time.currentTime()) {
287+
final int currentTime = Time.currentTime();
288+
if (expiration == 0 || expiration > currentTime + getConfig().getMinValidityToken()) {
288289
AccessTokenResponse tokenResponse = new AccessTokenResponse();
289-
tokenResponse.setExpiresIn(expiration);
290+
tokenResponse.setExpiresIn(expiration > 0? expiration - currentTime : 0);
290291
tokenResponse.setToken(accessToken);
291292
tokenResponse.setIdToken(null);
292293
tokenResponse.setRefreshToken(null);
@@ -304,7 +305,7 @@ protected Response exchangeSessionToken(UriInfo uriInfo, EventBuilder event, Cli
304305
return exchangeTokenExpired(uriInfo, authorizedClient, tokenUserSession, tokenSubject);
305306
}
306307
AccessTokenResponse newResponse = JsonSerialization.readValue(response, AccessTokenResponse.class);
307-
long accessTokenExpiration = newResponse.getExpiresIn() > 0 ? Time.currentTime() + newResponse.getExpiresIn() : 0;
308+
long accessTokenExpiration = newResponse.getExpiresIn() > 0 ? currentTime + newResponse.getExpiresIn() : 0;
308309
tokenUserSession.setNote(FEDERATED_TOKEN_EXPIRATION, Long.toString(accessTokenExpiration));
309310
tokenUserSession.setNote(FEDERATED_REFRESH_TOKEN, newResponse.getRefreshToken());
310311
tokenUserSession.setNote(FEDERATED_ACCESS_TOKEN, newResponse.getToken());

‎testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/updaters/IdentityProviderAttributeUpdater.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ public IdentityProviderAttributeUpdater removeAttribute(String name) {
4444
return this;
4545
}
4646

47+
public IdentityProviderAttributeUpdater setStoreToken(boolean storeToken) {
48+
rep.setStoreToken(storeToken);
49+
return this;
50+
}
51+
4752
public Closeable update() {
4853
identityProviderResource.update(rep);
4954

‎testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerTokenExchangeTest.java‎

Lines changed: 83 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,23 @@
1919

2020
import static org.hamcrest.MatcherAssert.assertThat;
2121
import static org.hamcrest.Matchers.equalTo;
22+
import static org.hamcrest.Matchers.is;
23+
import static org.hamcrest.Matchers.greaterThan;
24+
import static org.hamcrest.Matchers.lessThanOrEqualTo;
2225
import static org.hamcrest.Matchers.notNullValue;
26+
import static org.hamcrest.Matchers.nullValue;
2327
import static org.keycloak.testsuite.broker.BrokerTestConstants.IDP_OIDC_ALIAS;
2428
import static org.keycloak.testsuite.util.ProtocolMapperUtil.createHardcodedClaim;
2529

26-
import java.util.concurrent.TimeUnit;
27-
2830
import jakarta.ws.rs.client.Client;
2931
import jakarta.ws.rs.client.Entity;
3032
import jakarta.ws.rs.client.WebTarget;
3133
import jakarta.ws.rs.core.Form;
3234
import jakarta.ws.rs.core.HttpHeaders;
3335
import jakarta.ws.rs.core.Response;
3436
import jakarta.ws.rs.core.Response.Status;
37+
import java.io.Closeable;
38+
import java.util.Map;
3539
import org.junit.Test;
3640
import org.keycloak.OAuth2Constants;
3741
import org.keycloak.admin.client.resource.ClientResource;
@@ -50,6 +54,7 @@
5054
import org.keycloak.models.RealmModel;
5155
import org.keycloak.protocol.oidc.OIDCConfigAttributes;
5256
import org.keycloak.protocol.oidc.OIDCLoginProtocol;
57+
import org.keycloak.representations.AccessTokenResponse;
5358
import org.keycloak.representations.idm.ClientRepresentation;
5459
import org.keycloak.representations.idm.IdentityProviderMapperRepresentation;
5560
import org.keycloak.representations.idm.IdentityProviderRepresentation;
@@ -58,12 +63,13 @@
5863
import org.keycloak.services.resources.admin.permissions.AdminPermissionManagement;
5964
import org.keycloak.services.resources.admin.permissions.AdminPermissions;
6065
import org.keycloak.testsuite.Assert;
66+
import org.keycloak.testsuite.admin.ApiUtil;
6167
import org.keycloak.testsuite.arquillian.annotation.EnableFeature;
6268
import org.keycloak.testsuite.arquillian.annotation.EnableFeatures;
69+
import org.keycloak.testsuite.updaters.IdentityProviderAttributeUpdater;
6370
import org.keycloak.testsuite.util.AdminClientUtil;
6471
import org.keycloak.testsuite.util.OAuthClient;
6572
import org.keycloak.util.BasicAuthHelper;
66-
import com.google.common.collect.ImmutableMap;
6773

6874
@EnableFeatures({@EnableFeature(Profile.Feature.TOKEN_EXCHANGE), @EnableFeature(Profile.Feature.ADMIN_FINE_GRAINED_AUTHZ)})
6975
public final class KcOidcBrokerTokenExchangeTest extends AbstractInitializedBaseBrokerTest {
@@ -87,11 +93,10 @@ public void testExternalInternalTokenExchange() throws Exception {
8793
hardCodedSessionNoteMapper.setName("hard-coded");
8894
hardCodedSessionNoteMapper.setIdentityProviderAlias(bc.getIDPAlias());
8995
hardCodedSessionNoteMapper.setIdentityProviderMapper(UserAttributeMapper.PROVIDER_ID);
90-
hardCodedSessionNoteMapper.setConfig(ImmutableMap.<String, String>builder()
91-
.put(IdentityProviderMapperModel.SYNC_MODE, IdentityProviderMapperSyncMode.INHERIT.toString())
92-
.put(UserAttributeMapper.USER_ATTRIBUTE, "mapped-from-claim")
93-
.put(UserAttributeMapper.CLAIM, "hard-coded")
94-
.build());
96+
hardCodedSessionNoteMapper.setConfig(Map.of(
97+
IdentityProviderMapperModel.SYNC_MODE, IdentityProviderMapperSyncMode.INHERIT.toString(),
98+
UserAttributeMapper.USER_ATTRIBUTE, "mapped-from-claim",
99+
UserAttributeMapper.CLAIM, "hard-coded"));
95100

96101
RealmResource consumerRealm = realmsResouce().realm(bc.consumerRealmName());
97102
IdentityProviderResource identityProviderResource = consumerRealm.identityProviders().get(bc.getIDPAlias());
@@ -188,6 +193,30 @@ public void testSupportedTokenTypesWhenValidatingSubjectToken() throws Exception
188193
}
189194
}
190195

196+
@Test
197+
public void testInternalExternalTokenExchangeSessionToken() throws Exception {
198+
testingClient.server(bc.consumerRealmName()).run(KcOidcBrokerTokenExchangeTest::setupRealm);
199+
200+
try (Closeable idpUpdater = new IdentityProviderAttributeUpdater(
201+
realmsResouce().realm(bc.consumerRealmName()).identityProviders().get(bc.getIDPAlias()))
202+
.setStoreToken(false)
203+
.update()) {
204+
testInternalExternalTokenExchange();
205+
}
206+
}
207+
208+
@Test
209+
public void testInternalExternalTokenExchangeStoredToken() throws Exception {
210+
testingClient.server(bc.consumerRealmName()).run(KcOidcBrokerTokenExchangeTest::setupRealm);
211+
212+
try (Closeable idpUpdater = new IdentityProviderAttributeUpdater(
213+
realmsResouce().realm(bc.consumerRealmName()).identityProviders().get(bc.getIDPAlias()))
214+
.setStoreToken(true)
215+
.update()) {
216+
testInternalExternalTokenExchange();
217+
}
218+
}
219+
191220
private static void setupRealm(KeycloakSession session) {
192221
RealmModel realm = session.getContext().getRealm();
193222
IdentityProviderModel idp = session.identityProviders().getByAlias(IDP_OIDC_ALIAS);
@@ -201,12 +230,13 @@ private static void setupRealm(KeycloakSession session) {
201230
client.setSecret("secret");
202231
client.setProtocol(OIDCLoginProtocol.LOGIN_PROTOCOL);
203232
client.setFullScopeAllowed(false);
233+
ClientModel brokerApp = realm.getClientByClientId("broker-app");
204234

205235
AdminPermissionManagement management = AdminPermissions.management(session, realm);
206236
management.idps().setPermissionsEnabled(idp, true);
207237
ClientPolicyRepresentation clientRep = new ClientPolicyRepresentation();
208238
clientRep.setName("toIdp");
209-
clientRep.addClient(client.getId());
239+
clientRep.addClient(client.getId(), brokerApp.getId());
210240
ResourceServer server = management.realmResourceServer();
211241
Policy clientPolicy = management.authz().getStoreFactory().getPolicyStore().create(server, clientRep);
212242
management.idps().exchangeToPermission(idp).addAssociatedPolicy(clientPolicy);
@@ -216,4 +246,48 @@ private static void setupRealm(KeycloakSession session) {
216246
client.addRedirectUri(OAuthClient.APP_ROOT + "/auth");
217247
client.setAttribute(OIDCConfigAttributes.BACKCHANNEL_LOGOUT_URL, OAuthClient.APP_ROOT + "/admin/backchannelLogout");
218248
}
249+
250+
private void testInternalExternalTokenExchange() throws Exception {
251+
final RealmResource consumerRealm = realmsResouce().realm(bc.consumerRealmName());
252+
final int expires = realmsResouce().realm(bc.providerRealmName()).toRepresentation().getAccessTokenLifespan();
253+
final ClientRepresentation brokerApp = ApiUtil.findClientByClientId(consumerRealm, "broker-app").toRepresentation();
254+
255+
logInAsUserInIDPForFirstTimeAndAssertSuccess();
256+
final String code = oauth.getCurrentQuery().get(OAuth2Constants.CODE);
257+
OAuthClient.AccessTokenResponse tokenResponse = oauth.doAccessTokenRequest(code, brokerApp.getSecret());
258+
assertThat(tokenResponse.getError(), nullValue());
259+
assertThat(tokenResponse.getAccessToken(), notNullValue());
260+
261+
exchangeToIdP(brokerApp, tokenResponse.getAccessToken(), expires);
262+
263+
setTimeOffset(expires - IdentityProviderModel.DEFAULT_MIN_VALIDITY_TOKEN);
264+
265+
tokenResponse = oauth.doRefreshTokenRequest(tokenResponse.getRefreshToken(), brokerApp.getSecret());
266+
assertThat(tokenResponse.getError(), nullValue());
267+
assertThat(tokenResponse.getAccessToken(), notNullValue());
268+
269+
exchangeToIdP(brokerApp, tokenResponse.getAccessToken(), expires);
270+
}
271+
272+
private void exchangeToIdP(ClientRepresentation brokerApp, String subjectToken, long expires) {
273+
try (Client httpClient = AdminClientUtil.createResteasyClient();
274+
Response response = httpClient.target(OAuthClient.AUTH_SERVER_ROOT)
275+
.path("/realms").path(bc.consumerRealmName()).path("protocol/openid-connect/token")
276+
.request()
277+
.header(HttpHeaders.AUTHORIZATION, BasicAuthHelper.createHeader(brokerApp.getClientId(), brokerApp.getSecret()))
278+
.post(Entity.form(new Form()
279+
.param(OAuth2Constants.GRANT_TYPE, OAuth2Constants.TOKEN_EXCHANGE_GRANT_TYPE)
280+
.param(OAuth2Constants.SUBJECT_TOKEN, subjectToken)
281+
.param(OAuth2Constants.SUBJECT_TOKEN_TYPE, OAuth2Constants.ACCESS_TOKEN_TYPE)
282+
.param(OAuth2Constants.REQUESTED_ISSUER, bc.getIDPAlias()))
283+
)) {
284+
assertThat(response.getStatus(), is(Response.Status.OK.getStatusCode()));
285+
286+
AccessTokenResponse exchangeResponse = response.readEntity(AccessTokenResponse.class);
287+
assertThat(exchangeResponse.getError(), nullValue());
288+
assertThat(exchangeResponse.getToken(), notNullValue());
289+
assertThat(exchangeResponse.getExpiresIn(), greaterThan((long) IdentityProviderModel.DEFAULT_MIN_VALIDITY_TOKEN));
290+
assertThat(exchangeResponse.getExpiresIn(), lessThanOrEqualTo(expires));
291+
}
292+
}
219293
}

0 commit comments

Comments
 (0)
0