forked from ossf/scorecard
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🌱 attestor: Dockerize + small improvements for Cloud Build usage (oss…
…f#2456) * Dockerize * Add cloudbuild.yaml * Improve logging Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Add README.md Signed-off-by: Raghav Kaul <raghavkaul@google.com> * Address PR comments * debian10 -> 11 * CLI * Remove logging statements * Dockerfile Signed-off-by: Raghav Kaul <raghavkaul@google.com> Signed-off-by: Raghav Kaul <raghavkaul@google.com>
- Loading branch information
1 parent
0346745
commit 0568240
Showing
8 changed files
with
149 additions
and
19 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 |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Copyright 2022 Security Scorecard Authors | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
FROM golang@sha256:ea3d912d500b1ae0a691b2e53eb8a6345b579d42d7e6a64acca83d274b949740 AS base | ||
WORKDIR /src/scorecard | ||
COPY . ./ | ||
|
||
FROM base AS build | ||
ARG TARGETOS | ||
ARG TARGETARCH | ||
RUN make build-attestor | ||
|
||
FROM gcr.io/google-appengine/debian11@sha256:fed7dd5b2c4bbfb70bd26a277cdaff98dced71f113632ccd5451dcc013fce0a4 | ||
COPY --from=build /src/scorecard/attestor / | ||
ENTRYPOINT [ "/scorecard-attestor" ] | ||
|
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 |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# Scorecard Attestor | ||
|
||
## What is scorecard-attestor? | ||
|
||
scorecard-attestor is a tool that runs scorecard on a software source repo, and based on certain policies about those results, produces a Google Cloud binary authorization attestation. | ||
|
||
scorecard-attestor helps users secure their software deployment systems by ensuring the code that they deploy passes certain criteria. | ||
|
||
## Building and using scorecard-attestor | ||
|
||
scorecard-attestor can be built as a standalone binary from source using `make build-attestor`, or with Docker, using `make build-attestor-docker`. scorecard-attestor is intended to be used as part of a Google Cloud Build pipeline, and inherits environment variables based on [build substitutions](https://cloud.google.com/build/docs/configuring-builds/substitute-variable-values). | ||
|
||
Unless there's an internal error, scorecard-attestor will always return a successful status code, but will only produce a binary authorization attestation if the policy check passes. | ||
|
||
## Configuring policies for scorecard-attestor | ||
|
||
Policies for scorecard attestor can be passed through the CLI using the `--policy` flag. Examples of policies can be seen in [attestor/policy/testdata](/attestor/policy/testdata). | ||
|
||
### Policy schema | ||
|
||
Policies follow the following schema: | ||
|
||
```yaml | ||
--- | ||
type: "//rec" | ||
optional: | ||
preventBinaryArtifacts: "//bool" | ||
allowedBinaryArtifacts: | ||
type: "//arr" | ||
contents: "//str" # Accepts glob-based filepaths as strings here | ||
ensureNoVulnerabilities: "//bool" | ||
ensureDependenciesPinned: "//bool" | ||
allowedUnpinnedDependencies: | ||
type: "//arr" | ||
contents: | ||
type: "//rec" | ||
optional: | ||
packagename: "//str" | ||
filepath: "//str" | ||
version: "//str" | ||
ensureCodeReviewed: "//bool" | ||
codeReviewRequirements: | ||
type: "//rec" | ||
optional: | ||
requiredApprovers: | ||
type: "//arr" | ||
contents: "//str" | ||
minReviewers: "//int" | ||
``` | ||
### Missing parameters | ||
Policies that are left blank will be ignored. Policies that allow users additional configuration options will be given default parameters as listed below. | ||
* `PreventBinaryArtifacts`: If not specified, `AllowedBinaryArtifacts` will be empty, i.e. no binary artifacts will be allowed | ||
* `PreventUnpinnedDependencies`: If not specified, `AllowedUnpinnedDependencies` will be empty, i.e. no unpinned dependencies will be allowed | ||
* `RequireCodeReviewed`: If not specified, `CodeReviewRequirements` will require at least one reviewer on all changesets. | ||
|
||
## Sample | ||
|
||
Examples of how to use scorecard-attestor with binary authorization in your project can be found in these two repos: | ||
|
||
* [scorecard-binauthz-test-good](https://github.com/ossf-tests/scorecard-binauthz-test-good) | ||
* [scorecard-binauthz-test-bad](https://github.com/ossf-tests/scorecard-binauthz-test-bad) | ||
|
||
Sample code comes with: | ||
|
||
* `cloudbuild.yaml` to build the application and run scorecard-attestor | ||
* Terraform files to set up the binary authorization environment, including KMS and IAM. |
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
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
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