diff --git a/models/auth/webauthn.go b/models/auth/webauthn.go index 75776f1e0..9e0913466 100644 --- a/models/auth/webauthn.go +++ b/models/auth/webauthn.go @@ -6,7 +6,7 @@ package auth import ( "context" - "encoding/base64" + "encoding/base32" "fmt" "strings" @@ -94,7 +94,7 @@ type WebAuthnCredentialList []*WebAuthnCredential func (list WebAuthnCredentialList) ToCredentials() []webauthn.Credential { creds := make([]webauthn.Credential, 0, len(list)) for _, cred := range list { - credID, _ := base64.RawStdEncoding.DecodeString(cred.CredentialID) + credID, _ := base32.HexEncoding.DecodeString(cred.CredentialID) creds = append(creds, webauthn.Credential{ ID: credID, PublicKey: cred.PublicKey, @@ -164,13 +164,13 @@ func HasWebAuthnRegistrationsByUID(uid int64) (bool, error) { } // GetWebAuthnCredentialByCredID returns WebAuthn credential by credential ID -func GetWebAuthnCredentialByCredID(credID string) (*WebAuthnCredential, error) { - return getWebAuthnCredentialByCredID(db.DefaultContext, credID) +func GetWebAuthnCredentialByCredID(userID int64, credID string) (*WebAuthnCredential, error) { + return getWebAuthnCredentialByCredID(db.DefaultContext, userID, credID) } -func getWebAuthnCredentialByCredID(ctx context.Context, credID string) (*WebAuthnCredential, error) { +func getWebAuthnCredentialByCredID(ctx context.Context, userID int64, credID string) (*WebAuthnCredential, error) { cred := new(WebAuthnCredential) - if found, err := db.GetEngine(ctx).Where("credential_id = ?", credID).Get(cred); err != nil { + if found, err := db.GetEngine(ctx).Where("user_id = ? AND credential_id = ?", userID, credID).Get(cred); err != nil { return nil, err } else if !found { return nil, ErrWebAuthnCredentialNotExist{CredentialID: credID} @@ -187,7 +187,7 @@ func createCredential(ctx context.Context, userID int64, name string, cred *weba c := &WebAuthnCredential{ UserID: userID, Name: name, - CredentialID: base64.RawStdEncoding.EncodeToString(cred.ID), + CredentialID: base32.HexEncoding.EncodeToString(cred.ID), PublicKey: cred.PublicKey, AttestationType: cred.AttestationType, AAGUID: cred.Authenticator.AAGUID, diff --git a/models/auth/webauthn_test.go b/models/auth/webauthn_test.go index 572636dbb..216bf1108 100644 --- a/models/auth/webauthn_test.go +++ b/models/auth/webauthn_test.go @@ -5,7 +5,7 @@ package auth import ( - "encoding/base64" + "encoding/base32" "testing" "code.gitea.io/gitea/models/unittest" @@ -61,7 +61,7 @@ func TestCreateCredential(t *testing.T) { res, err := CreateCredential(1, "WebAuthn Created Credential", &webauthn.Credential{ID: []byte("Test")}) assert.NoError(t, err) assert.Equal(t, "WebAuthn Created Credential", res.Name) - bs, err := base64.RawStdEncoding.DecodeString(res.CredentialID) + bs, err := base32.HexEncoding.DecodeString(res.CredentialID) assert.NoError(t, err) assert.Equal(t, []byte("Test"), bs) diff --git a/models/migrations/migrations.go b/models/migrations/migrations.go index 4ee2bc839..5aaf283bd 100644 --- a/models/migrations/migrations.go +++ b/models/migrations/migrations.go @@ -368,6 +368,8 @@ var migrations = []Migration{ NewMigration("Add authorize column to team_unit table", addAuthorizeColForTeamUnit), // v207 -> v208 NewMigration("Add webauthn table and migrate u2f data to webauthn", addWebAuthnCred), + // v208 -> v209 + NewMigration("Use base32.HexEncoding instead of base64 encoding for cred ID as it is case insensitive", useBase32HexForCredIDInWebAuthnCredential), } // GetCurrentDBVersion returns the current db version diff --git a/models/migrations/v208.go b/models/migrations/v208.go new file mode 100644 index 000000000..04bb981a4 --- /dev/null +++ b/models/migrations/v208.go @@ -0,0 +1,51 @@ +// Copyright 2021 The Gitea Authors. All rights reserved. +// Use of this source code is governed by a MIT-style +// license that can be found in the LICENSE file. + +package migrations + +import ( + "encoding/base32" + "encoding/base64" + + "xorm.io/xorm" +) + +func useBase32HexForCredIDInWebAuthnCredential(x *xorm.Engine) error { + + // Create webauthnCredential table + type webauthnCredential struct { + ID int64 `xorm:"pk autoincr"` + CredentialID string `xorm:"INDEX"` + } + if err := x.Sync2(&webauthnCredential{}); err != nil { + return err + } + + var start int + regs := make([]*webauthnCredential, 0, 50) + for { + err := x.OrderBy("id").Limit(50, start).Find(®s) + if err != nil { + return err + } + + for _, reg := range regs { + credID, _ := base64.RawStdEncoding.DecodeString(reg.CredentialID) + reg.CredentialID = base32.HexEncoding.EncodeToString(credID) + + _, err := x.Update(reg) + if err != nil { + return err + } + } + + if len(regs) < 50 { + break + } + start += 50 + regs = regs[:0] + } + + return nil +} diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index e903e4c53..d8398f6d9 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -748,10 +748,9 @@ passcode_invalid = The passcode is incorrect. Try again. twofa_enrolled = Your account has been enrolled into two-factor authentication. Store your scratch token (%s) in a safe place as it is only shown once! twofa_failed_get_secret = Failed to get secret. -webauthn_desc = Security keys are hardware devices containing cryptographic keys. They can be used for two-factor authentication. Security keys must support the WebAuthn Authenticator standard. +webauthn_desc = Security keys are hardware devices containing cryptographic keys. They can be used for two-factor authentication. Security keys must support the WebAuthn Authenticator standard. webauthn_register_key = Add Security Key webauthn_nickname = Nickname -webauthn_press_button = Press the button on your security key to register it. webauthn_delete_key = Remove Security Key webauthn_delete_key_desc = If you remove a security key you can no longer sign in with it. Continue? diff --git a/routers/web/auth/webauthn.go b/routers/web/auth/webauthn.go index 50dcb919e..b9e8de2ac 100644 --- a/routers/web/auth/webauthn.go +++ b/routers/web/auth/webauthn.go @@ -5,7 +5,7 @@ package auth import ( - "encoding/base64" + "encoding/base32" "errors" "net/http" @@ -131,7 +131,7 @@ func WebAuthnLoginAssertionPost(ctx *context.Context) { } // Success! Get the credential and update the sign count with the new value we received. - dbCred, err := auth.GetWebAuthnCredentialByCredID(base64.RawStdEncoding.EncodeToString(cred.ID)) + dbCred, err := auth.GetWebAuthnCredentialByCredID(user.ID, base32.HexEncoding.EncodeToString(cred.ID)) if err != nil { ctx.ServerError("GetWebAuthnCredentialByCredID", err) return diff --git a/routers/web/user/setting/security/webauthn.go b/routers/web/user/setting/security/webauthn.go index 8d28de8c9..7e2fc7283 100644 --- a/routers/web/user/setting/security/webauthn.go +++ b/routers/web/user/setting/security/webauthn.go @@ -38,9 +38,9 @@ func WebAuthnRegister(ctx *context.Context) { return } - _ = ctx.Session.Delete("registration") - if err := ctx.Session.Set("WebauthnName", form.Name); err != nil { - ctx.ServerError("Unable to set session key for WebauthnName", err) + _ = ctx.Session.Delete("webauthnRegistration") + if err := ctx.Session.Set("webauthnName", form.Name); err != nil { + ctx.ServerError("Unable to set session key for webauthnName", err) return } @@ -51,7 +51,7 @@ func WebAuthnRegister(ctx *context.Context) { } // Save the session data as marshaled JSON - if err = ctx.Session.Set("registration", sessionData); err != nil { + if err = ctx.Session.Set("webauthnRegistration", sessionData); err != nil { ctx.ServerError("Unable to set session", err) return } @@ -61,20 +61,20 @@ func WebAuthnRegister(ctx *context.Context) { // WebauthnRegisterPost receives the response of the security key func WebauthnRegisterPost(ctx *context.Context) { - name, ok := ctx.Session.Get("WebauthnName").(string) + name, ok := ctx.Session.Get("webauthnName").(string) if !ok || name == "" { - ctx.ServerError("Get WebauthnName", errors.New("no WebauthnName")) + ctx.ServerError("Get webauthnName", errors.New("no webauthnName")) return } // Load the session data - sessionData, ok := ctx.Session.Get("registration").(*webauthn.SessionData) + sessionData, ok := ctx.Session.Get("webauthnRegistration").(*webauthn.SessionData) if !ok || sessionData == nil { ctx.ServerError("Get registration", errors.New("no registration")) return } defer func() { - _ = ctx.Session.Delete("registration") + _ = ctx.Session.Delete("webauthnRegistration") }() // Verify that the challenge succeeded @@ -103,6 +103,8 @@ func WebauthnRegisterPost(ctx *context.Context) { ctx.ServerError("CreateCredential", err) return } + _ = ctx.Session.Delete("webauthnName") + ctx.JSON(http.StatusCreated, cred) } diff --git a/templates/user/auth/webauthn_error.tmpl b/templates/user/auth/webauthn_error.tmpl index be46ee42a..6f2980df7 100644 --- a/templates/user/auth/webauthn_error.tmpl +++ b/templates/user/auth/webauthn_error.tmpl @@ -12,7 +12,7 @@

{{.i18n.Tr "webauthn_error_duplicated"}}

{{.i18n.Tr "webauthn_error_empty"}}

{{.i18n.Tr "webauthn_error_timeout"}}

-
+
diff --git a/templates/user/settings/security/webauthn.tmpl b/templates/user/settings/security/webauthn.tmpl index be8f8cccd..d447ec04b 100644 --- a/templates/user/settings/security/webauthn.tmpl +++ b/templates/user/settings/security/webauthn.tmpl @@ -28,16 +28,6 @@
- - {{template "user/auth/webauthn_error" .}}