auth

README

auth

bcrypt wrapper to provide auth structs and methods

Documentation

Overview

package auth wraps bcrypt to provide some basic functionality, adding a Token object which combines a distinct user id with that users secret to make a token in format <id>:<secret>

Index

• func Compare(hash string, plaintext string) (bool, error)
• func Cost(secret string) (int, error)
• func Hash(plaintext string, cost int) (string, error)
• func NewSecret(length int) (string, error)
• func NewToken(userID int, secret string) string
• type Token
  • func ParseToken(token string) (Token, error)
  • func (t *Token) Format() string

Functions

func Compare

func Compare(hash string, plaintext string) (bool, error)

Compare compares a provided string to an expected string. NOTE: make sure you're comparing *tokens* (<id>:<secret>) and not just the secret

func Cost

func Cost(secret string) (int, error)

Cost calculates the cost of the hash

func Hash

func Hash(plaintext string, cost int) (string, error)

Hash uses bcrypt to create a Hash from plaintext password

func NewSecret

func NewSecret(length int) (string, error)

NewSecret creates a new base64 encoded secret

func NewToken

func NewToken(userID int, secret string) string

NewToken formats into standard '<id>:<secret>'

Types

type Token

type Token struct {
	Id     int    // correlates with db: users.id
	Secret string // correlates with hashed db: users.hashed_secret
}

func ParseToken

func ParseToken(token string) (Token, error)

ParseToken takes a token in '<id>:<secret>' format and returns a Token struct

func (*Token) Format

func (t *Token) Format() string

Format takes 'id' and 'secret' and formats a string as '<id>:<secret>'