Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EvseSecurity module documentation #591

Merged
merged 9 commits into from
Mar 22, 2024
Merged

Conversation

Pietfried
Copy link
Contributor

@Pietfried Pietfried commented Mar 19, 2024

Describe your changes

This PR adds custom module documentation for the EvseSecurity module

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • I read the contribution documentation and made sure that my changes meet its requirements

Copy link
Contributor

@AssemblyJohn AssemblyJohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@Pietfried Pietfried force-pushed the docs/evse-security-module branch 5 times, most recently from dc9c372 to 1813d3f Compare March 19, 2024 14:37
Signed-off-by: pietfried <[email protected]>
@Pietfried Pietfried marked this pull request as ready for review March 20, 2024 13:25
@krealyt
Copy link
Contributor

krealyt commented Mar 20, 2024

Should we delete the docs directory? There is another index.rst in there that seems not to be needed.

I guess the current docs concept is: Having either the docs directory OR the docs.rst, right?

Signed-off-by: pietfried <[email protected]>
Copy link
Contributor

@barsnick barsnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I welcome these docs!

I miss an instruction on the expected bundles and how to construct them. Trying to use certificates from CharIN (testival Jan 2024, created by Keysight), I reverse-engineered what is created by cmake and make install in everest-core in order to get libevse-security to accept them.

modules/EvseSecurity/doc.rst Show resolved Hide resolved
Configuration for ISO15118
--------------------------

For ISO15118 communication, the charging station provides a server endpoint to which the electric vehicle connects. The communication may be secured using TLS. TLS is mandatory for Plug&Charge. If TLS is used, the correct configuration of the ``secc_leaf_cert_directory`` and ``secc_leaf_key_directory`` is required. These directories are used to locate the server certificate and key for the ISO15118 TLS server provided by the charging station.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fun fact: In ISO 15118-20, PnC expands to "Park'n'Charge" 😉

@Pietfried
Copy link
Contributor Author

I welcome these docs!

I miss an instruction on the expected bundles and how to construct them. Trying to use certificates from CharIN (testival Jan 2024, created by Keysight), I reverse-engineered what is created by cmake and make install in everest-core in order to get libevse-security to accept them.

The docs of this module attempt to be a generic description of what the module does and mainly how you should configure it including some advice for OCPP and ISO15118. Further, there is Plug&Charge tutorial coming up soon.

We're thinking about adding a broader explaination of how all the security relevant processes and access is related across multiple EVerest modules (OCPP, EvseV2G, EvseManager, Auth, EvseSecurity) for ISO15118, Plug&Charge and OCPP.

@Pietfried Pietfried merged commit a5e4173 into main Mar 22, 2024
5 checks passed
@Pietfried Pietfried deleted the docs/evse-security-module branch March 22, 2024 09:09
@hikinggrass hikinggrass added the include-in-release Tag that this PR should be included in the current merge window for the upcoming release if possible label Apr 2, 2024
hikinggrass pushed a commit that referenced this pull request Apr 2, 2024
* EvseSecurity module documentation
---------

Signed-off-by: pietfried <[email protected]>
Signed-off-by: Krealyt <[email protected]>
Co-authored-by: Krealyt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
include-in-release Tag that this PR should be included in the current merge window for the upcoming release if possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants