gss

Documentation

Index

• Constants
• Variables
• type CBFlag
  • func (flag CBFlag) IsValid() bool
  • func (flag CBFlag) String() string
• type Header
  • func NewHeader() *Header
  • func NewHeaderFromString(str string) (*Header, error)
  • func NewHeaderFromStrings(props []string) (*Header, error)
  • func (header *Header) AuthzID() string
  • func (header *Header) CBFlag() CBFlag
  • func (header *Header) CBName() string
  • func (header *Header) Equals(other *Header) bool
  • func (header *Header) HasStdFlag() bool
  • func (header *Header) NonStdFlag() bool
  • func (header *Header) ParseString(str string) error
  • func (header *Header) ParseStrings(props []string) error
  • func (header *Header) SetAuthzID(authzID string)
  • func (header *Header) SetCBFlag(flag CBFlag)
  • func (header *Header) SetCBFlagWithName(flag CBFlag, name string)
  • func (header *Header) String() string

Constants

const (
	ClientSupportsUsedCBSFlag   = CBFlag('p')
	ClientDoesNotSupportCBSFlag = CBFlag('n')
	ClientSupportsCBSFlag       = CBFlag('y')
)

const (
	GS2PropertyMaxCount = 3
	GS2NonStdFlag       = "F"
	GS2AuthzidPrefix    = "a="
)

Variables

var ErrInvalidHeader = errors.New("invalid header")

ErrInvalidHeader is returned when the header is invalid.

Types

type CBFlag

type CBFlag rune

CBFlag represents a channel binding flag.

func (CBFlag) IsValid

func (flag CBFlag) IsValid() bool

IsValid returns true if the flag is valid.

func (CBFlag) String

func (flag CBFlag) String() string

String returns a string representation of the flag.

type Header

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

Header represents a GS2 header.

func NewHeader

func NewHeader() *Header

NewHeader creates a new header.

func NewHeaderFromString

func NewHeaderFromString(str string) (*Header, error)

NewHeaderFromString creates a new header from the string.

func NewHeaderFromStrings

func NewHeaderFromStrings(props []string) (*Header, error)

NewHeaderFromString creates a new header from the property strings.

func (*Header) AuthzID

func (header *Header) AuthzID() string

AuthzID returns the authorization identity.

func (*Header) CBFlag

func (header *Header) CBFlag() CBFlag

CBFlag returns the channel binding flag.

func (*Header) CBName

func (header *Header) CBName() string

func (*Header) Equals

func (header *Header) Equals(other *Header) bool

Equals returns true if the header is equal to the other header.

func (*Header) HasStdFlag

func (header *Header) HasStdFlag() bool

HasStdFlag returns true if the header has a standard flag.

func (*Header) NonStdFlag

func (header *Header) NonStdFlag() bool

NonStdFlag returns true if the header has a non-standard flag.

func (*Header) ParseString

func (header *Header) ParseString(str string) error

ParseString parses the header string.

func (*Header) ParseStrings

func (header *Header) ParseStrings(props []string) error

ParseStrings parses the header property strings.

func (*Header) SetAuthzID

func (header *Header) SetAuthzID(authzID string)

SetAuthzID sets the authorization identity.

func (*Header) SetCBFlag

func (header *Header) SetCBFlag(flag CBFlag)

SetCBFlag sets the channel binding flag.

func (*Header) SetCBFlagWithName

func (header *Header) SetCBFlagWithName(flag CBFlag, name string)

SetCBFlagWithName sets the channel binding flag with the name.

func (*Header) String

func (header *Header) String() string

String returns the header properties.