Manage Certificate Authorities (CAs) used for client certificate based
authentication. The topic of the plugins control API is
$CONTROL/certificate-management/v1.
Currently supported commands offered by the API are insertCACertificate,
which can be used to extend the known Certificate Authorities (CAs). To
delete an existing CA the deleteCACertificate command can be used.
Accepts the following message:
{
"commands": [
{
"command": "insertCACertificate",
"listener_id": 2,
"file_name": "client_ca.pem",
"ca_cert_pem": "-----BEGIN CERTIFICATE-----\nMII...EyQ==\n-----END CERTIFICATE-----\n"
}
]
}
{
"commands": [
{
"command": "deleteCACertificate",
"listener_id": 2,
"file_name": "client_ca.pem"
}
]
}
Accepts the following message:
{
"responses": [
{
"command": "insertCACertificate",
"data": {
"response": "SUCCESS"
},
"correlationData": "1234-request"
}
]
}
{
"responses": [
{
"command": "deleteCACertificate",
"data": {
"response": "SUCCESS"
},
"correlationData": "1234-request"
}
]
}
{
"responses": [
{
"command": "insertCACertificate",
"error": "File already exists",
"correlationData": "1234-request"
}
]
}
Command which describes the action processed by the plugin. Currently only inserting and deleting custom CAs is supported.
Specifies the listener the CA certificate should be applied to.
Available listeners can be determined using the listListeners
broker control API command.
Name of CA certificate file stored in the configured capath.
Must follow the Linux file naming conventions.
This is an optional value to be able to identify the relation between request and response. The plugin will add the provided value in the response message.