API for EVerest API clients that use the EvseSecurity module.
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 file path of the CA root directory that can be used for verification. Will also invoke c_rehash for that directory
Available only on servers:
Accepts the following message:
Command to get the file path of the CA root directory that can be used for verification. Will also invoke c_rehash for that directory
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 path of the CA certificates directory
Return the CA root 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 module is alive. Send 'false' to stop communication check
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 file path of the CA root directory that can be used for verification. Will also invoke c_rehash for that directory
Reply to get verify location
The path of the CA certificates directory
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 module is alive. Send 'false' to stop communication check
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 module is alive. Send 'false' to stop communication check