You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: actions/submit-signing-request/README.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -23,39 +23,39 @@ The _Github Actions Trusted Build System_ must be enabled in the organization an
23
23
| `wait-for-completion` | - | If true, the action will wait for the signing request to complete. Defaults to `true`.
24
24
| `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.
25
25
| `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.
26
-
| `github-extended-verification-token` | - | Separate token for [extended validations](#extended-validation). See [Token permissions](#token-permissions) section below.
26
+
| `github-extended-verification-token` | - | Separate token for [extended verification](#extended-verification). See [Token permissions](#token-permissions) section below.
27
27
| `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.
28
28
| `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.
29
29
| `download-signed-artifact-timeout-in-seconds` | - | HTTP timeout when downloading the signed artifact. Defaults to 5 minutes.
30
30
| `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.
31
31
32
32
See also [action.yml](action.yml)
33
33
34
-
## Validations
34
+
## Verifications
35
35
36
-
### Basic validation
36
+
### Basic verification
37
37
38
38
SignPath performs a basic set of checks to verify that the signed artifact was built from the expected repository.
39
39
40
-
### Extended validation
40
+
### Extended verification
41
41
42
42
> [!NOTE]
43
43
> This feature is currently only available for selected Enterprise customers. Contact [[email protected]](mailto:[email protected]) if you are interested in using it.
44
44
45
-
SignPath can perform additional validations to ensure the security of the build pipeline.
45
+
SignPath can perform additional verifications to ensure the security of the build pipeline.
46
46
47
-
The following validations are currently supported:
47
+
The following verifications are currently supported:
48
48
49
-
#### Runner validations
49
+
#### Runner verifications
50
50
51
51
Restricts all workflow jobs leading to the signed artifact to run on runners from a defined set of runner groups.
52
52
53
-
#### Branch ruleset validations
53
+
#### Branch ruleset verifications
54
54
55
55
Ensures that certain branch rules are enforced on GitHub.
56
56
57
57
* Bypassers of the ruleset can be restricted.
58
-
* Continous enforcement of the rules from a specified date can be validated. _Note: Full functionality only available for GitHub Enterprise subscriptions._
58
+
* Continous enforcement of the rules from a specified date can be verified. _Note: Full functionality only available for GitHub Enterprise subscriptions._
59
59
60
60
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:
61
61
@@ -71,7 +71,7 @@ The following [branch ruleset rules](https://docs.github.com/en/repositories/con
71
71
72
72
#### `github-token`
73
73
74
-
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`.
74
+
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`.
75
75
76
76
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:
77
77
@@ -85,7 +85,7 @@ jobs:
85
85
86
86
#### `github-extended-verification-token`
87
87
88
-
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.
88
+
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.
89
89
90
90
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.
0 commit comments