SSL_library_init returns one.

SSL_CIPHER_description writes a description of cipher into buf and returns buf. If buf is NULL, it returns a newly allocated string, to be freed with OPENSSL_free, or NULL on error.

The description includes a trailing newline and has the form: AES128-SHA Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1

Consider SSL_CIPHER_standard_name or SSL_CIPHER_get_name instead.

SSL_CIPHER_get_version returns the string "TLSv1/SSLv3".

SSL_CIPHER_get_id returns cipher's IANA-assigned number, OR-d with 0x03000000. This is part of OpenSSL's SSL 2.0 legacy. SSL 2.0 has long since been removed from BoringSSL. Use SSL_CIPHER_get_protocol_id instead.

SSL_CIPHER_get_name returns the OpenSSL name of cipher. For example, "ECDHE-RSA-AES128-GCM-SHA256". Callers are recommended to use SSL_CIPHER_standard_name instead.

SSL_COMP_get_compression_methods returns NULL.

SSL_COMP_add_compression_method returns one.

SSL_COMP_get_name returns NULL.

SSL_COMP_get0_name returns the name member of comp.

SSL_COMP_get_id returns the id member of comp.

SSL_COMP_free_compression_methods does nothing.

SSLv23_method calls TLS_method.

These version-specific methods behave exactly like TLS_method and DTLS_method except they also call SSL_CTX_set_min_proto_version and SSL_CTX_set_max_proto_version to lock connections to that protocol version.

These client- and server-specific methods call their corresponding generic methods.

SSL_clear resets ssl to allow another connection and returns one on success or zero on failure. It returns most configuration state but releases memory associated with the current connection.

Free ssl and create a new one instead.

SSL_CTX_set_tmp_rsa_callback does nothing.

SSL_set_tmp_rsa_callback does nothing.

SSL_CTX_sess_connect returns zero.

SSL_CTX_sess_connect_good returns zero.

SSL_CTX_sess_connect_renegotiate returns zero.

SSL_CTX_sess_accept returns zero.

SSL_CTX_sess_accept_renegotiate returns zero.

SSL_CTX_sess_accept_good returns zero.

SSL_CTX_sess_hits returns zero.

SSL_CTX_sess_cb_hits returns zero.

SSL_CTX_sess_misses returns zero.

SSL_CTX_sess_timeouts returns zero.

SSL_CTX_sess_cache_full returns zero.

SSL_cutthrough_complete calls SSL_in_false_start.

SSL_num_renegotiations calls SSL_total_renegotiations.

SSL_CTX_need_tmp_RSA returns zero.

SSL_need_tmp_RSA returns zero.

SSL_CTX_set_tmp_rsa returns one.

SSL_set_tmp_rsa returns one.

SSL_CTX_get_read_ahead returns zero.

SSL_CTX_set_read_ahead returns one.

SSL_get_read_ahead returns zero.

SSL_set_read_ahead returns one.

SSL_set_state does nothing.

SSL_get_shared_ciphers writes an empty string to buf and returns a pointer to buf, or NULL if len is less than or equal to zero.

SSL_get_shared_sigalgs returns zero.

SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START.

i2d_SSL_SESSION serializes in, as described in i2d_SAMPLE.

Use SSL_SESSION_to_bytes instead.

d2i_SSL_SESSION parses a serialized session from the len bytes pointed to by *inp, as described in d2i_SAMPLE.

Use SSL_SESSION_from_bytes instead.

i2d_SSL_SESSION_bio serializes session and writes the result to bio. It returns the number of bytes written on success and <= 0 on error.

d2i_SSL_SESSION_bio reads a serialized SSL_SESSION from bio and returns a newly-allocated SSL_SESSION or NULL on error. If out is not NULL, it also frees *out and sets *out to the new SSL_SESSION.

ERR_load_SSL_strings does nothing.

SSL_load_error_strings does nothing.

SSL_CTX_set_tlsext_use_srtp calls SSL_CTX_set_srtp_profiles. It returns zero on success and one on failure.

WARNING: this function is dangerous because it breaks the usual return value convention. Use SSL_CTX_set_srtp_profiles instead.

SSL_set_tlsext_use_srtp calls SSL_set_srtp_profiles. It returns zero on success and one on failure.

WARNING: this function is dangerous because it breaks the usual return value convention. Use SSL_set_srtp_profiles instead.

SSL_get_current_compression returns NULL.

SSL_get_current_expansion returns NULL.

SSL_get_server_tmp_key returns zero.

SSL_get_peer_tmp_key returns zero.

SSL_CTX_set_tmp_dh returns 1.

SSL_set_tmp_dh returns 1.

SSL_CTX_set_tmp_dh_callback does nothing.

SSL_set_tmp_dh_callback does nothing.

SSL_CTX_set1_sigalgs takes num_values ints and interprets them as pairs where the first is the nid of a hash function and the second is an EVP_PKEY_* value. It configures the signature algorithm preferences for ctx based on them and returns one on success or zero on error.

This API is compatible with OpenSSL. However, BoringSSL-specific code should prefer SSL_CTX_set_signing_algorithm_prefs because it's clearer and it's more convenient to codesearch for specific algorithm values.

SSL_set1_sigalgs takes num_values ints and interprets them as pairs where the first is the nid of a hash function and the second is an EVP_PKEY_* value. It configures the signature algorithm preferences for ssl based on them and returns one on success or zero on error.

This API is compatible with OpenSSL. However, BoringSSL-specific code should prefer SSL_CTX_set_signing_algorithm_prefs because it's clearer and it's more convenient to codesearch for specific algorithm values.

SSL_CTX_set1_sigalgs_list takes a textual specification of a set of signature algorithms and configures them on ctx. It returns one on success and zero on error. See https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_sigalgs_list.html for a description of the text format. Also note that TLS 1.3 names (e.g. "rsa_pkcs1_md5_sha1") can also be used (as in OpenSSL, although OpenSSL doesn't document that).

This API is compatible with OpenSSL. However, BoringSSL-specific code should prefer SSL_CTX_set_signing_algorithm_prefs because it's clearer and it's more convenient to codesearch for specific algorithm values.

SSL_set1_sigalgs_list takes a textual specification of a set of signature algorithms and configures them on ssl. It returns one on success and zero on error. See https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_sigalgs_list.html for a description of the text format. Also note that TLS 1.3 names (e.g. "rsa_pkcs1_md5_sha1") can also be used (as in OpenSSL, although OpenSSL doesn't document that).

This API is compatible with OpenSSL. However, BoringSSL-specific code should prefer SSL_CTX_set_signing_algorithm_prefs because it's clearer and it's more convenient to codesearch for specific algorithm values.

The following flags do nothing and are included only to make it easier to compile code with BoringSSL.

SSL_cache_hit calls SSL_session_reused.

SSL_get_default_timeout returns SSL_DEFAULT_SESSION_TIMEOUT.

SSL_get_version returns a string describing the TLS version used by ssl. For example, "TLSv1.2" or "DTLSv1".

SSL_get_all_version_names outputs a list of possible strings SSL_get_version may return in this version of BoringSSL. It writes at most max_out entries to out and returns the total number it would have written, if max_out had been large enough. max_out may be initially set to zero to size the output.

This function is only intended to help initialize tables in callers that want possible strings pre-declared. This list would not be suitable to set a list of supported features. It is in no particular order, and may contain placeholder, experimental, or deprecated values that do not apply to every caller. Future versions of BoringSSL may also return strings not in this list, so this does not apply if, say, sending strings across services.

SSL_get_cipher_list returns the name of the nth cipher in the output of SSL_get_ciphers or NULL if out of range. Use SSL_get_ciphers instead.

SSL_CTX_set_client_cert_cb sets a callback which is called on the client if the server requests a client certificate and none is configured. On success, the callback should return one and set *out_x509 to *out_pkey to a leaf certificate and private key, respectively, passing ownership. It should return zero to send no certificate and -1 to fail or pause the handshake. If the handshake is paused, SSL_get_error will return SSL_ERROR_WANT_X509_LOOKUP.

The callback may call SSL_get0_certificate_types and SSL_get_client_CA_list for information on the server's certificate request.

Use SSL_CTX_set_cert_cb instead. Configuring intermediate certificates with this function is confusing. This callback may not be registered concurrently with SSL_CTX_set_cert_cb or SSL_set_cert_cb.

SSL_want returns one of the above values to determine what the most recent operation on ssl was blocked on. Use SSL_get_error instead.

SSL_get_finished writes up to count bytes of the Finished message sent by ssl to buf. It returns the total untruncated length or zero if none has been sent yet. At TLS 1.3 and later, it returns zero.

Use SSL_get_tls_unique instead.

SSL_get_peer_finished writes up to count bytes of the Finished message received from ssl's peer to buf. It returns the total untruncated length or zero if none has been received yet. At TLS 1.3 and later, it returns zero.

Use SSL_get_tls_unique instead.

SSL_alert_type_string returns "!". Use SSL_alert_type_string_long instead.

SSL_alert_desc_string returns "!!". Use SSL_alert_desc_string_long instead.

SSL_state_string returns "!!!!!!". Use SSL_state_string_long for a more intelligible string.

SSL_TXT_* expand to strings.

SSL_state returns SSL_ST_INIT if a handshake is in progress and SSL_ST_OK otherwise.

Use SSL_is_init instead.

SSL_set_shutdown causes ssl to behave as if the shutdown bitmask (see SSL_get_shutdown) were mode. This may be used to skip sending or receiving close_notify in SSL_shutdown by causing the implementation to believe the events already happened.

It is an error to use SSL_set_shutdown to unset a bit that has already been set. Doing so will trigger an assert in debug builds and otherwise be ignored.

Use SSL_CTX_set_quiet_shutdown instead.

SSL_CTX_set_tmp_ecdh calls SSL_CTX_set1_groups with a one-element list containing ec_key's curve. The remainder of ec_key is ignored.

SSL_set_tmp_ecdh calls SSL_set1_groups with a one-element list containing ec_key's curve. The remainder of ec_key is ignored.

SSL_add_dir_cert_subjects_to_stack lists files in directory dir. It calls SSL_add_file_cert_subjects_to_stack on each file and returns one on success or zero on error. This function is only available from the libdecrepit library.

SSL_CTX_enable_tls_channel_id calls SSL_CTX_set_tls_channel_id_enabled.

SSL_enable_tls_channel_id calls SSL_set_tls_channel_id_enabled.

BIO_f_ssl returns a BIO_METHOD that can wrap an SSL* in a BIO*. Note that this has quite different behaviour from the version in OpenSSL (notably that it doesn't try to auto renegotiate).

IMPORTANT: if you are not curl, don't use this.

BIO_set_ssl sets ssl as the underlying connection for bio, which must have been created using BIO_f_ssl. If take_owership is true, bio will call SSL_free on ssl when closed. It returns one on success or something other than one on error.

SSL_CTX_set_ecdh_auto returns one.

SSL_set_ecdh_auto returns one.

SSL_get_session returns a non-owning pointer to ssl's session. For historical reasons, which session it returns depends on ssl's state.

Prior to the start of the initial handshake, it returns the session the caller set with SSL_set_session. After the initial handshake has finished and if no additional handshakes are in progress, it returns the currently active session. Its behavior is undefined while a handshake is in progress.

If trying to add new sessions to an external session cache, use SSL_CTX_sess_set_new_cb instead. In particular, using the callback is required as of TLS 1.3. For compatibility, this function will return an unresumable session which may be cached, but will never be resumed.

If querying properties of the connection, use APIs on the SSL object.

SSL_get0_session is an alias for SSL_get_session.

SSL_get1_session acts like SSL_get_session but returns a new reference to the session.

OPENSSL_init_ssl returns one.

The following constants are legacy aliases for RSA-PSS with rsaEncryption keys. Use the new names instead.

SSL_set_tlsext_status_type configures a client to request OCSP stapling if type is TLSEXT_STATUSTYPE_ocsp and disables it otherwise. It returns one on success and zero if handshake configuration has already been shed.

Use SSL_enable_ocsp_stapling instead.

SSL_get_tlsext_status_type returns TLSEXT_STATUSTYPE_ocsp if the client requested OCSP stapling and TLSEXT_STATUSTYPE_nothing otherwise. On the client, this reflects whether OCSP stapling was enabled via, e.g., SSL_set_tlsext_status_type. On the server, this is determined during the handshake. It may be queried in callbacks set by SSL_CTX_set_cert_cb. The result is undefined after the handshake completes.

SSL_set_tlsext_status_ocsp_resp sets the OCSP response. It returns one on success and zero on error. On success, ssl takes ownership of resp, which must have been allocated by OPENSSL_malloc.

Use SSL_set_ocsp_response instead.

SSL_get_tlsext_status_ocsp_resp sets *out to point to the OCSP response from the server. It returns the length of the response. If there was no response, it sets *out to NULL and returns zero.

Use SSL_get0_ocsp_response instead.

WARNING: the returned data is not guaranteed to be well formed.

SSL_CTX_set_tlsext_status_cb configures the legacy OpenSSL OCSP callback and returns one. Though the type signature is the same, this callback has different behavior for client and server connections:

For clients, the callback is called after certificate verification. It should return one for success, zero for a bad OCSP response, and a negative number for internal error. Instead, handle this as part of certificate verification. (Historically, OpenSSL verified certificates just before parsing stapled OCSP responses, but BoringSSL fixes this ordering. All server credentials are available during verification.)

Do not use this callback as a server. It is provided for compatibility purposes only. For servers, it is called to configure server credentials. It should return SSL_TLSEXT_ERR_OK on success, SSL_TLSEXT_ERR_NOACK to ignore OCSP requests, or SSL_TLSEXT_ERR_ALERT_FATAL on error. It is usually used to fetch OCSP responses on demand, which is not ideal. Instead, treat OCSP responses like other server credentials, such as certificates or SCT lists. Configure, store, and refresh them eagerly. This avoids downtime if the CA's OCSP responder is briefly offline.

SSL_CTX_set_tlsext_status_arg sets additional data for SSL_CTX_set_tlsext_status_cb's callback and returns one.

The following symbols are compatibility aliases for reason codes used when receiving an alert from the peer. Use the other names instead, which fit the naming convention.

TODO(davidben): Fix references to SSL_R_TLSV1_CERTIFICATE_REQUIRED and remove the compatibility value. The others come from OpenSSL.

The following symbols are compatibility aliases for SSL_GROUP_*.

SSL_get_curve_id calls SSL_get_group_id.

SSL_get_curve_name calls SSL_get_group_name.

SSL_get_all_curve_names calls SSL_get_all_group_names.

SSL_CTX_set1_curves calls SSL_CTX_set1_groups.

SSL_set1_curves calls SSL_set1_groups.

SSL_CTX_set1_curves_list calls SSL_CTX_set1_groups_list.

SSL_set1_curves_list calls SSL_set1_groups_list.

TLSEXT_nid_unknown is a constant used in OpenSSL for SSL_get_negotiated_group to return an unrecognized group. BoringSSL never returns this value, but we define this constant for compatibility.

SSL_CTX_check_private_key returns one if ctx has both a certificate and private key, and zero otherwise.

This function does not check consistency because the library checks when the certificate and key are individually configured. However, if the private key is configured before the certificate, inconsistent private keys are silently dropped. Some callers are inadvertently relying on this function to detect when this happens.

Instead, callers should configure the certificate first, then the private key, checking for errors in each. This function is then unnecessary.

SSL_check_private_key returns one if ssl has both a certificate and private key, and zero otherwise.

See discussion in SSL_CTX_check_private_key.

SSL_CTX_get_security_level returns zero.

This function is not meaningful in BoringSSL. OpenSSL has an arbitrary mapping from algorithms to "security levels" and offers an API to filter TLS configuration by those levels. In OpenSSL, this function does not return how secure ctx is, just what security level the caller previously configured. As BoringSSL does not implement this API, we return zero to report that the security levels mechanism is not used.

SSL_CTX_set0_buffer_pool calls SSL_CTX_set1_buffer_pool. Use SSL_CTX_set1_buffer_pool instead.

WARNING: Despite being named set0, this function does not adopt the caller's reference to pool and instead increments its own reference like a set1 function. Historically, CRYPTO_BUFFER_POOL was not reference-counted and this function saved a non-owning pointer, expecting the caller to maintain a lifetime relationship between the two objects. Now that pools are reference-counted, the compatible behavior is to treat it as set0 rather than ownership-transfering.