Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
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
9 changes: 2 additions & 7 deletions api/client/proxy/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import (
transportv1pb "github.com/gravitational/teleport/api/gen/proto/go/teleport/transport/v1"
"github.com/gravitational/teleport/api/metadata"
"github.com/gravitational/teleport/api/utils/grpc/interceptors"
"github.com/gravitational/teleport/api/utils/keys"
)

// ClientConfig contains configuration needed for a Client
Expand Down Expand Up @@ -124,7 +125,7 @@ func (c *ClientConfig) CheckAndSetDefaults(ctx context.Context) error {
// before initiating the gRPC dial.
// This approach works because the connection is cached for a few seconds,
// allowing subsequent calls without requiring additional user action.
if priv, ok := cert.PrivateKey.(hardwareKeyWarmer); ok {
if priv, ok := cert.PrivateKey.(*keys.PrivateKey); ok {
err := priv.WarmupHardwareKey(ctx)
if err != nil {
return nil, trace.Wrap(err)
Expand Down Expand Up @@ -454,9 +455,3 @@ func (c *Client) Ping(ctx context.Context) error {
_, _ = c.transport.ClusterDetails(ctx)
return nil
}

// hardwareKeyWarmer performs a bogus call to the hardware key,
// to proactively prompt the user for a PIN/touch (if needed).
type hardwareKeyWarmer interface {
WarmupHardwareKey(ctx context.Context) error
}
3 changes: 2 additions & 1 deletion api/client/webclient/webclient.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import (
"github.com/gravitational/teleport/api/types"
"github.com/gravitational/teleport/api/utils"
"github.com/gravitational/teleport/api/utils/keys"
"github.com/gravitational/teleport/api/utils/keys/hardwarekey"
)

const (
Expand Down Expand Up @@ -528,7 +529,7 @@ type AuthenticationSettings struct {
// PrivateKeyPolicy contains the cluster-wide private key policy.
PrivateKeyPolicy keys.PrivateKeyPolicy `json:"private_key_policy"`
// PIVSlot specifies a specific PIV slot to use with hardware key support.
PIVSlot keys.PIVSlot `json:"piv_slot"`
PIVSlot hardwarekey.PIVSlotKeyString `json:"piv_slot"`
// DeviceTrust holds cluster-wide device trust settings.
DeviceTrust DeviceTrustSettings `json:"device_trust,omitempty"`
// HasMessageOfTheDay is a flag indicating that the cluster has MOTD
Expand Down
3 changes: 2 additions & 1 deletion api/profile/profile.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (
"github.com/gravitational/teleport/api/defaults"
"github.com/gravitational/teleport/api/utils/keypaths"
"github.com/gravitational/teleport/api/utils/keys"
"github.com/gravitational/teleport/api/utils/keys/hardwarekey"
"github.com/gravitational/teleport/api/utils/sshutils"
)

Expand Down Expand Up @@ -107,7 +108,7 @@ type Profile struct {
PrivateKeyPolicy keys.PrivateKeyPolicy `yaml:"private_key_policy"`

// PIVSlot is a specific piv slot that Teleport clients should use for hardware key support.
PIVSlot keys.PIVSlot `yaml:"piv_slot"`
PIVSlot hardwarekey.PIVSlotKeyString `yaml:"piv_slot"`

// MissingClusterDetails means this profile was created with limited cluster details.
// Missing cluster details should be loaded into the profile by pinging the proxy.
Expand Down
9 changes: 5 additions & 4 deletions api/types/authentication.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/gravitational/teleport/api/defaults"
"github.com/gravitational/teleport/api/utils"
"github.com/gravitational/teleport/api/utils/keys"
"github.com/gravitational/teleport/api/utils/keys/hardwarekey"
"github.com/gravitational/teleport/api/utils/tlsutils"
)

Expand Down Expand Up @@ -134,7 +135,7 @@ type AuthPreference interface {
// GetHardwareKey returns the hardware key settings configured for the cluster.
GetHardwareKey() (*HardwareKey, error)
// GetPIVSlot returns the configured piv slot for the cluster.
GetPIVSlot() keys.PIVSlot
GetPIVSlot() hardwarekey.PIVSlotKeyString
// GetHardwareKeySerialNumberValidation returns the cluster's hardware key
// serial number validation settings.
GetHardwareKeySerialNumberValidation() (*HardwareKeySerialNumberValidation, error)
Expand Down Expand Up @@ -491,9 +492,9 @@ func (c *AuthPreferenceV2) GetHardwareKey() (*HardwareKey, error) {
}

// GetPIVSlot returns the configured piv slot for the cluster.
func (c *AuthPreferenceV2) GetPIVSlot() keys.PIVSlot {
func (c *AuthPreferenceV2) GetPIVSlot() hardwarekey.PIVSlotKeyString {
if hk, err := c.GetHardwareKey(); err == nil {
return keys.PIVSlot(hk.PIVSlot)
return hardwarekey.PIVSlotKeyString(hk.PIVSlot)
}
return ""
}
Expand Down Expand Up @@ -840,7 +841,7 @@ func (c *AuthPreferenceV2) CheckAndSetDefaults() error {
}

if hk, err := c.GetHardwareKey(); err == nil && hk.PIVSlot != "" {
if err := keys.PIVSlot(hk.PIVSlot).Validate(); err != nil {
if err := hardwarekey.PIVSlotKeyString(hk.PIVSlot).Validate(); err != nil {
return trace.Wrap(err)
}
}
Expand Down
23 changes: 23 additions & 0 deletions api/utils/keys/alias.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*
Copyright 2025 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package keys

import "github.com/gravitational/teleport/api/utils/keys/hardwarekey"

// Temporary aliases for types moved to the hardwarekey or piv packages
// TODO(Joerger): Remove once /e no longer relies on them.

type AttestationStatement = hardwarekey.AttestationStatement

var AttestationStatementFromProto = hardwarekey.AttestationStatementFromProto
130 changes: 0 additions & 130 deletions api/utils/keys/cliprompt.go

This file was deleted.

50 changes: 50 additions & 0 deletions api/utils/keys/hardwarekey/attestation.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2025 Gravitational, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package hardwarekey

import (
"bytes"

"github.com/gogo/protobuf/jsonpb"
"github.com/gravitational/trace"

attestationv1 "github.com/gravitational/teleport/api/gen/proto/go/attestation/v1"
)

Copy link
Copy Markdown
Contributor Author

@Joerger Joerger Mar 31, 2025

Choose a reason for hiding this comment

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

This file was moved from hardwaresigner.go, no changes.

// AttestationStatement is an attestation statement for a hardware private key
// that supports json marshaling through the standard json/encoding package.
type AttestationStatement attestationv1.AttestationStatement

// ToProto converts this AttestationStatement to its protobuf form.
func (a *AttestationStatement) ToProto() *attestationv1.AttestationStatement {
return (*attestationv1.AttestationStatement)(a)
}

// AttestationStatementFromProto converts an AttestationStatement from its protobuf form.
func AttestationStatementFromProto(att *attestationv1.AttestationStatement) *AttestationStatement {
return (*AttestationStatement)(att)
}

// MarshalJSON implements custom protobuf json marshaling.
func (a *AttestationStatement) MarshalJSON() ([]byte, error) {
buf := new(bytes.Buffer)
err := (&jsonpb.Marshaler{}).Marshal(buf, a.ToProto())
return buf.Bytes(), trace.Wrap(err)
}

// UnmarshalJSON implements custom protobuf json unmarshaling.
func (a *AttestationStatement) UnmarshalJSON(buf []byte) error {
return (&jsonpb.Unmarshaler{AllowUnknownFields: true}).Unmarshal(bytes.NewReader(buf), a.ToProto())
}
Loading
Loading