entity

type BoxPrivateKey ¶

type BoxPrivateKey *[32]byte

BoxPrivateKey represents an Entity's crypto private key for public-key cryptography that is interoperable with NaCl: https://nacl.cr.yp.to/box.html.

type BoxPublicKey ¶

type BoxPublicKey *[32]byte

BoxPublicKey represents an Entity's public key for public-key cryptography that is interoperable with NaCl: https://nacl.cr.yp.to/box.html.

See: https://godoc.org/golang.org/x/crypto/nacl/box

type Domain ¶

type Domain struct {
	DomainID
	Name
	ParentID DomainID
	// BoxPublicKey is used to exchange encrypted messages with the Domain
	BoxPublicKey  BoxPublicKey
	SignPublicKey SignPublicKey
}

Domain is used to represent an Entity domain. Domains can form a hierarchy, i.e., all Domains have a parent Domain, except for the root Domain.

func (d Domain) IsRoot() bool

type DomainID ¶

type DomainID ulid.ULID

DomainID is used as the Entity's domain ID

func (d DomainID) IsZero() bool

type Entity ¶

type Entity struct {
	// DomainID for the Entity owner
	DomainID
	ID
	// Name is the unique Entity name within
	Name
	// BoxPublicKey is used to exchange encrypted messages
	BoxPublicKey BoxPublicKey
}

Entity represents any entity instance for a given Class

type ID ¶

type ID ulid.ULID

ID is used as the Entity identifier. The ID timestamp correlates to when the Entity was created.

type Name ¶

type Name string

Name is used to assign a user friendly name for an Entity

type SignPrivateKey ¶

type SignPrivateKey *[64]byte

SignPrivateKey represents an Entity's crypto private key for signing messages.

See: https://godoc.org/golang.org/x/crypto/nacl/sign

type SignPublicKey ¶

type SignPublicKey *[32]byte

SignPublicKey is the public key used to verify signatures

See: https://godoc.org/golang.org/x/crypto/nacl/sign

type SignedULID ¶

type SignedULID []byte

SignedULID is a signed ULID

func SignULID(id ulid.ULID, key SignPrivateKey) SignedULID

func (su SignedULID) Open(key SignPublicKey) (id ulid.ULID, ok bool)