Skip to content

Commit

Permalink
Adding rust client information to docs (#347)
Browse files Browse the repository at this point in the history
* 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
hayleycd authored Nov 8, 2024
1 parent 8406c1d commit f1c041f
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 1 deletion.
2 changes: 1 addition & 1 deletion content/en/language_clients/language_client_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
11 changes: 11 additions & 0 deletions content/en/language_clients/rust/_index.html
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
---
35 changes: 35 additions & 0 deletions content/en/language_clients/rust/overview.md
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).

0 comments on commit f1c041f

Please sign in to comment.