oaktoken

Documentation

Overview

Package oaktoken provides a secure random string factory that can be used for session or other types of tokens.

Index

• func FastRandom(n int) string
• type Factory
  • func New(withOptions ...Option) (Factory, error)
  • func NewURLToken(entropyByteCount int) (Factory, error)
• type Option
  • func WithBodyCharacterSet(set []byte) Option
  • func WithDefaultOptions() Option
  • func WithEdgeCharacterSet(set []byte) Option
  • func WithTokenEdgeLength(l int) Option
  • func WithTokenLength(l int) Option

Functions

func FastRandom

func FastRandom(n int) string

FastRandom is inspired by Ketan Parmar's work:

- https://github.com/kpbird/golang_random_string/blob/master/main.go - https://kpbird.medium.com/golang-generate-fixed-size-random-string-dd6dbd5e63c0

Types

type Factory

type Factory func() (string, error)

func New

func New(withOptions ...Option) (Factory, error)

func NewURLToken

func NewURLToken(entropyByteCount int) (Factory, error)

type Option

type Option func(*options) error

func WithBodyCharacterSet

func WithBodyCharacterSet(set []byte) Option

func WithDefaultOptions

func WithDefaultOptions() Option

func WithEdgeCharacterSet

func WithEdgeCharacterSet(set []byte) Option

func WithTokenEdgeLength

func WithTokenEdgeLength(l int) Option

func WithTokenLength

func WithTokenLength(l int) Option