1 /* 2 * SSL/TLS interface definition 3 * Copyright (c) 2004-2013, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9 #ifndef TLS_H 10 #define TLS_H 11 12 struct tls_connection; 13 14 struct tls_random { 15 const u8 *client_random; 16 size_t client_random_len; 17 const u8 *server_random; 18 size_t server_random_len; 19 }; 20 21 enum tls_event { 22 TLS_CERT_CHAIN_SUCCESS, 23 TLS_CERT_CHAIN_FAILURE, 24 TLS_PEER_CERTIFICATE, 25 TLS_ALERT, 26 TLS_UNSAFE_RENEGOTIATION_DISABLED, 27 }; 28 29 /* 30 * Note: These are used as identifier with external programs and as such, the 31 * values must not be changed. 32 */ 33 enum tls_fail_reason { 34 TLS_FAIL_UNSPECIFIED = 0, 35 TLS_FAIL_UNTRUSTED = 1, 36 TLS_FAIL_REVOKED = 2, 37 TLS_FAIL_NOT_YET_VALID = 3, 38 TLS_FAIL_EXPIRED = 4, 39 TLS_FAIL_SUBJECT_MISMATCH = 5, 40 TLS_FAIL_ALTSUBJECT_MISMATCH = 6, 41 TLS_FAIL_BAD_CERTIFICATE = 7, 42 TLS_FAIL_SERVER_CHAIN_PROBE = 8, 43 TLS_FAIL_DOMAIN_SUFFIX_MISMATCH = 9, 44 TLS_FAIL_DOMAIN_MISMATCH = 10, 45 TLS_FAIL_INSUFFICIENT_KEY_LEN = 11, 46 TLS_FAIL_DN_MISMATCH = 12, 47 }; 48 49 50 #define TLS_MAX_ALT_SUBJECT 10 51 52 struct tls_cert_data { 53 int depth; 54 const char *subject; 55 const struct wpabuf *cert; 56 const u8 *hash; 57 size_t hash_len; 58 const char *altsubject[TLS_MAX_ALT_SUBJECT]; 59 int num_altsubject; 60 const char *serial_num; 61 int tod; 62 }; 63 64 union tls_event_data { 65 struct { 66 int depth; 67 const char *subject; 68 enum tls_fail_reason reason; 69 const char *reason_txt; 70 const struct wpabuf *cert; 71 } cert_fail; 72 73 struct tls_cert_data peer_cert; 74 75 struct { 76 int is_local; 77 const char *type; 78 const char *description; 79 } alert; 80 }; 81 82 struct tls_config { 83 const char *opensc_engine_path; 84 const char *pkcs11_engine_path; 85 const char *pkcs11_module_path; 86 int fips_mode; 87 int cert_in_cb; 88 const char *openssl_ciphers; 89 unsigned int tls_session_lifetime; 90 unsigned int crl_reload_interval; 91 unsigned int tls_flags; 92 93 void (*event_cb)(void *ctx, enum tls_event ev, 94 union tls_event_data *data); 95 void *cb_ctx; 96 }; 97 98 #define TLS_CONN_ALLOW_SIGN_RSA_MD5 BIT(0) 99 #define TLS_CONN_DISABLE_TIME_CHECKS BIT(1) 100 #define TLS_CONN_DISABLE_SESSION_TICKET BIT(2) 101 #define TLS_CONN_REQUEST_OCSP BIT(3) 102 #define TLS_CONN_REQUIRE_OCSP BIT(4) 103 #define TLS_CONN_DISABLE_TLSv1_1 BIT(5) 104 #define TLS_CONN_DISABLE_TLSv1_2 BIT(6) 105 #define TLS_CONN_EAP_FAST BIT(7) 106 #define TLS_CONN_DISABLE_TLSv1_0 BIT(8) 107 #define TLS_CONN_EXT_CERT_CHECK BIT(9) 108 #define TLS_CONN_REQUIRE_OCSP_ALL BIT(10) 109 #define TLS_CONN_SUITEB BIT(11) 110 #define TLS_CONN_SUITEB_NO_ECDH BIT(12) 111 #define TLS_CONN_DISABLE_TLSv1_3 BIT(13) 112 #define TLS_CONN_ENABLE_TLSv1_0 BIT(14) 113 #define TLS_CONN_ENABLE_TLSv1_1 BIT(15) 114 #define TLS_CONN_ENABLE_TLSv1_2 BIT(16) 115 #define TLS_CONN_TEAP_ANON_DH BIT(17) 116 #define TLS_CONN_ALLOW_UNSAFE_RENEGOTIATION BIT(18) 117 118 /** 119 * struct tls_connection_params - Parameters for TLS connection 120 * @ca_cert: File or reference name for CA X.509 certificate in PEM or DER 121 * format 122 * @ca_cert_blob: ca_cert as inlined data or %NULL if not used 123 * @ca_cert_blob_len: ca_cert_blob length 124 * @ca_path: Path to CA certificates (OpenSSL specific) 125 * @subject_match: String to match in the subject of the peer certificate or 126 * %NULL to allow all subjects 127 * @altsubject_match: String to match in the alternative subject of the peer 128 * certificate or %NULL to allow all alternative subjects 129 * @suffix_match: Semicolon deliminated string of values to suffix match against 130 * the dNSName or CN of the peer certificate or %NULL to allow all domain names. 131 * This may allow subdomains and wildcard certificates. Each domain name label 132 * must have a full case-insensitive match. 133 * @domain_match: String to match in the dNSName or CN of the peer 134 * certificate or %NULL to allow all domain names. This requires a full, 135 * case-insensitive match. 136 * 137 * More than one match string can be provided by using semicolons to 138 * separate the strings (e.g., example.org;example.com). When multiple 139 * strings are specified, a match with any one of the values is 140 * considered a sufficient match for the certificate, i.e., the 141 * conditions are ORed together. 142 * @client_cert: File or reference name for client X.509 certificate in PEM or 143 * DER format 144 * @client_cert_blob: client_cert as inlined data or %NULL if not used 145 * @client_cert_blob_len: client_cert_blob length 146 * @private_key: File or reference name for client private key in PEM or DER 147 * format (traditional format (RSA PRIVATE KEY) or PKCS#8 (PRIVATE KEY) 148 * @private_key_blob: private_key as inlined data or %NULL if not used 149 * @private_key_blob_len: private_key_blob length 150 * @private_key_passwd: Passphrase for decrypted private key, %NULL if no 151 * passphrase is used. 152 * @dh_file: File name for DH/DSA data in PEM format, or %NULL if not used 153 * @engine: 1 = use engine (e.g., a smartcard) for private key operations 154 * (this is OpenSSL specific for now) 155 * @engine_id: engine id string (this is OpenSSL specific for now) 156 * @ppin: pointer to the pin variable in the configuration 157 * (this is OpenSSL specific for now) 158 * @key_id: the private key's id when using engine (this is OpenSSL 159 * specific for now) 160 * @cert_id: the certificate's id when using engine 161 * @ca_cert_id: the CA certificate's id when using engine 162 * @openssl_ciphers: OpenSSL cipher configuration 163 * @openssl_ecdh_curves: OpenSSL ECDH curve configuration. %NULL for auto if 164 * supported, empty string to disable, or a colon-separated curve list. 165 * @flags: Parameter options (TLS_CONN_*) 166 * @ocsp_stapling_response: DER encoded file with cached OCSP stapling response 167 * or %NULL if OCSP is not enabled 168 * @ocsp_stapling_response_multi: DER encoded file with cached OCSP stapling 169 * response list (OCSPResponseList for ocsp_multi in RFC 6961) or %NULL if 170 * ocsp_multi is not enabled 171 * @check_cert_subject: Client certificate subject name matching string 172 * 173 * TLS connection parameters to be configured with tls_connection_set_params() 174 * and tls_global_set_params(). 175 * 176 * Certificates and private key can be configured either as a reference name 177 * (file path or reference to certificate store) or by providing the same data 178 * as a pointer to the data in memory. Only one option will be used for each 179 * field. 180 */ 181 struct tls_connection_params { 182 const char *ca_cert; 183 const u8 *ca_cert_blob; 184 size_t ca_cert_blob_len; 185 const char *ca_path; 186 const char *subject_match; 187 const char *altsubject_match; 188 const char *suffix_match; 189 const char *domain_match; 190 const char *client_cert; 191 const char *client_cert2; 192 const u8 *client_cert_blob; 193 size_t client_cert_blob_len; 194 const char *private_key; 195 const char *private_key2; 196 const u8 *private_key_blob; 197 size_t private_key_blob_len; 198 const char *private_key_passwd; 199 const char *private_key_passwd2; 200 const char *dh_file; 201 202 /* OpenSSL specific variables */ 203 int engine; 204 const char *engine_id; 205 const char *pin; 206 const char *key_id; 207 const char *cert_id; 208 const char *ca_cert_id; 209 const char *openssl_ciphers; 210 const char *openssl_ecdh_curves; 211 212 unsigned int flags; 213 const char *ocsp_stapling_response; 214 const char *ocsp_stapling_response_multi; 215 const char *check_cert_subject; 216 }; 217 218 219 /** 220 * tls_init - Initialize TLS library 221 * @conf: Configuration data for TLS library 222 * Returns: Context data to be used as tls_ctx in calls to other functions, 223 * or %NULL on failure. 224 * 225 * Called once during program startup and once for each RSN pre-authentication 226 * session. In other words, there can be two concurrent TLS contexts. If global 227 * library initialization is needed (i.e., one that is shared between both 228 * authentication types), the TLS library wrapper should maintain a reference 229 * counter and do global initialization only when moving from 0 to 1 reference. 230 */ 231 void * tls_init(const struct tls_config *conf); 232 233 /** 234 * tls_deinit - Deinitialize TLS library 235 * @tls_ctx: TLS context data from tls_init() 236 * 237 * Called once during program shutdown and once for each RSN pre-authentication 238 * session. If global library deinitialization is needed (i.e., one that is 239 * shared between both authentication types), the TLS library wrapper should 240 * maintain a reference counter and do global deinitialization only when moving 241 * from 1 to 0 references. 242 */ 243 void tls_deinit(void *tls_ctx); 244 245 /** 246 * tls_get_errors - Process pending errors 247 * @tls_ctx: TLS context data from tls_init() 248 * Returns: Number of found error, 0 if no errors detected. 249 * 250 * Process all pending TLS errors. 251 */ 252 int tls_get_errors(void *tls_ctx); 253 254 /** 255 * tls_connection_init - Initialize a new TLS connection 256 * @tls_ctx: TLS context data from tls_init() 257 * Returns: Connection context data, conn for other function calls 258 */ 259 struct tls_connection * tls_connection_init(void *tls_ctx); 260 261 /** 262 * tls_connection_deinit - Free TLS connection data 263 * @tls_ctx: TLS context data from tls_init() 264 * @conn: Connection context data from tls_connection_init() 265 * 266 * Release all resources allocated for TLS connection. 267 */ 268 void tls_connection_deinit(void *tls_ctx, struct tls_connection *conn); 269 270 /** 271 * tls_connection_established - Has the TLS connection been completed? 272 * @tls_ctx: TLS context data from tls_init() 273 * @conn: Connection context data from tls_connection_init() 274 * Returns: 1 if TLS connection has been completed, 0 if not. 275 */ 276 int tls_connection_established(void *tls_ctx, struct tls_connection *conn); 277 278 /** 279 * tls_connection_peer_serial_num - Fetch peer certificate serial number 280 * @tls_ctx: TLS context data from tls_init() 281 * @conn: Connection context data from tls_connection_init() 282 * Returns: Allocated string buffer containing the peer certificate serial 283 * number or %NULL on error. 284 * 285 * The caller is responsible for freeing the returned buffer with os_free(). 286 */ 287 char * tls_connection_peer_serial_num(void *tls_ctx, 288 struct tls_connection *conn); 289 290 /** 291 * tls_connection_shutdown - Shutdown TLS connection 292 * @tls_ctx: TLS context data from tls_init() 293 * @conn: Connection context data from tls_connection_init() 294 * Returns: 0 on success, -1 on failure 295 * 296 * Shutdown current TLS connection without releasing all resources. New 297 * connection can be started by using the same conn without having to call 298 * tls_connection_init() or setting certificates etc. again. The new 299 * connection should try to use session resumption. 300 */ 301 int tls_connection_shutdown(void *tls_ctx, struct tls_connection *conn); 302 303 enum { 304 TLS_SET_PARAMS_ENGINE_PRV_BAD_PIN = -4, 305 TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED = -3, 306 TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED = -2 307 }; 308 309 /** 310 * tls_connection_set_params - Set TLS connection parameters 311 * @tls_ctx: TLS context data from tls_init() 312 * @conn: Connection context data from tls_connection_init() 313 * @params: Connection parameters 314 * Returns: 0 on success, -1 on failure, 315 * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on error causing PKCS#11 engine 316 * failure, or 317 * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 318 * PKCS#11 engine private key, or 319 * TLS_SET_PARAMS_ENGINE_PRV_BAD_PIN (-4) on PIN error causing PKCS#11 engine 320 * failure. 321 */ 322 int __must_check 323 tls_connection_set_params(void *tls_ctx, struct tls_connection *conn, 324 const struct tls_connection_params *params); 325 326 /** 327 * tls_global_set_params - Set TLS parameters for all TLS connection 328 * @tls_ctx: TLS context data from tls_init() 329 * @params: Global TLS parameters 330 * Returns: 0 on success, -1 on failure, 331 * TLS_SET_PARAMS_ENGINE_PRV_INIT_FAILED (-2) on error causing PKCS#11 engine 332 * failure, or 333 * TLS_SET_PARAMS_ENGINE_PRV_VERIFY_FAILED (-3) on failure to verify the 334 * PKCS#11 engine private key, or 335 * TLS_SET_PARAMS_ENGINE_PRV_BAD_PIN (-4) on PIN error causing PKCS#11 engine 336 * failure. 337 */ 338 int __must_check tls_global_set_params( 339 void *tls_ctx, const struct tls_connection_params *params); 340 341 /** 342 * tls_global_set_verify - Set global certificate verification options 343 * @tls_ctx: TLS context data from tls_init() 344 * @check_crl: 0 = do not verify CRLs, 1 = verify CRL for the user certificate, 345 * 2 = verify CRL for all certificates 346 * @strict: 0 = allow CRL time errors, 1 = do not allow CRL time errors 347 * Returns: 0 on success, -1 on failure 348 */ 349 int __must_check tls_global_set_verify(void *tls_ctx, int check_crl, 350 int strict); 351 352 /** 353 * tls_connection_set_verify - Set certificate verification options 354 * @tls_ctx: TLS context data from tls_init() 355 * @conn: Connection context data from tls_connection_init() 356 * @verify_peer: 0 = do not verify peer certificate, 1 = verify peer 357 * certificate (require it to be provided), 2 = verify peer certificate if 358 * provided 359 * @flags: Connection flags (TLS_CONN_*) 360 * @session_ctx: Session caching context or %NULL to use default 361 * @session_ctx_len: Length of @session_ctx in bytes. 362 * Returns: 0 on success, -1 on failure 363 */ 364 int __must_check tls_connection_set_verify(void *tls_ctx, 365 struct tls_connection *conn, 366 int verify_peer, 367 unsigned int flags, 368 const u8 *session_ctx, 369 size_t session_ctx_len); 370 371 /** 372 * tls_connection_get_random - Get random data from TLS connection 373 * @tls_ctx: TLS context data from tls_init() 374 * @conn: Connection context data from tls_connection_init() 375 * @data: Structure of client/server random data (filled on success) 376 * Returns: 0 on success, -1 on failure 377 */ 378 int __must_check tls_connection_get_random(void *tls_ctx, 379 struct tls_connection *conn, 380 struct tls_random *data); 381 382 /** 383 * tls_connection_export_key - Derive keying material from a TLS connection 384 * @tls_ctx: TLS context data from tls_init() 385 * @conn: Connection context data from tls_connection_init() 386 * @label: Label (e.g., description of the key) for PRF 387 * @context: Optional extra upper-layer context (max len 2^16) 388 * @context_len: The length of the context value 389 * @out: Buffer for output data from TLS-PRF 390 * @out_len: Length of the output buffer 391 * Returns: 0 on success, -1 on failure 392 * 393 * Exports keying material using the mechanism described in RFC 5705. If 394 * context is %NULL, context is not provided; otherwise, context is provided 395 * (including the case of empty context with context_len == 0). 396 */ 397 int __must_check tls_connection_export_key(void *tls_ctx, 398 struct tls_connection *conn, 399 const char *label, 400 const u8 *context, 401 size_t context_len, 402 u8 *out, size_t out_len); 403 404 /** 405 * tls_connection_get_eap_fast_key - Derive key material for EAP-FAST 406 * @tls_ctx: TLS context data from tls_init() 407 * @conn: Connection context data from tls_connection_init() 408 * @out: Buffer for output data from TLS-PRF 409 * @out_len: Length of the output buffer 410 * Returns: 0 on success, -1 on failure 411 * 412 * Exports key material after the normal TLS key block for use with 413 * EAP-FAST. Most callers will want tls_connection_export_key(), but EAP-FAST 414 * uses a different legacy mechanism. 415 */ 416 int __must_check tls_connection_get_eap_fast_key(void *tls_ctx, 417 struct tls_connection *conn, 418 u8 *out, size_t out_len); 419 420 /** 421 * tls_connection_handshake - Process TLS handshake (client side) 422 * @tls_ctx: TLS context data from tls_init() 423 * @conn: Connection context data from tls_connection_init() 424 * @in_data: Input data from TLS server 425 * @appl_data: Pointer to application data pointer, or %NULL if dropped 426 * Returns: Output data, %NULL on failure 427 * 428 * The caller is responsible for freeing the returned output data. If the final 429 * handshake message includes application data, this is decrypted and 430 * appl_data (if not %NULL) is set to point this data. The caller is 431 * responsible for freeing appl_data. 432 * 433 * This function is used during TLS handshake. The first call is done with 434 * in_data == %NULL and the library is expected to return ClientHello packet. 435 * This packet is then send to the server and a response from server is given 436 * to TLS library by calling this function again with in_data pointing to the 437 * TLS message from the server. 438 * 439 * If the TLS handshake fails, this function may return %NULL. However, if the 440 * TLS library has a TLS alert to send out, that should be returned as the 441 * output data. In this case, tls_connection_get_failed() must return failure 442 * (> 0). 443 * 444 * tls_connection_established() should return 1 once the TLS handshake has been 445 * completed successfully. 446 */ 447 struct wpabuf * tls_connection_handshake(void *tls_ctx, 448 struct tls_connection *conn, 449 const struct wpabuf *in_data, 450 struct wpabuf **appl_data); 451 452 struct wpabuf * tls_connection_handshake2(void *tls_ctx, 453 struct tls_connection *conn, 454 const struct wpabuf *in_data, 455 struct wpabuf **appl_data, 456 int *more_data_needed); 457 458 /** 459 * tls_connection_server_handshake - Process TLS handshake (server side) 460 * @tls_ctx: TLS context data from tls_init() 461 * @conn: Connection context data from tls_connection_init() 462 * @in_data: Input data from TLS peer 463 * @appl_data: Pointer to application data pointer, or %NULL if dropped 464 * Returns: Output data, %NULL on failure 465 * 466 * The caller is responsible for freeing the returned output data. 467 */ 468 struct wpabuf * tls_connection_server_handshake(void *tls_ctx, 469 struct tls_connection *conn, 470 const struct wpabuf *in_data, 471 struct wpabuf **appl_data); 472 473 /** 474 * tls_connection_encrypt - Encrypt data into TLS tunnel 475 * @tls_ctx: TLS context data from tls_init() 476 * @conn: Connection context data from tls_connection_init() 477 * @in_data: Plaintext data to be encrypted 478 * Returns: Encrypted TLS data or %NULL on failure 479 * 480 * This function is used after TLS handshake has been completed successfully to 481 * send data in the encrypted tunnel. The caller is responsible for freeing the 482 * returned output data. 483 */ 484 struct wpabuf * tls_connection_encrypt(void *tls_ctx, 485 struct tls_connection *conn, 486 const struct wpabuf *in_data); 487 488 /** 489 * tls_connection_decrypt - Decrypt data from TLS tunnel 490 * @tls_ctx: TLS context data from tls_init() 491 * @conn: Connection context data from tls_connection_init() 492 * @in_data: Encrypted TLS data 493 * Returns: Decrypted TLS data or %NULL on failure 494 * 495 * This function is used after TLS handshake has been completed successfully to 496 * receive data from the encrypted tunnel. The caller is responsible for 497 * freeing the returned output data. 498 */ 499 struct wpabuf * tls_connection_decrypt(void *tls_ctx, 500 struct tls_connection *conn, 501 const struct wpabuf *in_data); 502 503 struct wpabuf * tls_connection_decrypt2(void *tls_ctx, 504 struct tls_connection *conn, 505 const struct wpabuf *in_data, 506 int *more_data_needed); 507 508 /** 509 * tls_connection_resumed - Was session resumption used 510 * @tls_ctx: TLS context data from tls_init() 511 * @conn: Connection context data from tls_connection_init() 512 * Returns: 1 if current session used session resumption, 0 if not 513 */ 514 int tls_connection_resumed(void *tls_ctx, struct tls_connection *conn); 515 516 enum { 517 TLS_CIPHER_NONE, 518 TLS_CIPHER_RC4_SHA /* 0x0005 */, 519 TLS_CIPHER_AES128_SHA /* 0x002f */, 520 TLS_CIPHER_RSA_DHE_AES128_SHA /* 0x0031 */, 521 TLS_CIPHER_ANON_DH_AES128_SHA /* 0x0034 */, 522 TLS_CIPHER_RSA_DHE_AES256_SHA /* 0x0039 */, 523 TLS_CIPHER_AES256_SHA /* 0x0035 */, 524 }; 525 526 /** 527 * tls_connection_set_cipher_list - Configure acceptable cipher suites 528 * @tls_ctx: TLS context data from tls_init() 529 * @conn: Connection context data from tls_connection_init() 530 * @ciphers: Zero (TLS_CIPHER_NONE) terminated list of allowed ciphers 531 * (TLS_CIPHER_*). 532 * Returns: 0 on success, -1 on failure 533 */ 534 int __must_check tls_connection_set_cipher_list(void *tls_ctx, 535 struct tls_connection *conn, 536 u8 *ciphers); 537 538 /** 539 * tls_get_version - Get the current TLS version number 540 * @tls_ctx: TLS context data from tls_init() 541 * @conn: Connection context data from tls_connection_init() 542 * @buf: Buffer for returning the TLS version number 543 * @buflen: buf size 544 * Returns: 0 on success, -1 on failure 545 * 546 * Get the currently used TLS version number. 547 */ 548 int __must_check tls_get_version(void *tls_ctx, struct tls_connection *conn, 549 char *buf, size_t buflen); 550 551 /** 552 * tls_get_cipher - Get current cipher name 553 * @tls_ctx: TLS context data from tls_init() 554 * @conn: Connection context data from tls_connection_init() 555 * @buf: Buffer for the cipher name 556 * @buflen: buf size 557 * Returns: 0 on success, -1 on failure 558 * 559 * Get the name of the currently used cipher. 560 */ 561 int __must_check tls_get_cipher(void *tls_ctx, struct tls_connection *conn, 562 char *buf, size_t buflen); 563 564 /** 565 * tls_connection_enable_workaround - Enable TLS workaround options 566 * @tls_ctx: TLS context data from tls_init() 567 * @conn: Connection context data from tls_connection_init() 568 * Returns: 0 on success, -1 on failure 569 * 570 * This function is used to enable connection-specific workaround options for 571 * buffer SSL/TLS implementations. 572 */ 573 int __must_check tls_connection_enable_workaround(void *tls_ctx, 574 struct tls_connection *conn); 575 576 /** 577 * tls_connection_client_hello_ext - Set TLS extension for ClientHello 578 * @tls_ctx: TLS context data from tls_init() 579 * @conn: Connection context data from tls_connection_init() 580 * @ext_type: Extension type 581 * @data: Extension payload (%NULL to remove extension) 582 * @data_len: Extension payload length 583 * Returns: 0 on success, -1 on failure 584 */ 585 int __must_check tls_connection_client_hello_ext(void *tls_ctx, 586 struct tls_connection *conn, 587 int ext_type, const u8 *data, 588 size_t data_len); 589 590 /** 591 * tls_connection_get_failed - Get connection failure status 592 * @tls_ctx: TLS context data from tls_init() 593 * @conn: Connection context data from tls_connection_init() 594 * 595 * Returns >0 if connection has failed, 0 if not. 596 */ 597 int tls_connection_get_failed(void *tls_ctx, struct tls_connection *conn); 598 599 /** 600 * tls_connection_get_read_alerts - Get connection read alert status 601 * @tls_ctx: TLS context data from tls_init() 602 * @conn: Connection context data from tls_connection_init() 603 * Returns: Number of times a fatal read (remote end reported error) has 604 * happened during this connection. 605 */ 606 int tls_connection_get_read_alerts(void *tls_ctx, struct tls_connection *conn); 607 608 /** 609 * tls_connection_get_write_alerts - Get connection write alert status 610 * @tls_ctx: TLS context data from tls_init() 611 * @conn: Connection context data from tls_connection_init() 612 * Returns: Number of times a fatal write (locally detected error) has happened 613 * during this connection. 614 */ 615 int tls_connection_get_write_alerts(void *tls_ctx, 616 struct tls_connection *conn); 617 618 typedef int (*tls_session_ticket_cb) 619 (void *ctx, const u8 *ticket, size_t len, const u8 *client_random, 620 const u8 *server_random, u8 *master_secret); 621 622 int __must_check tls_connection_set_session_ticket_cb( 623 void *tls_ctx, struct tls_connection *conn, 624 tls_session_ticket_cb cb, void *ctx); 625 626 void tls_connection_set_log_cb(struct tls_connection *conn, 627 void (*log_cb)(void *ctx, const char *msg), 628 void *ctx); 629 630 #define TLS_BREAK_VERIFY_DATA BIT(0) 631 #define TLS_BREAK_SRV_KEY_X_HASH BIT(1) 632 #define TLS_BREAK_SRV_KEY_X_SIGNATURE BIT(2) 633 #define TLS_DHE_PRIME_511B BIT(3) 634 #define TLS_DHE_PRIME_767B BIT(4) 635 #define TLS_DHE_PRIME_15 BIT(5) 636 #define TLS_DHE_PRIME_58B BIT(6) 637 #define TLS_DHE_NON_PRIME BIT(7) 638 639 void tls_connection_set_test_flags(struct tls_connection *conn, u32 flags); 640 641 int tls_get_library_version(char *buf, size_t buf_len); 642 643 void tls_connection_set_success_data(struct tls_connection *conn, 644 struct wpabuf *data); 645 646 void tls_connection_set_success_data_resumed(struct tls_connection *conn); 647 648 const struct wpabuf * 649 tls_connection_get_success_data(struct tls_connection *conn); 650 651 void tls_connection_remove_session(struct tls_connection *conn); 652 653 /** 654 * tls_get_tls_unique - Fetch "tls-unique" for channel binding 655 * @conn: Connection context data from tls_connection_init() 656 * @buf: Buffer for returning the value 657 * @max_len: Maximum length of the buffer in bytes 658 * Returns: Number of bytes written to buf or -1 on error 659 * 660 * This function can be used to fetch "tls-unique" (RFC 5929, Section 3) which 661 * is the first TLS Finished message sent in the most recent TLS handshake of 662 * the TLS connection. 663 */ 664 int tls_get_tls_unique(struct tls_connection *conn, u8 *buf, size_t max_len); 665 666 /** 667 * tls_connection_get_cipher_suite - Get current TLS cipher suite 668 * @conn: Connection context data from tls_connection_init() 669 * Returns: TLS cipher suite of the current connection or 0 on error 670 */ 671 u16 tls_connection_get_cipher_suite(struct tls_connection *conn); 672 673 /** 674 * tls_connection_get_peer_subject - Get peer subject 675 * @conn: Connection context data from tls_connection_init() 676 * Returns: Peer subject or %NULL if not authenticated or not available 677 */ 678 const char * tls_connection_get_peer_subject(struct tls_connection *conn); 679 680 /** 681 * tls_connection_get_own_cert_used - Was own certificate used 682 * @conn: Connection context data from tls_connection_init() 683 * Returns: true if own certificate was used during authentication 684 */ 685 bool tls_connection_get_own_cert_used(struct tls_connection *conn); 686 687 /** 688 * tls_register_cert_callback - Register a callback to retrieve certificates 689 * @cb: Callback object to register 690 */ 691 typedef ssize_t (*tls_get_certificate_cb) 692 (void* ctx, const char* alias, uint8_t** value); 693 694 void tls_register_cert_callback(tls_get_certificate_cb cb); 695 696 #endif /* TLS_H */ 697