522 lines
19 KiB
C
522 lines
19 KiB
C
/*
|
|
* WPA Supplicant / SSL/TLS interface definition
|
|
* Copyright (c) 2004-2006, 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;
|
|
};
|
|
|
|
struct tls_config {
|
|
const char *opensc_engine_path;
|
|
const char *pkcs11_engine_path;
|
|
const char *pkcs11_module_path;
|
|
};
|
|
|
|
/**
|
|
* struct tls_connection_params - Parameters for TLS connection
|
|
* @ca_cert: File or reference name for CA X.509 certificate in PEM or DER
|
|
* format
|
|
* @ca_cert_blob: ca_cert as inlined data or %NULL if not used
|
|
* @ca_cert_blob_len: ca_cert_blob length
|
|
* @ca_path: Path to CA certificates (OpenSSL specific)
|
|
* @subject_match: String to match in the subject of the peer certificate or
|
|
* %NULL to allow all subjects
|
|
* @altsubject_match: String to match in the alternative subject of the peer
|
|
* certificate or %NULL to allow all alternative subjects
|
|
* @client_cert: File or reference name for client X.509 certificate in PEM or
|
|
* DER format
|
|
* @client_cert_blob: client_cert as inlined data or %NULL if not used
|
|
* @client_cert_blob_len: client_cert_blob length
|
|
* @private_key: File or reference name for client private key in PEM or DER
|
|
* format (traditional format (RSA PRIVATE KEY) or PKCS#8 (PRIVATE KEY)
|
|
* @private_key_blob: private_key as inlined data or %NULL if not used
|
|
* @private_key_blob_len: private_key_blob length
|
|
* @private_key_passwd: Passphrase for decrypted private key, %NULL if no
|
|
* passphrase is used.
|
|
* @dh_file: File name for DH/DSA data in PEM format, or %NULL if not used
|
|
* @dh_blob: dh_file as inlined data or %NULL if not used
|
|
* @dh_blob_len: dh_blob length
|
|
* @engine: 1 = use engine (e.g., a smartcard) for private key operations
|
|
* (this is OpenSSL specific for now)
|
|
* @engine_id: engine id string (this is OpenSSL specific for now)
|
|
* @ppin: pointer to the pin variable in the configuration
|
|
* (this is OpenSSL specific for now)
|
|
* @key_id: the private key's key id (this is OpenSSL specific for now)
|
|
* @tls_ia: Whether to enable TLS/IA (for EAP-TTLSv1)
|
|
*
|
|
* TLS connection parameters to be configured with tls_connection_set_params()
|
|
* and tls_global_set_params().
|
|
*
|
|
* Certificates and private key can be configured either as a reference name
|
|
* (file path or reference to certificate store) or by providing the same data
|
|
* as a pointer to the data in memory. Only one option will be used for each
|
|
* field.
|
|
*/
|
|
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;
|
|
};
|
|
|
|
|
|
/**
|
|
* tls_init - Initialize TLS library
|
|
* @conf: Configuration data for TLS library
|
|
* Returns: Context data to be used as tls_ctx in calls to other functions,
|
|
* or %NULL on failure.
|
|
*
|
|
* Called once during program startup and once for each RSN pre-authentication
|
|
* session. In other words, there can be two concurrent TLS contexts. If global
|
|
* library initialization is needed (i.e., one that is shared between both
|
|
* authentication types), the TLS library wrapper should maintain a reference
|
|
* counter and do global initialization only when moving from 0 to 1 reference.
|
|
*/
|
|
void * tls_init(const struct tls_config *conf);
|
|
|
|
/**
|
|
* tls_deinit - Deinitialize TLS library
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
*
|
|
* Called once during program shutdown and once for each RSN pre-authentication
|
|
* session. If global library deinitialization is needed (i.e., one that is
|
|
* shared between both authentication types), the TLS library wrapper should
|
|
* maintain a reference counter and do global deinitialization only when moving
|
|
* from 1 to 0 references.
|
|
*/
|
|
void tls_deinit(void *tls_ctx);
|
|
|
|
/**
|
|
* tls_get_errors - Process pending errors
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* Returns: Number of found error, 0 if no errors detected.
|
|
*
|
|
* Process all pending TLS errors.
|
|
*/
|
|
int tls_get_errors(void *tls_ctx);
|
|
|
|
/**
|
|
* tls_connection_init - Initialize a new TLS connection
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* Returns: Connection context data, conn for other function calls
|
|
*/
|
|
struct tls_connection * tls_connection_init(void *tls_ctx);
|
|
|
|
/**
|
|
* tls_connection_deinit - Free TLS connection data
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
*
|
|
* Release all resources allocated for TLS connection.
|
|
*/
|
|
void tls_connection_deinit(void *tls_ctx, struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_established - Has the TLS connection been completed?
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: 1 if TLS connection has been completed, 0 if not.
|
|
*/
|
|
int tls_connection_established(void *tls_ctx, struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_shutdown - Shutdown TLS connection
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* Shutdown current TLS connection without releasing all resources. New
|
|
* connection can be started by using the same conn without having to call
|
|
* tls_connection_init() or setting certificates etc. again. The new
|
|
* connection should try to use session resumption.
|
|
*/
|
|
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
|
|
};
|
|
|
|
/**
|
|
* tls_connection_set_params - Set TLS connection parameters
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @params: Connection parameters
|
|
* Returns: 0 on success, -1 on failure,
|
|
* TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing
|
|
* PKCS#11 engine failure, or
|
|
* TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the
|
|
* PKCS#11 engine private key.
|
|
*/
|
|
int tls_connection_set_params(void *tls_ctx, struct tls_connection *conn,
|
|
const struct tls_connection_params *params);
|
|
|
|
/**
|
|
* tls_global_set_params - Set TLS parameters for all TLS connection
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @params: Global TLS parameters
|
|
* Returns: 0 on success, -1 on failure,
|
|
* TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing
|
|
* PKCS#11 engine failure, or
|
|
* TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the
|
|
* PKCS#11 engine private key.
|
|
*/
|
|
int tls_global_set_params(void *tls_ctx,
|
|
const struct tls_connection_params *params);
|
|
|
|
/**
|
|
* tls_global_set_verify - Set global certificate verification options
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @check_crl: 0 = do not verify CRLs, 1 = verify CRL for the user certificate,
|
|
* 2 = verify CRL for all certificates
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_global_set_verify(void *tls_ctx, int check_crl);
|
|
|
|
/**
|
|
* tls_connection_set_verify - Set certificate verification options
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @verify_peer: 1 = verify peer certificate
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_set_verify(void *tls_ctx, struct tls_connection *conn,
|
|
int verify_peer);
|
|
|
|
/**
|
|
* tls_connection_set_ia - Set TLS/IA parameters
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @tls_ia: 1 = enable TLS/IA
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* This function is used to configure TLS/IA in server mode where
|
|
* tls_connection_set_params() is not used.
|
|
*/
|
|
int tls_connection_set_ia(void *tls_ctx, struct tls_connection *conn,
|
|
int tls_ia);
|
|
|
|
/**
|
|
* tls_connection_get_keys - Get master key and random data from TLS connection
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @keys: Structure of key/random data (filled on success)
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_get_keys(void *tls_ctx, struct tls_connection *conn,
|
|
struct tls_keys *keys);
|
|
|
|
/**
|
|
* tls_connection_prf - Use TLS-PRF to derive keying material
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @label: Label (e.g., description of the key) for PRF
|
|
* @server_random_first: seed is 0 = client_random|server_random,
|
|
* 1 = server_random|client_random
|
|
* @out: Buffer for output data from TLS-PRF
|
|
* @out_len: Length of the output buffer
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* This function is optional to implement if tls_connection_get_keys() provides
|
|
* access to master secret and server/client random values. If these values are
|
|
* not exported from the TLS library, tls_connection_prf() is required so that
|
|
* further keying material can be derived from the master secret. If not
|
|
* implemented, the function will still need to be defined, but it can just
|
|
* return -1. Example implementation of this function is in tls_prf() function
|
|
* when it is called with seed set to client_random|server_random (or
|
|
* server_random|client_random).
|
|
*/
|
|
int tls_connection_prf(void *tls_ctx, struct tls_connection *conn,
|
|
const char *label, int server_random_first,
|
|
u8 *out, size_t out_len);
|
|
|
|
/**
|
|
* tls_connection_handshake - Process TLS handshake (client side)
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @in_data: Input data from TLS peer
|
|
* @in_len: Input data length
|
|
* @out_len: Length of the output buffer.
|
|
* @appl_data: Pointer to application data pointer, or %NULL if dropped
|
|
* @appl_data_len: Pointer to variable that is set to appl_data length
|
|
* Returns: Pointer to output data, %NULL on failure
|
|
*
|
|
* Caller is responsible for freeing returned output data. If the final
|
|
* handshake message includes application data, this is decrypted and
|
|
* appl_data (if not %NULL) is set to point this data. Caller is responsible
|
|
* for freeing appl_data.
|
|
*
|
|
* This function is used during TLS handshake. The first call is done with
|
|
* in_data == %NULL and the library is expected to return ClientHello packet.
|
|
* This packet is then send to the server and a response from server is given
|
|
* to TLS library by calling this function again with in_data pointing to the
|
|
* TLS message from the server.
|
|
*
|
|
* If the TLS handshake fails, this function may return %NULL. However, if the
|
|
* TLS library has a TLS alert to send out, that should be returned as the
|
|
* output data. In this case, tls_connection_get_failed() must return failure
|
|
* (> 0).
|
|
*
|
|
* tls_connection_established() should return 1 once the TLS handshake has been
|
|
* completed successfully.
|
|
*/
|
|
u8 * tls_connection_handshake(void *tls_ctx, struct tls_connection *conn,
|
|
const u8 *in_data, size_t in_len,
|
|
size_t *out_len, u8 **appl_data,
|
|
size_t *appl_data_len);
|
|
|
|
/**
|
|
* tls_connection_server_handshake - Process TLS handshake (server side)
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @in_data: Input data from TLS peer
|
|
* @in_len: Input data length
|
|
* @out_len: Length of the output buffer.
|
|
* Returns: pointer to output data, %NULL on failure
|
|
*
|
|
* Caller is responsible for freeing returned output data.
|
|
*/
|
|
u8 * tls_connection_server_handshake(void *tls_ctx,
|
|
struct tls_connection *conn,
|
|
const u8 *in_data, size_t in_len,
|
|
size_t *out_len);
|
|
|
|
/**
|
|
* tls_connection_encrypt - Encrypt data into TLS tunnel
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @in_data: Pointer to plaintext data to be encrypted
|
|
* @in_len: Input buffer length
|
|
* @out_data: Pointer to output buffer (encrypted TLS data)
|
|
* @out_len: Maximum out_data length
|
|
* Returns: Number of bytes written to out_data, -1 on failure
|
|
*
|
|
* This function is used after TLS handshake has been completed successfully to
|
|
* send data in the encrypted tunnel.
|
|
*/
|
|
int tls_connection_encrypt(void *tls_ctx, struct tls_connection *conn,
|
|
const u8 *in_data, size_t in_len,
|
|
u8 *out_data, size_t out_len);
|
|
|
|
/**
|
|
* tls_connection_decrypt - Decrypt data from TLS tunnel
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @in_data: Pointer to input buffer (encrypted TLS data)
|
|
* @in_len: Input buffer length
|
|
* @out_data: Pointer to output buffer (decrypted data from TLS tunnel)
|
|
* @out_len: Maximum out_data length
|
|
* Returns: Number of bytes written to out_data, -1 on failure
|
|
*
|
|
* This function is used after TLS handshake has been completed successfully to
|
|
* receive data from the encrypted tunnel.
|
|
*/
|
|
int tls_connection_decrypt(void *tls_ctx, struct tls_connection *conn,
|
|
const u8 *in_data, size_t in_len,
|
|
u8 *out_data, size_t out_len);
|
|
|
|
/**
|
|
* tls_connection_resumed - Was session resumption used
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: 1 if current session used session resumption, 0 if not
|
|
*/
|
|
int tls_connection_resumed(void *tls_ctx, struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_set_master_key - Configure master secret for TLS connection
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @key: TLS pre-master-secret
|
|
* @key_len: length of key in bytes
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_set_master_key(void *tls_ctx, struct tls_connection *conn,
|
|
const u8 *key, size_t key_len);
|
|
|
|
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 */
|
|
};
|
|
|
|
/**
|
|
* tls_connection_set_cipher_list - Configure acceptable cipher suites
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @ciphers: Zero (TLS_CIPHER_NONE) terminated list of allowed ciphers
|
|
* (TLS_CIPHER_*).
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_set_cipher_list(void *tls_ctx, struct tls_connection *conn,
|
|
u8 *ciphers);
|
|
|
|
/**
|
|
* tls_get_cipher - Get current cipher name
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @buf: Buffer for the cipher name
|
|
* @buflen: buf size
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* Get the name of the currently used cipher.
|
|
*/
|
|
int tls_get_cipher(void *tls_ctx, struct tls_connection *conn,
|
|
char *buf, size_t buflen);
|
|
|
|
/**
|
|
* tls_connection_enable_workaround - Enable TLS workaround options
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: 0 on success, -1 on failure
|
|
*
|
|
* This function is used to enable connection-specific workaround options for
|
|
* buffer SSL/TLS implementations.
|
|
*/
|
|
int tls_connection_enable_workaround(void *tls_ctx,
|
|
struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_client_hello_ext - Set TLS extension for ClientHello
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @ext_type: Extension type
|
|
* @data: Extension payload (%NULL to remove extension)
|
|
* @data_len: Extension payload length
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_client_hello_ext(void *tls_ctx, struct tls_connection *conn,
|
|
int ext_type, const u8 *data,
|
|
size_t data_len);
|
|
|
|
/**
|
|
* tls_connection_get_failed - Get connection failure status
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
*
|
|
* Returns >0 if connection has failed, 0 if not.
|
|
*/
|
|
int tls_connection_get_failed(void *tls_ctx, struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_get_read_alerts - Get connection read alert status
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: Number of times a fatal read (remote end reported error) has
|
|
* happened during this connection.
|
|
*/
|
|
int tls_connection_get_read_alerts(void *tls_ctx, struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_get_write_alerts - Get connection write alert status
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: Number of times a fatal write (locally detected error) has happened
|
|
* during this connection.
|
|
*/
|
|
int tls_connection_get_write_alerts(void *tls_ctx,
|
|
struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_get_keyblock_size - Get TLS key_block size
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: Size of the key_block for the negotiated cipher suite or -1 on
|
|
* failure
|
|
*/
|
|
int tls_connection_get_keyblock_size(void *tls_ctx,
|
|
struct tls_connection *conn);
|
|
|
|
#define TLS_CAPABILITY_IA 0x0001 /* TLS Inner Application (TLS/IA) */
|
|
/**
|
|
* tls_capabilities - Get supported TLS capabilities
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* Returns: Bit field of supported TLS capabilities (TLS_CAPABILITY_*)
|
|
*/
|
|
unsigned int tls_capabilities(void *tls_ctx);
|
|
|
|
/**
|
|
* tls_connection_ia_send_phase_finished - Send a TLS/IA PhaseFinished message
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @final: 1 = FinalPhaseFinished, 0 = IntermediatePhaseFinished
|
|
* @out_data: Pointer to output buffer (encrypted TLS/IA data)
|
|
* @out_len: Maximum out_data length
|
|
* Returns: Number of bytes written to out_data on success, -1 on failure
|
|
*
|
|
* This function is used to send the TLS/IA end phase message, e.g., when the
|
|
* EAP server completes EAP-TTLSv1.
|
|
*/
|
|
int tls_connection_ia_send_phase_finished(void *tls_ctx,
|
|
struct tls_connection *conn,
|
|
int final,
|
|
u8 *out_data, size_t out_len);
|
|
|
|
/**
|
|
* tls_connection_ia_final_phase_finished - Has final phase been completed
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* Returns: 1 if valid FinalPhaseFinished has been received, 0 if not, or -1
|
|
* on failure
|
|
*/
|
|
int tls_connection_ia_final_phase_finished(void *tls_ctx,
|
|
struct tls_connection *conn);
|
|
|
|
/**
|
|
* tls_connection_ia_permute_inner_secret - Permute TLS/IA inner secret
|
|
* @tls_ctx: TLS context data from tls_init()
|
|
* @conn: Connection context data from tls_connection_init()
|
|
* @key: Session key material (session_key vectors with 2-octet length), or
|
|
* %NULL if no session key was generating in the current phase
|
|
* @key_len: Length of session key material
|
|
* Returns: 0 on success, -1 on failure
|
|
*/
|
|
int tls_connection_ia_permute_inner_secret(void *tls_ctx,
|
|
struct tls_connection *conn,
|
|
const u8 *key, size_t key_len);
|
|
|
|
#endif /* TLS_H */
|