types

type CID ¶

type CID [tiger.Size]byte

CID (Client ID) globally and publicly identify a unique client and underlie client to client communication.

They are generated by hashing the (unencoded) PID with the session hash algorithm.

Hubs should register clients by CID. CID length follows the length of the hash algorithm used for the session. Clients must be prepared to handle CIDs of varying lengths.

func MustParseCID(s string) (out CID)

func MustParseCIDP(s string) *CID

func (id *CID) FromBase32(s string) error

func (id CID) Hash() CID

func (id CID) IsZero() bool

func (id CID) MarshalAdc() ([]byte, error)

func (id CID) MarshalText() ([]byte, error)

func (id CID) String() string

func (id CID) ToBase32() string

func (id *CID) UnmarshalAdc(s []byte) error

func (id *CID) UnmarshalText(text []byte) error

type PID ¶

type PID = CID

PID (Private ID) globally identify a unique client.

They function during initial protocol negotiation to generate the CID and are invisible to other clients. PIDs should be generated in a way to avoid collisions, for example using the hash of the current time and primary network card MAC address if sufficient randomness cannot be generated.

Hubs and clients may not disclose PIDs to other clients; doing so weakens the security of the ADC network. Clients should should keep the same PID between sessions and hubs. PID length follows the length of the hash algorithm used for the session.

func NewPID() (id PID)

type SID ¶

type SID [4]byte

SID (Session ID) appears in all communication that interacts with the hub. They identify a unique user on a single hub and are assigned by the hub during initial protocol negotiation. SIDs are 20 bits long and encoded using a 4-byte base32 encoded string.

func SIDFromInt(v uint32) (id SID)

func SIDFromString(s string) (id SID)

func (id SID) MarshalAdc() ([]byte, error)

func (id SID) String() string

func (id *SID) UnmarshalAdc(s []byte) error