1 # Copyright 2016 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_HELLO_RETRY_REQUEST => 6,
21 MT_ENCRYPTED_EXTENSIONS => 8,
23 MT_SERVER_KEY_EXCHANGE => 12,
24 MT_CERTIFICATE_REQUEST => 13,
25 MT_SERVER_HELLO_DONE => 14,
26 MT_CERTIFICATE_VERIFY => 15,
27 MT_CLIENT_KEY_EXCHANGE => 16,
29 MT_CERTIFICATE_STATUS => 22,
41 AL_DESC_CLOSE_NOTIFY => 0,
42 AL_DESC_UNEXPECTED_MESSAGE => 10,
43 AL_DESC_NO_RENEGOTIATION => 100
47 MT_HELLO_REQUEST, "HelloRequest",
48 MT_CLIENT_HELLO, "ClientHello",
49 MT_SERVER_HELLO, "ServerHello",
50 MT_NEW_SESSION_TICKET, "NewSessionTicket",
51 MT_HELLO_RETRY_REQUEST, "HelloRetryRequest",
52 MT_ENCRYPTED_EXTENSIONS, "EncryptedExtensions",
53 MT_CERTIFICATE, "Certificate",
54 MT_SERVER_KEY_EXCHANGE, "ServerKeyExchange",
55 MT_CERTIFICATE_REQUEST, "CertificateRequest",
56 MT_SERVER_HELLO_DONE, "ServerHelloDone",
57 MT_CERTIFICATE_VERIFY, "CertificateVerify",
58 MT_CLIENT_KEY_EXCHANGE, "ClientKeyExchange",
59 MT_FINISHED, "Finished",
60 MT_CERTIFICATE_STATUS, "CertificateStatus",
61 MT_NEXT_PROTO, "NextProto"
66 EXT_STATUS_REQUEST => 5,
67 EXT_SUPPORTED_GROUPS => 10,
68 EXT_EC_POINT_FORMATS => 11,
75 EXT_ENCRYPT_THEN_MAC => 22,
76 EXT_EXTENDED_MASTER_SECRET => 23,
77 EXT_SESSION_TICKET => 35,
80 EXT_SUPPORTED_VERSIONS => 43,
81 EXT_PSK_KEX_MODES => 45,
82 EXT_RENEGOTIATE => 65281,
84 # This extension is an unofficial extension only ever written by OpenSSL
85 # (i.e. not read), and even then only when enabled. We use it to test
86 # handling of duplicate extensions.
87 EXT_DUPLICATE_EXTENSION => 0xfde8
91 CIPHER_DHE_RSA_AES_128_SHA => 0x0033,
92 CIPHER_ADH_AES_128_SHA => 0x0034
102 my @message_rec_list = ();
103 my @message_frag_lens = ();
105 my $successondata = 0;
116 @message_rec_list = ();
117 @message_frag_lens = ();
120 #Class method to extract messages from a record
124 my $serverin = shift;
129 @message_frag_lens = ();
131 if ($serverin != $server && length($payload) != 0) {
132 die "Changed peer, but we still have fragment data\n";
136 if ($record->content_type == TLSProxy::Record::RT_CCS) {
137 if ($payload ne "") {
138 #We can't handle this yet
139 die "CCS received before message data complete\n";
142 TLSProxy::Record->server_encrypting(1);
144 TLSProxy::Record->client_encrypting(1);
146 } elsif ($record->content_type == TLSProxy::Record::RT_HANDSHAKE) {
147 if ($record->len == 0 || $record->len_real == 0) {
148 print " Message truncated\n";
152 if (length $payload > 0) {
153 #We are continuing processing a message started in a previous
154 #record. Add this record to the list associated with this
156 push @message_rec_list, $record;
158 if ($messlen <= length($payload)) {
160 die "Internal error: invalid messlen: ".$messlen
161 ." payload length:".length($payload)."\n";
163 if (length($payload) + $record->decrypt_len >= $messlen) {
164 #We can complete the message with this record
165 $recoffset = $messlen - length($payload);
166 $payload .= substr($record->decrypt_data, 0, $recoffset);
167 push @message_frag_lens, $recoffset;
168 $message = create_message($server, $mt, $payload,
170 push @messages, $message;
174 #This is just part of the total message
175 $payload .= $record->decrypt_data;
176 $recoffset = $record->decrypt_len;
177 push @message_frag_lens, $record->decrypt_len;
179 print " Partial message data read: ".$recoffset." bytes\n";
182 while ($record->decrypt_len > $recoffset) {
183 #We are at the start of a new message
184 if ($record->decrypt_len - $recoffset < 4) {
185 #Whilst technically probably valid we can't cope with this
186 die "End of record in the middle of a message header\n";
188 @message_rec_list = ($record);
191 ($mt, $lenhi, $lenlo) = unpack('CnC',
192 substr($record->decrypt_data,
194 $messlen = ($lenhi << 8) | $lenlo;
195 print " Message type: $message_type{$mt}\n";
196 print " Message Length: $messlen\n";
197 $startoffset = $recoffset;
201 if ($recoffset <= $record->decrypt_len) {
202 #Some payload data is present in this record
203 if ($record->decrypt_len - $recoffset >= $messlen) {
204 #We can complete the message with this record
205 $payload .= substr($record->decrypt_data, $recoffset,
207 $recoffset += $messlen;
208 push @message_frag_lens, $messlen;
209 $message = create_message($server, $mt, $payload,
211 push @messages, $message;
215 #This is just part of the total message
216 $payload .= substr($record->decrypt_data, $recoffset,
217 $record->decrypt_len - $recoffset);
218 $recoffset = $record->decrypt_len;
219 push @message_frag_lens, $recoffset;
224 } elsif ($record->content_type == TLSProxy::Record::RT_APPLICATION_DATA) {
225 print " [ENCRYPTED APPLICATION DATA]\n";
226 print " [".$record->decrypt_data."]\n";
228 if ($successondata) {
232 } elsif ($record->content_type == TLSProxy::Record::RT_ALERT) {
233 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
234 #A CloseNotify from the client indicates we have finished successfully
236 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
237 && $alertdesc == AL_DESC_CLOSE_NOTIFY) {
240 #All alerts end the test
247 #Function to work out which sub-class we need to create and then
251 my ($server, $mt, $data, $startoffset) = @_;
254 #We only support ClientHello in this version...needs to be extended for
256 if ($mt == MT_CLIENT_HELLO) {
257 $message = TLSProxy::ClientHello->new(
265 } elsif ($mt == MT_SERVER_HELLO) {
266 $message = TLSProxy::ServerHello->new(
274 } elsif ($mt == MT_ENCRYPTED_EXTENSIONS) {
275 $message = TLSProxy::EncryptedExtensions->new(
283 } elsif ($mt == MT_CERTIFICATE) {
284 $message = TLSProxy::Certificate->new(
292 } elsif ($mt == MT_CERTIFICATE_VERIFY) {
293 $message = TLSProxy::CertificateVerify->new(
301 } elsif ($mt == MT_SERVER_KEY_EXCHANGE) {
302 $message = TLSProxy::ServerKeyExchange->new(
310 } elsif ($mt == MT_NEW_SESSION_TICKET) {
311 $message = TLSProxy::NewSessionTicket->new(
320 #Unknown message type
321 $message = TLSProxy::Message->new(
347 return !$success && $end;
357 $message_frag_lens) = @_;
364 startoffset => $startoffset,
365 message_frag_lens => $message_frag_lens
368 return bless $self, $class;
375 $ciphersuite = shift;
380 #Update all the underlying records with the modified data from this message
381 #Note: Only supports re-encrypting for TLSv1.3
387 my $numrecs = $#{$self->records};
389 $self->set_message_contents();
394 $lenlo = length($self->data) & 0xff;
395 $lenhi = length($self->data) >> 8;
396 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
399 #The message is fully contained within one record
400 my ($rec) = @{$self->records};
401 my $recdata = $rec->decrypt_data;
405 # We use empty message_frag_lens to indicates that pre-repacking,
406 # the message wasn't present. The first fragment length doesn't include
407 # the TLS header, so we need to check and compute the right length.
408 if (@{$self->message_frag_lens}) {
409 $old_length = ${$self->message_frag_lens}[0] +
410 TLS_MESSAGE_HEADER_LENGTH;
415 my $prefix = substr($recdata, 0, $self->startoffset);
416 my $suffix = substr($recdata, $self->startoffset + $old_length);
418 $rec->decrypt_data($prefix.($msgdata).($suffix));
419 # TODO(openssl-team): don't keep explicit lengths.
420 # (If a length override is ever needed to construct invalid packets,
421 # use an explicit override field instead.)
422 $rec->decrypt_len(length($rec->decrypt_data));
423 $rec->len($rec->len + length($msgdata) - $old_length);
424 # Only support re-encryption for TLSv1.3.
425 if (TLSProxy::Proxy->is_tls13() && $rec->encrypted()) {
426 #Add content type (1 byte) and 16 tag bytes
427 $rec->data($rec->decrypt_data
428 .pack("C", TLSProxy::Record::RT_HANDSHAKE).("\0"x16));
430 $rec->data($rec->decrypt_data);
433 #Update the fragment len in case we changed it above
434 ${$self->message_frag_lens}[0] = length($msgdata)
435 - TLS_MESSAGE_HEADER_LENGTH;
439 #Note we don't currently support changing a fragmented message length
442 foreach my $rec (@{$self->records}) {
443 my $recdata = $rec->decrypt_data;
445 #This is the first record
446 my $remainlen = length($recdata) - $self->startoffset;
447 $rec->data(substr($recdata, 0, $self->startoffset)
448 .substr(($msgdata), 0, $remainlen));
449 $datadone += $remainlen;
450 } elsif ($recctr + 1 == $numrecs) {
451 #This is the last record
452 $rec->data(substr($msgdata, $datadone));
454 #This is a middle record
455 $rec->data(substr($msgdata, $datadone, length($rec->data)));
456 $datadone += length($rec->data);
462 #To be overridden by sub-classes
463 sub set_message_contents
471 return $self->{server};
474 #Read/write accessors
487 $self->{data} = shift;
489 return $self->{data};
495 $self->{records} = shift;
497 return $self->{records};
503 $self->{startoffset} = shift;
505 return $self->{startoffset};
507 sub message_frag_lens
511 $self->{message_frag_lens} = shift;
513 return $self->{message_frag_lens};
518 return TLS_MESSAGE_HEADER_LENGTH + length($self->data);
524 $successondata = shift;
526 return $successondata;