-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: hayleycd <cook.hayley@gmail.com>
- Loading branch information
Showing
5 changed files
with
9 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,13 +10,14 @@ weight: 1 | |
|
||
## Features | ||
|
||
* Support for keyless signature generation and verification with [Sigstore](https://www.sigstore.dev/) | ||
* Support for signing with ["ambient" OpenID Connect identities ](https://github.com/sigstore/sigstore-python#signing-with-ambient-credentials) | ||
* A comprehensive [CLI](https://github.com/sigstore/sigstore-python#usage) and corresponding [importable Python API](https://sigstore.github.io/sigstore-python) | ||
* Supports keyless signature generation and verification | ||
* Supports signing with ["ambient" OpenID Connect identities ](../signing#signing-with-ambient-credentials) | ||
Check failure on line 14 in content/en/language_clients/python/python_client_overview.md GitHub Actions / markdownlintSpaces inside link text
|
||
* A comprehensive [CLI](#usage) and corresponding [importable Python API](https://sigstore.github.io/sigstore-python) | ||
* An official [GitHub Action](../github_action) | ||
|
||
## Usage | ||
Check failure on line 18 in content/en/language_clients/python/python_client_overview.md GitHub Actions / markdownlintTrailing spaces
|
||
|
||
For Python API usage, see our [documentation](https://sigstore.github.io/sigstore-python/). | ||
For Python API usage, see our [API documentation](https://sigstore.github.io/sigstore-python/). | ||
|
||
You can run `sigstore` as a standalone program, or via `python -m`: | ||
|
||
|
@@ -53,28 +54,6 @@ optional arguments: | |
``` | ||
<!-- @end-sigstore-help@ --> | ||
|
||
## Licensing | ||
|
||
`sigstore` is licensed under the Apache 2.0 License. | ||
|
||
## Community | ||
|
||
`sigstore-python` is developed as part of the [Sigstore](https://sigstore.dev) project. | ||
|
||
We also use a [Slack channel](https://sigstore.slack.com)! Click [here](https://join.slack.com/t/sigstore/shared_invite/zt-mhs55zh0-XmY3bcfWn4XEyMqUUutbUQ) for the invite link. | ||
|
||
## Contributing | ||
|
||
See [the contributing docs](https://github.com/sigstore/.github/blob/main/CONTRIBUTING.md) for details. | ||
|
||
## Code of Conduct | ||
|
||
Everyone interacting with this project is expected to follow the [sigstore Code of Conduct](https://github.com/sigstore/.github/blob/main/CODE_OF_CONDUCT.md). | ||
|
||
## Security | ||
|
||
Should you discover any security issues, please refer to sigstore's [security process](https://github.com/sigstore/.github/blob/main/SECURITY.md). | ||
|
||
### SLSA Provenance | ||
Check failure on line 57 in content/en/language_clients/python/python_client_overview.md GitHub Actions / markdownlintHeadings should be surrounded by blank lines
|
||
This project emits a SLSA provenance on its release! This enables you to verify the integrity of the downloaded artifacts and ensured that the binary's code really comes from this source code. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,19 +7,11 @@ weight: 30 | |
--- | ||
## Configuring a custom root of trust ("BYO PKI") | ||
|
||
Apart from the default and "staging" Sigstore instances, `sigstore` also | ||
supports "BYO PKI" setups, where a user maintains their own Sigstore | ||
instance services. | ||
Apart from the default and "staging" Sigstore instances, `sigstore` also supports "BYO PKI" setups, where a user maintains their own Sigstore instance services. | ||
|
||
These are supported via the `--trust-config` flag, which accepts a | ||
JSON-formatted file conforming to the `ClientTrustConfig` message | ||
in the [Sigstore protobuf specs](https://github.com/sigstore/protobuf-specs). | ||
This file configures the entire Sigstore instance state, *including* the URIs | ||
used to access the CA and artifact transparency services as well as the | ||
cryptographic root of trust itself. | ||
These are supported via the `--trust-config` flag, which accepts a JSON-formatted file conforming to the `ClientTrustConfig` message in the [Sigstore protobuf specs](https://github.com/sigstore/protobuf-specs). This file configures the entire Sigstore instance state, *including* the URIs used to access the CA and artifact transparency services as well as the cryptographic root of trust itself. | ||
|
||
To use a custom client config, prepend `--trust-config` to any `sigstore` | ||
command: | ||
To use a custom client config, prepend `--trust-config` to any `sigstore` command: | ||
|
||
```console | ||
$ sigstore --trust-config custom.trustconfig.json sign foo.txt | ||
Check failure on line 17 in content/en/language_clients/python/root_of_trust.md GitHub Actions / markdownlintDollar signs used before commands without showing output
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,6 @@ menuTitle: Signing | |
title: Signing | ||
weight: 10 | ||
--- | ||
## Signing | ||
|
||
<!-- @begin-sigstore-sign-help@ --> | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters