Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import fr.insee.keycloak.providers.common.AbstractBaseIdentityProvider;
import fr.insee.keycloak.providers.common.EidasLevel;
import fr.insee.keycloak.providers.common.Utils;
import jakarta.ws.rs.core.UriBuilder;
import org.keycloak.OAuth2Constants;
import org.keycloak.broker.provider.AuthenticationRequest;
Expand Down Expand Up @@ -36,7 +35,7 @@ final class AgentConnectIdentityProvider
);

AgentConnectIdentityProvider(KeycloakSession session, AgentConnectIdentityProviderConfig config) {
super(session, config, Utils.getJsonWebKeySetFrom(config.getJwksUrl(), session));
super(session, config);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -1,28 +1,20 @@
package fr.insee.keycloak.providers.common;

import static fr.insee.keycloak.providers.common.Utils.transcodeSignatureToDER;
import static org.keycloak.util.JWKSUtils.getKeyWrappersForUse;

import java.nio.charset.StandardCharsets;
import java.security.PublicKey;
import java.security.Signature;
import java.util.Optional;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriBuilder;
import jakarta.ws.rs.core.UriInfo;
import org.keycloak.broker.oidc.AbstractOAuth2IdentityProvider;
import org.keycloak.broker.oidc.OIDCIdentityProvider;
import org.keycloak.broker.oidc.OIDCIdentityProviderConfig;
import org.keycloak.broker.provider.BrokeredIdentityContext;
import org.keycloak.broker.provider.IdentityBrokerException;
import org.keycloak.broker.social.SocialIdentityProvider;
import org.keycloak.crypto.JavaAlgorithm;
import org.keycloak.events.Errors;
import org.keycloak.events.EventBuilder;
import org.keycloak.events.EventType;
import org.keycloak.jose.jwk.JSONWebKeySet;
import org.keycloak.jose.jwk.JWK;
import org.keycloak.jose.jws.Algorithm;
import org.keycloak.jose.jws.JWSInput;
import org.keycloak.jose.jws.crypto.HMACProvider;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
import org.keycloak.models.UserSessionModel;
Expand All @@ -33,23 +25,13 @@
import org.keycloak.services.resources.IdentityBrokerService;
import org.keycloak.services.resources.RealmsResource;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriBuilder;
import jakarta.ws.rs.core.UriInfo;

public abstract class AbstractBaseIdentityProvider<T extends AbstractBaseProviderConfig>
extends OIDCIdentityProvider implements SocialIdentityProvider<OIDCIdentityProviderConfig> {

protected static final String ACR_CLAIM_NAME = "acr";

protected JSONWebKeySet jwks;

protected AbstractBaseIdentityProvider(KeycloakSession session, T config, JSONWebKeySet jwks) {
protected AbstractBaseIdentityProvider(KeycloakSession session, T config) {
super(session, config);
this.jwks = jwks;
}

@Override
Expand Down Expand Up @@ -104,58 +86,6 @@ protected String getIdTokenForLogout(UserSessionModel userSession) {
return idToken != null ? idToken : userSession.getNote(FEDERATED_ID_TOKEN);
}

@Override
protected boolean verify(JWSInput jws) {
logger.info("Validating: " + jws.getWireString());

var config = getConfig();

if (!config.isValidateSignature()) {
return true;
}

if (Algorithm.HS256.equals(jws.getHeader().getAlgorithm())) {
try (var vaultStringSecret = session.vault().getStringSecret(getConfig().getClientSecret())) {
var clientSecret = vaultStringSecret.get().orElse(getConfig().getClientSecret());
return HMACProvider.verify(jws, clientSecret.getBytes());
}
}

try {
var publicKey =
Optional.ofNullable(getKeyWrappersForUse(jwks, JWK.Use.SIG).getKeyByKidAndAlg(jws.getHeader().getKeyId(),jws.getHeader().getAlgorithm().name()))
.or(
() -> {
// Try reloading jwks url
jwks = Utils.getJsonWebKeySetFrom(config.getJwksUrl(), session);
return Optional.ofNullable(
getKeyWrappersForUse(jwks, JWK.Use.SIG).getKeyByKidAndAlg(jws.getHeader().getKeyId(),jws.getHeader().getAlgorithm().name()));
})
.orElse(null);

if (publicKey == null) {
logger.error("No keys found for kid: " + jws.getHeader().getKeyId());
return false;
}

var algorithm = JavaAlgorithm.getJavaAlgorithm(jws.getHeader().getAlgorithm().name());

var verifier = Signature.getInstance(algorithm);
verifier.initVerify((PublicKey) publicKey.getPublicKey());
verifier.update(jws.getEncodedSignatureInput().getBytes(StandardCharsets.UTF_8));

var signature = jws.getSignature();
if (algorithm.endsWith("ECDSA")) {
signature = transcodeSignatureToDER(signature);
}

return verifier.verify(signature);
} catch (Exception ex) {
logger.error("Signature verification failed", ex);
return false;
}
}

@Override
public BrokeredIdentityContext getFederatedIdentity(String response) {

Expand Down
78 changes: 0 additions & 78 deletions src/main/java/fr/insee/keycloak/providers/common/Utils.java
Original file line number Diff line number Diff line change
Expand Up @@ -74,82 +74,4 @@ public static JSONWebKeySet getJsonWebKeySetFrom(String jwksUrl, KeycloakSession
}
}

// We need this due to a bug in signature verification
// (https://github.com/GluuFederation/oxAuth/issues/1210)
public static byte[] transcodeSignatureToDER(byte[] jwsSignature) {

// Adapted from
// org.apache.xml.security.algorithms.implementations.SignatureECDSA

int rawLen = jwsSignature.length / 2;

int i;

for (i = rawLen; (i > 0) && (jwsSignature[rawLen - i] == 0); i--) {
// do nothing
}

int j = i;

if (jwsSignature[rawLen - i] < 0) {
j += 1;
}

int k;

for (k = rawLen; (k > 0) && (jwsSignature[2 * rawLen - k] == 0); k--) {
// do nothing
}

int l = k;

if (jwsSignature[2 * rawLen - k] < 0) {
l += 1;
}

int len = 2 + j + 2 + l;

if (len > 255) {
throw new RuntimeException("Invalid ECDSA signature format");
}

int offset;

final byte derSignature[];

if (len < 128) {
derSignature = new byte[2 + 2 + j + 2 + l];
offset = 1;
} else {
derSignature = new byte[3 + 2 + j + 2 + l];
derSignature[1] = (byte) 0x81;
offset = 2;
}

derSignature[0] = 48;
derSignature[offset++] = (byte) len;
derSignature[offset++] = 2;
derSignature[offset++] = (byte) j;

System.arraycopy(jwsSignature, rawLen - i, derSignature, (offset + j) - i, i);

offset += j;

derSignature[offset++] = 2;
derSignature[offset++] = (byte) l;

System.arraycopy(jwsSignature, 2 * rawLen - k, derSignature, (offset + l) - k, k);

return derSignature;
}

public static byte[] generateRandomBytes(int length) {
if (length < 1) {
throw new IllegalArgumentException();
}

byte[] buf = new byte[length];
random.get().nextBytes(buf);
return buf;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
import java.util.Properties;

enum FCEnvironment {
// Legacy V1 , should stop in 2025
INTEGRATION_V1("france-connect.integration.v1"),
PRODUCTION_V1("france-connect.production.v1"),
// Names left for retro compatibility, prefer now "Plus"
INTEGRATION_V2("france-connect.plus.integration.v2"),
PRODUCTION_V2("france-connect.plus.production.v2"),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
package fr.insee.keycloak.providers.franceconnect;

import static fr.insee.keycloak.providers.common.EidasLevel.EIDAS1;
import static jakarta.ws.rs.core.Response.Status.OK;

import com.fasterxml.jackson.databind.JsonNode;
import fr.insee.keycloak.providers.common.AbstractBaseIdentityProvider;
import fr.insee.keycloak.providers.common.Utils;
import java.io.IOException;
import java.util.Optional;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.UriBuilder;
import jakarta.xml.bind.DatatypeConverter;
import org.keycloak.OAuth2Constants;
import org.keycloak.broker.oidc.mappers.AbstractJsonUserAttributeMapper;
import org.keycloak.broker.provider.AuthenticationRequest;
Expand All @@ -21,16 +14,19 @@
import org.keycloak.crypto.KeyWrapper;
import org.keycloak.jose.jwe.JWE;
import org.keycloak.jose.jwe.JWEException;
import org.keycloak.jose.jws.JWSInput;
import org.keycloak.jose.jws.JWSInputException;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.UserSessionModel;
import org.keycloak.protocol.oidc.OIDCLoginProtocol;
import org.keycloak.representations.AccessTokenResponse;
import org.keycloak.representations.IDToken;
import org.keycloak.representations.JsonWebToken;
import org.keycloak.util.JsonSerialization;

import java.io.IOException;
import java.util.Optional;

import static fr.insee.keycloak.providers.common.EidasLevel.EIDAS1;
import static jakarta.ws.rs.core.Response.Status.OK;

final class FranceConnectIdentityProvider
extends AbstractBaseIdentityProvider<FranceConnectIdentityProviderConfig> {

Expand All @@ -39,30 +35,17 @@ final class FranceConnectIdentityProvider

FranceConnectIdentityProvider(
KeycloakSession session, FranceConnectIdentityProviderConfig config) {
super(
session,
config,
useJwks(config) ? Utils.getJsonWebKeySetFrom(config.getJwksUrl(), session) : null);
super(session, config);
}

private static boolean useJwks(FranceConnectIdentityProviderConfig config) {
return config.isUseJwksUrl() && config.getJwksUrl() != null;
}

/** France connect requires nonce to be exactly 64 char long, so...yes */
@Override
protected UriBuilder createAuthorizationUrl(AuthenticationRequest request) {
var config = getConfig();
var authenticationSession = request.getAuthenticationSession();

authenticationSession.setClientNote(
OAuth2Constants.ACR_VALUES, config.getEidasLevel().toString());
OAuth2Constants.ACR_VALUES, getConfig().getEidasLevel().toString());
var uriBuilder = super.createAuthorizationUrl(request);

var nonce = DatatypeConverter.printHexBinary(Utils.generateRandomBytes(32));
authenticationSession.setClientNote(BROKER_NONCE_PARAM, nonce);
uriBuilder.replaceQueryParam(OIDCLoginProtocol.NONCE_PARAM, nonce);

logger.debugv("FC Authorization Url: {0}", uriBuilder.build().toString());

return uriBuilder;
Expand All @@ -74,14 +57,6 @@ public String getIdTokenForLogout(UserSessionModel userSession) {
return isJWETokenFormatRequired(getConfig()) ? decryptJWE(idToken) : idToken;
}

@Override
public JsonWebToken validateToken(String encodedToken) {
var ignoreAudience = false;
var token = isJWETokenFormatRequired(getConfig()) ? decryptJWE(encodedToken) : encodedToken;

return validateToken(token, ignoreAudience);
}

@Override
protected BrokeredIdentityContext extractIdentity(
AccessTokenResponse tokenResponse, String accessToken, JsonWebToken idToken)
Expand Down Expand Up @@ -131,12 +106,7 @@ protected BrokeredIdentityContext extractIdentity(
userInfo = response.asJson();
} else if (APPLICATION_JWT_TYPE.isCompatible(contentMediaType)) {
try {
var jwt =
isJWETokenFormatRequired(getConfig())
? decryptJWE(response.asString())
: response.asString();

userInfo = getJsonFromJWT(jwt);
userInfo = JsonSerialization.readValue(parseTokenInput(response.asString(),true), JsonNode.class);
} catch (IdentityBrokerException ex) {
throw new RuntimeException(
"Failed to verify signature of userinfo response from [" + userInfoUrl + "].",
Expand Down Expand Up @@ -194,7 +164,7 @@ protected BrokeredIdentityContext extractIdentity(

private boolean isJWETokenFormatRequired(FranceConnectIdentityProviderConfig config) {
var eidasLevel = config.getEidasLevel();
return !EIDAS1.equals(eidasLevel) && useJwks(config);
return !EIDAS1.equals(eidasLevel);
}

private String decryptJWE(String encryptedJWE) {
Expand Down Expand Up @@ -231,23 +201,4 @@ private SimpleHttp.Response executeRequest(String url, SimpleHttp request) throw
return response;
}

private JsonNode getJsonFromJWT(String jwt) throws IdentityBrokerException {
JWSInput jwsInput;

try {
jwsInput = new JWSInput(jwt);
} catch (JWSInputException cause) {
throw new IdentityBrokerException("Failed to parse JWT userinfo response", cause);
}

if (!verify(jwsInput)) {
throw new IdentityBrokerException("Failed to verify signature of of jwt");
}

try {
return JsonSerialization.readValue(jwsInput.getContent(), JsonNode.class);
} catch (IOException e) {
throw new IdentityBrokerException("Failed to parse jwt", e);
}
}
}
12 changes: 0 additions & 12 deletions src/main/resources/france-connect.properties
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
# FC V1 legacy

france-connect.integration.v1.authorization.url=https://fcp.integ01.dev-franceconnect.fr/api/v1/authorize
france-connect.integration.v1.token.url=https://fcp.integ01.dev-franceconnect.fr/api/v1/token
france-connect.integration.v1.userinfo.url=https://fcp.integ01.dev-franceconnect.fr/api/v1/userinfo
france-connect.integration.v1.logout.url=https://fcp.integ01.dev-franceconnect.fr/api/v1/logout

france-connect.production.v1.authorization.url=https://app.franceconnect.gouv.fr/api/v1/authorize
france-connect.production.v1.token.url=https://app.franceconnect.gouv.fr/api/v1/token
france-connect.production.v1.userinfo.url=https://app.franceconnect.gouv.fr/api/v1/userinfo
france-connect.production.v1.logout.url=https://app.franceconnect.gouv.fr/api/v1/logout

## FC standard V2

# integration when when you create your client id with the partner portal
Expand Down
Loading
Loading