Skip to content

Commit 06b38fe

Browse files
committed
pool.xml: Add information for new encryption-related methods
Signed-off-by: mulhern <amulhern@redhat.com>
1 parent 6e18abb commit 06b38fe

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

docs/dbus/pool.xml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2270,6 +2270,13 @@
22702270
<arg name="return_code" type="q" direction="out"/>
22712271
<arg name="return_string" type="s" direction="out"/>
22722272
</method>
2273+
<!-- Decrypt the pool, writing out the pool's data as plain text. -->
2274+
<method name="DecryptPool">
2275+
<!-- True if the pool was decrypted, otherwise false. -->
2276+
<arg name="results" type="b" direction="out"/>
2277+
<arg name="return_code" type="q" direction="out"/>
2278+
<arg name="return_string" type="s" direction="out"/>
2279+
</method>
22732280
<!-- Destroy the specified filesystems. -->
22742281
<method name="DestroyFilesystems">
22752282
<!-- List of filesystem object paths to destroy. -->
@@ -2282,6 +2289,32 @@
22822289
<arg name="return_code" type="q" direction="out"/>
22832290
<arg name="return_string" type="s" direction="out"/>
22842291
</method>
2292+
<!-- Encrypt a pool. -->
2293+
<method name="EncryptPool">
2294+
<!--
2295+
a((bu)s): An array of key description information items
2296+
(bu)s: Key description information
2297+
(bu): Token slot specification
2298+
b: True if a token slot is specified, otherwise false.
2299+
u: A token slot
2300+
s: The key description
2301+
-->
2302+
<arg name="key_descs" type="a((bu)s)" direction="in"/>
2303+
<!--
2304+
a((bu)s): An array of Clevis information items
2305+
(bu)ss: Clevis configuration information
2306+
(bu): Token slot specification
2307+
b: True if a token slot is specified, otherwise false.
2308+
u: A token slot
2309+
s: The Clevis "pin" specification
2310+
s: pin-specific Clevis configuration
2311+
-->
2312+
<arg name="clevis_infos" type="a((bu)ss)" direction="in"/>
2313+
<!-- True if the pool was encrypted. -->
2314+
<arg name="results" type="b" direction="out"/>
2315+
<arg name="return_code" type="q" direction="out"/>
2316+
<arg name="return_string" type="s" direction="out"/>
2317+
</method>
22852318
<!-- Get filesystem metadata. -->
22862319
<method name="FilesystemMetadata">
22872320
<!--
@@ -2369,6 +2402,16 @@
23692402
<arg name="return_code" type="q" direction="out"/>
23702403
<arg name="return_string" type="s" direction="out"/>
23712404
</method>
2405+
<!--
2406+
Reencrypt the pool, changing the pool's master key and re-encrypting
2407+
the data with the new key.
2408+
-->
2409+
<method name="ReencryptPool">
2410+
<!-- True if the pool was re-encrypted, otherwise false. -->
2411+
<arg name="results" type="b" direction="out"/>
2412+
<arg name="return_code" type="q" direction="out"/>
2413+
<arg name="return_string" type="s" direction="out"/>
2414+
</method>
23722415
<!-- Set the pool name. -->
23732416
<method name="SetName">
23742417
<!-- Name. -->

0 commit comments

Comments
 (0)