neckless

Documentation

Index

• func GetGems(pkms []*member.PrivateMember, nl *necklace.Necklace) ([]*gem.Gem, []error)
• func GetPkms(a GetPkmsArgs) ([]*member.PrivateMember, error)
• func Neckless(gitCommit string, version string)
• type CasketArgs
• type CasketCreateArgs
• type CasketGetArgs
• type CasketRmArgs
• type FlatKeyValue
• type GemAddArgs
• type GemArgs
• type GemLsArgs
• type GetPkmsArgs
• type GpgArgs
• type KeyValueArgs
• type KeyValueLsArgs
• type NecklessArgs
• type NecklessIO
• type NecklessOutput
• type NecklessOutputs

Functions

func GetGems

func GetGems(pkms []*member.PrivateMember, nl *necklace.Necklace) ([]*gem.Gem, []error)

GetGems retrievs the gems from the neckless

func GetPkms

func GetPkms(a GetPkmsArgs) ([]*member.PrivateMember, error)

GetPkms retrievs the privateMembers from the casket

func Neckless

func Neckless(gitCommit string, version string)

Types

type CasketArgs

type CasketArgs struct {
	Fname string
	// contains filtered or unexported fields
}

CasketArgs the global args of the casket command

type CasketCreateArgs

type CasketCreateArgs struct {
	Name       string
	DryRun     *bool
	DeviceName string
	Email      string
	DeviceType *bool
	PersonType *bool
	ValidUntil string
}

CasketCreateArgs the args of the create command

type CasketGetArgs

type CasketGetArgs struct {
	PubFile    string
	PrivateKey *bool
	Device     *bool
	Person     *bool
	KeyValue   *bool
}

CasketGetArgs the args of the get command

type CasketRmArgs

type CasketRmArgs struct {
	DryRun *bool
}

CasketRmArgs the args of the rm command

type FlatKeyValue

type FlatKeyValue struct {
	Key   string
	Value string
	Tags  []string
}

FlatKeyValue defines result of kv ls command

type GemAddArgs

type GemAddArgs struct {
	PubFile  string
	Device   *bool
	Person   *bool
	KeyValue *bool
	ToKeyIds []string
}

GemAddArgs defines arguments for the gem add command

type GemArgs

type GemArgs struct {
	Fname       string
	CasketFname string
	PrivKeyIds  []string
	Add         GemAddArgs
	Ls          GemLsArgs
}

GemArgs defines the global arguments for the gem command

type GemLsArgs

type GemLsArgs struct {
	Device *bool
	Person *bool
}

GemLsArgs defines arguments for the gem ls command

type GetPkmsArgs

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

GetPkmsArgs are the args for the api to retrieve the private key and member information

type GpgArgs

type GpgArgs struct {
	KeyIDFormat string
	StatusFd    int
	Verify      string
	Sign        bool
	DetachSign  bool
	Armor       bool
	UserID      string
	GpgCli      string
}

GpgArgs defines the global args to mock a gpg command

type KeyValueArgs

type KeyValueArgs struct {
	Fname       string
	CasketFname string
	PrivKeyIds  *[]string
	PrivKeyEnv  string
	PrivKeyVal  string
	Ls          KeyValueLsArgs
}

KeyValueArgs defines the global arguments

type KeyValueLsArgs

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

KeyValueLsArgs defines the arguments to the kv ls command

type NecklessArgs

type NecklessArgs struct {
	GitCommit string
	Version   string
	Nio       NecklessIO
	Casket    CasketArgs
	Kvs       KeyValueArgs
	Gems      GemArgs
	Gpg       GpgArgs
}

NecklessArgs defines the global args of the neckless command

type NecklessIO

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

NecklessIO defines the io for the application

type NecklessOutput

type NecklessOutput struct {
	Size  int
	Name  string
	Perm  os.FileMode
	Error error
	// contains filtered or unexported fields
}

NecklessOutput defines the structure of an output to a file or stdout/stderr this is needed for testing or multiple outputs of a kv ls command

type NecklessOutputs

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

NecklessOutputs defines the list of requested outputs