mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 19:07:30 +00:00
feat: add PKCE option to generic OAuth2 / OIDC identity providers (#9373)
# Which Problems Are Solved Some OAuth2 and OIDC providers require the use of PKCE for all their clients. While ZITADEL already recommended the same for its clients, it did not yet support the option on the IdP configuration. # How the Problems Are Solved - A new boolean `use_pkce` is added to the add/update generic OAuth/OIDC endpoints. - A new checkbox is added to the generic OAuth and OIDC provider templates. - The `rp.WithPKCE` option is added to the provider if the use of PKCE has been set. - The `rp.WithCodeChallenge` and `rp.WithCodeVerifier` options are added to the OIDC/Auth BeginAuth and CodeExchange function. - Store verifier or any other persistent argument in the intent or auth request. - Create corresponding session object before creating the intent, to be able to store the information. - (refactored session structs to use a constructor for unified creation and better overview of actual usage) Here's a screenshot showing the URI including the PKCE params:  # Additional Changes None. # Additional Context - Closes #6449 - This PR replaces the existing PR (#8228) of @doncicuto. The base he did was cherry picked. Thank you very much for that! --------- Co-authored-by: Miguel Cabrerizo <doncicuto@gmail.com> Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com>
This commit is contained in:
@@ -18,6 +18,7 @@ type OAuthIDPAddedEvent struct {
|
||||
UserEndpoint string `json:"userEndpoint,omitempty"`
|
||||
Scopes []string `json:"scopes,omitempty"`
|
||||
IDAttribute string `json:"idAttribute,omitempty"`
|
||||
UsePKCE bool `json:"usePKCE,omitempty"`
|
||||
Options
|
||||
}
|
||||
|
||||
@@ -32,6 +33,7 @@ func NewOAuthIDPAddedEvent(
|
||||
userEndpoint,
|
||||
idAttribute string,
|
||||
scopes []string,
|
||||
usePKCE bool,
|
||||
options Options,
|
||||
) *OAuthIDPAddedEvent {
|
||||
return &OAuthIDPAddedEvent{
|
||||
@@ -45,6 +47,7 @@ func NewOAuthIDPAddedEvent(
|
||||
UserEndpoint: userEndpoint,
|
||||
Scopes: scopes,
|
||||
IDAttribute: idAttribute,
|
||||
UsePKCE: usePKCE,
|
||||
Options: options,
|
||||
}
|
||||
}
|
||||
@@ -82,6 +85,7 @@ type OAuthIDPChangedEvent struct {
|
||||
UserEndpoint *string `json:"userEndpoint,omitempty"`
|
||||
Scopes []string `json:"scopes,omitempty"`
|
||||
IDAttribute *string `json:"idAttribute,omitempty"`
|
||||
UsePKCE *bool `json:"usePKCE,omitempty"`
|
||||
OptionChanges
|
||||
}
|
||||
|
||||
@@ -158,6 +162,12 @@ func ChangeOAuthIDAttribute(idAttribute string) func(*OAuthIDPChangedEvent) {
|
||||
}
|
||||
}
|
||||
|
||||
func ChangeOAuthUsePKCE(usePKCE bool) func(*OAuthIDPChangedEvent) {
|
||||
return func(e *OAuthIDPChangedEvent) {
|
||||
e.UsePKCE = &usePKCE
|
||||
}
|
||||
}
|
||||
|
||||
func (e *OAuthIDPChangedEvent) Payload() interface{} {
|
||||
return e
|
||||
}
|
||||
|
@@ -16,6 +16,7 @@ type OIDCIDPAddedEvent struct {
|
||||
ClientSecret *crypto.CryptoValue `json:"clientSecret"`
|
||||
Scopes []string `json:"scopes,omitempty"`
|
||||
IsIDTokenMapping bool `json:"idTokenMapping,omitempty"`
|
||||
UsePKCE bool `json:"usePKCE,omitempty"`
|
||||
Options
|
||||
}
|
||||
|
||||
@@ -27,7 +28,7 @@ func NewOIDCIDPAddedEvent(
|
||||
clientID string,
|
||||
clientSecret *crypto.CryptoValue,
|
||||
scopes []string,
|
||||
isIDTokenMapping bool,
|
||||
isIDTokenMapping, usePKCE bool,
|
||||
options Options,
|
||||
) *OIDCIDPAddedEvent {
|
||||
return &OIDCIDPAddedEvent{
|
||||
@@ -39,6 +40,7 @@ func NewOIDCIDPAddedEvent(
|
||||
ClientSecret: clientSecret,
|
||||
Scopes: scopes,
|
||||
IsIDTokenMapping: isIDTokenMapping,
|
||||
UsePKCE: usePKCE,
|
||||
Options: options,
|
||||
}
|
||||
}
|
||||
@@ -74,6 +76,7 @@ type OIDCIDPChangedEvent struct {
|
||||
ClientSecret *crypto.CryptoValue `json:"clientSecret,omitempty"`
|
||||
Scopes []string `json:"scopes,omitempty"`
|
||||
IsIDTokenMapping *bool `json:"idTokenMapping,omitempty"`
|
||||
UsePKCE *bool `json:"usePKCE,omitempty"`
|
||||
OptionChanges
|
||||
}
|
||||
|
||||
@@ -139,6 +142,12 @@ func ChangeOIDCIsIDTokenMapping(idTokenMapping bool) func(*OIDCIDPChangedEvent)
|
||||
}
|
||||
}
|
||||
|
||||
func ChangeOIDCUsePKCE(usePKCE bool) func(*OIDCIDPChangedEvent) {
|
||||
return func(e *OIDCIDPChangedEvent) {
|
||||
e.UsePKCE = &usePKCE
|
||||
}
|
||||
}
|
||||
|
||||
func (e *OIDCIDPChangedEvent) Payload() interface{} {
|
||||
return e
|
||||
}
|
||||
|
Reference in New Issue
Block a user