cisco IOS XE 17.16.x — Revoke RPC

rpc Rotate(stream RotateCertificateRequest) returns (stream RotateCertificateResponse); // Request messages to rotate existing certificates on the target. message RotateCertificateRequest { // Request Messages. oneof rotate_request { GenerateCSRRequest generate_csr = 1; LoadCertificateRequest load_certificate = 2; FinalizeRequest finalize_rotation = 3; } } // A Finalize message is sent to the target to confirm the Rotation of // the certificate and that the certificate should not be rolled back when // the RPC concludes. The certificate must be rolled back if the target returns // an error after receiving a Finalize message.

message FinalizeRequest { } message RotateCertificateResponse { // Response messages. oneof rotate_response { GenerateCSRResponse generated_csr = 1; LoadCertificateResponse load_certificate = 2; } } The Rotate RPC differs from the Install RPC in the following ways: • PKI has to save or cache the old certificate and the CA certificate when installing a new certificate (for the purpose of rollback). • The controller creates a new connection to test whether the renewed certificate works, and in case of success, finalizes the certificate rotation. Revoke RPC This RPC is used to revoke one or more certificates, each uniquely identified by a certificate ID.

Revocation of a certificate results in the corresponding trustpoint to be removed from the Cisco IOS XE configuration. If the corresponding trustpoints are currently in use, or if the trustpoints do not exist, revocation of the certificates may fail. A RevokeCertificate RPC may have certificates revoked successfully or unsuccessfully. On the target device, revocation is a simple delete operation; the actual revocation with the CA is done by the client. If the client revokes a certificate that is in use, new connections fail, but the existing connections are unaffected. The following is a sample RevokeCertificate RPC: // An RPC to revoke specific certificates.

// If a certificate is not present on the target, the request should silently // succeed. Revoking a certificate should render the existing certificate // unusable by any endpoints. rpc RevokeCertificates(RevokeCertificatesRequest) returns (RevokeCertificatesResponse); message RevokeCertificatesRequest { // Certificates to revoke. Model-Driven Programmability Revoke RPC Programmability Configuration Guide, Cisco IOS XE 17.16.x 279