Ecore Connection SSL Functions

Functions that operate on Ecore connection objects pertaining to SSL. More...

Functions

EAPI int ecore_con_ssl_available_get (void)
 Returns if SSL support is available.
EAPI Eina_Bool ecore_con_ssl_server_cert_add (Ecore_Con_Server *svr, const char *cert)
 Add an ssl certificate for use in ecore_con functions.
EAPI Eina_Bool ecore_con_ssl_server_privkey_add (Ecore_Con_Server *svr, const char *key_file)
 Add an ssl private key for use in ecore_con functions.
EAPI Eina_Bool ecore_con_ssl_server_crl_add (Ecore_Con_Server *svr, const char *crl_file)
 Add an ssl CRL for use in ecore_con functions.
EAPI Eina_Bool ecore_con_ssl_server_cafile_add (Ecore_Con_Server *svr, const char *ca_file)
 Add an ssl CA file for use in ecore_con functions.
EAPI void ecore_con_ssl_server_verify (Ecore_Con_Server *svr)
 Enable certificate verification on a server object.
EAPI void ecore_con_ssl_server_verify_basic (Ecore_Con_Server *svr)
 Enable hostname-based certificate verification on a server object.
EAPI void ecore_con_ssl_server_verify_name_set (Ecore_Con_Server *svr, const char *name)
 Set the hostname to verify against in certificate verification.
EAPI const char * ecore_con_ssl_server_verify_name_get (Ecore_Con_Server *svr)
 Get the hostname to verify against in certificate verification.
EAPI Eina_Bool ecore_con_ssl_server_upgrade (Ecore_Con_Server *svr, Ecore_Con_Type ssl_type)
 Upgrade a connection to a specified level of encryption.
EAPI Eina_Bool ecore_con_ssl_client_upgrade (Ecore_Con_Client *cl, Ecore_Con_Type ssl_type)
 Upgrade a connection to a specified level of encryption.

Detailed Description

Functions that operate on Ecore connection objects pertaining to SSL.


Function Documentation

EAPI int ecore_con_ssl_available_get ( void  )

Returns if SSL support is available.

Returns:
1 if SSL is available and provided by gnutls, 2 if provided by openssl, 0 if it is not available.

Referenced by ecore_ipc_ssl_available_get().

EAPI Eina_Bool ecore_con_ssl_client_upgrade ( Ecore_Con_Client cl,
Ecore_Con_Type  ssl_type 
)

Upgrade a connection to a specified level of encryption.

Use this function to begin an SSL handshake on a connection (STARTTLS or similar). Once the upgrade has been completed, an ECORE_CON_EVENT_CLIENT_UPGRADE event will be emitted. The connection should be treated as disconnected until the next event.

Parameters:
clThe client object
ssl_typeThe SSL connection type (ONLY).
Returns:
EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE.
Warning:
Setting a wrong value for compl_type WILL mess up your program.
Since:
1.1
EAPI Eina_Bool ecore_con_ssl_server_cafile_add ( Ecore_Con_Server svr,
const char *  ca_file 
)

Add an ssl CA file for use in ecore_con functions.

Use this function to add a SSL PEM CA file. Simply specify the file here to use it in the server object for connecting or listening. If there is an error loading the CAs, an error will automatically be logged.

Parameters:
svrThe server object
ca_fileThe path to the CA file.
Returns:
EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.
Note:
since 1.2, this function can load directores
Examples:
ecore_con_client_example.c.

References ECORE_CON_LOAD_CERT, and ECORE_CON_USE_MIXED.

EAPI Eina_Bool ecore_con_ssl_server_cert_add ( Ecore_Con_Server svr,
const char *  cert 
)

Add an ssl certificate for use in ecore_con functions.

Use this function to add a SSL PEM certificate. Simply specify the cert here to use it in the server object for connecting or listening. If there is an error loading the certificate, an error will automatically be logged.

Parameters:
svrThe server object
certThe path to the certificate.
Returns:
EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.
Examples:
ecore_con_server_example.c.

References ECORE_CON_LOAD_CERT, and ECORE_CON_USE_MIXED.

EAPI Eina_Bool ecore_con_ssl_server_crl_add ( Ecore_Con_Server svr,
const char *  crl_file 
)

Add an ssl CRL for use in ecore_con functions.

Use this function to add a SSL PEM CRL file Simply specify the CRL file here to use it in the server object for connecting or listening. If there is an error loading the CRL, an error will automatically be logged.

Parameters:
svrThe server object
crl_fileThe path to the CRL file.
Returns:
EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.

References ECORE_CON_LOAD_CERT, and ECORE_CON_USE_MIXED.

EAPI Eina_Bool ecore_con_ssl_server_privkey_add ( Ecore_Con_Server svr,
const char *  key_file 
)

Add an ssl private key for use in ecore_con functions.

Use this function to add a SSL PEM private key Simply specify the key file here to use it in the server object for connecting or listening. If there is an error loading the key, an error will automatically be logged.

Parameters:
svrThe server object
key_fileThe path to the key file.
Returns:
EINA_FALSE if the file cannot be loaded, otherwise EINA_TRUE.
Examples:
ecore_con_server_example.c.

References ECORE_CON_LOAD_CERT, and ECORE_CON_USE_MIXED.

EAPI Eina_Bool ecore_con_ssl_server_upgrade ( Ecore_Con_Server svr,
Ecore_Con_Type  ssl_type 
)

Upgrade a connection to a specified level of encryption.

Use this function to begin an SSL handshake on a connection (STARTTLS or similar). Once the upgrade has been completed, an ECORE_CON_EVENT_SERVER_UPGRADE event will be emitted. The connection should be treated as disconnected until the next event.

Parameters:
svrThe server object
ssl_typeThe SSL connection type (ONLY).
Returns:
EINA_FALSE if the connection cannot be upgraded, otherwise EINA_TRUE.
Note:
This function is NEVER to be used on a server object created with ecore_con_server_add
Warning:
Setting a wrong value for compl_type WILL mess up your program.
Since:
1.1
EAPI void ecore_con_ssl_server_verify ( Ecore_Con_Server svr)

Enable certificate verification on a server object.

Call this function on a server object before main loop has started to enable verification of certificates against loaded certificates.

Parameters:
svrThe server object
Examples:
ecore_con_client_example.c.
EAPI void ecore_con_ssl_server_verify_basic ( Ecore_Con_Server svr)

Enable hostname-based certificate verification on a server object.

Call this function on a server object before main loop has started to enable verification of certificates using ONLY their hostnames.

Parameters:
svrThe server object
Note:
This function has no effect when used on a listening server created by ecore_con_server_add
Since:
1.1
EAPI const char * ecore_con_ssl_server_verify_name_get ( Ecore_Con_Server svr)

Get the hostname to verify against in certificate verification.

This function returns the name which will be used to validate the SSL certificate common name (CN) or alt name (subjectAltName). It will default to the name param in ecore_con_server_connect(), but can be changed with ecore_con_ssl_server_verify_name_set().

Parameters:
svrThe server object
Returns:
The hostname which will be used
Since:
1.2
EAPI void ecore_con_ssl_server_verify_name_set ( Ecore_Con_Server svr,
const char *  name 
)

Set the hostname to verify against in certificate verification.

Sometimes the certificate hostname will not match the hostname that you are connecting to, and will instead match a different name. An example of this is that if you connect to talk.google.com to use Google Talk, you receive Google's certificate for gmail.com. This certificate should be trusted, and so you must call this function with "gmail.com" as name. See RFC2818 for more details.

Parameters:
svrThe server object
nameThe hostname to verify against
Since:
1.2