tls.h

Go to the documentation of this file.

/*
 * SSL/TLS interface definition
 * Copyright (c) 2004-2010, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef TLS_H
#define TLS_H

struct tls_connection;

struct tls_keys {
        const u8 *master_key; /* TLS master secret */
        size_t master_key_len;
        const u8 *client_random;
        size_t client_random_len;
        const u8 *server_random;
        size_t server_random_len;
        const u8 *inner_secret; /* TLS/IA inner secret */
        size_t inner_secret_len;
};

enum tls_event {
        TLS_CERT_CHAIN_FAILURE,
        TLS_PEER_CERTIFICATE
};

/*
 * Note: These are used as identifier with external programs and as such, the
 * values must not be changed.
 */
enum tls_fail_reason {
        TLS_FAIL_UNSPECIFIED = 0,
        TLS_FAIL_UNTRUSTED = 1,
        TLS_FAIL_REVOKED = 2,
        TLS_FAIL_NOT_YET_VALID = 3,
        TLS_FAIL_EXPIRED = 4,
        TLS_FAIL_SUBJECT_MISMATCH = 5,
        TLS_FAIL_ALTSUBJECT_MISMATCH = 6,
        TLS_FAIL_BAD_CERTIFICATE = 7,
        TLS_FAIL_SERVER_CHAIN_PROBE = 8
};

union tls_event_data {
        struct {
                int depth;
                const char *subject;
                enum tls_fail_reason reason;
                const char *reason_txt;
                const struct wpabuf *cert;
        } cert_fail;

        struct {
                int depth;
                const char *subject;
                const struct wpabuf *cert;
                const u8 *hash;
                size_t hash_len;
        } peer_cert;
};

struct tls_config {
        const char *opensc_engine_path;
        const char *pkcs11_engine_path;
        const char *pkcs11_module_path;
        int fips_mode;

        void (*event_cb)(void *ctx, enum tls_event ev,
                         union tls_event_data *data);
        void *cb_ctx;
};

#define TLS_CONN_ALLOW_SIGN_RSA_MD5 BIT(0)
#define TLS_CONN_DISABLE_TIME_CHECKS BIT(1)

struct tls_connection_params {
        const char *ca_cert;
        const u8 *ca_cert_blob;
        size_t ca_cert_blob_len;
        const char *ca_path;
        const char *subject_match;
        const char *altsubject_match;
        const char *client_cert;
        const u8 *client_cert_blob;
        size_t client_cert_blob_len;
        const char *private_key;
        const u8 *private_key_blob;
        size_t private_key_blob_len;
        const char *private_key_passwd;
        const char *dh_file;
        const u8 *dh_blob;
        size_t dh_blob_len;
        int tls_ia;

        /* OpenSSL specific variables */
        int engine;
        const char *engine_id;
        const char *pin;
        const char *key_id;
        const char *cert_id;
        const char *ca_cert_id;

        unsigned int flags;
};


void * tls_init(const struct tls_config *conf);

void tls_deinit(void *tls_ctx);

int tls_get_errors(void *tls_ctx);

struct tls_connection * tls_connection_init(void *tls_ctx);

void tls_connection_deinit(void *tls_ctx, struct tls_connection *conn);

int tls_connection_established(void *tls_ctx, struct tls_connection *conn);

int tls_connection_shutdown(void *tls_ctx, struct tls_connection *conn);

enum {
        TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED = -3,
        TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED = -2
};

int __must_check
tls_connection_set_params(void *tls_ctx, struct tls_connection *conn,
                          const struct tls_connection_params *params);

int __must_check tls_global_set_params(
        void *tls_ctx, const struct tls_connection_params *params);

int __must_check tls_global_set_verify(void *tls_ctx, int check_crl);

int __must_check tls_connection_set_verify(void *tls_ctx,
                                           struct tls_connection *conn,
                                           int verify_peer);

int __must_check tls_connection_set_ia(void *tls_ctx,
                                       struct tls_connection *conn,
                                       int tls_ia);

int __must_check tls_connection_get_keys(void *tls_ctx,
                                         struct tls_connection *conn,
                                         struct tls_keys *keys);

int __must_check  tls_connection_prf(void *tls_ctx,
                                     struct tls_connection *conn,
                                     const char *label,
                                     int server_random_first,
                                     u8 *out, size_t out_len);

struct wpabuf * tls_connection_handshake(void *tls_ctx,
                                         struct tls_connection *conn,
                                         const struct wpabuf *in_data,
                                         struct wpabuf **appl_data);

struct wpabuf * tls_connection_server_handshake(void *tls_ctx,
                                                struct tls_connection *conn,
                                                const struct wpabuf *in_data,
                                                struct wpabuf **appl_data);

struct wpabuf * tls_connection_encrypt(void *tls_ctx,
                                       struct tls_connection *conn,
                                       const struct wpabuf *in_data);

struct wpabuf * tls_connection_decrypt(void *tls_ctx,
                                       struct tls_connection *conn,
                                       const struct wpabuf *in_data);

int tls_connection_resumed(void *tls_ctx, struct tls_connection *conn);

enum {
        TLS_CIPHER_NONE,
        TLS_CIPHER_RC4_SHA /* 0x0005 */,
        TLS_CIPHER_AES128_SHA /* 0x002f */,
        TLS_CIPHER_RSA_DHE_AES128_SHA /* 0x0031 */,
        TLS_CIPHER_ANON_DH_AES128_SHA /* 0x0034 */
};

int __must_check tls_connection_set_cipher_list(void *tls_ctx,
                                                struct tls_connection *conn,
                                                u8 *ciphers);

int __must_check tls_get_cipher(void *tls_ctx, struct tls_connection *conn,
                                char *buf, size_t buflen);

int __must_check tls_connection_enable_workaround(void *tls_ctx,
                                                  struct tls_connection *conn);

int __must_check tls_connection_client_hello_ext(void *tls_ctx,
                                                 struct tls_connection *conn,
                                                 int ext_type, const u8 *data,
                                                 size_t data_len);

int tls_connection_get_failed(void *tls_ctx, struct tls_connection *conn);

int tls_connection_get_read_alerts(void *tls_ctx, struct tls_connection *conn);

int tls_connection_get_write_alerts(void *tls_ctx,
                                    struct tls_connection *conn);

int tls_connection_get_keyblock_size(void *tls_ctx,
                                     struct tls_connection *conn);

#define TLS_CAPABILITY_IA 0x0001 /* TLS Inner Application (TLS/IA) */

unsigned int tls_capabilities(void *tls_ctx);

struct wpabuf * tls_connection_ia_send_phase_finished(
        void *tls_ctx, struct tls_connection *conn, int final);

int __must_check tls_connection_ia_final_phase_finished(
        void *tls_ctx, struct tls_connection *conn);

int __must_check tls_connection_ia_permute_inner_secret(
        void *tls_ctx, struct tls_connection *conn,
        const u8 *key, size_t key_len);

typedef int (*tls_session_ticket_cb)
(void *ctx, const u8 *ticket, size_t len, const u8 *client_random,
 const u8 *server_random, u8 *master_secret);

int __must_check  tls_connection_set_session_ticket_cb(
        void *tls_ctx, struct tls_connection *conn,
        tls_session_ticket_cb cb, void *ctx);

#endif /* TLS_H */