auth

Documentation

Overview

Package auth determines and asserts client permissions to access and modify server resources.

Index

• Variables
• func BcryptCompare(password string, hash []byte) error
• func BcryptHash(password string, rounds int) ([]byte, error)
• func GetIP(req *http.Request) string
• func IsBoard(board string) bool
• func IsNonMetaBoard(board string) bool
• func RandomID(length int) (string, error)
• type Ident
  • func LookUpIdent(req *http.Request) Ident
• type Session
• type User

Variables

var (
	// IsReverseProxied specifies, if the server is deployed behind a reverse
	// proxy.
	IsReverseProxied bool

	// ReverseProxyIP specifies the IP of a non-localost reverse proxy. Used for
	// filtering in XFF IP determination.
	ReverseProxyIP string
)

Functions

func BcryptCompare

func BcryptCompare(password string, hash []byte) error

BcryptCompare compares a bcrypt hash with a user-suplied string

func BcryptHash

func BcryptHash(password string, rounds int) ([]byte, error)

BcryptHash generates a bcrypt hash from the passed string

func GetIP

func GetIP(req *http.Request) string

GetIP extracts the IP of a request, honouring reverse proxies, if set

func IsBoard

func IsBoard(board string) bool

IsBoard confirms the string is a valid board

func IsNonMetaBoard

func IsNonMetaBoard(board string) bool

IsNonMetaBoard returns wheather a valid board is a classic board and not some other path that emulates a board

func RandomID

func RandomID(length int) (string, error)

RandomID generates a randomID of base64 characters of desired byte length

Types

type Ident

type Ident struct {
	UserID string
	IP     string
}

Ident is used to verify a client's access and write permissions. Contains its IP and logged in user data, if any.

func LookUpIdent

func LookUpIdent(req *http.Request) Ident

LookUpIdent determine access rights of an IP

type Session

type Session struct {
	Token   string    `gorethink:"token"`
	Expires time.Time `gorethink:"expires"`
}

Session contains the token and expiry time of a single authenticated login session

type User

type User struct {
	ID       string    `gorethink:"id"`
	Password []byte    `gorethink:"password"`
	Sessions []Session `gorethink:"sessions"`
}

User contains ID, password hash and board-related data of a registered user account