github.com/cozy/cozy-stack@v0.0.0-20240327093429-939e4a21320e/model/instance/auth.go

package instance

import (
	"crypto/sha256"
	"encoding/base32"
	"io"
	"net/http"
	"time"

	"github.com/cozy/cozy-stack/pkg/crypto"
	"github.com/mssola/user_agent"
	"github.com/pquerna/otp"
	"github.com/pquerna/otp/totp"
	"golang.org/x/crypto/hkdf"
)

// This is the lengths of our tokens (in bytes).
const (
	RegisterTokenLen      = 16
	PasswordResetTokenLen = 16
	SessionCodeLen        = 32
	EmailVerifiedCodeLen  = 32
	SessionSecretLen      = 64
	MagicLinkCodeLen      = 32
	OauthSecretLen        = 128
)

var twoFactorTOTPOptions = totp.ValidateOpts{
	Period:    60, // 60s
	Skew:      14, // 60s +- 14*60s = [-13min; 15min]
	Digits:    otp.DigitsSix,
	Algorithm: otp.AlgorithmSHA256,
}

var totpMACConfig = crypto.MACConfig{
	Name:   "totp",
	MaxAge: 0,
	MaxLen: 256,
}

var trustedDeviceMACConfig = crypto.MACConfig{
	Name:   "trusted-device",
	MaxAge: 0,
	MaxLen: 256,
}

// AuthMode defines the authentication mode chosen for the connection to this
// instance.
type AuthMode int

const (
	// Basic authentication mode, only passphrase
	Basic AuthMode = iota
	// TwoFactorMail authentication mode, with passcode sent via email
	TwoFactorMail
)

// AuthModeToString encode authentication mode in a string
func AuthModeToString(authMode AuthMode) string {
	switch authMode {
	case TwoFactorMail:
		return "two_factor_mail"
	default:
		return "basic"
	}
}

// StringToAuthMode converts a string encoded authentication mode into a
// AuthMode int.
func StringToAuthMode(authMode string) (AuthMode, error) {
	switch authMode {
	case "two_factor_mail":
		return TwoFactorMail, nil
	case "basic":
		return Basic, nil
	default:
		return 0, ErrUnknownAuthMode
	}
}

// HasAuthMode returns whether or not the instance has the given authentication
// mode activated.
func (i *Instance) HasAuthMode(authMode AuthMode) bool {
	return i.AuthMode == authMode
}

// GenerateTwoFactorSecrets generates a (token, passcode) pair that can be
// used as a two factor authentication secret value. The token is used to allow
// the two-factor form — meaning the user has correctly entered its passphrase
// and successfully done the first part of the two factor authentication.
//
// The passcode should be send to the user by another mean (mail, SMS, ...)
func (i *Instance) GenerateTwoFactorSecrets() (token []byte, passcode string, err error) {
	// A salt is used when we generate a new 2FA secret to derive a new TOTP
	// function from. This allow us to have TOTP derived from a new key each time
	// we check the first step of the 2FA ("the passphrase step"). This salt is
	// given to the user and signed in the "two-factor-token" MAC.
	salt := crypto.GenerateRandomBytes(sha256.Size)
	token, err = crypto.EncodeAuthMessage(totpMACConfig, i.SessionSecret(), salt, nil)
	if err != nil {
		return
	}

	h := hkdf.New(sha256.New, i.SessionSecret(), salt, nil)
	key := make([]byte, 32)
	_, err = io.ReadFull(h, key)
	if err != nil {
		return
	}
	passcode, err = totp.GenerateCodeCustom(base32.StdEncoding.EncodeToString(key),
		time.Now().UTC(), twoFactorTOTPOptions)
	return
}

// ValidateTwoFactorPasscode validates the given (token, passcode) pair for two
// factor authentication.
func (i *Instance) ValidateTwoFactorPasscode(token []byte, passcode string) bool {
	salt, err := crypto.DecodeAuthMessage(totpMACConfig, i.SessionSecret(), token, nil)
	if err != nil {
		return false
	}

	h := hkdf.New(sha256.New, i.SessionSecret(), salt, nil)
	key := make([]byte, 32)
	_, err = io.ReadFull(h, key)
	if err != nil {
		return false
	}
	ok, err := totp.ValidateCustom(passcode, base32.StdEncoding.EncodeToString(key),
		time.Now().UTC(), twoFactorTOTPOptions)
	return ok && err == nil
}

// GenerateTwoFactorTrustedDeviceSecret generates a token that can be kept by the
// user on-demand to avoid having two-factor authentication on a specific
// machine.
func (i *Instance) GenerateTwoFactorTrustedDeviceSecret(req *http.Request) ([]byte, error) {
	ua := user_agent.New(req.UserAgent())
	browser, _ := ua.Browser()
	additionalData := []byte(i.Domain + ua.OS() + browser)
	return crypto.EncodeAuthMessage(trustedDeviceMACConfig, i.SessionSecret(), nil, additionalData)
}

// ValidateTwoFactorTrustedDeviceSecret validates the given token used to check
// if the computer is trusted to avoid two-factor authorization.
func (i *Instance) ValidateTwoFactorTrustedDeviceSecret(req *http.Request, token []byte) bool {
	ua := user_agent.New(req.UserAgent())
	browser, _ := ua.Browser()
	additionalData := []byte(i.Domain + ua.OS() + browser)
	_, err := crypto.DecodeAuthMessage(trustedDeviceMACConfig, i.SessionSecret(), token, additionalData)
	return err == nil
}

// GenerateMailConfirmationCode generates a code for validating the user's
// email.
func (i *Instance) GenerateMailConfirmationCode() (string, error) {
	email, err := i.SettingsEMail()
	if err != nil {
		return "", err
	}
	h := hkdf.New(sha256.New, i.SessionSecret(), nil, []byte(email))
	key := make([]byte, 32)
	_, err = io.ReadFull(h, key)
	if err != nil {
		return "", err
	}
	return totp.GenerateCodeCustom(base32.StdEncoding.EncodeToString(key),
		time.Now().UTC(), twoFactorTOTPOptions)
}

// ValidateMailConfirmationCode returns true if the given passcode is valid.
func (i *Instance) ValidateMailConfirmationCode(passcode string) bool {
	email, err := i.SettingsEMail()
	if err != nil {
		return false
	}
	h := hkdf.New(sha256.New, i.SessionSecret(), nil, []byte(email))
	key := make([]byte, 32)
	_, err = io.ReadFull(h, key)
	if err != nil {
		return false
	}
	ok, err := totp.ValidateCustom(passcode, base32.StdEncoding.EncodeToString(key),
		time.Now().UTC(), twoFactorTOTPOptions)
	if !ok || err != nil {
		return false
	}
	return true
}

// CreateSessionCode returns a session_code that can be used to open a webview
// inside the flagship app and create the session.
func (i *Instance) CreateSessionCode() (string, error) {
	code := crypto.GenerateRandomString(SessionCodeLen)
	store := GetStore()
	if err := store.SaveSessionCode(i, code); err != nil {
		return "", err
	}
	return code, nil
}

// CheckAndClearSessionCode will return true if the session code is valid. The
// session code can only be used once, so it will be cleared after calling this
// function.
func (i *Instance) CheckAndClearSessionCode(code string) bool {
	return GetStore().CheckAndClearSessionCode(i, code)
}

// CreateEmailVerifiedCode returns an email_verified_code that can be used to
// avoid the 2FA by email.
func (i *Instance) CreateEmailVerifiedCode() (string, error) {
	code := crypto.GenerateRandomString(EmailVerifiedCodeLen)
	store := GetStore()
	if err := store.SaveEmailVerfiedCode(i, code); err != nil {
		return "", err
	}
	return code, nil
}

// CheckEmailVerifiedCode will return true if the email verified code is valid.
func (i *Instance) CheckEmailVerifiedCode(code string) bool {
	if code == "" {
		return false
	}
	return GetStore().CheckEmailVerifiedCode(i, code)
}