2024-08-14 20:18:29 +02:00
|
|
|
package idp
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
"connectrpc.com/connect"
|
2024-08-14 20:18:29 +02:00
|
|
|
"github.com/crewjam/saml"
|
|
|
|
"github.com/muhlemmer/gu"
|
|
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
|
|
|
|
|
|
"github.com/zitadel/zitadel/internal/api/grpc/object/v2"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
|
|
"github.com/zitadel/zitadel/internal/idp/providers/azuread"
|
|
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
|
|
idp_rp "github.com/zitadel/zitadel/internal/repository/idp"
|
|
|
|
idp_pb "github.com/zitadel/zitadel/pkg/grpc/idp/v2"
|
|
|
|
)
|
|
|
|
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
func (s *Server) GetIDPByID(ctx context.Context, req *connect.Request[idp_pb.GetIDPByIDRequest]) (*connect.Response[idp_pb.GetIDPByIDResponse], error) {
|
|
|
|
idp, err := s.query.IDPTemplateByID(ctx, true, req.Msg.GetId(), false, s.checkPermission)
|
2024-08-14 20:18:29 +02:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
return connect.NewResponse(&idp_pb.GetIDPByIDResponse{Idp: idpToPb(idp)}), nil
|
2024-08-14 20:18:29 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
func idpToPb(idp *query.IDPTemplate) *idp_pb.IDP {
|
|
|
|
return &idp_pb.IDP{
|
|
|
|
Id: idp.ID,
|
|
|
|
Details: object.DomainToDetailsPb(
|
|
|
|
&domain.ObjectDetails{
|
|
|
|
Sequence: idp.Sequence,
|
|
|
|
EventDate: idp.ChangeDate,
|
|
|
|
ResourceOwner: idp.ResourceOwner,
|
2025-02-26 14:00:04 +01:00
|
|
|
CreationDate: idp.CreationDate,
|
2024-08-14 20:18:29 +02:00
|
|
|
}),
|
|
|
|
State: idpStateToPb(idp.State),
|
|
|
|
Name: idp.Name,
|
|
|
|
Type: idpTypeToPb(idp.Type),
|
|
|
|
Config: configToPb(idp),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func idpStateToPb(state domain.IDPState) idp_pb.IDPState {
|
|
|
|
switch state {
|
|
|
|
case domain.IDPStateActive:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_ACTIVE
|
|
|
|
case domain.IDPStateInactive:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_INACTIVE
|
|
|
|
case domain.IDPStateUnspecified:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_UNSPECIFIED
|
|
|
|
case domain.IDPStateMigrated:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_MIGRATED
|
|
|
|
case domain.IDPStateRemoved:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_REMOVED
|
|
|
|
default:
|
|
|
|
return idp_pb.IDPState_IDP_STATE_UNSPECIFIED
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func idpTypeToPb(idpType domain.IDPType) idp_pb.IDPType {
|
|
|
|
switch idpType {
|
|
|
|
case domain.IDPTypeOIDC:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_OIDC
|
|
|
|
case domain.IDPTypeJWT:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_JWT
|
|
|
|
case domain.IDPTypeOAuth:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_OAUTH
|
|
|
|
case domain.IDPTypeLDAP:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_LDAP
|
|
|
|
case domain.IDPTypeAzureAD:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_AZURE_AD
|
|
|
|
case domain.IDPTypeGitHub:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_GITHUB
|
|
|
|
case domain.IDPTypeGitHubEnterprise:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_GITHUB_ES
|
|
|
|
case domain.IDPTypeGitLab:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_GITLAB
|
|
|
|
case domain.IDPTypeGitLabSelfHosted:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_GITLAB_SELF_HOSTED
|
|
|
|
case domain.IDPTypeGoogle:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_GOOGLE
|
|
|
|
case domain.IDPTypeApple:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_APPLE
|
|
|
|
case domain.IDPTypeSAML:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_SAML
|
|
|
|
case domain.IDPTypeUnspecified:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_UNSPECIFIED
|
|
|
|
default:
|
|
|
|
return idp_pb.IDPType_IDP_TYPE_UNSPECIFIED
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func configToPb(config *query.IDPTemplate) *idp_pb.IDPConfig {
|
|
|
|
idpConfig := &idp_pb.IDPConfig{
|
|
|
|
Options: &idp_pb.Options{
|
|
|
|
IsLinkingAllowed: config.IsLinkingAllowed,
|
|
|
|
IsCreationAllowed: config.IsCreationAllowed,
|
|
|
|
IsAutoCreation: config.IsAutoCreation,
|
|
|
|
IsAutoUpdate: config.IsAutoUpdate,
|
2024-12-18 17:19:05 +01:00
|
|
|
AutoLinking: AutoLinkingOptionToPb(config.AutoLinking),
|
2024-08-14 20:18:29 +02:00
|
|
|
},
|
|
|
|
}
|
|
|
|
if config.OAuthIDPTemplate != nil {
|
|
|
|
oauthConfigToPb(idpConfig, config.OAuthIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.OIDCIDPTemplate != nil {
|
|
|
|
oidcConfigToPb(idpConfig, config.OIDCIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.JWTIDPTemplate != nil {
|
|
|
|
jwtConfigToPb(idpConfig, config.JWTIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.AzureADIDPTemplate != nil {
|
|
|
|
azureConfigToPb(idpConfig, config.AzureADIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.GitHubIDPTemplate != nil {
|
|
|
|
githubConfigToPb(idpConfig, config.GitHubIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.GitHubEnterpriseIDPTemplate != nil {
|
|
|
|
githubEnterpriseConfigToPb(idpConfig, config.GitHubEnterpriseIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.GitLabIDPTemplate != nil {
|
|
|
|
gitlabConfigToPb(idpConfig, config.GitLabIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.GitLabSelfHostedIDPTemplate != nil {
|
|
|
|
gitlabSelfHostedConfigToPb(idpConfig, config.GitLabSelfHostedIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.GoogleIDPTemplate != nil {
|
|
|
|
googleConfigToPb(idpConfig, config.GoogleIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.LDAPIDPTemplate != nil {
|
|
|
|
ldapConfigToPb(idpConfig, config.LDAPIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.AppleIDPTemplate != nil {
|
|
|
|
appleConfigToPb(idpConfig, config.AppleIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
if config.SAMLIDPTemplate != nil {
|
|
|
|
samlConfigToPb(idpConfig, config.SAMLIDPTemplate)
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
return idpConfig
|
|
|
|
}
|
|
|
|
|
2024-12-18 17:19:05 +01:00
|
|
|
func AutoLinkingOptionToPb(linking domain.AutoLinkingOption) idp_pb.AutoLinkingOption {
|
2024-08-14 20:18:29 +02:00
|
|
|
switch linking {
|
|
|
|
case domain.AutoLinkingOptionUnspecified:
|
|
|
|
return idp_pb.AutoLinkingOption_AUTO_LINKING_OPTION_UNSPECIFIED
|
|
|
|
case domain.AutoLinkingOptionUsername:
|
|
|
|
return idp_pb.AutoLinkingOption_AUTO_LINKING_OPTION_USERNAME
|
|
|
|
case domain.AutoLinkingOptionEmail:
|
|
|
|
return idp_pb.AutoLinkingOption_AUTO_LINKING_OPTION_EMAIL
|
|
|
|
default:
|
|
|
|
return idp_pb.AutoLinkingOption_AUTO_LINKING_OPTION_UNSPECIFIED
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func oauthConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.OAuthIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Oauth{
|
|
|
|
Oauth: &idp_pb.OAuthConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
AuthorizationEndpoint: template.AuthorizationEndpoint,
|
|
|
|
TokenEndpoint: template.TokenEndpoint,
|
|
|
|
UserEndpoint: template.UserEndpoint,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
IdAttribute: template.IDAttribute,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func oidcConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.OIDCIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Oidc{
|
|
|
|
Oidc: &idp_pb.GenericOIDCConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Issuer: template.Issuer,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
IsIdTokenMapping: template.IsIDTokenMapping,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func jwtConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.JWTIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Jwt{
|
|
|
|
Jwt: &idp_pb.JWTConfig{
|
|
|
|
JwtEndpoint: template.Endpoint,
|
|
|
|
Issuer: template.Issuer,
|
|
|
|
KeysEndpoint: template.KeysEndpoint,
|
|
|
|
HeaderName: template.HeaderName,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func azureConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.AzureADIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_AzureAd{
|
|
|
|
AzureAd: &idp_pb.AzureADConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Tenant: azureTenantToPb(template.Tenant),
|
|
|
|
EmailVerified: template.IsEmailVerified,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func azureTenantToPb(tenant string) *idp_pb.AzureADTenant {
|
|
|
|
var tenantType idp_pb.IsAzureADTenantType
|
|
|
|
switch azuread.TenantType(tenant) {
|
|
|
|
case azuread.CommonTenant:
|
|
|
|
tenantType = &idp_pb.AzureADTenant_TenantType{TenantType: idp_pb.AzureADTenantType_AZURE_AD_TENANT_TYPE_COMMON}
|
|
|
|
case azuread.OrganizationsTenant:
|
|
|
|
tenantType = &idp_pb.AzureADTenant_TenantType{TenantType: idp_pb.AzureADTenantType_AZURE_AD_TENANT_TYPE_ORGANISATIONS}
|
|
|
|
case azuread.ConsumersTenant:
|
|
|
|
tenantType = &idp_pb.AzureADTenant_TenantType{TenantType: idp_pb.AzureADTenantType_AZURE_AD_TENANT_TYPE_CONSUMERS}
|
|
|
|
default:
|
|
|
|
tenantType = &idp_pb.AzureADTenant_TenantId{TenantId: tenant}
|
|
|
|
}
|
|
|
|
return &idp_pb.AzureADTenant{Type: tenantType}
|
|
|
|
}
|
|
|
|
|
|
|
|
func githubConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.GitHubIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Github{
|
|
|
|
Github: &idp_pb.GitHubConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func githubEnterpriseConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.GitHubEnterpriseIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_GithubEs{
|
|
|
|
GithubEs: &idp_pb.GitHubEnterpriseServerConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
AuthorizationEndpoint: template.AuthorizationEndpoint,
|
|
|
|
TokenEndpoint: template.TokenEndpoint,
|
|
|
|
UserEndpoint: template.UserEndpoint,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func gitlabConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.GitLabIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Gitlab{
|
|
|
|
Gitlab: &idp_pb.GitLabConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func gitlabSelfHostedConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.GitLabSelfHostedIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_GitlabSelfHosted{
|
|
|
|
GitlabSelfHosted: &idp_pb.GitLabSelfHostedConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Issuer: template.Issuer,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func googleConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.GoogleIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Google{
|
|
|
|
Google: &idp_pb.GoogleConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func ldapConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.LDAPIDPTemplate) {
|
|
|
|
var timeout *durationpb.Duration
|
|
|
|
if template.Timeout != 0 {
|
|
|
|
timeout = durationpb.New(template.Timeout)
|
|
|
|
}
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Ldap{
|
|
|
|
Ldap: &idp_pb.LDAPConfig{
|
|
|
|
Servers: template.Servers,
|
|
|
|
StartTls: template.StartTLS,
|
|
|
|
BaseDn: template.BaseDN,
|
|
|
|
BindDn: template.BindDN,
|
|
|
|
UserBase: template.UserBase,
|
|
|
|
UserObjectClasses: template.UserObjectClasses,
|
|
|
|
UserFilters: template.UserFilters,
|
|
|
|
Timeout: timeout,
|
2025-02-18 10:06:50 +00:00
|
|
|
RootCa: template.RootCA,
|
2024-08-14 20:18:29 +02:00
|
|
|
Attributes: ldapAttributesToPb(template.LDAPAttributes),
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func ldapAttributesToPb(attributes idp_rp.LDAPAttributes) *idp_pb.LDAPAttributes {
|
|
|
|
return &idp_pb.LDAPAttributes{
|
|
|
|
IdAttribute: attributes.IDAttribute,
|
|
|
|
FirstNameAttribute: attributes.FirstNameAttribute,
|
|
|
|
LastNameAttribute: attributes.LastNameAttribute,
|
|
|
|
DisplayNameAttribute: attributes.DisplayNameAttribute,
|
|
|
|
NickNameAttribute: attributes.NickNameAttribute,
|
|
|
|
PreferredUsernameAttribute: attributes.PreferredUsernameAttribute,
|
|
|
|
EmailAttribute: attributes.EmailAttribute,
|
|
|
|
EmailVerifiedAttribute: attributes.EmailVerifiedAttribute,
|
|
|
|
PhoneAttribute: attributes.PhoneAttribute,
|
|
|
|
PhoneVerifiedAttribute: attributes.PhoneVerifiedAttribute,
|
|
|
|
PreferredLanguageAttribute: attributes.PreferredLanguageAttribute,
|
|
|
|
AvatarUrlAttribute: attributes.AvatarURLAttribute,
|
|
|
|
ProfileAttribute: attributes.ProfileAttribute,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func appleConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.AppleIDPTemplate) {
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Apple{
|
|
|
|
Apple: &idp_pb.AppleConfig{
|
|
|
|
ClientId: template.ClientID,
|
|
|
|
TeamId: template.TeamID,
|
|
|
|
KeyId: template.KeyID,
|
|
|
|
Scopes: template.Scopes,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func samlConfigToPb(idpConfig *idp_pb.IDPConfig, template *query.SAMLIDPTemplate) {
|
|
|
|
nameIDFormat := idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_PERSISTENT
|
|
|
|
if template.NameIDFormat.Valid {
|
|
|
|
nameIDFormat = nameIDToPb(template.NameIDFormat.V)
|
|
|
|
}
|
|
|
|
idpConfig.Config = &idp_pb.IDPConfig_Saml{
|
|
|
|
Saml: &idp_pb.SAMLConfig{
|
|
|
|
MetadataXml: template.Metadata,
|
|
|
|
Binding: bindingToPb(template.Binding),
|
|
|
|
WithSignedRequest: template.WithSignedRequest,
|
|
|
|
NameIdFormat: nameIDFormat,
|
|
|
|
TransientMappingAttributeName: gu.Ptr(template.TransientMappingAttributeName),
|
feat: federated logout for SAML IdPs (#9931)
# Which Problems Are Solved
Currently if a user signs in using an IdP, once they sign out of
Zitadel, the corresponding IdP session is not terminated. This can be
the desired behavior. In some cases, e.g. when using a shared computer
it results in a potential security risk, since a follower user might be
able to sign in as the previous using the still open IdP session.
# How the Problems Are Solved
- Admins can enabled a federated logout option on SAML IdPs through the
Admin and Management APIs.
- During the termination of a login V1 session using OIDC end_session
endpoint, Zitadel will check if an IdP was used to authenticate that
session.
- In case there was a SAML IdP used with Federated Logout enabled, it
will intercept the logout process, store the information into the shared
cache and redirect to the federated logout endpoint in the V1 login.
- The V1 login federated logout endpoint checks every request on an
existing cache entry. On success it will create a SAML logout request
for the used IdP and either redirect or POST to the configured SLO
endpoint. The cache entry is updated with a `redirected` state.
- A SLO endpoint is added to the `/idp` handlers, which will handle the
SAML logout responses. At the moment it will check again for an existing
federated logout entry (with state `redirected`) in the cache. On
success, the user is redirected to the initially provided
`post_logout_redirect_uri` from the end_session request.
# Additional Changes
None
# Additional Context
- This PR merges the https://github.com/zitadel/zitadel/pull/9841 and
https://github.com/zitadel/zitadel/pull/9854 to main, additionally
updating the docs on Entra ID SAML.
- closes #9228
- backport to 3.x
---------
Co-authored-by: Silvan <27845747+adlerhurst@users.noreply.github.com>
Co-authored-by: Zach Hirschtritt <zachary.hirschtritt@klaviyo.com>
2025-05-23 13:52:25 +02:00
|
|
|
FederatedLogoutEnabled: gu.Ptr(template.FederatedLogoutEnabled),
|
2024-08-14 20:18:29 +02:00
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func bindingToPb(binding string) idp_pb.SAMLBinding {
|
|
|
|
switch binding {
|
|
|
|
case "":
|
|
|
|
return idp_pb.SAMLBinding_SAML_BINDING_UNSPECIFIED
|
|
|
|
case saml.HTTPPostBinding:
|
|
|
|
return idp_pb.SAMLBinding_SAML_BINDING_POST
|
|
|
|
case saml.HTTPRedirectBinding:
|
|
|
|
return idp_pb.SAMLBinding_SAML_BINDING_REDIRECT
|
|
|
|
case saml.HTTPArtifactBinding:
|
|
|
|
return idp_pb.SAMLBinding_SAML_BINDING_ARTIFACT
|
|
|
|
default:
|
|
|
|
return idp_pb.SAMLBinding_SAML_BINDING_UNSPECIFIED
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func nameIDToPb(format domain.SAMLNameIDFormat) idp_pb.SAMLNameIDFormat {
|
|
|
|
switch format {
|
|
|
|
case domain.SAMLNameIDFormatUnspecified:
|
|
|
|
return idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_UNSPECIFIED
|
|
|
|
case domain.SAMLNameIDFormatEmailAddress:
|
|
|
|
return idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_EMAIL_ADDRESS
|
|
|
|
case domain.SAMLNameIDFormatPersistent:
|
|
|
|
return idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_PERSISTENT
|
|
|
|
case domain.SAMLNameIDFormatTransient:
|
|
|
|
return idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_TRANSIENT
|
|
|
|
default:
|
|
|
|
return idp_pb.SAMLNameIDFormat_SAML_NAME_ID_FORMAT_UNSPECIFIED
|
|
|
|
}
|
|
|
|
}
|