From 7b2d78b4f6ca94351bb79fbbd88f26a70a97aec1 Mon Sep 17 00:00:00 2001 From: Pedro Sousa <680496+pedrosousa@users.noreply.github.com> Date: Tue, 24 Sep 2024 11:57:44 +0100 Subject: [PATCH] Replace relative links --- .../api/auditor-information.mdx | 4 ++-- .../monitor-the-auditor/index.mdx | 17 +++++++++-------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/src/content/docs/key-transparency/api/auditor-information.mdx b/src/content/docs/key-transparency/api/auditor-information.mdx index 44c01086e2da50..7f75d18dd5499f 100644 --- a/src/content/docs/key-transparency/api/auditor-information.mdx +++ b/src/content/docs/key-transparency/api/auditor-information.mdx @@ -1,11 +1,11 @@ --- pcx_content_type: overview title: Auditor -sidebar: +sidebar: order: 1 --- -The Auditor is designed to sign epoch information, which includes the time at which the request is received by the Auditor, the epoch number, and the epoch digest. The Auditor serialises this information in binary using protobuf or bincode and checks whether the requested inclusion is valid, as in not satisfies [publication constraints](./epochs/#constraints). +The Auditor is designed to sign epoch information, which includes the time at which the request is received by the Auditor, the epoch number, and the epoch digest. The Auditor serializes this information in binary using protobuf or bincode and checks whether the requested inclusion is valid, as in not satisfies [publication constraints](/key-transparency/api/epochs/#constraints). If the Log is setup to provide [AKD](https://github.com/facebook/akd) audit proof, the Auditor verifies them asynchronously. diff --git a/src/content/docs/key-transparency/monitor-the-auditor/index.mdx b/src/content/docs/key-transparency/monitor-the-auditor/index.mdx index b2a885f8978b78..6ccfdf1ce5d5ab 100644 --- a/src/content/docs/key-transparency/monitor-the-auditor/index.mdx +++ b/src/content/docs/key-transparency/monitor-the-auditor/index.mdx @@ -7,18 +7,18 @@ sidebar: Cloudflare's Key Transparency Auditor validates Log audit proofs and provides a signature for them. The Log can then distribute these signatures to its end-users, and provides users with confidence that keys have not been tampered with. -In order to verify our work, you can use [Plexi](https://github.com/cloudflare/plexi), a CLI tool that allows anyone to perform proof verification locally via a public [API](./api/index.mdx). +In order to verify our work, you can use [Plexi](https://github.com/cloudflare/plexi), a CLI tool that allows anyone to perform proof verification locally via a public [API](/key-transparency/api/). ## Features -* Verify authenticity of a signature, to confirm it has been signed by a given public key -* Verify the validity of [facebook/akd](https://github.com/facebook/akd) proofs -* List Logs an Auditor monitors +- Verify authenticity of a signature, to confirm it has been signed by a given public key +- Verify the validity of [facebook/akd](https://github.com/facebook/akd) proofs +- List Logs an Auditor monitors ## Installation | Environment | CLI Command | -|:--------------------------------------------------------------|:----------------------| +| :------------------------------------------------------------ | :-------------------- | | [Cargo](https://www.rust-lang.org/tools/install) (Rust 1.76+) | `cargo install plexi` | ## Usage @@ -31,14 +31,14 @@ plexi [OPTIONS] ### Configure your auditor remote -`plexi` does not come with a default remote auditor, and you will need to choose your own. +`plexi` does not come with a default remote auditor, and you will need to choose your own. You can do so either by passing `--remote-url=` or setting the `PLEXI_REMOTE_URL` environment variable. -A common remote is provided below: +A common remote is provided below: | Name | Remote | -|:-----------|:------------------------------------------------| +| :--------- | :---------------------------------------------- | | Cloudflare | `https://plexi.key-transparency.cloudflare.com` | If you have deployed your own auditor, you can add a remote by filing a [GitHub issue](https://github.com/cloudflare/plexi/issues). @@ -59,6 +59,7 @@ The Key Transparency Auditor vouches for Log validity by ensuring epoch uniquene `plexi audit` provides information about a given epoch and its validity. It can perform a local audit to confirm the auditor behaviour. For instance, to verify WhatsApp Log auditted by Cloudflare Auditor, run the following: + ```shell > plexi audit --remote-url 'https://plexi.key-transparency.cloudflare.com' --namespace 'whatsapp.key-transparency.v1' --long Namespace: whatsapp.key-transparency.v1