From f1c041f2da78325e419ffa420560ec38e49f9c23 Mon Sep 17 00:00:00 2001 From: Hayley Denbraver Date: Fri, 8 Nov 2024 11:27:11 -0800 Subject: [PATCH] Adding rust client information to docs (#347) * Adding rust information Signed-off-by: hayleycd * addressing linter comment. Signed-off-by: hayleycd * Addressing comments. Signed-off-by: hayleycd --------- Signed-off-by: hayleycd --- .../language_client_overview.md | 2 +- content/en/language_clients/rust/_index.html | 11 ++++++ content/en/language_clients/rust/overview.md | 35 +++++++++++++++++++ 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 content/en/language_clients/rust/_index.html create mode 100644 content/en/language_clients/rust/overview.md diff --git a/content/en/language_clients/language_client_overview.md b/content/en/language_clients/language_client_overview.md index 8c83b1d4..ddcf6164 100644 --- a/content/en/language_clients/language_client_overview.md +++ b/content/en/language_clients/language_client_overview.md @@ -13,7 +13,7 @@ Sigstore has clients for the following language ecosystems: - [Java](https://github.com/sigstore/sigstore-java#sigstore-java) - [JavaScript](../javascript/overview) - [Python](../python/overview) -- [Rust](https://github.com/sigstore/sigstore-rs#features) +- [Rust](../rust/overview) - [Ruby](https://github.com/sigstore/sigstore-ruby#sigstore) - [Java](https://github.com/sigstore/sigstore-java#sigstore-java) diff --git a/content/en/language_clients/rust/_index.html b/content/en/language_clients/rust/_index.html new file mode 100644 index 00000000..f81e35a7 --- /dev/null +++ b/content/en/language_clients/rust/_index.html @@ -0,0 +1,11 @@ +--- +type: docs +title: "Rust" +description: "Rust Language Client" +lead: "Rust Language Client" +date: 2024-10-06T08:49:15+00:00 +lastmod: 2024-10-06T08:49:15+00:00 +draft: false +images: [] +weight: 80 +--- \ No newline at end of file diff --git a/content/en/language_clients/rust/overview.md b/content/en/language_clients/rust/overview.md new file mode 100644 index 00000000..4a8e3a8a --- /dev/null +++ b/content/en/language_clients/rust/overview.md @@ -0,0 +1,35 @@ +--- +type: docs +category: Rust +title: Rust Client Overview +weight: 5 +--- + +[`sigstore`](https://crates.io/crates/sigstore) is a crate designed to interact with Sigstore architecture. + +**This crate is under active development, and will not be considered stable until the [1.0 release](https://github.com/sigstore/sigstore-rs/issues/274).** + +## Features + +- Container and binary signing and verification +- Fulcio integration including an OpenID Connect API +- All Rekor client APIs can be leveraged to interact with the transparency log +- Cryptographic key management + +## Installation + +Run the following command in your project directory: + +```console +cargo add sigstore +``` + +Or add the following to your Cargo.toml: + +`sigstore = "0.10.0"` + +Current release information is available [here](https://github.com/sigstore/sigstore-rs/releases). + +## Example + +Numerous examples are provided in the [project repository](https://github.com/sigstore/sigstore-rs/tree/main/examples), including a [simple signing example](https://github.com/sigstore/sigstore-rs/tree/main/examples/cosign/sign) and a number of examples interacting with the [Rekor transparency log](https://github.com/sigstore/sigstore-rs/tree/main/examples/rekor).