Skip to content

Adding support for rotating session recording encryption keys #57577

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.

Sign up for GitHub

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

Merged
eriktate merged 1 commit into from
Aug 26, 2025
Merged

Adding support for rotating session recording encryption keys #57577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions api/proto/teleport/legacy/types/types.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2485,9 +2485,9 @@ message ManualKeyManagementConfig {
// Enabled controls whether or recording encryption keys should be managed externally.
bool enabled = 1 [(gogoproto.jsontag) = "enabled,omitempty"];
// ActiveKeys describe which keys should be queried for active recording encryption and replay.
repeated KeyLabel active_keys = 2 [(gogoproto.jsontag) = "active_key,omitempty"];
repeated KeyLabel active_keys = 2 [(gogoproto.jsontag) = "active_keys,omitempty"];
// RotatedKeys describe which keys should be queried for historical replay.
repeated KeyLabel rotated_keys = 3 [(gogoproto.jsontag) = "rotated_key,omitempty"];
Comment on lines 2487 to -2490
Copy link
Copy Markdown
Contributor

@kopiczko kopiczko Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it safe to do that? Will that change be backward compatible?

Copy link
Copy Markdown
Contributor Author

@eriktate eriktate Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be since these fields haven't landed in a release just yet

repeated KeyLabel rotated_keys = 3 [(gogoproto.jsontag) = "rotated_keys,omitempty"];
}

// SessionRecordingEncryptionConfig configures if and how session recordings
Expand Down
3,046 changes: 1,523 additions & 1,523 deletions api/types/types.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/pages/reference/terraform-provider/data-sources/session_recording_config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,19 @@ Optional:

Optional:

- `active_key` (Attributes List) ActiveKeys describe which keys should be queried for active recording encryption and replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementactive_key))
- `active_keys` (Attributes List) ActiveKeys describe which keys should be queried for active recording encryption and replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementactive_keys))
- `enabled` (Boolean) Enabled controls whether or recording encryption keys should be managed externally.
- `rotated_key` (Attributes List) RotatedKeys describe which keys should be queried for historical replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementrotated_key))
- `rotated_keys` (Attributes List) RotatedKeys describe which keys should be queried for historical replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementrotated_keys))

### Nested Schema for `spec.encryption.manual_key_management.active_key`
### Nested Schema for `spec.encryption.manual_key_management.active_keys`

Optional:

- `label` (String) Label is a value that can be used with the related keystore in order to find relevant keys.
- `type` (String) Type represents which keystore should be searched when looking up keys by label.


### Nested Schema for `spec.encryption.manual_key_management.rotated_key`
### Nested Schema for `spec.encryption.manual_key_management.rotated_keys`

Optional:

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/reference/terraform-provider/resources/session_recording_config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,19 @@ Optional:

Optional:

- `active_key` (Attributes List) ActiveKeys describe which keys should be queried for active recording encryption and replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementactive_key))
- `active_keys` (Attributes List) ActiveKeys describe which keys should be queried for active recording encryption and replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementactive_keys))
- `enabled` (Boolean) Enabled controls whether or recording encryption keys should be managed externally.
- `rotated_key` (Attributes List) RotatedKeys describe which keys should be queried for historical replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementrotated_key))
- `rotated_keys` (Attributes List) RotatedKeys describe which keys should be queried for historical replay. (see [below for nested schema](#nested-schema-for-specencryptionmanual_key_managementrotated_keys))

### Nested Schema for `spec.encryption.manual_key_management.active_key`
### Nested Schema for `spec.encryption.manual_key_management.active_keys`

Optional:

- `label` (String) Label is a value that can be used with the related keystore in order to find relevant keys.
- `type` (String) Type represents which keystore should be searched when looking up keys by label.


### Nested Schema for `spec.encryption.manual_key_management.rotated_key`
### Nested Schema for `spec.encryption.manual_key_management.rotated_keys`

Optional:

Expand Down
24 changes: 12 additions & 12 deletions integrations/terraform/tfschema/types_terraform.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 7 additions & 6 deletions lib/auth/auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,12 @@ func NewServer(cfg *InitConfig, opts ...ServerOption) (as *Server, err error) {
}

recordingEncryptionManager, err := recordingencryption.NewManager(closeCtx, recordingencryption.ManagerConfig{
Backend: localRecordingEncryption,
Cache: localRecordingEncryption,
ClusterConfig: cfg.ClusterConfiguration,
KeyStore: cfg.KeyStore,
Logger: cfg.Logger,
Backend: localRecordingEncryption,
Cache: localRecordingEncryption,
ClusterConfig: cfg.ClusterConfiguration,
KeyStore: cfg.KeyStore,
Logger: cfg.Logger,
InitialSessionRecordingConfig: cfg.SessionRecordingConfig,
LockConfig: backend.RunWhileLockedConfig{
LockConfiguration: backend.LockConfiguration{
Backend: cfg.Backend,
Expand All @@ -281,7 +282,7 @@ func NewServer(cfg *InitConfig, opts ...ServerOption) (as *Server, err error) {
},
})
if err != nil {
return nil, trace.Wrap(err)
return nil, trace.Wrap(err, "initializing session recording encryption")
}

cfg.RecordingEncryption = recordingEncryptionManager
Expand Down
1 change: 1 addition & 0 deletions lib/auth/grpcserver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5824,6 +5824,7 @@ func NewGRPCServer(cfg GRPCServerConfig) (*GRPCServer, error) {
recordingEncryptionService, err := recordingencryptionv1.NewService(recordingencryptionv1.ServiceConfig{
Authorizer: cfg.Authorizer,
Uploader: cfg.AuthServer.Services,
KeyRotater: cfg.AuthServer.Services,
Logger: cfg.AuthServer.logger.With(teleport.ComponentKey, teleport.ComponentRecordingEncryption),
})
if err != nil {
Expand Down
2 changes: 2 additions & 0 deletions lib/auth/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ import (
"github.com/gravitational/teleport/lib/auth/machineid/machineidv1"
"github.com/gravitational/teleport/lib/auth/migration"
"github.com/gravitational/teleport/lib/auth/recordingencryption"
"github.com/gravitational/teleport/lib/auth/recordingencryption/recordingencryptionv1"
"github.com/gravitational/teleport/lib/auth/state"
"github.com/gravitational/teleport/lib/auth/summarizer"
"github.com/gravitational/teleport/lib/backend"
Expand Down Expand Up @@ -92,6 +93,7 @@ type VersionStorage interface {
type RecordingEncryptionManager interface {
services.RecordingEncryption
recordingencryption.KeyUnwrapper
recordingencryptionv1.KeyRotater
SetCache(cache recordingencryption.Cache)
}

Expand Down
Loading
Loading