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_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_STATUS_REQUEST => 5,
65 EXT_SUPPORTED_GROUPS => 10,
66 EXT_EC_POINT_FORMATS => 11,
73 EXT_ENCRYPT_THEN_MAC => 22,
74 EXT_EXTENDED_MASTER_SECRET => 23,
75 EXT_SESSION_TICKET => 35,
77 EXT_SUPPORTED_VERSIONS => 43,
78 EXT_RENEGOTIATE => 65281,
80 # This extension is an unofficial extension only ever written by OpenSSL
81 # (i.e. not read), and even then only when enabled. We use it to test
82 # handling of duplicate extensions.
83 EXT_DUPLICATE_EXTENSION => 0xfde8
93 my @message_rec_list = ();
94 my @message_frag_lens = ();
105 @message_rec_list = ();
106 @message_frag_lens = ();
109 #Class method to extract messages from a record
113 my $serverin = shift;
118 @message_frag_lens = ();
120 if ($serverin != $server && length($payload) != 0) {
121 die "Changed peer, but we still have fragment data\n";
125 if ($record->content_type == TLSProxy::Record::RT_CCS) {
126 if ($payload ne "") {
127 #We can't handle this yet
128 die "CCS received before message data complete\n";
131 TLSProxy::Record->server_encrypting(1);
133 TLSProxy::Record->client_encrypting(1);
135 } elsif ($record->content_type == TLSProxy::Record::RT_HANDSHAKE) {
136 if ($record->len == 0 || $record->len_real == 0) {
137 print " Message truncated\n";
141 if (length $payload > 0) {
142 #We are continuing processing a message started in a previous
143 #record. Add this record to the list associated with this
145 push @message_rec_list, $record;
147 if ($messlen <= length($payload)) {
149 die "Internal error: invalid messlen: ".$messlen
150 ." payload length:".length($payload)."\n";
152 if (length($payload) + $record->decrypt_len >= $messlen) {
153 #We can complete the message with this record
154 $recoffset = $messlen - length($payload);
155 $payload .= substr($record->decrypt_data, 0, $recoffset);
156 push @message_frag_lens, $recoffset;
157 $message = create_message($server, $mt, $payload,
159 push @messages, $message;
163 #This is just part of the total message
164 $payload .= $record->decrypt_data;
165 $recoffset = $record->decrypt_len;
166 push @message_frag_lens, $record->decrypt_len;
168 print " Partial message data read: ".$recoffset." bytes\n";
171 while ($record->decrypt_len > $recoffset) {
172 #We are at the start of a new message
173 if ($record->decrypt_len - $recoffset < 4) {
174 #Whilst technically probably valid we can't cope with this
175 die "End of record in the middle of a message header\n";
177 @message_rec_list = ($record);
180 ($mt, $lenhi, $lenlo) = unpack('CnC',
181 substr($record->decrypt_data,
183 $messlen = ($lenhi << 8) | $lenlo;
184 print " Message type: $message_type{$mt}\n";
185 print " Message Length: $messlen\n";
186 $startoffset = $recoffset;
190 if ($recoffset < $record->decrypt_len) {
191 #Some payload data is present in this record
192 if ($record->decrypt_len - $recoffset >= $messlen) {
193 #We can complete the message with this record
194 $payload .= substr($record->decrypt_data, $recoffset,
196 $recoffset += $messlen;
197 push @message_frag_lens, $messlen;
198 $message = create_message($server, $mt, $payload,
200 push @messages, $message;
204 #This is just part of the total message
205 $payload .= substr($record->decrypt_data, $recoffset,
206 $record->decrypt_len - $recoffset);
207 $recoffset = $record->decrypt_len;
208 push @message_frag_lens, $recoffset;
213 } elsif ($record->content_type == TLSProxy::Record::RT_APPLICATION_DATA) {
214 print " [ENCRYPTED APPLICATION DATA]\n";
215 print " [".$record->decrypt_data."]\n";
216 } elsif ($record->content_type == TLSProxy::Record::RT_ALERT) {
217 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
218 #A CloseNotify from the client indicates we have finished successfully
220 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
221 && $alertdesc == AL_DESC_CLOSE_NOTIFY) {
224 #All alerts end the test
231 #Function to work out which sub-class we need to create and then
235 my ($server, $mt, $data, $startoffset) = @_;
238 #We only support ClientHello in this version...needs to be extended for
240 if ($mt == MT_CLIENT_HELLO) {
241 $message = TLSProxy::ClientHello->new(
249 } elsif ($mt == MT_SERVER_HELLO) {
250 $message = TLSProxy::ServerHello->new(
258 } elsif ($mt == MT_ENCRYPTED_EXTENSIONS) {
259 $message = TLSProxy::EncryptedExtensions->new(
267 } elsif ($mt == MT_SERVER_KEY_EXCHANGE) {
268 $message = TLSProxy::ServerKeyExchange->new(
276 } elsif ($mt == MT_NEW_SESSION_TICKET) {
277 $message = TLSProxy::NewSessionTicket->new(
286 #Unknown message type
287 $message = TLSProxy::Message->new(
313 return !$success && $end;
323 $message_frag_lens) = @_;
330 startoffset => $startoffset,
331 message_frag_lens => $message_frag_lens
334 return bless $self, $class;
341 $ciphersuite = shift;
346 #Update all the underlying records with the modified data from this message
347 #Note: Does not currently support re-encrypting
353 my $numrecs = $#{$self->records};
355 $self->set_message_contents();
360 $lenlo = length($self->data) & 0xff;
361 $lenhi = length($self->data) >> 8;
362 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
365 #The message is fully contained within one record
366 my ($rec) = @{$self->records};
367 my $recdata = $rec->decrypt_data;
371 # We use empty message_frag_lens to indicates that pre-repacking,
372 # the message wasn't present. The first fragment length doesn't include
373 # the TLS header, so we need to check and compute the right length.
374 if (@{$self->message_frag_lens}) {
375 $old_length = ${$self->message_frag_lens}[0] +
376 TLS_MESSAGE_HEADER_LENGTH;
381 my $prefix = substr($recdata, 0, $self->startoffset);
382 my $suffix = substr($recdata, $self->startoffset + $old_length);
384 $rec->decrypt_data($prefix.($msgdata).($suffix));
385 # TODO(openssl-team): don't keep explicit lengths.
386 # (If a length override is ever needed to construct invalid packets,
387 # use an explicit override field instead.)
388 $rec->decrypt_len(length($rec->decrypt_data));
389 $rec->len($rec->len + length($msgdata) - $old_length);
390 # Don't support re-encryption.
391 $rec->data($rec->decrypt_data);
393 #Update the fragment len in case we changed it above
394 ${$self->message_frag_lens}[0] = length($msgdata)
395 - TLS_MESSAGE_HEADER_LENGTH;
399 #Note we don't currently support changing a fragmented message length
402 foreach my $rec (@{$self->records}) {
403 my $recdata = $rec->decrypt_data;
405 #This is the first record
406 my $remainlen = length($recdata) - $self->startoffset;
407 $rec->data(substr($recdata, 0, $self->startoffset)
408 .substr(($msgdata), 0, $remainlen));
409 $datadone += $remainlen;
410 } elsif ($recctr + 1 == $numrecs) {
411 #This is the last record
412 $rec->data(substr($msgdata, $datadone));
414 #This is a middle record
415 $rec->data(substr($msgdata, $datadone, length($rec->data)));
416 $datadone += length($rec->data);
422 #To be overridden by sub-classes
423 sub set_message_contents
431 return $self->{server};
434 #Read/write accessors
447 $self->{data} = shift;
449 return $self->{data};
455 $self->{records} = shift;
457 return $self->{records};
463 $self->{startoffset} = shift;
465 return $self->{startoffset};
467 sub message_frag_lens
471 $self->{message_frag_lens} = shift;
473 return $self->{message_frag_lens};
478 return TLS_MESSAGE_HEADER_LENGTH + length($self->data);