Skip to content

Commit 6a18273

Browse files
committed
consistent table format
1 parent 0483def commit 6a18273

3 files changed

Lines changed: 20 additions & 20 deletions

File tree

docs/build-system-integration.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ You need to provide these values for every single API request.
4848

4949
### Submit a signing request
5050

51-
| Synopsis | |
52-
|-----------------------------|------|
51+
| Synopsis |
52+
|-----------------------------|----------------
5353
| URL | `/SigningRequests/SubmitWithArtifact`
5454
| Method | `POST`
5555
| Encoding | `multipart/form-data`
@@ -86,8 +86,8 @@ Example: `-F "parameters.productVersion=1.2.0"`
8686

8787
### Get signing request data
8888

89-
| Synopsis | |
90-
|------------|------|
89+
| Synopsis |
90+
|------------|------
9191
| URL | `/SigningRequests/$(SigningRequestId)` <br> (`Location` response-header from the call that submitted the signing request)
9292
| Method | GET
9393
| Parameters | none
@@ -148,8 +148,8 @@ curl -H "Authorization: Bearer $API_TOKEN" \
148148

149149
Once the signing request is successfully completed, the status response contains a `signedArtifactLink` field with a link to the signed artifact file. It can easily be retrieved by issuing the following command:
150150

151-
| Synopsis | |
152-
|------------|------|
151+
| Synopsis |
152+
|------------|------
153153
| URL | `/SigningRequests/$(SigningRequestId)/SignedArtifact` <br> (`signedArtifactLink` field from `GET SigningRequests/`id)
154154
| Method | GET |
155155
| Parameters | none
@@ -168,8 +168,8 @@ curl -H "Authorization: Bearer $API_TOKEN" \
168168

169169
See [Resubmit an existing signing request](/signing-code#resubmit) for more information.
170170

171-
| Synopsis | |
172-
|-----------------------------|------|
171+
| Synopsis |
172+
|-----------------------------|--------------------------------
173173
| URL | `/SigningRequests/Resubmit`
174174
| Method | `POST`
175175
| Encoding | `multipart/form-data`

docs/projects.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Both types of policies may alternatively use certificates that are issued by an
5151
5252
### General Properties
5353

54-
| Property | Value |
55-
|-----------------|-------|
54+
| Property | Value
55+
|-----------------|-----------------------------
5656
| **Certificate** | Select the certificate that will be used to sign the artifact |
5757
| **Submitters** | Select the users that are allowed to submit an artifact (may be regular or [CI users](/users#ci-users)) |
5858

@@ -61,7 +61,7 @@ Both types of policies may alternatively use certificates that are issued by an
6161
Select **Use approval process** if you want to require manual approval for each signing request. This is recommended for release-signing.
6262

6363
| Property | Value | Editions
64-
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
64+
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------
6565
| **Approvers** | Select the users that are allowed to approve signing requests. They will receive e-mail notifications for each request.
6666
| **Required approvals** | Set how many approvals are required. Note that a single _deny_ will abort the request. (Also known as _quorum_ or _k-out-of-n approval_.) | {{ site.data.editions | where: "policy_enforcement.quorum_approval", "true" | map: "name" | join: ", " }}
6767

@@ -82,7 +82,7 @@ Select **Verify origin** if you want to accept only signing requests with positi
8282
[Trusted build system verification](#signing-policy-trusted-build-system) must be enabled for origin verfication.
8383

8484
| Property | Value
85-
|----------------------------|-------
85+
|----------------------------|----------------------
8686
| **Project repository URL** | Must be configured in the project settings (applies to all signing policies)
8787
| **Allowed branch names** | For release-signing, it is recommended to restrict the signing policy to release branches, such as `main` or `release/*`. This helps to enforce a code review policy for release builds and prevents accidental or intentional release-signing of internal and test builds.
8888

docs/slsa-attestations/definitions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ Guarantee: If the provenance is signed by SignPath, the build was executed on a
116116
{:.quote}
117117
> It MUST NOT be possible for two builds that overlap in time to influence one another, such as by altering the memory of a different build process running on the same machine.
118118
119-
| Build System | Guarantee |
120-
| -- | ------------------------------ |
119+
| Build System | Guarantee
120+
|----------------|------------------------------
121121
| Azure DevOps | The build was executed on a runner from the Microsoft-hosted pools, which offer isolation (see [the official documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/security/misc))
122122
| GitHub Actions | The build was executed on a GitHub-hosted runner, each job is run in a fresh instance of the runner image (see [the official documentation](https://docs.github.com/en/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners))
123123

@@ -126,8 +126,8 @@ Guarantee: If the provenance is signed by SignPath, the build was executed on a
126126
{:.quote}
127127
> It MUST NOT be possible for one build to persist or influence the build environment of a subsequent build. In other words, an ephemeral build environment MUST be provisioned for each build.
128128
129-
| Build System | Guarantee |
130-
| -- | ------------------------------ |
129+
| Build System | Guarantee
130+
|----------------|------------------------------
131131
| Azure DevOps | The build was executed on a runner from the Microsoft-hosted pools, which provide a clean virtual machine for each build run (see [the official documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/security/misc))
132132
| GitHub Actions | The build was executed on a GitHub-hosted runner, each job is run in a fresh instance of the runner image (see [the official documentation](https://docs.github.com/en/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners))
133133

@@ -136,8 +136,8 @@ Guarantee: If the provenance is signed by SignPath, the build was executed on a
136136
{:.quote}
137137
> It MUST NOT be possible for one build to inject false entries into a build cache used by another build, also known as “cache poisoning”. In other words, the output of the build MUST be identical whether or not the cache is used.
138138
139-
| Build System | Guarantee |
140-
| -- | ------------------------------ |
139+
| Build System | Guarantee
140+
|----------------|------------------------------
141141
| Azure DevOps | Cache usage has to be explicitly defined in the pipeline definition and cannot be shared across pipelines or branches (see [the official documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/release/caching?view=azure-devops&tabs=bundler#cache-isolation-and-security))
142142
| GitHub Actions | Cache usage has to be explicitly defined in the workflow definition (see [the official definition](https://docs.github.com/en/actions/reference/workflows-and-actions/dependency-caching))
143143

@@ -146,8 +146,8 @@ Guarantee: If the provenance is signed by SignPath, the build was executed on a
146146
{:.quote}
147147
> The build platform MUST NOT open services that allow for remote influence unless all such interactions are captured as externalParameters in the provenance
148148
149-
| Build System | Guarantee |
150-
| -- | ------------------------------ |
149+
| Build System | Guarantee
150+
|----------------|------------------------------
151151
| Azure DevOps | The build was executed on a runner from the Microsoft-hosted pools, which do not provide the ability to remotely connect (see [the official documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/hosted)).
152152
| GitHub Actions | The build was executed on a GitHub-hosted runner which does not provide the ability to remotely connect, unless explicitly specified in the build definition (see [the official documentation](https://docs.github.com/en/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network))
153153

0 commit comments

Comments
 (0)