Skip to content

feat: Hardware Key Agent - Enrich the PEM encoded hardware private key file#53675

Merged
Joerger merged 7 commits intomasterfrom
joerger/enrich-hardware-key-ref
Apr 10, 2025
Merged

feat: Hardware Key Agent - Enrich the PEM encoded hardware private key file#53675
Joerger merged 7 commits intomasterfrom
joerger/enrich-hardware-key-ref

Conversation

@Joerger
Copy link
Copy Markdown
Contributor

@Joerger Joerger commented Apr 2, 2025

Part of RFD 199

Enrich the PEM encoded hardware private key file, with fallback logic for old, non-enriched private key files.

This makes it so we only need to attest the key during login. This shaves off ~500ms from all non-login commands. It's also necessary when the client is using a hardware key agent to avoid falling back to the direct PIV implementation.

Depends on #53674

@github-actions github-actions Bot requested review from espadolini and greedy52 April 2, 2025 21:07
@Joerger Joerger force-pushed the joerger/hardware-key-service-reduced branch from 4729e97 to a986b49 Compare April 2, 2025 23:52
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch from 13b8a60 to 2e84db7 Compare April 3, 2025 00:28
@Joerger Joerger added the no-changelog Indicates that a PR does not require a changelog entry label Apr 3, 2025
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch 2 times, most recently from 34b2917 to 53a74a9 Compare April 3, 2025 01:36
@Joerger Joerger changed the title Enrich the PEM encoded hardware private key file feat: Hardware Key Agent - Enrich the PEM encoded hardware private key file Apr 3, 2025
@Joerger Joerger force-pushed the joerger/hardware-key-service-reduced branch from 6ce5204 to 5846f51 Compare April 5, 2025 01:08
Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
// Sign performs a cryptographic signature using the specified hardware
// private key and provided signature parameters.
Sign(ctx context.Context, ref *PrivateKeyRef, rand io.Reader, digest []byte, opts crypto.SignerOpts) (signature []byte, err error)
// TODO(Joerger): DELETE IN v19.0.0
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Are you sure we can delete the fallback in v19? What will be the fix for not having that data in v19?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

As long as the client login was with a v18+ tsh, it'll have the data. If they have a v17- login for some reason, they can just re-login.

Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment on lines +105 to +115
// If the public key is missing, this is likely an old login key with only
// the serial number and slot. Fetch missing data from the hardware key.
// This data will be saved to the login key on next login
// TODO(Joerger): DELETE IN v19.0.0
if ref.PublicKey == nil {
if err := s.GetMissingKeyRefDetails(ref); err != nil {
return nil, trace.Wrap(err)
}
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why isn't this part of NewPrivateKey?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is part of #53674 ^

In the context of NewPrivateKey, we already have the full key ref, and it will get encoded into the key PEM file.

	ref := &hardwarekey.PrivateKeyRef{
		SerialNumber: ykPriv.serialNumber,
		SlotKey:      hardwarekey.PIVSlotKey(ykPriv.pivSlot.Key),
		PublicKey:    ykPriv.Public(),
		Policy: hardwarekey.PromptPolicy{
			TouchRequired: ykPriv.attestation.TouchPolicy != piv.TouchPolicyNever,
			PINRequired:   ykPriv.attestation.PINPolicy != piv.PINPolicyNever,
		},
		AttestationStatement: &hardwarekey.AttestationStatement{
			AttestationStatement: &attestationv1.AttestationStatement_YubikeyAttestationStatement{
				YubikeyAttestationStatement: &attestationv1.YubiKeyAttestationStatement{
					SlotCert:        ykPriv.slotCert.Raw,
					AttestationCert: ykPriv.attestationCert.Raw,
				},
			},
		},
	}

Getting missing key ref info is only necessary when we are parsing an old login key (v17-) which did not encode the key ref info into the PEM file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you document if it's ever legal to create a PrivateKeyRef or a PrivateKey without a public key, and thus if code using those can actually rely on the public key being there?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

(my vote is that a valid PrivateKeyRef should have a public key and it's a bug to create one without the public key except to immediately call GetMissingKeyRefDetails)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

WDYT? 529e280

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

After e2054fc getting the keyRef is a bit more consistent with y.getKeyRef, so we could also validate it there.

Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment thread api/utils/keys/privatekey.go Outdated
@Joerger Joerger force-pushed the joerger/hardware-key-service-reduced branch 5 times, most recently from ae0418b to c19bf87 Compare April 7, 2025 19:48
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch 2 times, most recently from 2d0aa69 to a8f2a54 Compare April 7, 2025 20:06
@Joerger Joerger force-pushed the joerger/hardware-key-service-reduced branch from c19bf87 to 4a82d3c Compare April 7, 2025 23:30
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch from a8f2a54 to 8ef5e57 Compare April 7, 2025 23:32
@Joerger Joerger requested a review from espadolini April 8, 2025 16:23
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch from 8ef5e57 to 5fff33f Compare April 8, 2025 17:54
Comment thread api/utils/keys/hardwarekey/hardwarekey.go Outdated
Comment on lines +105 to +115
// If the public key is missing, this is likely an old login key with only
// the serial number and slot. Fetch missing data from the hardware key.
// This data will be saved to the login key on next login
// TODO(Joerger): DELETE IN v19.0.0
if ref.PublicKey == nil {
if err := s.GetMissingKeyRefDetails(ref); err != nil {
return nil, trace.Wrap(err)
}
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you document if it's ever legal to create a PrivateKeyRef or a PrivateKey without a public key, and thus if code using those can actually rely on the public key being there?

Comment on lines +105 to +115
// If the public key is missing, this is likely an old login key with only
// the serial number and slot. Fetch missing data from the hardware key.
// This data will be saved to the login key on next login
// TODO(Joerger): DELETE IN v19.0.0
if ref.PublicKey == nil {
if err := s.GetMissingKeyRefDetails(ref); err != nil {
return nil, trace.Wrap(err)
}
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

(my vote is that a valid PrivateKeyRef should have a public key and it's a bug to create one without the public key except to immediately call GetMissingKeyRefDetails)

@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch 2 times, most recently from 529e280 to 0e93eca Compare April 9, 2025 20:08
Base automatically changed from joerger/hardware-key-service-reduced to master April 9, 2025 22:34
@Joerger Joerger force-pushed the joerger/enrich-hardware-key-ref branch from 0e93eca to 9a18f8f Compare April 9, 2025 22:59
@Joerger Joerger enabled auto-merge April 10, 2025 19:09
@Joerger Joerger added this pull request to the merge queue Apr 10, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 10, 2025
@Joerger Joerger added this pull request to the merge queue Apr 10, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 10, 2025
@Joerger Joerger added this pull request to the merge queue Apr 10, 2025
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Apr 10, 2025
@Joerger Joerger added this pull request to the merge queue Apr 10, 2025
Merged via the queue into master with commit eedf8b6 Apr 10, 2025
41 checks passed
@Joerger Joerger deleted the joerger/enrich-hardware-key-ref branch April 10, 2025 22:22
Joerger added a commit that referenced this pull request Apr 21, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 21, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 24, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 25, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 25, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 25, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 25, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 25, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 28, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 28, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 28, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Joerger added a commit that referenced this pull request Apr 28, 2025
…y file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
github-merge-queue Bot pushed a commit that referenced this pull request Apr 29, 2025
* feat: Hardware Key Agent - Add `api/utils/keys/hardwarekey` package (#53671)

* Move hardware key files into new hardwarekey package.

* Tidy up PIVSlot logic and remove its piv-go dependency.

* Add godoc comments to cliPrompt methods; Update cliprompt.go license year.

* Add godocs.

* feat: Hardware Key Agent - Add `hardwarekey.Service` interface with adapted PIV implementation (#53674)

* Add hardware key service interface; Add mock service for tests.

* Add piv implementation of hardware key service.

* Remove old yubikey parsing logic in favor of hardwarekey.PrivateKeyRef.

* Remove HardwareSigner in favor of hardwarekey.PrivateKey.

* Add test; Cleanup comment; Don't require pin/touch prompts in tests with MockHarwdareKeyService by default.

* Fix tests.

* Add TODOs.

* Use unhashed digest for WarmupHardwareKey.

* Address comments.

* Fix race condition in test service.

* Address comments.

* feat: Hardware Key Agent - Add `api/harwdarekey/piv` package (#53677)

* Remove YubiKeyPrivateKey

* Remove keys package dependencies from PIV implementation.

* Move PIV implementation into new piv package.

* Move newPrivateKey into YubiKeyService.NewPrivateKey.

* * Clean up separation of concerns between YubiKey and YubiKeyService

* Replace hardwarekey.PrivateKey cache with YubiKey cache for proper support for multiple clusters or yubikeys

* Add YubiKey version field for use in version specific signature edge cases

* Change sharedPIVConnection connection from an embedded field.

* Address comments.

* Add getKeyRef helper method.

* feat: Hardware Key Agent - Enrich the PEM encoded hardware private key file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* feat: Hardware Key Agent - set hardware key service in client store (#53563)

* Replace prompt in keystore with hardware key service in client store.

* Add client StoreConfig and StoreConfigOpt.

* Add client store and key store tests.

* Provide nil service for ProfileStatus's AppsForCluster and DatabasesForCluster methods.

* Address comments.

* Fix test.

* Fix test with cmp.Diff.

* feat: Hardware Key Agent - Propagate contextual key info from key store to hardware key prompts (#53703)

* Propagate contextual key info from key store through to hardware key prompts.

* Remove HardwareKeyPromptConstructor.

* Cleanup; add tests.

* feat: Hardware Key Agent - consolidate globally shared PIV service variables (#53974)

* Consolidate process-wide shared prompt mutex and yubikey connections into a shared YubiKeyService, which will also share the prompt.

* Fix interactive piv service tests.

* Fix wording on comment.

* Move RemoveProfile and ListProfileNames into ProfileStore. (#53781)

* feat: Hardware Key PIN caching (#53976)

* Add PinCachingPrompt.

* Add PINCacheTimeout to auth preference proto message.

* Report PIVPINCacheTimeout through ping; Store PIVPINCacheTimeout in profile.

* Set PIV pin cache timeout for tsh and teleterm.

* Add SetPrompt and GetPrompt to hardware key service interface.

* Cleanup; Add test.

* Address comments.

* Rename to PINCacheTTL.

* Apply suggestions.

* Fix lint.

* Simplify randPIN for test.

* Use math/rand/v2.

* Update terraform docs.

* Revert pin caching change for connect to fix race condition. (#54140)

* feat: Hardware Key Agent (#54026)

* Add HardwareKeyAgent proto service.

* Add hardware key agent client and server implementation.

* Add tsh piv agent command.

* Use hardware key agent service when available.

* * Add config option to Teleport connect to start the hardware key agent server

* Add flag to tsh daemon command to start the hardware key agent server

* Fix hardware key agent client connection for Windows.

* Add hardware key agent service; Add tests.

* Minor cleanup.

* Move hardware key agent proto to /api.

* * Restructure packages based on dependencies.

* Add hardware key agent test coverage for RSA, ECDSA, and ED25519 keys.

* Add PIV test coverage for RSA keys.

* Fix lint.

* Fix lint; Fix test.

* Address comments.

* Address comments.

* Fix merge conflict.

* feat: Hardware Key Agent - require users to configure certificate (#54118)

* * Hardware key agent checks whether a key is configured for Teleport clients before performing a signature.

* Add detailed error message and docs for configuring PIV slot certificate.

* Add additional checks for mismatched public key on PIV slot, which can occur when generating a new key on a PIV slot with an active login session.

* Update api/utils/keys/piv/yubikey.go

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Remove MaxUint32 call to fix builds on 32-bit systems. (#54125)

* feat: Hardware Key Agent - command hint (#54090)

* Supply command for context on hardware key prompt.

* * Include command in Teleport Connect hardware key prompts, excluding tshd commands

* Fix proxy host context passed to Teleport connect hardware key prompts

* Only use direct service for `tsh login` to avoid jumping between clients

* Add new line before command.

* Fix story.

* Address comments.

* Trim forward slash for windows.

* Change proxy_host to proxy_hostname; Update comment.

* feat: Hardware Key Agent w/ PIN caching - fix cross-cluster support (#54144)

* Style hardware key prompt with command in Connect (#54258)

* Style hardware key prompt with command in Connect.

* Move `CliCommand.tsx` to `components`

* Extend stories with a command

* Use `CliCommand` component, improve spacing

* Wrap command in the dialog

* End sentences with a dot

* Add a gap between `CliCommand` and errors in `OnlineDocumentGateway`

---------

Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>

* feat: Hardware Key Agent - fix socket replacement on Windows (#54126)

* Prevent windows from trying to reuse the addr and getting a bind error.

* Replace unresponsive windows unix sockets.

* Explicitly check for error message instead of os.Stat.

* Move windowsBindErrMessage.

* Add cross-platform ErrAddrInUse constant.

* Move error constants to hardwarekey package.

* feat: Hardware Key Agent - initialize hardware key service at start of `tsh daemon` (#54226)

* * Initialize shared hardware key service and client store for tshd

* Replace CustomHardwareKeyPrompt with SetPrompt

* Add lazy loaded tshd event service client and use it to initialize hardware key prompt early.

* Address comments; Set TshdEventsClient in daemon service.

* Fix test.

* Fix potential race condition on global yubikey service prompt.

* Add test.

* Require ClientStore in `client.Config` (#54227)

* Invert config.EnableEscapeSequences into config.DisableEscapeSequences so that the default value (false) results in the desired default behavior.

* * Replace MakeDefaultClientConfig with CheckAndSetDefaults

* Require ClientStore to be provided in config

* Remove CustomHardwareKeyPrompt from config

* Set client store in tests that were missing it.

* Ensure tsh only initializes client store once.

* Client config uses its own client store.

* Replace uses of KeysDir with ClientStore.

* Remove unused home apth for vnet process.

* Remove unnecessary profile re-load and helper function.

* Replace sync.Once with atomic; add get/setClientStore.

* Fix uncaught merge conflict.

* Fix test; Add comment for why we initialize the client store atomically.

* Return error when using MemKeyStore for tsh puttyconfig.

* Fix merge conflict.

* feat: PIV PIN Caching - add file config option (#54328)

* Add pin_cache_ttl as file config option.

* Add test.

* Update lib/config/fileconf.go

Co-authored-by: Bernard Kim <bernard@goteleport.com>

---------

Co-authored-by: Bernard Kim <bernard@goteleport.com>

* Restore namespace in client config.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>
Co-authored-by: Bernard Kim <bernard@goteleport.com>
github-merge-queue Bot pushed a commit that referenced this pull request Apr 29, 2025
* feat: Hardware Key Agent - Add `api/utils/keys/hardwarekey` package (#53671)

* Move hardware key files into new hardwarekey package.

* Tidy up PIVSlot logic and remove its piv-go dependency.

* Add godoc comments to cliPrompt methods; Update cliprompt.go license year.

* Add godocs.

* feat: Hardware Key Agent - Add `hardwarekey.Service` interface with adapted PIV implementation (#53674)

* Add hardware key service interface; Add mock service for tests.

* Add piv implementation of hardware key service.

* Remove old yubikey parsing logic in favor of hardwarekey.PrivateKeyRef.

* Remove HardwareSigner in favor of hardwarekey.PrivateKey.

* Add test; Cleanup comment; Don't require pin/touch prompts in tests with MockHarwdareKeyService by default.

* Fix tests.

* Add TODOs.

* Use unhashed digest for WarmupHardwareKey.

* Address comments.

* Fix race condition in test service.

* Address comments.

* feat: Hardware Key Agent - Add `api/harwdarekey/piv` package (#53677)

* Remove YubiKeyPrivateKey

* Remove keys package dependencies from PIV implementation.

* Move PIV implementation into new piv package.

* Move newPrivateKey into YubiKeyService.NewPrivateKey.

* * Clean up separation of concerns between YubiKey and YubiKeyService

* Replace hardwarekey.PrivateKey cache with YubiKey cache for proper support for multiple clusters or yubikeys

* Add YubiKey version field for use in version specific signature edge cases

* Change sharedPIVConnection connection from an embedded field.

* Address comments.

* Add getKeyRef helper method.

* Rename NewSoftwarePrivateKey to NewPrivateKey (#53598)

* feat: Hardware Key Agent - Enrich the PEM encoded hardware private key file (#53675)

* Enrich hardware key PEM file.

* Add test.

* Validate PrivateKeyRef before/after encode/decode.

* Update api/utils/keys/hardwarekey/hardwarekey.go

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* Validate key ref in hardware key service implementations; Fix merge conflict.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>

* feat: Hardware Key Agent - set hardware key service in client store (#53563)

* Replace prompt in keystore with hardware key service in client store.

* Add client StoreConfig and StoreConfigOpt.

* Add client store and key store tests.

* Provide nil service for ProfileStatus's AppsForCluster and DatabasesForCluster methods.

* Address comments.

* Fix test.

* Fix test with cmp.Diff.

* feat: Hardware Key Agent - Propagate contextual key info from key store to hardware key prompts (#53703)

* Propagate contextual key info from key store through to hardware key prompts.

* Remove HardwareKeyPromptConstructor.

* Cleanup; add tests.

* feat: Hardware Key Agent - consolidate globally shared PIV service variables (#53974)

* Consolidate process-wide shared prompt mutex and yubikey connections into a shared YubiKeyService, which will also share the prompt.

* Fix interactive piv service tests.

* Fix wording on comment.

* Move RemoveProfile and ListProfileNames into ProfileStore. (#53781)

* feat: Hardware Key PIN caching (#53976)

* Add PinCachingPrompt.

* Add PINCacheTimeout to auth preference proto message.

* Report PIVPINCacheTimeout through ping; Store PIVPINCacheTimeout in profile.

* Set PIV pin cache timeout for tsh and teleterm.

* Add SetPrompt and GetPrompt to hardware key service interface.

* Cleanup; Add test.

* Address comments.

* Rename to PINCacheTTL.

* Apply suggestions.

* Fix lint.

* Simplify randPIN for test.

* Use math/rand/v2.

* Update terraform docs.

* Revert pin caching change for connect to fix race condition. (#54140)

* feat: Hardware Key Agent (#54026)

* Add HardwareKeyAgent proto service.

* Add hardware key agent client and server implementation.

* Add tsh piv agent command.

* Use hardware key agent service when available.

* * Add config option to Teleport connect to start the hardware key agent server

* Add flag to tsh daemon command to start the hardware key agent server

* Fix hardware key agent client connection for Windows.

* Add hardware key agent service; Add tests.

* Minor cleanup.

* Move hardware key agent proto to /api.

* * Restructure packages based on dependencies.

* Add hardware key agent test coverage for RSA, ECDSA, and ED25519 keys.

* Add PIV test coverage for RSA keys.

* Fix lint.

* Fix lint; Fix test.

* Address comments.

* Address comments.

* Fix merge conflict.

* feat: Hardware Key Agent - require users to configure certificate (#54118)

* * Hardware key agent checks whether a key is configured for Teleport clients before performing a signature.

* Add detailed error message and docs for configuring PIV slot certificate.

* Add additional checks for mismatched public key on PIV slot, which can occur when generating a new key on a PIV slot with an active login session.

* Update api/utils/keys/piv/yubikey.go

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Remove MaxUint32 call to fix builds on 32-bit systems. (#54125)

* feat: Hardware Key Agent - command hint (#54090)

* Supply command for context on hardware key prompt.

* * Include command in Teleport Connect hardware key prompts, excluding tshd commands

* Fix proxy host context passed to Teleport connect hardware key prompts

* Only use direct service for `tsh login` to avoid jumping between clients

* Add new line before command.

* Fix story.

* Address comments.

* Trim forward slash for windows.

* Change proxy_host to proxy_hostname; Update comment.

* feat: Hardware Key Agent w/ PIN caching - fix cross-cluster support (#54144)

* Style hardware key prompt with command in Connect (#54258)

* Style hardware key prompt with command in Connect.

* Move `CliCommand.tsx` to `components`

* Extend stories with a command

* Use `CliCommand` component, improve spacing

* Wrap command in the dialog

* End sentences with a dot

* Add a gap between `CliCommand` and errors in `OnlineDocumentGateway`

---------

Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>

* feat: Hardware Key Agent - fix socket replacement on Windows (#54126)

* Prevent windows from trying to reuse the addr and getting a bind error.

* Replace unresponsive windows unix sockets.

* Explicitly check for error message instead of os.Stat.

* Move windowsBindErrMessage.

* Add cross-platform ErrAddrInUse constant.

* Move error constants to hardwarekey package.

* feat: Hardware Key Agent - initialize hardware key service at start of `tsh daemon` (#54226)

* * Initialize shared hardware key service and client store for tshd

* Replace CustomHardwareKeyPrompt with SetPrompt

* Add lazy loaded tshd event service client and use it to initialize hardware key prompt early.

* Address comments; Set TshdEventsClient in daemon service.

* Fix test.

* Fix potential race condition on global yubikey service prompt.

* Add test.

* Require ClientStore in `client.Config` (#54227)

* Invert config.EnableEscapeSequences into config.DisableEscapeSequences so that the default value (false) results in the desired default behavior.

* * Replace MakeDefaultClientConfig with CheckAndSetDefaults

* Require ClientStore to be provided in config

* Remove CustomHardwareKeyPrompt from config

* Set client store in tests that were missing it.

* Ensure tsh only initializes client store once.

* Client config uses its own client store.

* Replace uses of KeysDir with ClientStore.

* Remove unused home apth for vnet process.

* Remove unnecessary profile re-load and helper function.

* Replace sync.Once with atomic; add get/setClientStore.

* Fix uncaught merge conflict.

* Fix test; Add comment for why we initialize the client store atomically.

* Return error when using MemKeyStore for tsh puttyconfig.

* Fix merge conflict.

* feat: PIV PIN Caching - add file config option (#54328)

* Add pin_cache_ttl as file config option.

* Add test.

* Update lib/config/fileconf.go

Co-authored-by: Bernard Kim <bernard@goteleport.com>

---------

Co-authored-by: Bernard Kim <bernard@goteleport.com>

* Restore namespace in client config.

---------

Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
Co-authored-by: Grzegorz Zdunek <grzegorz.zdunek@goteleport.com>
Co-authored-by: Bernard Kim <bernard@goteleport.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Indicates that a PR does not require a changelog entry size/sm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants