sequoia-sq/tests/data/examples
Neal H. Walfield 7ecc843dee
Add new command sq download.
- Add a new command, `sq download`, which downloads a file and a
    signature file, and then authenticates the file.

  - Fixes #84.
2024-11-09 13:28:17 +01:00
..
cert-store Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
debian Add new command sq download. 2024-11-09 13:28:17 +01:00
alice-new-secret.pgp Add examples for sq key subkey adopt. 2024-06-13 10:47:00 +02:00
alice-secret.pgp Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
alice.pgp.rev Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
autocrypt.eml Port sq autocrypt's examples to the example framework. 2024-06-20 15:48:43 +02:00
bare.pgp Don't require a key being adopted to have a binding signature. 2024-09-26 13:05:36 +02:00
bob-secret.pgp Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
bob.pgp Add missing example data file bob.pgp. 2024-10-07 15:27:28 +02:00
bob.pgp.rev Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
ca-secret.pgp Extend sq pki authorize to constrain by domain. 2024-10-14 17:46:18 +02:00
ciphertext.pgp Convert sq decrypt examples to use the example framework. 2024-05-27 13:36:35 +02:00
document.pgp Port sq verify's examples to the example framework. 2024-06-20 18:00:47 +02:00
document.sig Port sq inspect's examples to the example framework. 2024-03-13 10:26:32 +01:00
document.txt Port sq inspect's examples to the example framework. 2024-03-13 10:26:32 +01:00
juliet-secret.pgp Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
juliet.pgp Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
juliet.pgp.rev Add a framework to format and test examples. 2024-02-09 18:08:09 +01:00
message.pgp Port sq inspect's examples to the example framework. 2024-03-13 10:26:32 +01:00
password-file.txt Port sq key password's examples to the example framework. 2024-06-13 10:25:00 +02:00
README.md Add new command sq download. 2024-11-09 13:28:17 +01:00
romeo-secret.pgp Convert sq decrypt examples to use the example framework. 2024-05-27 13:36:35 +02:00
romeo.pgp Convert sq decrypt examples to use the example framework. 2024-05-27 13:36:35 +02:00

Introduction

This directory contains data for the examples.

The test suite executes each subcommand's examples. Each subcommand has its own context (temporary directory), which is set to the current working directory. The contents of this directory are copied into that directory. If a subcommand has multiple examples, they are execute after each other in the same context.

By using static data, we can use known fingerprints in the examples.

Contents

  • alice-secret.pgp: A general-purpose key for Alice alice@example.org.

    • Imported into the cert store.
    • NOT Imported into the key store.
  • alice-new-secret.pgp: A general-purpose key for Alice alice@example.org.

    • Not related to alice-secret.pgp, modulo having the same user ID.
    • NOT imported into the cert store.
    • NOT Imported into the key store.
  • bob.pgp: A general-purpose certificate for Bob bob@example.org.

    • Imported into the cert store.
    • Certified by Alice.
  • bob-secret.pgp: A general-purpose key for Bob bob@example.org.

    • NOT Imported into the key store.
  • juliet.pgp: A general-purpose certificate for Juliet Capulet juliet@example.org.

    • NOT imported into the cert store.
  • juliet-secret.pgp: A general-purpose key for Juliet Capulet juliet@example.org.

    • NOT imported into the key store.
  • romeo.pgp: A general-purpose certificate for Romeo Montague romeo@example.org.

    • NOT imported into the cert store.
  • romeo-secret.pgp: A general-purpose key for Romeo Montague romeo@example.org.

    • NOT imported into the key store.
  • ca-secret.pgp: A key with the user ID ca@example.org.

    • NOT imported into the cert store.
  • bare.pgp: A bare key.

    A bare key is a public key without any components or signatures. Bare keys are useful when working with raw keys, e.g., keys generated on an OpenPGP card, a TPM device, etc. To add them to a certificate, they just need to be wrapped in a minimal amount of OpenPGP framing; no signatures are required.

    • NOT imported into the key store.
  • document.txt, document.sig: A document, and a detached signatured.

    • sq sign --detached --signer-file juliet-secret.pgp document.txt > document.sig
    • sq verify --signer-file juliet-secret.pgp --detached document.sig document.txt
  • document.pgp: An inline-signed document, equivalent to the above.

  • message.pgp: A document encrypted for Bob, and signed by Alice.

    • echo 'Golf this afternoon?' | sq encrypt --for-file bob-secret.pgp --signer-file alice-secret.pgp > message.pgp
  • ciphertext.pgp: A document encrypted for Juliet, and signed by Romeo.

    • echo 'Ti amo!' | sq encrypt --for-file juliet.pgp --signer-file romeo-secret.pgp > ciphertext.pgp
  • debian/: The checksum file, the signature file, and the signing key for the debian 12.7.0 release.