1 # Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
3 # Licensed under the Apache License 2.0 (the "License"). You may not use
4 # this file except in compliance with the License. You can obtain a copy
5 # in the file LICENSE in the source distribution or at
6 # https://www.openssl.org/source/license.html
10 package TLSProxy
::Message
;
14 use constant TLS_MESSAGE_HEADER_LENGTH
=> 4;
18 MT_HELLO_REQUEST
=> 0,
21 MT_NEW_SESSION_TICKET
=> 4,
22 MT_ENCRYPTED_EXTENSIONS
=> 8,
24 MT_SERVER_KEY_EXCHANGE
=> 12,
25 MT_CERTIFICATE_REQUEST
=> 13,
26 MT_SERVER_HELLO_DONE
=> 14,
27 MT_CERTIFICATE_VERIFY
=> 15,
28 MT_CLIENT_KEY_EXCHANGE
=> 16,
30 MT_CERTIFICATE_STATUS
=> 22,
42 AL_DESC_CLOSE_NOTIFY
=> 0,
43 AL_DESC_UNEXPECTED_MESSAGE
=> 10,
44 AL_DESC_ILLEGAL_PARAMETER
=> 47,
45 AL_DESC_NO_RENEGOTIATION
=> 100
49 MT_HELLO_REQUEST
, "HelloRequest",
50 MT_CLIENT_HELLO
, "ClientHello",
51 MT_SERVER_HELLO
, "ServerHello",
52 MT_NEW_SESSION_TICKET
, "NewSessionTicket",
53 MT_ENCRYPTED_EXTENSIONS
, "EncryptedExtensions",
54 MT_CERTIFICATE
, "Certificate",
55 MT_SERVER_KEY_EXCHANGE
, "ServerKeyExchange",
56 MT_CERTIFICATE_REQUEST
, "CertificateRequest",
57 MT_SERVER_HELLO_DONE
, "ServerHelloDone",
58 MT_CERTIFICATE_VERIFY
, "CertificateVerify",
59 MT_CLIENT_KEY_EXCHANGE
, "ClientKeyExchange",
60 MT_FINISHED
, "Finished",
61 MT_CERTIFICATE_STATUS
, "CertificateStatus",
62 MT_NEXT_PROTO
, "NextProto"
67 EXT_MAX_FRAGMENT_LENGTH
=> 1,
68 EXT_STATUS_REQUEST
=> 5,
69 EXT_SUPPORTED_GROUPS
=> 10,
70 EXT_EC_POINT_FORMATS
=> 11,
77 EXT_ENCRYPT_THEN_MAC
=> 22,
78 EXT_EXTENDED_MASTER_SECRET
=> 23,
79 EXT_SESSION_TICKET
=> 35,
82 EXT_SUPPORTED_VERSIONS
=> 43,
84 EXT_PSK_KEX_MODES
=> 45,
85 EXT_POST_HANDSHAKE_AUTH
=> 49,
86 EXT_SIG_ALGS_CERT
=> 50,
87 EXT_RENEGOTIATE
=> 65281,
89 EXT_CRYPTOPRO_BUG_EXTENSION
=> 0xfde8,
90 EXT_UNKNOWN
=> 0xfffe,
91 #Unknown extension that should appear last
92 EXT_FORCE_LAST
=> 0xffff
95 # SignatureScheme of TLS 1.3 from:
96 # https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-signaturescheme
97 # We have to manually grab the SHA224 equivalents from the old registry
99 SIG_ALG_RSA_PKCS1_SHA256
=> 0x0401,
100 SIG_ALG_RSA_PKCS1_SHA384
=> 0x0501,
101 SIG_ALG_RSA_PKCS1_SHA512
=> 0x0601,
102 SIG_ALG_ECDSA_SECP256R1_SHA256
=> 0x0403,
103 SIG_ALG_ECDSA_SECP384R1_SHA384
=> 0x0503,
104 SIG_ALG_ECDSA_SECP521R1_SHA512
=> 0x0603,
105 SIG_ALG_RSA_PSS_RSAE_SHA256
=> 0x0804,
106 SIG_ALG_RSA_PSS_RSAE_SHA384
=> 0x0805,
107 SIG_ALG_RSA_PSS_RSAE_SHA512
=> 0x0806,
108 SIG_ALG_ED25519
=> 0x0807,
109 SIG_ALG_ED448
=> 0x0808,
110 SIG_ALG_RSA_PSS_PSS_SHA256
=> 0x0809,
111 SIG_ALG_RSA_PSS_PSS_SHA384
=> 0x080a,
112 SIG_ALG_RSA_PSS_PSS_SHA512
=> 0x080b,
113 SIG_ALG_RSA_PKCS1_SHA1
=> 0x0201,
114 SIG_ALG_ECDSA_SHA1
=> 0x0203,
115 SIG_ALG_DSA_SHA1
=> 0x0202,
116 SIG_ALG_DSA_SHA256
=> 0x0402,
117 SIG_ALG_DSA_SHA384
=> 0x0502,
118 SIG_ALG_DSA_SHA512
=> 0x0602,
119 OSSL_SIG_ALG_RSA_PKCS1_SHA224
=> 0x0301,
120 OSSL_SIG_ALG_DSA_SHA224
=> 0x0302,
121 OSSL_SIG_ALG_ECDSA_SHA224
=> 0x0303
125 CIPHER_RSA_WITH_AES_128_CBC_SHA
=> 0x002f,
126 CIPHER_DHE_RSA_AES_128_SHA
=> 0x0033,
127 CIPHER_ADH_AES_128_SHA
=> 0x0034,
128 CIPHER_TLS13_AES_128_GCM_SHA256
=> 0x1301,
129 CIPHER_TLS13_AES_256_GCM_SHA384
=> 0x1302
140 my $startoffset = -1;
144 my @message_rec_list = ();
145 my @message_frag_lens = ();
147 my $successondata = 0;
159 @message_rec_list = ();
160 @message_frag_lens = ();
164 #Class method to extract messages from a record
168 my $serverin = shift;
173 @message_frag_lens = ();
175 if ($serverin != $server && length($payload) != 0) {
176 die "Changed peer, but we still have fragment data\n";
180 if ($record->content_type == TLSProxy
::Record
::RT_CCS
) {
181 if ($payload ne "") {
182 #We can't handle this yet
183 die "CCS received before message data complete\n";
185 if (!TLSProxy
::Proxy
->is_tls13()) {
187 TLSProxy
::Record
->server_encrypting(1);
189 TLSProxy
::Record
->client_encrypting(1);
192 } elsif ($record->content_type == TLSProxy
::Record
::RT_HANDSHAKE
) {
193 if ($record->len == 0 || $record->len_real == 0) {
194 print " Message truncated\n";
198 if (length $payload > 0) {
199 #We are continuing processing a message started in a previous
200 #record. Add this record to the list associated with this
202 push @message_rec_list, $record;
204 if ($messlen <= length($payload)) {
206 die "Internal error: invalid messlen: ".$messlen
207 ." payload length:".length($payload)."\n";
209 if (length($payload) + $record->decrypt_len >= $messlen) {
210 #We can complete the message with this record
211 $recoffset = $messlen - length($payload);
212 $payload .= substr($record->decrypt_data, 0, $recoffset);
213 push @message_frag_lens, $recoffset;
214 $message = create_message
($server, $mt, $payload,
216 push @messages, $message;
220 #This is just part of the total message
221 $payload .= $record->decrypt_data;
222 $recoffset = $record->decrypt_len;
223 push @message_frag_lens, $record->decrypt_len;
225 print " Partial message data read: ".$recoffset." bytes\n";
228 while ($record->decrypt_len > $recoffset) {
229 #We are at the start of a new message
230 if ($record->decrypt_len - $recoffset < 4) {
231 #Whilst technically probably valid we can't cope with this
232 die "End of record in the middle of a message header\n";
234 @message_rec_list = ($record);
237 ($mt, $lenhi, $lenlo) = unpack('CnC',
238 substr($record->decrypt_data,
240 $messlen = ($lenhi << 8) | $lenlo;
241 print " Message type: $message_type{$mt}\n";
242 print " Message Length: $messlen\n";
243 $startoffset = $recoffset;
247 if ($recoffset <= $record->decrypt_len) {
248 #Some payload data is present in this record
249 if ($record->decrypt_len - $recoffset >= $messlen) {
250 #We can complete the message with this record
251 $payload .= substr($record->decrypt_data, $recoffset,
253 $recoffset += $messlen;
254 push @message_frag_lens, $messlen;
255 $message = create_message
($server, $mt, $payload,
257 push @messages, $message;
261 #This is just part of the total message
262 $payload .= substr($record->decrypt_data, $recoffset,
263 $record->decrypt_len - $recoffset);
264 $recoffset = $record->decrypt_len;
265 push @message_frag_lens, $recoffset;
270 } elsif ($record->content_type == TLSProxy
::Record
::RT_APPLICATION_DATA
) {
271 print " [ENCRYPTED APPLICATION DATA]\n";
272 print " [".$record->decrypt_data."]\n";
274 if ($successondata) {
278 } elsif ($record->content_type == TLSProxy
::Record
::RT_ALERT
) {
279 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
280 print " [$alertlev, $alertdesc]\n";
281 #A CloseNotify from the client indicates we have finished successfully
283 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
284 && $alertdesc == AL_DESC_CLOSE_NOTIFY
) {
287 #Fatal or close notify alerts end the test
288 if ($alertlev == AL_LEVEL_FATAL
|| $alertdesc == AL_DESC_CLOSE_NOTIFY
) {
291 $alert = TLSProxy
::Alert
->new(
301 #Function to work out which sub-class we need to create and then
305 my ($server, $mt, $data, $startoffset) = @_;
308 #We only support ClientHello in this version...needs to be extended for
310 if ($mt == MT_CLIENT_HELLO
) {
311 $message = TLSProxy
::ClientHello
->new(
319 } elsif ($mt == MT_SERVER_HELLO
) {
320 $message = TLSProxy
::ServerHello
->new(
328 } elsif ($mt == MT_ENCRYPTED_EXTENSIONS
) {
329 $message = TLSProxy
::EncryptedExtensions
->new(
337 } elsif ($mt == MT_CERTIFICATE
) {
338 $message = TLSProxy
::Certificate
->new(
346 } elsif ($mt == MT_CERTIFICATE_REQUEST
) {
347 $message = TLSProxy
::CertificateRequest
->new(
355 } elsif ($mt == MT_CERTIFICATE_VERIFY
) {
356 $message = TLSProxy
::CertificateVerify
->new(
364 } elsif ($mt == MT_SERVER_KEY_EXCHANGE
) {
365 $message = TLSProxy
::ServerKeyExchange
->new(
373 } elsif ($mt == MT_NEW_SESSION_TICKET
) {
374 $message = TLSProxy
::NewSessionTicket
->new(
383 #Unknown message type
384 $message = TLSProxy
::Message
->new(
410 return !$success && $end;
426 $message_frag_lens) = @_;
433 startoffset
=> $startoffset,
434 message_frag_lens
=> $message_frag_lens,
438 return bless $self, $class;
445 $ciphersuite = shift;
450 #Update all the underlying records with the modified data from this message
451 #Note: Only supports TLSv1.3 and ETM encryption
457 my $numrecs = $#{$self->records};
459 $self->set_message_contents();
464 $lenlo = length($self->data) & 0xff;
465 $lenhi = length($self->data) >> 8;
466 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
469 #The message is fully contained within one record
470 my ($rec) = @
{$self->records};
471 my $recdata = $rec->decrypt_data;
475 # We use empty message_frag_lens to indicates that pre-repacking,
476 # the message wasn't present. The first fragment length doesn't include
477 # the TLS header, so we need to check and compute the right length.
478 if (@
{$self->message_frag_lens}) {
479 $old_length = ${$self->message_frag_lens}[0] +
480 TLS_MESSAGE_HEADER_LENGTH
;
485 my $prefix = substr($recdata, 0, $self->startoffset);
486 my $suffix = substr($recdata, $self->startoffset + $old_length);
488 $rec->decrypt_data($prefix.($msgdata).($suffix));
489 # TODO(openssl-team): don't keep explicit lengths.
490 # (If a length override is ever needed to construct invalid packets,
491 # use an explicit override field instead.)
492 $rec->decrypt_len(length($rec->decrypt_data));
493 # Only support re-encryption for TLSv1.3 and ETM.
494 if ($rec->encrypted()) {
495 if (TLSProxy
::Proxy
->is_tls13()) {
496 #Add content type (1 byte) and 16 tag bytes
497 $rec->data($rec->decrypt_data
498 .pack("C", TLSProxy
::Record
::RT_HANDSHAKE
).("\0"x16
));
499 } elsif ($rec->etm()) {
500 my $data = $rec->decrypt_data;
502 my $padval = length($data) % 16;
503 $padval = 15 - $padval;
505 $data .= pack("C", $padval);
508 #Add MAC. Assumed to be 20 bytes
509 foreach my $macval (0..19) {
510 $data .= pack("C", $macval);
513 if ($rec->version() >= TLSProxy
::Record
::VERS_TLS_1_1
) {
515 $data = ("\0"x16
).$data;
519 die "Unsupported encryption: No ETM";
522 $rec->data($rec->decrypt_data);
524 $rec->len(length($rec->data));
526 #Update the fragment len in case we changed it above
527 ${$self->message_frag_lens}[0] = length($msgdata)
528 - TLS_MESSAGE_HEADER_LENGTH
;
532 #Note we don't currently support changing a fragmented message length
535 foreach my $rec (@
{$self->records}) {
536 my $recdata = $rec->decrypt_data;
538 #This is the first record
539 my $remainlen = length($recdata) - $self->startoffset;
540 $rec->data(substr($recdata, 0, $self->startoffset)
541 .substr(($msgdata), 0, $remainlen));
542 $datadone += $remainlen;
543 } elsif ($recctr + 1 == $numrecs) {
544 #This is the last record
545 $rec->data(substr($msgdata, $datadone));
547 #This is a middle record
548 $rec->data(substr($msgdata, $datadone, length($rec->data)));
549 $datadone += length($rec->data);
555 #To be overridden by sub-classes
556 sub set_message_contents
564 return $self->{server
};
567 #Read/write accessors
580 $self->{data
} = shift;
582 return $self->{data
};
588 $self->{records
} = shift;
590 return $self->{records
};
596 $self->{startoffset
} = shift;
598 return $self->{startoffset
};
600 sub message_frag_lens
604 $self->{message_frag_lens
} = shift;
606 return $self->{message_frag_lens
};
611 return TLS_MESSAGE_HEADER_LENGTH
+ length($self->data);
617 $self->{dupext
} = shift;
619 return $self->{dupext
};
625 $successondata = shift;
627 return $successondata;