user.go

package model

import (
	"encoding/binary"
	"encoding/json"
	"fmt"
	"time"

	"github.com/alist-org/alist/v3/internal/errs"
	"github.com/alist-org/alist/v3/pkg/utils"
	"github.com/alist-org/alist/v3/pkg/utils/random"
	"github.com/go-webauthn/webauthn/webauthn"
	"github.com/pkg/errors"
)

const (
	GENERAL = iota
	GUEST   // only one exists
	ADMIN
	NEWGENERAL
)

const StaticHashSalt = "https://github.com/alist-org/alist"

type User struct {
	ID          uint   `json:"id" gorm:"primaryKey"`                      // unique key
	Username    string `json:"username" gorm:"unique" binding:"required"` // username
	PwdHash     string `json:"-"`                                         // password hash
	PwdTS       int64  `json:"-"`                                         // password timestamp
	Salt        string `json:"-"`                                         // unique salt
	Password    string `json:"password"`                                  // password
	BasePath    string `json:"base_path"`                                 // base path
	Role        Roles  `json:"role" gorm:"type:text"`                     // user's roles
	RolesDetail []Role `json:"-" gorm:"-"`
	Disabled    bool   `json:"disabled"`
	// Determine permissions by bit
	//   0:  can see hidden files
	//   1:  can access without password
	//   2:  can add offline download tasks
	//   3:  can mkdir and upload
	//   4:  can rename
	//   5:  can move
	//   6:  can copy
	//   7:  can remove
	//   8:  webdav read
	//   9:  webdav write
	//   10: ftp/sftp login and read
	//   11: ftp/sftp write
	//   12: can read archives
	//   13: can decompress archives
	//   14: check path limit
	Permission int32  `json:"permission"`
	OtpSecret  string `json:"-"`
	SsoID      string `json:"sso_id"` // unique by sso platform
	Authn      string `gorm:"type:text" json:"-"`
}

func (u *User) IsGuest() bool {
	return u.Role.Contains(GUEST)
}

func (u *User) IsAdmin() bool {
	return u.Role.Contains(ADMIN)
}

func (u *User) ValidateRawPassword(password string) error {
	return u.ValidatePwdStaticHash(StaticHash(password))
}

func (u *User) ValidatePwdStaticHash(pwdStaticHash string) error {
	if pwdStaticHash == "" {
		return errors.WithStack(errs.EmptyPassword)
	}
	if u.PwdHash != HashPwd(pwdStaticHash, u.Salt) {
		return errors.WithStack(errs.WrongPassword)
	}
	return nil
}

func (u *User) SetPassword(pwd string) *User {
	u.Salt = random.String(16)
	u.PwdHash = TwoHashPwd(pwd, u.Salt)
	u.PwdTS = time.Now().Unix()
	return u
}

func (u *User) CanSeeHides() bool {
	return u.Permission&1 == 1
}

func (u *User) CanAccessWithoutPassword() bool {
	return (u.Permission>>1)&1 == 1
}

func (u *User) CanAddOfflineDownloadTasks() bool {
	return (u.Permission>>2)&1 == 1
}

func (u *User) CanWrite() bool {
	return (u.Permission>>3)&1 == 1
}

func (u *User) CanRename() bool {
	return (u.Permission>>4)&1 == 1
}

func (u *User) CanMove() bool {
	return (u.Permission>>5)&1 == 1
}

func (u *User) CanCopy() bool {
	return (u.Permission>>6)&1 == 1
}

func (u *User) CanRemove() bool {
	return (u.Permission>>7)&1 == 1
}

func (u *User) CanWebdavRead() bool {
	return (u.Permission>>8)&1 == 1
}

func (u *User) CanWebdavManage() bool {
	return (u.Permission>>9)&1 == 1
}

func (u *User) CanFTPAccess() bool {
	return (u.Permission>>10)&1 == 1
}

func (u *User) CanFTPManage() bool {
	return (u.Permission>>11)&1 == 1
}

func (u *User) CanReadArchives() bool {
	return (u.Permission>>12)&1 == 1
}

func (u *User) CanDecompress() bool {
	return (u.Permission>>13)&1 == 1
}

func (u *User) CheckPathLimit() bool {
	return (u.Permission>>14)&1 == 1
}

func (u *User) JoinPath(reqPath string) (string, error) {
	if reqPath == "/" {
		return utils.FixAndCleanPath(u.BasePath), nil
	}
	path, err := utils.JoinBasePath(u.BasePath, reqPath)
	if err != nil {
		return "", err
	}

	if path != "/" && u.CheckPathLimit() {
		basePaths := GetAllBasePathsFromRoles(u)
		match := false
		for _, base := range basePaths {
			if utils.IsSubPath(base, path) {
				match = true
				break
			}
		}
		if !match {
			return "", errs.PermissionDenied
		}
	}

	return path, nil
}

func StaticHash(password string) string {
	return utils.HashData(utils.SHA256, []byte(fmt.Sprintf("%s-%s", password, StaticHashSalt)))
}

func HashPwd(static string, salt string) string {
	return utils.HashData(utils.SHA256, []byte(fmt.Sprintf("%s-%s", static, salt)))
}

func TwoHashPwd(password string, salt string) string {
	return HashPwd(StaticHash(password), salt)
}

func (u *User) WebAuthnID() []byte {
	bs := make([]byte, 8)
	binary.LittleEndian.PutUint64(bs, uint64(u.ID))
	return bs
}

func (u *User) WebAuthnName() string {
	return u.Username
}

func (u *User) WebAuthnDisplayName() string {
	return u.Username
}

func (u *User) WebAuthnCredentials() []webauthn.Credential {
	var res []webauthn.Credential
	err := json.Unmarshal([]byte(u.Authn), &res)
	if err != nil {
		fmt.Println(err)
	}
	return res
}

func (u *User) WebAuthnIcon() string {
	return "https://alistgo.com/logo.svg"
}

// FetchRole is used to load role details by id. It should be set by the op package
// to avoid an import cycle between model and op.
var FetchRole func(uint) (*Role, error)

// GetAllBasePathsFromRoles returns all permission paths from user's roles
func GetAllBasePathsFromRoles(u *User) []string {
	basePaths := make([]string, 0)
	seen := make(map[string]struct{})

	for _, rid := range u.Role {
		if FetchRole == nil {
			continue
		}
		role, err := FetchRole(uint(rid))
		if err != nil || role == nil {
			continue
		}
		for _, entry := range role.PermissionScopes {
			if entry.Path == "" {
				continue
			}
			if _, ok := seen[entry.Path]; !ok {
				basePaths = append(basePaths, entry.Path)
				seen[entry.Path] = struct{}{}
			}
		}
	}
	return basePaths
}