Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement concurrency in GPG agent server #61

Merged
merged 3 commits into from
Sep 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deploy/piv-agent.service
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Description=piv-agent service

[Service]
ExecStart=piv-agent serve --debug --agent-types=ssh=0;gpg=1
ExecStart=piv-agent serve --agent-types=ssh=0;gpg=1
11 changes: 6 additions & 5 deletions internal/assuan/assuan_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package assuan_test

import (
"bytes"
"context"
"crypto"
"crypto/ecdsa"
"encoding/hex"
Expand Down Expand Up @@ -153,7 +154,7 @@ func TestSign(t *testing.T) {
}
}
// start the state machine
if err := a.Run(); err != nil {
if err := a.Run(context.Background()); err != nil {
tt.Fatal(err)
}
// check the responses
Expand Down Expand Up @@ -226,7 +227,7 @@ func TestKeyinfo(t *testing.T) {
}
}
// start the state machine
if err := a.Run(); err != nil {
if err := a.Run(context.Background()); err != nil {
tt.Fatal(err)
}
// check the responses
Expand Down Expand Up @@ -349,7 +350,7 @@ func TestDecryptRSAKeyfile(t *testing.T) {
}
}
// start the state machine
if err := a.Run(); err != nil {
if err := a.Run(context.Background()); err != nil {
tt.Fatal(err)
}
// check the responses
Expand Down Expand Up @@ -447,7 +448,7 @@ func TestSignRSAKeyfile(t *testing.T) {
}
}
// start the state machine
if err := a.Run(); err != nil {
if err := a.Run(context.Background()); err != nil {
tt.Fatal(err)
}
// check the responses
Expand Down Expand Up @@ -533,7 +534,7 @@ func TestReadKey(t *testing.T) {
}
}
// start the state machine
if err := a.Run(); err != nil {
if err := a.Run(context.Background()); err != nil {
tt.Fatal(err)
}
// check the responses
Expand Down
8 changes: 7 additions & 1 deletion internal/assuan/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,24 @@ package assuan

import (
"bytes"
"context"
"fmt"
"io"
)

// Run the event machine loop
func (a *Assuan) Run() error {
func (a *Assuan) Run(ctx context.Context) error {
// register connection
if err := a.Occur(connect); err != nil {
return fmt.Errorf("error handling connect: %w", err)
}
var e Event
for {
// check for cancellation
if err := ctx.Err(); err != nil {
return err
}
// get the next command. returns at latest after conn deadline expiry.
line, err := a.reader.ReadBytes(byte('\n'))
if err != nil {
if err == io.EOF {
Expand Down
23 changes: 15 additions & 8 deletions internal/server/gpg.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (
"go.uber.org/zap"
)

const connTimeout = 4 * time.Minute

// GPG represents a gpg-agent server.
type GPG struct {
log *zap.Logger
Expand Down Expand Up @@ -39,26 +41,31 @@ func (g *GPG) Serve(ctx context.Context, l net.Listener, exit *time.Ticker,
timeout time.Duration) error {
// start serving connections
conns := accept(g.log, l)
g.log.Debug("accepted gpg-agent connection")
for {
select {
case conn, ok := <-conns:
if !ok {
return fmt.Errorf("listen socket closed")
}
g.log.Debug("accepted gpg-agent connection")
// reset the exit timer
exit.Reset(timeout)
// if the client stops responding for 300 seconds, give up.
if err := conn.SetDeadline(time.Now().Add(300 * time.Second)); err != nil {
// if the client takes too long, give up
if err := conn.SetDeadline(time.Now().Add(connTimeout)); err != nil {
return fmt.Errorf("couldn't set deadline: %v", err)
}
// init protocol state machine
a := assuan.New(conn, g.log, g.pivKeyService, g.gpgKeyService)
// run the protocol state machine to completion
// (client severs connection)
if err := a.Run(); err != nil {
return err
}
// this goroutine will exit by either:
// * client severs connection (the usual case)
// * conn deadline reached (client stopped responding)
// err will be non-nil in this case.
go func() {
// run the protocol state machine to completion
if err := a.Run(ctx); err != nil {
g.log.Error("gpg-agent error", zap.Error(err))
}
}()
case <-ctx.Done():
return nil
}
Expand Down
2 changes: 1 addition & 1 deletion internal/server/ssh.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func (s *SSH) Serve(ctx context.Context, a *ssh.Agent, l net.Listener,
s.log.Debug("start serving SSH connection")
if err := agent.ServeAgent(a, conn); err != nil {
if errors.Is(err, io.EOF) {
s.log.Debug("finish serving connection")
s.log.Debug("finish serving SSH connection")
continue
}
return fmt.Errorf("ssh Serve error: %w", err)
Expand Down