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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
|
package agent
import (
"bytes"
"crypto/rand"
"errors"
"fmt"
"io"
"io/fs"
"log"
"log/slog"
"net"
"os"
"path/filepath"
"slices"
"strings"
"sync"
"time"
keyfile "github.com/foxboron/go-tpm-keyfiles"
"github.com/foxboron/ssh-tpm-agent/internal/keyring"
"github.com/foxboron/ssh-tpm-agent/key"
"github.com/foxboron/ssh-tpm-agent/utils"
"github.com/google/go-tpm/tpm2"
"github.com/google/go-tpm/tpm2/transport"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/agent"
"golang.org/x/text/cases"
"golang.org/x/text/language"
)
var (
ErrOperationUnsupported = errors.New("operation unsupported")
ErrNoMatchPrivateKeys = errors.New("no private keys match the requested public key")
)
var SSH_TPM_AGENT_ADD = "tpm-add-key"
type Agent struct {
mu sync.Mutex
tpm func() transport.TPMCloser
op func() ([]byte, error)
pin func(key.SSHTPMKeys) ([]byte, error)
listener *net.UnixListener
quit chan interface{}
wg sync.WaitGroup
keyring func() *keyring.ThreadKeyring
keys []key.SSHTPMKeys
hierkeys []*key.HierSSHTPMKey
agents []agent.ExtendedAgent
}
var _ agent.ExtendedAgent = &Agent{}
func (a *Agent) Extension(extensionType string, contents []byte) ([]byte, error) {
slog.Debug("called extensions")
switch extensionType {
case SSH_TPM_AGENT_ADD:
slog.Debug("runnning extension", slog.String("type", extensionType))
return a.AddTPMKey(contents)
}
return nil, agent.ErrExtensionUnsupported
}
func (a *Agent) AddTPMKey(addedkey []byte) ([]byte, error) {
slog.Debug("called addtpmkey")
a.mu.Lock()
defer a.mu.Unlock()
k, err := ParseTPMKeyMsg(addedkey)
if err != nil {
return nil, err
}
// delete the key if it already exists in the list
// it may have been loaded with no certificate or an old certificate
a.keys = slices.DeleteFunc(a.keys, func(kk key.SSHTPMKeys) bool {
return bytes.Equal(k.AgentKey().Marshal(), kk.AgentKey().Marshal())
})
a.keys = append(a.keys, k)
return []byte(""), nil
}
func (a *Agent) AddProxyAgent(es agent.ExtendedAgent) error {
// TODO: Write this up as an extension
slog.Debug("called addproxyagent")
a.mu.Lock()
defer a.mu.Unlock()
a.agents = append(a.agents, es)
return nil
}
func (a *Agent) Close() error {
slog.Debug("called close")
// Flush hierarchy keys
for _, k := range a.hierkeys {
k.FlushHandle(a.tpm())
}
a.Stop()
return nil
}
func (a *Agent) signers() ([]ssh.Signer, error) {
var signers []ssh.Signer
for _, agent := range a.agents {
l, err := agent.Signers()
if err != nil {
slog.Info("failed getting Signers from agent", slog.String("error", err.Error()))
continue
}
signers = append(signers, l...)
}
for _, k := range a.keys {
s, err := ssh.NewSignerFromSigner(k.Signer(
a.keyring(), a.op, a.tpm,
func(_ *keyfile.TPMKey) ([]byte, error) {
// Shimming the function to get the correct type
return a.pin(k)
}),
)
if err != nil {
return nil, fmt.Errorf("failed to prepare signer: %w", err)
}
signers = append(signers, s)
}
return signers, nil
}
func (a *Agent) Signers() ([]ssh.Signer, error) {
slog.Debug("called signers")
a.mu.Lock()
defer a.mu.Unlock()
return a.signers()
}
func (a *Agent) List() ([]*agent.Key, error) {
slog.Debug("called list")
var agentKeys []*agent.Key
a.mu.Lock()
defer a.mu.Unlock()
// Our keys first, then proxied agents
for _, k := range a.keys {
agentKeys = append(agentKeys, k.AgentKey())
}
for _, agent := range a.agents {
l, err := agent.List()
if err != nil {
slog.Info("failed getting list from agent", slog.String("error", err.Error()))
continue
}
agentKeys = append(agentKeys, l...)
}
return agentKeys, nil
}
func (a *Agent) SignWithFlags(key ssh.PublicKey, data []byte, flags agent.SignatureFlags) (*ssh.Signature, error) {
slog.Debug("called signwithflags")
a.mu.Lock()
defer a.mu.Unlock()
signers, err := a.signers()
if err != nil {
return nil, err
}
var wantKey []byte
wantKey = key.Marshal()
alg := key.Type()
// Unwrap the ssh.Certificate PublicKey
if strings.Contains(alg, "cert") {
parsedCert, err := ssh.ParsePublicKey(wantKey)
if err != nil {
return nil, err
}
cert, ok := parsedCert.(*ssh.Certificate)
if ok {
wantKey = cert.Key.Marshal()
alg = cert.Key.Type()
}
}
switch {
case alg == ssh.KeyAlgoRSA && flags&agent.SignatureFlagRsaSha256 != 0:
alg = ssh.KeyAlgoRSASHA256
case alg == ssh.KeyAlgoRSA && flags&agent.SignatureFlagRsaSha512 != 0:
alg = ssh.KeyAlgoRSASHA512
}
for _, s := range signers {
if !bytes.Equal(s.PublicKey().Marshal(), wantKey) {
continue
}
return s.(ssh.AlgorithmSigner).SignWithAlgorithm(rand.Reader, data, alg)
}
slog.Debug("trying to sign as proxy...")
for _, agent := range a.agents {
signers, err := agent.Signers()
if err != nil {
slog.Info("failed getting signers from agent", slog.String("error", err.Error()))
continue
}
for _, s := range signers {
if !bytes.Equal(s.PublicKey().Marshal(), wantKey) {
continue
}
return s.(ssh.AlgorithmSigner).SignWithAlgorithm(rand.Reader, data, alg)
}
}
return nil, ErrNoMatchPrivateKeys
}
func (a *Agent) Sign(key ssh.PublicKey, data []byte) (*ssh.Signature, error) {
slog.Debug("called sign")
return a.SignWithFlags(key, data, 0)
}
func (a *Agent) serveConn(c net.Conn) {
if err := agent.ServeAgent(a, c); err != io.EOF {
slog.Info("Agent client connection ended unsuccessfully", slog.String("error", err.Error()))
}
}
func (a *Agent) Wait() {
a.wg.Wait()
}
func (a *Agent) Stop() {
close(a.quit)
a.listener.Close()
a.wg.Wait()
}
func (a *Agent) serve() {
defer a.wg.Done()
for {
c, err := a.listener.AcceptUnix()
if err != nil {
type temporary interface {
Temporary() bool
Error() string
}
if err, ok := err.(temporary); ok && err.Temporary() {
slog.Info("Temporary Accept failure, sleeping 1s", slog.String("error", err.Error()))
time.Sleep(1 * time.Second)
continue
}
select {
case <-a.quit:
return
default:
slog.Error("Failed to accept connections", slog.String("error", err.Error()))
}
}
a.wg.Add(1)
go func() {
a.serveConn(c)
a.wg.Done()
}()
}
}
func (a *Agent) AddKey(k *key.SSHTPMKey) error {
slog.Debug("called addkey")
a.keys = append(a.keys, k)
return nil
}
func (a *Agent) LoadKeys(keys []key.SSHTPMKeys) {
slog.Debug("called loadkeys")
a.mu.Lock()
defer a.mu.Unlock()
a.keys = append(a.keys, keys...)
}
func (a *Agent) AddHierarchyKeys(hier string) error {
tpm := a.tpm()
h, err := utils.GetParentHandle(hier)
if err != nil {
log.Fatal(err)
}
for n, t := range map[string]struct {
alg tpm2.TPMAlgID
}{
"rsa": {alg: tpm2.TPMAlgRSA},
"ecdsa": {alg: tpm2.TPMAlgECC},
} {
slog.Info("hierarchy key", slog.String("algorithm", strings.ToUpper(n)), slog.String("hierarchy", hier))
hkey, err := key.CreateHierarchyKey(tpm, t.alg, h, fmt.Sprintf("%s hierarchy key", cases.Title(language.Und, cases.NoLower).String(hier)))
if err != nil {
return err
}
a.mu.Lock()
a.hierkeys = append(a.hierkeys, hkey)
a.keys = append(a.keys, hkey)
a.mu.Unlock()
}
return nil
}
func (a *Agent) Add(key agent.AddedKey) error {
// This just proxies the Add call to all proxied agents
// First to accept gets the key!
slog.Debug("called add")
for _, agent := range a.agents {
if err := agent.Add(key); err == nil {
return nil
}
}
return nil
}
func (a *Agent) Remove(sshkey ssh.PublicKey) error {
slog.Debug("called remove")
a.mu.Lock()
defer a.mu.Unlock()
var found bool
a.keys = slices.DeleteFunc(a.keys, func(k key.SSHTPMKeys) bool {
if bytes.Equal(sshkey.Marshal(), k.AgentKey().Marshal()) {
slog.Debug("deleting key from ssh-tpm-agent",
slog.String("fingerprint", ssh.FingerprintSHA256(sshkey)),
slog.String("type", sshkey.Type()),
)
found = true
return true
}
return false
})
if found {
return nil
}
for _, agent := range a.agents {
lkeys, err := agent.List()
if err != nil {
slog.Debug("agent returned err on List()", slog.Any("err", err))
continue
}
for _, k := range lkeys {
if !bytes.Equal(k.Marshal(), sshkey.Marshal()) {
continue
}
if err := agent.Remove(sshkey); err != nil {
slog.Debug("agent returned err on Remove()", slog.Any("err", err))
}
slog.Debug("deleting key from an proxy agent",
slog.String("fingerprint", ssh.FingerprintSHA256(sshkey)),
slog.String("type", sshkey.Type()),
)
return nil
}
}
slog.Debug("could not find key in any proxied agent",
slog.String("fingerprint", ssh.FingerprintSHA256(sshkey)),
slog.String("type", sshkey.Type()),
)
return fmt.Errorf("key not found")
}
func (a *Agent) RemoveAll() error {
slog.Debug("called removeall")
a.mu.Lock()
defer a.mu.Unlock()
a.keys = []key.SSHTPMKeys{}
for _, agent := range a.agents {
if err := agent.RemoveAll(); err == nil {
return nil
}
}
return nil
}
func (a *Agent) Lock(passphrase []byte) error {
slog.Debug("called lock")
return ErrOperationUnsupported
}
func (a *Agent) Unlock(passphrase []byte) error {
slog.Debug("called unlock")
return ErrOperationUnsupported
}
func LoadKeys(keyDir string) ([]key.SSHTPMKeys, error) {
keyDir, err := filepath.EvalSymlinks(keyDir)
if err != nil {
return nil, err
}
var keys []key.SSHTPMKeys
walkFunc := func(path string, d fs.DirEntry, err error) error {
if err != nil {
return err
}
if d.IsDir() {
return nil
}
if !strings.HasSuffix(path, ".tpm") {
slog.Debug("skipping key: does not have .tpm suffix", slog.String("name", path))
return nil
}
f, err := os.ReadFile(path)
if err != nil {
return fmt.Errorf("failed reading %s", path)
}
k, err := key.Decode(f)
if err != nil {
if errors.Is(err, key.ErrOldKey) {
slog.Info("TPM key is in an old format. Will not load it.", slog.String("key_path", path), slog.String("error", err.Error()))
} else {
slog.Debug("not a TPM sealed key", slog.String("key_path", path), slog.String("error", err.Error()))
}
return nil
}
keys = append(keys, k)
slog.Debug("added TPM key", slog.String("name", path))
certStr := fmt.Sprintf("%s-cert.pub", strings.TrimSuffix(path, filepath.Ext(path)))
if _, err := os.Stat(certStr); !errors.Is(err, os.ErrNotExist) {
b, err := os.ReadFile(certStr)
if err != nil {
return err
}
pubKey, _, _, _, err := ssh.ParseAuthorizedKey(b)
if err != nil {
return err
}
cert, ok := pubKey.(*ssh.Certificate)
if !ok {
return err
}
c := *k
c.Certificate = cert
keys = append(keys, &c)
slog.Debug("added certificate", slog.String("name", path))
}
return nil
}
err = filepath.WalkDir(keyDir, walkFunc)
return keys, err
}
func NewAgent(listener *net.UnixListener, agents []agent.ExtendedAgent, keyring func() *keyring.ThreadKeyring, tpmFetch func() transport.TPMCloser, ownerPassword func() ([]byte, error), pin func(key.SSHTPMKeys) ([]byte, error)) *Agent {
a := &Agent{
agents: agents,
tpm: tpmFetch,
op: ownerPassword,
listener: listener,
pin: pin,
quit: make(chan interface{}),
keys: []key.SSHTPMKeys{},
hierkeys: []*key.HierSSHTPMKey{},
keyring: keyring,
}
a.wg.Add(1)
go a.serve()
return a
}
|