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

keyring: update handle to state inside replication loop #15227

Merged
merged 3 commits into from
Nov 17, 2022
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
3 changes: 3 additions & 0 deletions .changelog/15227.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
keyring: Fixed a bug where replication would stop after snapshot restores
```
29 changes: 6 additions & 23 deletions nomad/encrypter.go
Original file line number Diff line number Diff line change
Expand Up @@ -431,18 +431,13 @@ func (krr *KeyringReplicator) stop() {
krr.stopFn()
}

const keyringReplicationRate = 10
const keyringReplicationRate = 5

func (krr *KeyringReplicator) run(ctx context.Context) {
limiter := rate.NewLimiter(keyringReplicationRate, keyringReplicationRate)
krr.logger.Debug("starting encryption key replication")
defer krr.logger.Debug("exiting key replication")

retryErrTimer, stop := helper.NewSafeTimer(time.Second * 1)
defer stop()

START:
store := krr.srv.fsm.State()
limiter := rate.NewLimiter(keyringReplicationRate, keyringReplicationRate)

for {
select {
Expand All @@ -451,19 +446,17 @@ START:
case <-ctx.Done():
return
default:
// Rate limit how often we attempt replication
err := limiter.Wait(ctx)
if err != nil {
goto ERR_WAIT // rate limit exceeded
continue // rate limit exceeded
}

ws := store.NewWatchSet()
iter, err := store.RootKeyMetas(ws)
store := krr.srv.fsm.State()
iter, err := store.RootKeyMetas(nil)
if err != nil {
krr.logger.Error("failed to fetch keyring", "error", err)
goto ERR_WAIT
continue
}

for {
raw := iter.Next()
if raw == nil {
Expand All @@ -488,16 +481,6 @@ START:
}
}

ERR_WAIT:
retryErrTimer.Reset(1 * time.Second)

select {
case <-retryErrTimer.C:
goto START
case <-ctx.Done():
return
}

}

// replicateKey replicates a single key from peer servers that was present in
Expand Down
28 changes: 28 additions & 0 deletions nomad/encrypter_test.go
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
package nomad

import (
"bytes"
"context"
"os"
"path/filepath"
"testing"
"time"

msgpackrpc "github.com/hashicorp/net-rpc-msgpackrpc"
"github.com/shoenig/test/must"
"github.com/stretchr/testify/require"

"github.com/hashicorp/nomad/ci"
Expand Down Expand Up @@ -300,6 +302,32 @@ func TestEncrypter_KeyringReplication(t *testing.T) {
time.Second*5, time.Second,
"expected new servers to get replicated keys")

// Scenario: reload a snapshot

t.Logf("taking snapshot of node5")

snapshot, err := srv5.fsm.Snapshot()
must.NoError(t, err)

defer snapshot.Release()

// Persist so we can read it back
buf := bytes.NewBuffer(nil)
sink := &MockSink{buf, false}
must.NoError(t, snapshot.Persist(sink))

must.NoError(t, srv5.fsm.Restore(sink))

// rotate the key

err = msgpackrpc.CallWithCodec(codec, "Keyring.Rotate", rotateReq, &rotateResp)
require.NoError(t, err)
keyID4 := rotateResp.Key.KeyID

require.Eventually(t, checkReplicationFn(keyID4),
time.Second*5, time.Second,
"expected new servers to get replicated keys after snapshot restore")

}

func TestEncrypter_EncryptDecrypt(t *testing.T) {
Expand Down