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 #if OPENSSL_VERSION_NUMBER < 0x10001000L
 110 #define ssl_session ssl->session
 111 #else
 112 #define ssl_session session
 113 #endif
 114
 115 /** Contains EAP-REQUEST specific data (ie FR_TLS_DATA(fragment), EAPTLS-ALERT, EAPTLS-REQUEST ...)
 116  *
 117  * The tls_session_t Structure gets stored as opaque in eap_handler_t
 118  */
 119 typedef struct _tls_session_t {
 120         SSL_CTX         *ctx;
 121         SSL             *ssl;
 122 #if OPENSSL_VERSION_NUMBER >= 0x10001000L
 123         SSL_SESSION     *session;
 124 #endif
 125         tls_info_t      info;
 126
 127         BIO             *into_ssl;
 128         BIO             *from_ssl;
 129         record_t        clean_in;                       //!< Data that needs to be sent but only after it is soiled.
 130         record_t        clean_out;                      //!< Data that is cleaned after receiving.
 131         record_t        dirty_in;                       //!< Data EAP server receives.
 132         record_t        dirty_out;                      //!< Data EAP server sends.
 133
 134         void            (*record_init)(record_t *buf);
 135         void            (*record_close)(record_t *buf);
 136         unsigned int    (*record_plus)(record_t *buf, void const *ptr, unsigned int size);
 137         unsigned int    (*record_minus)(record_t *buf, void *ptr, unsigned int size);
 138
 139         bool            invalid_hb_used;                //!< Whether heartbleed attack was detected.
 140
 141         /*
 142          *      Framed-MTU attribute in RADIUS, if present, can also be used to set this
 143          */
 144         size_t          mtu;                            //!< Current fragment size transmitted.
 145         size_t          tls_msg_len;                    //!< Actual/Total TLS message length.
 146         bool            fragment;                       //!< Flag, In fragment mode or not.
 147         bool            length_flag;                    //!< A flag to include length in every TLS Data/Alert packet.
 148                                                         //!< If set to no then only the first fragment contains length.
 149         int             peap_flag;
 150
 151         size_t          tls_record_in_total_len;        //!< How long the peer indicated the complete tls record
 152                                                         //!< would be.
 153         size_t          tls_record_in_recvd_len;        //!< How much of the record we've received so far.
 154
 155         /*
 156          *      Used by TTLS & PEAP to keep track of other per-session data.
 157          */
 158         void            *opaque;
 159         void            (*free_opaque)(void *opaque);
 160
 161         char const      *prf_label;
 162         bool            allow_session_resumption;       //!< Whether session resumption is allowed.
 163 } tls_session_t;
 164
 165 /*
 166  *      RFC 2716, Section 4.2:
 167  *
 168  *         Flags
 169  *
 170  *      0 1 2 3 4 5 6 7 8
 171  *      +-+-+-+-+-+-+-+-+
 172  *      |L M S R R R R R|
 173  *      +-+-+-+-+-+-+-+-+
 174  *
 175  *      L = Length included
 176  *      M = More fragments
 177  *      S = EAP-TLS start
 178  *      R = Reserved
 179  */
 180 #define TLS_START(x)            (((x) & 0x20) != 0)
 181 #define TLS_MORE_FRAGMENTS(x)   (((x) & 0x40) != 0)
 182 #define TLS_LENGTH_INCLUDED(x)  (((x) & 0x80) != 0)
 183
 184 #define TLS_CHANGE_CIPHER_SPEC(x)       (((x) & 0x0014) == 0x0014)
 185 #define TLS_ALERT(x)                    (((x) & 0x0015) == 0x0015)
 186 #define TLS_HANDSHAKE(x)                (((x) & 0x0016) == 0x0016)
 187
 188 #define SET_START(x)            ((x) | (0x20))
 189 #define SET_MORE_FRAGMENTS(x)   ((x) | (0x40))
 190 #define SET_LENGTH_INCLUDED(x)  ((x) | (0x80))
 191
 192 /*
 193  *      Following enums from rfc2246
 194  *
 195  *      Hmm... since we dpeend on OpenSSL, it would be smarter to
 196  *      use the OpenSSL names for these.
 197  */
 198 enum ContentType {
 199         change_cipher_spec = 20,
 200         alert = 21,
 201         handshake = 22,
 202         application_data = 23
 203 };
 204
 205 enum AlertLevel {
 206         warning = 1,
 207         fatal = 2
 208 };
 209
 210 enum AlertDescription {
 211         close_notify = 0,
 212         unexpected_message = 10,
 213         bad_record_mac = 20,
 214         decryption_failed = 21,
 215         record_overflow = 22,
 216         decompression_failure = 30,
 217         handshake_failure = 40,
 218         bad_certificate = 42,
 219         unsupported_certificate = 43,
 220         certificate_revoked = 44,
 221         certificate_expired = 45,
 222         certificate_unknown = 46,
 223         illegal_parameter = 47,
 224         unknown_ca = 48,
 225         access_denied = 49,
 226         decode_error = 50,
 227         decrypt_error = 51,
 228         export_restriction = 60,
 229         protocol_version = 70,
 230         insufficient_security = 71,
 231         internal_error = 80,
 232         user_canceled = 90,
 233         no_renegotiation = 100
 234 };
 235
 236 enum HandshakeType {
 237         hello_request = 0,
 238         client_hello = 1,
 239         server_hello = 2,
 240         certificate = 11,
 241         server_key_exchange  = 12,
 242         certificate_request = 13,
 243         server_hello_done = 14,
 244         certificate_verify = 15,
 245         client_key_exchange = 16,
 246         handshake_finished = 20
 247 };
 248
 249
 250 /*
 251  * From rfc
 252    Flags
 253
 254       0 1 2 3 4 5 6 7 8
 255       +-+-+-+-+-+-+-+-+
 256       |L M S R R R R R|
 257       +-+-+-+-+-+-+-+-+
 258
 259       L = Length included
 260       M = More fragments
 261       S = EAP-TLS start
 262       R = Reserved
 263
 264       The L bit (length included) is set to indicate the presence of the
 265       four octet TLS Message Length field, and MUST be set for the first
 266       fragment of a fragmented TLS message or set of messages. The M bit
 267       (more fragments) is set on all but the last fragment. The S bit
 268       (EAP-TLS start) is set in an EAP-TLS Start message.  This
 269       differentiates the EAP-TLS Start message from a fragment
 270       acknowledgement.
 271
 272    TLS Message Length
 273
 274       The TLS Message Length field is four octets, and is present only
 275       if the L bit is set. This field provides the total length of the
 276       TLS message or set of messages that is being fragmented.
 277
 278    TLS data
 279
 280       The TLS data consists of the encapsulated TLS packet in TLS record
 281       format.
 282  *
 283  * The data structures present here
 284  * maps only to the typedata in the EAP packet
 285  *
 286  * Based on the L bit flag, first 4 bytes of data indicate the length
 287  */
 288
 289 /* Callbacks */
 290 int             cbtls_password(char *buf, int num, int rwflag, void *userdata);
 291 void            cbtls_info(SSL const *s, int where, int ret);
 292 void            cbtls_msg(int write_p, int msg_version, int content_type, void const *buf, size_t len, SSL *ssl,
 293                           void *arg);
 294 int             cbtls_verify(int ok, X509_STORE_CTX *ctx);
 295
 296 /* TLS */
 297 void            tls_global_init(void);
 298 #ifdef ENABLE_OPENSSL_VERSION_CHECK
 299 int             tls_global_version_check(char const *acknowledged);
 300 #endif
 301
 302 int             tls_error_log(REQUEST *request, char const *msg, ...) CC_HINT(format (printf, 2, 3));
 303 int             tls_error_io_log(REQUEST *request, tls_session_t *session, int ret, char const *msg, ...)
 304                                  CC_HINT(format (printf, 4, 5));
 305
 306 void            tls_global_cleanup(void);
 307 tls_session_t   *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert);
 308 tls_session_t   *tls_new_client_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, int fd);
 309 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs);
 310 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs);
 311 fr_tls_server_conf_t *tls_server_conf_alloc(TALLOC_CTX *ctx);
 312 SSL_CTX         *tls_init_ctx(fr_tls_server_conf_t *conf, int client);
 313 int             tls_handshake_recv(REQUEST *, tls_session_t *ssn);
 314 int             tls_handshake_send(REQUEST *, tls_session_t *ssn);
 315 void            tls_session_information(tls_session_t *ssn);
 316 void            tls_session_id(SSL_SESSION *ssn, char *buffer, size_t bufsize);
 317
 318 /*
 319  *      Low-level TLS stuff
 320  */
 321 int tls_success(tls_session_t *ssn, REQUEST *request);
 322 void tls_fail(tls_session_t *ssn);
 323 fr_tls_status_t tls_ack_handler(tls_session_t *tls_session, REQUEST *request);
 324 fr_tls_status_t tls_application_data(tls_session_t *ssn, REQUEST *request);
 325
 326 #define FR_TLS_EX_INDEX_HANDLER  (10)
 327 #define FR_TLS_EX_INDEX_CONF     (11)
 328 #define FR_TLS_EX_INDEX_REQUEST  (12)
 329 #define FR_TLS_EX_INDEX_IDENTITY (13)
 330 #define FR_TLS_EX_INDEX_STORE    (14)
 331 #define FR_TLS_EX_INDEX_SSN      (15)
 332 #define FR_TLS_EX_INDEX_TALLOC   (16)
 333
 334 extern int fr_tls_ex_index_certs;
 335 extern int fr_tls_ex_index_vps;
 336
 337 /* configured values goes right here */
 338 struct fr_tls_server_conf_t {
 339         SSL_CTX         *ctx;
 340         CONF_SECTION    *cs;
 341
 342         char const      *private_key_password;
 343         char const      *private_key_file;
 344         char const      *certificate_file;
 345         char const      *random_file;
 346         char const      *ca_path;
 347         char const      *ca_file;
 348         char const      *dh_file;
 349         char const      *rsa_file;
 350         uint32_t        verify_depth;
 351         bool            file_type;
 352         bool            include_length;
 353         bool            auto_chain;
 354         bool            disable_single_dh_use;
 355         bool            disable_tlsv1;
 356         bool            disable_tlsv1_1;
 357         bool            disable_tlsv1_2;
 358
 359         /*
 360          *      Always < 4096 (due to radius limit), 0 by default = 1024
 361          */
 362         uint32_t        fragment_size;
 363         bool            check_crl;
 364         bool            check_all_crl;
 365         bool            allow_expired_crl;
 366         char const      *check_cert_cn;
 367         char const      *cipher_list;
 368         bool            cipher_server_preference;
 369         char const      *check_cert_issuer;
 370
 371         bool            session_cache_enable;
 372         uint32_t        session_timeout;
 373         uint32_t        session_cache_size;
 374         char const      *session_id_name;
 375         char const      *session_cache_path;
 376         char            session_context_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
 377         time_t          session_last_flushed;
 378
 379         bool            verify_skip_if_ocsp_ok;
 380         char const      *verify_tmp_dir;
 381         char const      *verify_client_cert_cmd;
 382         bool            require_client_cert;
 383
 384 #ifdef HAVE_OPENSSL_OCSP_H
 385         /*
 386          * OCSP Configuration
 387          */
 388         bool            ocsp_enable;
 389         bool            ocsp_override_url;
 390         char const      *ocsp_url;
 391         bool            ocsp_use_nonce;
 392         X509_STORE      *ocsp_store;
 393         uint32_t        ocsp_timeout;
 394         bool            ocsp_softfail;
 395 #endif
 396
 397 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
 398 #ifndef OPENSSL_NO_ECDH
 399         char const      *ecdh_curve;
 400 #endif
 401 #endif
 402
 403 #ifdef PSK_MAX_IDENTITY_LEN
 404         char const      *psk_identity;
 405         char const      *psk_password;
 406         char const      *psk_query;
 407 #endif
 408
 409 };
 410
 411 #ifdef __cplusplus
 412 }
 413 #endif
 414
 415 #endif  /* WITH_TLS */
 416 #endif /* FR_TLS_H */