summaryrefslogtreecommitdiffstats
path: root/internal/entropy/entropy.go
blob: 886ecba4c3b9e04859870b812943515f8fdaf301 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
package entropy

import (
	crand "crypto/rand"
	"crypto/sha512"
	"encoding/binary"
	"errors"
	"fmt"
	"io"
	"sync"
)

const blockSize = sha512.Size

var ErrExternalEntropyRequired = errors.New("external entropy source required")

type HybridOptions struct {
	RequireExternal bool
}

type HybridReader struct {
	base            io.Reader
	external        io.Reader
	requireExternal bool

	mu         sync.Mutex
	counter    uint64
	degraded   bool
	degradeErr error
	buffer     []byte
}

func NewHybridReader(base io.Reader, external io.Reader, opts HybridOptions) (*HybridReader, error) {
	if base == nil {
		base = crand.Reader
	}
	if external == nil {
		return nil, ErrExternalEntropyRequired
	}

	return &HybridReader{
		base:            base,
		external:        external,
		requireExternal: opts.RequireExternal,
	}, nil
}

func (r *HybridReader) Read(p []byte) (int, error) {
	if len(p) == 0 {
		return 0, nil
	}

	r.mu.Lock()
	defer r.mu.Unlock()

	written := 0
	for written < len(p) {
		if len(r.buffer) > 0 {
			n := copy(p[written:], r.buffer)
			written += n
			r.buffer = r.buffer[n:]
			continue
		}

		block, err := r.nextBlockLocked()
		if err != nil {
			return written, err
		}

		n := copy(p[written:], block[:])
		written += n
		if n < len(block) {
			r.buffer = append(r.buffer[:0], block[n:]...)
		}
	}

	return written, nil
}

func (r *HybridReader) Degraded() bool {
	r.mu.Lock()
	defer r.mu.Unlock()
	return r.degraded
}

func (r *HybridReader) DegradeError() error {
	r.mu.Lock()
	defer r.mu.Unlock()
	return r.degradeErr
}

func (r *HybridReader) nextBlockLocked() ([blockSize]byte, error) {
	var base [blockSize]byte
	if _, err := io.ReadFull(r.base, base[:]); err != nil {
		return [blockSize]byte{}, fmt.Errorf("read OS CSPRNG: %w", err)
	}

	if r.degraded {
		return base, nil
	}

	var external [blockSize]byte
	if _, err := io.ReadFull(r.external, external[:]); err != nil {
		if r.requireExternal {
			return [blockSize]byte{}, fmt.Errorf("read external entropy: %w", err)
		}
		r.degraded = true
		r.degradeErr = err
		return base, nil
	}

	var counter [8]byte
	binary.BigEndian.PutUint64(counter[:], r.counter)
	r.counter++

	h := sha512.New()
	h.Write([]byte("qpass hybrid entropy v1\x00"))
	h.Write(counter[:])
	h.Write(base[:])
	h.Write(external[:])

	var out [blockSize]byte
	copy(out[:], h.Sum(nil))
	return out, nil
}

func InstallGlobal(reader io.Reader) func() {
	if reader == nil {
		reader = crand.Reader
	}
	previous := crand.Reader
	crand.Reader = reader
	return func() {
		crand.Reader = previous
	}
}