[feature] add TOTP two-factor authentication (2FA) (#3960)

* [feature] add TOTP two-factor authentication (2FA) * use byteutil.S2B to avoid allocations when comparing + generating password hashes * don't bother with string conversion for consts * use io.ReadFull * use MustGenerateSecret for backup codes * rename util functions
2025-06-05 21:59:39 +02:00 · 2025-04-07 16:14:41 +02:00
parent 6f24205a26
commit 365b575341
78 changed files with 5593 additions and 825 deletions
--- a/internal/api/auth/signin.go
+++ b/internal/api/auth/signin.go
@ -22,104 +22,143 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
+	"slices"
+	"strings"

+	"codeberg.org/gruf/go-byteutil"
 	"github.com/gin-contrib/sessions"
 	"github.com/gin-gonic/gin"
+	"github.com/pquerna/otp/totp"
 	apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util"
 	"github.com/superseriousbusiness/gotosocial/internal/config"
 	"github.com/superseriousbusiness/gotosocial/internal/gtserror"
+	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
 	"github.com/superseriousbusiness/gotosocial/internal/oauth"
 	"golang.org/x/crypto/bcrypt"
 )

-// signIn just wraps a form-submitted username (we want an email) and password
-type signIn struct {
-	Email    string `form:"username"`
-	Password string `form:"password"`
-}
-
-// SignInGETHandler should be served at https://example.org/auth/sign_in.
-// The idea is to present a sign in page to the user, where they can enter their username and password.
-// The form will then POST to the sign in page, which will be handled by SignInPOSTHandler.
-// If an idp provider is set, then the user will be redirected to that to do their sign in.
+// SignInGETHandler should be served at
+// GET https://example.org/auth/sign_in.
+//
+// The idea is to present a friendly sign-in
+// page to the user, where they can enter their
+// username and password.
+//
+// When submitted, the form will POST to the sign-
+// in page, which will be handled by SignInPOSTHandler.
+//
+// If an idp provider is set, then the user will
+// be redirected to that to do their sign in.
 func (m *Module) SignInGETHandler(c *gin.Context) {
 	if _, err := apiutil.NegotiateAccept(c, apiutil.HTMLAcceptHeaders...); err != nil {
 		apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1)
 		return
 	}

-	if !config.GetOIDCEnabled() {
-		instance, errWithCode := m.processor.InstanceGetV1(c.Request.Context())
-		if errWithCode != nil {
-			apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
+	if config.GetOIDCEnabled() {
+		// IDP provider is in use, so redirect to it
+		// instead of serving our own sign in page.
+		//
+		// We need the internal state to know where
+		// to redirect to.
+		internalState := m.mustStringFromSession(
+			c,
+			sessions.Default(c),
+			sessionInternalState,
+		)
+		if internalState == "" {
+			// Error already
+			// written.
 			return
 		}

-		page := apiutil.WebPage{
-			Template: "sign-in.tmpl",
-			Instance: instance,
-		}
-
-		apiutil.TemplateWebPage(c, page)
+		c.Redirect(http.StatusSeeOther, m.idp.AuthCodeURL(internalState))
 		return
 	}

-	// idp provider is in use, so redirect to it
-	s := sessions.Default(c)
-
-	internalStateI := s.Get(sessionInternalState)
-	internalState, ok := internalStateI.(string)
-	if !ok {
-		m.clearSession(s)
-		err := fmt.Errorf("key %s was not found in session", sessionInternalState)
-		apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGetV1)
-		return
-	}
-
-	c.Redirect(http.StatusSeeOther, m.idp.AuthCodeURL(internalState))
-}
-
-// SignInPOSTHandler should be served at https://example.org/auth/sign_in.
-// The idea is to present a sign in page to the user, where they can enter their username and password.
-// The handler will then redirect to the auth handler served at /auth
-func (m *Module) SignInPOSTHandler(c *gin.Context) {
-	s := sessions.Default(c)
-
-	form := &signIn{}
-	if err := c.ShouldBind(form); err != nil {
-		m.clearSession(s)
-		apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, oauth.HelpfulAdvice), m.processor.InstanceGetV1)
-		return
-	}
-
-	userid, errWithCode := m.ValidatePassword(c.Request.Context(), form.Email, form.Password)
+	// IDP provider is not in use.
+	// Render our own cute little page.
+	instance, errWithCode := m.processor.InstanceGetV1(c.Request.Context())
 	if errWithCode != nil {
-		// don't clear session here, so the user can just press back and try again
-		// if they accidentally gave the wrong password or something
 		apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
 		return
 	}

-	s.Set(sessionUserID, userid)
-	if err := s.Save(); err != nil {
-		err := fmt.Errorf("error saving user id onto session: %s", err)
-		apiutil.ErrorHandler(c, gtserror.NewErrorInternalError(err, oauth.HelpfulAdvice), m.processor.InstanceGetV1)
+	apiutil.TemplateWebPage(c, apiutil.WebPage{
+		Template: "sign-in.tmpl",
+		Instance: instance,
+	})
+}
+
+// SignInPOSTHandler should be served at
+// POST https://example.org/auth/sign_in.
+//
+// The handler will check the submitted credentials,
+// then redirect either to the 2fa form, or straight
+// to the authorize page served at /oauth/authorize.
+func (m *Module) SignInPOSTHandler(c *gin.Context) {
+	s := sessions.Default(c)
+
+	// Parse email + password.
+	form := &struct {
+		Email    string `form:"username" validate:"required"`
+		Password string `form:"password" validate:"required"`
+	}{}
+	if err := c.ShouldBind(form); err != nil {
+		m.clearSessionWithBadRequest(c, s, err, oauth.HelpfulAdvice)
+		return
 	}

+	user, errWithCode := m.validatePassword(
+		c.Request.Context(),
+		form.Email,
+		form.Password,
+	)
+	if errWithCode != nil {
+		// Don't clear session here yet, so the user
+		// can just press back and try again if they
+		// accidentally gave the wrong password, without
+		// having to do the whole sign in flow again!
+		apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
+		return
+	}
+
+	// Whether or not 2fa is enabled, we want
+	// to save the session when we're done here.
+	defer m.mustSaveSession(s)
+
+	if user.TwoFactorEnabled() {
+		// If this user has 2FA enabled, redirect
+		// to the 2FA page and have them submit
+		// a code from their authenticator app.
+		s.Set(sessionUserIDAwaiting2FA, user.ID)
+		c.Redirect(http.StatusFound, "/auth"+Auth2FAPath)
+		return
+	}
+
+	// If the user doesn't have 2fa enabled,
+	// redirect straight to the OAuth authorize page.
+	s.Set(sessionUserID, user.ID)
 	c.Redirect(http.StatusFound, "/oauth"+OauthAuthorizePath)
 }

-// ValidatePassword takes an email address and a password.
-// The goal is to authenticate the password against the one for that email
-// address stored in the database. If OK, we return the userid (a ulid) for that user,
-// so that it can be used in further Oauth flows to generate a token/retreieve an oauth client from the db.
-func (m *Module) ValidatePassword(ctx context.Context, email string, password string) (string, gtserror.WithCode) {
+// validatePassword takes an email address and a password.
+// The func authenticates the password against the one for
+// that email address stored in the database.
+//
+// If OK, it returns the user, so that it can be used in
+// further OAuth flows to generate a token etc.
+func (m *Module) validatePassword(
+	ctx context.Context,
+	email string,
+	password string,
+) (*gtsmodel.User, gtserror.WithCode) {
 	if email == "" || password == "" {
 		err := errors.New("email or password was not provided")
 		return incorrectPassword(err)
 	}

-	user, err := m.db.GetUserByEmailAddress(ctx, email)
+	user, err := m.state.DB.GetUserByEmailAddress(ctx, email)
 	if err != nil {
 		err := fmt.Errorf("user %s was not retrievable from db during oauth authorization attempt: %s", email, err)
 		return incorrectPassword(err)
@ -130,17 +169,141 @@ func (m *Module) ValidatePassword(ctx context.Context, email string, password st
 		return incorrectPassword(err)
 	}

-	if err := bcrypt.CompareHashAndPassword([]byte(user.EncryptedPassword), []byte(password)); err != nil {
+	if err := bcrypt.CompareHashAndPassword(
+		byteutil.S2B(user.EncryptedPassword),
+		byteutil.S2B(password),
+	); err != nil {
 		err := fmt.Errorf("password hash didn't match for user %s during sign in attempt: %s", user.Email, err)
 		return incorrectPassword(err)
 	}

-	return user.ID, nil
+	return user, nil
 }

 // incorrectPassword wraps the given error in a gtserror.WithCode, and returns
 // only a generic 'safe' error message to the user, to not give any info away.
-func incorrectPassword(err error) (string, gtserror.WithCode) {
-	safeErr := fmt.Errorf("password/email combination was incorrect")
-	return "", gtserror.NewErrorUnauthorized(err, safeErr.Error(), oauth.HelpfulAdvice)
+func incorrectPassword(err error) (*gtsmodel.User, gtserror.WithCode) {
+	const errText = "password/email combination was incorrect"
+	return nil, gtserror.NewErrorUnauthorized(err, errText, oauth.HelpfulAdvice)
+}
+
+// TwoFactorCodeGETHandler should be served at
+// GET https://example.org/auth/2fa.
+//
+// The 2fa template displays a simple form asking the
+// user to input a code from their authenticator app.
+func (m *Module) TwoFactorCodeGETHandler(c *gin.Context) {
+	s := sessions.Default(c)
+
+	user := m.mustUserFromSession(c, s)
+	if user == nil {
+		// Error already
+		// written.
+		return
+	}
+
+	instance, errWithCode := m.processor.InstanceGetV1(c.Request.Context())
+	if errWithCode != nil {
+		apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
+		return
+	}
+
+	apiutil.TemplateWebPage(c, apiutil.WebPage{
+		Template: "2fa.tmpl",
+		Instance: instance,
+		Extra: map[string]any{
+			"user": user.Account.Username,
+		},
+	})
+}
+
+// TwoFactorCodePOSTHandler should be served at
+// POST https://example.org/auth/2fa.
+//
+// The idea is to handle a submitted 2fa code, validate it,
+// and if valid redirect to the /oauth/authorize page that
+// the user would get to if they didn't have 2fa enabled.
+func (m *Module) TwoFactorCodePOSTHandler(c *gin.Context) {
+	s := sessions.Default(c)
+
+	user := m.mustUserFromSession(c, s)
+	if user == nil {
+		// Error already
+		// written.
+		return
+	}
+
+	// Parse 2fa code.
+	form := &struct {
+		Code string `form:"code" validate:"required"`
+	}{}
+	if err := c.ShouldBind(form); err != nil {
+		m.clearSessionWithBadRequest(c, s, err, oauth.HelpfulAdvice)
+		return
+	}
+
+	valid, err := m.validate2FACode(c, user, form.Code)
+	if err != nil {
+		m.clearSessionWithInternalError(c, s, err, oauth.HelpfulAdvice)
+		return
+	}
+
+	if !valid {
+		// Don't clear session here yet, so the user
+		// can just press back and try again if they
+		// accidentally gave the wrong code, without
+		// having to do the whole sign in flow again!
+		const errText = "2fa code invalid or timed out, press back and try again; " +
+			"if issues persist, pester your instance admin to check the server clock"
+		errWithCode := gtserror.NewErrorBadRequest(errors.New(errText), errText)
+		apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1)
+		return
+	}
+
+	// Code looks good! Redirect
+	// to the OAuth authorize page.
+	s.Set(sessionUserID, user.ID)
+	m.mustSaveSession(s)
+	c.Redirect(http.StatusFound, "/oauth"+OauthAuthorizePath)
+}
+
+func (m *Module) validate2FACode(c *gin.Context, user *gtsmodel.User, code string) (bool, error) {
+	code = strings.TrimSpace(code)
+	if len(code) <= 6 {
+		// This is a normal authenticator
+		// app code, just try to validate it.
+		return totp.Validate(code, user.TwoFactorSecret), nil
+	}
+
+	// This is a one-time recovery code.
+	// Check against the user's stored codes.
+	for i := 0; i < len(user.TwoFactorBackups); i++ {
+		err := bcrypt.CompareHashAndPassword(
+			byteutil.S2B(user.TwoFactorBackups[i]),
+			byteutil.S2B(code),
+		)
+		if err != nil {
+			// Doesn't match,
+			// try next.
+			continue
+		}
+
+		// We have a match.
+		// Remove this one-time code from the user's backups.
+		user.TwoFactorBackups = slices.Delete(user.TwoFactorBackups, i, i+1)
+		if err := m.state.DB.UpdateUser(
+			c.Request.Context(),
+			user,
+			"two_factor_backups",
+		); err != nil {
+			return false, err
+		}
+
+		// So valid bestie!
+		return true, nil
+	}
+
+	// Not a valid one-time
+	// recovery code.
+	return false, nil
 }