secure

package

v0.31.0 Latest Latest Go to latest Published: Jul 10, 2018 License: BSD-3-Clause Imports: 3 Imported by: 12

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 secure is a wrapper package around memguard for managing data which must not be swapped to disk or easily read via a memory scanner.

This section is empty.

View Source

var ErrSecretNotFound = errors.New("Could not find secret to remove it")

ErrSecretNotFound occurs when a secret could not be found

This section is empty.

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

Guard is a controller of guarded memory which contains many different secrets. Only one guard can exist at a time.

func NewGuard() *Guard

NewGuard returns a Guard instance or errors if a guard already exists.

func (g *Guard) Destroy()

Destroy removes all secrets and cleans up everything up appropriately.

func (g *Guard) Random(size int) (*Secret, error)

Random returns a new secret of the given length in bytes.

func (g *Guard) Secret(v []byte) (*Secret, error)

Secret returns a new secret for the given value, the given byte slice will be wiped *after* the secret has been moved into secure memory.

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

Secret represent a specific guraded piece of memory

func (s *Secret) Buffer() []byte

Buffer returns an array of bytes referencing the underlying secure memory.

func (s *Secret) Destroy()

Destroy properly dispenses of the underlying secret stored in secure memory.