The highest tagged major version is v2.

keys

package

v0.0.0-...-77d204d Latest Latest Go to latest Published: May 31, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package keys could be it's own thing between go-ssb and this but not today

This section is empty.

View Source

var SecretPerms = os.FileMode(0600)

func EncodeKeyPairAsJSON(kp KeyPair, w io.Writer) error

EncodeKeyPairAsJSON serializes the passed Keypair into the writer w

func IsValidFeedFormat(r refs.FeedRef) error

IsValidFeedFormat checks if the passed FeedRef is for one of the two supported formats, legacy/crapp or GabbyGrove.

func SaveKeyPair(kp KeyPair, path string) error

SaveKeyPair serializes the passed KeyPair to path. It errors if path already exists.

type KeyPair struct {
	Feed refs.FeedRef
	Pair secrethandshake.EdKeyPair
}

KeyPair contains a seret handshake keypair and the assosicated feed

func LoadKeyPair(fname string) (*KeyPair, error)

LoadKeyPair opens fname, ignores any line starting with # and passes it ParseKeyPair

func NewKeyPair(r io.Reader) (*KeyPair, error)

NewKeyPair generates a fresh KeyPair using the passed io.Reader as a seed. Passing nil is fine and will use crypto/rand.

func ParseKeyPair(r io.Reader) (*KeyPair, error)

ParseKeyPair json decodes an object from the reader. It expects std base64 encoded data under the `private` and `public` fields.