From e18fcdc5223b767a0cd0bc1bb6001bfbde129155 Mon Sep 17 00:00:00 2001 From: Mariano Cano Date: Tue, 1 Jul 2025 17:55:42 -0700 Subject: [PATCH 1/3] Add a plugins section to the README This commit adds a new Plugins section to the README with links to known plugins. --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index b8d083639..3c59be266 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,27 @@ Here's a quick example, combining `step oauth` and `step crypto` to get and veri ![Animated terminal showing step in practice](https://smallstep.com/images/blog/2018-08-07-unfurl.gif) +## Plugins + +A plugin is an executable file named using the format `step--plugin`. +Plugins must be available in your `$PATH` or in the `$STEPPATH/plugins` +directory. + +When you run `step `, the CLI will automatically execute the corresponding +plugin if it exists. + +Some known plugins include: + +- [**step-kms-proxy**](https://github.com/smallstep/step-kms-plugin): Manage +keys and certificates stored in a KMS, including HSMs, TPMs, YubiKeys, the macOS +Keychain, and cloud KMSs. +- [**step-kmsproxy-plugin**](https://github.com/orbit-online/step-kmsproxy-plugin): +Provides an HSM/KMS-backed authenticating proxy for mTLS services. Thanks to +[@andsens](https://github.com/andsens) for creating and maintaining this plugin! + +[`step-kms-proxy`] is also integrated directly into `step` to create +certificates, generate CSRs, sign tokens, and more using KMS-backed keys. + ## Community * Connect with `step` users on [GitHub Discussions](https://github.com/smallstep/certificates/discussions) or [Discord](https://bit.ly/step-discord) From de23b9419af2dd80b8f935a18af102a4b57f591f Mon Sep 17 00:00:00 2001 From: Mariano Cano Date: Wed, 2 Jul 2025 10:26:39 -0700 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Carl Tashian Co-authored-by: Herman Slatman --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c59be266..095e80cec 100644 --- a/README.md +++ b/README.md @@ -82,14 +82,14 @@ Here's a quick example, combining `step oauth` and `step crypto` to get and veri A plugin is an executable file named using the format `step--plugin`. Plugins must be available in your `$PATH` or in the `$STEPPATH/plugins` -directory. +directory (`$HOME/.step`, by default). When you run `step `, the CLI will automatically execute the corresponding plugin if it exists. Some known plugins include: -- [**step-kms-proxy**](https://github.com/smallstep/step-kms-plugin): Manage +- [**step-kms-plugin**](https://github.com/smallstep/step-kms-plugin): Manage keys and certificates stored in a KMS, including HSMs, TPMs, YubiKeys, the macOS Keychain, and cloud KMSs. - [**step-kmsproxy-plugin**](https://github.com/orbit-online/step-kmsproxy-plugin): From 12ad1891f0fca4bf00a09d7df0bf60b1fbe8e2c9 Mon Sep 17 00:00:00 2001 From: Mariano Cano Date: Wed, 2 Jul 2025 13:46:38 -0700 Subject: [PATCH 3/3] Fix step-kms-plugin name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 095e80cec..8676d42ef 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ Keychain, and cloud KMSs. Provides an HSM/KMS-backed authenticating proxy for mTLS services. Thanks to [@andsens](https://github.com/andsens) for creating and maintaining this plugin! -[`step-kms-proxy`] is also integrated directly into `step` to create +`step-kms-plugin` is also integrated directly into `step` to create certificates, generate CSRs, sign tokens, and more using KMS-backed keys. ## Community