Skip to content

Commit

Permalink
Update main userdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 12, 2024
1 parent dc752b5 commit c663d3b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions public/docs/user/main/_sources/security.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,10 @@ However, there are also some disadvantages of the non-suid mode:
container, which is a big advantage over having many files directly
on networked filesystems.

- Encryption is not yet supported. In suid mode, {Project} uses kernel LUKS2
mounts to run encrypted containers without writing a decrypted
version of their content to disk.
An unprivileged FUSE filesystem will hopefully be able to perform this
operation in a future release.
- Non-suid mode SIF file encryption is incompatible with the older suid
mode encryption. It uses a kernel feature that does not have an exact
uprivileged replacement, but encryption is available unprivileged by
making use of a FUSE program.

- Some little used :ref:`security options <security-options>` and
:ref:`network options <networking>` of {Project} that give users elevated
Expand Down Expand Up @@ -215,7 +214,8 @@ feature. This is the same technology routinely used for full disk
encryption. The encrypted container is mounted directly through the
kernel. Unlike other container formats, the encrypted container is run
without ever decrypting its contents to disk.
Encryption and decryption is not currently supported in non-suid mode.
Non-suid encryption and decryption uses the FUSE gocryptfs program,
which also avoids decrypting contents to disk.

*******************************
Configuration & Runtime Options
Expand Down
2 changes: 1 addition & 1 deletion public/docs/user/main/searchindex.js

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions public/docs/user/main/security.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,10 @@ <h2>Setuid &amp; User Namespaces<a class="headerlink" href="#setuid-user-namespa
Metadata operations are still moved to the node running the
container, which is a big advantage over having many files directly
on networked filesystems.</p></li>
<li><p>Encryption is not yet supported. In suid mode, Apptainer uses kernel LUKS2
mounts to run encrypted containers without writing a decrypted
version of their content to disk.
An unprivileged FUSE filesystem will hopefully be able to perform this
operation in a future release.</p></li>
<li><p>Non-suid mode SIF file encryption is incompatible with the older suid
mode encryption. It uses a kernel feature that does not have an exact
uprivileged replacement, but encryption is available unprivileged by
making use of a FUSE program.</p></li>
<li><p>Some little used <a class="reference internal" href="security_options.html#security-options"><span class="std std-ref">security options</span></a> and
<a class="reference internal" href="networking.html#networking"><span class="std std-ref">network options</span></a> of Apptainer that give users elevated
privileges through configuration are only available in suid mode.</p></li>
Expand Down Expand Up @@ -314,7 +313,8 @@ <h2>Singularity Image Format (SIF)<a class="headerlink" href="#singularity-image
encryption. The encrypted container is mounted directly through the
kernel. Unlike other container formats, the encrypted container is run
without ever decrypting its contents to disk.
Encryption and decryption is not currently supported in non-suid mode.</p>
Non-suid encryption and decryption uses the FUSE gocryptfs program,
which also avoids decrypting contents to disk.</p>
</div>
<div class="section" id="configuration-runtime-options">
<h2>Configuration &amp; Runtime Options<a class="headerlink" href="#configuration-runtime-options" title="Permalink to this heading"></a></h2>
Expand Down

0 comments on commit c663d3b

Please sign in to comment.