docs: fix modutil/P11_KIT_SERVER_ADDRESS ordering in PKCS#11 guide#534
Open
joshdrake wants to merge 1 commit into
Open
docs: fix modutil/P11_KIT_SERVER_ADDRESS ordering in PKCS#11 guide#534joshdrake wants to merge 1 commit into
joshdrake wants to merge 1 commit into
Conversation
The "OpenSSL and PKCS#11 support" example ran `modutil -add` before exporting P11_KIT_SERVER_ADDRESS. That fails: modutil loads and initializes the module as it adds it, and p11-kit-client.so cannot initialize unless P11_KIT_SERVER_ADDRESS already points at the running agent's PKCS#11 socket. - smallstep-agent.mdx: export the env var before running modutil, and add a warning callout explaining the ordering requirement. - troubleshooting-agent.mdx: add a "Recovering from a failed modutil add" subsection (list/delete the broken module with modutil/certutil, then re-add in the correct order). - vale vocab: accept `certutil`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VBgyxA5TPfE3hZMyoL1T5r
|
|
joshdrake
marked this pull request as ready for review
July 21, 2026 15:26
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The OpenSSL and PKCS#11 support section of the Smallstep Agent docs showed a broken command sequence: it ran
modutil -addbefore exportingP11_KIT_SERVER_ADDRESS.This fails.
modutilloads and initializes the module as part of adding it, andp11-kit-client.socannot initialize unlessP11_KIT_SERVER_ADDRESSalready points at the running agent's PKCS#11 socket. Run in the documented order,modutilerrors out and can leave a broken module registered in~/.pki/nssdb.Changes
platform/smallstep-agent.mdx— ExportP11_KIT_SERVER_ADDRESSbefore runningmodutil, and add a warning callout explaining the ordering requirement (with a deep link to the new recovery steps).platform/troubleshooting-agent.mdx— Add a Recovering from a failedmodutiladd subsection: close the browser, list modules (modutil -list/certutil -d ~/.pki/nssdb -U), delete the broken module (modutil -delete step-agent), then re-export and re-add in the correct order..vale/styles/config/vocabularies/Smallstep/accept.txt— Acceptcertutil(matches howmodutilis already whitelisted).Verification
vale(repo config, excluding auto-generatedstep-cli/reference/**): the edits introduce no new lint errors.#recovering-from-a-failed-modutil-addand reused#openssl-and-pkcs11-supportfollow the repo's slug convention.🤖 Generated with Claude Code