Skip to content

Commit 32057af

Browse files
author
Mathias Oben
committed
Initial implementation of profiles, features and handlers for 'Improved security for OCPP 1.6-J'
1 parent 06ee19a commit 32057af

15 files changed

+1136
-0
lines changed

‎ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/securityext/ClientSecurityExtEventHandler.java‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
package eu.chargetime.ocpp.feature.profile.securityext;
2+
3+
/*
4+
ChargeTime.eu - Java-OCA-OCPP
5+
6+
MIT License
7+
8+
Copyright (C) 2022 Mathias Oben <[email protected]>
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
*/
28+
29+
import eu.chargetime.ocpp.model.securityext.CertificateSignedConfirmation;
30+
import eu.chargetime.ocpp.model.securityext.CertificateSignedRequest;
31+
import eu.chargetime.ocpp.model.securityext.DeleteCertificateConfirmation;
32+
import eu.chargetime.ocpp.model.securityext.DeleteCertificateRequest;
33+
import eu.chargetime.ocpp.model.securityext.ExtendedTriggerMessageConfirmation;
34+
import eu.chargetime.ocpp.model.securityext.ExtendedTriggerMessageRequest;
35+
import eu.chargetime.ocpp.model.securityext.GetInstalledCertificateIdsConfirmation;
36+
import eu.chargetime.ocpp.model.securityext.GetInstalledCertificateIdsRequest;
37+
import eu.chargetime.ocpp.model.securityext.GetLogConfirmation;
38+
import eu.chargetime.ocpp.model.securityext.GetLogRequest;
39+
import eu.chargetime.ocpp.model.securityext.InstallCertificateConfirmation;
40+
import eu.chargetime.ocpp.model.securityext.InstallCertificateRequest;
41+
import eu.chargetime.ocpp.model.securityext.SignedUpdateFirmwareConfirmation;
42+
import eu.chargetime.ocpp.model.securityext.SignedUpdateFirmwareRequest;
43+
44+
public interface ClientSecurityExtEventHandler {
45+
/**
46+
* Handle a {@link CertificateSignedRequest} and return a {@link CertificateSignedConfirmation}.
47+
*
48+
* @param request incoming {@link CertificateSignedRequest} to handle.
49+
* @return outgoing {@link CertificateSignedConfirmation} to reply with.
50+
*/
51+
CertificateSignedConfirmation handleCertificateSignedRequest(CertificateSignedRequest request);
52+
53+
/**
54+
* Handle a {@link DeleteCertificateRequest} and return a {@link DeleteCertificateConfirmation}.
55+
*
56+
* @param request incoming {@link DeleteCertificateRequest} to handle.
57+
* @return outgoing {@link DeleteCertificateConfirmation} to reply with.
58+
*/
59+
DeleteCertificateConfirmation handleDeleteCertificateRequest(DeleteCertificateRequest request);
60+
61+
/**
62+
* Handle a {@link ExtendedTriggerMessageRequest} and return a {@link ExtendedTriggerMessageConfirmation}.
63+
*
64+
* @param request incoming {@link ExtendedTriggerMessageRequest} to handle.
65+
* @return outgoing {@link ExtendedTriggerMessageConfirmation} to reply with.
66+
*/
67+
ExtendedTriggerMessageConfirmation handleExtendedTriggerMessageRequest(ExtendedTriggerMessageRequest request);
68+
69+
/**
70+
* Handle a {@link GetInstalledCertificateIdsRequest} and return a {@link GetInstalledCertificateIdsConfirmation}.
71+
*
72+
* @param request incoming {@link GetInstalledCertificateIdsRequest} to handle.
73+
* @return outgoing {@link GetInstalledCertificateIdsConfirmation} to reply with.
74+
*/
75+
GetInstalledCertificateIdsConfirmation handleGetInstalledCertificateIdsRequest(GetInstalledCertificateIdsRequest request);
76+
77+
/**
78+
* Handle a {@link GetLogRequest} and return a {@link GetLogConfirmation}.
79+
*
80+
* @param request incoming {@link GetLogRequest} to handle.
81+
* @return outgoing {@link GetLogConfirmation} to reply with.
82+
*/
83+
GetLogConfirmation handleGetLogRequest(GetLogRequest request);
84+
85+
/**
86+
* Handle a {@link InstallCertificateRequest} and return a {@link InstallCertificateConfirmation}.
87+
*
88+
* @param request incoming {@link InstallCertificateRequest} to handle.
89+
* @return outgoing {@link InstallCertificateConfirmation} to reply with.
90+
*/
91+
InstallCertificateConfirmation handleInstallCertificateRequest(InstallCertificateRequest request);
92+
93+
/**
94+
* Handle a {@link SignedUpdateFirmwareRequest} and return a {@link SignedUpdateFirmwareConfirmation}.
95+
*
96+
* @param request incoming {@link SignedUpdateFirmwareRequest} to handle.
97+
* @return outgoing {@link SignedUpdateFirmwareConfirmation} to reply with.
98+
*/
99+
SignedUpdateFirmwareConfirmation handleSignedUpdateFirmwareRequest(SignedUpdateFirmwareRequest request);
100+
}

‎ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/securityext/ClientSecurityExtProfile.java‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
package eu.chargetime.ocpp.feature.profile.securityext;
2+
3+
/*
4+
ChargeTime.eu - Java-OCA-OCPP
5+
6+
MIT License
7+
8+
Copyright (C) 2022 Mathias Oben <[email protected]>
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
*/
28+
29+
import eu.chargetime.ocpp.feature.Feature;
30+
import eu.chargetime.ocpp.feature.ProfileFeature;
31+
import eu.chargetime.ocpp.feature.profile.Profile;
32+
import eu.chargetime.ocpp.feature.securityext.CertificateSignedFeature;
33+
import eu.chargetime.ocpp.feature.securityext.DeleteCertificateFeature;
34+
import eu.chargetime.ocpp.feature.securityext.ExtendedTriggerMessageFeature;
35+
import eu.chargetime.ocpp.feature.securityext.GetInstalledCertificateIdsFeature;
36+
import eu.chargetime.ocpp.feature.securityext.GetLogFeature;
37+
import eu.chargetime.ocpp.feature.securityext.InstallCertificateFeature;
38+
import eu.chargetime.ocpp.feature.securityext.LogStatusNotificationFeature;
39+
import eu.chargetime.ocpp.feature.securityext.SecurityEventNotificationFeature;
40+
import eu.chargetime.ocpp.feature.securityext.SignCertificateFeature;
41+
import eu.chargetime.ocpp.feature.securityext.SignedFirmwareStatusNotificationFeature;
42+
import eu.chargetime.ocpp.feature.securityext.SignedUpdateFirmwareFeature;
43+
import eu.chargetime.ocpp.model.Confirmation;
44+
import eu.chargetime.ocpp.model.Request;
45+
import eu.chargetime.ocpp.model.securityext.CertificateSignedRequest;
46+
import eu.chargetime.ocpp.model.securityext.DeleteCertificateRequest;
47+
import eu.chargetime.ocpp.model.securityext.ExtendedTriggerMessageRequest;
48+
import eu.chargetime.ocpp.model.securityext.GetInstalledCertificateIdsRequest;
49+
import eu.chargetime.ocpp.model.securityext.GetLogRequest;
50+
import eu.chargetime.ocpp.model.securityext.InstallCertificateRequest;
51+
import eu.chargetime.ocpp.model.securityext.LogStatusNotificationRequest;
52+
import eu.chargetime.ocpp.model.securityext.SecurityEventNotificationRequest;
53+
import eu.chargetime.ocpp.model.securityext.SignCertificateRequest;
54+
import eu.chargetime.ocpp.model.securityext.SignedFirmwareStatusNotificationRequest;
55+
import eu.chargetime.ocpp.model.securityext.SignedUpdateFirmwareRequest;
56+
import eu.chargetime.ocpp.model.securityext.types.FirmwareStatusEnumType;
57+
import eu.chargetime.ocpp.model.securityext.types.UploadLogStatusEnumType;
58+
59+
import java.time.ZonedDateTime;
60+
import java.util.HashSet;
61+
import java.util.Set;
62+
import java.util.UUID;
63+
64+
public class ClientSecurityExtProfile implements Profile {
65+
66+
private final Set<Feature> features;
67+
private final ClientSecurityExtEventHandler eventHandler;
68+
69+
public ClientSecurityExtProfile(ClientSecurityExtEventHandler handler) {
70+
this.features = new HashSet<>();
71+
this.eventHandler = handler;
72+
73+
features.add(new CertificateSignedFeature(this));
74+
features.add(new DeleteCertificateFeature(this));
75+
features.add(new ExtendedTriggerMessageFeature(this));
76+
features.add(new GetInstalledCertificateIdsFeature(this));
77+
features.add(new GetLogFeature(this));
78+
features.add(new InstallCertificateFeature(this));
79+
features.add(new LogStatusNotificationFeature(null));
80+
features.add(new SecurityEventNotificationFeature(null));
81+
features.add(new SignCertificateFeature(null));
82+
features.add(new SignedFirmwareStatusNotificationFeature(null));
83+
features.add(new SignedUpdateFirmwareFeature(this));
84+
}
85+
86+
@Override
87+
public ProfileFeature[] getFeatureList() {
88+
return features.toArray(new ProfileFeature[0]);
89+
}
90+
91+
@Override
92+
public Confirmation handleRequest(UUID sessionIndex, Request request) {
93+
Confirmation result = null;
94+
95+
if (request instanceof CertificateSignedRequest) {
96+
result = eventHandler.handleCertificateSignedRequest((CertificateSignedRequest) request);
97+
} else if (request instanceof DeleteCertificateRequest) {
98+
result = eventHandler.handleDeleteCertificateRequest((DeleteCertificateRequest) request);
99+
} else if (request instanceof ExtendedTriggerMessageRequest) {
100+
result = eventHandler.handleExtendedTriggerMessageRequest((ExtendedTriggerMessageRequest) request);
101+
} else if (request instanceof GetInstalledCertificateIdsRequest) {
102+
result = eventHandler.handleGetInstalledCertificateIdsRequest((GetInstalledCertificateIdsRequest) request);
103+
} else if (request instanceof GetLogRequest) {
104+
result = eventHandler.handleGetLogRequest((GetLogRequest) request);
105+
} else if (request instanceof InstallCertificateRequest) {
106+
result = eventHandler.handleInstallCertificateRequest((InstallCertificateRequest) request);
107+
}else if (request instanceof SignedUpdateFirmwareRequest) {
108+
result = eventHandler.handleSignedUpdateFirmwareRequest((SignedUpdateFirmwareRequest) request);
109+
}
110+
111+
return result;
112+
}
113+
114+
/**
115+
* Create a client {@link LogStatusNotificationRequest} with required values.
116+
*
117+
* @return an instance of {@link LogStatusNotificationRequest}.
118+
* @see LogStatusNotificationRequest
119+
* @see LogStatusNotificationFeature
120+
*/
121+
public LogStatusNotificationRequest createLogStatusNotificationRequest(UploadLogStatusEnumType status) {
122+
return new LogStatusNotificationRequest(status);
123+
}
124+
125+
/**
126+
* Create a client {@link SecurityEventNotificationRequest} with required values.
127+
*
128+
* @return an instance of {@link SecurityEventNotificationRequest}
129+
* @see SecurityEventNotificationRequest
130+
* @see SecurityEventNotificationFeature
131+
*/
132+
public SecurityEventNotificationRequest createSecurityEventNotificationRequest(String type, ZonedDateTime timestamp) {
133+
return new SecurityEventNotificationRequest(type, timestamp);
134+
}
135+
136+
/**
137+
* Create a client {@link SignCertificateRequest} with required values.
138+
*
139+
* @return an instance of {@link SignCertificateRequest}.
140+
* @see SignCertificateRequest
141+
* @see SignCertificateFeature
142+
*/
143+
public SignCertificateRequest createSignCertificateRequest(String csr) {
144+
return new SignCertificateRequest(csr);
145+
}
146+
147+
/**
148+
* Create a client {@link SignedFirmwareStatusNotificationRequest}.
149+
*
150+
* @return an instance of {@link SignedFirmwareStatusNotificationRequest}
151+
* @see SignedFirmwareStatusNotificationRequest
152+
* @see SignedFirmwareStatusNotificationFeature
153+
*/
154+
public SignedFirmwareStatusNotificationRequest createSignedFirmwareStatusNotificationRequest(FirmwareStatusEnumType status) {
155+
return new SignedFirmwareStatusNotificationRequest(status);
156+
}
157+
}

‎ocpp-v1_6/src/main/java/eu/chargetime/ocpp/feature/profile/securityext/ServerSecurityExtEventHandler.java‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
package eu.chargetime.ocpp.feature.profile.securityext;
2+
3+
/*
4+
ChargeTime.eu - Java-OCA-OCPP
5+
6+
MIT License
7+
8+
Copyright (C) 2022 Mathias Oben <[email protected]>
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
*/
28+
29+
import eu.chargetime.ocpp.model.securityext.LogStatusNotificationConfirmation;
30+
import eu.chargetime.ocpp.model.securityext.LogStatusNotificationRequest;
31+
import eu.chargetime.ocpp.model.securityext.SecurityEventNotificationConfirmation;
32+
import eu.chargetime.ocpp.model.securityext.SecurityEventNotificationRequest;
33+
import eu.chargetime.ocpp.model.securityext.SignCertificateConfirmation;
34+
import eu.chargetime.ocpp.model.securityext.SignCertificateRequest;
35+
import eu.chargetime.ocpp.model.securityext.SignedFirmwareStatusNotificationConfirmation;
36+
import eu.chargetime.ocpp.model.securityext.SignedFirmwareStatusNotificationRequest;
37+
38+
import java.util.UUID;
39+
40+
public interface ServerSecurityExtEventHandler {
41+
/**
42+
* Handle a {@link LogStatusNotificationRequest} and return a {@link LogStatusNotificationConfirmation}.
43+
*
44+
* @param sessionIndex source of the request.
45+
* @param request incoming {@link LogStatusNotificationRequest} to handle.
46+
* @return outgoing {@link LogStatusNotificationConfirmation} to reply with.
47+
*/
48+
LogStatusNotificationConfirmation handleLogStatusNotificationRequest(UUID sessionIndex, LogStatusNotificationRequest request);
49+
50+
/**
51+
* Handle a {@link SecurityEventNotificationRequest} and return a {@link SecurityEventNotificationConfirmation}.
52+
*
53+
* @param sessionIndex source of the request.
54+
* @param request incoming {@link SecurityEventNotificationRequest} to handle.
55+
* @return outgoing {@link SecurityEventNotificationConfirmation} to reply with.
56+
*/
57+
SecurityEventNotificationConfirmation handleSecurityEventNotificationRequest(UUID sessionIndex, SecurityEventNotificationRequest request);
58+
59+
/**
60+
* Handle a {@link SignCertificateRequest} and return a {@link SignCertificateConfirmation}.
61+
*
62+
* @param sessionIndex source of the request.
63+
* @param request incoming {@link SignCertificateRequest} to handle.
64+
* @return outgoing {@link SignCertificateConfirmation} to reply with.
65+
*/
66+
SignCertificateConfirmation handleSignCertificateRequest(UUID sessionIndex, SignCertificateRequest request);
67+
68+
/**
69+
* Handle a {@link SignedFirmwareStatusNotificationRequest} and return a {@link SignedFirmwareStatusNotificationConfirmation}.
70+
*
71+
* @param sessionIndex source of the request.
72+
* @param request incoming {@link SignedFirmwareStatusNotificationRequest} to handle.
73+
* @return outgoing {@link SignedFirmwareStatusNotificationConfirmation} to reply with.
74+
*/
75+
SignedFirmwareStatusNotificationConfirmation handleSignedFirmwareStatusNotificationRequest(UUID sessionIndex, SignedFirmwareStatusNotificationRequest request);
76+
}

0 commit comments

Comments
 (0)