File: identity.go

package info (click to toggle)
age-plugin-tpm 1.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 196 kB
  • sloc: makefile: 23
file content (219 lines) | stat: -rw-r--r-- 4,852 bytes parent folder | download | duplicates (2)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
package plugin

import (
	"bufio"
	"bytes"
	"crypto/ecdh"
	"encoding/binary"
	"errors"
	"fmt"
	"io"
	"strings"
	"time"

	"filippo.io/age"
	"filippo.io/age/plugin"
	"filippo.io/age/tag"
	"github.com/google/go-tpm/tpm2"
	"github.com/google/go-tpm/tpm2/transport"
)

// We need to know if the TPM handle has a pin set
type PINStatus uint8

const (
	NoPIN PINStatus = iota
	HasPIN
)

func (p PINStatus) String() string {
	switch p {
	case NoPIN:
		return "NoPIN"
	case HasPIN:
		return "HasPIN"
	}
	return "Not a PINStatus"
}

// Identity is the base Identity file for serialziation/deserialization
type Identity struct {
	Version uint8
	PIN     PINStatus
	Private tpm2.TPM2BPrivate
	Public  tpm2.TPM2BPublic
	SRKName *tpm2.TPM2BName

	// Private fields for implementation details
	publickey *ecdh.PublicKey
	p         *plugin.Plugin
	tpm       transport.TPMCloser
	pin       func() ([]byte, error)
}

var _ age.Identity = &Identity{}

func (i *Identity) checktpm() bool {
	// We need to check if we have passed a hw device
	// TODO: Figure out a better relationship between identities
	// identity -> TPM enabled identity -> ( TPMTagIdentity || TPMIdentity )
	return i.tpm == nil
}

func (i *Identity) Callbacks(plugin *plugin.Plugin, tpm transport.TPMCloser, pin func() ([]byte, error)) {
	i.p = plugin
	i.tpm = tpm
	i.pin = pin
}

func (i *Identity) Unwrap(stanzas []*age.Stanza) (fileKey []byte, err error) {
	if i.checktpm() {
		panic("missing tpm or age.Plugin access")
	}
	var resp age.Identity
	for _, stanza := range stanzas {
		switch stanza.Type {
		case "p256tag":
			resp = NewTPMTagIdentity(i.tpm, i.pin, i)
		case "tpm-ecc":
			if i.p != nil {
				if err := i.p.DisplayMessage("The file was encrypted with a previous version of age-plugin-tpm. Please re-encrypt the file!"); err != nil {
					return nil, fmt.Errorf("failed displaying message: %v", err)
				}
			}
			resp = NewTPMIdentity(i.tpm, i.pin, i)
		default:
			continue
		}
		fileKey, err := resp.Unwrap([]*age.Stanza{stanza})
		if errors.Is(err, age.ErrIncorrectIdentity) {
			continue
		}
		return fileKey, err
	}
	return nil, age.ErrIncorrectIdentity
}

func (i *Identity) Publickey() *ecdh.PublicKey {
	return i.publickey
}

func (i *Identity) Serialize() []any {
	return []interface{}{
		&i.Version,
		&i.PIN,
	}
}

func (i *Identity) TPMRecipient() *TPMRecipient {
	return NewTPMRecipient(i.publickey)
}

func (i *Identity) Recipient() (*tag.Recipient, error) {
	return NewTagRecipient(i.publickey)
}

func (i *Identity) HasPIN() bool {
	return i.PIN == HasPIN
}

func (i *Identity) String() string {
	var b bytes.Buffer
	for _, v := range i.Serialize() {
		binary.Write(&b, binary.BigEndian, v)
	}

	var pub []byte
	pub = append(pub, tpm2.Marshal(i.Public)...)
	pub = append(pub, tpm2.Marshal(i.Private)...)
	if i.Version > 1 {
		pub = append(pub, tpm2.Marshal(i.SRKName)...)
	}
	b.Write(pub)

	return plugin.EncodeIdentity(PluginName, b.Bytes())
}

func DecodeIdentity(s string) (*Identity, error) {
	var key Identity
	name, b, err := plugin.ParseIdentity(s)
	if err != nil {
		return nil, err
	}
	if name != PluginName {
		return nil, fmt.Errorf("invalid hrp")
	}
	r := bytes.NewBuffer(b)
	for _, f := range key.Serialize() {
		if err := binary.Read(r, binary.BigEndian, f); err != nil {
			return nil, err
		}
	}

	public, err := tpm2.Unmarshal[tpm2.TPM2BPublic](r.Bytes())
	if err != nil {
		return nil, fmt.Errorf("failed parsing TPMTPublic: %v", err)
	}
	r.Next(len(public.Bytes()) + 2)

	private, err := tpm2.Unmarshal[tpm2.TPM2BPrivate](r.Bytes())
	if err != nil {
		return nil, fmt.Errorf("failed parsing TPMTPrivate: %v", err)
	}
	r.Next(len(private.Buffer) + 2)

	key.Public = *public
	key.Private = *private

	// Parse out the public key early
	ecdhKey, err := PublicToECDH(*public)
	if err != nil {
		return nil, err
	}

	key.publickey = ecdhKey

	if key.Version > 1 {
		name, err := tpm2.Unmarshal[tpm2.TPM2BName](r.Bytes())
		if err != nil {
			return nil, err
		}
		key.SRKName = name
	}

	return &key, nil
}

func ParseIdentity(f io.Reader) (*Identity, error) {
	// Same parser as age
	const privateKeySizeLimit = 1 << 24 // 16 MiB
	scanner := bufio.NewScanner(io.LimitReader(f, privateKeySizeLimit))
	var n int
	for scanner.Scan() {
		n++
		line := scanner.Text()
		if strings.HasPrefix(line, "#") || line == "" {
			continue
		}

		identity, err := DecodeIdentity(line)
		if err != nil {
			return nil, fmt.Errorf("error at line %d: %v", n, err)
		}
		return identity, nil
	}
	return nil, fmt.Errorf("no identities found")
}

var marshalTemplate = `
# Created: %s
`

func MarshalIdentity(i *Identity, recipient fmt.Stringer, w io.Writer) error {
	s := fmt.Sprintf(marshalTemplate, time.Now())
	s = strings.TrimSpace(s)
	fmt.Fprintf(w, "%s\n", s)
	fmt.Fprintf(w, "# Recipient: %s\n", recipient.String())
	fmt.Fprintf(w, "\n%s\n", i.String())
	return nil
}