Skip to content

Commit

Permalink
certz: clarify that ssl_profile_id cannot be empty (#199)
Browse files Browse the repository at this point in the history
The ssl_profile_id field should always be set,
and providing an empty ssl_profile_id to the server
should result in an error being returned.
  • Loading branch information
brianneville authored Jul 11, 2024
1 parent e61da63 commit 5601340
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
6 changes: 3 additions & 3 deletions certz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ Certificate Authority chain of certificates (a.k.a. a CA trust bundle) and
a set of Certificate Revocation Lists into a set that then can be assigned
as a whole to a gRPC server.

There is always at least one profile present on a target - the `system_default_profile` which is vendor provided. This profile cannot be changed. If the use but when the `ssl_profile_id` field in the
`RotateCertificateRequest` message is not set (or set to an empty string) it
also refers this SSL profile. (This statement will be deprecated once all vendors standardize on the key name)
There is always at least one profile present on a target - the `system_default_profile` which is vendor provided.
This profile cannot be changed or deleted.
See the the [System default SSL profile](#system-default-ssl-profile) section below.

Profiles existing on a target can be discovered using the
`Certz.GetProfileList()` RPC.
Expand Down
7 changes: 5 additions & 2 deletions certz/certz.proto
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,8 @@ message RotateCertificateRequest {

// An identifier for the specific SSL profile (collection of
// certs/bundles/CRLs) which is being rotated through this stream.
// Leaving this field blank means that this stream will rotate the SSL profile
// which is currently being used by the gNSI service.
// Leaving this field blank will result in an InvalidArgument error
// being returned to the client
string ssl_profile_id = 2;

// Request Messages.
Expand Down Expand Up @@ -586,6 +586,9 @@ message ExistingEntity {
ENTITY_TYPE_AUTHENTICATION_POLICY = 4;
}

// The existing SSL profile to reference.
// Leaving this field blank will result in an InvalidArgument error
// being returned to the client
string ssl_profile_id = 1;
EntityType entity_type = 2;
}
Expand Down

0 comments on commit 5601340

Please sign in to comment.