API for EVerest API clients that use the EvseSecurity module. Experimental: this API is exempt from the EVerest stability guarantees and the deprecation period; channels, operations and message payloads may change without further notice until it is promoted to stable.
default local MQTT
The ID of the module as defined in the EVerest config file.
Command that indicates if the given CA certificate type is installed
Available only on servers:
Accepts the following message:
Command that indicates if the given CA certificate type is installed
Ask if certificated of type CSMS is installed
{
"headers": {
"replyTo": "reply/to/address"
},
"payload": "CSMS"
}
Accepts the following message:
Reply to is ca certificate installed
True if CA certificate is installed, else false
Command to get the paths of the certificate and the respective key
Available only on servers:
Accepts the following message:
Command to get the paths of the certificate and the respective key
Get information for CSMS type certificate
{
"headers": {
"replyTo": "reply/to/address"
},
"payload": {
"certificate_type": "CSMS",
"encoding": "PEM",
"include_ocsp": false
}
}
Accepts the following message:
Reply to get leaf certificate info
Response to the command get_leaf_certificate_info
Reply to get information request
{
"status": "Accepted",
"info": {
"key": "/etc/everest/certs/client/csms.key",
"certificate_count": 1
}
}
Command to get the path of the CA certificates for verification: the bundle file if the CA store is a file, otherwise the directory (c_rehash is invoked on it)
Available only on servers:
Accepts the following message:
Command to get the path of the CA certificates for verification: the bundle file if the CA store is a file, otherwise the directory (c_rehash is invoked on it)
Get file path for V2G CA root directory
{
"headers": {
"replyTo": "reply/to/address"
},
"payload": "V2G"
}
Accepts the following message:
Reply to get verify location. The payload is the path as plain text, not a JSON string. It is empty if no CA certificate is found.
Path of the CA bundle file or CA directory, as plain text
Return the CA bundle file or directory
/path/to/ca/certificates
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.
CommunicationCheck
Command that indicates if the given CA certificate type is installed
Reply to is ca certificate installed
True if CA certificate is installed, else false
Command to get the paths of the certificate and the respective key
Reply to get leaf certificate info
Response to the command get_leaf_certificate_info
Command to get the path of the CA certificates for verification: the bundle file if the CA store is a file, otherwise the directory (c_rehash is invoked on it)
Reply to get verify location. The payload is the path as plain text, not a JSON string. It is empty if no CA certificate is found.
Path of the CA bundle file or CA directory, as plain text
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.
Enum specifies the type of a CA certificate
Enum specifies the type of a leaf certificate
Enum specifies the encoding of certificates or keys
Status indicates the result of the attempt to retrieve a certificate
Enum specifies a hash algorithm
Type specifies the hash data of a certificate
OCSP data related to requested the certificates
Type that specifies the paths of a certificate and the respective private key
Response to the command get_leaf_certificate_info
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Send true at least every cfg_communication_check_to_s seconds to signal that the client is alive, otherwise EVerest raises a CommunicationFault, which the next message clears. Send false to stop the check until the module restarts.