mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
# Which Problems Are Solved Zitadel exposes the secrets generator configuration through its admin api. This allows instance admins to manage them on their own and they can create overwrite the system / runtime defaults (incl. expiration). This very much needed in multi-instance scenarios such as zitadel.cloud. Currently the invite code configuration was not manageable through the API, but only runtime config. # How the Problems Are Solved - added the `invite_code` type to the API allowing it to be set and retrieved. - added the type to console's management list - added the type to be stored on instance setup - change the `GetSecretGenerator` endpoint to fall back to the runtime config if no config is stored on the instance itself - ensure the `length` and at least one charset is enabled, return an error otherwise - expiry is not enforced, so 0 allows codes with no expiry (current state) # Additional Changes None # Additional Context - closes https://github.com/zitadel/zitadel/issues/10474
221 lines
8.2 KiB
Go
221 lines
8.2 KiB
Go
package admin
|
|
|
|
import (
|
|
"context"
|
|
|
|
"google.golang.org/protobuf/types/known/durationpb"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
"github.com/zitadel/zitadel/internal/api/grpc/object"
|
|
obj_grpc "github.com/zitadel/zitadel/internal/api/grpc/object"
|
|
"github.com/zitadel/zitadel/internal/command"
|
|
"github.com/zitadel/zitadel/internal/crypto"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
admin_pb "github.com/zitadel/zitadel/pkg/grpc/admin"
|
|
settings_pb "github.com/zitadel/zitadel/pkg/grpc/settings"
|
|
)
|
|
|
|
func listSecretGeneratorToModel(req *admin_pb.ListSecretGeneratorsRequest) (*query.SecretGeneratorSearchQueries, error) {
|
|
offset, limit, asc := object.ListQueryToModel(req.Query)
|
|
queries, err := SecretGeneratorQueriesToModel(req.Queries)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &query.SecretGeneratorSearchQueries{
|
|
SearchRequest: query.SearchRequest{
|
|
Offset: offset,
|
|
Limit: limit,
|
|
Asc: asc,
|
|
},
|
|
Queries: queries,
|
|
}, nil
|
|
}
|
|
|
|
func SecretGeneratorQueriesToModel(queries []*settings_pb.SecretGeneratorQuery) (_ []query.SearchQuery, err error) {
|
|
q := make([]query.SearchQuery, len(queries))
|
|
for i, query := range queries {
|
|
q[i], err = SecretGeneratorQueryToModel(query)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return q, nil
|
|
}
|
|
|
|
func SecretGeneratorQueryToModel(apiQuery *settings_pb.SecretGeneratorQuery) (query.SearchQuery, error) {
|
|
switch q := apiQuery.Query.(type) {
|
|
case *settings_pb.SecretGeneratorQuery_TypeQuery:
|
|
domainType := SecretGeneratorTypeToDomain(q.TypeQuery.GeneratorType)
|
|
return query.NewSecretGeneratorTypeSearchQuery(int32(domainType))
|
|
default:
|
|
return nil, zerrors.ThrowInvalidArgument(nil, "ORG-fm9es", "List.Query.Invalid")
|
|
}
|
|
}
|
|
|
|
func UpdateSecretGeneratorToConfig(req *admin_pb.UpdateSecretGeneratorRequest) *crypto.GeneratorConfig {
|
|
return &crypto.GeneratorConfig{
|
|
Length: uint(req.Length),
|
|
Expiry: req.Expiry.AsDuration(),
|
|
IncludeUpperLetters: req.IncludeUpperLetters,
|
|
IncludeLowerLetters: req.IncludeLowerLetters,
|
|
IncludeDigits: req.IncludeDigits,
|
|
IncludeSymbols: req.IncludeSymbols,
|
|
}
|
|
}
|
|
|
|
func SecretGeneratorsToPb(generators []*query.SecretGenerator) []*settings_pb.SecretGenerator {
|
|
list := make([]*settings_pb.SecretGenerator, len(generators))
|
|
for i, generator := range generators {
|
|
list[i] = SecretGeneratorToPb(generator)
|
|
}
|
|
return list
|
|
}
|
|
|
|
func SecretGeneratorToPb(generator *query.SecretGenerator) *settings_pb.SecretGenerator {
|
|
mapped := &settings_pb.SecretGenerator{
|
|
GeneratorType: SecretGeneratorTypeToPb(generator.GeneratorType),
|
|
Length: uint32(generator.Length),
|
|
Expiry: durationpb.New(generator.Expiry),
|
|
IncludeUpperLetters: generator.IncludeUpperLetters,
|
|
IncludeLowerLetters: generator.IncludeLowerLetters,
|
|
IncludeDigits: generator.IncludeDigits,
|
|
IncludeSymbols: generator.IncludeSymbols,
|
|
Details: obj_grpc.ToViewDetailsPb(generator.Sequence, generator.CreationDate, generator.ChangeDate, generator.AggregateID),
|
|
}
|
|
return mapped
|
|
}
|
|
|
|
func SecretGeneratorTypeToPb(generatorType domain.SecretGeneratorType) settings_pb.SecretGeneratorType {
|
|
switch generatorType {
|
|
case domain.SecretGeneratorTypeInitCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_INIT_CODE
|
|
case domain.SecretGeneratorTypeVerifyEmailCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE
|
|
case domain.SecretGeneratorTypeVerifyPhoneCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE
|
|
case domain.SecretGeneratorTypePasswordResetCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE
|
|
case domain.SecretGeneratorTypePasswordlessInitCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE
|
|
case domain.SecretGeneratorTypeAppSecret:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_APP_SECRET
|
|
case domain.SecretGeneratorTypeOTPSMS:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_OTP_SMS
|
|
case domain.SecretGeneratorTypeOTPEmail:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_OTP_EMAIL
|
|
case domain.SecretGeneratorTypeInviteCode:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_INVITE_CODE
|
|
default:
|
|
return settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_UNSPECIFIED
|
|
}
|
|
}
|
|
|
|
func SecretGeneratorTypeToDomain(generatorType settings_pb.SecretGeneratorType) domain.SecretGeneratorType {
|
|
switch generatorType {
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_INIT_CODE:
|
|
return domain.SecretGeneratorTypeInitCode
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_VERIFY_EMAIL_CODE:
|
|
return domain.SecretGeneratorTypeVerifyEmailCode
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_VERIFY_PHONE_CODE:
|
|
return domain.SecretGeneratorTypeVerifyPhoneCode
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_PASSWORD_RESET_CODE:
|
|
return domain.SecretGeneratorTypePasswordResetCode
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_PASSWORDLESS_INIT_CODE:
|
|
return domain.SecretGeneratorTypePasswordlessInitCode
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_APP_SECRET:
|
|
return domain.SecretGeneratorTypeAppSecret
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_OTP_SMS:
|
|
return domain.SecretGeneratorTypeOTPSMS
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_OTP_EMAIL:
|
|
return domain.SecretGeneratorTypeOTPEmail
|
|
case settings_pb.SecretGeneratorType_SECRET_GENERATOR_TYPE_INVITE_CODE:
|
|
return domain.SecretGeneratorTypeInviteCode
|
|
default:
|
|
return domain.SecretGeneratorTypeUnspecified
|
|
}
|
|
}
|
|
|
|
// Deprecated: use [addEmailProviderSMTPToConfig] instead
|
|
func addSMTPToConfig(ctx context.Context, req *admin_pb.AddSMTPConfigRequest) *command.AddSMTPConfig {
|
|
cmd := &command.AddSMTPConfig{
|
|
ResourceOwner: authz.GetInstance(ctx).InstanceID(),
|
|
Description: req.Description,
|
|
Tls: req.Tls,
|
|
From: req.SenderAddress,
|
|
FromName: req.SenderName,
|
|
ReplyToAddress: req.ReplyToAddress,
|
|
Host: req.Host,
|
|
User: req.User,
|
|
}
|
|
|
|
if req.User != "" || req.Password != "" {
|
|
cmd.PlainAuth = &command.PlainAuth{
|
|
Password: req.Password,
|
|
}
|
|
}
|
|
|
|
return cmd
|
|
}
|
|
|
|
// Deprecated: use [updateEmailProviderSMTPToConfig] instead
|
|
func updateSMTPToConfig(ctx context.Context, req *admin_pb.UpdateSMTPConfigRequest) *command.ChangeSMTPConfig {
|
|
cmd := &command.ChangeSMTPConfig{
|
|
ResourceOwner: authz.GetInstance(ctx).InstanceID(),
|
|
ID: req.Id,
|
|
Description: req.Description,
|
|
Tls: req.Tls,
|
|
From: req.SenderAddress,
|
|
FromName: req.SenderName,
|
|
ReplyToAddress: req.ReplyToAddress,
|
|
Host: req.Host,
|
|
User: req.User,
|
|
}
|
|
|
|
if req.User != "" || req.Password != "" {
|
|
cmd.PlainAuth = &command.PlainAuth{
|
|
Password: req.Password,
|
|
}
|
|
}
|
|
|
|
return cmd
|
|
}
|
|
|
|
// Deprecated: use [smtpToPb] instead.
|
|
func SMTPConfigToPb(smtp *query.SMTPConfig) *settings_pb.SMTPConfig {
|
|
if smtp.SMTPConfig == nil {
|
|
return nil
|
|
}
|
|
|
|
return &settings_pb.SMTPConfig{
|
|
Description: smtp.Description,
|
|
Tls: smtp.SMTPConfig.TLS,
|
|
SenderAddress: smtp.SMTPConfig.SenderAddress,
|
|
SenderName: smtp.SMTPConfig.SenderName,
|
|
ReplyToAddress: smtp.SMTPConfig.ReplyToAddress,
|
|
Host: smtp.SMTPConfig.Host,
|
|
Details: obj_grpc.ToViewDetailsPb(smtp.Sequence, smtp.CreationDate, smtp.ChangeDate, smtp.ResourceOwner),
|
|
Id: smtp.ID,
|
|
State: settings_pb.SMTPConfigState(smtp.State),
|
|
User: smtp.SMTPConfig.User,
|
|
}
|
|
}
|
|
|
|
func SecurityPolicyToPb(policy *query.SecurityPolicy) *settings_pb.SecurityPolicy {
|
|
return &settings_pb.SecurityPolicy{
|
|
Details: obj_grpc.ToViewDetailsPb(policy.Sequence, policy.CreationDate, policy.ChangeDate, policy.AggregateID),
|
|
EnableIframeEmbedding: policy.EnableIframeEmbedding,
|
|
AllowedOrigins: policy.AllowedOrigins,
|
|
EnableImpersonation: policy.EnableImpersonation,
|
|
}
|
|
}
|
|
|
|
func securityPolicyToCommand(req *admin_pb.SetSecurityPolicyRequest) *command.SecurityPolicy {
|
|
return &command.SecurityPolicy{
|
|
EnableIframeEmbedding: req.GetEnableIframeEmbedding(),
|
|
AllowedOrigins: req.GetAllowedOrigins(),
|
|
EnableImpersonation: req.GetEnableImpersonation(),
|
|
}
|
|
}
|