auth

README

Go-Auth

Go-Auth is a package that does a few things:

• Generate Bcrypt password hash
• Verify a Bcrypt passport
• Generate a JWT Token
• Validate a JWT Token
• Generate random SHA1 tokens

Documentation

Index

• Variables
• type BcryptHasher
  • func NewBCryptHasher() *BcryptHasher
  • func (b BcryptHasher) Hash(password []byte) ([]byte, error)
  • func (b BcryptHasher) VerifyPassword(correctPassword, password []byte) error
• type CustomClaim
• type IPasswordHasher
• type ITokenManager
• type MockHasher
  • func NewMockHasher() MockHasher
  • func (MockHasher) Hash(password []byte) ([]byte, error)
  • func (h MockHasher) VerifyPassword(correctPassword, password []byte) error
• type MockTokenManager
  • func NewMockTokenManager() MockTokenManager
  • func (m MockTokenManager) GenerateRandomToken() string
  • func (MockTokenManager) NewJWT(subject string) (*Tokens, error)
  • func (m MockTokenManager) ValidateJWT(token string) (*jwt.Token, string, error)
• type TokenManager
  • func NewTokenManager(signingKey string, audience string, issuer string, ...) (*TokenManager, error)
  • func (t *TokenManager) GenerateRandomToken() string
  • func (t *TokenManager) NewJWT(subject string) (*Tokens, error)
  • func (t *TokenManager) ValidateJWT(jwtToken string) (*jwt.Token, string, error)
• type Tokens

Variables

var (
	ErrJWTSigningKeyNotSet  = errors.New("jwt signing key not set")
	ErrInvalidSigningMethod = errors.New("invalid signing method")
	ErrExpiredJWTToken      = errors.New("expired JWT token")
	ErrInvalidJWTAudience   = errors.New("invalid jwt audience")
	ErrInvalidJWTIssuer     = errors.New("invalid jwt issuer")
	ErrInvalidSigningKey    = errors.New("invalid jwt signature")
)

Types

type BcryptHasher

type BcryptHasher struct {
	// contains filtered or unexported fields
}

func NewBCryptHasher

func NewBCryptHasher() *BcryptHasher

func (BcryptHasher) Hash

func (b BcryptHasher) Hash(password []byte) ([]byte, error)

func (BcryptHasher) VerifyPassword

func (b BcryptHasher) VerifyPassword(correctPassword, password []byte) error

type CustomClaim

type CustomClaim struct {
	*jwt.StandardClaims
	TokenType string
}

type IPasswordHasher

type IPasswordHasher interface {
	Hash(password []byte) ([]byte, error)
	VerifyPassword(correctPassword, password []byte) error
}

type ITokenManager

type ITokenManager interface {
	NewJWT(subject string) (*Tokens, error)
	ValidateJWT(token string) (*jwt.Token, string, error)
	GenerateRandomToken() string
}

type MockHasher

type MockHasher struct{}

MockHasher Mock of IPasswordHasher

func NewMockHasher

func NewMockHasher() MockHasher

func (MockHasher) Hash

func (MockHasher) Hash(password []byte) ([]byte, error)

func (MockHasher) VerifyPassword

func (h MockHasher) VerifyPassword(correctPassword, password []byte) error

type MockTokenManager

type MockTokenManager struct{}

func NewMockTokenManager

func NewMockTokenManager() MockTokenManager

func (MockTokenManager) GenerateRandomToken

func (m MockTokenManager) GenerateRandomToken() string

func (MockTokenManager) NewJWT

func (MockTokenManager) NewJWT(subject string) (*Tokens, error)

func (MockTokenManager) ValidateJWT

func (m MockTokenManager) ValidateJWT(token string) (*jwt.Token, string, error)

type TokenManager

type TokenManager struct {
	SigningKey               string
	Audience                 string
	Issuer                   string
	AccessTokenTimeToExpiry  time.Duration
	RefreshTokenTimeToExpiry time.Duration
}

func NewTokenManager

func NewTokenManager(signingKey string, audience string, issuer string,
	accessTokenTimeToExpiry, refreshTokenTimeToExpiry time.Duration) (*TokenManager, error)

func (*TokenManager) GenerateRandomToken

func (t *TokenManager) GenerateRandomToken() string

func (*TokenManager) NewJWT

func (t *TokenManager) NewJWT(subject string) (*Tokens, error)

func (*TokenManager) ValidateJWT

func (t *TokenManager) ValidateJWT(jwtToken string) (*jwt.Token, string, error)

type Tokens

type Tokens struct {
	AccessToken  string
	RefreshToken string
}