cryptoutil

README

cryptoutil

cryptoutil is a wrapper for some commonly used crypto functions

Documentation

Index

• Constants
• Variables
• func Decrypt(key *[KeyLen]byte, data []byte) ([]byte, error)
• func Encrypt(key *[KeyLen]byte, data []byte) ([]byte, error)
• func GenerateSalt() ([]byte, error)
• type Entity
  • func CreateEntity(name, comment, email string) (*Entity, error)
  • func LoadEntity(b []byte) (*Entity, error)
  • func (e *Entity) Encrypt(r io.Reader) ([]byte, error)
  • func (e *Entity) PrivateKey() ([]byte, error)
  • func (e *Entity) PublicKey() ([]byte, error)
  • func (e *Entity) Sign(r io.Reader) ([]byte, error)
  • func (e *Entity) UserID() *packet.UserId
  • func (e *Entity) Verify(r io.Reader, signature []byte) error
• type PublicKey
  • func LoadPublicKey(b []byte) (*PublicKey, error)
  • func (pub *PublicKey) Verify(r io.Reader, signature []byte) error
• type ScryptConfig
  • func DecodeScryptConfig(data []byte) (ScryptConfig, error)
  • func (config ScryptConfig) Decrypt(password string, data []byte) ([]byte, error)
  • func (config ScryptConfig) Derive(salt []byte, password string) (*[KeyLen]byte, error)
  • func (config ScryptConfig) Encode() []byte
  • func (config ScryptConfig) Encrypt(password string, data []byte) ([]byte, error)
  • func (config ScryptConfig) MemoryRequiredMB() int
  • func (config ScryptConfig) String() string
  • func (config ScryptConfig) TimeRequiredMS() (int, error)

Constants

const (
	SaltLen   = 32
	KeyLen    = 32
	NonceLen  = 24
	ScryptLen = 24
)

Variables

var ScryptConfigHigh = ScryptConfig{
	N: 1 << uint64(19),
	R: 8,
	P: 1,
}

ScryptConfigHigh requires 512MB RAM for less than 5 seconds (i7).

var ScryptConfigLow = ScryptConfig{
	N: 1 << uint64(17),
	R: 8,
	P: 1,
}

ScryptConfigLow requires 128MB RAM for about a second (i7).

var ScryptConfigMid = ScryptConfig{
	N: 1 << uint64(18),
	R: 8,
	P: 1,
}

ScryptConfigMid requires 256MB RAM for less than 5 seconds (i7).

var ScryptConfigParanoid = ScryptConfig{
	N: 1 << uint64(20),
	R: 8,
	P: 1,
}

ScryptConfigParanoid requires 1GB RAM for about 5 seconds (i7).

var ScryptConfigRealtime = ScryptConfig{
	N: 1 << uint64(15),
	R: 8,
	P: 1,
}

ScryptConfigRealtime requires 32MB RAM for under a second (i7).

Functions

func Decrypt

func Decrypt(key *[KeyLen]byte, data []byte) ([]byte, error)

panics if key is nil

func Encrypt

func Encrypt(key *[KeyLen]byte, data []byte) ([]byte, error)

func GenerateSalt

func GenerateSalt() ([]byte, error)

Types

type Entity

type Entity struct {
	PGP *openpgp.Entity
}

func CreateEntity

func CreateEntity(name, comment, email string) (*Entity, error)

func LoadEntity

func LoadEntity(b []byte) (*Entity, error)

func (*Entity) Encrypt

func (e *Entity) Encrypt(r io.Reader) ([]byte, error)

func (*Entity) PrivateKey

func (e *Entity) PrivateKey() ([]byte, error)

func (*Entity) PublicKey

func (e *Entity) PublicKey() ([]byte, error)

func (*Entity) Sign

func (e *Entity) Sign(r io.Reader) ([]byte, error)

func (*Entity) UserID

func (e *Entity) UserID() *packet.UserId

func (*Entity) Verify

func (e *Entity) Verify(r io.Reader, signature []byte) error

type PublicKey

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

func LoadPublicKey

func LoadPublicKey(b []byte) (*PublicKey, error)

func (*PublicKey) Verify

func (pub *PublicKey) Verify(r io.Reader, signature []byte) error

type ScryptConfig

type ScryptConfig struct {
	// CPU/memory cost parameter (logN)
	N uint64 `json:"n"`

	// block size parameter (octets)
	R uint64 `json:"r"`

	// parallelisation parameter (positive int)
	P uint64 `json:"p"`
}

func DecodeScryptConfig

func DecodeScryptConfig(data []byte) (ScryptConfig, error)

func (ScryptConfig) Decrypt

func (config ScryptConfig) Decrypt(password string, data []byte) ([]byte, error)

func (ScryptConfig) Derive

func (config ScryptConfig) Derive(salt []byte, password string) (*[KeyLen]byte, error)

func (ScryptConfig) Encode

func (config ScryptConfig) Encode() []byte

func (ScryptConfig) Encrypt

func (config ScryptConfig) Encrypt(password string, data []byte) ([]byte, error)

func (ScryptConfig) MemoryRequiredMB

func (config ScryptConfig) MemoryRequiredMB() int

func (ScryptConfig) String

func (config ScryptConfig) String() string

func (ScryptConfig) TimeRequiredMS

func (config ScryptConfig) TimeRequiredMS() (int, error)