idcheck

package module

v0.0.0-...-e4b661b Latest Latest Go to latest Published: Jul 10, 2018 License: MIT Imports: 4 Imported by: 4

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

Package idcheck generates ids that can be verified using the final byte as a checksum.

This section is empty.

This section is empty.

func SetIDReader(idReader io.Reader)

SetIDReader Sets the reader used to generate new IDs

func SetSalt(salt string)

SetSalt sets the salt to use in hash calculations

func ValidID(id *ID) bool

ValidID returns true if the ID has the correct length and checksum

type ID [length]byte

ID is an id

func FromBase64(str string) (*ID, error)

FromBase64 creates a new ID from a base64 encoded string

func NewID() (*ID, error)

NewID creates a new ID of default length with a random value

func (id *ID) Base64() string

Base64 encodes an ID as a base64 string

type IDChecker interface {
	NewID() (*ID, error)
	ValidID(id *ID) bool
}

IDChecker issues and validates IDs

func NewIDChecker(options ...Option) IDChecker

NewIDChecker returns a new IDChecker

type Option func(*idChecker)

Option is an option for creating IDs

func Reader(reader io.Reader) Option

Reader use reader to create new IDs instead of the default rand.Reader

func Salt(salt string) Option

Salt sets the salt to use in hash calculations