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,
21 MT_SERVER_KEY_EXCHANGE => 12,
22 MT_CERTIFICATE_REQUEST => 13,
23 MT_SERVER_HELLO_DONE => 14,
24 MT_CERTIFICATE_VERIFY => 15,
25 MT_CLIENT_KEY_EXCHANGE => 16,
27 MT_CERTIFICATE_STATUS => 22,
39 AL_DESC_CLOSE_NOTIFY => 0,
40 AL_DESC_UNEXPECTED_MESSAGE => 10,
41 AL_DESC_NO_RENEGOTIATION => 100
45 MT_HELLO_REQUEST, "HelloRequest",
46 MT_CLIENT_HELLO, "ClientHello",
47 MT_SERVER_HELLO, "ServerHello",
48 MT_NEW_SESSION_TICKET, "NewSessionTicket",
49 MT_CERTIFICATE, "Certificate",
50 MT_SERVER_KEY_EXCHANGE, "ServerKeyExchange",
51 MT_CERTIFICATE_REQUEST, "CertificateRequest",
52 MT_SERVER_HELLO_DONE, "ServerHelloDone",
53 MT_CERTIFICATE_VERIFY, "CertificateVerify",
54 MT_CLIENT_KEY_EXCHANGE, "ClientKeyExchange",
55 MT_FINISHED, "Finished",
56 MT_CERTIFICATE_STATUS, "CertificateStatus",
57 MT_NEXT_PROTO, "NextProto"
61 EXT_STATUS_REQUEST => 5,
62 EXT_ENCRYPT_THEN_MAC => 22,
63 EXT_EXTENDED_MASTER_SECRET => 23,
64 EXT_SESSION_TICKET => 35,
65 # This extension does not exist and isn't recognised by OpenSSL.
66 # We use it to test handling of duplicate extensions.
67 EXT_DUPLICATE_EXTENSION => 1234
77 my @message_rec_list = ();
78 my @message_frag_lens = ();
89 @message_rec_list = ();
90 @message_frag_lens = ();
93 #Class method to extract messages from a record
102 @message_frag_lens = ();
104 if ($serverin != $server && length($payload) != 0) {
105 die "Changed peer, but we still have fragment data\n";
109 if ($record->content_type == TLSProxy::Record::RT_CCS) {
110 if ($payload ne "") {
111 #We can't handle this yet
112 die "CCS received before message data complete\n";
115 TLSProxy::Record->server_ccs_seen(1);
117 TLSProxy::Record->client_ccs_seen(1);
119 } elsif ($record->content_type == TLSProxy::Record::RT_HANDSHAKE) {
120 if ($record->len == 0 || $record->len_real == 0) {
121 print " Message truncated\n";
125 if (length $payload > 0) {
126 #We are continuing processing a message started in a previous
127 #record. Add this record to the list associated with this
129 push @message_rec_list, $record;
131 if ($messlen <= length($payload)) {
133 die "Internal error: invalid messlen: ".$messlen
134 ." payload length:".length($payload)."\n";
136 if (length($payload) + $record->decrypt_len >= $messlen) {
137 #We can complete the message with this record
138 $recoffset = $messlen - length($payload);
139 $payload .= substr($record->decrypt_data, 0, $recoffset);
140 push @message_frag_lens, $recoffset;
141 $message = create_message($server, $mt, $payload,
143 push @messages, $message;
147 #This is just part of the total message
148 $payload .= $record->decrypt_data;
149 $recoffset = $record->decrypt_len;
150 push @message_frag_lens, $record->decrypt_len;
152 print " Partial message data read: ".$recoffset." bytes\n";
155 while ($record->decrypt_len > $recoffset) {
156 #We are at the start of a new message
157 if ($record->decrypt_len - $recoffset < 4) {
158 #Whilst technically probably valid we can't cope with this
159 die "End of record in the middle of a message header\n";
161 @message_rec_list = ($record);
164 ($mt, $lenhi, $lenlo) = unpack('CnC',
165 substr($record->decrypt_data,
167 $messlen = ($lenhi << 8) | $lenlo;
168 print " Message type: $message_type{$mt}\n";
169 print " Message Length: $messlen\n";
170 $startoffset = $recoffset;
174 if ($recoffset < $record->decrypt_len) {
175 #Some payload data is present in this record
176 if ($record->decrypt_len - $recoffset >= $messlen) {
177 #We can complete the message with this record
178 $payload .= substr($record->decrypt_data, $recoffset,
180 $recoffset += $messlen;
181 push @message_frag_lens, $messlen;
182 $message = create_message($server, $mt, $payload,
184 push @messages, $message;
188 #This is just part of the total message
189 $payload .= substr($record->decrypt_data, $recoffset,
190 $record->decrypt_len - $recoffset);
191 $recoffset = $record->decrypt_len;
192 push @message_frag_lens, $recoffset;
197 } elsif ($record->content_type == TLSProxy::Record::RT_APPLICATION_DATA) {
198 print " [ENCRYPTED APPLICATION DATA]\n";
199 print " [".$record->decrypt_data."]\n";
200 } elsif ($record->content_type == TLSProxy::Record::RT_ALERT) {
201 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
202 #A CloseNotify from the client indicates we have finished successfully
204 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
205 && $alertdesc == AL_DESC_CLOSE_NOTIFY) {
208 #All alerts end the test
215 #Function to work out which sub-class we need to create and then
219 my ($server, $mt, $data, $startoffset) = @_;
222 #We only support ClientHello in this version...needs to be extended for
224 if ($mt == MT_CLIENT_HELLO) {
225 $message = TLSProxy::ClientHello->new(
233 } elsif ($mt == MT_SERVER_HELLO) {
234 $message = TLSProxy::ServerHello->new(
242 } elsif ($mt == MT_SERVER_KEY_EXCHANGE) {
243 $message = TLSProxy::ServerKeyExchange->new(
251 } elsif ($mt == MT_NEW_SESSION_TICKET) {
252 $message = TLSProxy::NewSessionTicket->new(
261 #Unknown message type
262 $message = TLSProxy::Message->new(
288 return !$success && $end;
298 $message_frag_lens) = @_;
305 startoffset => $startoffset,
306 message_frag_lens => $message_frag_lens
309 return bless $self, $class;
316 $ciphersuite = shift;
321 #Update all the underlying records with the modified data from this message
322 #Note: Does not currently support re-encrypting
328 my $numrecs = $#{$self->records};
330 $self->set_message_contents();
335 $lenlo = length($self->data) & 0xff;
336 $lenhi = length($self->data) >> 8;
337 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
340 #The message is fully contained within one record
341 my ($rec) = @{$self->records};
342 my $recdata = $rec->decrypt_data;
346 # We use empty message_frag_lens to indicates that pre-repacking,
347 # the message wasn't present. The first fragment length doesn't include
348 # the TLS header, so we need to check and compute the right length.
349 if (@{$self->message_frag_lens}) {
350 $old_length = ${$self->message_frag_lens}[0] +
351 TLS_MESSAGE_HEADER_LENGTH;
356 my $prefix = substr($recdata, 0, $self->startoffset);
357 my $suffix = substr($recdata, $self->startoffset + $old_length);
359 $rec->decrypt_data($prefix.($msgdata).($suffix));
360 # TODO(openssl-team): don't keep explicit lengths.
361 # (If a length override is ever needed to construct invalid packets,
362 # use an explicit override field instead.)
363 $rec->decrypt_len(length($rec->decrypt_data));
364 $rec->len($rec->len + length($msgdata) - $old_length);
365 # Don't support re-encryption.
366 $rec->data($rec->decrypt_data);
368 #Update the fragment len in case we changed it above
369 ${$self->message_frag_lens}[0] = length($msgdata)
370 - TLS_MESSAGE_HEADER_LENGTH;
374 #Note we don't currently support changing a fragmented message length
377 foreach my $rec (@{$self->records}) {
378 my $recdata = $rec->decrypt_data;
380 #This is the first record
381 my $remainlen = length($recdata) - $self->startoffset;
382 $rec->data(substr($recdata, 0, $self->startoffset)
383 .substr(($msgdata), 0, $remainlen));
384 $datadone += $remainlen;
385 } elsif ($recctr + 1 == $numrecs) {
386 #This is the last record
387 $rec->data(substr($msgdata, $datadone));
389 #This is a middle record
390 $rec->data(substr($msgdata, $datadone, length($rec->data)));
391 $datadone += length($rec->data);
397 #To be overridden by sub-classes
398 sub set_message_contents
406 return $self->{server};
409 #Read/write accessors
422 $self->{data} = shift;
424 return $self->{data};
430 $self->{records} = shift;
432 return $self->{records};
438 $self->{startoffset} = shift;
440 return $self->{startoffset};
442 sub message_frag_lens
446 $self->{message_frag_lens} = shift;
448 return $self->{message_frag_lens};
453 return TLS_MESSAGE_HEADER_LENGTH + length($self->data);