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 2 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 @@ -11,7 +11,7 @@ Sigstore has clients for the following language ecosystems:

- [Python](../python/overview)
- [Rust](https://github.com/sigstore/sigstore-rs#features)
- [Ruby](https://github.com/sigstore/sigstore-ruby#sigstore)
- [Ruby](../ruby/overview)
- [JavaScript](https://github.com/sigstore/sigstore-js#sigstore-js---)
- [Java](https://github.com/sigstore/sigstore-java#sigstore-java)
- [Go](https://github.com/sigstore/sigstore-go#sigstore-go)
Expand Down
11 changes: 11 additions & 0 deletions content/en/language_clients/ruby/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
type: docs
title: "Ruby"
description: "Ruby Language Client"
lead: "Ruby Language Client"
date: 2024-10-06T08:49:15+00:00
lastmod: 2024-10-06T08:49:15+00:00
draft: false
images: []
weight: 50
---
40 changes: 40 additions & 0 deletions content/en/language_clients/ruby/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
type: docs
category: Ruby
title: Ruby Client Overview
weight: 5
---
[`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 verify` command from the [Cosign](../../cosign/verify) project
hayleycd marked this conversation as resolved.
Show resolved Hide resolved
- `gem` subcommand
- TUF client implementation

## Installation

`sigstore` requires Ruby version 3.1.0 or greater.

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

View workflow job for this annotation

GitHub Actions / markdownlint

Trailing spaces

content/en/language_clients/ruby/overview.md:19:51 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md009.md

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 \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this name has changed, @segiddins can you provide an updated example for verification and/or signing?

--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
```
Loading