Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

proto, pkg, docs: update CSR docstrings #926

Merged
merged 12 commits into from
Jan 3, 2023
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ jobs:
- uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # v3.5.0
with:
go-version: ${{ env.GOVERSION }}
- uses: arduino/setup-protoc@64c0c85d18e984422218383b81c52f8b077404d3 # v1.1.2
- uses: trail-of-forks/setup-protoc@a97892a429d98fae78d26f40334ab7eb616d08b9
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
name: Install protobuf
with:
version: '3.20.3'
version: '21.11'

- name: Build
run: make -C $GITHUB_WORKSPACE all
Expand Down
5 changes: 4 additions & 1 deletion fulcio.proto
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ message CreateSigningCertificateRequest {
* Contains the public key to be stored in the requested certificate. All other CSR fields
* are ignored. Since the CSR is self-signed, it also acts as a proof of posession of
* the private key.
*
* In particular, the CSR's subject name is not verified, or tested for
* compatibility with its specified X.509 name type (e.g. email address).
*/
bytes certificate_signing_request = 3 [(google.api.field_behavior) = REQUIRED];
}
Expand Down Expand Up @@ -234,4 +237,4 @@ message OIDCIssuer {
string challenge_claim = 4;
// The expected SPIFFE trust domain. Only present when the OIDC issuer issues tokens for SPIFFE identities.
string spiffe_trust_domain = 5;
}
}
2 changes: 1 addition & 1 deletion fulcio.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"certificateSigningRequest": {
"type": "string",
"format": "byte",
"description": "Contains the public key to be stored in the requested certificate. All other CSR fields\nare ignored. Since the CSR is self-signed, it also acts as a proof of posession of\nthe private key.",
"description": "Contains the public key to be stored in the requested certificate. All other CSR fields\nare ignored. Since the CSR is self-signed, it also acts as a proof of posession of\nthe private key.\n\nIn particular, the CSR's subject name is not verified, or tested for\ncompatibility with its specified X.509 name type (e.g. email address).",
"title": "PKCS#10 PEM-encoded certificate signing request"
}
},
Expand Down
3 changes: 3 additions & 0 deletions fulcio_legacy.proto
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ message CreateSigningCertificateRequest {
* certificate. All other CSR fields are ignored. Since
* the CSR is self-signed, it also acts as a proof of
* posession of the private key.
*
* In particular, the CSR's subject name is not verified, or tested for
* compatibility with its specified X.509 name type (e.g. email address).
*/
bytes certificateSigningRequest = 3 [
deprecated=true,
Expand Down
2 changes: 1 addition & 1 deletion fulcio_legacy.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
"certificateSigningRequest": {
"type": "string",
"format": "byte",
"description": "Optional: PKCS#10 PEM-encoded certificate signing request\nContains the public key to be stored in the requested\ncertificate. All other CSR fields are ignored. Since\nthe CSR is self-signed, it also acts as a proof of\nposession of the private key."
"description": "Optional: PKCS#10 PEM-encoded certificate signing request\nContains the public key to be stored in the requested\ncertificate. All other CSR fields are ignored. Since\nthe CSR is self-signed, it also acts as a proof of\nposession of the private key.\n\nIn particular, the CSR's subject name is not verified, or tested for\ncompatibility with its specified X.509 name type (e.g. email address)."
}
}
},
Expand Down
5 changes: 4 additions & 1 deletion pkg/generated/protobuf/fulcio.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/generated/protobuf/fulcio_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion pkg/generated/protobuf/legacy/fulcio_legacy.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pkg/generated/protobuf/legacy/fulcio_legacy_grpc.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.