1 # Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
3 # Licensed under the OpenSSL license (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
;
12 use constant TLS_MESSAGE_HEADER_LENGTH
=> 4;
16 MT_HELLO_REQUEST
=> 0,
19 MT_NEW_SESSION_TICKET
=> 4,
20 MT_ENCRYPTED_EXTENSIONS
=> 8,
22 MT_SERVER_KEY_EXCHANGE
=> 12,
23 MT_CERTIFICATE_REQUEST
=> 13,
24 MT_SERVER_HELLO_DONE
=> 14,
25 MT_CERTIFICATE_VERIFY
=> 15,
26 MT_CLIENT_KEY_EXCHANGE
=> 16,
28 MT_CERTIFICATE_STATUS
=> 22,
40 AL_DESC_CLOSE_NOTIFY
=> 0,
41 AL_DESC_UNEXPECTED_MESSAGE
=> 10,
42 AL_DESC_NO_RENEGOTIATION
=> 100
46 MT_HELLO_REQUEST
, "HelloRequest",
47 MT_CLIENT_HELLO
, "ClientHello",
48 MT_SERVER_HELLO
, "ServerHello",
49 MT_NEW_SESSION_TICKET
, "NewSessionTicket",
50 MT_ENCRYPTED_EXTENSIONS
, "EncryptedExtensions",
51 MT_CERTIFICATE
, "Certificate",
52 MT_SERVER_KEY_EXCHANGE
, "ServerKeyExchange",
53 MT_CERTIFICATE_REQUEST
, "CertificateRequest",
54 MT_SERVER_HELLO_DONE
, "ServerHelloDone",
55 MT_CERTIFICATE_VERIFY
, "CertificateVerify",
56 MT_CLIENT_KEY_EXCHANGE
, "ClientKeyExchange",
57 MT_FINISHED
, "Finished",
58 MT_CERTIFICATE_STATUS
, "CertificateStatus",
59 MT_NEXT_PROTO
, "NextProto"
64 EXT_MAX_FRAGMENT_LENGTH
=> 1,
65 EXT_STATUS_REQUEST
=> 5,
66 EXT_SUPPORTED_GROUPS
=> 10,
67 EXT_EC_POINT_FORMATS
=> 11,
74 EXT_ENCRYPT_THEN_MAC
=> 22,
75 EXT_EXTENDED_MASTER_SECRET
=> 23,
76 EXT_SESSION_TICKET
=> 35,
79 EXT_SUPPORTED_VERSIONS
=> 43,
81 EXT_PSK_KEX_MODES
=> 45,
82 EXT_POST_HANDSHAKE_AUTH
=> 49,
83 EXT_SIG_ALGS_CERT
=> 50,
84 EXT_RENEGOTIATE
=> 65281,
86 # This extension is an unofficial extension only ever written by OpenSSL
87 # (i.e. not read), and even then only when enabled. We use it to test
88 # handling of duplicate extensions.
89 EXT_DUPLICATE_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://tools.ietf.org/html/draft-ietf-tls-tls13-20#appendix-B.3.1.3
97 # TODO(TLS1.3) update link to IANA registry after publication
98 # We have to manually grab the SHA224 equivalents from the old registry
100 SIG_ALG_RSA_PKCS1_SHA256
=> 0x0401,
101 SIG_ALG_RSA_PKCS1_SHA384
=> 0x0501,
102 SIG_ALG_RSA_PKCS1_SHA512
=> 0x0601,
103 SIG_ALG_ECDSA_SECP256R1_SHA256
=> 0x0403,
104 SIG_ALG_ECDSA_SECP384R1_SHA384
=> 0x0503,
105 SIG_ALG_ECDSA_SECP521R1_SHA512
=> 0x0603,
106 SIG_ALG_RSA_PSS_SHA256
=> 0x0804,
107 SIG_ALG_RSA_PSS_SHA384
=> 0x0805,
108 SIG_ALG_RSA_PSS_SHA512
=> 0x0806,
109 SIG_ALG_ED25519
=> 0x0807,
110 SIG_ALG_ED448
=> 0x0808,
111 SIG_ALG_RSA_PKCS1_SHA1
=> 0x0201,
112 SIG_ALG_ECDSA_SHA1
=> 0x0203,
113 SIG_ALG_DSA_SHA1
=> 0x0202,
114 SIG_ALG_DSA_SHA256
=> 0x0402,
115 SIG_ALG_DSA_SHA384
=> 0x0502,
116 SIG_ALG_DSA_SHA512
=> 0x0602,
117 OSSL_SIG_ALG_RSA_PKCS1_SHA224
=> 0x0301,
118 OSSL_SIG_ALG_DSA_SHA224
=> 0x0302,
119 OSSL_SIG_ALG_ECDSA_SHA224
=> 0x0303
123 CIPHER_DHE_RSA_AES_128_SHA
=> 0x0033,
124 CIPHER_ADH_AES_128_SHA
=> 0x0034,
125 CIPHER_TLS13_AES_128_GCM_SHA256
=> 0x1301,
126 CIPHER_TLS13_AES_256_GCM_SHA384
=> 0x1302
132 my $startoffset = -1;
136 my @message_rec_list = ();
137 my @message_frag_lens = ();
139 my $successondata = 0;
150 @message_rec_list = ();
151 @message_frag_lens = ();
154 #Class method to extract messages from a record
158 my $serverin = shift;
163 @message_frag_lens = ();
165 if ($serverin != $server && length($payload) != 0) {
166 die "Changed peer, but we still have fragment data\n";
170 if ($record->content_type == TLSProxy
::Record
::RT_CCS
) {
171 if ($payload ne "") {
172 #We can't handle this yet
173 die "CCS received before message data complete\n";
175 if (!TLSProxy
::Proxy
->is_tls13()) {
177 TLSProxy
::Record
->server_encrypting(1);
179 TLSProxy
::Record
->client_encrypting(1);
182 } elsif ($record->content_type == TLSProxy
::Record
::RT_HANDSHAKE
) {
183 if ($record->len == 0 || $record->len_real == 0) {
184 print " Message truncated\n";
188 if (length $payload > 0) {
189 #We are continuing processing a message started in a previous
190 #record. Add this record to the list associated with this
192 push @message_rec_list, $record;
194 if ($messlen <= length($payload)) {
196 die "Internal error: invalid messlen: ".$messlen
197 ." payload length:".length($payload)."\n";
199 if (length($payload) + $record->decrypt_len >= $messlen) {
200 #We can complete the message with this record
201 $recoffset = $messlen - length($payload);
202 $payload .= substr($record->decrypt_data, 0, $recoffset);
203 push @message_frag_lens, $recoffset;
204 $message = create_message
($server, $mt, $payload,
206 push @messages, $message;
210 #This is just part of the total message
211 $payload .= $record->decrypt_data;
212 $recoffset = $record->decrypt_len;
213 push @message_frag_lens, $record->decrypt_len;
215 print " Partial message data read: ".$recoffset." bytes\n";
218 while ($record->decrypt_len > $recoffset) {
219 #We are at the start of a new message
220 if ($record->decrypt_len - $recoffset < 4) {
221 #Whilst technically probably valid we can't cope with this
222 die "End of record in the middle of a message header\n";
224 @message_rec_list = ($record);
227 ($mt, $lenhi, $lenlo) = unpack('CnC',
228 substr($record->decrypt_data,
230 $messlen = ($lenhi << 8) | $lenlo;
231 print " Message type: $message_type{$mt}\n";
232 print " Message Length: $messlen\n";
233 $startoffset = $recoffset;
237 if ($recoffset <= $record->decrypt_len) {
238 #Some payload data is present in this record
239 if ($record->decrypt_len - $recoffset >= $messlen) {
240 #We can complete the message with this record
241 $payload .= substr($record->decrypt_data, $recoffset,
243 $recoffset += $messlen;
244 push @message_frag_lens, $messlen;
245 $message = create_message
($server, $mt, $payload,
247 push @messages, $message;
251 #This is just part of the total message
252 $payload .= substr($record->decrypt_data, $recoffset,
253 $record->decrypt_len - $recoffset);
254 $recoffset = $record->decrypt_len;
255 push @message_frag_lens, $recoffset;
260 } elsif ($record->content_type == TLSProxy
::Record
::RT_APPLICATION_DATA
) {
261 print " [ENCRYPTED APPLICATION DATA]\n";
262 print " [".$record->decrypt_data."]\n";
264 if ($successondata) {
268 } elsif ($record->content_type == TLSProxy
::Record
::RT_ALERT
) {
269 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
270 #A CloseNotify from the client indicates we have finished successfully
272 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
273 && $alertdesc == AL_DESC_CLOSE_NOTIFY
) {
276 #All alerts end the test
283 #Function to work out which sub-class we need to create and then
287 my ($server, $mt, $data, $startoffset) = @_;
290 #We only support ClientHello in this version...needs to be extended for
292 if ($mt == MT_CLIENT_HELLO
) {
293 $message = TLSProxy
::ClientHello
->new(
301 } elsif ($mt == MT_SERVER_HELLO
) {
302 $message = TLSProxy
::ServerHello
->new(
310 } elsif ($mt == MT_ENCRYPTED_EXTENSIONS
) {
311 $message = TLSProxy
::EncryptedExtensions
->new(
319 } elsif ($mt == MT_CERTIFICATE
) {
320 $message = TLSProxy
::Certificate
->new(
328 } elsif ($mt == MT_CERTIFICATE_VERIFY
) {
329 $message = TLSProxy
::CertificateVerify
->new(
337 } elsif ($mt == MT_SERVER_KEY_EXCHANGE
) {
338 $message = TLSProxy
::ServerKeyExchange
->new(
346 } elsif ($mt == MT_NEW_SESSION_TICKET
) {
347 $message = TLSProxy
::NewSessionTicket
->new(
356 #Unknown message type
357 $message = TLSProxy
::Message
->new(
383 return !$success && $end;
393 $message_frag_lens) = @_;
400 startoffset
=> $startoffset,
401 message_frag_lens
=> $message_frag_lens
404 return bless $self, $class;
411 $ciphersuite = shift;
416 #Update all the underlying records with the modified data from this message
417 #Note: Only supports re-encrypting for TLSv1.3
423 my $numrecs = $#{$self->records};
425 $self->set_message_contents();
430 $lenlo = length($self->data) & 0xff;
431 $lenhi = length($self->data) >> 8;
432 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
435 #The message is fully contained within one record
436 my ($rec) = @
{$self->records};
437 my $recdata = $rec->decrypt_data;
441 # We use empty message_frag_lens to indicates that pre-repacking,
442 # the message wasn't present. The first fragment length doesn't include
443 # the TLS header, so we need to check and compute the right length.
444 if (@
{$self->message_frag_lens}) {
445 $old_length = ${$self->message_frag_lens}[0] +
446 TLS_MESSAGE_HEADER_LENGTH
;
451 my $prefix = substr($recdata, 0, $self->startoffset);
452 my $suffix = substr($recdata, $self->startoffset + $old_length);
454 $rec->decrypt_data($prefix.($msgdata).($suffix));
455 # TODO(openssl-team): don't keep explicit lengths.
456 # (If a length override is ever needed to construct invalid packets,
457 # use an explicit override field instead.)
458 $rec->decrypt_len(length($rec->decrypt_data));
459 $rec->len($rec->len + length($msgdata) - $old_length);
460 # Only support re-encryption for TLSv1.3.
461 if (TLSProxy
::Proxy
->is_tls13() && $rec->encrypted()) {
462 #Add content type (1 byte) and 16 tag bytes
463 $rec->data($rec->decrypt_data
464 .pack("C", TLSProxy
::Record
::RT_HANDSHAKE
).("\0"x16
));
466 $rec->data($rec->decrypt_data);
469 #Update the fragment len in case we changed it above
470 ${$self->message_frag_lens}[0] = length($msgdata)
471 - TLS_MESSAGE_HEADER_LENGTH
;
475 #Note we don't currently support changing a fragmented message length
478 foreach my $rec (@
{$self->records}) {
479 my $recdata = $rec->decrypt_data;
481 #This is the first record
482 my $remainlen = length($recdata) - $self->startoffset;
483 $rec->data(substr($recdata, 0, $self->startoffset)
484 .substr(($msgdata), 0, $remainlen));
485 $datadone += $remainlen;
486 } elsif ($recctr + 1 == $numrecs) {
487 #This is the last record
488 $rec->data(substr($msgdata, $datadone));
490 #This is a middle record
491 $rec->data(substr($msgdata, $datadone, length($rec->data)));
492 $datadone += length($rec->data);
498 #To be overridden by sub-classes
499 sub set_message_contents
507 return $self->{server
};
510 #Read/write accessors
523 $self->{data
} = shift;
525 return $self->{data
};
531 $self->{records
} = shift;
533 return $self->{records
};
539 $self->{startoffset
} = shift;
541 return $self->{startoffset
};
543 sub message_frag_lens
547 $self->{message_frag_lens
} = shift;
549 return $self->{message_frag_lens
};
554 return TLS_MESSAGE_HEADER_LENGTH
+ length($self->data);
560 $successondata = shift;
562 return $successondata;