1526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/* 2526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * WPA Supplicant / SSL/TLS interface definition 3526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi> 4526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 5526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This program is free software; you can redistribute it and/or modify 6526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * it under the terms of the GNU General Public License version 2 as 7526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * published by the Free Software Foundation. 8526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 9526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Alternatively, this software may be distributed under the terms of BSD 10526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * license. 11526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 12526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * See README and COPYING for more details. 13526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 14526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 15526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt#ifndef TLS_H 16526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt#define TLS_H 17526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 18526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtstruct tls_connection; 19526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 20526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtstruct tls_keys { 21526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *master_key; /* TLS master secret */ 22526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t master_key_len; 23526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *client_random; 24526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t client_random_len; 25526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *server_random; 26526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t server_random_len; 27526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *inner_secret; /* TLS/IA inner secret */ 28526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t inner_secret_len; 29526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt}; 30526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 31526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtstruct tls_config { 32526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *opensc_engine_path; 33526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *pkcs11_engine_path; 34526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *pkcs11_module_path; 35526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt}; 36526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 37dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt#define TLS_CONN_ALLOW_SIGN_RSA_MD5 BIT(0) 38dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt#define TLS_CONN_DISABLE_TIME_CHECKS BIT(1) 39dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt 40526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 41526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * struct tls_connection_params - Parameters for TLS connection 42526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ca_cert: File or reference name for CA X.509 certificate in PEM or DER 43526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * format 44526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ca_cert_blob: ca_cert as inlined data or %NULL if not used 45526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ca_cert_blob_len: ca_cert_blob length 46526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ca_path: Path to CA certificates (OpenSSL specific) 47526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @subject_match: String to match in the subject of the peer certificate or 48526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * %NULL to allow all subjects 49526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @altsubject_match: String to match in the alternative subject of the peer 50526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * certificate or %NULL to allow all alternative subjects 51526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @client_cert: File or reference name for client X.509 certificate in PEM or 52526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * DER format 53526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @client_cert_blob: client_cert as inlined data or %NULL if not used 54526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @client_cert_blob_len: client_cert_blob length 55526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @private_key: File or reference name for client private key in PEM or DER 56526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * format (traditional format (RSA PRIVATE KEY) or PKCS#8 (PRIVATE KEY) 57526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @private_key_blob: private_key as inlined data or %NULL if not used 58526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @private_key_blob_len: private_key_blob length 59526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @private_key_passwd: Passphrase for decrypted private key, %NULL if no 60526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * passphrase is used. 61526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @dh_file: File name for DH/DSA data in PEM format, or %NULL if not used 62526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @dh_blob: dh_file as inlined data or %NULL if not used 63526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @dh_blob_len: dh_blob length 64526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @engine: 1 = use engine (e.g., a smartcard) for private key operations 65526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * (this is OpenSSL specific for now) 66526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @engine_id: engine id string (this is OpenSSL specific for now) 67526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ppin: pointer to the pin variable in the configuration 68526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * (this is OpenSSL specific for now) 69526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @key_id: the private key's id when using engine (this is OpenSSL 70526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * specific for now) 71526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @cert_id: the certificate's id when using engine 72526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ca_cert_id: the CA certificate's id when using engine 73526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ia: Whether to enable TLS/IA (for EAP-TTLSv1) 74dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt * @flags: Parameter options (TLS_CONN_*) 75526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 76526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS connection parameters to be configured with tls_connection_set_params() 77526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * and tls_global_set_params(). 78526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 79526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Certificates and private key can be configured either as a reference name 80526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * (file path or reference to certificate store) or by providing the same data 81526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * as a pointer to the data in memory. Only one option will be used for each 82526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * field. 83526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 84526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtstruct tls_connection_params { 85526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *ca_cert; 86526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *ca_cert_blob; 87526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t ca_cert_blob_len; 88526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *ca_path; 89526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *subject_match; 90526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *altsubject_match; 91526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *client_cert; 92526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *client_cert_blob; 93526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t client_cert_blob_len; 94526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *private_key; 95526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *private_key_blob; 96526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t private_key_blob_len; 97526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *private_key_passwd; 98526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *dh_file; 99526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *dh_blob; 100526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t dh_blob_len; 101526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int tls_ia; 102526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 103526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt /* OpenSSL specific variables */ 104526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int engine; 105526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *engine_id; 106526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *pin; 107526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *key_id; 108526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *cert_id; 109526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *ca_cert_id; 110dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt 111dde787cc314cd04caa4ea5f031cc8a02495ca513Dmitry Shmidt unsigned int flags; 112526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt}; 113526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 114526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 115526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 116526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_init - Initialize TLS library 117526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conf: Configuration data for TLS library 118526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Context data to be used as tls_ctx in calls to other functions, 119526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * or %NULL on failure. 120526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 121526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Called once during program startup and once for each RSN pre-authentication 122526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * session. In other words, there can be two concurrent TLS contexts. If global 123526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * library initialization is needed (i.e., one that is shared between both 124526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * authentication types), the TLS library wrapper should maintain a reference 125526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * counter and do global initialization only when moving from 0 to 1 reference. 126526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 127526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtvoid * tls_init(const struct tls_config *conf); 128526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 129526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 130526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_deinit - Deinitialize TLS library 131526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 132526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 133526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Called once during program shutdown and once for each RSN pre-authentication 134526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * session. If global library deinitialization is needed (i.e., one that is 135526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * shared between both authentication types), the TLS library wrapper should 136526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * maintain a reference counter and do global deinitialization only when moving 137526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * from 1 to 0 references. 138526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 139526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtvoid tls_deinit(void *tls_ctx); 140526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 141526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 142526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_get_errors - Process pending errors 143526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 144526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of found error, 0 if no errors detected. 145526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 146526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Process all pending TLS errors. 147526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 148526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_get_errors(void *tls_ctx); 149526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 150526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 151526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_init - Initialize a new TLS connection 152526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 153526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Connection context data, conn for other function calls 154526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 155526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtstruct tls_connection * tls_connection_init(void *tls_ctx); 156526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 157526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 158526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_deinit - Free TLS connection data 159526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 160526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 161526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 162526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Release all resources allocated for TLS connection. 163526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 164526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtvoid tls_connection_deinit(void *tls_ctx, struct tls_connection *conn); 165526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 166526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 167526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_established - Has the TLS connection been completed? 168526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 169526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 170526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 1 if TLS connection has been completed, 0 if not. 171526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 172526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_established(void *tls_ctx, struct tls_connection *conn); 173526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 174526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 175526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_shutdown - Shutdown TLS connection 176526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 177526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 178526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 179526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 180526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Shutdown current TLS connection without releasing all resources. New 181526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * connection can be started by using the same conn without having to call 182526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_init() or setting certificates etc. again. The new 183526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * connection should try to use session resumption. 184526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 185526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_shutdown(void *tls_ctx, struct tls_connection *conn); 186526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 187526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtenum { 188526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED = -3, 189526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED = -2 190526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt}; 191526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 192526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 193526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_set_params - Set TLS connection parameters 194526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 195526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 196526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @params: Connection parameters 197526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure, 198526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing 199526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * PKCS#11 engine failure, or 200526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 201526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * PKCS#11 engine private key. 202526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 203526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check 204526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidttls_connection_set_params(void *tls_ctx, struct tls_connection *conn, 205526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const struct tls_connection_params *params); 206526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 207526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 208526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_global_set_params - Set TLS parameters for all TLS connection 209526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 210526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @params: Global TLS parameters 211526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure, 212526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing 213526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * PKCS#11 engine failure, or 214526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 215526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * PKCS#11 engine private key. 216526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 217526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_global_set_params( 218526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt void *tls_ctx, const struct tls_connection_params *params); 219526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 220526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 221526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_global_set_verify - Set global certificate verification options 222526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 223526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @check_crl: 0 = do not verify CRLs, 1 = verify CRL for the user certificate, 224526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 2 = verify CRL for all certificates 225526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 226526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 227526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_global_set_verify(void *tls_ctx, int check_crl); 228526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 229526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 230526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_set_verify - Set certificate verification options 231526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 232526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 233526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @verify_peer: 1 = verify peer certificate 234526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 235526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 236526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_set_verify(void *tls_ctx, 237526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 238526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int verify_peer); 239526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 240526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 241526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_set_ia - Set TLS/IA parameters 242526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 243526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 244526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ia: 1 = enable TLS/IA 245526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 246526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 247526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used to configure TLS/IA in server mode where 248526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_set_params() is not used. 249526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 250526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_set_ia(void *tls_ctx, 251526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 252526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int tls_ia); 253526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 254526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 255526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_get_keys - Get master key and random data from TLS connection 256526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 257526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 258526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @keys: Structure of key/random data (filled on success) 259526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 260526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 261526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_get_keys(void *tls_ctx, 262526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 263526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_keys *keys); 264526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 265526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 266526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_prf - Use TLS-PRF to derive keying material 267526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 268526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 269526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @label: Label (e.g., description of the key) for PRF 270526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @server_random_first: seed is 0 = client_random|server_random, 271526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 1 = server_random|client_random 272526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out: Buffer for output data from TLS-PRF 273526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Length of the output buffer 274526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 275526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 276526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is optional to implement if tls_connection_get_keys() provides 277526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * access to master secret and server/client random values. If these values are 278526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * not exported from the TLS library, tls_connection_prf() is required so that 279526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * further keying material can be derived from the master secret. If not 280526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * implemented, the function will still need to be defined, but it can just 281526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * return -1. Example implementation of this function is in tls_prf() function 282526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * when it is called with seed set to client_random|server_random (or 283526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * server_random|client_random). 284526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 285526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_prf(void *tls_ctx, 286526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 287526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const char *label, 288526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int server_random_first, 289526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt u8 *out, size_t out_len); 290526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 291526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 292526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_handshake - Process TLS handshake (client side) 293526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 294526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 295526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_data: Input data from TLS peer 296526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_len: Input data length 297526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Length of the output buffer. 298526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @appl_data: Pointer to application data pointer, or %NULL if dropped 299526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @appl_data_len: Pointer to variable that is set to appl_data length 300526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Pointer to output data, %NULL on failure 301526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 302526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Caller is responsible for freeing returned output data. If the final 303526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * handshake message includes application data, this is decrypted and 304526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * appl_data (if not %NULL) is set to point this data. Caller is responsible 305526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * for freeing appl_data. 306526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 307526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used during TLS handshake. The first call is done with 308526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * in_data == %NULL and the library is expected to return ClientHello packet. 309526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This packet is then send to the server and a response from server is given 310526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * to TLS library by calling this function again with in_data pointing to the 311526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS message from the server. 312526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 313526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * If the TLS handshake fails, this function may return %NULL. However, if the 314526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * TLS library has a TLS alert to send out, that should be returned as the 315526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * output data. In this case, tls_connection_get_failed() must return failure 316526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * (> 0). 317526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 318526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_established() should return 1 once the TLS handshake has been 319526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * completed successfully. 320526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 321526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtu8 * tls_connection_handshake(void *tls_ctx, struct tls_connection *conn, 322526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *in_data, size_t in_len, 323526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t *out_len, u8 **appl_data, 324526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t *appl_data_len); 325526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 326526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 327526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_server_handshake - Process TLS handshake (server side) 328526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 329526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 330526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_data: Input data from TLS peer 331526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_len: Input data length 332526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Length of the output buffer. 333526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: pointer to output data, %NULL on failure 334526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 335526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Caller is responsible for freeing returned output data. 336526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 337526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtu8 * tls_connection_server_handshake(void *tls_ctx, 338526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 339526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *in_data, size_t in_len, 340526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t *out_len); 341526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 342526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 343526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_encrypt - Encrypt data into TLS tunnel 344526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 345526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 346526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_data: Pointer to plaintext data to be encrypted 347526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_len: Input buffer length 348526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_data: Pointer to output buffer (encrypted TLS data) 349526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Maximum out_data length 350526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of bytes written to out_data, -1 on failure 351526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 352526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used after TLS handshake has been completed successfully to 353526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * send data in the encrypted tunnel. 354526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 355526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_encrypt(void *tls_ctx, 356526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 357526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *in_data, size_t in_len, 358526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt u8 *out_data, size_t out_len); 359526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 360526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 361526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_decrypt - Decrypt data from TLS tunnel 362526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 363526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 364526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_data: Pointer to input buffer (encrypted TLS data) 365526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @in_len: Input buffer length 366526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_data: Pointer to output buffer (decrypted data from TLS tunnel) 367526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Maximum out_data length 368526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of bytes written to out_data, -1 on failure 369526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 370526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used after TLS handshake has been completed successfully to 371526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * receive data from the encrypted tunnel. 372526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 373526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_decrypt(void *tls_ctx, 374526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 375526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *in_data, size_t in_len, 376526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt u8 *out_data, size_t out_len); 377526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 378526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 379526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_resumed - Was session resumption used 380526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 381526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 382526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 1 if current session used session resumption, 0 if not 383526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 384526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_resumed(void *tls_ctx, struct tls_connection *conn); 385526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 386526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtenum { 387526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_CIPHER_NONE, 388526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_CIPHER_RC4_SHA /* 0x0005 */, 389526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_CIPHER_AES128_SHA /* 0x002f */, 390526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_CIPHER_RSA_DHE_AES128_SHA /* 0x0031 */, 391526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt TLS_CIPHER_ANON_DH_AES128_SHA /* 0x0034 */ 392526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt}; 393526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 394526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 395526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_set_cipher_list - Configure acceptable cipher suites 396526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 397526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 398526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ciphers: Zero (TLS_CIPHER_NONE) terminated list of allowed ciphers 399526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * (TLS_CIPHER_*). 400526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 401526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 402526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_set_cipher_list(void *tls_ctx, 403526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 404526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt u8 *ciphers); 405526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 406526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 407526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_get_cipher - Get current cipher name 408526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 409526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 410526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @buf: Buffer for the cipher name 411526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @buflen: buf size 412526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 413526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 414526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Get the name of the currently used cipher. 415526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 416526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_get_cipher(void *tls_ctx, struct tls_connection *conn, 417526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt char *buf, size_t buflen); 418526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 419526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 420526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_enable_workaround - Enable TLS workaround options 421526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 422526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 423526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 424526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 425526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used to enable connection-specific workaround options for 426526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * buffer SSL/TLS implementations. 427526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 428526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_enable_workaround(void *tls_ctx, 429526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn); 430526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 431526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 432526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_client_hello_ext - Set TLS extension for ClientHello 433526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 434526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 435526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @ext_type: Extension type 436526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @data: Extension payload (%NULL to remove extension) 437526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @data_len: Extension payload length 438526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 439526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 440526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_client_hello_ext(void *tls_ctx, 441526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn, 442526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt int ext_type, const u8 *data, 443526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt size_t data_len); 444526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 445526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 446526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_get_failed - Get connection failure status 447526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 448526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 449526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 450526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns >0 if connection has failed, 0 if not. 451526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 452526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_get_failed(void *tls_ctx, struct tls_connection *conn); 453526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 454526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 455526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_get_read_alerts - Get connection read alert status 456526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 457526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 458526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of times a fatal read (remote end reported error) has 459526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * happened during this connection. 460526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 461526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_get_read_alerts(void *tls_ctx, struct tls_connection *conn); 462526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 463526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 464526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_get_write_alerts - Get connection write alert status 465526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 466526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 467526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of times a fatal write (locally detected error) has happened 468526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * during this connection. 469526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 470526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_get_write_alerts(void *tls_ctx, 471526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn); 472526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 473526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 474526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_get_keyblock_size - Get TLS key_block size 475526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 476526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 477526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Size of the key_block for the negotiated cipher suite or -1 on 478526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * failure 479526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 480526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint tls_connection_get_keyblock_size(void *tls_ctx, 481526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt struct tls_connection *conn); 482526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 483526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt#define TLS_CAPABILITY_IA 0x0001 /* TLS Inner Application (TLS/IA) */ 484526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 485526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_capabilities - Get supported TLS capabilities 486526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 487526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Bit field of supported TLS capabilities (TLS_CAPABILITY_*) 488526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 489526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtunsigned int tls_capabilities(void *tls_ctx); 490526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 491526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 492526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_ia_send_phase_finished - Send a TLS/IA PhaseFinished message 493526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 494526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 495526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @final: 1 = FinalPhaseFinished, 0 = IntermediatePhaseFinished 496526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_data: Pointer to output buffer (encrypted TLS/IA data) 497526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @out_len: Maximum out_data length 498526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: Number of bytes written to out_data on success, -1 on failure 499526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * 500526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * This function is used to send the TLS/IA end phase message, e.g., when the 501526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * EAP server completes EAP-TTLSv1. 502526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 503526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_ia_send_phase_finished( 504526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt void *tls_ctx, struct tls_connection *conn, int final, 505526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt u8 *out_data, size_t out_len); 506526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 507526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 508526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_ia_final_phase_finished - Has final phase been completed 509526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 510526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 511526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 1 if valid FinalPhaseFinished has been received, 0 if not, or -1 512526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * on failure 513526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 514526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_ia_final_phase_finished( 515526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt void *tls_ctx, struct tls_connection *conn); 516526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 517526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt/** 518526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * tls_connection_ia_permute_inner_secret - Permute TLS/IA inner secret 519526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @tls_ctx: TLS context data from tls_init() 520526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @conn: Connection context data from tls_connection_init() 521526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @key: Session key material (session_key vectors with 2-octet length), or 522526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * %NULL if no session key was generating in the current phase 523526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * @key_len: Length of session key material 524526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt * Returns: 0 on success, -1 on failure 525526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt */ 526526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_ia_permute_inner_secret( 527526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt void *tls_ctx, struct tls_connection *conn, 528526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *key, size_t key_len); 529526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 530526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidttypedef int (*tls_session_ticket_cb) 531526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt(void *ctx, const u8 *ticket, size_t len, const u8 *client_random, 532526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt const u8 *server_random, u8 *master_secret); 533526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 534526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidtint __must_check tls_connection_set_session_ticket_cb( 535526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt void *tls_ctx, struct tls_connection *conn, 536526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt tls_session_ticket_cb cb, void *ctx); 537526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt 538526fc2a7dc09b4450086cdec313a5c44d36b10fdDmitry Shmidt#endif /* TLS_H */ 539