state

Documentation

Index

• type InvalidStateError
  • func (e InvalidStateError) Error() string
• type State
  • func Generate() (State, error)
  • func (s *State) String() string
  • func (s *State) Validate(returnedState string) error

Types

type InvalidStateError

type InvalidStateError struct {
	Expected State
	Got      State
}

InvalidStateError is returned by Validate when the returned state is invalid.

func (InvalidStateError) Error

func (e InvalidStateError) Error() string

type State

type State string

State implements some utilities for working with OAuth2 state parameters.

func Generate

func Generate() (State, error)

Generate generates a new random state parameter of an appropriate size.

func (*State) String

func (s *State) String() string

String returns the string encoding of this state value.

func (*State) Validate

func (s *State) Validate(returnedState string) error

Validate the returned state (from a callback parameter).