mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-15 04:18:01 +00:00
aabefb9382
# Which Problems Are Solved The session API was designed to be flexible enough for multiple use cases / login scenarios, where the login could respect the login policy or not. The session API itself does not have a corresponding policy and would not check for a required MFA or alike. It therefore also did not yet respect the lockout policy and would leave it to the login UI to handle that. Since the lockout policy is related to the user and not the login itself, we decided to handle the lockout also on calls of the session API. # How the Problems Are Solved If a lockout policy is set for either password or (T)OTP checks, the corresponding check on the session API be run against the lockout check. This means that any failed check, regardless if occurred in the session API or the current hosted login will be counted against the maximum allowed checks of that authentication mechanism. TOTP, OTP SMS and OTP Email are each treated as a separate mechanism. For implementation: - The existing lockout check functions were refactored to be usable for session API calls. - `SessionCommand` type now returns not only an error, but also `[]eventstore.Command` - these will be executed in case of an error # Additional Changes None. # Additional Context Closes #7967 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
170 lines
6.9 KiB
Go
170 lines
6.9 KiB
Go
package command
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"golang.org/x/text/language"
|
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
|
"github.com/zitadel/zitadel/internal/eventstore"
|
|
"github.com/zitadel/zitadel/internal/repository/session"
|
|
"github.com/zitadel/zitadel/internal/repository/user"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
)
|
|
|
|
func (c *Commands) CreateOTPSMSChallengeReturnCode(dst *string) SessionCommand {
|
|
return c.createOTPSMSChallenge(true, dst)
|
|
}
|
|
|
|
func (c *Commands) CreateOTPSMSChallenge() SessionCommand {
|
|
return c.createOTPSMSChallenge(false, nil)
|
|
}
|
|
|
|
func (c *Commands) createOTPSMSChallenge(returnCode bool, dst *string) SessionCommand {
|
|
return func(ctx context.Context, cmd *SessionCommands) ([]eventstore.Command, error) {
|
|
if cmd.sessionWriteModel.UserID == "" {
|
|
return nil, zerrors.ThrowPreconditionFailed(nil, "COMMAND-JKL3g", "Errors.User.UserIDMissing")
|
|
}
|
|
writeModel := NewHumanOTPSMSWriteModel(cmd.sessionWriteModel.UserID, "")
|
|
if err := cmd.eventstore.FilterToQueryReducer(ctx, writeModel); err != nil {
|
|
return nil, err
|
|
}
|
|
if !writeModel.OTPAdded() {
|
|
return nil, zerrors.ThrowPreconditionFailed(nil, "COMMAND-BJ2g3", "Errors.User.MFA.OTP.NotReady")
|
|
}
|
|
code, err := cmd.createCode(ctx, cmd.eventstore.Filter, domain.SecretGeneratorTypeOTPSMS, cmd.otpAlg, c.defaultSecretGenerators.OTPSMS)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if returnCode {
|
|
*dst = code.Plain
|
|
}
|
|
cmd.OTPSMSChallenged(ctx, code.Crypted, code.Expiry, returnCode)
|
|
return nil, nil
|
|
}
|
|
}
|
|
|
|
func (c *Commands) OTPSMSSent(ctx context.Context, sessionID, resourceOwner string) error {
|
|
sessionWriteModel := NewSessionWriteModel(sessionID, resourceOwner)
|
|
err := c.eventstore.FilterToQueryReducer(ctx, sessionWriteModel)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if sessionWriteModel.OTPSMSCodeChallenge == nil {
|
|
return zerrors.ThrowPreconditionFailed(nil, "COMMAND-G3t31", "Errors.User.Code.NotFound")
|
|
}
|
|
return c.pushAppendAndReduce(ctx, sessionWriteModel,
|
|
session.NewOTPSMSSentEvent(ctx, &session.NewAggregate(sessionID, sessionWriteModel.ResourceOwner).Aggregate),
|
|
)
|
|
}
|
|
|
|
func (c *Commands) CreateOTPEmailChallengeURLTemplate(urlTmpl string) (SessionCommand, error) {
|
|
if err := domain.RenderOTPEmailURLTemplate(io.Discard, urlTmpl, "code", "userID", "loginName", "displayName", language.English); err != nil {
|
|
return nil, err
|
|
}
|
|
return c.createOTPEmailChallenge(false, urlTmpl, nil), nil
|
|
}
|
|
|
|
func (c *Commands) CreateOTPEmailChallengeReturnCode(dst *string) SessionCommand {
|
|
return c.createOTPEmailChallenge(true, "", dst)
|
|
}
|
|
|
|
func (c *Commands) CreateOTPEmailChallenge() SessionCommand {
|
|
return c.createOTPEmailChallenge(false, "", nil)
|
|
}
|
|
|
|
func (c *Commands) createOTPEmailChallenge(returnCode bool, urlTmpl string, dst *string) SessionCommand {
|
|
return func(ctx context.Context, cmd *SessionCommands) ([]eventstore.Command, error) {
|
|
if cmd.sessionWriteModel.UserID == "" {
|
|
return nil, zerrors.ThrowPreconditionFailed(nil, "COMMAND-JK3gp", "Errors.User.UserIDMissing")
|
|
}
|
|
writeModel := NewHumanOTPEmailWriteModel(cmd.sessionWriteModel.UserID, "")
|
|
if err := cmd.eventstore.FilterToQueryReducer(ctx, writeModel); err != nil {
|
|
return nil, err
|
|
}
|
|
if !writeModel.OTPAdded() {
|
|
return nil, zerrors.ThrowPreconditionFailed(nil, "COMMAND-JKLJ3", "Errors.User.MFA.OTP.NotReady")
|
|
}
|
|
code, err := cmd.createCode(ctx, cmd.eventstore.Filter, domain.SecretGeneratorTypeOTPEmail, cmd.otpAlg, c.defaultSecretGenerators.OTPEmail)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if returnCode {
|
|
*dst = code.Plain
|
|
}
|
|
cmd.OTPEmailChallenged(ctx, code.Crypted, code.Expiry, returnCode, urlTmpl)
|
|
return nil, nil
|
|
}
|
|
}
|
|
|
|
func (c *Commands) OTPEmailSent(ctx context.Context, sessionID, resourceOwner string) error {
|
|
sessionWriteModel := NewSessionWriteModel(sessionID, resourceOwner)
|
|
err := c.eventstore.FilterToQueryReducer(ctx, sessionWriteModel)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if sessionWriteModel.OTPEmailCodeChallenge == nil {
|
|
return zerrors.ThrowPreconditionFailed(nil, "COMMAND-SLr02", "Errors.User.Code.NotFound")
|
|
}
|
|
return c.pushAppendAndReduce(ctx, sessionWriteModel,
|
|
session.NewOTPEmailSentEvent(ctx, &session.NewAggregate(sessionID, sessionWriteModel.ResourceOwner).Aggregate),
|
|
)
|
|
}
|
|
|
|
func CheckOTPSMS(code string) SessionCommand {
|
|
return func(ctx context.Context, cmd *SessionCommands) (_ []eventstore.Command, err error) {
|
|
writeModel := func(ctx context.Context, userID string, resourceOwner string) (OTPCodeWriteModel, error) {
|
|
otpWriteModel := NewHumanOTPSMSCodeWriteModel(cmd.sessionWriteModel.UserID, "")
|
|
err := cmd.eventstore.FilterToQueryReducer(ctx, otpWriteModel)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// explicitly set the challenge from the session write model since the code write model will only check user events
|
|
otpWriteModel.otpCode = cmd.sessionWriteModel.OTPSMSCodeChallenge
|
|
return otpWriteModel, nil
|
|
}
|
|
succeededEvent := func(ctx context.Context, aggregate *eventstore.Aggregate, info *user.AuthRequestInfo) eventstore.Command {
|
|
return user.NewHumanOTPSMSCheckSucceededEvent(ctx, aggregate, nil)
|
|
}
|
|
failedEvent := func(ctx context.Context, aggregate *eventstore.Aggregate, info *user.AuthRequestInfo) eventstore.Command {
|
|
return user.NewHumanOTPSMSCheckFailedEvent(ctx, aggregate, nil)
|
|
}
|
|
commands, err := checkOTP(ctx, cmd.sessionWriteModel.UserID, code, "", nil, writeModel, cmd.eventstore.FilterToQueryReducer, cmd.otpAlg, succeededEvent, failedEvent)
|
|
if err != nil {
|
|
return commands, err
|
|
}
|
|
cmd.eventCommands = append(cmd.eventCommands, commands...)
|
|
cmd.OTPSMSChecked(ctx, cmd.now())
|
|
return nil, nil
|
|
}
|
|
}
|
|
|
|
func CheckOTPEmail(code string) SessionCommand {
|
|
return func(ctx context.Context, cmd *SessionCommands) (_ []eventstore.Command, err error) {
|
|
writeModel := func(ctx context.Context, userID string, resourceOwner string) (OTPCodeWriteModel, error) {
|
|
otpWriteModel := NewHumanOTPEmailCodeWriteModel(cmd.sessionWriteModel.UserID, "")
|
|
err := cmd.eventstore.FilterToQueryReducer(ctx, otpWriteModel)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
// explicitly set the challenge from the session write model since the code write model will only check user events
|
|
otpWriteModel.otpCode = cmd.sessionWriteModel.OTPEmailCodeChallenge
|
|
return otpWriteModel, nil
|
|
}
|
|
succeededEvent := func(ctx context.Context, aggregate *eventstore.Aggregate, info *user.AuthRequestInfo) eventstore.Command {
|
|
return user.NewHumanOTPEmailCheckSucceededEvent(ctx, aggregate, nil)
|
|
}
|
|
failedEvent := func(ctx context.Context, aggregate *eventstore.Aggregate, info *user.AuthRequestInfo) eventstore.Command {
|
|
return user.NewHumanOTPEmailCheckFailedEvent(ctx, aggregate, nil)
|
|
}
|
|
commands, err := checkOTP(ctx, cmd.sessionWriteModel.UserID, code, "", nil, writeModel, cmd.eventstore.FilterToQueryReducer, cmd.otpAlg, succeededEvent, failedEvent)
|
|
if err != nil {
|
|
return commands, err
|
|
}
|
|
cmd.eventCommands = append(cmd.eventCommands, commands...)
|
|
cmd.OTPEmailChecked(ctx, cmd.now())
|
|
return nil, nil
|
|
}
|
|
}
|