Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding rust client information to docs #347

Merged
merged 4 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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).
Loading