-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding rust client information to docs (#347)
* Adding rust information Signed-off-by: hayleycd <[email protected]> * addressing linter comment. Signed-off-by: hayleycd <[email protected]> * Addressing comments. Signed-off-by: hayleycd <[email protected]> --------- Signed-off-by: hayleycd <[email protected]>
- Loading branch information
Showing
3 changed files
with
47 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |