Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: MFA NewFactor to default to creating unverfied factors #1692

Merged
merged 4 commits into from
Jul 31, 2024
Merged

fix: MFA NewFactor to default to creating unverfied factors #1692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
719a6e4
fix: explicitly specify factor type
J0 Jul 30, 2024
7c9732b
fix: correct typo
J0 Jul 30, 2024
1e1fa88
fix: also restrict challenge when verify is disabled
J0 Jul 30, 2024
8570d8a
fix: remove unused methods
J0 Jul 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions internal/api/admin_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,8 @@ func (ts *AdminTestSuite) TestAdminUserDeleteFactor() {
require.NoError(ts.T(), err, "Error making new user")
require.NoError(ts.T(), ts.API.db.Create(u), "Error creating user")

f := models.NewFactor(u, "testSimpleName", models.TOTP, models.FactorStateVerified)
f := models.NewTOTPFactor(u, "testSimpleName")
require.NoError(ts.T(), f.UpdateStatus(ts.API.db, models.FactorStateVerified))
require.NoError(ts.T(), f.SetSecret("secretkey", ts.Config.Security.DBEncryption.Encrypt, ts.Config.Security.DBEncryption.EncryptionKeyID, ts.Config.Security.DBEncryption.EncryptionKey))
require.NoError(ts.T(), ts.API.db.Create(f), "Error saving new test factor")

Expand All @@ -793,7 +794,7 @@ func (ts *AdminTestSuite) TestAdminUserGetFactors() {
require.NoError(ts.T(), err, "Error making new user")
require.NoError(ts.T(), ts.API.db.Create(u), "Error creating user")

f := models.NewFactor(u, "testSimpleName", models.TOTP, models.FactorStateUnverified)
f := models.NewTOTPFactor(u, "testSimpleName")
require.NoError(ts.T(), f.SetSecret("secretkey", ts.Config.Security.DBEncryption.Encrypt, ts.Config.Security.DBEncryption.EncryptionKeyID, ts.Config.Security.DBEncryption.EncryptionKey))
require.NoError(ts.T(), ts.API.db.Create(f), "Error saving new test factor")

Expand All @@ -815,7 +816,7 @@ func (ts *AdminTestSuite) TestAdminUserUpdateFactor() {
require.NoError(ts.T(), err, "Error making new user")
require.NoError(ts.T(), ts.API.db.Create(u), "Error creating user")

f := models.NewFactor(u, "testSimpleName", models.TOTP, models.FactorStateUnverified)
f := models.NewTOTPFactor(u, "testSimpleName")
require.NoError(ts.T(), f.SetSecret("secretkey", ts.Config.Security.DBEncryption.Encrypt, ts.Config.Security.DBEncryption.EncryptionKeyID, ts.Config.Security.DBEncryption.EncryptionKey))
require.NoError(ts.T(), ts.API.db.Create(f), "Error saving new test factor")

Expand Down
21 changes: 17 additions & 4 deletions internal/api/mfa.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func (a *API) enrollPhoneFactor(w http.ResponseWriter, r *http.Request, params *
if numVerifiedFactors > 0 && !session.IsAAL2() {
return forbiddenError(ErrorCodeInsufficientAAL, "AAL2 required to enroll a new factor")
}
factor := models.NewPhoneFactor(user, phone, params.FriendlyName, params.FactorType, models.FactorStateUnverified)
factor := models.NewPhoneFactor(user, phone, params.FriendlyName)
err = db.Transaction(func(tx *storage.Connection) error {
if terr := tx.Create(factor); terr != nil {
pgErr := utilities.NewPostgresError(terr)
Expand Down Expand Up @@ -222,7 +222,7 @@ func (a *API) EnrollFactor(w http.ResponseWriter, r *http.Request) error {
}
svgData.End()

factor = models.NewFactor(user, params.FriendlyName, params.FactorType, models.FactorStateUnverified)
factor = models.NewTOTPFactor(user, params.FriendlyName)
if err := factor.SetSecret(key.Secret(), config.Security.DBEncryption.Encrypt, config.Security.DBEncryption.EncryptionKeyID, config.Security.DBEncryption.EncryptionKey); err != nil {
return err
}
Expand Down Expand Up @@ -352,10 +352,23 @@ func (a *API) ChallengeFactor(w http.ResponseWriter, r *http.Request) error {

user := getUser(ctx)
factor := getFactor(ctx)

ipAddress := utilities.GetIPAddress(r)
if factor.IsPhoneFactor() {
switch factor.FactorType {
case models.Phone:
if !config.MFA.Phone.VerifyEnabled {
return unprocessableEntityError(ErrorCodeMFAPhoneEnrollDisabled, "MFA verification is disabled for Phone")
}
return a.challengePhoneFactor(w, r)

case models.TOTP:
if !config.MFA.TOTP.VerifyEnabled {
return unprocessableEntityError(ErrorCodeMFATOTPEnrollDisabled, "MFA verification is disabled for TOTP")
}
default:
return badRequestError(ErrorCodeValidationFailed, "factor_type needs to be TOTP or Phone")
}

challenge := factor.CreateChallenge(ipAddress)
if err := db.Transaction(func(tx *storage.Connection) error {
if terr := tx.Create(challenge); terr != nil {
Expand Down Expand Up @@ -626,7 +639,7 @@ func (a *API) VerifyFactor(w http.ResponseWriter, r *http.Request) error {
return terr
}
}
if shouldReEncrypt && config.Security.DBEncryption.Encrypt && factor.IsTOTPFactor() {
if shouldReEncrypt && config.Security.DBEncryption.Encrypt {
hf marked this conversation as resolved.
Show resolved Hide resolved
es, terr := crypto.NewEncryptedString(factor.ID.String(), []byte(secret), config.Security.DBEncryption.EncryptionKeyID, config.Security.DBEncryption.EncryptionKey)
if terr != nil {
return terr
Expand Down
8 changes: 4 additions & 4 deletions internal/api/mfa_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ func (ts *MFATestSuite) SetupTest() {
require.NoError(ts.T(), err, "Error creating test user model")
require.NoError(ts.T(), ts.API.db.Create(u), "Error saving new test user")
// Create Factor
f := models.NewFactor(u, "test_factor", models.TOTP, models.FactorStateUnverified)
f := models.NewTOTPFactor(u, "test_factor")
require.NoError(ts.T(), f.SetSecret("secretkey", ts.Config.Security.DBEncryption.Encrypt, ts.Config.Security.DBEncryption.EncryptionKeyID, ts.Config.Security.DBEncryption.EncryptionKey))
require.NoError(ts.T(), ts.API.db.Create(f), "Error saving new test factor")
// Create corresponding session
Expand Down Expand Up @@ -277,7 +277,7 @@ func (ts *MFATestSuite) TestChallengeSMSFactor() {
phone := "+1234567"
friendlyName := "testchallengesmsfactor"

f := models.NewPhoneFactor(ts.TestUser, phone, friendlyName, models.Phone, models.FactorStateUnverified)
f := models.NewPhoneFactor(ts.TestUser, phone, friendlyName)
require.NoError(ts.T(), ts.API.db.Create(f), "Error creating new SMS factor")
token := ts.generateAAL1Token(ts.TestUser, &ts.TestSession.ID)

Expand Down Expand Up @@ -369,7 +369,7 @@ func (ts *MFATestSuite) TestMFAVerifyFactor() {

if v.factorType == models.TOTP {
friendlyName := uuid.Must(uuid.NewV4()).String()
f = models.NewFactor(ts.TestUser, friendlyName, models.TOTP, models.FactorStateUnverified)
f = models.NewTOTPFactor(ts.TestUser, friendlyName)
sharedSecret = ts.TestOTPKey.Secret()
f.Secret = sharedSecret
require.NoError(ts.T(), ts.API.db.Create(f), "Error updating new test factor")
Expand All @@ -379,7 +379,7 @@ func (ts *MFATestSuite) TestMFAVerifyFactor() {
otp, err := crypto.GenerateOtp(numDigits)
require.NoError(ts.T(), err)
phone := fmt.Sprintf("+%s", otp)
f = models.NewPhoneFactor(ts.TestUser, phone, friendlyName, models.Phone, models.FactorStateUnverified)
f = models.NewPhoneFactor(ts.TestUser, phone, friendlyName)
require.NoError(ts.T(), ts.API.db.Create(f), "Error creating new SMS factor")
}

Expand Down
16 changes: 6 additions & 10 deletions internal/models/factor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,12 @@ func NewFactor(user *User, friendlyName string, factorType string, state FactorS
return factor
}

func NewPhoneFactor(user *User, phone, friendlyName string, factorType string, state FactorState) *Factor {
factor := NewFactor(user, friendlyName, factorType, state)
func NewTOTPFactor(user *User, friendlyName string) *Factor {
return NewFactor(user, friendlyName, TOTP, FactorStateUnverified)
}

func NewPhoneFactor(user *User, phone, friendlyName string) *Factor {
factor := NewFactor(user, friendlyName, Phone, FactorStateUnverified)
factor.Phone = storage.NullString(phone)
return factor
}
Expand Down Expand Up @@ -238,14 +242,6 @@ func (f *Factor) UpdateFactorType(tx *storage.Connection, factorType string) err
return tx.UpdateOnly(f, "factor_type", "updated_at")
}

func (f *Factor) IsTOTPFactor() bool {
return f.FactorType == TOTP
}

func (f *Factor) IsPhoneFactor() bool {
return f.FactorType == Phone
}

func (f *Factor) DowngradeSessionsToAAL1(tx *storage.Connection) error {
sessions, err := FindSessionsByFactorID(tx, f.ID)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion internal/models/factor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func (ts *FactorTestSuite) SetupTest() {
require.NoError(ts.T(), err)
require.NoError(ts.T(), ts.db.Create(user))

factor := NewFactor(user, "asimplename", TOTP, FactorStateUnverified)
factor := NewTOTPFactor(user, "asimplename")
require.NoError(ts.T(), factor.SetSecret("topsecret", false, "", ""))
require.NoError(ts.T(), ts.db.Create(factor))
ts.TestFactor = factor
Expand Down
Loading