crypto: golang.org/x/crypto/hkdf Index | Examples | Files

package hkdf

import "golang.org/x/crypto/hkdf"

Package hkdf implements the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) as defined in RFC 5869.

HKDF is a cryptographic key derivation function (KDF) with the goal of expanding limited input keying material into one or more cryptographically strong secret keys.

RFC 5869: https://tools.ietf.org/html/rfc5869

Usage example that expands one master key into three other cryptographically secure keys.

Code:

// Underlying hash function to use
hash := sha256.New

// Cryptographically secure master key.
master := []byte{0x00, 0x01, 0x02, 0x03} // i.e. NOT this.

// Non secret salt, optional (can be nil)
// Recommended: hash-length sized random
salt := make([]byte, hash().Size())
n, err := io.ReadFull(rand.Reader, salt)
if n != len(salt) || err != nil {
    fmt.Println("error:", err)
    return
}

// Non secret context specific info, optional (can be nil).
// Note, independent from the master key.
info := []byte{0x03, 0x14, 0x15, 0x92, 0x65}

// Create the key derivation function
hkdf := hkdf.New(hash, master, salt, info)

// Generate the required keys
keys := make([][]byte, 3)
for i := 0; i < len(keys); i++ {
    keys[i] = make([]byte, 24)
    n, err := io.ReadFull(hkdf, keys[i])
    if n != len(keys[i]) || err != nil {
        fmt.Println("error:", err)
        return
    }
}

// Keys should contain 192 bit random keys
for i := 1; i <= len(keys); i++ {
    fmt.Printf("Key #%d: %v\n", i, !bytes.Equal(keys[i-1], make([]byte, 24)))
}

Output:

Key #1: true
Key #2: true
Key #3: true

Index

Examples

Package Files

hkdf.go

func New Uses

func New(hash func() hash.Hash, secret, salt, info []byte) io.Reader

New returns a new HKDF using the given hash, the secret keying material to expand and optional salt and info fields.

Package hkdf imports 4 packages (graph) and is imported by 47 packages. Updated 2017-04-26. Refresh now. Tools for package owners.