-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy path.README.html
More file actions
330 lines (319 loc) · 24.9 KB
/
.README.html
File metadata and controls
330 lines (319 loc) · 24.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!DOCTYPE html>
<!--
==============================================================================
"GitHub HTML5 Pandoc Template" v2.2 — by Tristano Ajmone
==============================================================================
Copyright © Tristano Ajmone, 2017-2020, MIT License (MIT). Project's home:
- https://github.com/tajmone/pandoc-goodies
The CSS in this template reuses source code taken from the following projects:
- GitHub Markdown CSS: Copyright © Sindre Sorhus, MIT License (MIT):
https://github.com/sindresorhus/github-markdown-css
- Primer CSS: Copyright © 2016-2017 GitHub Inc., MIT License (MIT):
http://primercss.io/
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The MIT License
Copyright (c) Tristano Ajmone, 2017-2020 (github.com/tajmone/pandoc-goodies)
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
Copyright (c) 2017 GitHub Inc.
"GitHub Pandoc HTML5 Template" is Copyright (c) Tristano Ajmone, 2017-2020,
released under the MIT License (MIT); it contains readaptations of substantial
portions of the following third party softwares:
(1) "GitHub Markdown CSS", Copyright (c) Sindre Sorhus, MIT License (MIT).
(2) "Primer CSS", Copyright (c) 2016 GitHub Inc., MIT License (MIT).
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
==============================================================================-->
<html>
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>trustee_client</title>
<style type="text/css">
@charset "UTF-8";.markdown-body{-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%;color:#24292e;font-family:-apple-system,system-ui,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";font-size:16px;line-height:1.5;word-wrap:break-word;box-sizing:border-box;min-width:200px;margin:0 auto;padding:45px}.markdown-body a{color:#0366d6;background-color:transparent;text-decoration:none;-webkit-text-decoration-skip:objects}.markdown-body a:active,.markdown-body a:hover{outline-width:0}.markdown-body a:hover{text-decoration:underline}.markdown-body a:not([href]){color:inherit;text-decoration:none}.markdown-body strong{font-weight:600}.markdown-body h1,.markdown-body h2,.markdown-body h3,.markdown-body h4,.markdown-body h5,.markdown-body h6{margin-top:24px;margin-bottom:16px;font-weight:600;line-height:1.25}.markdown-body h1{font-size:2em;margin:.67em 0;padding-bottom:.3em;border-bottom:1px solid #eaecef}.markdown-body h2{padding-bottom:.3em;font-size:1.5em;border-bottom:1px solid #eaecef}.markdown-body h3{font-size:1.25em}.markdown-body h4{font-size:1em}.markdown-body h5{font-size:.875em}.markdown-body h6{font-size:.85em;color:#6a737d}.markdown-body img{border-style:none}.markdown-body svg:not(:root){overflow:hidden}.markdown-body hr{box-sizing:content-box;height:.25em;margin:24px 0;padding:0;overflow:hidden;background-color:#e1e4e8;border:0}.markdown-body hr::before{display:table;content:""}.markdown-body hr::after{display:table;clear:both;content:""}.markdown-body input{margin:0;overflow:visible;font:inherit;font-family:inherit;font-size:inherit;line-height:inherit}.markdown-body [type=checkbox]{box-sizing:border-box;padding:0}.markdown-body *{box-sizing:border-box}.markdown-body blockquote{margin:0}.markdown-body ol,.markdown-body ul{padding-left:2em}.markdown-body ol ol,.markdown-body ul ol{list-style-type:lower-roman}.markdown-body ol ol,.markdown-body ol ul,.markdown-body ul ol,.markdown-body ul ul{margin-top:0;margin-bottom:0}.markdown-body ol ol ol,.markdown-body ol ul ol,.markdown-body ul ol ol,.markdown-body ul ul ol{list-style-type:lower-alpha}.markdown-body li>p{margin-top:16px}.markdown-body li+li{margin-top:.25em}.markdown-body dd{margin-left:0}.markdown-body dl{padding:0}.markdown-body dl dt{padding:0;margin-top:16px;font-size:1em;font-style:italic;font-weight:600}.markdown-body dl dd{padding:0 16px;margin-bottom:16px}.markdown-body code{font-family:SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace}.markdown-body pre{font:12px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;word-wrap:normal}.markdown-body blockquote,.markdown-body dl,.markdown-body ol,.markdown-body p,.markdown-body pre,.markdown-body table,.markdown-body ul{margin-top:0;margin-bottom:16px}.markdown-body blockquote{padding:0 1em;color:#6a737d;border-left:.25em solid #dfe2e5}.markdown-body blockquote>:first-child{margin-top:0}.markdown-body blockquote>:last-child{margin-bottom:0}.markdown-body table{display:block;width:100%;overflow:auto;border-spacing:0;border-collapse:collapse}.markdown-body table th{font-weight:600}.markdown-body table td,.markdown-body table th{padding:6px 13px;border:1px solid #dfe2e5}.markdown-body table tr{background-color:#fff;border-top:1px solid #c6cbd1}.markdown-body table tr:nth-child(2n){background-color:#f6f8fa}.markdown-body img{max-width:100%;box-sizing:content-box;background-color:#fff}.markdown-body code{padding:.2em 0;margin:0;font-size:85%;background-color:rgba(27,31,35,.05);border-radius:3px}.markdown-body code::after,.markdown-body code::before{letter-spacing:-.2em;content:" "}.markdown-body pre>code{padding:0;margin:0;font-size:100%;word-break:normal;white-space:pre;background:0 0;border:0}.markdown-body .highlight{margin-bottom:16px}.markdown-body .highlight pre{margin-bottom:0;word-break:normal}.markdown-body .highlight pre,.markdown-body pre{padding:16px;overflow:auto;font-size:85%;line-height:1.45;background-color:#f6f8fa;border-radius:3px}.markdown-body pre code{display:inline;max-width:auto;padding:0;margin:0;overflow:visible;line-height:inherit;word-wrap:normal;background-color:transparent;border:0}.markdown-body pre code::after,.markdown-body pre code::before{content:normal}.markdown-body .full-commit .btn-outline:not(:disabled):hover{color:#005cc5;border-color:#005cc5}.markdown-body kbd{box-shadow:inset 0 -1px 0 #959da5;display:inline-block;padding:3px 5px;font:11px/10px SFMono-Regular,Consolas,"Liberation Mono",Menlo,Courier,monospace;color:#444d56;vertical-align:middle;background-color:#fcfcfc;border:1px solid #c6cbd1;border-bottom-color:#959da5;border-radius:3px;box-shadow:inset 0 -1px 0 #959da5}.markdown-body :checked+.radio-label{position:relative;z-index:1;border-color:#0366d6}.markdown-body .task-list-item{list-style-type:none}.markdown-body .task-list-item+.task-list-item{margin-top:3px}.markdown-body .task-list-item input{margin:0 .2em .25em -1.6em;vertical-align:middle}.markdown-body::before{display:table;content:""}.markdown-body::after{display:table;clear:both;content:""}.markdown-body>:first-child{margin-top:0!important}.markdown-body>:last-child{margin-bottom:0!important}.Alert,.Error,.Note,.Success,.Warning{padding:11px;margin-bottom:24px;border-style:solid;border-width:1px;border-radius:4px}.Alert p,.Error p,.Note p,.Success p,.Warning p{margin-top:0}.Alert p:last-child,.Error p:last-child,.Note p:last-child,.Success p:last-child,.Warning p:last-child{margin-bottom:0}.Alert{color:#246;background-color:#e2eef9;border-color:#bac6d3}.Warning{color:#4c4a42;background-color:#fff9ea;border-color:#dfd8c2}.Error{color:#911;background-color:#fcdede;border-color:#d2b2b2}.Success{color:#22662c;background-color:#e2f9e5;border-color:#bad3be}.Note{color:#2f363d;background-color:#f6f8fa;border-color:#d5d8da}.Alert h1,.Alert h2,.Alert h3,.Alert h4,.Alert h5,.Alert h6{color:#246;margin-bottom:0}.Warning h1,.Warning h2,.Warning h3,.Warning h4,.Warning h5,.Warning h6{color:#4c4a42;margin-bottom:0}.Error h1,.Error h2,.Error h3,.Error h4,.Error h5,.Error h6{color:#911;margin-bottom:0}.Success h1,.Success h2,.Success h3,.Success h4,.Success h5,.Success h6{color:#22662c;margin-bottom:0}.Note h1,.Note h2,.Note h3,.Note h4,.Note h5,.Note h6{color:#2f363d;margin-bottom:0}.Alert h1:first-child,.Alert h2:first-child,.Alert h3:first-child,.Alert h4:first-child,.Alert h5:first-child,.Alert h6:first-child,.Error h1:first-child,.Error h2:first-child,.Error h3:first-child,.Error h4:first-child,.Error h5:first-child,.Error h6:first-child,.Note h1:first-child,.Note h2:first-child,.Note h3:first-child,.Note h4:first-child,.Note h5:first-child,.Note h6:first-child,.Success h1:first-child,.Success h2:first-child,.Success h3:first-child,.Success h4:first-child,.Success h5:first-child,.Success h6:first-child,.Warning h1:first-child,.Warning h2:first-child,.Warning h3:first-child,.Warning h4:first-child,.Warning h5:first-child,.Warning h6:first-child{margin-top:0}h1.title,p.subtitle{text-align:center}h1.title.followed-by-subtitle{margin-bottom:0}p.subtitle{font-size:1.5em;font-weight:600;line-height:1.25;margin-top:0;margin-bottom:16px;padding-bottom:.3em}div.line-block{white-space:pre-line}
</style>
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
html { -webkit-text-size-adjust: 100%; }
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<article class="markdown-body">
<header>
<h1 class="title">trustee_client</h1>
</header>
<hr>
<nav id="TOC">
<h1 class="toc-title">Contents</h1>
<ul>
<li><a href="#features" id="toc-features">Features</a></li>
<li><a href="#variables" id="toc-variables">Variables</a>
<ul>
<li><a href="#trustee_client_trustee_gc"
id="toc-trustee_client_trustee_gc">trustee_client_trustee_gc</a></li>
<li><a href="#trustee_client_kbs_url"
id="toc-trustee_client_kbs_url">trustee_client_kbs_url</a></li>
<li><a href="#trustee_client_kbs_cert_content"
id="toc-trustee_client_kbs_cert_content">trustee_client_kbs_cert_content</a></li>
<li><a href="#trustee_client_kbs_cert_src"
id="toc-trustee_client_kbs_cert_src">trustee_client_kbs_cert_src</a></li>
<li><a href="#trustee_client_secret_registration_enabled"
id="toc-trustee_client_secret_registration_enabled">trustee_client_secret_registration_enabled</a></li>
<li><a href="#trustee_client_encrypt_disk"
id="toc-trustee_client_encrypt_disk">trustee_client_encrypt_disk</a></li>
<li><a href="#trustee_client_encrypt_disk_mount_point"
id="toc-trustee_client_encrypt_disk_mount_point">trustee_client_encrypt_disk_mount_point</a></li>
<li><a href="#trustee_client_secure_logging"
id="toc-trustee_client_secure_logging">trustee_client_secure_logging</a></li>
</ul></li>
<li><a href="#example-playbook" id="toc-example-playbook">Example
Playbook</a></li>
<li><a href="#trustee-client" id="toc-trustee-client">Trustee
Client</a></li>
<li><a href="#secret-registration-client"
id="toc-secret-registration-client">Secret Registration Client</a></li>
<li><a href="#encrypt-disk" id="toc-encrypt-disk">Encrypt Disk</a></li>
<li><a href="#license" id="toc-license">License</a></li>
<li><a href="#author-information" id="toc-author-information">Author
Information</a></li>
</ul>
</nav>
<hr>
<p><img
src="https://github.com/linux-system-roles/trustee_client/workflows/tox/badge.svg"
alt="trustee_client" /></p>
<p>Ansible role for deploying Trustee Guest Components using Podman
Quadlets for confidential virtual machine deployments. The role
downloads quadlet files and configuration files from a GitHub
repository, installs them, and manages them as systemd services. The
role also supports an optional secret registration client for disk key
registration and optional disk encryption for securing additional
storage devices.</p>
<h1 id="features">Features</h1>
<ul>
<li><strong>Trustee Client (Quadlet)</strong>: Deploys Trustee guest
components Attestation Agent(AA), Confidential Data Hub(CDH) and API
Server REST(ASR) using Podman Quadlets from a Github repository</li>
<li><strong>Secret Registration Client</strong>: Utility script and
service which registers to Secret Registration Server on Trustee Server.
It acquires the encryption key from Trustee and decrypts the designated
disk upon boot</li>
<li><strong>Encrypt Disk</strong>: Does LUKS2 encryption of the found
empty data disk. The encryption key is provided by Secret Registration
Client.</li>
</ul>
<p>Example of setting the variables:</p>
<div class="sourceCode" id="cb1"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="fu">trustee_client_kbs_url</span><span class="kw">:</span><span class="at"> </span><span class="st">"https://kbs.example.com"</span></span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">trustee_client_kbs_cert_content</span><span class="kw">:</span><span class="at"> </span><span class="st">"-----BEGIN CERTIFICATE-----</span><span class="sc">\n</span><span class="st">...</span><span class="sc">\n</span><span class="st">-----END CERTIFICATE-----"</span><span class="co"> # or trustee_client_kbs_cert_src: "/path/to/server.crt"</span></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="fu">trustee_client_secret_registration_enabled</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="fu">trustee_client_encrypt_disk</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span></code></pre></div>
<h1 id="variables">Variables</h1>
<h2 id="trustee_client_trustee_gc">trustee_client_trustee_gc</h2>
<p>Whether to deploy Trustee Guest Components using Podman Quadlets
(packages, quadlet files, <code>/etc/trustee-gc/</code> configuration,
and the <code>trustee-gc</code> pod service). When <code>false</code>,
this part of the role is skipped.</p>
<p>The secret registration client is only deployed when this variable
and <code>trustee_client_secret_registration_enabled</code> are both
<code>true</code>.</p>
<p>Default: <code>true</code></p>
<p>Type: <code>bool</code></p>
<h2 id="trustee_client_kbs_url">trustee_client_kbs_url</h2>
<p>URL of the Key Broker Service (KBS) used by Trustee Guest Components.
When non-empty, the role replaces the <code>KBS_URL</code> placeholder
in the Attestation Agent and Confidential Data Hub
<code>config.toml</code> files under <code>/etc/trustee-gc/</code> with
this value.</p>
<p>If unset (empty string), the bundled placeholder values in those
files are left unchanged.</p>
<p>Default: <code>""</code></p>
<p>Type: <code>string</code></p>
<h2
id="trustee_client_kbs_cert_content">trustee_client_kbs_cert_content</h2>
<p>PEM-encoded TLS certificate for the KBS server, as a string (for
example from Ansible Vault). When non-empty, the role replaces the
<code>KBS_CERT</code> placeholder in the AA and CDH
<code>config.toml</code> files and writes the certificate to
<code>/etc/trustee-gc/server.crt</code>.</p>
<p>Use either this variable or <code>trustee_client_kbs_cert_src</code>,
not both as the primary source; if both are set, explicit content takes
precedence when it is non-empty.</p>
<p>Default: <code>""</code></p>
<p>Type: <code>string</code></p>
<h2 id="trustee_client_kbs_cert_src">trustee_client_kbs_cert_src</h2>
<p>Path on the control node to a PEM certificate file for the KBS
server. Used when <code>trustee_client_kbs_cert_content</code> is empty.
The file is read with <code>lookup('file', ...)</code> and applied like
<code>trustee_client_kbs_cert_content</code>.</p>
<p>Default: <code>""</code></p>
<p>Type: <code>string</code></p>
<h2
id="trustee_client_secret_registration_enabled">trustee_client_secret_registration_enabled</h2>
<p>Whether to install and configure the secret registration client
(requires Trustee Guest Components; see
<code>trustee_client_trustee_gc</code>). When <code>true</code>, the
client can register with the Secret Registration Server and supply disk
encryption keys when encrypt-disk features use it.</p>
<p>Default: <code>false</code></p>
<p>Type: <code>bool</code></p>
<h2 id="trustee_client_encrypt_disk">trustee_client_encrypt_disk</h2>
<p>Whether to locate an unpartitioned disk, create a LUKS2 encrypted
volume, and mount it. The encryption key comes from the secret
registration client when
<code>trustee_client_secret_registration_enabled</code> is
<code>true</code>, otherwise from a generated key and TPM binding via
<code>systemd-cryptenroll</code> (PCR 7).</p>
<p>Default: <code>false</code></p>
<p>Type: <code>bool</code></p>
<h2
id="trustee_client_encrypt_disk_mount_point">trustee_client_encrypt_disk_mount_point</h2>
<p>Filesystem path where the encrypted disk (mapper device
<code>trustee_client_encrypted_disk_0</code>) is mounted when
<code>trustee_client_encrypt_disk</code> is <code>true</code>. The
directory is created if missing.</p>
<p>Default: <code>"/mnt/encrypted-disk"</code></p>
<p>Type: <code>string</code></p>
<h2
id="trustee_client_secure_logging">trustee_client_secure_logging</h2>
<p>If <code>true</code>, suppress potentially sensitive output from
tasks that handle credentials, secrets, and other sensitive data by
setting <code>no_log: true</code> on those tasks. This prevents
passwords, API tokens, private keys, and similar sensitive information
from appearing in Ansible logs and console output.</p>
<p>If you need to debug issues with credential handling or secret
management, you can temporarily set
<code>trustee_client_secure_logging: false</code> to see the full output
from these tasks. However, be aware that this may expose sensitive
information in logs, so it should only be used in development or
troubleshooting scenarios.</p>
<p>Default: <code>true</code></p>
<p>Type: <code>bool</code></p>
<h1 id="example-playbook">Example Playbook</h1>
<p>Including an example of how to use your role (for instance, with
variables passed in as parameters) is always nice for users too:</p>
<div class="sourceCode" id="cb2"><pre
class="sourceCode yaml"><code class="sourceCode yaml"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="kw">-</span><span class="at"> </span><span class="fu">name</span><span class="kw">:</span><span class="at"> Deploy Trustee Guest Components using Podman Quadlets</span></span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">hosts</span><span class="kw">:</span><span class="at"> all</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">vars</span><span class="kw">:</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">trustee_client_kbs_url</span><span class="kw">:</span><span class="at"> </span><span class="st">"https://kbs.example.com"</span></span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">trustee_client_kbs_cert_content</span><span class="kw">:</span><span class="at"> </span><span class="st">"-----BEGIN CERTIFICATE-----</span><span class="sc">\n</span><span class="st">...</span><span class="sc">\n</span><span class="st">-----END CERTIFICATE-----"</span></span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">trustee_client_secret_registration_enabled</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">trustee_client_encrypt_disk</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">roles</span><span class="kw">:</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="kw">-</span><span class="at"> linux-system-roles.trustee_client</span></span></code></pre></div>
<h1 id="trustee-client">Trustee Client</h1>
<p>The task:</p>
<ol type="1">
<li>Downloads the Podman Quadlets from designated repo</li>
<li>Configures the settings in /etc/trustee-gc/</li>
<li>Enables and starts trustee-gc.pod as a service</li>
</ol>
<h1 id="secret-registration-client">Secret Registration Client</h1>
<p>When enabled, this task:</p>
<ol type="1">
<li>Sends registration request to Secret Registration Server via HTTPS
to acquire disk encryption keys</li>
<li>Requests above disk encryption key upon boot when Encrypt Disk is
enabled to decrypt and mount disk</li>
</ol>
<h1 id="encrypt-disk">Encrypt Disk</h1>
<p>An unpartitioned empty disk must be attached to the target. When
enabled, this task:</p>
<ol type="1">
<li>Finds the first unpartitioned and unmounted disk</li>
<li>Encrypts the disk using a key from either: a. secret key fetched
using Secret Registration Client (when enabled), or b.
<code>systemd-cryptenroll</code> which binds to PCR 7</li>
<li>Mounts it at the designated path</li>
<li>Sets up automatic unlock and mount either with Secret Registration
Client service or /etc/crypttab with
<code>systemd-cryptenroll</code></li>
</ol>
<h1 id="license">License</h1>
<p>Whenever possible, please prefer MIT.</p>
<h1 id="author-information">Author Information</h1>
<p>An optional section for the role authors to include contact
information, or a website (HTML is not allowed).</p>
</article>
</body>
</html>