auth

package

v0.0.0-...-ee3211a Latest Latest Go to latest Published: Jun 6, 2022 License: AGPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var Protected = 2

View Source

var WriteProtected = 1

func ComparePassword(hash string, password string) bool

ComparePassword compares a hash and a password, returning true on match

type Claims struct {
	NotebookID string `json:"notebook_id"`
	jwt.StandardClaims
}

type Hasher struct {
	Cost int
}

func NewHasher() *Hasher

func (h *Hasher) HashPassword(password string) (string, error)

HashPassword hashes a password

type Issuer struct {
	SigningKey []byte
}

func NewIssuer(key string) *Issuer

NewIssuer returns a new configured JWT issuer

func (issuer *Issuer) Issue(id string) (string, error)

Issue issues a new JWT

func (issuer *Issuer) Validate(token string) (*Claims, error)

Validate tries to validate a JWT, returning Claims or an error

func (issuer *Issuer) ValidateNotebook(token string, notebookID string) bool

ValidateNotebook validates if a token grants authorized access to a notebook

type ProtectionLevel uint8

func (p ProtectionLevel) Protected() bool

Protected checks if notebook is protected, meaning authentication is required to see and motify its contents.

func (p ProtectionLevel) WriteProtected() bool

WriteProtected checks if notebook is protected against writes, i.e. is read only by unauthenticated users.