[WFLY-17143] Community - Add the ability to specify that the OIDC Authentication Request should include request and request_uri parameters #532

PrarthonaPaul · 2023-08-08T17:43:22Z

Issue: https://issues.redhat.com/browse/WFLY-17143
related issue: https://issues.redhat.com/browse/ELY-2584
Relevant github discussions:

Sending Request Object by reference keycloak/keycloak#23150
Hows does a client communicate public Key to Keycloak that will be used to verify signed and encrypted JWTs? keycloak/keycloak#22729
Signing JWTs with symmetrical secret key keycloak/keycloak#24514

fjuma

Thanks @PrarthonaPaul! I've started adding a few comments here.

fjuma · 2023-08-08T19:13:00Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+== Overview
+
+OpenID Connect is an authentication mechanism that builds on OAuth 2.0 and allows a user to login to a web application using credentials established by an OpenID provider. Authentication requests sent using OpenID Connect can be signed and optionally encrypted. This can be achieved using 2 auth request parameters: `request` and `request_uri`, which are both optional. 


We should mention in the overview that the elytron-oidc-client subsystem doesn't currently include the ability to specify the request or request_uri in the authentication request.

fjuma · 2023-08-08T19:13:25Z

elytron/WFLY-17143-request-uri-parameters.adoc

+=== Related Issues
+
+* https://issues.redhat.com/browse/EAP7-1974[EAP7-1974]
+* [INSERT ELY ISSUE]


Feel free to create the corresponding ELY issue.

fjuma · 2023-08-08T19:14:35Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+=== Hard Requirements
+
+* Two new attributes named `request` and `request-uri` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem, which will be used to specify either the `request` or the `request_uri`, which are both JWTs.  


What will be the type of the new attributes? (i.e., what will their allowed values be, what will they default to, etc.)

fjuma · 2023-08-08T19:14:50Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+* Two new attributes named `request` and `request-uri` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem, which will be used to specify either the `request` or the `request_uri`, which are both JWTs.  
+
+* According to the https://issues.redhat.com/browse/EAP7-1974[OIDC specs], only one of the two parameters can be specified at a time. If `request` is added, then `request_uri` MUST NOT be used in the same request. However, the user can choose to specify neither. 


I think this is the wrong link here.

fjuma · 2023-08-08T19:15:43Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+* The feature must deal with cases where the OpenId Provider does not support request parameters by recognizing `request_not_supported` error and dealing with it accordingly.
+
+* It should be possible to specify that these parameters should be included in the Authentication Request via deployment configuration using the `oidc.json` file inside the `WEB-INF` directory of the web application and `elytron-oidc-client` subsystem configuration.


What will the new attributes in oidc.json look like?

fjuma · 2023-08-08T19:16:03Z

elytron/WFLY-17143-request-uri-parameters.adoc

+    * 
+
+== Community Documentation
+Documentation for the new scope option will be added to https://github.com/wildfly/wildfly/blob/main/docs/src/main/asciidoc/_admin-guide/subsystem-configuration/Elytron_OIDC_Client.adoc[Elytron OpenID Connect Client Subsystem Configuration].


This needs to be updated.

Updated! Thank you for the reviews!

OndrejKotek · 2023-08-11T07:12:49Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+=== Hard Requirements
+
+* A new attribute named `request-object-required` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem. The value for this attribute will be a String with 3 acceptable values: 


A new attribute named request-object-required will be added to the secure-deployment resource under the elytron-oidc-client subsystem.

Why just to secure-deployment? Why not also to provider, realm, and/or secure-server?

Hi @OndrejKotek,
Thank you for your review. Adding this attribute to secure-server makes sense and I can add that to the analysis doc. However, I am not sure if this attribute relates to realm or provider_url since request parameters encrypt query parameters. Additionally, you cannot configure client-id using realm or provider_url, which is needed for the auth request. So, they would have to configure secure-server or secure-deployment regardless. However, if you see other benefits to having request-object-required added to realm and provider_url, I am happy to add it there!

IIUIC, provider and realm resources are just containers for settings that can be referenced in secure-deployment or secure-server resources. It makes sense to me to allow to define request-object-requiredalso in such resources (at higher/more global configuration levels) like the other attributes. WDYT?

Yes, that makes sense! This way if we have two secure-deployments using the same realm or provider, then we don't need to set request-object-required multiple times. And if we want to have multiple secure-deployment or secure-servers using the same realm but one with request_uri and the other with plaintext query, then they can declare it under secure-server directly.
Ill update the docs and implement it accordingly on the subsystem.
Thank you!

OndrejKotek · 2023-08-14T06:28:34Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+* The `request-object-required` attribute will specify if either `request` or the `request_uri` would be added to the auth request. This will be an optional attribute. The default value for this attribute will be set to `none`, indicating that neither request parameters are used and the query parameters are sent through the url.
+
+** For multiple `secure-server` or `secure-deployment`s using the same `realm` or `provider`, the `request-object-required` can be specified at the higher level resource. 


`secure-deployment`s

This formatting does not work, there needs to a space before the s. I suggest to use something like `secure-deployment` resources instead.

The same in the next point/sentence.

fjuma · 2023-08-28T19:02:15Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+=== Hard Requirements
+
+* A new attributes named `request-object-required`, `request-signing-algorithm`, `request-encrypt-algorithm` and `request-encrypt-enc` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `request-object-required` attribute will be a String with 3 acceptable values: 


Instead of request-object-required, I'm wondering if authentication-request-format might be a better name?

That sounds better. I can change it to this. Thanks for the suggestion!

fjuma · 2023-08-28T19:02:43Z

elytron/WFLY-17143-request-uri-parameters.adoc

+=== Hard Requirements
+
+* A new attributes named `request-object-required`, `request-signing-algorithm`, `request-encrypt-algorithm` and `request-encrypt-enc` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `request-object-required` attribute will be a String with 3 acceptable values: 
+** none


Instead of none, maybe we can call it oauth2 (for the standard OAuth2 request format)?

fjuma · 2023-08-28T19:18:33Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** The values for `request-signing-algorithm` attribute are of type `String`. Default value for this attribute would be `none`, specifying that the request would be sent as a plaintext. The default value of `request-signing-algorithm` is `none`. The signing algorithm specified must be one of the signing algorithms accepted by the OpenID provider. 
+
+* The request object may also be encrypted. To specify that the request parameter will be encrypted, the user needs to specify the relevant algorithms using `request-encrypt-algorithm` and `request-encrypt-enc`. 


Just looking at https://openid.net/specs/openid-connect-core-1_0.html#EncryptedRequestObject.

It mentions "If the Authorization Server has advertised JWE encryption algorithms in the request_object_encryption_alg_values_supported and request_object_encryption_enc_values_supported elements of its Discovery document [OpenID.Discovery], or has supplied encryption algorithms by other means, these are used by the Client to encrypt the JWT."

To keep things simple, instead of making the encryption algorithm configurable, we could just rely on discovery, i.e., we can use one of the algorithms discovered from request_object_encryption_alg_values_supported and request_object_encryption_enc_values_supported.

(Note that the discovery code is here: https://github.com/wildfly-security/wildfly-elytron/blob/2.x/http/oidc/src/main/java/org/wildfly/security/http/oidc/OidcClientConfiguration.java#L215-L253)

@OndrejKotek What do you think?

Do we know if Keycloak supports request object encryption? (Was just taking a look at the response from http://localhost:8080/auth/realms/WildFly/.well-known/openid-configuration and I do see request_object_signing_alg_values_supported but I don't seem to see request_object_encryption_alg_values_supported or request_object_encryption_enc_values_supported.)

Thank you for your comment.
I have added to the discovery code to extract openid information, such as algorithms that are supported for signing and encrypting. There are multiple algorithms for all three supported by keycloak.
For example here are the algorithms that keycloak supports for encrypting:

This is why I allowed the user to specify the algorithms.

And yes, Keycloak does support request object encryption (please see image above). We can do a check to see if the algorithm specified by the user is one of the ones supported and throw an error/exception otherwise.

Thanks for clarifying that, if Keycloak provides the ability to configure that, then it's fine to have corresponding attributes in the subsystem / JSON configuration.

How about renaming to request-object-encryption-algorithm and request-object-content-encryption-algorithm?

fjuma · 2023-08-28T19:24:26Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+* The Request Object MAY be signed or unsigned (plaintext) and can be specified by value or by reference. The user can specify the algorithm used to sign the JWT request using the `request-signing-algorithm` attribute which will also be added to the resources specified above. 
+
+** The values for `request-signing-algorithm` attribute are of type `String`. Default value for this attribute would be `none`, specifying that the request would be sent as a plaintext. The default value of `request-signing-algorithm` is `none`. The signing algorithm specified must be one of the signing algorithms accepted by the OpenID provider. 


Maybe we could call this request-object-signing-algorithm?

updated! I have also added a point about configuring the keystore information using existing keystore file related attributes.
Thank you for the comments :)

fjuma · 2023-09-01T18:13:52Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+=== Hard Requirements
+
+* A new attributes named `authentication-request-format`, `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `authentication-request-format` attribute will be a String with 3 acceptable values: 


Very minor, s/A new attributes/New attributes

fjuma · 2023-09-01T18:21:49Z

elytron/WFLY-17143-request-uri-parameters.adoc

+* A new attributes named `authentication-request-format`, `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `authentication-request-format` attribute will be a String with 3 acceptable values: 
+** oauth2: Indicating that the query parameters will be sent as usual following the oauth2 syntax. 
+** request: Indicating that the query will be sent as a jwt by value. 
+** request_uri: Indicating that the query will be sent as a reference to the jwt. 


Just to be consistent with the format of the other attribute names, I think we could use request-uri instead of request_uri.

As discussed, since this is a value and not an attribute name, we will keep it as request_uri to be consistent with the specifications.

fjuma · 2023-09-01T18:22:09Z

elytron/WFLY-17143-request-uri-parameters.adoc

+** request: Indicating that the query will be sent as a jwt by value. 
+** request_uri: Indicating that the query will be sent as a reference to the jwt. 
+
+* The `authentication-request-format` attribute will specify if either `request` or the `request_uri` would be added to the auth request. This will be an optional attribute. The default value for this attribute will be set to `none`, indicating that neither request parameters are used and the query parameters are sent through the url.


s/would be added/should be added

The default value will be oauth2

fjuma · 2023-09-01T18:23:19Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** For multiple `secure-server` or `secure-deployment` resources using the same `realm` or `provider`, the `authentication-request-format` can be specified at the higher level resource. 
+
+** For multiple `secure-server` or `secure-deployment` resources using the same higher level resource, if the Request Object type is not the same, then the authentication-request-format` attribute can be set accordingly for the individual lower level resources. 


authentication-request-format is missing the beginning `

fjuma · 2023-09-01T18:23:43Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** For multiple `secure-server` or `secure-deployment` resources using the same higher level resource, if the Request Object type is not the same, then the authentication-request-format` attribute can be set accordingly for the individual lower level resources. 
+
+* According to the https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests[OIDC specs], only one of the two parameters can be specified at a time. If `request` is added, then `request_uri` MUST NOT be used in the same request. However, the user can choose to specify neither by setting `authentication-request-format` to `none`. 


s/none/oauth2

Fixed!
Thank you for the comments!
I have added more information about the key configurations and how request_uri value is obtained.

fjuma · 2023-09-01T18:56:45Z

elytron/WFLY-17143-request-uri-parameters.adoc

+    /subsystem=elytron-oidc-client/secure-deployment:add(client_id=myclient, provider-url="http://localhost:8090/", authentication-request-format="request_uri")
+``` 
+
+* For signed and encrypted request objects, we must need to use a private key, whose corresponding public key and certificate must be communicated with the OpenID provider. The public key is communicated to the OpenID provider using the admin console of the OpenID provider (i.e. Keycloak). And the same keypair is added to the deployment settings using existing attributes `client-keystore`, `client-keystore-password`, `client-key-password`, which are available under the `secure-deployment`, `secure-server`, `realm` and provider resources. Additionally, `client-key-alias` and `client-keystore-type` attributes will be added to these resources for additional information about the keystore.


Just to confirm, I think client-key-alias and client-keystore-type are part of the JSON configuration already, right? So here, they just need to be added to the subsystem configuration, right?

Thank you for the comments. I will address these changes.

Looking at the schema for wildfly, it seems that elytron-oidc-client.secure-deployment.credential.client-keystore-type and etc. already exists. This is used to specify the client credentials, such as the client secret using a keystore. But we need to use it for the secure-deployment, secure-server, realm and provider. So, we will be adding it one level higher as well.

Skyllarr · 2023-09-26T13:31:43Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+* According to the OpenID docs, if the same parameter exists both in the Request Object and the OAuth Authorization Request parameters, the parameter in the Request Object is used.
+
+* The feature must deal with cases where the OpenId Provider does not support request parameters by recognizing `request_not_supported` error and dealing with it accordingly.


@PrarthonaPaul

by recognizing request_not_supported error and dealing with it accordingly.

what will be the approach for this situation? Will some error be thrown that says that request parameters are not supported and only oauth2 format is supported?

For now I have coded it so that if either request or request_uri is not supported, then we send it as usual.
But this may not be as secure. So, in that case, if it makes more sense to, I can change it to throw a runtime error saying that request/request_uri is not supported by the OpenID provider
Which one do you think would be more appropriate?

@PrarthonaPaul I think we should log this and then document that the request and the request_uri methods are used only if available with the OpenID provider, if not available then the warning message will be logged.

That is an excellent idea! I will add that to the code.
Thank you!

Skyllarr · 2023-09-26T13:32:43Z

elytron/WFLY-17143-request-uri-parameters.adoc

+* The Request Object MAY be signed or unsigned (plaintext) and can be specified by value or by reference. The user can specify the algorithm used to sign the JWT request using the `request-object-signing-algorithm` attribute which will also be added to the resources specified above. This algorithm must be one of the Request object signature algorithms supported by the 
+OpenID provider. 
+
+** The values for `request-object-signing-algorithm` attribute are of type `String`. Default value for this attribute would be `none`, specifying that the request would be sent as a plaintext.In order to sign the jwt using an algorithm other than `none`, the user must specify the KeyPair used. This can be done using the `client-keystore-file`, `client-keystore-password`, `client-key-password`, `client-key-alias` and `client-keystore-type` attributes. The algorithm for the KeyPair must match the algorithm used to sign the JWT. The keystore should be on type `JKS` and can be generated using `keytool` on the linux terminal. 


@PrarthonaPaul Just a minor, s/JKS/PKCS12

Oh, yes. I will change it. Should we allow both JKS and PKCS since keycloak allows both?
I tested both manually and they both work. (PKCS12 is a bit picky when it comes to EC algorithm)

fjuma · 2023-10-30T15:24:34Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+This RFE will add an attribute to the `elytron-oidc-client` subsystem called `authentication-request-format`, which can allow the user to specify if they will use either of the request parameters. Additionally, we will be adding supporting attributes called `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm`, which will be used to specify if and how the request parameters will be signed and/or encrypted. All of these attributes will be added to the `secure-server`, `secure-deployment`, `provider` and `realm` resources, which the user can configure using either the `elytron-oidc-client` subsystem, or using a json file in deployment configuration.
+
+We will also be adding some keystore attributes, such as, `client-keystore-file`, `client-keystore-password`, `client-key-password`, `client-key-alias` and `client-keystore-type` to the resources mentioned above. These attributes are currently available under the `credential` attribute. However, when they are configured outside of the `credentials` attribute, they will be used to sign Request Objects.


"to the resources mentioned above"

Just looking at the current schema and it's currently possible to configure client-keystore-password, client-keystore, etc. for realm, provider, secure-deployment, and secure-server resources to specify the client keystore configuration to be used for HTTPS connections. Will the attributes being added conflict with these?

It could conflict if both OIDC and HTTPS are configured at the same time.
Would there be a case where the user would want to configure OIDC with HTTPS?
If so, then I can use two new attributes called oidc-client-keystore and oidc-client-keystore-password.

Yes, it's possible that a user would want their request to be signed and also want to use HTTPS for communication with the OpenID provider. I think it would be good to use attribute names that explain what the attribute is for (e.g., something like request-object-signing-keystore-file perhaps).

Sounds good.
I will add those two attributes and edit the proposal.
Thanks

Thanks. Note that this applies to all the signing keystore related attributes mentioned above, i.e.,

client-keystore-file, client-keystore-password, client-key-password, client-key-alias and client-keystore-type

These attribute have been renamed to request-object-signing-keystore-file, request-object-signing-keystore-password, request-object-signing-key-password, request-object-signing-key-alias and request-object-signing-keystore-type

fjuma · 2023-10-30T15:49:05Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** The values for the `request-object-encryption-algorithm` and the `request-object-content-encryption-algorithm` attributes are of type `String`. The default value for the attributes are undefined, which specifies that the request object will not be encrypted. 
+
+** The request object will only be encrypted if both `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` are specified. The values for these attributes must be part of the encryption algorithms and content encryption methods supported by the OpenID provider. These values can also be found by sending a GET request to the discovery url or by looking at the client configurations on the admin console of the OpenID provider. 


Would be good to mention the names of the attributes in the result of the GET request to the discovery url that contain the allowed values.

I think the output of this would be a bit long.

Do you think it would be better to point to https://github.com/wildfly-security/wildfly-elytron/blob/2.x/http/oidc/src/main/java/org/wildfly/security/http/oidc/OidcClientConfiguration.java#L212-L238 and https://github.com/wildfly-security/wildfly-elytron/blob/2.x/http/oidc/src/main/java/org/wildfly/security/http/oidc/OidcProviderMetadata.java for more information?
Alternatively, we could give some examples of what metadata is obtained through this GET request and link either the elytron source code links I added above or this keycloak doc

I think we could just mention the specific ones that contain the info we're interested in (I think you had these in a previous version of the proposal), e.g., request_object_signing_alg_values_supported, etc.

Sounds good!
I have made this change to include the attributes relevant to Request Objects.

fjuma · 2023-10-30T16:07:00Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** The request object will only be encrypted if both `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` are specified. The values for these attributes must be part of the encryption algorithms and content encryption methods supported by the OpenID provider. These values can also be found by sending a GET request to the discovery url or by looking at the client configurations on the admin console of the OpenID provider. 
+
+** The JWT must be signed first and then encrypted to make a nested JWT and the key used to encrypt the JWT must be the realm public key shared by the OpenID provided. The key algorithm must be the same as the encrypting algorithm. Signing and encrypting algorithms can be of different types (i. e. ES-256 for signing and RSA-OAEP for encrypting is allowed). The realm key for encrypting the JWT can be obtained by sending a GET request to the `jwksUri` obtained from the `discoveryUrl`(http://localhost:8080/realms/myrealm/.well-known/openid-configuration). 


s/OpenID provided/OpenID provider

Would be good to add some links to Keycloak issues/PRs/docs where the request object encryption is described, e.g.,

https://issues.redhat.com/browse/KEYCLOAK-18630
keycloak/keycloak#8243
keycloak/keycloak#8261

Do you have some sample output that shows the result of sending a GET request to the jwksUri endpoint?

I have added the links and a sample output with some of the longer values truncated for readability.

elytron/WFLY-17143-request-uri-parameters.adoc

fjuma · 2024-03-20T21:38:20Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+** The certificate for the KeyPair used to sign the JWT must be shared with the OpenID provider either by importing it from the keystore, or by uploading a jwksUrl. 
+
+** In order to be able to upload client keys on the admin console of the OpenID Provider, the `Client Authentication` toggle must be turned on. As a result, when configuring the client in deployment or subsystem settings, the `public-client` attribute must be set to `false` and client credentials must be specified as well using the `credentials` attribute. 


This is specifically about the Keycloak provider right? (since this mentions the Client Authentication toggle).

darranl · 2024-03-21T19:00:15Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+This RFE will add an attribute to the `elytron-oidc-client` subsystem called `authentication-request-format`, which can allow the user to specify if they will use either of the request parameters. Additionally, we will be adding supporting attributes called `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm`, which will be used to specify if and how the request parameters will be signed and/or encrypted. All of these attributes will be added to the `secure-server`, `secure-deployment`, `provider` and `realm` resources, which the user can configure using either the `elytron-oidc-client` subsystem, or using a json file in deployment configuration.
+
+We will also be adding some keystore attributes, such as, `request-object-signing-keystore-file`, `request-object-signing-keystore-password`, `request-object-signing-key-password`, `request-object-signing-key-alias` and `request-object-signing-keystore-type` to the resources mentioned above. There are similar attributes that are currently available under the `credential` attribute. However, when they are configured outside of the `credentials` attribute, they will be used to sign Request Objects.


@fjuma I see this is re-using a pattern already in use in this subsystem but is there any reason we are not making use of the key-store capability so we can rely on the Elytron subsystem handling all of the different types of KeyStore?

Or possibly something using a credential reference / credential source type pattern?

Maybe this could be some kind of follow up consideration?

Right, this is re-using a pattern that was already present elsewhere in the subsystem.

We could switch to making use of the key-store capability instead to simplify things.

We had previously talked about introducing that elsewhere in the subsystem too.

@fjuma Should we move that to a Jira as a follow up consideration so it does not block this one?

Created https://issues.redhat.com/browse/WFLY-19157.

darranl · 2024-03-21T19:17:00Z

elytron/WFLY-17143-request-uri-parameters.adoc

+
+=== Related Issues
+
+* https://issues.redhat.com/browse/EAP7-1974[EAP7-1974]


I think we can remove the EAP7 reference as we are going for community stability level.

darranl

I think we can remove the EAP7 reference and I think we should have a follow up to consider the key-store reference but adding my approval.

…hentication Request should include request and request_uri parameters

PrarthonaPaul force-pushed the WFLY-17143 branch from 1b7f98a to c4629b0 Compare August 8, 2023 17:44

fjuma requested changes Aug 8, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch 2 times, most recently from 876b195 to 14b9503 Compare August 10, 2023 19:33

OndrejKotek reviewed Aug 11, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch from 14b9503 to efee31f Compare August 11, 2023 15:28

OndrejKotek reviewed Aug 14, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch 2 times, most recently from c082d6b to 43c47d1 Compare August 21, 2023 14:03

fjuma reviewed Aug 28, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch from 43c47d1 to 9491f5b Compare August 29, 2023 13:32

fjuma reviewed Sep 1, 2023

View reviewed changes

PrarthonaPaul mentioned this pull request Sep 12, 2023

[ELY-2584] Add the ability to specify that the OIDC Authentication Request should include request and request_uri parameters wildfly-security/wildfly-elytron#1953

Closed

PrarthonaPaul force-pushed the WFLY-17143 branch from 9491f5b to d4d2f91 Compare September 13, 2023 15:42

PrarthonaPaul mentioned this pull request Sep 25, 2023

[WFLY-17143] Add the ability to specify that the OIDC Authentication Request should include request and request_uri parameters wildfly/wildfly#17213

Closed

Skyllarr reviewed Sep 26, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch from d4d2f91 to a8de81d Compare October 3, 2023 20:03

fjuma reviewed Oct 30, 2023

View reviewed changes

PrarthonaPaul force-pushed the WFLY-17143 branch 2 times, most recently from cc17b5c to 8201c5c Compare October 31, 2023 14:05

PrarthonaPaul force-pushed the WFLY-17143 branch from 8201c5c to 536579b Compare February 28, 2024 16:10

PrarthonaPaul force-pushed the WFLY-17143 branch from 536579b to 0717791 Compare February 28, 2024 16:17

fjuma reviewed Mar 20, 2024

View reviewed changes

fjuma approved these changes Mar 20, 2024

View reviewed changes

darranl reviewed Mar 21, 2024

View reviewed changes

darranl approved these changes Mar 21, 2024

View reviewed changes

[WFLY-17143] Community - Add the ability to specify that the OIDC Aut…

29d2cac

…hentication Request should include request and request_uri parameters

PrarthonaPaul force-pushed the WFLY-17143 branch from 0717791 to 29d2cac Compare March 21, 2024 20:15

Changed to preview

b1d74f5


		== Overview

		OpenID Connect is an authentication mechanism that builds on OAuth 2.0 and allows a user to login to a web application using credentials established by an OpenID provider. Authentication requests sent using OpenID Connect can be signed and optionally encrypted. This can be achieved using 2 auth request parameters: `request` and `request_uri`, which are both optional.


		=== Hard Requirements

		* Two new attributes named `request` and `request-uri` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem, which will be used to specify either the `request` or the `request_uri`, which are both JWTs.


		* Two new attributes named `request` and `request-uri` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem, which will be used to specify either the `request` or the `request_uri`, which are both JWTs.

		* According to the https://issues.redhat.com/browse/EAP7-1974[OIDC specs], only one of the two parameters can be specified at a time. If `request` is added, then `request_uri` MUST NOT be used in the same request. However, the user can choose to specify neither.


		* The feature must deal with cases where the OpenId Provider does not support request parameters by recognizing `request_not_supported` error and dealing with it accordingly.

		* It should be possible to specify that these parameters should be included in the Authentication Request via deployment configuration using the `oidc.json` file inside the `WEB-INF` directory of the web application and `elytron-oidc-client` subsystem configuration.


		=== Hard Requirements

		* A new attribute named `request-object-required` will be added to the `secure-deployment` resource under the `elytron-oidc-client` subsystem. The value for this attribute will be a String with 3 acceptable values:


		* The `request-object-required` attribute will specify if either `request` or the `request_uri` would be added to the auth request. This will be an optional attribute. The default value for this attribute will be set to `none`, indicating that neither request parameters are used and the query parameters are sent through the url.

		** For multiple `secure-server` or `secure-deployment`s using the same `realm` or `provider`, the `request-object-required` can be specified at the higher level resource.


		=== Hard Requirements

		* A new attributes named `request-object-required`, `request-signing-algorithm`, `request-encrypt-algorithm` and `request-encrypt-enc` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `request-object-required` attribute will be a String with 3 acceptable values:


		** The values for `request-signing-algorithm` attribute are of type `String`. Default value for this attribute would be `none`, specifying that the request would be sent as a plaintext. The default value of `request-signing-algorithm` is `none`. The signing algorithm specified must be one of the signing algorithms accepted by the OpenID provider.

		* The request object may also be encrypted. To specify that the request parameter will be encrypted, the user needs to specify the relevant algorithms using `request-encrypt-algorithm` and `request-encrypt-enc`.


		* The Request Object MAY be signed or unsigned (plaintext) and can be specified by value or by reference. The user can specify the algorithm used to sign the JWT request using the `request-signing-algorithm` attribute which will also be added to the resources specified above.

		** The values for `request-signing-algorithm` attribute are of type `String`. Default value for this attribute would be `none`, specifying that the request would be sent as a plaintext. The default value of `request-signing-algorithm` is `none`. The signing algorithm specified must be one of the signing algorithms accepted by the OpenID provider.


		=== Hard Requirements

		* A new attributes named `authentication-request-format`, `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` will be added to the `secure-deployment`, `secure-server`, `realm` and `provider` resources under the `elytron-oidc-client` subsystem. The value for the `authentication-request-format` attribute will be a String with 3 acceptable values:


		** For multiple `secure-server` or `secure-deployment` resources using the same higher level resource, if the Request Object type is not the same, then the authentication-request-format` attribute can be set accordingly for the individual lower level resources.

		* According to the https://openid.net/specs/openid-connect-core-1_0.html#JWTRequests[OIDC specs], only one of the two parameters can be specified at a time. If `request` is added, then `request_uri` MUST NOT be used in the same request. However, the user can choose to specify neither by setting `authentication-request-format` to `none`.


		* According to the OpenID docs, if the same parameter exists both in the Request Object and the OAuth Authorization Request parameters, the parameter in the Request Object is used.

		* The feature must deal with cases where the OpenId Provider does not support request parameters by recognizing `request_not_supported` error and dealing with it accordingly.


		This RFE will add an attribute to the `elytron-oidc-client` subsystem called `authentication-request-format`, which can allow the user to specify if they will use either of the request parameters. Additionally, we will be adding supporting attributes called `request-object-signing-algorithm`, `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm`, which will be used to specify if and how the request parameters will be signed and/or encrypted. All of these attributes will be added to the `secure-server`, `secure-deployment`, `provider` and `realm` resources, which the user can configure using either the `elytron-oidc-client` subsystem, or using a json file in deployment configuration.

		We will also be adding some keystore attributes, such as, `client-keystore-file`, `client-keystore-password`, `client-key-password`, `client-key-alias` and `client-keystore-type` to the resources mentioned above. These attributes are currently available under the `credential` attribute. However, when they are configured outside of the `credentials` attribute, they will be used to sign Request Objects.


		** The values for the `request-object-encryption-algorithm` and the `request-object-content-encryption-algorithm` attributes are of type `String`. The default value for the attributes are undefined, which specifies that the request object will not be encrypted.

		** The request object will only be encrypted if both `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` are specified. The values for these attributes must be part of the encryption algorithms and content encryption methods supported by the OpenID provider. These values can also be found by sending a GET request to the discovery url or by looking at the client configurations on the admin console of the OpenID provider.


		** The request object will only be encrypted if both `request-object-encryption-algorithm` and `request-object-content-encryption-algorithm` are specified. The values for these attributes must be part of the encryption algorithms and content encryption methods supported by the OpenID provider. These values can also be found by sending a GET request to the discovery url or by looking at the client configurations on the admin console of the OpenID provider.

		** The JWT must be signed first and then encrypted to make a nested JWT and the key used to encrypt the JWT must be the realm public key shared by the OpenID provided. The key algorithm must be the same as the encrypting algorithm. Signing and encrypting algorithms can be of different types (i. e. ES-256 for signing and RSA-OAEP for encrypting is allowed). The realm key for encrypting the JWT can be obtained by sending a GET request to the `jwksUri` obtained from the `discoveryUrl`(http://localhost:8080/realms/myrealm/.well-known/openid-configuration).


		** The certificate for the KeyPair used to sign the JWT must be shared with the OpenID provider either by importing it from the keystore, or by uploading a jwksUrl.

		** In order to be able to upload client keys on the admin console of the OpenID Provider, the `Client Authentication` toggle must be turned on. As a result, when configuring the client in deployment or subsystem settings, the `public-client` attribute must be set to `false` and client credentials must be specified as well using the `credentials` attribute.


		=== Related Issues

		* https://issues.redhat.com/browse/EAP7-1974[EAP7-1974]

[WFLY-17143] Community - Add the ability to specify that the OIDC Authentication Request should include request and request_uri parameters #532

Are you sure you want to change the base?

[WFLY-17143] Community - Add the ability to specify that the OIDC Authentication Request should include request and request_uri parameters #532

Conversation

PrarthonaPaul commented Aug 8, 2023 • edited

fjuma left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PrarthonaPaul Sep 13, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Skyllarr Sep 26, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PrarthonaPaul commented Aug 8, 2023 •

edited

PrarthonaPaul Sep 13, 2023 •

edited

Skyllarr Sep 26, 2023 •

edited