LibItsPki_Functions.ttcn 24.3 KB
Newer Older
Yann Garcia's avatar
Yann Garcia committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
/**
 *  @author   ETSI / STF544
 *  @version  $URL$
 *            $Id$
 *  @desc     Module containing functions for ITS PKI ATS
 *  @copyright   ETSI Copyright Notification
 *               No part may be reproduced except as authorized by written permission.
 *               The copyright and the foregoing restriction extend to reproduction in all media.
 *               All rights reserved.
 *
 */
module LibItsPki_Functions {
    
  // LibCommon
  import from LibCommon_Time all;
  import from LibCommon_VerdictControl all;
  import from LibCommon_Sync all;
  import from LibCommon_BasicTypesAndValues all;
  import from LibCommon_DataStrings all;
  
  // LibIts
  import from IEEE1609dot2BaseTypes language "ASN.1:1997" all;
  import from IEEE1609dot2 language "ASN.1:1997" all;
  import from EtsiTs102941BaseTypes language "ASN.1:1997" all;
  import from EtsiTs102941TypesEnrolment language "ASN.1:1997" all;
  import from EtsiTs102941MessagesItss language "ASN.1:1997" all;
  import from EtsiTs103097Module language "ASN.1:1997" all;
  import from ITS_Container language "ASN.1:1997" all;
  import from CAM_PDU_Descriptions language "ASN.1:1997" all;
  
  // LibItsCommon
garciay's avatar
garciay committed
32
  import from LibItsCommon_TypesAndValues all;
Yann Garcia's avatar
Yann Garcia committed
33
34
35
  import from LibItsCommon_Functions all;
  import from LibItsCommon_ASN1_NamedNumbers all;
  import from LibItsCommon_Pixits all;
garciay's avatar
garciay committed
36
  
Yann Garcia's avatar
Yann Garcia committed
37
38
39
40
41
  // LibItsSecurity
  import from LibItsSecurity_TypesAndValues all;
  import from LibItsSecurity_Templates all;
  import from LibItsSecurity_Functions all;
  import from LibItsSecurity_Pixits all;
garciay's avatar
garciay committed
42
  
Yann Garcia's avatar
Yann Garcia committed
43
44
45
  // LibItsHttp
  import from LibItsHttp_TypesAndValues all;
  import from LibItsHttp_TestSystem all;
garciay's avatar
garciay committed
46
  
Yann Garcia's avatar
Yann Garcia committed
47
  // LibItsPki
garciay's avatar
garciay committed
48
  import from LibItsPki_TypesAndValues all;
Yann Garcia's avatar
Yann Garcia committed
49
  import from LibItsPki_Templates all;
garciay's avatar
garciay committed
50
  import from LibItsPki_Pics all;
Yann Garcia's avatar
Yann Garcia committed
51
  import from LibItsPki_TestSystem all;
garciay's avatar
garciay committed
52
53
  
  group pkiConfigurationFunctions {
Yann Garcia's avatar
Yann Garcia committed
54
55
56
57
58
59
60
61
62
63
     
    /**
     * @desc    Setups default configuration   
     * @param   p_certificateId The certificate identifier the TA shall use in case of secured IUT
     */
    function f_cfUp(
                    in charstring p_certificateId := "CERT_TS_A_EA" // TODO Use a constant
                   ) runs on ItsPki /* TITAN TODO: system ItsPkiSystem */ {
            
      map(self:pkiPort, system:pkiPort);
64
      map(self:acPkiPort, system:acPkiPort);
Yann Garcia's avatar
Yann Garcia committed
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
      f_connect4SelfOrClientSync();
      
      if( not f_loadCertificates(PX_IUT_SEC_CONFIG_NAME) ) {
        log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
        stop;
      }
      
      f_prepareCertificates(p_certificateId, vc_aaCertificate, vc_atCertificate);
      f_readCertificate(p_certificateId, vc_eaCertificate);
    } // End of function f_cfUp
    
    /**
     * @desc    Setups default configuration   
     * @param   p_certificateId The certificate identifier the TA shall use in case of secured IUT
     */
    function f_cfHttpUp(
                        in charstring p_certificateId  := "CERT_TS_A_EA" // TODO Use a constant
                       ) runs on ItsPkiHttp /* TITAN TODO: system ItsPkiHttpSystem */ {
      
      map(self:httpPort, system:httpPort);
      f_connect4SelfOrClientSync();
      
      if( not f_loadCertificates(PX_IUT_SEC_CONFIG_NAME) ) {
        log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
        stop;
      }
      
      f_prepareCertificates(p_certificateId, vc_aaCertificate, vc_atCertificate);
      f_readCertificate(p_certificateId, vc_eaCertificate);
94
95
      f_readSigningKey(p_certificateId, vc_eaPrivateKey);
      f_getCertificateDigest(p_certificateId, vc_eaHashedId8);
Yann Garcia's avatar
Yann Garcia committed
96
    } // End of function f_cfHttpUp
97
    
Yann Garcia's avatar
Yann Garcia committed
98
99
100
101
102
    /**
     * @desc    Deletes default configuration 
     */
    function f_cfDown() runs on ItsPki /* TITAN TODO: system ItsPkiSystem */ {
      unmap(self:pkiPort, system:pkiPort);
103
      unmap(self:acPkiPort, system:acPkiPort);
Yann Garcia's avatar
Yann Garcia committed
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
      f_disconnect4SelfOrClientSync();
    } // End of function f_cfDown
    
    /**
     * @desc    Deletes default configuration 
     */
    function f_cfHttpDown() runs on ItsPkiHttp /* TITAN TODO: system ItsPkiHttpSystem */ {
      unmap(self:httpPort, system:httpPort);
      f_disconnect4SelfOrClientSync();
    } // End of function f_cfHttpDown
    
    /**
     * @desc Initialise secure mode if required
     */
    function f_initialiseSecuredMode() runs on ItsPki {
      // Local variables
      
      // Load certificates
      if( not f_loadCertificates(PX_IUT_SEC_CONFIG_NAME) ) {
        log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
        stop;
      }
      
    } // End of function f_initialiseSecuredMode()
        
    function f_uninitialiseSecuredMode() runs on ItsPki {
      f_unloadCertificates();
    } // End of function f_uninitialiseSecuredMode()
        
  } // End of pkiConfigurationFunctions
garciay's avatar
garciay committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

  group ac_port {

    function f_sendAcPkiPrimitive(
                                  in octetstring p_private_key,
                                  in octetstring p_publicKeyCompressed,
                                  in integer p_compressedMode
                                  ) runs on ItsPki {
      var AcSetSecurityData v_ac_set_security_data;
      
      v_ac_set_security_data := { PICS_TS_CERTIFICATE_ID, PICS_IUT_CERTIFICATE_ID, p_private_key, p_publicKeyCompressed, p_compressedMode };
      acPkiPort.send(AcPkiPrimitive: { acSetSecurityData := v_ac_set_security_data });
      tc_ac.start;
      alt {
        [] acPkiPort.receive(AcPkiResponse: { result := true }) {
          tc_ac.stop;
        }
        [] acPkiPort.receive(AcPkiResponse: { result := false }) {
          tc_ac.stop;
          log("*** f_sendAcPkiPrimitive: ERROR: Received unexpected message ***");
          f_selfOrClientSyncAndVerdict("error", e_error);
        }
        [] tc_ac.timeout {
          log("*** f_sendAcPkiPrimitive: ERROR: Timeout while waiting for adapter control event result ***");
          f_selfOrClientSyncAndVerdict("error", e_timeout);
        }
      } // End of 'alt' statement
    }
    
  } // End of group ac_port
Yann Garcia's avatar
Yann Garcia committed
164
165
166
  
  group inner_ec_xxx {
    
garciay's avatar
garciay committed
167
168
169
170
171
172
173
174
    function f_generate_inner_ec_request(
                                         out Oct32 p_private_key,
                                         out Oct32 p_publicKeyX,
                                         out Oct32 p_publicKeyY,
                                         out Oct32 p_publicKeyCompressed,
                                         out integer p_compressedMode,
                                         out InnerEcRequest p_inner_ec_request
                                         ) return boolean {
Yann Garcia's avatar
Yann Garcia committed
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
      // Local variables
      var template (value) EccP256CurvePoint v_eccP256_curve_point;
      
      // Generate keys for the certificate to be requested
      if (f_generate_key_pair_nistp256(p_private_key, p_publicKeyX, p_publicKeyY, p_publicKeyCompressed, p_compressedMode) == false) {
        return false;
      }
      log("p_private_key = ", p_private_key);
      log("p_public_key X= ", p_publicKeyX);
      log("p_public_key Y= ", p_publicKeyY);
      log("p_public_key compressed= ", p_publicKeyCompressed, p_compressedMode);
      if (p_compressedMode == 0) {
        v_eccP256_curve_point := m_eccP256CurvePoint_compressed_y_0(p_publicKeyCompressed);
      } else {
        v_eccP256_curve_point := m_eccP256CurvePoint_compressed_y_1(p_publicKeyCompressed);
      }
garciay's avatar
garciay committed
191
      // Build the Proof of Possession InnerEcRequest
Yann Garcia's avatar
Yann Garcia committed
192
193
      p_inner_ec_request := valueof(
                                    m_innerEcRequest(
garciay's avatar
garciay committed
194
                                                     "CanonicalItsId", // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
195
196
197
198
199
200
201
202
203
                                                     m_publicKeys(
                                                                  m_publicVerificationKey_ecdsaNistP256(v_eccP256_curve_point),
                                                                  m_encryptionKey(
                                                                                  -,
                                                                                  m_publicEncryptionKey_ecdsaNistP256(v_eccP256_curve_point)
                                                                                 )
                                                                  ),
                                                     m_certificateSubjectAttributes(
                                                                                    { // ETSI TS 102 965 Table A.1: ETSI ITS standardized ITS-AIDs
garciay's avatar
garciay committed
204
205
                                                                                      valueof(m_appPermissions(36, { bitmapSsp := '830001'O })), // TODO Use PIXIT
                                                                                      valueof(m_appPermissions(37, { bitmapSsp := '830001'O })) // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
206
207
208
                                                                                    },
                                                                                    m_validityPeriod(
                                                                                                             17469212,
garciay's avatar
garciay committed
209
                                                                                                             m_duration_years(10) // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
210
211
212
                                                                                                            ),
                                                                                    m_geographicRegion_identifiedRegion(
                                                                                                                                {
garciay's avatar
garciay committed
213
214
                                                                                                                                  m_identifiedRegion_country_only(12), // TODO Use PIXIT
                                                                                                                                  m_identifiedRegion_country_only(34) // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
215
216
                                                                                                                                }
                                                                                                                               ),
garciay's avatar
garciay committed
217
                                                                                    'C0'O // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
218
219
                                                                                   )
                                            )
garciay's avatar
garciay committed
220
                                    );
Yann Garcia's avatar
Yann Garcia committed
221
222
      
      return true;
garciay's avatar
garciay committed
223
    } // End of function f_generate_inner_ec_request
Yann Garcia's avatar
Yann Garcia committed
224
    
garciay's avatar
garciay committed
225
226
227
228
    function f_generate_inner_ec_request_signed_for_pop(
                                                        in Oct32 p_private_key,
                                                        in InnerEcRequest p_inner_ec_request,
                                                        out Ieee1609Dot2Data p_inner_ec_request_signed_for_pop
Yann Garcia's avatar
Yann Garcia committed
229
230
231
232
233
234
    ) return boolean {
      // Local variables
      var template (value) EccP256CurvePoint v_eccP256_curve_point;
      var octetstring v_encoded_inner_ec_request;
      var template (value) ToBeSignedData v_tbs;
      var Oct32 v_tbs_signed;
garciay's avatar
garciay committed
235
236
237
238
239
240
241
242
243
244
245
246
      
      // Encode it
      v_encoded_inner_ec_request := bit2oct(encvalue(p_inner_ec_request));
      // Signed the encoded InnerEcRequestSignedForPop
      v_tbs := m_toBeSignedData(
                                m_signedDataPayload(
                                                    m_etsiTs103097Data_unsecured(
                                                                                 v_encoded_inner_ec_request
                                                                                 )
                                                   ),
                                m_headerInfo_inner_ec_request(
                                                              c_its_aid_SCR,
247
                                                              f_getCurrentTimeUtc())
garciay's avatar
garciay committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
                               );
      // Signed the encoded InnerEcRequestSignedForPop
      v_tbs_signed := f_signWithEcdsaNistp256WithSha256(bit2oct(encvalue(v_tbs)), int2oct(0, 32), p_private_key);
      // Finalyse signed InnerEcRequestSignedForPop
      p_inner_ec_request_signed_for_pop := valueof(
                                                   m_etsiTs103097Data_signed(
                                                                             m_signedData(
                                                                                          sha256,
                                                                                          v_tbs,
                                                                                          m_signerIdentifier_self,
                                                                                          m_signature_ecdsaNistP256(
                                                                                                                    m_ecdsaP256Signature(
                                                                                                                                         m_eccP256CurvePoint_x_only(
                                                                                                                                                                    substr(v_tbs_signed, 0, 32)
                                                                                                                                                                    ),
                                                                                                                                         substr(v_tbs_signed, 32, 32)
                                                                                                                                         )
                                                                                                                    )
                                                                                          )
                                                                             )
                                                   );
      return true;
    } // End of function f_generate_inner_ec_request_signed_for_pop
    
  } // End of group inner_ec_xxx

  group pki_functions {
275
276
277
278
279
280
281
282
283
284
285
286
287

    /**
     * @desc Build a signed and encrypted PKI message
     * @param p_private_key         Private key for signature
     * @param p_signer_identifier   Signer identifier for signature, could be self or certificate HashedId8
     * @param p_recipientId         Recipient identifier to be inclued in encrypted layer.
     *                              If value is int2oct(0. 8), the recipient id is the HashedId8 of the symmetric key used by the sender to encrypt the message to which the response is built
     * @param p_publicKeyCompressed The public compressed key (canonical form) for encryption
     * @param p_compressedMode      The compressed mode of the public compressed key (canonical form) for encryption
     * @param p_pki_message         The PKI message to be secured
     * @param p_ieee1609dot2_signed_and_encrypted_data The secured message
     * @return true on success, false otherwise
     */
garciay's avatar
garciay committed
288
    function f_build_pki_secured_message(
289
                                         in octetstring p_private_key,
290
291
                                         in SignerIdentifier p_signer_identifier,
                                         in HashedId8 p_recipientId,
garciay's avatar
garciay committed
292
293
294
295
296
297
298
299
300
                                         in Oct32 p_publicKeyCompressed,
                                         in integer p_compressedMode,
                                         in octetstring p_pki_message, 
                                         out Ieee1609Dot2Data p_ieee1609dot2_signed_and_encrypted_data
                                         ) return boolean {
      // Local variables
      var template (value) EccP256CurvePoint v_eccP256_curve_point;
      var template (value) ToBeSignedData v_tbs;
      var Oct32 v_tbs_signed;
Yann Garcia's avatar
Yann Garcia committed
301
      var template (value) Ieee1609Dot2Data v_ieee1609dot2_signed_data;
garciay's avatar
garciay committed
302
      var octetstring v_encoded_inner_ec_request;
Yann Garcia's avatar
Yann Garcia committed
303
304
305
      var Oct12 v_nonce;
      var Oct16 v_authentication_vector;
      var Oct16 v_encrypted_sym_key;
306
      var HashedId8 v_recipientId;
Yann Garcia's avatar
Yann Garcia committed
307
308
309
      var Oct32 v_publicEphemeralKeyCompressed;
      var integer v_ephemeralKeyModeCompressed;
      var octetstring v_encrypted_inner_ec_request;
310

311
      // Signed the encoded PKI message
Yann Garcia's avatar
Yann Garcia committed
312
313
      v_tbs := m_toBeSignedData(
                                m_signedDataPayload(
garciay's avatar
garciay committed
314
                                                    m_etsiTs103097Data_unsecured(p_pki_message)
Yann Garcia's avatar
Yann Garcia committed
315
                                                   ),
316
                                m_headerInfo_inner_ec_request(12345, f_getCurrentTimeUtc()) // TODO Use PIXIT
Yann Garcia's avatar
Yann Garcia committed
317
                               );
318
319
320
321
322
323
324
325
326
327
      if (ischosen(p_signer_identifier.self_)) {
        v_tbs_signed := f_signWithEcdsaNistp256WithSha256(bit2oct(encvalue(v_tbs)), int2oct(0, 32), p_private_key);
      } else {
        var charstring v_certificate_id;
        var octetstring v_hash;
        fx_readCertificateFromDigest(p_signer_identifier.digest, v_certificate_id); // TODO Add a wrapper function
        f_getCertificateHash(v_certificate_id, v_hash);
        v_tbs_signed := f_signWithEcdsaNistp256WithSha256(bit2oct(encvalue(v_tbs)), v_hash, p_private_key);
      }
      // Add the signature and create EtsiTs103097Data-Signed data structure
Yann Garcia's avatar
Yann Garcia committed
328
329
330
331
      v_ieee1609dot2_signed_data := m_etsiTs103097Data_signed(
                                                              m_signedData(
                                                                           sha256,
                                                                           v_tbs,
332
                                                                           p_signer_identifier,
Yann Garcia's avatar
Yann Garcia committed
333
334
335
336
337
338
339
340
341
342
                                                                           m_signature_ecdsaNistP256(
                                                                                                     m_ecdsaP256Signature(
                                                                                                                          m_eccP256CurvePoint_x_only(
                                                                                                                                                     substr(v_tbs_signed, 0, 32)
                                                                                                                                                     ),
                                                                                                                          substr(v_tbs_signed, 32, 32)
                                                                                                                          )
                                                                                                     )
                                                                           )
                                                      );
343
      // Encode EtsiTs103097Data-Signed data structure
Yann Garcia's avatar
Yann Garcia committed
344
      v_encoded_inner_ec_request := bit2oct(encvalue(v_ieee1609dot2_signed_data));
345
      // Encrypt encode EtsiTs103097Data-Signed data structure
Yann Garcia's avatar
Yann Garcia committed
346
      v_encrypted_inner_ec_request := f_encryptWithEciesNistp256WithSha256(v_encoded_inner_ec_request, p_publicKeyCompressed, p_compressedMode, v_publicEphemeralKeyCompressed, v_ephemeralKeyModeCompressed, v_encrypted_sym_key, v_authentication_vector, v_nonce);
347
348
349
350
351
352
353
354
355
      log("p_recipientId=", p_recipientId);
      if (p_recipientId == int2oct(0, 8)) {
        log("v_encrypted_sym_key=", v_encrypted_sym_key);
        log("f_hashWithSha256(v_encrypted_sym_key=", f_hashWithSha256(v_encrypted_sym_key));
        v_recipientId := f_HashedId8FromSha256(f_hashWithSha256(v_encrypted_sym_key));
      } else {
        v_recipientId := p_recipientId;
      }
      log("v_recipientId=", v_recipientId);
Yann Garcia's avatar
Yann Garcia committed
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
      // Fill Certificate template with the public compressed keys (canonical form)
      if (v_ephemeralKeyModeCompressed == 0) {
        v_eccP256_curve_point := valueof(m_eccP256CurvePoint_compressed_y_0(v_publicEphemeralKeyCompressed));
      } else {
        v_eccP256_curve_point := valueof(m_eccP256CurvePoint_compressed_y_1(v_publicEphemeralKeyCompressed));
      }
      p_ieee1609dot2_signed_and_encrypted_data := valueof(
                                                          m_etsiTs103097Data_encrypted(
                                                                                       m_encryptedData(
                                                                                                       {
                                                                                                        m_recipientInfo_signedDataRecipInfo(
                                                                                                                                            m_pKRecipientInfo(
                                                                                                                                                              v_recipientId,
                                                                                                                                                              m_encryptedDataEncryptionKey_eciesNistP256(
                                                                                                                                                                                                      m_evciesP256EncryptedKey(
                                                                                                                                                                                                                               v_eccP256_curve_point,
                                                                                                                                                                                                                               v_encrypted_sym_key, 
                                                                                                                                                                                                                               v_authentication_vector
                                                                                                        ))))
                                                                                                       },
                                                                                                       m_SymmetricCiphertext_aes128ccm(
                                                                                                                                       m_aesCcmCiphertext(
                                                                                                                                                          v_nonce, 
                                                                                                                                                          v_encrypted_inner_ec_request
                                                                                                                                                         )
                                                                                                                                      )
                                                                                                      )
                                                                                       )
                                                         );
      
      return true;
garciay's avatar
garciay committed
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
    } // End of function f_build_pki_secured_message
    
    function f_generate_inner_ec_response(
                                          in Oct32 p_inner_ec_request_hashed_id,
                                          in EtsiTs103097Certificate p_certificate,
                                          out InnerEcResponse p_inner_ec_response
                                         ) return boolean {
      // Local variables
      
      // Build the Proof of Possession InnerEcResponse
      p_inner_ec_response := valueof(
                                     m_innerEcResponse_ok(
                                                          substr(p_inner_ec_request_hashed_id, 0, 16),
                                                          p_certificate
                                                          )
                                     );
      
      return true;
    } // End of function f_generate_inner_ec_response
Yann Garcia's avatar
Yann Garcia committed
406
407
408
409
    
  } // End of group inner_ec_xxx
  
} // End of module LibItsPki_Functions