crypthlp

Documentation

Index

• Variables
• func Create(filename string, passphrase []byte, timeout time.Duration) (io.WriteCloser, error)
• func CreateWriter(w io.Writer, passphrase []byte, timeout time.Duration) (io.WriteCloser, error)
• func Salt(saltLen int) ([]byte, error)
• type Key
  • func GenKey(password []byte, saltLen, keyLen int, timeout time.Duration) (Key, error)
  • func Open(filename string, passphrase []byte) (Key, io.Reader, error)
  • func OpenReader(r io.Reader, passphrase []byte) (Key, io.Reader, error)
  • func (key Key) CreateWriter(w io.Writer) (io.WriteCloser, error)
  • func (key *Key) Populate(password []byte, keyLen int) error
  • func (key Key) String() string

Variables

var DefaultTimeout = 5 * time.Second

Functions

func Create

func Create(filename string, passphrase []byte, timeout time.Duration) (io.WriteCloser, error)

func CreateWriter

func CreateWriter(w io.Writer, passphrase []byte, timeout time.Duration) (io.WriteCloser, error)

func Salt

func Salt(saltLen int) ([]byte, error)

Salt creates a new random salt with the given length.

Types

type Key

type Key struct {
	Bytes []byte `json:"-"`
	Salt  []byte
	L2N   uint
	R, P  int
}

func GenKey

func GenKey(password []byte, saltLen, keyLen int, timeout time.Duration,
) (Key, error)

GenKey derives a key from the password, using scrypt. It tries to create the strongest key within the given time window.

func Open

func Open(filename string, passphrase []byte) (Key, io.Reader, error)

func OpenReader

func OpenReader(r io.Reader, passphrase []byte) (Key, io.Reader, error)

func (Key) CreateWriter

func (key Key) CreateWriter(w io.Writer) (io.WriteCloser, error)

func (*Key) Populate

func (key *Key) Populate(password []byte, keyLen int) error

func (Key) String

func (key Key) String() string