This repository contains the public gRPC protos supporting our services, plus packages to ease integration with the Chainguard platform.
After updating a *.proto you'll need to update the corresponding generated go
code.
Run codegen in an ephemeral container with all dependencies pre-installed:
./hack/update-codegen-docker.shThis requires Docker but no local installation of protoc or its plugins.
./hack/update-codegen.shInstall protoc v36.2: https://grpc.io/docs/protoc-installation/
We currently require protoc v36.2.
Install protoc codegen dependencies:
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.36.12
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.6.2
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.30.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@v2.30.0The proto/platform/argos/v1 package exposes two gRPC services over the
platform endpoint.
ArgosDocuments manages organization-scoped, client-side-encrypted documents.
Callers require one of CAP_ARGOS_DOCUMENTS_CREATE, CAP_ARGOS_DOCUMENTS_LIST,
or CAP_ARGOS_DOCUMENTS_DELETE depending on the operation. Documents are
encrypted client-side before upload; the server never holds plaintext.
ArgosOSV provides OSV-format vulnerability query access to the Private OSV
shared corpus. A coalition member reads every approved record; a mitigation
partner reads only the records that match its approved mitigation capabilities
and, if it declared any, its package interests. The service exposes four RPCs:
| RPC | HTTP | Description |
|---|---|---|
Query |
POST /argos/v1/osv/query |
Query vulnerabilities affecting a package at a version |
QueryBatch |
POST /argos/v1/osv/querybatch |
Batch form of Query |
GetVuln |
GET /argos/v1/osv/vulns/{id} |
Fetch a single OSV record by ID |
Dump |
GET /argos/v1/osv/dump |
Stream a tar.gz archive of the records the caller reads: built nightly for coalition members, on request for mitigation partners |
Records are returned in OSV schema format.
While we make every effort to maintain backward compatibility and avoid breaking changes, we cannot guarantee that future updates to this SDK will be entirely non-breaking. As our platform evolves and new features are added, some modifications to the API surface may be necessary. We recommend pinning to specific versions in production environments and thoroughly testing updates before deployment.