README
¶
crypter
import "github.com/alfred-landrum/crypter"
Overview
Package crypter provides convienence wrapping around the nacl/secretbox package.
Index
Package files
Constants
const (
KeySize = 32
// 24 bytes for nonce + minimum secretbox length
Overhead = 24 + secretbox.Overhead
)
Sizes and minimums set by secretbox
type Box
type Box struct {
Key [KeySize]byte
}
A Box is generated from a Key, and can encrypt & decrypt "small" messages, using nacl/secretbox.
func NewBox
func NewBox(key Key) (*Box, error)
NewBox creates a new crypter box from the given key, failing only if the key wasn't created from NewKey.
func (*Box) Decrypt
func (b *Box) Decrypt(data []byte) ([]byte, error)
Decrypt uses secretbox.Open to authenticate & decrypt data.
func (*Box) Encrypt
func (b *Box) Encrypt(data []byte) []byte
Encrypt uses secretbox.Seal to authenticate & encrypt the data.
type Key
type Key string
A Key is a base64 RawURLEncoded 32 byte sequence.
func NewKey
func NewKey() Key
NewKey generates a new appropriately sized key.
Generated by godoc2md
Documentation
¶
Overview ¶
Package crypter provides convienence wrapping around the nacl/secretbox package.
Index ¶
Constants ¶
const ( KeySize = 32 // 24 bytes for nonce + minimum secretbox length Overhead = 24 + secretbox.Overhead )
Sizes and minimums set by secretbox
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Box ¶
A Box is generated from a Key, and can encrypt & decrypt "small" messages, using nacl/secretbox.
func NewBox ¶
NewBox creates a new crypter box from the given key, failing only if the key wasn't created from NewKey.
Source Files