Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update sample outputs of key list cmd to match singularity PR 1957, from sylabs 174 #242

Merged
merged 2 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions definition_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ to one another during the build process.
fi

%labels
Author alice
Author [email protected]
Version v0.0.1

%help
Expand Down Expand Up @@ -691,7 +691,7 @@ Consider the ``%labels`` section from the example definition file above:
.. code:: {command}

%labels
Author [email protected]
Author [email protected]
Version v0.0.1
MyLabel Hello World

Expand All @@ -701,7 +701,7 @@ first space will be taken as the label's name, and the portion following
it will be taken as the label's value.

In the previous example, the first label name is ``Author`` with a
value of ``alice``. The second label name is ``Version`` with a
value of ``[email protected]``. The second label name is ``Version`` with a
value of ``v0.0.1``. Finally, the third label name is ``MyLabel`` with a
value of ``Hello World``.

Expand All @@ -712,7 +712,7 @@ following command:

$ {command} inspect my_container.sif

Author: alice
Author: [email protected]
Version: v0.0.1
MyLabel: Hello World
org.label-schema.build-arch: amd64
Expand Down
48 changes: 23 additions & 25 deletions key_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,15 @@ The output will look as it follows:

Private key listing (/home/joana/.{command}/keys/pgp-secret):

0) U: Johnny Cash (none) <[email protected]>
C: 2019-04-11 22:22:28 +0200 CEST
F: 47282BDC661F58FA4BEBEF47CA576CBD8EF1A2B4
L: 3072
--------
1) U: John Green (none) <[email protected]>
C: 2019-04-11 13:08:45 +0200 CEST
F: 5720799FE7B048CF36FAB8445EE1E2BD7B6342C5
L: 1024
--------
0) User: Johnny Cash (none) <[email protected]>
Creation time: 2019-04-11 22:22:28 +0200 CEST
Fingerprint: 47282BDC661F58FA4BEBEF47CA576CBD8EF1A2B4
Length (in bits): 3072

1) User: John Green (none) <[email protected]>
Creation time: 2019-04-11 13:08:45 +0200 CEST
Fingerprint: 5720799FE7B048CF36FAB8445EE1E2BD7B6342C5
Length (in bits): 1024

.. note::

Expand Down Expand Up @@ -102,21 +101,20 @@ keystore by running ``{command} key list -s`` command:

Private key listing (/home/joana/.{command}/keys/pgp-secret):

0) U: Johnny Cash (none) <[email protected]>
C: 2019-04-11 22:22:28 +0200 CEST
F: 47282BDC661F58FA4BEBEF47CA576CBD8EF1A2B4
L: 3072
--------
1) U: John Green (none) <[email protected]>
C: 2019-04-11 13:08:45 +0200 CEST
F: 5720799FE7B048CF36FAB8445EE1E2BD7B6342C5
L: 1024
--------
3) U: Pinkie Pie (Eternal chaos comes with chocolate rain!) <[email protected]>
C: 2019-04-26 12:07:07 +0200 CEST
F: 8C10B902F438E4D504C3ACF689FCFFAED5F34A77
L: 1024
--------
1) User: Johnny Cash (none) <[email protected]>
Creation time: 2019-04-11 22:22:28 +0200 CEST
Fingerprint: 47282BDC661F58FA4BEBEF47CA576CBD8EF1A2B4
Length (in bits): 3072

2) User: John Green (none) <[email protected]>
Creation time: 2019-04-11 13:08:45 +0200 CEST
Fingerprint: 5720799FE7B048CF36FAB8445EE1E2BD7B6342C5
Length (in bits): 1024

3) User: Pinkie Pie (Eternal chaos comes with chocolate rain!) <[email protected]>
Creation time: 2019-04-26 12:07:07 +0200 CEST
Fingerprint: 8C10B902F438E4D504C3ACF689FCFFAED5F34A77
Length (in bits): 1024

You will see the imported key at the bottom of the list. Remember you
can also import an ``ascii`` armored key and this will be automatically
Expand Down
51 changes: 21 additions & 30 deletions signNverify.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ You can use the ``newpair`` subcommand in the ``key`` command group like so:

$ {command} key newpair

Enter your name (e.g., John Doe) : Ian Kaneshiro
Enter your email address (e.g., [email protected]) : [email protected]
Enter optional comment (e.g., development keys) : example key
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 :
Generating Entity and OpenPGP Key Pair... done
Expand All @@ -106,19 +106,10 @@ or saved locally.

Public key listing (/home/ian/.{command}/keys/pgp-public):

0) U: Ian Kaneshiro (example key) <[email protected]>
C: 2022-02-23 15:12:19 -0800 PST
F: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
L: 4096
--------

In the output above the index of my key is ``0`` and the letters stand
for the following:

- U: User
- C: Creation date and time
- F: Fingerprint
- L: Key length
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 would like others in the community to easily be able to fetch your
public key for image verification, you can push your key to a public keyserver.
Expand Down Expand Up @@ -175,8 +166,8 @@ download it again like so.

Showing 1 results

FINGERPRINT ALGORITHM BITS CREATION DATE EXPIRATION DATE STATUS NAME/EMAIL
8232570480B868E1473AEEB03DBCBA1EE9D661E5 RSA 4096 2022-02-23 15:12:19 -0800 PST [enabled] Ian Kaneshiro (example key) <[email protected]>
KEY ID BITS NAME/EMAIL
12EE233B 4096 Joe User (demo) <[email protected]>

$ {command} key pull 8232570480B868E1473AEEB03DBCBA1EE9D661E5
1 key(s) added to keyring of trust /home/ian/.{command}/keys/pgp-public
Expand Down Expand Up @@ -230,8 +221,8 @@ without needing to contact the key server.
$ {command} verify my_container.sif

Verifying image: my_container.sif
[LOCAL] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[LOCAL] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[LOCAL] Signing entity: Joe User (Demo keys) <[email protected]>
[LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448
Objects verified:
ID |GROUP |LINK |TYPE
------------------------------------------------
Expand All @@ -253,8 +244,8 @@ command again.
$ {command} verify my_container.sif

Verifying image: my_container.sif
[REMOTE] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[REMOTE] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[REMOTE] Signing entity: Joe User (Demo keys) <[email protected]>
[REMOTE] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448
Objects verified:
ID |GROUP |LINK |TYPE
------------------------------------------------
Expand Down Expand Up @@ -316,8 +307,8 @@ option to ``sign`` and ``verify``.
$ {command} verify --sif-id 1 my_container.sif

Verifying image: my_container.sif
[LOCAL] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[LOCAL] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[LOCAL] Signing entity: Joe User (Demo keys) <[email protected]>
[LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448
Objects verified:
ID |GROUP |LINK |TYPE
------------------------------------------------
Expand All @@ -334,8 +325,8 @@ knowledge.
$ {command} verify my_container.sif

Verifying image: my_container.sif
[LOCAL] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[LOCAL] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[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
Expand All @@ -359,8 +350,8 @@ the same ``--group-id`` option.
$ {command} verify --group-id 1 my_container.sif

Verifying image: my_container.sif
[LOCAL] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[LOCAL] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[LOCAL] Signing entity: Joe User (Demo keys) <[email protected]>
[LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448
Objects verified:
ID |GROUP |LINK |TYPE
------------------------------------------------
Expand All @@ -379,8 +370,8 @@ specifying ``--group-id`` can also verify the container:
$ {command} verify my_container.sif

Verifying image: my_container.sif
[LOCAL] Signing entity: Ian Kaneshiro (example key) <[email protected]>
[LOCAL] Fingerprint: 8232570480B868E1473AEEB03DBCBA1EE9D661E5
[LOCAL] Signing entity: Joe User (Demo keys) <[email protected]>
[LOCAL] Fingerprint: 65833F473098C6215E750B3BDFD69E5CEE85D448
Objects verified:
ID |GROUP |LINK |TYPE
------------------------------------------------
Expand Down
Loading