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

Ruby client information #344

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
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 @@ -15,5 +15,5 @@ Language client summaries are available in the main Sigstore documentation, but
| Java (available soon) | [sigstore-java](https://github.com/sigstore/sigstore-java) |
| [Javascript](../javascript) | [sigstore-js](https://github.com/sigstore/sigstore-js) |
| [Python](../python) | [sigstore-python](https://github.com/sigstore/sigstore-python) |
| Ruby (available soon) | [sigstore-ruby](https://github.com/sigstore/sigstore-ruby) |
| [Ruby](../ruby) | [sigstore-ruby](https://github.com/sigstore/sigstore-ruby) |
| [Rust](../rust) | [sigstore-rs](https://github.com/sigstore/sigstore-rs) |
44 changes: 44 additions & 0 deletions content/en/language_clients/ruby.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
type: docs
category: Language Clients
title: Ruby
weight: 45
---
[`sigstore`](https://rubygems.org/gems/sigstore) is a pure-ruby implementation of Sigstore signature verification.

The project repository can be found [here](https://github.com/sigstore/sigstore-ruby#sigstore).

## Features

- Pure Ruby implementation of `sigstore sign` and `sigstore verify` command from the [Cosign](../../cosign/verifying/verify) project
- `gem` subcommand
- TUF client implementation

## Installation

`sigstore` requires Ruby version 3.1.0 or greater.

**This gem is under active development, and will not be considered stable until the 1.0 release.**

Release information is available [here](https://github.com/sigstore/sigstore-ruby/releases).

Add sigstore to your Gemfile:

```console
gem 'sigstore', '~> 0.1.1'
```

Install sigstore:

```console
gem install sigstore
```

## Example

```console
gem sigstore_cosign_verify_bundle --bundle a.txt.sigstore \
--certificate-identity https://github.com/sigstore-conformance/extremely-dangerous-public-oidc-beacon/.github/workflows/extremely-dangerous-oidc-beacon.yml@refs/heads/main \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
a.txt
```

Check failure on line 44 in content/en/language_clients/ruby.md

View workflow job for this annotation

GitHub Actions / markdownlint

Files should end with a single newline character

content/en/language_clients/ruby.md:44:3 MD047/single-trailing-newline Files should end with a single newline character https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md047.md
Loading