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;
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 # This extension is an unofficial extension only ever written by OpenSSL
90 # (i.e. not read), and even then only when enabled. We use it to test
91 # handling of duplicate extensions.
92 EXT_DUPLICATE_EXTENSION => 0xfde8,
93 EXT_UNKNOWN => 0xfffe,
94 #Unknown extension that should appear last
95 EXT_FORCE_LAST => 0xffff
98 # SignatureScheme of TLS 1.3 from:
99 # https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-signaturescheme
100 # We have to manually grab the SHA224 equivalents from the old registry
102 SIG_ALG_RSA_PKCS1_SHA256 => 0x0401,
103 SIG_ALG_RSA_PKCS1_SHA384 => 0x0501,
104 SIG_ALG_RSA_PKCS1_SHA512 => 0x0601,
105 SIG_ALG_ECDSA_SECP256R1_SHA256 => 0x0403,
106 SIG_ALG_ECDSA_SECP384R1_SHA384 => 0x0503,
107 SIG_ALG_ECDSA_SECP521R1_SHA512 => 0x0603,
108 SIG_ALG_RSA_PSS_RSAE_SHA256 => 0x0804,
109 SIG_ALG_RSA_PSS_RSAE_SHA384 => 0x0805,
110 SIG_ALG_RSA_PSS_RSAE_SHA512 => 0x0806,
111 SIG_ALG_ED25519 => 0x0807,
112 SIG_ALG_ED448 => 0x0808,
113 SIG_ALG_RSA_PSS_PSS_SHA256 => 0x0809,
114 SIG_ALG_RSA_PSS_PSS_SHA384 => 0x080a,
115 SIG_ALG_RSA_PSS_PSS_SHA512 => 0x080b,
116 SIG_ALG_RSA_PKCS1_SHA1 => 0x0201,
117 SIG_ALG_ECDSA_SHA1 => 0x0203,
118 SIG_ALG_DSA_SHA1 => 0x0202,
119 SIG_ALG_DSA_SHA256 => 0x0402,
120 SIG_ALG_DSA_SHA384 => 0x0502,
121 SIG_ALG_DSA_SHA512 => 0x0602,
122 OSSL_SIG_ALG_RSA_PKCS1_SHA224 => 0x0301,
123 OSSL_SIG_ALG_DSA_SHA224 => 0x0302,
124 OSSL_SIG_ALG_ECDSA_SHA224 => 0x0303
128 CIPHER_RSA_WITH_AES_128_CBC_SHA => 0x002f,
129 CIPHER_DHE_RSA_AES_128_SHA => 0x0033,
130 CIPHER_ADH_AES_128_SHA => 0x0034,
131 CIPHER_TLS13_AES_128_GCM_SHA256 => 0x1301,
132 CIPHER_TLS13_AES_256_GCM_SHA384 => 0x1302
138 my $startoffset = -1;
142 my @message_rec_list = ();
143 my @message_frag_lens = ();
145 my $successondata = 0;
157 @message_rec_list = ();
158 @message_frag_lens = ();
162 #Class method to extract messages from a record
166 my $serverin = shift;
171 @message_frag_lens = ();
173 if ($serverin != $server && length($payload) != 0) {
174 die "Changed peer, but we still have fragment data\n";
178 if ($record->content_type == TLSProxy::Record::RT_CCS) {
179 if ($payload ne "") {
180 #We can't handle this yet
181 die "CCS received before message data complete\n";
183 if (!TLSProxy::Proxy->is_tls13()) {
185 TLSProxy::Record->server_encrypting(1);
187 TLSProxy::Record->client_encrypting(1);
190 } elsif ($record->content_type == TLSProxy::Record::RT_HANDSHAKE) {
191 if ($record->len == 0 || $record->len_real == 0) {
192 print " Message truncated\n";
196 if (length $payload > 0) {
197 #We are continuing processing a message started in a previous
198 #record. Add this record to the list associated with this
200 push @message_rec_list, $record;
202 if ($messlen <= length($payload)) {
204 die "Internal error: invalid messlen: ".$messlen
205 ." payload length:".length($payload)."\n";
207 if (length($payload) + $record->decrypt_len >= $messlen) {
208 #We can complete the message with this record
209 $recoffset = $messlen - length($payload);
210 $payload .= substr($record->decrypt_data, 0, $recoffset);
211 push @message_frag_lens, $recoffset;
212 $message = create_message($server, $mt, $payload,
214 push @messages, $message;
218 #This is just part of the total message
219 $payload .= $record->decrypt_data;
220 $recoffset = $record->decrypt_len;
221 push @message_frag_lens, $record->decrypt_len;
223 print " Partial message data read: ".$recoffset." bytes\n";
226 while ($record->decrypt_len > $recoffset) {
227 #We are at the start of a new message
228 if ($record->decrypt_len - $recoffset < 4) {
229 #Whilst technically probably valid we can't cope with this
230 die "End of record in the middle of a message header\n";
232 @message_rec_list = ($record);
235 ($mt, $lenhi, $lenlo) = unpack('CnC',
236 substr($record->decrypt_data,
238 $messlen = ($lenhi << 8) | $lenlo;
239 print " Message type: $message_type{$mt}\n";
240 print " Message Length: $messlen\n";
241 $startoffset = $recoffset;
245 if ($recoffset <= $record->decrypt_len) {
246 #Some payload data is present in this record
247 if ($record->decrypt_len - $recoffset >= $messlen) {
248 #We can complete the message with this record
249 $payload .= substr($record->decrypt_data, $recoffset,
251 $recoffset += $messlen;
252 push @message_frag_lens, $messlen;
253 $message = create_message($server, $mt, $payload,
255 push @messages, $message;
259 #This is just part of the total message
260 $payload .= substr($record->decrypt_data, $recoffset,
261 $record->decrypt_len - $recoffset);
262 $recoffset = $record->decrypt_len;
263 push @message_frag_lens, $recoffset;
268 } elsif ($record->content_type == TLSProxy::Record::RT_APPLICATION_DATA) {
269 print " [ENCRYPTED APPLICATION DATA]\n";
270 print " [".$record->decrypt_data."]\n";
272 if ($successondata) {
276 } elsif ($record->content_type == TLSProxy::Record::RT_ALERT) {
277 my ($alertlev, $alertdesc) = unpack('CC', $record->decrypt_data);
278 print " [$alertlev, $alertdesc]\n";
279 #A CloseNotify from the client indicates we have finished successfully
281 if (!$end && !$server && $alertlev == AL_LEVEL_WARN
282 && $alertdesc == AL_DESC_CLOSE_NOTIFY) {
285 #Fatal or close notify alerts end the test
286 if ($alertlev == AL_LEVEL_FATAL || $alertdesc == AL_DESC_CLOSE_NOTIFY) {
289 $alert = TLSProxy::Alert->new(
299 #Function to work out which sub-class we need to create and then
303 my ($server, $mt, $data, $startoffset) = @_;
306 #We only support ClientHello in this version...needs to be extended for
308 if ($mt == MT_CLIENT_HELLO) {
309 $message = TLSProxy::ClientHello->new(
317 } elsif ($mt == MT_SERVER_HELLO) {
318 $message = TLSProxy::ServerHello->new(
326 } elsif ($mt == MT_ENCRYPTED_EXTENSIONS) {
327 $message = TLSProxy::EncryptedExtensions->new(
335 } elsif ($mt == MT_CERTIFICATE) {
336 $message = TLSProxy::Certificate->new(
344 } elsif ($mt == MT_CERTIFICATE_VERIFY) {
345 $message = TLSProxy::CertificateVerify->new(
353 } elsif ($mt == MT_SERVER_KEY_EXCHANGE) {
354 $message = TLSProxy::ServerKeyExchange->new(
362 } elsif ($mt == MT_NEW_SESSION_TICKET) {
363 $message = TLSProxy::NewSessionTicket->new(
372 #Unknown message type
373 $message = TLSProxy::Message->new(
399 return !$success && $end;
415 $message_frag_lens) = @_;
422 startoffset => $startoffset,
423 message_frag_lens => $message_frag_lens
426 return bless $self, $class;
433 $ciphersuite = shift;
438 #Update all the underlying records with the modified data from this message
439 #Note: Only supports re-encrypting for TLSv1.3
445 my $numrecs = $#{$self->records};
447 $self->set_message_contents();
452 $lenlo = length($self->data) & 0xff;
453 $lenhi = length($self->data) >> 8;
454 $msgdata = pack('CnC', $self->mt, $lenhi, $lenlo).$self->data;
457 #The message is fully contained within one record
458 my ($rec) = @{$self->records};
459 my $recdata = $rec->decrypt_data;
463 # We use empty message_frag_lens to indicates that pre-repacking,
464 # the message wasn't present. The first fragment length doesn't include
465 # the TLS header, so we need to check and compute the right length.
466 if (@{$self->message_frag_lens}) {
467 $old_length = ${$self->message_frag_lens}[0] +
468 TLS_MESSAGE_HEADER_LENGTH;
473 my $prefix = substr($recdata, 0, $self->startoffset);
474 my $suffix = substr($recdata, $self->startoffset + $old_length);
476 $rec->decrypt_data($prefix.($msgdata).($suffix));
477 # TODO(openssl-team): don't keep explicit lengths.
478 # (If a length override is ever needed to construct invalid packets,
479 # use an explicit override field instead.)
480 $rec->decrypt_len(length($rec->decrypt_data));
481 $rec->len($rec->len + length($msgdata) - $old_length);
482 # Only support re-encryption for TLSv1.3.
483 if (TLSProxy::Proxy->is_tls13() && $rec->encrypted()) {
484 #Add content type (1 byte) and 16 tag bytes
485 $rec->data($rec->decrypt_data
486 .pack("C", TLSProxy::Record::RT_HANDSHAKE).("\0"x16));
488 $rec->data($rec->decrypt_data);
491 #Update the fragment len in case we changed it above
492 ${$self->message_frag_lens}[0] = length($msgdata)
493 - TLS_MESSAGE_HEADER_LENGTH;
497 #Note we don't currently support changing a fragmented message length
500 foreach my $rec (@{$self->records}) {
501 my $recdata = $rec->decrypt_data;
503 #This is the first record
504 my $remainlen = length($recdata) - $self->startoffset;
505 $rec->data(substr($recdata, 0, $self->startoffset)
506 .substr(($msgdata), 0, $remainlen));
507 $datadone += $remainlen;
508 } elsif ($recctr + 1 == $numrecs) {
509 #This is the last record
510 $rec->data(substr($msgdata, $datadone));
512 #This is a middle record
513 $rec->data(substr($msgdata, $datadone, length($rec->data)));
514 $datadone += length($rec->data);
520 #To be overridden by sub-classes
521 sub set_message_contents
529 return $self->{server};
532 #Read/write accessors
545 $self->{data} = shift;
547 return $self->{data};
553 $self->{records} = shift;
555 return $self->{records};
561 $self->{startoffset} = shift;
563 return $self->{startoffset};
565 sub message_frag_lens
569 $self->{message_frag_lens} = shift;
571 return $self->{message_frag_lens};
576 return TLS_MESSAGE_HEADER_LENGTH + length($self->data);
582 $successondata = shift;
584 return $successondata;