src/include/tls-h

   1 /*
   2  *   This program is free software; you can redistribute it and/or modify
   3  *   it under the terms of the GNU General Public License as published by
   4  *   the Free Software Foundation; either version 2 of the License, or
   5  *   (at your option) any later version.
   6  *
   7  *   This program is distributed in the hope that it will be useful,
   8  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  *   GNU General Public License for more details.
  11  *
  12  *   You should have received a copy of the GNU General Public License
  13  *   along with this program; if not, write to the Free Software
  14  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16 #ifndef FR_TLS_H
  17 #define FR_TLS_H
  18
  19 #ifdef WITH_TLS
  20 /**
  21  * $Id$
  22  *
  23  * @file tls.h
  24  * @brief Structures and prototypes for TLS wrappers
  25  *
  26  * @copyright 2010 Network RADIUS SARL <info@networkradius.com>
  27  */
  28
  29 RCSIDH(tls_h, "$Id$")
  30
  31 #include <freeradius-devel/conffile.h>
  32
  33 /*
  34  *      For RH 9, which apparently needs this.
  35  */
  36 #ifndef OPENSSL_NO_KRB5
  37 #  define OPENSSL_NO_KRB5
  38 #endif
  39 #include <openssl/err.h>
  40 #ifdef HAVE_OPENSSL_ENGINE_H
  41 #  include <openssl/engine.h>
  42 #endif
  43 #include <openssl/ssl.h>
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 typedef struct fr_tls_server_conf_t fr_tls_server_conf_t;
  50
  51 typedef enum {
  52         FR_TLS_INVALID = 0,                     //!< Invalid, don't reply.
  53         FR_TLS_REQUEST,                         //!< Request, ok to send, invalid to receive.
  54         FR_TLS_RESPONSE,                        //!< Response, ok to receive, invalid to send.
  55         FR_TLS_SUCCESS,                         //!< Success, send success.
  56         FR_TLS_FAIL,                            //!< Fail, send fail.
  57         FR_TLS_NOOP,                            //!< Noop, continue.
  58
  59         FR_TLS_START,                           //!< Start, ok to send, invalid to receive.
  60         FR_TLS_OK,                              //!< Ok, continue.
  61         FR_TLS_ACK,                             //!< Acknowledge, continue.
  62         FR_TLS_FIRST_FRAGMENT,                  //!< First fragment.
  63         FR_TLS_MORE_FRAGMENTS,                  //!< More fragments, to send/receive.
  64         FR_TLS_LENGTH_INCLUDED,                 //!< Length included.
  65         FR_TLS_MORE_FRAGMENTS_WITH_LENGTH,      //!< More fragments with length.
  66         FR_TLS_HANDLED                          //!< TLS code has handled it.
  67 } fr_tls_status_t;
  68 extern FR_NAME_NUMBER const fr_tls_status_table[];
  69
  70 #define MAX_RECORD_SIZE 16384
  71
  72 /*
  73  *      A single TLS record may be up to 16384 octets in length, but a
  74  *      TLS message may span multiple TLS records, and a TLS
  75  *      certificate message may in principle be as long as 16MB.
  76  *
  77  *      However, note that in order to protect against reassembly
  78  *      lockup and denial of service attacks, it may be desirable for
  79  *      an implementation to set a maximum size for one such group of
  80  *      TLS messages.
  81  *
  82  *      The TLS Message Length field is four octets, and provides the
  83  *      total length of the TLS message or set of messages that is
  84  *      being fragmented; this simplifies buffer allocation.
  85  */
  86
  87 /*
  88  * FIXME: Dynamic allocation of buffer to overcome MAX_RECORD_SIZE overflows.
  89  *      or configure TLS not to exceed MAX_RECORD_SIZE.
  90  */
  91 typedef struct _record_t {
  92         uint8_t data[MAX_RECORD_SIZE];
  93         size_t  used;
  94 } record_t;
  95
  96 typedef struct _tls_info_t {
  97         int             origin;
  98         int             content_type;
  99         uint8_t         handshake_type;
 100         uint8_t         alert_level;
 101         uint8_t         alert_description;
 102         bool            initialized;
 103
 104         char            info_description[256];
 105         size_t          record_len;
 106         int             version;
 107 } tls_info_t;
 108
 109 /** Contains EAP-REQUEST specific data (ie FR_TLS_DATA(fragment), EAPTLS-ALERT, EAPTLS-REQUEST ...)
 110  *
 111  * The tls_session_t Structure gets stored as opaque in eap_handler_t
 112  */
 113 typedef struct _tls_session_t {
 114         SSL_CTX         *ctx;
 115         SSL             *ssl;
 116         tls_info_t      info;
 117
 118         BIO             *into_ssl;
 119         BIO             *from_ssl;
 120         record_t        clean_in;                       //!< Data that needs to be sent but only after it is soiled.
 121         record_t        clean_out;                      //!< Data that is cleaned after receiving.
 122         record_t        dirty_in;                       //!< Data EAP server receives.
 123         record_t        dirty_out;                      //!< Data EAP server sends.
 124
 125         void            (*record_init)(record_t *buf);
 126         void            (*record_close)(record_t *buf);
 127         unsigned int    (*record_plus)(record_t *buf, void const *ptr, unsigned int size);
 128         unsigned int    (*record_minus)(record_t *buf, void *ptr, unsigned int size);
 129
 130         bool            invalid_hb_used;                //!< Whether heartbleed attack was detected.
 131
 132         /*
 133          *      Framed-MTU attribute in RADIUS, if present, can also be used to set this
 134          */
 135         size_t          mtu;                            //!< Current fragment size transmitted.
 136         size_t          tls_msg_len;                    //!< Actual/Total TLS message length.
 137         bool            fragment;                       //!< Flag, In fragment mode or not.
 138         bool            length_flag;                    //!< A flag to include length in every TLS Data/Alert packet.
 139                                                         //!< If set to no then only the first fragment contains length.
 140         int             peap_flag;
 141
 142         size_t          tls_record_in_total_len;        //!< How long the peer indicated the complete tls record
 143                                                         //!< would be.
 144         size_t          tls_record_in_recvd_len;        //!< How much of the record we've received so far.
 145
 146         /*
 147          *      Used by TTLS & PEAP to keep track of other per-session data.
 148          */
 149         void            *opaque;
 150         void            (*free_opaque)(void *opaque);
 151
 152         char const      *prf_label;
 153         bool            allow_session_resumption;       //!< Whether session resumption is allowed.
 154 } tls_session_t;
 155
 156 /*
 157  *      RFC 2716, Section 4.2:
 158  *
 159  *         Flags
 160  *
 161  *      0 1 2 3 4 5 6 7 8
 162  *      +-+-+-+-+-+-+-+-+
 163  *      |L M S R R R R R|
 164  *      +-+-+-+-+-+-+-+-+
 165  *
 166  *      L = Length included
 167  *      M = More fragments
 168  *      S = EAP-TLS start
 169  *      R = Reserved
 170  */
 171 #define TLS_START(x)            (((x) & 0x20) != 0)
 172 #define TLS_MORE_FRAGMENTS(x)   (((x) & 0x40) != 0)
 173 #define TLS_LENGTH_INCLUDED(x)  (((x) & 0x80) != 0)
 174
 175 #define TLS_CHANGE_CIPHER_SPEC(x)       (((x) & 0x0014) == 0x0014)
 176 #define TLS_ALERT(x)                    (((x) & 0x0015) == 0x0015)
 177 #define TLS_HANDSHAKE(x)                (((x) & 0x0016) == 0x0016)
 178
 179 #define SET_START(x)            ((x) | (0x20))
 180 #define SET_MORE_FRAGMENTS(x)   ((x) | (0x40))
 181 #define SET_LENGTH_INCLUDED(x)  ((x) | (0x80))
 182
 183 /*
 184  *      Following enums from rfc2246
 185  *
 186  *      Hmm... since we dpeend on OpenSSL, it would be smarter to
 187  *      use the OpenSSL names for these.
 188  */
 189 enum ContentType {
 190         change_cipher_spec = 20,
 191         alert = 21,
 192         handshake = 22,
 193         application_data = 23
 194 };
 195
 196 enum AlertLevel {
 197         warning = 1,
 198         fatal = 2
 199 };
 200
 201 enum AlertDescription {
 202         close_notify = 0,
 203         unexpected_message = 10,
 204         bad_record_mac = 20,
 205         decryption_failed = 21,
 206         record_overflow = 22,
 207         decompression_failure = 30,
 208         handshake_failure = 40,
 209         bad_certificate = 42,
 210         unsupported_certificate = 43,
 211         certificate_revoked = 44,
 212         certificate_expired = 45,
 213         certificate_unknown = 46,
 214         illegal_parameter = 47,
 215         unknown_ca = 48,
 216         access_denied = 49,
 217         decode_error = 50,
 218         decrypt_error = 51,
 219         export_restriction = 60,
 220         protocol_version = 70,
 221         insufficient_security = 71,
 222         internal_error = 80,
 223         user_canceled = 90,
 224         no_renegotiation = 100
 225 };
 226
 227 enum HandshakeType {
 228         hello_request = 0,
 229         client_hello = 1,
 230         server_hello = 2,
 231         certificate = 11,
 232         server_key_exchange  = 12,
 233         certificate_request = 13,
 234         server_hello_done = 14,
 235         certificate_verify = 15,
 236         client_key_exchange = 16,
 237         handshake_finished = 20
 238 };
 239
 240
 241 /*
 242  * From rfc
 243    Flags
 244
 245       0 1 2 3 4 5 6 7 8
 246       +-+-+-+-+-+-+-+-+
 247       |L M S R R R R R|
 248       +-+-+-+-+-+-+-+-+
 249
 250       L = Length included
 251       M = More fragments
 252       S = EAP-TLS start
 253       R = Reserved
 254
 255       The L bit (length included) is set to indicate the presence of the
 256       four octet TLS Message Length field, and MUST be set for the first
 257       fragment of a fragmented TLS message or set of messages. The M bit
 258       (more fragments) is set on all but the last fragment. The S bit
 259       (EAP-TLS start) is set in an EAP-TLS Start message.  This
 260       differentiates the EAP-TLS Start message from a fragment
 261       acknowledgement.
 262
 263    TLS Message Length
 264
 265       The TLS Message Length field is four octets, and is present only
 266       if the L bit is set. This field provides the total length of the
 267       TLS message or set of messages that is being fragmented.
 268
 269    TLS data
 270
 271       The TLS data consists of the encapsulated TLS packet in TLS record
 272       format.
 273  *
 274  * The data structures present here
 275  * maps only to the typedata in the EAP packet
 276  *
 277  * Based on the L bit flag, first 4 bytes of data indicate the length
 278  */
 279
 280 /* Callbacks */
 281 int             cbtls_password(char *buf, int num, int rwflag, void *userdata);
 282 void            cbtls_info(SSL const *s, int where, int ret);
 283 void            cbtls_msg(int write_p, int msg_version, int content_type, void const *buf, size_t len, SSL *ssl,
 284                           void *arg);
 285 int             cbtls_verify(int ok, X509_STORE_CTX *ctx);
 286
 287 /* TLS */
 288 void            tls_global_init(void);
 289 #ifdef ENABLE_OPENSSL_VERSION_CHECK
 290 int             tls_global_version_check(char const *acknowledged);
 291 #endif
 292 void            tls_global_cleanup(void);
 293 tls_session_t   *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert);
 294 tls_session_t   *tls_new_client_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, int fd);
 295 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs);
 296 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs);
 297 SSL_CTX         *tls_init_ctx(fr_tls_server_conf_t *conf, int client);
 298 int             tls_handshake_recv(REQUEST *, tls_session_t *ssn);
 299 int             tls_handshake_send(REQUEST *, tls_session_t *ssn);
 300 void            tls_session_information(tls_session_t *ssn);
 301
 302 /*
 303  *      Low-level TLS stuff
 304  */
 305 int tls_success(tls_session_t *ssn, REQUEST *request);
 306 void tls_fail(tls_session_t *ssn);
 307 fr_tls_status_t tls_ack_handler(tls_session_t *tls_session, REQUEST *request);
 308 fr_tls_status_t tls_application_data(tls_session_t *ssn, REQUEST *request);
 309
 310 #define FR_TLS_EX_INDEX_HANDLER  (10)
 311 #define FR_TLS_EX_INDEX_CONF     (11)
 312 #define FR_TLS_EX_INDEX_REQUEST  (12)
 313 #define FR_TLS_EX_INDEX_IDENTITY (13)
 314 #define FR_TLS_EX_INDEX_STORE    (14)
 315 #define FR_TLS_EX_INDEX_SSN      (15)
 316 #define FR_TLS_EX_INDEX_TALLOC   (16)
 317
 318 extern int fr_tls_ex_index_certs;
 319 extern int fr_tls_ex_index_vps;
 320
 321 /* configured values goes right here */
 322 struct fr_tls_server_conf_t {
 323         SSL_CTX         *ctx;
 324         CONF_SECTION    *cs;
 325
 326         char const      *private_key_password;
 327         char const      *private_key_file;
 328         char const      *certificate_file;
 329         char const      *random_file;
 330         char const      *ca_path;
 331         char const      *ca_file;
 332         char const      *dh_file;
 333         char const      *rsa_file;
 334         bool            rsa_key;
 335         bool            dh_key;
 336         uint32_t        rsa_key_length;
 337         uint32_t        dh_key_length;
 338         uint32_t        verify_depth;
 339         bool            file_type;
 340         bool            include_length;
 341         bool            disable_tlsv1;
 342         bool            disable_tlsv1_1;
 343         bool            disable_tlsv1_2;
 344
 345         /*
 346          *      Always < 4096 (due to radius limit), 0 by default = 2048
 347          */
 348         uint32_t        fragment_size;
 349         bool            check_crl;
 350         bool            check_all_crl;
 351         bool            allow_expired_crl;
 352         char const      *check_cert_cn;
 353         char const      *cipher_list;
 354         char const      *check_cert_issuer;
 355
 356         bool            session_cache_enable;
 357         uint32_t        session_timeout;
 358         uint32_t        session_cache_size;
 359         char const      *session_id_name;
 360         char const      *session_cache_path;
 361         char            session_context_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
 362         time_t          session_last_flushed;
 363
 364         char const      *verify_tmp_dir;
 365         char const      *verify_client_cert_cmd;
 366         bool            require_client_cert;
 367
 368 #ifdef HAVE_OPENSSL_OCSP_H
 369         /*
 370          * OCSP Configuration
 371          */
 372         bool            ocsp_enable;
 373         bool            ocsp_override_url;
 374         char const      *ocsp_url;
 375         bool            ocsp_use_nonce;
 376         X509_STORE      *ocsp_store;
 377         uint32_t        ocsp_timeout;
 378         bool            ocsp_softfail;
 379 #endif
 380
 381 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
 382 #ifndef OPENSSL_NO_ECDH
 383         char const      *ecdh_curve;
 384 #endif
 385 #endif
 386
 387 #ifdef PSK_MAX_IDENTITY_LEN
 388         char const      *psk_identity;
 389         char const      *psk_password;
 390         char const      *psk_query;
 391 #endif
 392
 393 };
 394
 395 #ifdef __cplusplus
 396 }
 397 #endif
 398
 399 #endif  /* WITH_TLS */
 400 #endif /* FR_TLS_H */