mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-17 12:07:02 +02:00
2b0f80b981
* Add backend plugin changes * Fix totp backend plugin tests * Fix logical/plugin InvalidateKey test * Fix plugin catalog CRUD test, fix NoopBackend * Clean up commented code block * Fix system backend mount test * Set plugin_name to omitempty, fix handleMountTable config parsing * Clean up comments, keep shim connections alive until cleanup * Include pluginClient, disallow LookupPlugin call from within a plugin * Add wrapper around backendPluginClient for proper cleanup * Add logger shim tests * Add logger, storage, and system shim tests * Use pointer receivers for system view shim * Use plugin name if no path is provided on mount * Enable plugins for auth backends * Add backend type attribute, move builtin/plugin/package * Fix merge conflict * Fix missing plugin name in mount config * Add integration tests on enabling auth backend plugins * Remove dependency cycle on mock-plugin * Add passthrough backend plugin, use logical.BackendType to determine lease generation * Remove vault package dependency on passthrough package * Add basic impl test for passthrough plugin * Incorporate feedback; set b.backend after shims creation on backendPluginServer * Fix totp plugin test * Add plugin backends docs * Fix tests * Fix builtin/plugin tests * Remove flatten from PluginRunner fields * Move mock plugin to logical/plugin, remove totp and passthrough plugins * Move pluginMap into newPluginClient * Do not create storage RPC connection on HandleRequest and HandleExistenceCheck * Change shim logger's Fatal to no-op * Change BackendType to uint32, match UX backend types * Change framework.Backend Setup signature * Add Setup func to logical.Backend interface * Move OptionallyEnableMlock call into plugin.Serve, update docs and comments * Remove commented var in plugin package * RegisterLicense on logical.Backend interface (#3017) * Add RegisterLicense to logical.Backend interface * Update RegisterLicense to use callback func on framework.Backend * Refactor framework.Backend.RegisterLicense * plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs * plugin: Revert BackendType to remove TypePassthrough and related references * Fix typo in plugin backends docs
45 lines
1.5 KiB
Markdown
45 lines
1.5 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Plugin Backends"
|
|
sidebar_current: "docs-plugin"
|
|
description: |-
|
|
Plugin backends are mountable backends that are implemented unsing Vault's plugin system.
|
|
---
|
|
|
|
# Plugin Backends
|
|
|
|
Plugin backends are the components in Vault that can be implemented separately from Vault's
|
|
builtin backends. These backends can be either authentication or secret backends.
|
|
|
|
Detailed information regarding the plugin system can be found in the
|
|
[internals documentation](https://www.vaultproject.io/docs/internals/plugins.html).
|
|
|
|
# Mounting/unmounting Plugin Backends
|
|
|
|
Before a plugin backend can be mounted, it needs to be registered via the
|
|
[plugin catalog](https://www.vaultproject.io/docs/internals/plugins.html#plugin-catalog). After
|
|
the plugin is registered, it can be mounted by specifying the registered plugin name:
|
|
|
|
```
|
|
$ vault mount -path=my-secrets -plugin-name=passthrough-plugin plugin
|
|
Successfully mounted plugin 'passthrough-plugin' at 'my-secrets'!
|
|
```
|
|
|
|
Listing mounts will display backends that are mounted as plugins, along with the
|
|
name of plugin backend that is mounted:
|
|
|
|
```
|
|
$ vault mounts
|
|
Path Type Accessor Plugin Default TTL Max TTL Force No Cache Replication Behavior Description
|
|
my-secrets/ plugin plugin_deb84140 passthrough-plugin system system false replicated
|
|
...
|
|
```
|
|
|
|
Unmounting a plugin backend is the identical to unmounting internal backends:
|
|
|
|
```
|
|
$ vault unmount my-secrets
|
|
```
|
|
|
|
|