database

Documentation

Index

• Variables
• func ComputeHash(password string, salt []byte) []byte
• func CreateInstance(connectionString string) error
• func Migrate()
• type User
  • func NewUser(username, password string) (*User, error)
  • func (user *User) ChangePassword(password string)
  • func (user *User) CheckPassword(password string) bool

Variables

var Instance *gorm.DB

Instance is a shared, global Gorm instance. Initialize with CreateInstance.

Functions

func ComputeHash

func ComputeHash(password string, salt []byte) []byte

ComputeHash computes a hash for a given password and salt combination.

func CreateInstance

func CreateInstance(connectionString string) error

CreateInstance creates a global Gorm instance.

func Migrate

func Migrate()

Migrate automatically creates the necessary database structure for all models.

Types

type User

type User struct {
	gorm.Model
	Username       string `gorm:"unique;index"`
	HashedPassword []byte
	PasswordSalt   []byte
}

User represents a single Okra user.

func NewUser

func NewUser(username, password string) (*User, error)

NewUser creates a new user.

func (*User) ChangePassword

func (user *User) ChangePassword(password string)

ChangePassword changes a user's password.

func (*User) CheckPassword

func (user *User) CheckPassword(password string) bool

CheckPassword checks a provided password against the stored password for a given user.