mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-11-03 20:01:16 +00:00
fe8921c27b
Also one stray angle bracket. Signed-off-by: Ján Tomko <jtomko@redhat.com> Fixes:068efae5b1Fixes:3e9076e777Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com>
83 lines
2.7 KiB
XML
83 lines
2.7 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<body>
|
|
<h1>Secret information management</h1>
|
|
|
|
<p>
|
|
The secrets driver in libvirt provides a simple interface for
|
|
storing and retrieving secret information.
|
|
</p>
|
|
|
|
<h2><a id="uris">Connections to SECRET driver</a></h2>
|
|
|
|
<p>
|
|
The libvirt SECRET driver is a multi-instance driver, providing a single
|
|
system wide privileged driver (the "system" instance), and per-user
|
|
unprivileged drivers (the "session" instance). A connection to the secret
|
|
driver is automatically available when opening a connection to one of the
|
|
stateful primary hypervisor drivers. It is none the less also possible to
|
|
explicitly open just the secret driver, using the URI protocol "secret"
|
|
Some example connection URIs for the driver are:
|
|
</p>
|
|
|
|
<pre>
|
|
secret:///session (local access to per-user instance)
|
|
secret+unix:///session (local access to per-user instance)
|
|
|
|
secret:///system (local access to system instance)
|
|
secret+unix:///system (local access to system instance)
|
|
secret://example.com/system (remote access, TLS/x509)
|
|
secret+tcp://example.com/system (remote access, SASl/Kerberos)
|
|
secret+ssh://root@example.com/system (remote access, SSH tunnelled)
|
|
</pre>
|
|
|
|
<h3><a id="uriembedded">Embedded driver</a></h3>
|
|
|
|
<p>
|
|
Since 6.1.0 the secret driver has experimental support for operating
|
|
in an embedded mode. In this scenario, rather than connecting to
|
|
the libvirtd daemon, the secret driver runs in the client application
|
|
process directly. To open the driver in embedded mode the app use the
|
|
new URI path and specify a virtual root directory under which the
|
|
driver will create content.
|
|
</p>
|
|
|
|
<pre>
|
|
secret:///embed?root=/some/dir
|
|
</pre>
|
|
|
|
<p>
|
|
Under the specified root directory the following locations will
|
|
be used
|
|
</p>
|
|
|
|
<pre>
|
|
/some/dir
|
|
|
|
|
+- etc
|
|
| |
|
|
| +- secrets
|
|
|
|
|
+- run
|
|
|
|
|
+- secrets
|
|
</pre>
|
|
|
|
<p>
|
|
The application is responsible for recursively purging the contents
|
|
of this directory tree once they no longer require a connection,
|
|
though it can also be left intact for reuse when opening a future
|
|
connection.
|
|
</p>
|
|
|
|
<p>
|
|
The range of functionality is intended to be on a par with that
|
|
seen when using the traditional system or session libvirt connections
|
|
to QEMU. Normal practice would be to open the secret driver in embedded
|
|
mode any time one of the other drivers is opened in embedded mode so
|
|
that the two drivers can interact in-process.
|
|
</p>
|
|
</body>
|
|
</html>
|