Commit cf72c757 authored by FdaSilvaYY's avatar FdaSilvaYY Committed by Bernd Edlinger
Browse files

Implement Maximum Fragment Length TLS extension. 

Based on patch from Tomasz Moń:
https://groups.google.com/forum/#!topic/mailing.openssl.dev/fQxXvCg1uQY



Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
Reviewed-by: default avatarBernd Edlinger <bernd.edlinger@hotmail.de>
(Merged from https://github.com/openssl/openssl/pull/1008)
parent b82acc3c

CHANGES

+5 −0
Original line number Diff line number Diff line
@@ -9,6 +9,11 @@ 














 Changes between 1.1.0f and 1.1.1 [xx XXX xxxx]



























  *) Add 'Maximum Fragment Length' TLS extension negotiation and support













     as documented in RFC6066.













     Based on a patch from Tomasz Moń













     [Filipe Raimundo da Silva]



























  *) Add SM4 implemented according to GB/T 32907-2016.















     [ Jack Lloyd <jack.lloyd@ribose.com>,















       Ronald Tse <ronald.tse@ribose.com>,

































apps/s_client.c



+35
−2






























Original line number
Diff line number
Diff line








@@ -590,8 +590,8 @@ typedef enum OPTION_choice {













    OPT_CHAINCAFILE, OPT_VERIFYCAFILE, OPT_NEXTPROTONEG, OPT_ALPN,















    OPT_SERVERINFO, OPT_STARTTLS, OPT_SERVERNAME, OPT_NOSERVERNAME, OPT_ASYNC,















    OPT_USE_SRTP, OPT_KEYMATEXPORT, OPT_KEYMATEXPORTLEN, OPT_PROTOHOST,













    OPT_MAX_SEND_FRAG, OPT_SPLIT_SEND_FRAG, OPT_MAX_PIPELINES, OPT_READ_BUF,













    OPT_KEYLOG_FILE, OPT_EARLY_DATA, OPT_REQCAFILE,













    OPT_MAXFRAGLEN, OPT_MAX_SEND_FRAG, OPT_SPLIT_SEND_FRAG, OPT_MAX_PIPELINES,













    OPT_READ_BUF, OPT_KEYLOG_FILE, OPT_EARLY_DATA, OPT_REQCAFILE,















    OPT_V_ENUM,















    OPT_X_ENUM,















    OPT_S_ENUM,










@@ -665,6 +665,8 @@ const OPTIONS s_client_options[] = {













     "Export keying material using label"},















    {"keymatexportlen", OPT_KEYMATEXPORTLEN, 'p',















     "Export len bytes of keying material (default 20)"},













    {"maxfraglen", OPT_MAXFRAGLEN, 'p',













     "Enable Maximum Fragment Length Negotiation (len values: 512, 1024, 2048 and 4096)"},















    {"fallback_scsv", OPT_FALLBACKSCSV, '-', "Send the fallback SCSV"},















    {"name", OPT_PROTOHOST, 's',















     "Hostname to use for \"-starttls lmtp\", \"-starttls smtp\" or \"-starttls xmpp[-server]\""},










@@ -942,6 +944,7 @@ int s_client_main(int argc, char **argv)













    unsigned int split_send_fragment = 0, max_pipelines = 0;















    enum { use_inet, use_unix, use_unknown } connect_type = use_unknown;















    int count4or6 = 0;













    uint8_t maxfraglen = 0;















    int c_nbio = 0, c_msg = 0, c_ign_eof = 0, c_brief = 0;















    int c_tlsextdebug = 0;















#ifndef OPENSSL_NO_OCSP










@@ -1424,6 +1427,28 @@ int s_client_main(int argc, char **argv)













        case OPT_ASYNC:















            async = 1;















            break;













        case OPT_MAXFRAGLEN:













            len = atoi(opt_arg());













            switch (len) {













            case 512:













                maxfraglen = TLSEXT_max_fragment_length_512;













                break;













            case 1024:













                maxfraglen = TLSEXT_max_fragment_length_1024;













                break;













            case 2048:













                maxfraglen = TLSEXT_max_fragment_length_2048;













                break;













            case 4096:













                maxfraglen = TLSEXT_max_fragment_length_4096;













                break;













            default:













                BIO_printf(bio_err,













                           "%s: Max Fragment Len %u is out of permitted values",













                           prog, len);













                goto opthelp;













            }













            break;















        case OPT_MAX_SEND_FRAG:















            max_send_fragment = atoi(opt_arg());















            break;










@@ -1677,6 +1702,14 @@ int s_client_main(int argc, char **argv)













        SSL_CTX_set_default_read_buffer_len(ctx, read_buf_len);















    }





























    if (maxfraglen > 0













            && !SSL_CTX_set_tlsext_max_fragment_length(ctx, maxfraglen)) {













        BIO_printf(bio_err,













                   "%s: Max Fragment Length code %u is out of permitted values"













                   "\n", prog, maxfraglen);













        goto end;













    }





























    if (!config_ctx(cctx, ssl_args, ctx))















        goto end;

















































crypto/err/openssl.txt



+7
−0






























Original line number
Diff line number
Diff line








@@ -1063,6 +1063,8 @@ SSL_F_SSL_CTX_SET_CLIENT_CERT_ENGINE:290:SSL_CTX_set_client_cert_engine













SSL_F_SSL_CTX_SET_CT_VALIDATION_CALLBACK:396:SSL_CTX_set_ct_validation_callback















SSL_F_SSL_CTX_SET_SESSION_ID_CONTEXT:219:SSL_CTX_set_session_id_context















SSL_F_SSL_CTX_SET_SSL_VERSION:170:SSL_CTX_set_ssl_version













SSL_F_SSL_CTX_SET_TLSEXT_MAX_FRAGMENT_LENGTH:551:\













	SSL_CTX_set_tlsext_max_fragment_length















SSL_F_SSL_CTX_USE_CERTIFICATE:171:SSL_CTX_use_certificate















SSL_F_SSL_CTX_USE_CERTIFICATE_ASN1:172:SSL_CTX_use_certificate_ASN1















SSL_F_SSL_CTX_USE_CERTIFICATE_FILE:173:SSL_CTX_use_certificate_file










@@ -1126,6 +1128,7 @@ SSL_F_SSL_SET_RFD:194:SSL_set_rfd













SSL_F_SSL_SET_SESSION:195:SSL_set_session















SSL_F_SSL_SET_SESSION_ID_CONTEXT:218:SSL_set_session_id_context















SSL_F_SSL_SET_SESSION_TICKET_EXT:294:SSL_set_session_ticket_ext













SSL_F_SSL_SET_TLSEXT_MAX_FRAGMENT_LENGTH:550:SSL_set_tlsext_max_fragment_length















SSL_F_SSL_SET_WFD:196:SSL_set_wfd















SSL_F_SSL_SHUTDOWN:224:SSL_shutdown















SSL_F_SSL_SRP_CTX_INIT:313:SSL_SRP_CTX_init










@@ -1192,6 +1195,7 @@ SSL_F_TLS_CONSTRUCT_CTOS_ETM:469:tls_construct_ctos_etm













SSL_F_TLS_CONSTRUCT_CTOS_HELLO:356:*















SSL_F_TLS_CONSTRUCT_CTOS_KEY_EXCHANGE:357:*















SSL_F_TLS_CONSTRUCT_CTOS_KEY_SHARE:470:tls_construct_ctos_key_share













SSL_F_TLS_CONSTRUCT_CTOS_MAXFRAGMENTLEN:549:tls_construct_ctos_maxfragmentlen















SSL_F_TLS_CONSTRUCT_CTOS_NPN:471:tls_construct_ctos_npn















SSL_F_TLS_CONSTRUCT_CTOS_PADDING:472:tls_construct_ctos_padding















SSL_F_TLS_CONSTRUCT_CTOS_PSK:501:tls_construct_ctos_psk










@@ -1233,6 +1237,7 @@ SSL_F_TLS_CONSTRUCT_STOC_ETM:455:tls_construct_stoc_etm













SSL_F_TLS_CONSTRUCT_STOC_HELLO:376:*















SSL_F_TLS_CONSTRUCT_STOC_KEY_EXCHANGE:377:*















SSL_F_TLS_CONSTRUCT_STOC_KEY_SHARE:456:tls_construct_stoc_key_share













SSL_F_TLS_CONSTRUCT_STOC_MAXFRAGMENTLEN:548:tls_construct_stoc_maxfragmentlen















SSL_F_TLS_CONSTRUCT_STOC_NEXT_PROTO_NEG:457:tls_construct_stoc_next_proto_neg















SSL_F_TLS_CONSTRUCT_STOC_PSK:504:tls_construct_stoc_psk















SSL_F_TLS_CONSTRUCT_STOC_RENEGOTIATE:458:tls_construct_stoc_renegotiate










@@ -2443,6 +2448,8 @@ SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES:362:srtp could not allocate profiles













SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG:363:\















	srtp protection profile list too long















SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE:364:srtp unknown protection profile













SSL_R_SSL3_EXT_INVALID_MAX_FRAGMENT_LENGTH:232:\













	ssl3 ext invalid max fragment length















SSL_R_SSL3_EXT_INVALID_SERVERNAME:319:ssl3 ext invalid servername















SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE:320:ssl3 ext invalid servername type















SSL_R_SSL3_SESSION_ID_TOO_LONG:300:ssl3 session id too long

































doc/man3/SSL_CTX_set_split_send_fragment.pod



+62
−6






























Original line number
Diff line number
Diff line








@@ -5,8 +5,10 @@













SSL_CTX_set_max_send_fragment, SSL_set_max_send_fragment,















SSL_CTX_set_split_send_fragment, SSL_set_split_send_fragment,















SSL_CTX_set_max_pipelines, SSL_set_max_pipelines,













SSL_CTX_set_default_read_buffer_len, SSL_set_default_read_buffer_len - Control













fragment sizes and pipelining operations













SSL_CTX_set_default_read_buffer_len, SSL_set_default_read_buffer_len,













SSL_CTX_set_tlsext_max_fragment_length,













SSL_set_tlsext_max_fragment_length,













SSL_SESSION_get_max_fragment_length - Control fragment size settings and pipelining operations































=head1 SYNOPSIS

























@@ -24,6 +26,10 @@ fragment sizes and pipelining operations













 void SSL_CTX_set_default_read_buffer_len(SSL_CTX *ctx, size_t len);















 void SSL_set_default_read_buffer_len(SSL *s, size_t len);





























 int SSL_CTX_set_tlsext_max_fragment_length(SSL_CTX *ctx, uint8_t mode);













 int SSL_set_tlsext_max_fragment_length(SSL *ssl, uint8_t mode);













 uint8_t SSL_SESSION_get_max_fragment_length(SSL_SESSION *session);





























=head1 DESCRIPTION































Some engines are able to process multiple simultaneous crypto operations. This










@@ -99,15 +105,62 @@ greater than the default that would have been used anyway. The normal default













value depends on a number of factors but it will be at least















SSL3_RT_MAX_PLAIN_LENGTH + SSL3_RT_MAX_ENCRYPTED_OVERHEAD (16704) bytes.





























SSL_CTX_set_tlsext_max_fragment_length() sets the default maximum fragment













length negotiation mode via value B<mode> to B<ctx>.













This setting affects only SSL instances created after this function is called.













It affects the client-side as only its side may initiate this extension use.



























SSL_set_tlsext_max_fragment_length() sets the maximum fragment length













negotiation mode via value B<mode> to B<ssl>.













This setting will be used during a handshake when extensions are exchanged













between client and server.













So it only affects SSL sessions created after this function is called.













It affects the client-side as only its side may initiate this extension use.



























SSL_SESSION_get_max_fragment_length() gets the maximum fragment length













negotiated in B<session>.





























=head1 RETURN VALUES































All non-void functions return 1 on success and 0 on failure.































=head1 NOTES





























With the exception of SSL_CTX_set_default_read_buffer_len() and













SSL_set_default_read_buffer_len() all these functions are implemented using













macros.













The Maximum Fragment Length extension support is optional on the server side.













If the server does not support this extension then













SSL_SESSION_get_max_fragment_length() will return:













TLSEXT_max_fragment_length_DISABLED.



























The following modes are available:



























=over 4



























=item TLSEXT_max_fragment_length_DISABLED



























Disables Maximum Fragment Length Negotiation (default).



























=item TLSEXT_max_fragment_length_512



























Sets Maximum Fragment Length to 512 bytes.



























=item TLSEXT_max_fragment_length_1024



























Sets Maximum Fragment Length to 1024.



























=item TLSEXT_max_fragment_length_2048



























Sets Maximum Fragment Length to 2048.



























=item TLSEXT_max_fragment_length_4096



























Sets Maximum Fragment Length to 4096.



























=back



























With the exception of SSL_CTX_set_default_read_buffer_len()













SSL_set_default_read_buffer_len(), SSL_CTX_set_tlsext_max_fragment_length(),













SSL_set_tlsext_max_fragment_length() and SSL_SESSION_get_max_fragment_length()













all these functions are implemented using macros.































=head1 HISTORY

























@@ -116,13 +169,16 @@ SSL_CTX_set_split_send_fragment(), SSL_set_split_send_fragment(),













SSL_CTX_set_default_read_buffer_len() and  SSL_set_default_read_buffer_len()















functions were added in OpenSSL 1.1.0.





























SSL_CTX_set_tlsext_max_fragment_length(), SSL_set_tlsext_max_fragment_length()













and SSL_SESSION_get_max_fragment_length() were added in OpenSSL 1.1.1.





























=head1 SEE ALSO































L<SSL_CTX_set_read_ahead(3)>, L<SSL_pending(3)>































=head1 COPYRIGHT





























Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.













Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.































Licensed under the OpenSSL license (the "License").  You may not use















this file except in compliance with the License.  You can obtain a copy

































include/openssl/ssl.h



+2
−1






























Original line number
Diff line number
Diff line








@@ -1915,10 +1915,11 @@ __owur size_t SSL_get_client_random(const SSL *ssl, unsigned char *out,













                                    size_t outlen);















__owur size_t SSL_get_server_random(const SSL *ssl, unsigned char *out,















                                    size_t outlen);













__owur size_t SSL_SESSION_get_master_key(const SSL_SESSION *ssl,













__owur size_t SSL_SESSION_get_master_key(const SSL_SESSION *sess,















                                         unsigned char *out, size_t outlen);















__owur int SSL_SESSION_set1_master_key(SSL_SESSION *sess,















                                       const unsigned char *in, size_t len);













uint8_t SSL_SESSION_get_max_fragment_length(const SSL_SESSION *sess);































#define SSL_get_ex_new_index(l, p, newf, dupf, freef) \















    CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_SSL, l, p, newf, dupf, freef)