crypt

package module

v1.0.0 Latest Latest Go to latest Published: Dec 12, 2019 License: MIT Imports: 6 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

Repository

github.com/rtctunnel/crypt

Links

Open Source Insights

README ¶

crypt

Documentation ¶

Index ¶

Constants
type Nonce
type PrivateKey
- func Generate() (PrivateKey, error)
- func NewPrivateKey(str string) (key PrivateKey, err error)
type PublicKey
- func NewPublicKey(str string) (key PublicKey, err error)

Constants ¶

View Source

const (
	// KeySize is the size of an encryption key in bytes
	KeySize = 32
	// NonceSize is the size of a nonce in bytes
	NonceSize = 24
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Nonce ¶

type Nonce = [NonceSize]byte

Nonce is a number used once.

type PrivateKey ¶

type PrivateKey [KeySize * 2]byte

PrivateKey is a private encryption key

func Generate ¶

func Generate() (PrivateKey, error)

Generate generates a new PrivateKey.

func NewPrivateKey ¶

func NewPrivateKey(str string) (key PrivateKey, err error)

NewKey creates a new key from a base58 string.

func (PrivateKey) Decrypt ¶

func (key PrivateKey) Decrypt(data []byte) (PublicKey, []byte, error)

Decrypt decrypts data that was encrypted via a private key. The peer's public key is sent along with the data.

func (PrivateKey) Encrypt ¶

func (key PrivateKey) Encrypt(peersPublicKey PublicKey, data []byte) []byte

Encrypt encrypts data using the private key intended for the peer public key.

func (PrivateKey) MarshalYAML ¶

func (key PrivateKey) MarshalYAML() (interface{}, error)

MarshalYAML marshales the key for use in a YAML file.

func (PrivateKey) PublicKey ¶

func (key PrivateKey) PublicKey() PublicKey

func (PrivateKey) String ¶

func (key PrivateKey) String() string

String returns the base58 encoded representation of the private key.

func (*PrivateKey) UnmarshalYAML ¶

func (key *PrivateKey) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshales the key from a YAML file.

type PublicKey ¶

type PublicKey [KeySize]byte

PublicKey is a public encryption key

func NewPublicKey ¶

func NewPublicKey(str string) (key PublicKey, err error)

NewKey creates a new key from a base58 string.

func (PublicKey) MarshalYAML ¶

func (key PublicKey) MarshalYAML() (interface{}, error)

MarshalYAML marshals the public key for a YAML file.

func (PublicKey) String ¶

func (key PublicKey) String() string

String returns the base58 encoded public key.

func (*PublicKey) UnmarshalYAML ¶

func (key *PublicKey) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals the public key from a YAML file.

Source Files ¶

View all Source files

crypt.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL