From 241c45d390e2bd4addb043762ad51cf9aff21d36 Mon Sep 17 00:00:00 2001 From: Anton Livaja Date: Fri, 14 Feb 2025 01:27:46 -0500 Subject: [PATCH] clean up docs --- .../src/component-documents/hardware-models.md | 4 ---- .../src/component-documents/linux-workstation.md | 7 +++++++ .../all-levels/pgp-key-provisioning.md | 11 +++++------ .../operator/ceremony-sd-card-provisioning.md | 4 ++-- .../operator/coins/sol/generate-address.md | 4 ++-- .../operator/coins/sol/transfer-token.md | 4 +--- .../proposer/create-transaction-payload.md | 2 +- .../src/generated-documents/level-2/hardware.md | 2 -- .../level-2/operator-requirements.md | 10 ++++++++-- 9 files changed, 26 insertions(+), 22 deletions(-) create mode 100644 quorum-vault-system/src/component-documents/linux-workstation.md diff --git a/quorum-vault-system/src/component-documents/hardware-models.md b/quorum-vault-system/src/component-documents/hardware-models.md index f5936c5..aa8facb 100644 --- a/quorum-vault-system/src/component-documents/hardware-models.md +++ b/quorum-vault-system/src/component-documents/hardware-models.md @@ -63,12 +63,8 @@ Some options include: * NitroKey 3 -* Solo Key - * YubiKey 5 -* Librem Key - // ANCHOR_END: smart-cards ## Tamper Proofing diff --git a/quorum-vault-system/src/component-documents/linux-workstation.md b/quorum-vault-system/src/component-documents/linux-workstation.md new file mode 100644 index 0000000..93a9fe1 --- /dev/null +++ b/quorum-vault-system/src/component-documents/linux-workstation.md @@ -0,0 +1,7 @@ +/* ANCHOR: all */ +# Linux Workstation (Online Machine) +// ANCHOR: content +* Linux Workstation (online machine) + * Any internet connected computer with a Linux shell will suffice +// ANCHOR_END: content +/* ANCHOR_END: all */ \ No newline at end of file diff --git a/quorum-vault-system/src/generated-documents/all-levels/pgp-key-provisioning.md b/quorum-vault-system/src/generated-documents/all-levels/pgp-key-provisioning.md index 119065b..d3ef311 100644 --- a/quorum-vault-system/src/generated-documents/all-levels/pgp-key-provisioning.md +++ b/quorum-vault-system/src/generated-documents/all-levels/pgp-key-provisioning.md @@ -10,15 +10,14 @@ * Provided by [AirGapped Bundle](../level-2/fixed-location/provisioner/air-gapped-bundle.md) * Alternative: Computer that can load AirgapOS ([compatibility reference](https://git.distrust.co/public/airgap#tested-models)) -* Linux Workstation - * Any internet connected Linux shell will suffice +{{ #include ../../component-documents/linux-workstation.md:content }} -* 1 New Smart Card - * Nitrokey Pro 3+ or Yubikey 5+ +* 1+ Smart Card + * At least 1 primary smart card + * Any number of backup smart cards * 1 Transfer SD card - * Document will assume volume label is TRANSFER - * Brand and size does not matter + * Document will assume the card is labelled as "TRANSFER" ## Process diff --git a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/ceremony-sd-card-provisioning.md b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/ceremony-sd-card-provisioning.md index b4f52e0..b42ef63 100644 --- a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/ceremony-sd-card-provisioning.md +++ b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/ceremony-sd-card-provisioning.md @@ -6,7 +6,7 @@ * [Personal PGP Keys](/key-types.html#personal-pgp-keypair) -* Online computer +{{ #include ../../../../component-documents/linux-workstation.md:content }} ## Procedure @@ -14,7 +14,7 @@ 1. Open the SD Card Pack -{{ #include ../../../../component-documents/tamper-evidence-methods.md:vsbwf-procedure-unsealing}} +{{ #include ../../../../component-documents/tamper-evidence-methods.md:vsbwf-procedure-unsealing }} 1. Plug in a fresh SD card into computer diff --git a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/generate-address.md b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/generate-address.md index 0ee4fa7..85cabc1 100644 --- a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/generate-address.md +++ b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/generate-address.md @@ -4,7 +4,7 @@ {{ #include ../../../../operator-requirements.md:requirements }} -* Online machine +{{ #include ../../../../../../component-documents/linux-workstation.md:content }} * [High Visibility Storage](TODO): plastic container or bag that's used to keep items while not in use in a visible location like the middle of a desk. @@ -149,7 +149,7 @@ * `export ICEPICK_CONFIG_FILE=/icepick.toml` - * `icepick workflow sol generate-nonce-account --cluster --authorization-address "$(cat $account_id.txt)" | jq -r .nonce_account > $account_id-na.txt` + * `icepick workflow sol generate-nonce-account --authorization-address "$(cat $account_id.txt)" | jq -r .nonce_account > $account_id-na.txt` * [38 removes he need to use jq and cat](https://git.distrust.co/public/icepick/issues/38) * Repeat command if returned message is "The transaction was possibly not received by the cluster." diff --git a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/transfer-token.md b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/transfer-token.md index 30fd4b7..6c83e65 100644 --- a/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/transfer-token.md +++ b/quorum-vault-system/src/generated-documents/level-2/fixed-location/operator/coins/sol/transfer-token.md @@ -50,9 +50,7 @@ * `export ICEPICK_CONFIG_FILE=/icepick.toml` -1. Run the command: `icepick workflow sol broadcast --cluster --nonce-address=$nonce_address` - - * Available clusters are `devnet`, `testnet` and `mainnet-beta` +1. Run the command: `icepick workflow sol broadcast --nonce-address=$nonce_address` * Await completion message before removing Ceremony SD card diff --git a/quorum-vault-system/src/generated-documents/level-2/fixed-location/proposer/create-transaction-payload.md b/quorum-vault-system/src/generated-documents/level-2/fixed-location/proposer/create-transaction-payload.md index 677675b..1e73465 100644 --- a/quorum-vault-system/src/generated-documents/level-2/fixed-location/proposer/create-transaction-payload.md +++ b/quorum-vault-system/src/generated-documents/level-2/fixed-location/proposer/create-transaction-payload.md @@ -30,7 +30,7 @@ The proposer must combine these values into a JSON file, such as: * The proposer should verify the commit signatures of the photographs they are printing against a list of permitted PGP keys found in the `vaults` repo -* Online Machine +{{ #include ../../../../component-documents/linux-workstation.md:content }} * Clone the [Vaults Repository](../../../all-levels/create-vaults-repository.md) for your organization to the machine diff --git a/quorum-vault-system/src/generated-documents/level-2/hardware.md b/quorum-vault-system/src/generated-documents/level-2/hardware.md index bc0bc01..395035f 100644 --- a/quorum-vault-system/src/generated-documents/level-2/hardware.md +++ b/quorum-vault-system/src/generated-documents/level-2/hardware.md @@ -23,8 +23,6 @@ * Computers which are compatible which can be verified via [this guide](https://git.distrust.co/public/airgap#hardware-compatibility) -* Online Use: Chromebook or QubesOS laptop - // ANCHOR_END: computer-models ## Digital Camera diff --git a/quorum-vault-system/src/generated-documents/level-2/operator-requirements.md b/quorum-vault-system/src/generated-documents/level-2/operator-requirements.md index 896b1c4..d5d865d 100644 --- a/quorum-vault-system/src/generated-documents/level-2/operator-requirements.md +++ b/quorum-vault-system/src/generated-documents/level-2/operator-requirements.md @@ -8,9 +8,15 @@ * The operators should verify the commit signatures of the photographs they are printing against a list of permitted PGP keys found in the "ceremonies" repo -* [Air-gapped bundle](/generated-documents/level-2/fixed-location/provisioner/air-gapped-bundle.md) +* [AirgapOS SD card](/generated-documents/level-2/fixed-location/provisioner/provision-airgapos.md) + * Provided by [AirGapped Bundle](/generated-documents/level-2/fixed-location/provisioner/air-gapped-bundle.md) + * Alternative: Create your own from documentation in [AirgapOS Repository](https://git.distrust.co/public/airgap) -* Minimum of 2 [Operators](/system-roles.md#operator) +* AirgapOS Laptop + * Provided by [AirGapped Bundle](/generated-documents/level-2/fixed-location/provisioner/air-gapped-bundle.md) + * Alternative: Computer that can load AirgapOS ([compatibility reference](https://git.distrust.co/public/airgap#tested-models)) + +* Minimum of 1 [Operator](/system-roles.md#operator) and 1 [Witness](/system-roles.md#witness) * [Personal PGP key pair](/key-types.md#personal-pgp-keypair) for each operator