Skip to content

Commit

Permalink
renamed validation to verification
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Savoie committed Jul 24, 2024
1 parent bf71639 commit af45db0
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions actions/submit-signing-request/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,39 +23,39 @@ The _Github Actions Trusted Build System_ must be enabled in the organization an
| `wait-for-completion` | - | If true, the action will wait for the signing request to complete. Defaults to `true`.
| `output-artifact-directory` | - | Path to where the signed artifact will be extracted. If not specified, the task will not download the signed artifact from SignPath.
| `github-token` | - | GitHub access token used to read job details and download the artifact. Defaults to the [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication). See [Token permissions](#token-permissions) section below.
| `github-extended-verification-token` | - | Separate token for [extended validations](#extended-validation). See [Token permissions](#token-permissions) section below.
| `github-extended-verification-token` | - | Separate token for [extended verification](#extended-verification). See [Token permissions](#token-permissions) section below.
| `wait-for-completion-timeout-in-seconds` | - | Maximum time in seconds that the action will wait for the signing request to complete. Defaults to 10 minutes.
| `service-unavailable-timeout-in-seconds` | - | Total time in seconds that the action will wait for a single service call to succeed (across several retries). Defaults to 10 minutes.
| `download-signed-artifact-timeout-in-seconds` | - | HTTP timeout when downloading the signed artifact. Defaults to 5 minutes.
| `parameters` | - | Multiline-string of values that map to user-defined parameters in the Artifact Configuration. Use one line per parameter with the format `<name>: "<value>"` where `<value>` needs to be a valid JSON string.

See also [action.yml](action.yml)

## Validations
## Verifications

### Basic validation
### Basic verification

SignPath performs a basic set of checks to verify that the signed artifact was built from the expected repository.

### Extended validation
### Extended verification

> [!NOTE]
> This feature is currently only available for selected Enterprise customers. Contact [[email protected]](mailto:[email protected]) if you are interested in using it.
SignPath can perform additional validations to ensure the security of the build pipeline.
SignPath can perform additional verifications to ensure the security of the build pipeline.

The following validations are currently supported:
The following verifications are currently supported:

#### Runner validations
#### Runner verifications

Restricts all workflow jobs leading to the signed artifact to run on runners from a defined set of runner groups.

#### Branch ruleset validations
#### Branch ruleset verifications

Ensures that certain branch rules are enforced on GitHub.

* Bypassers of the ruleset can be restricted.
* Continous enforcement of the rules from a specified date can be validated. _Note: Full functionality only available for GitHub Enterprise subscriptions._
* Continous enforcement of the rules from a specified date can be verified. _Note: Full functionality only available for GitHub Enterprise subscriptions._

The following [branch ruleset rules](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets) are currently supported:

Expand All @@ -71,7 +71,7 @@ The following [branch ruleset rules](https://docs.github.com/en/repositories/con

#### `github-token`

The `github-token` is used for [basic validation](#basic-validation) and for downloading the artifact to SignPath.io. This token will be stored (encrypted) on SignPath.io, and should be short-lived with minimal permissions. It is recommended to use the default `secrets.GITHUB_TOKEN`.
The `github-token` is used for [basic verification](#basic-verification) and for downloading the artifact to SignPath.io. This token will be stored (encrypted) on SignPath.io, and should be short-lived with minimal permissions. It is recommended to use the default `secrets.GITHUB_TOKEN`.

The permissions of the `secrets.GITHUB_TOKEN` are set to `permissive` (default) or `restricted` in the repository, organization or enterprise. See the [GitHub documentation](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) for more details. In the latter case, the `action.read` and `content:read` permissions need to be explicitly set in the workflow definition for the respective job using the following snippet:

Expand All @@ -85,7 +85,7 @@ jobs:
#### `github-extended-verification-token`

The `github-extended-verification-token` is used if the `github-token` does not have sufficient permissions for performing [extended validations](#extended-validation). This token is only used temporarily and will not be stored on SignPath.io.
The `github-extended-verification-token` is used if the `github-token` does not have sufficient permissions for performing [extended verifications](#extended-verification). This token is only used temporarily and will not be stored on SignPath.io.

It requires the _Repository metadata read_ permission and, for GitHub Enterprise subscriptions that check the validity of those rules in the past, the _Get the audit log for an enterprise_ permission.

Expand Down

0 comments on commit af45db0

Please sign in to comment.