{Singularity}'s SIF images can be signed, and subsequently verified, so that a user can be confident that an image they have obtained is a bit-for-bit reproduction of the original container as the author intended it. The signature, over the metadata and content of the container, is created using a private key, and directly added to the SIF file. This means that a signed container carries it's signature with it, avoiding the need for extra infrastructure to distribute signatures to end users of the container.
A user verifies the container has not been modified since signing using a public key or certificate. By default, {Singularity} uses PGP keys to sign and verify containers. Since 3.11, signing and verifying containers with X.509 key material / certificates is also supported.
PGP Public keys for verification can be distributed manually, or can be upload to and automatically retrieved from Singularity Container Services (SCS) or a Singularity Enterprise installation. Optionally, an HKP keyserver can also be configured.
As well as indicating a container has not been modified, a valid signature may be used to indicate a container has undergone testing or review, and is approved for execution. Multiple signatures can be added to a container, to document its progress through an approval process. {Singularity}'s Execution Control List (ECL) feature can be enable by administrators of privileged installations to restrict execution of containers based on their signatures (see the admin guide for more information).
Note
Due to a change in signature format, containers signed by 3.6.0 and later cannot be verified by older versions of {Singularity}.
To verify containers signed with older versions of {Singularity}
using 3.6.0 and above, the --legacy-insecure flag must be provided to the
singularity verify command.
The verify command will check that a SIF container image has been signed
using a PGP key, and is unchanged since it was signed.
If you are using a container image that was pulled from the SCS container library, then it is likely that it was signed with a PGP key that has been submitted to the SCS keystore. {Singularity} is able to automatically retrieve the public key to perform verification.
$ singularity pull library://alpine:latest $ singularity verify alpine_latest.sif Container is signed by 1 key(s): Verifying partition: FS: 8883491F4268F173C6E5DC49EDECE4F3F38D871E [REMOTE] Sylabs Admin <[email protected]> [OK] Data integrity verified INFO: Container verified: alpine_latest.sif
In this example you can see that Sylabs Admin has signed the container.
Note
singularity verify will only run against a local SIF file. You must
pull an image from a library:// source before you can verify it.
To sign your own containers you first need to generate one or more keys. In order to submit them to the SCS keystore, you will also need to login to SCS with a token:
- Go to: https://cloud.sylabs.io/
- Click "Sign In" and follow the sign in steps.
- Click on your login id (same and updated button as the Sign in one).
- Select "Access Tokens" from the drop down menu.
- Enter a name for your new access token, such as "test token"
- Click the "Create a New Access Token" button.
- Click "Copy token to Clipboard" from the "New API Token" page.
- Run
singularity remote loginand paste the access token at the prompt.
If you attempt to sign a container before you have generated any keys,
{Singularity} will guide you through the interactive process of creating
a new key. Or you can use the newpair subcommand in the key
command group like so:.
$ singularity key newpair Enter your name (e.g., John Doe) : Joe User Enter your email address (e.g., [email protected]) : [email protected] Enter optional comment (e.g., development keys) : demo Enter a passphrase : Retype your passphrase : Would you like to push it to the keystore? [Y,n] Y Generating Entity and OpenPGP Key Pair... done Key successfully pushed to: https://keys.sylabs.io
Note that I chose Y when asked if I wanted to push my key to the
keystore. This will push my public key to whichever keystore has been
configured by the singularity remote command, so that it can be
retrieved by other users running singularity verify. If you do not
wish to push your public key, say n during the newpair process.
The list subcommand will show you all of the keys you have created
or saved locally.`
$ singularity key list Public key listing (/home/dave/.singularity/sypgp/pgp-public): 0) User: Joe User (demo) <[email protected]> Creation time: 2019-11-15 09:54:54 -0600 CST Fingerprint: E5F780B2C22F59DF748524B435C3844412EE233B Length (in bits): 4096
If you chose not to push your key to the keystore during the newpair
process, but later wish to, you can push it to a keystore configured
using singularity remote like so:
$ singularity key push E5F780B2C22F59DF748524B435C3844412EE233B public key `E5F780B2C22F59DF748524B435C3844412EE233B` pushed to server successfully
If you delete your local public PGP key, you can always locate and download it again like so.
$ singularity key search Trudgian Showing 1 results KEY ID BITS NAME/EMAIL 12EE233B 4096 Joe User (demo) <[email protected]> $ singularity key pull 12EE233B 1 key(s) added to keyring of trust /home/dave/.singularity/sypgp/pgp-public
But note that this only restores the public key (used for verifying) to your local machine and does not restore the private key (used for signing).
{Singularity} allows you to search the keystore for public keys. You can
search for names, emails, and fingerprints (key IDs). When searching for
a fingerprint, you need to use 0x before the fingerprint, check the
example:
# search for key ID: $ singularity key search 0x8883491F4268F173C6E5DC49EDECE4F3F38D871E # search for the sort ID: $ singularity key search 0xF38D871E # search for user: $ singularity key search Godlove # search for email: $ singularity key search @gmail.com
Now that you have a key generated, you can use it to sign images like so:
$ singularity sign my_container.sif Signing image: my_container.sif Enter key passphrase : Signature created and applied to my_container.sif
Because your public PGP key is saved locally you can verify the image without needing to contact the Keystore.
$ singularity verify my_container.sif Verifying image: my_container.sif [LOCAL] Signing entity: Joe User (Demo keys) <[email protected]> [LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE 2 |1 |NONE |JSON.Generic 3 |1 |NONE |FS Container verified: my_container.sif
If you've pushed your key to the Keystore you can also verify this image
in the absence of a local public key. To demonstrate this, first
remove your local public key, and then try to use the verify
command again.
$ singularity key remove E5F780B2C22F59DF748524B435C3844412EE233B $ singularity verify my_container.sif Verifying image: my_container.sif [REMOTE] Signing entity: Joe User (Demo keys) <[email protected]> [REMOTE] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE 2 |1 |NONE |JSON.Generic 3 |1 |NONE |FS Container verified: my_container.sif
Note that the [REMOTE] message shows the key used for verification
was obtained from the keystore, and is not present on your local
computer. You can retrieve it, so that you can verify even if you are
offline with singularity key pull
$ singularity key pull E5F780B2C22F59DF748524B435C3844412EE233B 1 key(s) added to keyring of trust /home/dave/.singularity/sypgp/pgp-public
As well as the default behaviour, which signs all objects, fine-grained control of signing is possible.
If you sif list a SIF file you will see it is comprised of a number
of objects. Each object has an ID, and belongs to a GROUP.
$ singularity sif list my_container.sif Container id: e455d2ae-7f0b-4c79-b3ef-315a4913d76a Created on: 2019-11-15 10:11:58 -0600 CST Modified on: 2019-11-15 10:11:58 -0600 CST ---------------------------------------------------- Descriptor list: ID |GROUP |LINK |SIF POSITION (start-end) |TYPE ------------------------------------------------------------------------------ 1 |1 |NONE |32768-32800 |Def.FILE 2 |1 |NONE |36864-36961 |JSON.Generic 3 |1 |NONE |40960-25890816 |FS (Squashfs/*System/amd64)
Note
The singularity sif commands will only run against a local SIF file. You
must pull an image from a library:// source before you can examine
it.
I can choose to sign and verify a specific object with the --sif-id
option to sign and verify.
$ singularity sign --sif-id 1 my_container.sif Signing image: my_container.sif Enter key passphrase : Signature created and applied to my_container.sif $ singularity verify --sif-id 1 my_container.sif Verifying image: my_container.sif [LOCAL] Signing entity: Joe User (Demo keys) <[email protected]> [LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE Container verified: my_container.sif
Note that running the verify command without specifying the specific
sif-id gives a fatal error. The container is not considered verified as
whole because other objects could have been changed without my
knowledge.
$ singularity verify my_container.sif Verifying image: my_container.sif [LOCAL] Signing entity: Joe User (Demo keys) <[email protected]> [LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Error encountered during signature verification: object 2: object not signed FATAL: Failed to verify container: integrity: object 2: object not signed
I can sign a group of objects with the --group-id option to
sign.
$ singularity sign --groupid 1 my_container.sif Signing image: my_container.sif Enter key passphrase : Signature created and applied to my_container.sif
This creates one signature over all objects in the group. I can verify
that nothing in the group has been modified by running verify with
the same --group-id option.
$ singularity verify --group-id 1 my_container.sif Verifying image: my_container.sif [LOCAL] Signing entity: Joe User (Demo keys) <[email protected]> [LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE 2 |1 |NONE |JSON.Generic 3 |1 |NONE |FS Container verified: my_container.sif
Because every object in the SIF file is within the signed group 1 the
entire container is signed, and the default verify behavior without
specifying --group-id can also verify the container:
$ singularity verify my_container.sif Verifying image: my_container.sif [LOCAL] Signing entity: Joe User (Demo keys) <[email protected]> [LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448 Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE 2 |1 |NONE |JSON.Generic 3 |1 |NONE |FS Container verified: my_container.sif
Beginning with version 3.11, {Singularity} supports signing SIF container images using a PEM format private key, and verifying with a PEM format public key, or X.509 certificate. Non-PGP signatures are implemented using the Dead Simple Signing Envelope (DSSE) standard.
To sign a container using a private key in PEM format, provide the key material
to the sign command using the --key flag:
$ singularity sign --key mykey.pem lolcow.sif INFO: Signing image with key material from 'mykey.pem' INFO: Signature created and applied to image 'lolcow.sif'
The DSSE signature descriptor can now be seen by inspecting the SIF file:
$ singularity sif list lolcow.sif
------------------------------------------------------------------------------
ID |GROUP |LINK |SIF POSITION (start-end) |TYPE
------------------------------------------------------------------------------
1 |1 |NONE |32176-32393 |Def.FILE
2 |1 |NONE |32393-33522 |JSON.Generic
3 |1 |NONE |33522-33718 |JSON.Generic
4 |1 |NONE |36864-84656128 |FS (Squashfs/*System/amd64)
5 |NONE |1 (G) |84656128-84658191 |Signature (SHA-256)
$ singularity sif dump 5 lolcow.sif | jq
{
"payloadType": "application/vnd.sylabs.sif-metadata+json",
...
Attempting to verify the image without options will fail, as it is not
signed with a PGP key:
$ singularity verify lolcow.sif INFO: Verifying image with PGP key material FATAL: Failed to verify container: integrity: key material not provided for DSSE envelope signature
Note that the error message shows that the container image has a DSSE signature present.
To verify a container using a PEM public key directly, provide the key material
to the verify command using the key flag:
$ singularity verify --key mypublic.pem lolcow.sif INFO: Verifying image with key material from 'mypublic.pem' Objects verified: ID |GROUP |LINK |TYPE ------------------------------------------------ 1 |1 |NONE |Def.FILE 2 |1 |NONE |JSON.Generic 3 |1 |NONE |JSON.Generic 4 |1 |NONE |FS INFO: Verified signature(s) from image 'lolcow.sif'
To verify a container that was signed with a PEM private key, using an X.509
certificate, pass the certificate to the verify command using the
--certificate flag. If the certificate is part of a chain, provide
intermediate and valid root certificates with the
--certificate-intermediates and --certificate-roots flags:
$ singularity verify \ --certificate leaf.pem \ --certificate-intermediates intermediate.pem \ --certificate-roots root.pem \ lolcow.sif
Note
The certificate must have a usage field that allows code signing in order to verify container images.
When verifying a container using X.509 certificates, {Singularity} can perform
online revocation checks using the Online Certificate Status Protocol (OCSP). To
enable OCSP checks, add the --ocsp-verify flag to your verify command:
$ singularity verify \ --certificate leaf.pem \ --certificate-intermediates intermediate.pem \ --certificate-roots root.pem \ --ocsp-verify lolcow.sif
{Singularity} will then attempt to contact the prescribed OCSP responder for each certificate in the chain, in order to check that the relevant certificate has not been revoked. In the event that an OCSP responder cannot be contacted, or a certificate has been revoked, verification will fail with a validation error:
INFO: Validate: cert:leaf issuer:intermediate FATAL: Failed to verify container: OCSP verification has failed