diff options
author | JunsuChoi <jsuya.choi@samsung.com> | 2018-09-27 11:22:22 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2018-09-27 11:30:19 +0200 |
commit | f19ff5312b4547793a8a2d8b94fde9d6c4b5137c (patch) | |
tree | cdfc4618bf2ce22fd3ee82644c2c6a58d377affc | |
parent | 6f339cdc2a0e614fb41b898f54d6221f1bf4709b (diff) | |
download | efl-f19ff5312b4547793a8a2d8b94fde9d6c4b5137c.tar.gz |
ecore_con: Add docs for ecore_con legacy functions
Summary:
Find docs of missing legacy functions
from 9c33623(ecore: add ecore_con_url_ssl_ca_set.),
40edc9c(ecore: add ecore_con_url_ssl_verify_peer_set patch by Raoul Hecky.)
and add them.
Test Plan: make doc
Reviewers: cedric, Hermet, segfaultxavi
Reviewed By: segfaultxavi
Subscribers: #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D7117
-rw-r--r-- | src/lib/ecore_con/Ecore_Con.h | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index ea3e223480..f919158b48 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -2283,8 +2283,38 @@ EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con */ EAPI void ecore_con_url_cookies_jar_write(Ecore_Con_Url *url_con); +/** + * Toggle libcurl's verify peer's certificate option. + * + * If @p verify is @c EINA_TRUE, libcurl will verify + * the authenticity of the peer's certificate, otherwise + * it will not. Default behavior of libcurl is to check + * peer's certificate. + * + * @param url_con Ecore_Con_Url instance which will be acted upon. + * @param verify Whether or not libcurl will check peer's certificate. + * @since 1.1.0 + */ EAPI void ecore_con_url_ssl_verify_peer_set(Ecore_Con_Url *url_con, Eina_Bool verify); +/** + * Set a custom CA to trust for SSL/TLS connections. + * + * Specify the path of a file (in PEM format) containing one or more + * CA certificate(s) to use for the validation of the server certificate. + * + * This function can also disable CA validation if @p ca_path is @c NULL. + * However, the server certificate still needs to be valid for the connection + * to succeed (i.e., the certificate must concern the server the + * connection is made to). + * + * @param url_con Connection object that will use the custom CA. + * @param ca_path Path to a CA certificate(s) file or @c NULL to disable + * CA validation. + * + * @return @c 0 on success. When cURL is used, non-zero return values + * are equal to cURL error codes. + */ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con, const char *ca_path); |