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
  69 #define MAX_RECORD_SIZE 16384
  70
  71 /*
  72  *      A single TLS record may be up to 16384 octets in length, but a
  73  *      TLS message may span multiple TLS records, and a TLS
  74  *      certificate message may in principle be as long as 16MB.
  75  *
  76  *      However, note that in order to protect against reassembly
  77  *      lockup and denial of service attacks, it may be desirable for
  78  *      an implementation to set a maximum size for one such group of
  79  *      TLS messages.
  80  *
  81  *      The TLS Message Length field is four octets, and provides the
  82  *      total length of the TLS message or set of messages that is
  83  *      being fragmented; this simplifies buffer allocation.
  84  */
  85
  86 /*
  87  * FIXME: Dynamic allocation of buffer to overcome MAX_RECORD_SIZE overflows.
  88  *      or configure TLS not to exceed MAX_RECORD_SIZE.
  89  */
  90 typedef struct _record_t {
  91         unsigned char data[MAX_RECORD_SIZE];
  92         unsigned int  used;
  93 } record_t;
  94
  95 typedef struct _tls_info_t {
  96         unsigned char   origin;
  97         unsigned char   content_type;
  98         unsigned char   handshake_type;
  99         unsigned char   alert_level;
 100         unsigned char   alert_description;
 101         char            info_description[256];
 102         size_t          record_len;
 103         int             version;
 104         char            initialized;
 105 } tls_info_t;
 106
 107 /*
 108  * tls_session_t Structure gets stored as opaque in eap_handler_t
 109  * This contains EAP-REQUEST specific data
 110  * (ie FR_TLS_DATA(fragment), EAPTLS-ALERT, EAPTLS-REQUEST ...)
 111  *
 112  * clean_in  - data that needs to be sent but only after it is soiled.
 113  * dirty_in  - data EAP server receives.
 114  * clean_out - data that is cleaned after receiving.
 115  * dirty_out - data EAP server sends.
 116  * offset    - current fragment size transmitted
 117  * fragment  - Flag, In fragment mode or not.
 118  * tls_msg_len - Actual/Total TLS message length.
 119  * length_flag - A flag to include length in every TLS Data/Alert packet
 120  *                                      if set to no then only the first fragment contains length
 121  */
 122 typedef struct _tls_session_t {
 123         SSL_CTX         *ctx;
 124         SSL             *ssl;
 125         tls_info_t      info;
 126
 127         BIO             *into_ssl;
 128         BIO             *from_ssl;
 129         record_t        clean_in;
 130         record_t        clean_out;
 131         record_t        dirty_in;
 132         record_t        dirty_out;
 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,
 137                                        unsigned int size);
 138         unsigned int    (*record_minus)(record_t *buf, void *ptr,
 139                                         unsigned int size);
 140
 141         bool            invalid_hb_used;
 142
 143         /*
 144          * Framed-MTU attribute in RADIUS,
 145          * if present, can also be used to set this
 146          */
 147         unsigned int    offset;
 148         unsigned int    tls_msg_len;
 149         int             fragment;
 150         int             length_flag;
 151         int             peap_flag;
 152
 153         /*
 154          *      Used by TTLS & PEAP to keep track of other per-session
 155          *      data.
 156          */
 157         void            *opaque;
 158         void            (*free_opaque)(void *opaque);
 159
 160         char const      *prf_label;
 161         int             allow_session_resumption;
 162 } tls_session_t;
 163
 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         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 int             tls_global_version_check(char const *acknowledged);
 299 void            tls_global_cleanup(void);
 300 tls_session_t   *tls_new_session(TALLOC_CTX *ctx, fr_tls_server_conf_t *conf, REQUEST *request, bool client_cert);
 301 tls_session_t   *tls_new_client_session(fr_tls_server_conf_t *conf, int fd);
 302 fr_tls_server_conf_t *tls_server_conf_parse(CONF_SECTION *cs);
 303 fr_tls_server_conf_t *tls_client_conf_parse(CONF_SECTION *cs);
 304 int             tls_handshake_recv(REQUEST *, tls_session_t *ssn);
 305 int             tls_handshake_send(REQUEST *, tls_session_t *ssn);
 306 void            tls_session_information(tls_session_t *ssn);
 307
 308 /*
 309  *      Low-level TLS stuff
 310  */
 311 int tls_success(tls_session_t *ssn, REQUEST *request);
 312 void tls_fail(tls_session_t *ssn);
 313 fr_tls_status_t tls_ack_handler(tls_session_t *tls_session, REQUEST *request);
 314 fr_tls_status_t tls_application_data(tls_session_t *ssn, REQUEST *request);
 315
 316 /* Session */
 317 void            session_close(tls_session_t *ssn);
 318 void            session_init(tls_session_t *ssn);
 319
 320 #define FR_TLS_EX_INDEX_HANDLER  (10)
 321 #define FR_TLS_EX_INDEX_CONF     (11)
 322 #define FR_TLS_EX_INDEX_REQUEST  (12)
 323 #define FR_TLS_EX_INDEX_IDENTITY (13)
 324 #define FR_TLS_EX_INDEX_STORE    (14)
 325 #define FR_TLS_EX_INDEX_SSN      (15)
 326 #define FR_TLS_EX_INDEX_TALLOC   (16)
 327
 328 extern int FR_TLS_EX_INDEX_CERTS;
 329
 330 /* configured values goes right here */
 331 struct fr_tls_server_conf_t {
 332         SSL_CTX         *ctx;
 333         CONF_SECTION    *cs;
 334
 335         char const      *private_key_password;
 336         char const      *private_key_file;
 337         char const      *certificate_file;
 338         char const      *random_file;
 339         char const      *ca_path;
 340         char const      *ca_file;
 341         char const      *dh_file;
 342         char const      *rsa_file;
 343         bool            rsa_key;
 344         bool            dh_key;
 345         uint32_t        rsa_key_length;
 346         uint32_t        dh_key_length;
 347         uint32_t        verify_depth;
 348         bool            file_type;
 349         bool            include_length;
 350
 351         /*
 352          *      Always < 4096 (due to radius limit), 0 by default = 2048
 353          */
 354         uint32_t        fragment_size;
 355         bool            check_crl;
 356         bool            allow_expired_crl;
 357         char const      *check_cert_cn;
 358         char const      *cipher_list;
 359         char const      *check_cert_issuer;
 360
 361         bool            session_cache_enable;
 362         uint32_t        session_timeout;
 363         uint32_t        session_cache_size;
 364         char const      *session_id_name;
 365         char const      *session_cache_path;
 366         char            session_context_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
 367         time_t          session_last_flushed;
 368
 369         char const      *verify_tmp_dir;
 370         char const      *verify_client_cert_cmd;
 371         bool            require_client_cert;
 372
 373 #ifdef HAVE_OPENSSL_OCSP_H
 374         /*
 375          * OCSP Configuration
 376          */
 377         bool            ocsp_enable;
 378         bool            ocsp_override_url;
 379         char const      *ocsp_url;
 380         bool            ocsp_use_nonce;
 381         X509_STORE      *ocsp_store;
 382         uint32_t        ocsp_timeout;
 383         bool            ocsp_softfail;
 384 #endif
 385
 386 #if OPENSSL_VERSION_NUMBER >= 0x0090800fL
 387 #ifndef OPENSSL_NO_ECDH
 388         char const      *ecdh_curve;
 389 #endif
 390 #endif
 391
 392 #ifdef PSK_MAX_IDENTITY_LEN
 393         char const      *psk_identity;
 394         char const      *psk_password;
 395 #endif
 396
 397 };
 398
 399 #ifdef __cplusplus
 400 }
 401 #endif
 402
 403 #endif  /* WITH_TLS */
 404 #endif /* FR_TLS_H */