Update OIDCConfig with scope information (#13973)

Allow users to provide custom scope through OIDC configuration
This commit is contained in:
Rishabh Singh 2023-03-28 14:50:00 +05:30 committed by GitHub
parent d5b1b5bc8e
commit e8e8082573
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 22 additions and 3 deletions

View File

@ -54,3 +54,4 @@ druid.auth.authenticator.jwt.type=jwt
|`druid.auth.pac4j.oidc.clientSecret`|OAuth Client Application secret. It can be provided as plaintext string or The [Password Provider](../../operations/password-provider.md).|none|Yes| |`druid.auth.pac4j.oidc.clientSecret`|OAuth Client Application secret. It can be provided as plaintext string or The [Password Provider](../../operations/password-provider.md).|none|Yes|
|`druid.auth.pac4j.oidc.discoveryURI`|discovery URI for fetching OP metadata [see this](http://openid.net/specs/openid-connect-discovery-1_0.html).|none|Yes| |`druid.auth.pac4j.oidc.discoveryURI`|discovery URI for fetching OP metadata [see this](http://openid.net/specs/openid-connect-discovery-1_0.html).|none|Yes|
|`druid.auth.pac4j.oidc.oidcClaim`|[claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims) that will be extracted from the ID Token after validation.|name|No| |`druid.auth.pac4j.oidc.oidcClaim`|[claim](https://openid.net/specs/openid-connect-core-1_0.html#Claims) that will be extracted from the ID Token after validation.|name|No|
|`druid.auth.pac4j.oidc.scope`| scope is used by an application during authentication to authorize access to a user's details |`openid profile email`|No

View File

@ -24,6 +24,8 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Preconditions; import com.google.common.base.Preconditions;
import org.apache.druid.metadata.PasswordProvider; import org.apache.druid.metadata.PasswordProvider;
import javax.annotation.Nullable;
public class OIDCConfig public class OIDCConfig
{ {
private final String DEFAULT_SCOPE = "name"; private final String DEFAULT_SCOPE = "name";
@ -39,18 +41,23 @@ public class OIDCConfig
@JsonProperty @JsonProperty
private final String oidcClaim; private final String oidcClaim;
@JsonProperty
private final String scope;
@JsonCreator @JsonCreator
public OIDCConfig( public OIDCConfig(
@JsonProperty("clientID") String clientID, @JsonProperty("clientID") String clientID,
@JsonProperty("clientSecret") PasswordProvider clientSecret, @JsonProperty("clientSecret") PasswordProvider clientSecret,
@JsonProperty("discoveryURI") String discoveryURI, @JsonProperty("discoveryURI") String discoveryURI,
@JsonProperty("oidcClaim") String oidcClaim @JsonProperty("oidcClaim") String oidcClaim,
@JsonProperty("scope") @Nullable String scope
) )
{ {
this.clientID = Preconditions.checkNotNull(clientID, "null clientID"); this.clientID = Preconditions.checkNotNull(clientID, "null clientID");
this.clientSecret = Preconditions.checkNotNull(clientSecret, "null clientSecret"); this.clientSecret = Preconditions.checkNotNull(clientSecret, "null clientSecret");
this.discoveryURI = Preconditions.checkNotNull(discoveryURI, "null discoveryURI"); this.discoveryURI = Preconditions.checkNotNull(discoveryURI, "null discoveryURI");
this.oidcClaim = oidcClaim == null ? DEFAULT_SCOPE : oidcClaim; this.oidcClaim = oidcClaim == null ? DEFAULT_SCOPE : oidcClaim;
this.scope = scope;
} }
@JsonProperty @JsonProperty
@ -76,4 +83,10 @@ public class OIDCConfig
{ {
return oidcClaim; return oidcClaim;
} }
@JsonProperty
public String getScope()
{
return scope;
}
} }

View File

@ -130,6 +130,7 @@ public class Pac4jAuthenticator implements Authenticator
oidcConf.setClientId(oidcConfig.getClientID()); oidcConf.setClientId(oidcConfig.getClientID());
oidcConf.setSecret(oidcConfig.getClientSecret().getPassword()); oidcConf.setSecret(oidcConfig.getClientSecret().getPassword());
oidcConf.setDiscoveryURI(oidcConfig.getDiscoveryURI()); oidcConf.setDiscoveryURI(oidcConfig.getDiscoveryURI());
oidcConf.setScope(oidcConfig.getScope());
oidcConf.setExpireSessionWithToken(true); oidcConf.setExpireSessionWithToken(true);
oidcConf.setUseNonce(true); oidcConf.setUseNonce(true);
oidcConf.setReadTimeout(Ints.checkedCast(pac4jCommonConfig.getReadTimeout().getMillis())); oidcConf.setReadTimeout(Ints.checkedCast(pac4jCommonConfig.getReadTimeout().getMillis()));

View File

@ -33,7 +33,8 @@ public class OIDCConfigTest
String jsonStr = "{\n" String jsonStr = "{\n"
+ " \"clientID\": \"testid\",\n" + " \"clientID\": \"testid\",\n"
+ " \"clientSecret\": \"testsecret\",\n" + " \"clientSecret\": \"testsecret\",\n"
+ " \"discoveryURI\": \"testdiscoveryuri\"\n" + " \"discoveryURI\": \"testdiscoveryuri\",\n"
+ " \"scope\": \"testscope\"\n"
+ "}\n"; + "}\n";
OIDCConfig conf = jsonMapper.readValue( OIDCConfig conf = jsonMapper.readValue(
@ -44,6 +45,7 @@ public class OIDCConfigTest
Assert.assertEquals("testsecret", conf.getClientSecret().getPassword()); Assert.assertEquals("testsecret", conf.getClientSecret().getPassword());
Assert.assertEquals("testdiscoveryuri", conf.getDiscoveryURI()); Assert.assertEquals("testdiscoveryuri", conf.getDiscoveryURI());
Assert.assertEquals("name", conf.getOidcClaim()); Assert.assertEquals("name", conf.getOidcClaim());
Assert.assertEquals("testscope", conf.getScope());
} }
@Test @Test
@ -55,7 +57,8 @@ public class OIDCConfigTest
+ " \"clientID\": \"testid\",\n" + " \"clientID\": \"testid\",\n"
+ " \"clientSecret\": \"testsecret\",\n" + " \"clientSecret\": \"testsecret\",\n"
+ " \"discoveryURI\": \"testdiscoveryuri\",\n" + " \"discoveryURI\": \"testdiscoveryuri\",\n"
+ " \"oidcClaim\": \"email\"\n" + " \"oidcClaim\": \"email\",\n"
+ " \"scope\": \"testscope\"\n"
+ "}\n"; + "}\n";
OIDCConfig conf = jsonMapper.readValue( OIDCConfig conf = jsonMapper.readValue(
@ -67,5 +70,6 @@ public class OIDCConfigTest
Assert.assertEquals("testsecret", conf.getClientSecret().getPassword()); Assert.assertEquals("testsecret", conf.getClientSecret().getPassword());
Assert.assertEquals("testdiscoveryuri", conf.getDiscoveryURI()); Assert.assertEquals("testdiscoveryuri", conf.getDiscoveryURI());
Assert.assertEquals("email", conf.getOidcClaim()); Assert.assertEquals("email", conf.getOidcClaim());
Assert.assertEquals("testscope", conf.getScope());
} }
} }