client

package

v0.3.2 Latest Latest Go to latest Published: Feb 16, 2024 License: MPL-2.0 Imports: 8 Imported by: 5

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 client provides utilities for handling client-side PGP keys.

This section is empty.

This section is empty.

This section is empty.

type Key struct {
	*pgp.Key
	// contains filtered or unexported fields
}

Key represents an OpenPGP client key pair associated with a context and an identity. It is stored on the filesystem.

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

KeyProvider handles loading/saving client keys.

func NewKeyProvider(dataFileDirectory string) *KeyProvider

NewKeyProvider creates a new KeyProvider.

func (provider *KeyProvider) DeleteKey(context, email string) error

DeleteKey deletes the key pair from disk.

func (provider *KeyProvider) GenerateKey(context, email, clientNameWithVersion string) (*Key, error)

GenerateKey generates a new PGP key pair.

func (provider *KeyProvider) ReadValidKey(context, email string) (*Key, error)

ReadValidKey reads a PGP key from the filesystem.

If the key is missing or invalid (e.g., expired, revoked), an error will be returned.

func (provider *KeyProvider) WriteKey(c *Key) (string, error)

WriteKey saves the key pair to disk and returns the save path.