Skip to content

Commit 632b477

Browse files
authored
Merge pull request #1447 from smallstep/mariano/plugin
Add a plugins section to the README
2 parents b578783 + 12ad189 commit 632b477

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,27 @@ Here's a quick example, combining `step oauth` and `step crypto` to get and veri
7878

7979
![Animated terminal showing step in practice](https://smallstep.com/images/blog/2018-08-07-unfurl.gif)
8080

81+
## Plugins
82+
83+
A plugin is an executable file named using the format `step-<name>-plugin`.
84+
Plugins must be available in your `$PATH` or in the `$STEPPATH/plugins`
85+
directory (`$HOME/.step`, by default).
86+
87+
When you run `step <name>`, the CLI will automatically execute the corresponding
88+
plugin if it exists.
89+
90+
Some known plugins include:
91+
92+
- [**step-kms-plugin**](https://github.com/smallstep/step-kms-plugin): Manage
93+
keys and certificates stored in a KMS, including HSMs, TPMs, YubiKeys, the macOS
94+
Keychain, and cloud KMSs.
95+
- [**step-kmsproxy-plugin**](https://github.com/orbit-online/step-kmsproxy-plugin):
96+
Provides an HSM/KMS-backed authenticating proxy for mTLS services. Thanks to
97+
[@andsens](https://github.com/andsens) for creating and maintaining this plugin!
98+
99+
`step-kms-plugin` is also integrated directly into `step` to create
100+
certificates, generate CSRs, sign tokens, and more using KMS-backed keys.
101+
81102
## Community
82103

83104
* Connect with `step` users on [GitHub Discussions](https://github.com/smallstep/certificates/discussions) or [Discord](https://bit.ly/step-discord)

0 commit comments

Comments
 (0)