mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-20 06:24:25 +00:00
<!-- Please inform yourself about the contribution guidelines on submitting a PR here: https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.md#submit-a-pull-request-pr. Take note of how PR/commit titles should be written and replace the template texts in the sections below. Don't remove any of the sections. It is important that the commit history clearly shows what is changed and why. Important: By submitting a contribution you agree to the terms from our Licensing Policy as described here: https://github.com/zitadel/zitadel/blob/main/LICENSING.md#community-contributions. --> One-time recovery codes are a common multi-factor authentication (MFA) backup method, letting users access their account if they lose other MFA devices. Support for recovery codes can also reduce support burden for users locked out of their accounts and provide a more secure and reliable form of verification than security questions. # Which Problems Are Solved Zitadel currently lacks support for recovery codes. # How the Problems Are Solved This PR partially addresses recovery code support in Zitadel. Importantly, it adds recovery codes as a new 2FA `Factor` and an additional `Check` type for the Session API. ``` Example recovery code flow: 1. User generates N new recovery codes using `POST /v2/users/{user_id}/recovery_codes` 2. Zitadel hashes and stores these codes and returns the un-hashed codes in the response 3. User creates new session with an additional check: `recoveryCode` 4. Code is checked against hash and, if valid, cannot be used again 5. User attempts to adds N more codes using the same endpoint 6. If `remaining_codes + N <= RecoveryCodes->MaxCount` config value, then recovery codes are added in addition to original codes 7. User can remove all recovery codes using `DEL /v2/users/:userId/recovery_codes` ``` This PR adds: - [x] Session recovery_code check support on `POST+PATCH /v2/sessions` endpoints - [x] Adds `mfa_recovery_code_checked_at` column (default null) to `projections.sessions8` table - [x] Support for `SECOND_FACTOR_TYPE_RECOVERY_CODES` as available 2FA method on login policy - [x] Support for importing recovery codes in /import code Missing, will _not_ implement in this PR: - [ ] Admin console support for displaying Recovery Code settings for user(s) - [ ] Zitadel Typescript login support for recovery codes TODO: - [x] Additional unit and integration tests - [x] Error translations # Additional Changes None # Additional Context - Closes #6898 --------- Co-authored-by: Livio Spring <[email protected]>
150 lines
5.3 KiB
Go
150 lines
5.3 KiB
Go
package start
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/mitchellh/mapstructure"
|
|
"github.com/spf13/viper"
|
|
"github.com/zitadel/logging"
|
|
|
|
"github.com/zitadel/zitadel/cmd/encryption"
|
|
"github.com/zitadel/zitadel/cmd/hooks"
|
|
"github.com/zitadel/zitadel/internal/actions"
|
|
admin_es "github.com/zitadel/zitadel/internal/admin/repository/eventsourcing"
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
"github.com/zitadel/zitadel/internal/api/http/middleware"
|
|
"github.com/zitadel/zitadel/internal/api/oidc"
|
|
"github.com/zitadel/zitadel/internal/api/saml"
|
|
scim_config "github.com/zitadel/zitadel/internal/api/scim/config"
|
|
"github.com/zitadel/zitadel/internal/api/ui/console"
|
|
"github.com/zitadel/zitadel/internal/api/ui/login"
|
|
auth_es "github.com/zitadel/zitadel/internal/auth/repository/eventsourcing"
|
|
"github.com/zitadel/zitadel/internal/cache/connector"
|
|
"github.com/zitadel/zitadel/internal/command"
|
|
"github.com/zitadel/zitadel/internal/config/hook"
|
|
"github.com/zitadel/zitadel/internal/config/network"
|
|
"github.com/zitadel/zitadel/internal/config/systemdefaults"
|
|
"github.com/zitadel/zitadel/internal/database"
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/execution"
|
|
"github.com/zitadel/zitadel/internal/id"
|
|
"github.com/zitadel/zitadel/internal/logstore"
|
|
"github.com/zitadel/zitadel/internal/notification/handlers"
|
|
"github.com/zitadel/zitadel/internal/query/projection"
|
|
"github.com/zitadel/zitadel/internal/serviceping"
|
|
static_config "github.com/zitadel/zitadel/internal/static/config"
|
|
metrics "github.com/zitadel/zitadel/internal/telemetry/metrics/config"
|
|
profiler "github.com/zitadel/zitadel/internal/telemetry/profiler/config"
|
|
tracing "github.com/zitadel/zitadel/internal/telemetry/tracing/config"
|
|
)
|
|
|
|
type Config struct {
|
|
Log *logging.Config
|
|
Port uint16
|
|
ExternalPort uint16
|
|
ExternalDomain string
|
|
ExternalSecure bool
|
|
TLS network.TLS
|
|
InstanceHostHeaders []string
|
|
PublicHostHeaders []string
|
|
HTTP2HostHeader string
|
|
HTTP1HostHeader string
|
|
WebAuthNName string
|
|
Database database.Config
|
|
Caches *connector.CachesConfig
|
|
Tracing tracing.Config
|
|
Metrics metrics.Config
|
|
Profiler profiler.Config
|
|
Projections projection.Config
|
|
Notifications handlers.WorkerConfig
|
|
Executions execution.WorkerConfig
|
|
Auth auth_es.Config
|
|
Admin admin_es.Config
|
|
UserAgentCookie *middleware.UserAgentCookieConfig
|
|
OIDC oidc.Config
|
|
SAML saml.Config
|
|
SCIM scim_config.Config
|
|
Login login.Config
|
|
Console console.Config
|
|
AssetStorage static_config.AssetStorageConfig
|
|
InternalAuthZ authz.Config
|
|
SystemAuthZ authz.Config
|
|
SystemDefaults systemdefaults.SystemDefaults
|
|
EncryptionKeys *encryption.EncryptionKeyConfig
|
|
DefaultInstance command.InstanceSetup
|
|
AuditLogRetention time.Duration
|
|
SystemAPIUsers map[string]*authz.SystemAPIUser
|
|
CustomerPortal string
|
|
Machine *id.Config
|
|
Actions *actions.Config
|
|
Eventstore *eventstore.Config
|
|
LogStore *logstore.Configs
|
|
Quotas *QuotasConfig
|
|
Telemetry *handlers.TelemetryPusherConfig
|
|
ServicePing *serviceping.Config
|
|
}
|
|
|
|
type QuotasConfig struct {
|
|
Access struct {
|
|
logstore.EmitterConfig `mapstructure:",squash"`
|
|
middleware.AccessConfig `mapstructure:",squash"`
|
|
}
|
|
Execution *logstore.EmitterConfig
|
|
}
|
|
|
|
func MustNewConfig(v *viper.Viper) *Config {
|
|
config, err := readConfig(v)
|
|
logging.OnError(err).Fatal("unable to read config")
|
|
|
|
err = config.Log.SetLogger()
|
|
logging.OnError(err).Fatal("unable to set logger")
|
|
|
|
err = config.Tracing.NewTracer()
|
|
logging.OnError(err).Fatal("unable to set tracer")
|
|
|
|
err = config.Metrics.NewMeter()
|
|
logging.OnError(err).Fatal("unable to set meter")
|
|
|
|
err = config.Profiler.NewProfiler()
|
|
logging.OnError(err).Fatal("unable to set profiler")
|
|
|
|
id.Configure(config.Machine)
|
|
if config.Actions != nil {
|
|
actions.SetHTTPConfig(&config.Actions.HTTP)
|
|
}
|
|
|
|
err = config.SystemDefaults.Validate()
|
|
logging.OnError(err).Fatal("system defaults config invalid")
|
|
|
|
// Copy the global role permissions mappings to the instance until we allow instance-level configuration over the API.
|
|
config.DefaultInstance.RolePermissionMappings = config.InternalAuthZ.RolePermissionMappings
|
|
|
|
return config
|
|
}
|
|
|
|
func readConfig(v *viper.Viper) (*Config, error) {
|
|
config := new(Config)
|
|
|
|
err := v.Unmarshal(config,
|
|
viper.DecodeHook(mapstructure.ComposeDecodeHookFunc(
|
|
hooks.SliceTypeStringDecode[*domain.CustomMessageText],
|
|
hooks.SliceTypeStringDecode[authz.RoleMapping],
|
|
hooks.MapTypeStringDecode[string, *authz.SystemAPIUser],
|
|
hooks.MapHTTPHeaderStringDecode,
|
|
database.DecodeHook(false),
|
|
actions.HTTPConfigDecodeHook,
|
|
hook.EnumHookFunc(authz.MemberTypeString),
|
|
hooks.MapTypeStringDecode[domain.Feature, any],
|
|
hooks.SliceTypeStringDecode[*command.SetQuota],
|
|
hook.Base64ToBytesHookFunc(),
|
|
hook.TagToLanguageHookFunc(),
|
|
mapstructure.StringToTimeDurationHookFunc(),
|
|
mapstructure.StringToTimeHookFunc(time.RFC3339),
|
|
mapstructure.StringToSliceHookFunc(","),
|
|
mapstructure.TextUnmarshallerHookFunc(),
|
|
)),
|
|
)
|
|
return config, err
|
|
}
|