diff --git a/content/en/language_clients/language_client_overview.md b/content/en/language_clients/language_client_overview.md index d6b88b92..71a918ec 100644 --- a/content/en/language_clients/language_client_overview.md +++ b/content/en/language_clients/language_client_overview.md @@ -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) | diff --git a/content/en/language_clients/ruby.md b/content/en/language_clients/ruby.md new file mode 100644 index 00000000..82a563be --- /dev/null +++ b/content/en/language_clients/ruby.md @@ -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 +``` \ No newline at end of file