From fd37d95515b16a229f4675b3bc69e315d6f48db1 Mon Sep 17 00:00:00 2001 From: hayleycd Date: Sun, 3 Nov 2024 14:00:40 -0800 Subject: [PATCH 1/5] Initial commit Signed-off-by: hayleycd --- .../language_client_overview.md | 2 +- content/en/language_clients/ruby/_index.html | 11 +++++++++++ content/en/language_clients/ruby/overview.md | 19 +++++++++++++++++++ 3 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 content/en/language_clients/ruby/_index.html create mode 100644 content/en/language_clients/ruby/overview.md diff --git a/content/en/language_clients/language_client_overview.md b/content/en/language_clients/language_client_overview.md index a974704f..530cf203 100644 --- a/content/en/language_clients/language_client_overview.md +++ b/content/en/language_clients/language_client_overview.md @@ -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) diff --git a/content/en/language_clients/ruby/_index.html b/content/en/language_clients/ruby/_index.html new file mode 100644 index 00000000..a13104b3 --- /dev/null +++ b/content/en/language_clients/ruby/_index.html @@ -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 +--- \ No newline at end of file diff --git a/content/en/language_clients/ruby/overview.md b/content/en/language_clients/ruby/overview.md new file mode 100644 index 00000000..745a98f1 --- /dev/null +++ b/content/en/language_clients/ruby/overview.md @@ -0,0 +1,19 @@ +--- +type: docs +category: Ruby +title: Ruby Client Overview +weight: 5 +--- + +## Features + +## Installation + +## Example + +### Signing example + +### Verifying example + +### Additional use cases + From b6efabe307b498d86385eea7bcce1b72efa64df8 Mon Sep 17 00:00:00 2001 From: hayleycd Date: Sun, 3 Nov 2024 15:19:50 -0800 Subject: [PATCH 2/5] Adding ruby client information. Signed-off-by: hayleycd --- content/en/language_clients/ruby/overview.md | 29 +++++++++++++++++--- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/content/en/language_clients/ruby/overview.md b/content/en/language_clients/ruby/overview.md index 745a98f1..9b7f3ad6 100644 --- a/content/en/language_clients/ruby/overview.md +++ b/content/en/language_clients/ruby/overview.md @@ -4,16 +4,37 @@ 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 +- `gem` subcommand +- TUF client implementation + ## Installation -## Example +`sigstore` requires Ruby version 3.1.0 or greater. -### Signing example +Add sigstore to your Gemfile: -### Verifying example +```console +gem 'sigstore', '~> 0.1.1' +``` -### Additional use cases +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 +``` From 723c6e41ae96016288058e5755dbc5e9dd513339 Mon Sep 17 00:00:00 2001 From: hayleycd Date: Fri, 8 Nov 2024 15:34:20 -0800 Subject: [PATCH 3/5] Addressing comments. Signed-off-by: hayleycd --- content/en/language_clients/ruby/overview.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/en/language_clients/ruby/overview.md b/content/en/language_clients/ruby/overview.md index 9b7f3ad6..7d9a48cd 100644 --- a/content/en/language_clients/ruby/overview.md +++ b/content/en/language_clients/ruby/overview.md @@ -10,13 +10,17 @@ The project repository can be found [here](https://github.com/sigstore/sigstore- ## Features -- Pure Ruby implementation of `sigstore verify` command from the [Cosign](../../cosign/verify) project +- Pure Ruby implementation of `sigstore sign` and `sigstore verify` command from the [Cosign](../../cosign/verify) project - `gem` subcommand - TUF client implementation ## Installation -`sigstore` requires Ruby version 3.1.0 or greater. +`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: From 014a188a1086d75c97d44c7f5d337c977bf4b2a5 Mon Sep 17 00:00:00 2001 From: hayleycd Date: Mon, 18 Nov 2024 16:31:44 -0800 Subject: [PATCH 4/5] Reorg Signed-off-by: hayleycd --- .../en/language_clients/{ruby/overview.md => ruby.md} | 10 +++++----- content/en/language_clients/ruby/_index.html | 11 ----------- 2 files changed, 5 insertions(+), 16 deletions(-) rename content/en/language_clients/{ruby/overview.md => ruby.md} (89%) delete mode 100644 content/en/language_clients/ruby/_index.html diff --git a/content/en/language_clients/ruby/overview.md b/content/en/language_clients/ruby.md similarity index 89% rename from content/en/language_clients/ruby/overview.md rename to content/en/language_clients/ruby.md index 7d9a48cd..82a563be 100644 --- a/content/en/language_clients/ruby/overview.md +++ b/content/en/language_clients/ruby.md @@ -1,8 +1,8 @@ --- type: docs -category: Ruby -title: Ruby Client Overview -weight: 5 +category: Language Clients +title: Ruby +weight: 45 --- [`sigstore`](https://rubygems.org/gems/sigstore) is a pure-ruby implementation of Sigstore signature verification. @@ -10,7 +10,7 @@ The project repository can be found [here](https://github.com/sigstore/sigstore- ## Features -- Pure Ruby implementation of `sigstore sign` and `sigstore verify` command from the [Cosign](../../cosign/verify) project +- Pure Ruby implementation of `sigstore sign` and `sigstore verify` command from the [Cosign](../../cosign/verifying/verify) project - `gem` subcommand - TUF client implementation @@ -41,4 +41,4 @@ 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 diff --git a/content/en/language_clients/ruby/_index.html b/content/en/language_clients/ruby/_index.html deleted file mode 100644 index a13104b3..00000000 --- a/content/en/language_clients/ruby/_index.html +++ /dev/null @@ -1,11 +0,0 @@ ---- -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 ---- \ No newline at end of file From 8f9d2272d9aec2a187695878e763285fa91adc59 Mon Sep 17 00:00:00 2001 From: hayleycd Date: Mon, 18 Nov 2024 17:09:54 -0800 Subject: [PATCH 5/5] fixing link Signed-off-by: hayleycd --- content/en/language_clients/language_client_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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) |