symmetric

package

v0.0.0-...-08edebc Latest Latest Go to latest Published: Sep 29, 2021 License: MIT Imports: 5 Imported by: 10

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

View Source

const (
	// NonceBytes is the length of GCM nonce.
	NonceBytes = 12

	// KeyBytes is the length of GCM key.
	KeyBytes = 32
)

This section is empty.

This section is empty.

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

Key is a wrapper for a symmetric key.

func FromBytes(k []byte) (*Key, error)

FromBytes returns a key by decoding bytes.

func FromString(k string) (*Key, error)

FromString returns a key by decoding a base32-encoded string.

func New() *Key

New returns Key if err is nil and panics otherwise.

func NewRandom() (*Key, error)

NewRandom returns a random key.

func (k *Key) Bytes() []byte

Bytes returns raw key bytes.

func (k *Key) Decrypt(ciphertext []byte) ([]byte, error)

Decrypt uses key to perform AES-256 GCM decryption on ciphertext.

func (k *Key) Encrypt(plaintext []byte) ([]byte, error)

Encrypt performs AES-256 GCM encryption on plaintext.

func (k *Key) MarshalBinary() ([]byte, error)

MarshalBinary implements BinaryMarshaler.

func (k *Key) String() string

String returns the base32-encoded string representation of raw key bytes.