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

secrets/db: improves error logs for static role rotation #22253

Merged
merged 3 commits into from
Aug 8, 2023
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
31 changes: 18 additions & 13 deletions builtin/logical/database/rotation.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,7 @@ func (b *databaseBackend) populateQueue(ctx context.Context, s logical.Storage)
log.Warn("unable to delete WAL", "error", err, "WAL ID", walEntry.walID)
}
} else {
log.Info("found WAL for role",
"role", item.Key,
"WAL ID", walEntry.walID)
log.Info("found WAL for role", "role", item.Key, "WAL ID", walEntry.walID)
item.Value = walEntry.walID
item.Priority = time.Now().Unix()
}
Expand Down Expand Up @@ -190,39 +188,45 @@ func (b *databaseBackend) rotateCredential(ctx context.Context, s logical.Storag
return false
}

roleName := item.Key
logger := b.Logger().With("role", roleName)

// Grab the exclusive lock for this Role, to make sure we don't incur and
// writes during the rotation process
lock := locksutil.LockForKey(b.roleLocks, item.Key)
lock := locksutil.LockForKey(b.roleLocks, roleName)
lock.Lock()
defer lock.Unlock()

// Validate the role still exists
role, err := b.StaticRole(ctx, s, item.Key)
role, err := b.StaticRole(ctx, s, roleName)
if err != nil {
b.logger.Error("unable to load role", "role", item.Key, "error", err)
logger.Error("unable to load role", "error", err)

item.Priority = time.Now().Add(10 * time.Second).Unix()
if err := b.pushItem(item); err != nil {
b.logger.Error("unable to push item on to queue", "error", err)
logger.Error("unable to push item on to queue", "error", err)
}
return true
}
if role == nil {
b.logger.Warn("role not found", "role", item.Key, "error", err)
logger.Warn("role not found", "error", err)
return true
}

logger = logger.With("database", role.DBName)

// If "now" is less than the Item priority, then this item does not need to
// be rotated
if time.Now().Unix() < item.Priority {
if err := b.pushItem(item); err != nil {
b.logger.Error("unable to push item on to queue", "error", err)
logger.Error("unable to push item on to queue", "error", err)
}
// Break out of the for loop
return false
}

input := &setStaticAccountInput{
RoleName: item.Key,
RoleName: roleName,
Role: role,
}

Expand All @@ -234,7 +238,8 @@ func (b *databaseBackend) rotateCredential(ctx context.Context, s logical.Storag

resp, err := b.setStaticAccount(ctx, s, input)
if err != nil {
b.logger.Error("unable to rotate credentials in periodic function", "error", err)
logger.Error("unable to rotate credentials in periodic function", "error", err)

// Increment the priority enough so that the next call to this method
// likely will not attempt to rotate it, as a back-off of sorts
item.Priority = time.Now().Add(10 * time.Second).Unix()
Expand All @@ -245,7 +250,7 @@ func (b *databaseBackend) rotateCredential(ctx context.Context, s logical.Storag
}

if err := b.pushItem(item); err != nil {
b.logger.Error("unable to push item on to queue", "error", err)
logger.Error("unable to push item on to queue", "error", err)
}
// Go to next item
return true
Expand All @@ -262,7 +267,7 @@ func (b *databaseBackend) rotateCredential(ctx context.Context, s logical.Storag
nextRotation := lvr.Add(role.StaticAccount.RotationPeriod)
item.Priority = nextRotation.Unix()
if err := b.pushItem(item); err != nil {
b.logger.Warn("unable to push item on to queue", "error", err)
logger.Warn("unable to push item on to queue", "error", err)
}
return true
}
Expand Down
3 changes: 3 additions & 0 deletions changelog/22253.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
secrets/database: Improves error logging for static role rotations by including the database and role names.
```