Skip to content

Document rotating the PIV admin keys - #24

Merged
mmlado merged 1 commit into
mainfrom
docs/piv-admin-key-rotation
Oct 12, 2026
Merged

mmlado merged 1 commit into
mainfrom
docs/piv-admin-key-rotation

Conversation

@mmlado

@mmlado mmlado commented Oct 8, 2026

Copy link
Copy Markdown
Collaborator

Documentation only.

  • New section "Rotating the PIV admin keys" in docs/piv/piv-personalization.rst (label piv-admin-key-rotation): what key versions 1 and 2 of the PIV security domain are, how to read the key table without authenticating, the gp PUT KEY command that replaces key version 1 in place, how to verify with the new keys and point the CLI at them via PIV_SCP03_ENC / PIV_SCP03_MAC / PIV_SCP03_DEK, recovery, and deleting key version 2.
  • Warns against --new-keyver 2: that overwrites the per-card Cryptnox keyset, which is needed for remote reset and attestation.
  • Notes the card-wide delay on INITIALIZE UPDATE after five failed authentications and that any INITIALIZE UPDATE without a matching EXTERNAL AUTHENTICATE counts, including read-only status probes.
  • Finalize paragraph now says it locks the PIV structure only, not the admin keys; rotate before finalize.
  • Getting started, factory commands, PIV commands, PIV quick start and troubleshooting cross-reference the new section instead of describing the keys loosely.

No code changes. Sphinx -W build and unit tests pass.

🤖 Generated with Claude Code

Add a section on replacing key version 1 of the PIV security domain
before production: the keyless key-table read, the in-place PUT KEY,
verification with the new keys, the key version 2 recovery set and its
deletion. Link it from the getting-started warning, the quick start, the
PIV and factory command pages and the troubleshooting KVN note.

State that finalize locks the structure only and that administration with
the security domain keys continues afterwards.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@mmlado
mmlado requested a review from embarquech October 8, 2026 17:16
@mmlado
mmlado merged commit f9ec51a into main Oct 12, 2026
12 checks passed
@mmlado
mmlado deleted the docs/piv-admin-key-rotation branch October 12, 2026 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant