forked from Oryx-Embedded/CycloneSSL
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtls_common.c
1931 lines (1715 loc) · 61 KB
/
tls_common.c
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
94
95
96
97
98
99
100
101
102
103
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
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file tls_common.c
* @brief Handshake message processing (TLS client and server)
*
* @section License
*
* SPDX-License-Identifier: GPL-2.0-or-later
*
* Copyright (C) 2010-2022 Oryx Embedded SARL. All rights reserved.
*
* This file is part of CycloneSSL Open.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* @author Oryx Embedded SARL (www.oryx-embedded.com)
* @version 2.1.4
**/
//Switch to the appropriate trace level
#define TRACE_LEVEL TLS_TRACE_LEVEL
//Dependencies
#include <string.h>
#include "tls.h"
#include "tls_cipher_suites.h"
#include "tls_handshake.h"
#include "tls_client.h"
#include "tls_server.h"
#include "tls_common.h"
#include "tls_certificate.h"
#include "tls_signature.h"
#include "tls_transcript_hash.h"
#include "tls_cache.h"
#include "tls_record.h"
#include "tls_misc.h"
#include "tls13_signature.h"
#include "dtls_record.h"
#include "pkix/x509_common.h"
#include "debug.h"
//Check TLS library configuration
#if (TLS_SUPPORT == ENABLED)
/**
* @brief Send Certificate message
* @param[in] context Pointer to the TLS context
* @return Error code
**/
error_t tlsSendCertificate(TlsContext *context)
{
error_t error;
size_t length;
TlsCertificate *message;
//Initialize status code
error = NO_ERROR;
//Point to the buffer where to format the message
message = (TlsCertificate *) (context->txBuffer + context->txBufferLen);
#if (TLS_CLIENT_SUPPORT == ENABLED)
//Client mode?
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//The client must send a Certificate message if the server requests it
if(context->clientCertRequested)
{
//Format Certificate message
error = tlsFormatCertificate(context, message, &length);
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending Certificate message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_DEBUG_ARRAY(" ", message, length);
//Send handshake message
error = tlsSendHandshakeMessage(context, message, length,
TLS_TYPE_CERTIFICATE);
}
}
}
else
#endif
#if (TLS_SERVER_SUPPORT == ENABLED)
//Server mode?
if(context->entity == TLS_CONNECTION_END_SERVER)
{
//The server must send a Certificate message whenever the agreed-upon
//key exchange method uses certificates for authentication
if(context->cert != NULL)
{
//Format Certificate message
error = tlsFormatCertificate(context, message, &length);
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending Certificate message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_DEBUG_ARRAY(" ", message, length);
//Send handshake message
error = tlsSendHandshakeMessage(context, message, length,
TLS_TYPE_CERTIFICATE);
}
}
}
else
#endif
//Unsupported mode of operation?
{
//Report an error
error = ERROR_FAILURE;
}
//Check status code
if(error == NO_ERROR || error == ERROR_WOULD_BLOCK || error == ERROR_TIMEOUT)
{
//Version of TLS prior to TLS 1.3?
if(context->version <= TLS_VERSION_1_2)
{
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
context->state = TLS_STATE_CLIENT_KEY_EXCHANGE;
}
else
{
context->state = TLS_STATE_SERVER_KEY_EXCHANGE;
}
}
else
{
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//Clients must send a CertificateVerify message whenever
//authenticating via a certificate
if(context->clientCertRequested)
{
context->state = TLS_STATE_CLIENT_CERTIFICATE_VERIFY;
}
else
{
context->state = TLS_STATE_CLIENT_FINISHED;
}
}
else
{
//Servers must send a CertificateVerify message whenever
//authenticating via a certificate
context->state = TLS_STATE_SERVER_CERTIFICATE_VERIFY;
}
}
}
//Return status code
return error;
}
/**
* @brief Send CertificateVerify message
*
* The CertificateVerify message is used to provide explicit verification
* of a client certificate. This message is only sent following a client
* certificate that has signing capability
*
* @param[in] context Pointer to the TLS context
* @return Error code
**/
error_t tlsSendCertificateVerify(TlsContext *context)
{
error_t error;
size_t length;
TlsCertificateVerify *message;
//Initialize status code
error = NO_ERROR;
//The CertificateVerify message is only sent following a client certificate
//that has signing capability
if(context->cert != NULL)
{
//Check certificate type
if(context->cert->type == TLS_CERT_RSA_SIGN ||
context->cert->type == TLS_CERT_RSA_PSS_SIGN ||
context->cert->type == TLS_CERT_DSS_SIGN ||
context->cert->type == TLS_CERT_ECDSA_SIGN ||
context->cert->type == TLS_CERT_ED25519_SIGN ||
context->cert->type == TLS_CERT_ED448_SIGN)
{
//Point to the buffer where to format the message
message = (TlsCertificateVerify *) (context->txBuffer + context->txBufferLen);
//Format CertificateVerify message
error = tlsFormatCertificateVerify(context, message, &length);
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending CertificateVerify message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_DEBUG_ARRAY(" ", message, length);
//Send handshake message
error = tlsSendHandshakeMessage(context, message, length,
TLS_TYPE_CERTIFICATE_VERIFY);
}
}
}
//Check status code
if(error == NO_ERROR || error == ERROR_WOULD_BLOCK || error == ERROR_TIMEOUT)
{
//Version of TLS prior to TLS 1.3?
if(context->version <= TLS_VERSION_1_2)
{
//Send a ChangeCipherSpec message to the server
context->state = TLS_STATE_CLIENT_CHANGE_CIPHER_SPEC;
}
else
{
//Send a Finished message to the peer
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
context->state = TLS_STATE_CLIENT_FINISHED;
}
else
{
context->state = TLS_STATE_SERVER_FINISHED;
}
}
}
//Return status code
return error;
}
/**
* @brief Send ChangeCipherSpec message
*
* The change cipher spec message is sent by both the client and the
* server to notify the receiving party that subsequent records will be
* protected under the newly negotiated CipherSpec and keys
*
* @param[in] context Pointer to the TLS context
* @return Error code
**/
error_t tlsSendChangeCipherSpec(TlsContext *context)
{
error_t error;
size_t length;
TlsChangeCipherSpec *message;
//Point to the buffer where to format the message
message = (TlsChangeCipherSpec *) (context->txBuffer + context->txBufferLen);
//Format ChangeCipherSpec message
error = tlsFormatChangeCipherSpec(context, message, &length);
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending ChangeCipherSpec message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_DEBUG_ARRAY(" ", message, length);
#if (DTLS_SUPPORT == ENABLED)
//DTLS protocol?
if(context->transportProtocol == TLS_TRANSPORT_PROTOCOL_DATAGRAM)
{
//Send ChangeCipherSpec message
error = dtlsWriteProtocolData(context, (uint8_t *) message,
length, TLS_TYPE_CHANGE_CIPHER_SPEC);
}
else
#endif
//TLS protocol?
{
//Send ChangeCipherSpec message
error = tlsWriteProtocolData(context, (uint8_t *) message,
length, TLS_TYPE_CHANGE_CIPHER_SPEC);
}
}
//Check status code
if(error == NO_ERROR || error == ERROR_WOULD_BLOCK || error == ERROR_TIMEOUT)
{
//Version of TLS prior to TLS 1.3?
if(context->version <= TLS_VERSION_1_2)
{
#if (DTLS_SUPPORT == ENABLED)
//Release previous encryption engine first
tlsFreeEncryptionEngine(&context->prevEncryptionEngine);
//Save current encryption engine for later use
context->prevEncryptionEngine = context->encryptionEngine;
//Reset encryption engine
osMemset(&context->encryptionEngine, 0, sizeof(TlsEncryptionEngine));
context->encryptionEngine.epoch = context->prevEncryptionEngine.epoch;
#else
//Release encryption engine first
tlsFreeEncryptionEngine(&context->encryptionEngine);
#endif
//Inform the record layer that subsequent records will be protected
//under the newly negotiated encryption algorithm
error = tlsInitEncryptionEngine(context, &context->encryptionEngine,
context->entity, NULL);
//Check status code
if(!error)
{
//Send a Finished message to the peer
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
context->state = TLS_STATE_CLIENT_FINISHED;
}
else
{
context->state = TLS_STATE_SERVER_FINISHED;
}
}
}
else
{
#if (TLS13_MIDDLEBOX_COMPAT_SUPPORT == ENABLED)
//The middlebox compatibility mode improves the chance of successfully
//connecting through middleboxes
if(context->state == TLS_STATE_CLIENT_CHANGE_CIPHER_SPEC ||
context->state == TLS_STATE_SERVER_CHANGE_CIPHER_SPEC_2)
{
//The client can send its second flight
context->state = TLS_STATE_CLIENT_HELLO_2;
}
else if(context->state == TLS_STATE_SERVER_CHANGE_CIPHER_SPEC ||
context->state == TLS_STATE_CLIENT_CHANGE_CIPHER_SPEC_2)
{
//All handshake messages after the ServerHello are now encrypted
context->state = TLS_STATE_HANDSHAKE_TRAFFIC_KEYS;
}
else
#endif
{
//Middlebox compatibility mode is not implemented
error = ERROR_UNEXPECTED_STATE;
}
}
}
//Return status code
return error;
}
/**
* @brief Send Finished message
*
* A Finished message is always sent immediately after a change
* cipher spec message to verify that the key exchange and
* authentication processes were successful. It is essential that a
* change cipher spec message be received between the other handshake
* messages and the Finished message
*
* @param[in] context Pointer to the TLS context
* @return Error code
**/
error_t tlsSendFinished(TlsContext *context)
{
error_t error;
size_t length;
TlsFinished *message;
//Point to the buffer where to format the message
message = (TlsFinished *) (context->txBuffer + context->txBufferLen);
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//The verify data is generated from all messages in this handshake
//up to but not including the Finished message
error = tlsComputeVerifyData(context, TLS_CONNECTION_END_CLIENT,
context->clientVerifyData, &context->clientVerifyDataLen);
}
else
{
//The verify data is generated from all messages in this handshake
//up to but not including the Finished message
error = tlsComputeVerifyData(context, TLS_CONNECTION_END_SERVER,
context->serverVerifyData, &context->serverVerifyDataLen);
}
//Check status code
if(!error)
{
//Format Finished message
error = tlsFormatFinished(context, message, &length);
}
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending Finished message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_DEBUG_ARRAY(" ", message, length);
//Send handshake message
error = tlsSendHandshakeMessage(context, message, length,
TLS_TYPE_FINISHED);
}
//Check status code
if(error == NO_ERROR || error == ERROR_WOULD_BLOCK || error == ERROR_TIMEOUT)
{
//Version of TLS prior to TLS 1.3?
if(context->version <= TLS_VERSION_1_2)
{
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//Abbreviated or full handshake?
if(context->resume)
{
//The client and server can now exchange application-layer data
context->state = TLS_STATE_APPLICATION_DATA;
}
else
{
#if (TLS_TICKET_SUPPORT == ENABLED)
//The server uses the SessionTicket extension to indicate to
//the client that it will send a new session ticket using the
//NewSessionTicket handshake message
if(context->sessionTicketExtReceived)
{
//Wait for a NewSessionTicket message from the server
context->state = TLS_STATE_NEW_SESSION_TICKET;
}
else
#endif
{
//Wait for a ChangeCipherSpec message from the server
context->state = TLS_STATE_SERVER_CHANGE_CIPHER_SPEC;
}
}
}
else
{
//Abbreviated or full handshake?
if(context->resume)
{
//Wait for a ChangeCipherSpec message from the client
context->state = TLS_STATE_CLIENT_CHANGE_CIPHER_SPEC;
}
else
{
//The client and server can now exchange application-layer data
context->state = TLS_STATE_APPLICATION_DATA;
}
}
}
else
{
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//Compute client application traffic keys
context->state = TLS_STATE_CLIENT_APP_TRAFFIC_KEYS;
}
else
{
//Compute server application traffic keys
context->state = TLS_STATE_SERVER_APP_TRAFFIC_KEYS;
}
}
}
//Return status code
return error;
}
/**
* @brief Send Alert message
* @param[in] context Pointer to the TLS context
* @param[in] level Severity of the message (warning or fatal)
* @param[in] description Description of the alert
* @return Error code
**/
error_t tlsSendAlert(TlsContext *context, uint8_t level, uint8_t description)
{
error_t error;
size_t length;
TlsAlert *message;
//Point to the buffer where to format the message
message = (TlsAlert *) (context->txBuffer + context->txBufferLen);
//Format Alert message
error = tlsFormatAlert(context, level, description, message, &length);
//Check status code
if(!error)
{
//Debug message
TRACE_INFO("Sending Alert message (%" PRIuSIZE " bytes)...\r\n", length);
TRACE_INFO_ARRAY(" ", message, length);
#if (DTLS_SUPPORT == ENABLED)
//DTLS protocol?
if(context->transportProtocol == TLS_TRANSPORT_PROTOCOL_DATAGRAM)
{
//Send Alert message
error = dtlsWriteProtocolData(context, (uint8_t *) message,
length, TLS_TYPE_ALERT);
}
else
#endif
//TLS protocol?
{
//Send Alert message
error = tlsWriteProtocolData(context, (uint8_t *) message,
length, TLS_TYPE_ALERT);
}
}
//Alert messages convey the severity of the message
if(level == TLS_ALERT_LEVEL_WARNING)
{
//If an alert with a level of warning is sent, generally the
//connection can continue normally
if(description == TLS_ALERT_CLOSE_NOTIFY)
{
//Either party may initiate a close by sending a close_notify alert
context->closeNotifySent = TRUE;
//Update FSM state
context->state = TLS_STATE_CLOSING;
}
}
else if(level == TLS_ALERT_LEVEL_FATAL)
{
//Alert messages with a level of fatal result in the immediate
//termination of the connection
context->fatalAlertSent = TRUE;
#if (TLS_MAX_VERSION >= TLS_VERSION_1_0 && TLS_MIN_VERSION <= TLS_VERSION_1_2)
//Any connection terminated with a fatal alert must not be resumed
if(context->entity == TLS_CONNECTION_END_SERVER)
{
tlsRemoveFromCache(context);
}
#endif
//Servers and clients must forget any session identifiers
osMemset(context->sessionId, 0, 32);
context->sessionIdLen = 0;
//Update FSM state
context->state = TLS_STATE_CLOSING;
}
//Return status code
return error;
}
/**
* @brief Format Certificate message
* @param[in] context Pointer to the TLS context
* @param[out] message Buffer where to format the Certificate message
* @param[out] length Length of the resulting Certificate message
* @return Error code
**/
error_t tlsFormatCertificate(TlsContext *context,
TlsCertificate *message, size_t *length)
{
error_t error;
size_t n;
uint8_t *p;
TlsCertificateList *certificateList;
//Point to the beginning of the handshake message
p = message;
//Length of the handshake message
*length = 0;
#if (TLS_MAX_VERSION >= TLS_VERSION_1_3 && TLS_MIN_VERSION <= TLS_VERSION_1_3)
//TLS 1.3 currently selected?
if(context->version == TLS_VERSION_1_3)
{
Tls13CertRequestContext *certRequestContext;
//Point to the certificate request context
certRequestContext = (Tls13CertRequestContext *) p;
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//The value of the certificate_request_context field from server's
//CertificateRequest message is echoed in the Certificate message
if(context->certRequestContextLen > 0)
{
//Copy certificate request context
osMemcpy(certRequestContext->value, context->certRequestContext,
context->certRequestContextLen);
}
//The context is preceded by a length field
certRequestContext->length = (uint8_t) context->certRequestContextLen;
}
else
{
//In the case of server authentication, this field shall be zero length
certRequestContext->length = 0;
}
//Point to the next field
p += sizeof(Tls13CertRequestContext) + certRequestContext->length;
//Adjust the length of the Certificate message
*length += sizeof(Tls13CertRequestContext) + certRequestContext->length;
}
#endif
//Point to the chain of certificates
certificateList = (TlsCertificateList *) p;
#if (TLS_RAW_PUBLIC_KEY_SUPPORT == ENABLED)
//Check certificate type
if(context->certFormat == TLS_CERT_FORMAT_RAW_PUBLIC_KEY)
{
//Format the raw public key
error = tlsFormatRawPublicKey(context, certificateList->value, &n);
}
else
#endif
{
//Format the certificate chain
error = tlsFormatCertificateList(context, certificateList->value, &n);
}
//Check status code
if(!error)
{
//A 3-byte length field shall precede the certificate list
STORE24BE(n, certificateList->length);
//Adjust the length of the Certificate message
*length += sizeof(TlsCertificateList) + n;
}
//Return status code
return error;
}
/**
* @brief Format CertificateVerify message
* @param[in] context Pointer to the TLS context
* @param[out] message Buffer where to format the CertificateVerify message
* @param[out] length Length of the resulting CertificateVerify message
* @return Error code
**/
error_t tlsFormatCertificateVerify(TlsContext *context,
TlsCertificateVerify *message, size_t *length)
{
error_t error;
//Length of the handshake message
*length = 0;
#if (TLS_MAX_VERSION >= TLS_VERSION_1_0 && TLS_MIN_VERSION <= TLS_VERSION_1_1)
//TLS 1.0 or TLS 1.1 currently selected?
if(context->version <= TLS_VERSION_1_1)
{
//In TLS version prior to 1.2, the digitally-signed element combines
//MD5 and SHA-1
error = tlsGenerateSignature(context, message, length);
}
else
#endif
#if (TLS_MAX_VERSION >= TLS_VERSION_1_2 && TLS_MIN_VERSION <= TLS_VERSION_1_2)
//TLS 1.2 currently selected?
if(context->version == TLS_VERSION_1_2)
{
//In TLS 1.2, the MD5/SHA-1 combination in the digitally-signed element
//has been replaced with a single hash. The signed element now includes
//a field that explicitly specifies the hash algorithm used
error = tls12GenerateSignature(context, message, length);
}
else
#endif
#if (TLS_MAX_VERSION >= TLS_VERSION_1_3 && TLS_MIN_VERSION <= TLS_VERSION_1_3)
//TLS 1.3 currently selected?
if(context->version == TLS_VERSION_1_3)
{
//In TLS 1.3, the signed element specifies the signature algorithm used.
//The content that is covered under the signature is the transcript hash
//output
error = tls13GenerateSignature(context, message, length);
}
else
#endif
//Invalid TLS version?
{
//Report an error
error = ERROR_INVALID_VERSION;
}
//Return status code
return error;
}
/**
* @brief Format ChangeCipherSpec message
* @param[in] context Pointer to the TLS context
* @param[out] message Buffer where to format the ChangeCipherSpec message
* @param[out] length Length of the resulting ChangeCipherSpec message
* @return Error code
**/
error_t tlsFormatChangeCipherSpec(TlsContext *context,
TlsChangeCipherSpec *message, size_t *length)
{
//The message consists of a single byte of value 1
message->type = 1;
//Length of the ChangeCipherSpec message
*length = sizeof(TlsChangeCipherSpec);
//Successful processing
return NO_ERROR;
}
/**
* @brief Format Finished message
* @param[in] context Pointer to the TLS context
* @param[out] message Buffer where to format the Finished message
* @param[out] length Length of the resulting Finished message
* @return Error code
**/
error_t tlsFormatFinished(TlsContext *context,
TlsFinished *message, size_t *length)
{
//Check whether TLS operates as a client or a server
if(context->entity == TLS_CONNECTION_END_CLIENT)
{
//Copy the client's verify data
osMemcpy(message, context->clientVerifyData, context->clientVerifyDataLen);
//Length of the handshake message
*length = context->clientVerifyDataLen;
}
else
{
//Copy the server's verify data
osMemcpy(message, context->serverVerifyData, context->serverVerifyDataLen);
//Length of the handshake message
*length = context->serverVerifyDataLen;
}
//Successful processing
return NO_ERROR;
}
/**
* @brief Format Alert message
* @param[in] context Pointer to the TLS context
* @param[in] level Severity of the message (warning or fatal)
* @param[in] description Description of the alert
* @param[out] message Buffer where to format the Alert message
* @param[out] length Length of the resulting Alert message
* @return Error code
**/
error_t tlsFormatAlert(TlsContext *context, uint8_t level,
uint8_t description, TlsAlert *message, size_t *length)
{
//Severity of the message
message->level = level;
//Description of the alert
message->description = description;
//Length of the Alert message
*length = sizeof(TlsAlert);
//Successful processing
return NO_ERROR;
}
/**
* @brief Format SignatureAlgorithms extension
* @param[in] context Pointer to the TLS context
* @param[in] cipherSuiteTypes Types of cipher suites proposed by the client
* @param[in] p Output stream where to write the SignatureAlgorithms extension
* @param[out] written Total number of bytes that have been written
* @return Error code
**/
error_t tlsFormatSignatureAlgorithmsExtension(TlsContext *context,
uint_t cipherSuiteTypes, uint8_t *p, size_t *written)
{
size_t n = 0;
#if (TLS_MAX_VERSION >= TLS_VERSION_1_2 && TLS_MIN_VERSION <= TLS_VERSION_1_3)
//This extension is not meaningful for TLS versions prior to 1.2. Clients
//must not offer it if they are offering prior versions (refer to RFC 5246,
//section 7.4.1.4.1)
if(context->versionMax >= TLS_VERSION_1_2)
{
TlsExtension *extension;
TlsSignHashAlgos *supportedSignAlgos;
//Add the SignatureAlgorithms extension
extension = (TlsExtension *) p;
//Type of the extension
extension->type = HTONS(TLS_EXT_SIGNATURE_ALGORITHMS);
//Point to the list of the hash/signature algorithm pairs that the
//server is able to verify
supportedSignAlgos = (TlsSignHashAlgos *) extension->value;
//Enumerate the hash/signature algorithm pairs in descending order
//of preference
n = 0;
#if (TLS_EDDSA_SIGN_SUPPORT == ENABLED)
#if (TLS_ED25519_SUPPORT == ENABLED)
//Ed25519 signature algorithm (PureEdDSA mode)
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ED25519;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#if (TLS_ED448_SUPPORT == ENABLED)
//Ed448 signature algorithm (PureEdDSA mode)
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ED448;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#endif
#if (TLS_ECDSA_SIGN_SUPPORT == ENABLED)
//Any ECC cipher suite proposed by the client?
if((cipherSuiteTypes & TLS_CIPHER_SUITE_TYPE_ECC) != 0 ||
(cipherSuiteTypes & TLS_CIPHER_SUITE_TYPE_TLS13) != 0)
{
#if (TLS_SHA256_SUPPORT == ENABLED)
//ECDSA signature algorithm with SHA-256
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ECDSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA256;
#endif
#if (TLS_SHA384_SUPPORT == ENABLED)
//ECDSA signature algorithm with SHA-384
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ECDSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA384;
#endif
#if (TLS_SHA512_SUPPORT == ENABLED)
//ECDSA signature algorithm with SHA-512
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ECDSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA512;
#endif
}
#endif
#if (TLS_RSA_PSS_SIGN_SUPPORT == ENABLED)
//Check whether the X.509 parser supports RSA-PSS signatures
if(x509IsSignAlgoSupported(X509_SIGN_ALGO_RSA_PSS))
{
#if (TLS_SHA256_SUPPORT == ENABLED)
//RSASSA-PSS PSS signature algorithm with SHA-256
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_PSS_SHA256;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#if (TLS_SHA384_SUPPORT == ENABLED)
//RSASSA-PSS PSS signature algorithm with SHA-384
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_PSS_SHA384;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#if (TLS_SHA512_SUPPORT == ENABLED)
//RSASSA-PSS PSS signature algorithm with SHA-512
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_PSS_SHA512;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
}
#endif
#if (TLS_RSA_PSS_SIGN_SUPPORT == ENABLED)
#if (TLS_SHA256_SUPPORT == ENABLED)
//RSASSA-PSS RSAE signature algorithm with SHA-256
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_RSAE_SHA256;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#if (TLS_SHA384_SUPPORT == ENABLED)
//RSASSA-PSS RSAE signature algorithm with SHA-384
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_RSAE_SHA384;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#if (TLS_SHA512_SUPPORT == ENABLED)
//RSASSA-PSS RSAE signature algorithm with SHA-512
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA_PSS_RSAE_SHA512;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_INTRINSIC;
#endif
#endif
#if (TLS_RSA_SIGN_SUPPORT == ENABLED)
#if (TLS_SHA256_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with SHA-256
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA256;
#endif
#if (TLS_SHA384_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with SHA-384
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA384;
#endif
#if (TLS_SHA512_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with SHA-512
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA512;
#endif
#endif
#if (TLS_ECDSA_SIGN_SUPPORT == ENABLED)
//Any ECC cipher suite proposed by the client?
if((cipherSuiteTypes & TLS_CIPHER_SUITE_TYPE_ECC) != 0 ||
(cipherSuiteTypes & TLS_CIPHER_SUITE_TYPE_TLS13) != 0)
{
#if (TLS_SHA1_SUPPORT == ENABLED)
//ECDSA signature algorithm with SHA-1
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ECDSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA1;
#endif
#if (TLS_SHA224_SUPPORT == ENABLED)
//ECDSA signature algorithm with SHA-224
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_ECDSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA224;
#endif
}
#endif
#if (TLS_RSA_SIGN_SUPPORT == ENABLED)
#if (TLS_SHA1_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with SHA-1
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA1;
#endif
#if (TLS_SHA224_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with SHA-224
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA224;
#endif
#if (TLS_MD5_SUPPORT == ENABLED)
//RSASSA-PKCS1-v1_5 signature algorithm with MD5
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_RSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_MD5;
#endif
#endif
#if (TLS_DSA_SIGN_SUPPORT == ENABLED)
#if (TLS_SHA1_SUPPORT == ENABLED)
//DSA signature algorithm with SHA-1
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_DSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA1;
#endif
#if (TLS_SHA224_SUPPORT == ENABLED)
//DSA signature algorithm with SHA-224
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_DSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA224;
#endif
#if (TLS_SHA256_SUPPORT == ENABLED)
//DSA signature algorithm with SHA-256
supportedSignAlgos->value[n].signature = TLS_SIGN_ALGO_DSA;
supportedSignAlgos->value[n++].hash = TLS_HASH_ALGO_SHA256;
#endif
#endif