jointoken

Documentation

Overview

Package jointoken implements siderolink jointoken parser.

Package jointoken implements siderolink jointoken parser.

Index

• type ExtraData
• type JoinToken
  • func NewPlain(token string) JoinToken
  • func NewWithExtraData(token string, extraData map[string]string) (JoinToken, error)
  • func Parse(value string) (JoinToken, error)
  • func (t JoinToken) Encode() (string, error)
  • func (t JoinToken) IsValid(token string) bool
• type NodeUniqueToken
  • func NewNodeUniqueToken(fingerprint, token string) *NodeUniqueToken
  • func ParseNodeUniqueToken(data string) (*NodeUniqueToken, error)
  • func (t *NodeUniqueToken) Encode() (string, error)
  • func (t *NodeUniqueToken) Equal(other *NodeUniqueToken) bool
  • func (t *NodeUniqueToken) HasToken() bool
  • func (t *NodeUniqueToken) IsSameFingerprint(other *NodeUniqueToken) bool

Types

type ExtraData

type ExtraData map[string]string

ExtraData is the type of the extra token data.

type JoinToken

type JoinToken struct {
	ExtraData ExtraData `json:"extra_data"`

	Signature []byte `json:"signature"`
	// contains filtered or unexported fields
}

JoinToken is the siderolink join token. Custom type adds methods for encoding/decoding extra data from the token.

func NewPlain

func NewPlain(token string) JoinToken

NewPlain token creates the token without extra data.

func NewWithExtraData

func NewWithExtraData(token string, extraData map[string]string) (JoinToken, error)

NewWithExtraData creates the token with extra data.

func Parse

func Parse(value string) (JoinToken, error)

Parse reads string into token.

func (JoinToken) Encode

func (t JoinToken) Encode() (string, error)

Encode the token into string.

func (JoinToken) IsValid

func (t JoinToken) IsValid(token string) bool

IsValid checks the signature or plain token.

type NodeUniqueToken

type NodeUniqueToken struct {
	Fingerprint string
	Token       string
}

NodeUniqueToken represents a join token generated for a specific node.

func NewNodeUniqueToken

func NewNodeUniqueToken(fingerprint, token string) *NodeUniqueToken

NewNodeUniqueToken creates the node unique token.

func ParseNodeUniqueToken

func ParseNodeUniqueToken(data string) (*NodeUniqueToken, error)

ParseNodeUniqueToken from the marshaled version.

func (*NodeUniqueToken) Encode

func (t *NodeUniqueToken) Encode() (string, error)

Encode the node unique token to bytes representation.

func (*NodeUniqueToken) Equal

func (t *NodeUniqueToken) Equal(other *NodeUniqueToken) bool

Equal is true when the token part is equal.

func (*NodeUniqueToken) HasToken

func (t *NodeUniqueToken) HasToken() bool

HasToken is true when the token field isn't empty.

func (*NodeUniqueToken) IsSameFingerprint

func (t *NodeUniqueToken) IsSameFingerprint(other *NodeUniqueToken) bool

IsSameFingerprint checks if the tokens have the same fingerprint.