18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * SSL/TLS interface definition 38d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2004-2010, Jouni Malinen <j@w1.fi> 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 5c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * This software may be distributed under the terms of the BSD license. 6c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * See README for more details. 78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef TLS_H 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define TLS_H 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct tls_connection; 138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct tls_keys { 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *master_key; /* TLS master secret */ 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t master_key_len; 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *client_random; 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t client_random_len; 198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *server_random; 208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t server_random_len; 218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum tls_event { 2404949598a23f501be6eec21697465fd46a28840aDmitry Shmidt TLS_CERT_CHAIN_SUCCESS, 258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CERT_CHAIN_FAILURE, 2604949598a23f501be6eec21697465fd46a28840aDmitry Shmidt TLS_PEER_CERTIFICATE, 2704949598a23f501be6eec21697465fd46a28840aDmitry Shmidt TLS_ALERT 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Note: These are used as identifier with external programs and as such, the 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * values must not be changed. 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum tls_fail_reason { 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_UNSPECIFIED = 0, 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_UNTRUSTED = 1, 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_REVOKED = 2, 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_NOT_YET_VALID = 3, 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_EXPIRED = 4, 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_SUBJECT_MISMATCH = 5, 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_ALTSUBJECT_MISMATCH = 6, 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_BAD_CERTIFICATE = 7, 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_FAIL_SERVER_CHAIN_PROBE = 8 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtunion tls_event_data { 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct { 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int depth; 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *subject; 508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt enum tls_fail_reason reason; 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *reason_txt; 528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *cert; 538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt } cert_fail; 548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct { 568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int depth; 578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *subject; 588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *cert; 598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *hash; 608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t hash_len; 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt } peer_cert; 6204949598a23f501be6eec21697465fd46a28840aDmitry Shmidt 6304949598a23f501be6eec21697465fd46a28840aDmitry Shmidt struct { 6404949598a23f501be6eec21697465fd46a28840aDmitry Shmidt int is_local; 6504949598a23f501be6eec21697465fd46a28840aDmitry Shmidt const char *type; 6604949598a23f501be6eec21697465fd46a28840aDmitry Shmidt const char *description; 6704949598a23f501be6eec21697465fd46a28840aDmitry Shmidt } alert; 688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct tls_config { 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *opensc_engine_path; 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *pkcs11_engine_path; 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *pkcs11_module_path; 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int fips_mode; 751f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt int cert_in_cb; 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*event_cb)(void *ctx, enum tls_event ev, 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt union tls_event_data *data); 798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *cb_ctx; 808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define TLS_CONN_ALLOW_SIGN_RSA_MD5 BIT(0) 838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define TLS_CONN_DISABLE_TIME_CHECKS BIT(1) 8461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt#define TLS_CONN_DISABLE_SESSION_TICKET BIT(2) 858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * struct tls_connection_params - Parameters for TLS connection 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ca_cert: File or reference name for CA X.509 certificate in PEM or DER 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * format 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ca_cert_blob: ca_cert as inlined data or %NULL if not used 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ca_cert_blob_len: ca_cert_blob length 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ca_path: Path to CA certificates (OpenSSL specific) 938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @subject_match: String to match in the subject of the peer certificate or 948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * %NULL to allow all subjects 958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @altsubject_match: String to match in the alternative subject of the peer 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * certificate or %NULL to allow all alternative subjects 978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @client_cert: File or reference name for client X.509 certificate in PEM or 988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * DER format 998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @client_cert_blob: client_cert as inlined data or %NULL if not used 1008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @client_cert_blob_len: client_cert_blob length 1018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @private_key: File or reference name for client private key in PEM or DER 1028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * format (traditional format (RSA PRIVATE KEY) or PKCS#8 (PRIVATE KEY) 1038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @private_key_blob: private_key as inlined data or %NULL if not used 1048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @private_key_blob_len: private_key_blob length 1058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @private_key_passwd: Passphrase for decrypted private key, %NULL if no 1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * passphrase is used. 1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @dh_file: File name for DH/DSA data in PEM format, or %NULL if not used 1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @dh_blob: dh_file as inlined data or %NULL if not used 1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @dh_blob_len: dh_blob length 1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @engine: 1 = use engine (e.g., a smartcard) for private key operations 1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (this is OpenSSL specific for now) 1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @engine_id: engine id string (this is OpenSSL specific for now) 1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ppin: pointer to the pin variable in the configuration 1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (this is OpenSSL specific for now) 1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @key_id: the private key's id when using engine (this is OpenSSL 1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * specific for now) 1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @cert_id: the certificate's id when using engine 1188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ca_cert_id: the CA certificate's id when using engine 1198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @flags: Parameter options (TLS_CONN_*) 1208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS connection parameters to be configured with tls_connection_set_params() 1228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * and tls_global_set_params(). 1238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Certificates and private key can be configured either as a reference name 1258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (file path or reference to certificate store) or by providing the same data 1268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * as a pointer to the data in memory. Only one option will be used for each 1278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * field. 1288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct tls_connection_params { 1308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *ca_cert; 1318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *ca_cert_blob; 1328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t ca_cert_blob_len; 1338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *ca_path; 1348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *subject_match; 1358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *altsubject_match; 1368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *client_cert; 1378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *client_cert_blob; 1388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t client_cert_blob_len; 1398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *private_key; 1408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *private_key_blob; 1418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t private_key_blob_len; 1428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *private_key_passwd; 1438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *dh_file; 1448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *dh_blob; 1458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t dh_blob_len; 1468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* OpenSSL specific variables */ 1488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int engine; 1498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *engine_id; 1508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *pin; 1518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *key_id; 1528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *cert_id; 1538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *ca_cert_id; 1548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned int flags; 1568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_init - Initialize TLS library 1618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conf: Configuration data for TLS library 1628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Context data to be used as tls_ctx in calls to other functions, 1638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * or %NULL on failure. 1648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Called once during program startup and once for each RSN pre-authentication 1668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * session. In other words, there can be two concurrent TLS contexts. If global 1678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * library initialization is needed (i.e., one that is shared between both 1688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * authentication types), the TLS library wrapper should maintain a reference 1698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * counter and do global initialization only when moving from 0 to 1 reference. 1708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid * tls_init(const struct tls_config *conf); 1728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_deinit - Deinitialize TLS library 1758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 1768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Called once during program shutdown and once for each RSN pre-authentication 1788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * session. If global library deinitialization is needed (i.e., one that is 1798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * shared between both authentication types), the TLS library wrapper should 1808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * maintain a reference counter and do global deinitialization only when moving 1818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * from 1 to 0 references. 1828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid tls_deinit(void *tls_ctx); 1848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_get_errors - Process pending errors 1878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 1888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Number of found error, 0 if no errors detected. 1898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Process all pending TLS errors. 1918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_get_errors(void *tls_ctx); 1938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_init - Initialize a new TLS connection 1968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 1978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Connection context data, conn for other function calls 1988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct tls_connection * tls_connection_init(void *tls_ctx); 2008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_deinit - Free TLS connection data 2038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Release all resources allocated for TLS connection. 2078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid tls_connection_deinit(void *tls_ctx, struct tls_connection *conn); 2098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_established - Has the TLS connection been completed? 2128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 1 if TLS connection has been completed, 0 if not. 2158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_established(void *tls_ctx, struct tls_connection *conn); 2178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_shutdown - Shutdown TLS connection 2208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 2238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Shutdown current TLS connection without releasing all resources. New 2258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * connection can be started by using the same conn without having to call 2268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_init() or setting certificates etc. again. The new 2278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * connection should try to use session resumption. 2288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_shutdown(void *tls_ctx, struct tls_connection *conn); 2308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum { 2328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED = -3, 2338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED = -2 2348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 2358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_set_params - Set TLS connection parameters 2388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @params: Connection parameters 2418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure, 2428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing 2438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * PKCS#11 engine failure, or 2448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 2458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * PKCS#11 engine private key. 2468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check 2488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidttls_connection_set_params(void *tls_ctx, struct tls_connection *conn, 2498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct tls_connection_params *params); 2508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_global_set_params - Set TLS parameters for all TLS connection 2538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @params: Global TLS parameters 2558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure, 2568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on possible PIN error causing 2578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * PKCS#11 engine failure, or 2588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 2598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * PKCS#11 engine private key. 2608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_global_set_params( 2628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *tls_ctx, const struct tls_connection_params *params); 2638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_global_set_verify - Set global certificate verification options 2668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @check_crl: 0 = do not verify CRLs, 1 = verify CRL for the user certificate, 2688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2 = verify CRL for all certificates 2698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 2708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_global_set_verify(void *tls_ctx, int check_crl); 2728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_set_verify - Set certificate verification options 2758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @verify_peer: 1 = verify peer certificate 2788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 2798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_set_verify(void *tls_ctx, 2818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 2828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int verify_peer); 2838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_get_keys - Get master key and random data from TLS connection 2868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @keys: Structure of key/random data (filled on success) 2898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 2908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_get_keys(void *tls_ctx, 2928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 2938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_keys *keys); 2948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_prf - Use TLS-PRF to derive keying material 2978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 2988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 2998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @label: Label (e.g., description of the key) for PRF 3008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @server_random_first: seed is 0 = client_random|server_random, 3018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1 = server_random|client_random 3028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @out: Buffer for output data from TLS-PRF 3038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @out_len: Length of the output buffer 3048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 3058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is optional to implement if tls_connection_get_keys() provides 3078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * access to master secret and server/client random values. If these values are 3088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * not exported from the TLS library, tls_connection_prf() is required so that 3098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * further keying material can be derived from the master secret. If not 3108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * implemented, the function will still need to be defined, but it can just 3111f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * return -1. Example implementation of this function is in tls_prf_sha1_md5() 3128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * when it is called with seed set to client_random|server_random (or 3138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * server_random|client_random). 3148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 3158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_prf(void *tls_ctx, 3168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 3178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *label, 3188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int server_random_first, 3198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 *out, size_t out_len); 3208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 3228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_handshake - Process TLS handshake (client side) 3238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 3248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 3258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @in_data: Input data from TLS server 3268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @appl_data: Pointer to application data pointer, or %NULL if dropped 3278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Output data, %NULL on failure 3288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The caller is responsible for freeing the returned output data. If the final 3308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * handshake message includes application data, this is decrypted and 3318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * appl_data (if not %NULL) is set to point this data. The caller is 3328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * responsible for freeing appl_data. 3338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used during TLS handshake. The first call is done with 3358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * in_data == %NULL and the library is expected to return ClientHello packet. 3368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This packet is then send to the server and a response from server is given 3378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * to TLS library by calling this function again with in_data pointing to the 3388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS message from the server. 3398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * If the TLS handshake fails, this function may return %NULL. However, if the 3418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * TLS library has a TLS alert to send out, that should be returned as the 3428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * output data. In this case, tls_connection_get_failed() must return failure 3438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (> 0). 3448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_established() should return 1 once the TLS handshake has been 3468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * completed successfully. 3478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 3488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * tls_connection_handshake(void *tls_ctx, 3498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 3508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *in_data, 3518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wpabuf **appl_data); 3528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3531f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidtstruct wpabuf * tls_connection_handshake2(void *tls_ctx, 3541f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt struct tls_connection *conn, 3551f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt const struct wpabuf *in_data, 3561f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt struct wpabuf **appl_data, 3571f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt int *more_data_needed); 3581f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt 3598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 3608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_server_handshake - Process TLS handshake (server side) 3618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 3628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 3638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @in_data: Input data from TLS peer 3648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @appl_data: Pointer to application data pointer, or %NULL if dropped 3658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Output data, %NULL on failure 3668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The caller is responsible for freeing the returned output data. 3688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 3698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * tls_connection_server_handshake(void *tls_ctx, 3708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 3718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *in_data, 3728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wpabuf **appl_data); 3738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 3758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_encrypt - Encrypt data into TLS tunnel 3768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 3778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 3788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @in_data: Plaintext data to be encrypted 3798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Encrypted TLS data or %NULL on failure 3808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used after TLS handshake has been completed successfully to 3828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * send data in the encrypted tunnel. The caller is responsible for freeing the 3838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * returned output data. 3848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 3858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * tls_connection_encrypt(void *tls_ctx, 3868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 3878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *in_data); 3888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 3908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_decrypt - Decrypt data from TLS tunnel 3918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 3928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 3938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @in_data: Encrypted TLS data 3948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Decrypted TLS data or %NULL on failure 3958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 3968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used after TLS handshake has been completed successfully to 3978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * receive data from the encrypted tunnel. The caller is responsible for 3988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * freeing the returned output data. 3998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * tls_connection_decrypt(void *tls_ctx, 4018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 4028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *in_data); 4038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4041f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidtstruct wpabuf * tls_connection_decrypt2(void *tls_ctx, 4051f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt struct tls_connection *conn, 4061f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt const struct wpabuf *in_data, 4071f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt int *more_data_needed); 4081f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt 4098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_resumed - Was session resumption used 4118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 1 if current session used session resumption, 0 if not 4148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_resumed(void *tls_ctx, struct tls_connection *conn); 4168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum { 4188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CIPHER_NONE, 4198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CIPHER_RC4_SHA /* 0x0005 */, 4208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CIPHER_AES128_SHA /* 0x002f */, 4218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CIPHER_RSA_DHE_AES128_SHA /* 0x0031 */, 4228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt TLS_CIPHER_ANON_DH_AES128_SHA /* 0x0034 */ 4238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 4248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_set_cipher_list - Configure acceptable cipher suites 4278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ciphers: Zero (TLS_CIPHER_NONE) terminated list of allowed ciphers 4308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * (TLS_CIPHER_*). 4318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 4328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_set_cipher_list(void *tls_ctx, 4348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 4358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 *ciphers); 4368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_get_cipher - Get current cipher name 4398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @buf: Buffer for the cipher name 4428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @buflen: buf size 4438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 4448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 4458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Get the name of the currently used cipher. 4468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_get_cipher(void *tls_ctx, struct tls_connection *conn, 4488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *buf, size_t buflen); 4498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_enable_workaround - Enable TLS workaround options 4528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 4558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 4568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used to enable connection-specific workaround options for 4578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * buffer SSL/TLS implementations. 4588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_enable_workaround(void *tls_ctx, 4608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn); 4618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_client_hello_ext - Set TLS extension for ClientHello 4648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ext_type: Extension type 4678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @data: Extension payload (%NULL to remove extension) 4688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @data_len: Extension payload length 4698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 4708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_client_hello_ext(void *tls_ctx, 4728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn, 4738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int ext_type, const u8 *data, 4748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t data_len); 4758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_get_failed - Get connection failure status 4788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 4818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns >0 if connection has failed, 0 if not. 4828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_get_failed(void *tls_ctx, struct tls_connection *conn); 4848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_get_read_alerts - Get connection read alert status 4878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Number of times a fatal read (remote end reported error) has 4908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * happened during this connection. 4918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 4928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_get_read_alerts(void *tls_ctx, struct tls_connection *conn); 4938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 4948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 4958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_get_write_alerts - Get connection write alert status 4968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 4978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 4988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Number of times a fatal write (locally detected error) has happened 4998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * during this connection. 5008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 5018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_get_write_alerts(void *tls_ctx, 5028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn); 5038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 5048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 5058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_connection_get_keyblock_size - Get TLS key_block size 5068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 5078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @conn: Connection context data from tls_connection_init() 5088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Size of the key_block for the negotiated cipher suite or -1 on 5098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * failure 5108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 5118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint tls_connection_get_keyblock_size(void *tls_ctx, 5128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct tls_connection *conn); 5138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 5148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 5158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * tls_capabilities - Get supported TLS capabilities 5168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @tls_ctx: TLS context data from tls_init() 5178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Bit field of supported TLS capabilities (TLS_CAPABILITY_*) 5188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 5198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtunsigned int tls_capabilities(void *tls_ctx); 5208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 5218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidttypedef int (*tls_session_ticket_cb) 5228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt(void *ctx, const u8 *ticket, size_t len, const u8 *client_random, 5238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 *server_random, u8 *master_secret); 5248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 5258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint __must_check tls_connection_set_session_ticket_cb( 5268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *tls_ctx, struct tls_connection *conn, 5278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt tls_session_ticket_cb cb, void *ctx); 5288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 5298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* TLS_H */ 530