crypto

README

crypto

https://godoc.org/github.com/sermodigital/crypto

Documentation

Overview

Package crypto provides basic cryptographic routines.

Index

• func ClearSlice(buf ...[]byte)
• func Equal(a, b []byte) bool
• func EqualString(x, y string) bool
• func Key(pass, salt []byte) []byte
• func Shake256(data []byte) []byte
• func Shake256s(data string) []byte
• type Clearer
  • func NewClearer(buf ...[]byte) *Clearer
  • func (c *Clearer) Add()
  • func (c *Clearer) Clear()
  • func (c *Clearer) Done()

Functions

func ClearSlice

func ClearSlice(buf ...[]byte)

ClearSlice will zero each provided slice.

func Equal

func Equal(a, b []byte) bool

Equal returns true if a == b using constant time comparison.

func EqualString

func EqualString(x, y string) bool

Equal returns true if x == y using constant time comparison.

func Key

func Key(pass, salt []byte) []byte

Key calls a standardized scrypt.Key.

N = 1 << 15 (32768)
r = 8
p = 1
keylen = 32

It panics if scrypt.Key panics, but that will only happen if the constants are invalid. (Which won't happen.)

func Shake256

func Shake256(data []byte) []byte

Shake256 calls sha3.ShakeSum256 with 64 bytes of output.

func Shake256s

func Shake256s(data string) []byte

Shake256 calls sha3.ShakeSum256 with 64 bytes of output.

Types

type Clearer

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

Clearer allows deferred clearing of multiple slices while still allowing the slices to be used inside goroutines. Add should be called to add another reader to the Clearer. Once the slice is finished being used, Done should be called.

func NewClearer

func NewClearer(buf ...[]byte) *Clearer

NewClearer creates a new Clearer initialized with the provided byte slices.

func (*Clearer) Add

func (c *Clearer) Add()

func (*Clearer) Clear

func (c *Clearer) Clear()

Clear locks the Clearer and, if Clear has not already been executed, clears each slice it contains. Clear does not block so it need not be run in its own goroutine.

func (*Clearer) Done

func (c *Clearer) Done()