admin

Documentation

Index

• Variables
• type AdminUser
  • func (a *AdminUser) CheckPassword(rawPassword string) error
  • func (a *AdminUser) SetPassword(rawPassword string) error
• type Session
  • func (s *Session) GenerateSessionToken() error
• type TunnelUser
  • func (t *TunnelUser) RotateSecretKey() string
• type UserService
  • func NewUserService(store *gorm.DB) *UserService
  • func (u *UserService) CanCreateSuperUser(ctx context.Context) error
  • func (u *UserService) CreateAdminUser(ctx context.Context, email, password string) (*AdminUser, error)
  • func (u *UserService) CreateSuperUser(ctx context.Context, email, password string) (*AdminUser, error)
  • func (u *UserService) CreateTunnelUser(ctx context.Context, email string) (*TunnelUser, error)
  • func (u *UserService) CreateUser(ctx context.Context, email, password string, superUser bool) (*AdminUser, error)
  • func (u *UserService) DeleteTunnelUser(ctx context.Context, id uint) error
  • func (u *UserService) GetTunnelUserBySecret(ctx context.Context, secretKey string) (*TunnelUser, error)
  • func (u *UserService) GetUserConnectionStatus(ctx context.Context) ([]TunnelUser, error)
  • func (u *UserService) ListTunnelUsers(ctx context.Context) ([]TunnelUser, error)
  • func (u *UserService) Login(ctx context.Context, email, password string) (string, error)
  • func (u *UserService) Logout(ctx context.Context, sessionToken string) error
  • func (u *UserService) RotateTunnelUserSecretKey(ctx context.Context, email string) (*TunnelUser, error)
  • func (u *UserService) SetActiveConnection(ctx context.Context, tunnelUser *TunnelUser) error
  • func (u *UserService) SetInactiveConnectionStatusForUsers(ctc context.Context, userIdentifiers ...string) error
  • func (u *UserService) ValidateSession(ctx context.Context, sessionToken string) (*AdminUser, error)

Variables

var (
	ErrWrongPassword  = errors.New("wrong password")
	ErrWrongSecretKey = errors.New("wrong secret key")
)

var ErrAdminUserNotFound = errors.New("admin user does not exist")

var ErrDuplicateAdminUser = errors.New("admin user with the same email exists")

var ErrDuplicateTunnelUser = errors.New("tunnel user with the same email exists")

var ErrInvalidUserSession = errors.New("invalid user session")

var ErrMultipleSuperuserError = errors.New("you cannot create more than one superuser")

var ErrTunnelUserNotFound = errors.New("tunnel user does not exist")

var ErrWrongEmailOrPassword = errors.New("wrong email or password")

Types

type AdminUser

type AdminUser struct {
	gorm.Model

	Email        string `gorm:"index,unique"`
	PasswordHash string `gorm:"unique" json:"-"`
	SuperUser    bool

	Session Session
}

func (*AdminUser) CheckPassword

func (a *AdminUser) CheckPassword(rawPassword string) error

func (*AdminUser) SetPassword

func (a *AdminUser) SetPassword(rawPassword string) error

type Session

type Session struct {
	gorm.Model

	Token       string `gorm:"index, unique"`
	AdminUserId uint
}

func (*Session) GenerateSessionToken

func (s *Session) GenerateSessionToken() error

type TunnelUser

type TunnelUser struct {
	gorm.Model

	Email        string  `gorm:"index,unique"`
	SecretKey    *string `gorm:"index,unique" json:"-"`
	Active       bool
	LastActiveAt *time.Time
}

func (*TunnelUser) RotateSecretKey

func (t *TunnelUser) RotateSecretKey() string

type UserService

type UserService struct {
	DB *gorm.DB
}

func NewUserService

func NewUserService(store *gorm.DB) *UserService

func (*UserService) CanCreateSuperUser

func (u *UserService) CanCreateSuperUser(ctx context.Context) error

func (*UserService) CreateAdminUser

func (u *UserService) CreateAdminUser(ctx context.Context, email, password string) (*AdminUser, error)

func (*UserService) CreateSuperUser

func (u *UserService) CreateSuperUser(ctx context.Context, email, password string) (*AdminUser, error)

func (*UserService) CreateTunnelUser

func (u *UserService) CreateTunnelUser(ctx context.Context, email string) (*TunnelUser, error)

func (*UserService) CreateUser

func (u *UserService) CreateUser(ctx context.Context, email, password string, superUser bool) (*AdminUser, error)

func (*UserService) DeleteTunnelUser

func (u *UserService) DeleteTunnelUser(ctx context.Context, id uint) error

func (*UserService) GetTunnelUserBySecret

func (u *UserService) GetTunnelUserBySecret(ctx context.Context, secretKey string) (*TunnelUser, error)

func (*UserService) GetUserConnectionStatus

func (u *UserService) GetUserConnectionStatus(ctx context.Context) ([]TunnelUser, error)

func (*UserService) ListTunnelUsers

func (u *UserService) ListTunnelUsers(ctx context.Context) ([]TunnelUser, error)

func (*UserService) Login

func (u *UserService) Login(ctx context.Context, email, password string) (string, error)

func (*UserService) Logout

func (u *UserService) Logout(ctx context.Context, sessionToken string) error

func (*UserService) RotateTunnelUserSecretKey

func (u *UserService) RotateTunnelUserSecretKey(ctx context.Context, email string) (*TunnelUser, error)

func (*UserService) SetActiveConnection

func (u *UserService) SetActiveConnection(ctx context.Context, tunnelUser *TunnelUser) error

func (*UserService) SetInactiveConnectionStatusForUsers

func (u *UserService) SetInactiveConnectionStatusForUsers(ctc context.Context, userIdentifiers ...string) error

func (*UserService) ValidateSession

func (u *UserService) ValidateSession(ctx context.Context, sessionToken string) (*AdminUser, error)