Documentation
¶
Overview ¶
Package identity provides functionality for generating and managing identifiers within a swarm. This includes entity identification, such as for Services, Tasks and Networks but also cryptographically-secure Node identities.
Random Identifiers ¶
Identifiers provided by this package are cryptographically-strong, random 128 bit numbers encoded in Base36. This method is preferred over UUID4 since it requires less storage and leverages the full 128 bits of entropy.
Generating an identifier is simple. Simply call the `NewID` function:
id := NewID()
If an error occurs while generating the ID, it will panic.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CombineTwoIDs ¶
CombineTwoIDs combines the given IDs into a new ID, e.g. a secret and a task ID.
func NewID ¶
func NewID() string
NewID generates a new identifier for use where random identifiers with low collision probability are required.
With the parameters in this package, the generated identifier will provide ~129 bits of entropy encoded with base36. Leading padding is added if the string is less 25 bytes. We do not intend to maintain this interface, so identifiers should be treated opaquely.
Types ¶
This section is empty.
Source Files