This is a C++ library for security related operations for charging stations. It respects the requirements specified in OCPP and ISO15118 and can be used in combination with OCPP and ISO15118 implementations.
All documentation and the issue tracking can be found in our main repository here: https://github.com/EVerest/everest
The library requires OpenSSL 3.
Clone this repository and build with CMake.
git clone [email protected]:EVerest/libevsesecurity.git
cd libevsesecurity
mkdir build && cd build
cmake ..
make -j$(nproc) installGTest is required for building the test cases target. To build the target and run the tests use:
mkdir build && cd build
cmake -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=./dist ..
make -j$(nproc) install
make testWe allow any certificate structure with the following recommendations:
- Root CA certificate directories/bundles should not overlap leaf certificates
- It is not recommended to store any SUBCAs in the root certificate bundle (if using files)
Important: when requesting leaf certificates with get_leaf_certificate_info care should be taken if you require the full certificate chain.
If a full chain is Leaf->SubCA2->SubCA1->Root, it is recommended to have the root certificate in a single file, V2G_ROOT_CA.pem for example. The Leaf->SubCA2->SubCA1 should be placed in a file e.g. SECC_CERT_CHAIN.pem.
There are two configuration options that will add a DNS name and IP address to the subject alternative name in the certificate signing request. By default they are not added.
cmake -DCSR_DNS_NAME=charger.pionix.de ...to include a DNS namecmake -DCSR_IP_ADDRESS=192.168.2.1 ...to include an IPv4 address
When receiving back a signed CSR, the library will take care to create two files, one containing the Leaf->SubCA2->SubCA1 chain and another containing the single Leaf. When they both exist, the return of get_leaf_certificate_info will contain a path to both the single file and the chain file.
There is a configuration option to configure OpenSSL for use with a TPM.
cmake ... -DUSING_TPM2=ON
The library will use the UseTPM flag and the PEM private key file to
configure whether to use the default provider or the tpm2 provider.
Configuration is managed via propquery strings (see CMakeLists.txt)
PROPQUERY_PROVIDER_DEFAULTis the string to use when selecting the default providerPROPQUERY_PROVIDER_CUSTOMis the string to use when selecting the tpm2 provider
| propquery | action |
|---|---|
| "provider=default" | use the default provider |
| "provider=tpm2" | use the tpm2 provider |
| "provider!=tpm2" | don't use the tpm provider |
| "?provider=tpm2,tpm2.digest!=yes" | prefer the tpm2 provider but not for message digests |
For more information see:
Note: In case of errors related to CSR signing, update tpm2-openssl to v 1.2.0.
There is a configuration option to configure OpenSSL for use with a custom provider.
cmake ... -DUSING_CUSTOM_PROVIDER=ON
The workflow follows the same steps as using the TPM provider. The library will
have a flag to configure whether it uses the default provider or the custom one.
Note: The custom provider name has to be defined here. Change the name from "custom_provider" to the required provider.
By default a garbage collect function will run and delete all expired leaf certificates and their respective keys, only if the certificate storage is full. A minimum count of leaf certificates will be kept even if they are expired.
Certificate signing requests have an expiry time. If the CSMS does not respond to them within that timeframe, CSRs will be deleted.
Defaults:
- Garbage collect time: 20 minutes
- CSR expiry: 60 minutes
- Minimum certificates kept: 10
- Maximum storage space: 50 MB
- Maximum certificate entries: 2000