sslconn.h File Reference

SSL API. More...

#include "certificate.h"
#include "proxy.h"
Include dependency graph for sslconn.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PurpleSslConnection
struct  PurpleSslOps
 SSL implementation operations structure. More...

Macros

#define PURPLE_SSL_DEFAULT_PORT   443

Typedefs

typedef struct _PurpleSslConnection PurpleSslConnection
 
typedef void(* PurpleSslInputFunction )(gpointer, PurpleSslConnection *, PurpleInputCondition)
typedef void(* PurpleSslErrorFunction )(PurpleSslConnection *, PurpleSslErrorType, gpointer)

Enumerations

enum  PurpleSslErrorType { PURPLE_SSL_HANDSHAKE_FAILED = 1, PURPLE_SSL_CONNECT_FAILED = 2, PURPLE_SSL_CERTIFICATE_INVALID = 3 }
 Possible SSL errors. More...

Functions

SSL API
gboolean purple_ssl_is_supported (void)
 Returns whether or not SSL is currently supported.
const gchar * purple_ssl_strerror (PurpleSslErrorType error)
 Returns a human-readable string for an SSL error.
PurpleSslConnectionpurple_ssl_connect (PurpleAccount *account, const char *host, int port, PurpleSslInputFunction func, PurpleSslErrorFunction error_func, void *data)
 Makes a SSL connection to the specified host and port.
PurpleSslConnectionpurple_ssl_connect_with_ssl_cn (PurpleAccount *account, const char *host, int port, PurpleSslInputFunction func, PurpleSslErrorFunction error_func, const char *ssl_host, void *data)
 Makes a SSL connection to the specified host and port, using the separate name to verify with the certificate.
PurpleSslConnectionpurple_ssl_connect_fd (PurpleAccount *account, int fd, PurpleSslInputFunction func, PurpleSslErrorFunction error_func, void *data)
 Makes a SSL connection using an already open file descriptor.
PurpleSslConnectionpurple_ssl_connect_with_host_fd (PurpleAccount *account, int fd, PurpleSslInputFunction func, PurpleSslErrorFunction error_func, const char *host, void *data)
 Makes a SSL connection using an already open file descriptor.
void purple_ssl_input_add (PurpleSslConnection *gsc, PurpleSslInputFunction func, void *data)
 Adds an input watcher for the specified SSL connection.
void purple_ssl_close (PurpleSslConnection *gsc)
 Closes a SSL connection.
size_t purple_ssl_read (PurpleSslConnection *gsc, void *buffer, size_t len)
 Reads data from an SSL connection.
size_t purple_ssl_write (PurpleSslConnection *gsc, const void *buffer, size_t len)
 Writes data to an SSL connection.
GList * purple_ssl_get_peer_certificates (PurpleSslConnection *gsc)
 Obtains the peer's presented certificates.
Subsystem API
void purple_ssl_set_ops (PurpleSslOps *ops)
 Sets the current SSL operations structure.
PurpleSslOpspurple_ssl_get_ops (void)
 Returns the current SSL operations structure.
void purple_ssl_init (void)
 Initializes the SSL subsystem.
void purple_ssl_uninit (void)
 Uninitializes the SSL subsystem.

Detailed Description

SSL API.

Definition in file sslconn.h.

Typedef Documentation

Definition at line 43 of file sslconn.h.

Enumeration Type Documentation

Possible SSL errors.

Definition at line 30 of file sslconn.h.

Function Documentation

void purple_ssl_close ( PurpleSslConnection gsc)

Closes a SSL connection.

Parameters
gscThe SSL connection to close.
PurpleSslConnection* purple_ssl_connect ( PurpleAccount account,
const char *  host,
int  port,
PurpleSslInputFunction  func,
PurpleSslErrorFunction  error_func,
void *  data 
)

Makes a SSL connection to the specified host and port.

The caller should keep track of the returned value and use it to cancel the connection, if needed.

Parameters
accountThe account making the connection.
hostThe destination host.
portThe destination port.
funcThe SSL input handler function.
error_funcThe SSL error handler function. This function should NOT call purple_ssl_close(). In the event of an error the PurpleSslConnection will be destroyed for you.
dataUser-defined data.
Returns
The SSL connection handle.
PurpleSslConnection* purple_ssl_connect_fd ( PurpleAccount account,
int  fd,
PurpleSslInputFunction  func,
PurpleSslErrorFunction  error_func,
void *  data 
)

Makes a SSL connection using an already open file descriptor.

Deprecated:
Use purple_ssl_connect_with_host_fd() instead.
Parameters
accountThe account making the connection.
fdThe file descriptor.
funcThe SSL input handler function.
error_funcThe SSL error handler function.
dataUser-defined data.
Returns
The SSL connection handle.
PurpleSslConnection* purple_ssl_connect_with_host_fd ( PurpleAccount account,
int  fd,
PurpleSslInputFunction  func,
PurpleSslErrorFunction  error_func,
const char *  host,
void *  data 
)

Makes a SSL connection using an already open file descriptor.

Parameters
accountThe account making the connection.
fdThe file descriptor.
funcThe SSL input handler function.
error_funcThe SSL error handler function.
hostThe hostname of the other peer (to verify the CN)
dataUser-defined data.
Returns
The SSL connection handle.
Since
2.2.0
PurpleSslConnection* purple_ssl_connect_with_ssl_cn ( PurpleAccount account,
const char *  host,
int  port,
PurpleSslInputFunction  func,
PurpleSslErrorFunction  error_func,
const char *  ssl_host,
void *  data 
)

Makes a SSL connection to the specified host and port, using the separate name to verify with the certificate.

The caller should keep track of the returned value and use it to cancel the connection, if needed.

Parameters
accountThe account making the connection.
hostThe destination host.
portThe destination port.
funcThe SSL input handler function.
error_funcThe SSL error handler function. This function should NOT call purple_ssl_close(). In the event of an error the PurpleSslConnection will be destroyed for you.
ssl_hostThe hostname of the other peer (to verify the CN)
dataUser-defined data.
Returns
The SSL connection handle.
Since
2.6.0
PurpleSslOps* purple_ssl_get_ops ( void  )

Returns the current SSL operations structure.

Returns
The SSL operations structure.
GList* purple_ssl_get_peer_certificates ( PurpleSslConnection gsc)

Obtains the peer's presented certificates.

Parameters
gscThe SSL connection handle
Returns
The peer certificate chain, in the order of certificate, issuer, issuer's issuer, etc. NULL if no certificates have been provided,
Since
2.2.0
void purple_ssl_input_add ( PurpleSslConnection gsc,
PurpleSslInputFunction  func,
void *  data 
)

Adds an input watcher for the specified SSL connection.

Once the SSL handshake is complete, use this to watch for actual data across it.

Parameters
gscThe SSL connection handle.
funcThe callback function.
dataUser-defined data.
gboolean purple_ssl_is_supported ( void  )

Returns whether or not SSL is currently supported.

Returns
TRUE if SSL is supported, or FALSE otherwise.
size_t purple_ssl_read ( PurpleSslConnection gsc,
void *  buffer,
size_t  len 
)

Reads data from an SSL connection.

Parameters
gscThe SSL connection handle.
bufferThe destination buffer.
lenThe maximum number of bytes to read.
Returns
The number of bytes read.
void purple_ssl_set_ops ( PurpleSslOps ops)

Sets the current SSL operations structure.

Parameters
opsThe SSL operations structure to assign.
const gchar* purple_ssl_strerror ( PurpleSslErrorType  error)

Returns a human-readable string for an SSL error.

Parameters
errorError code
Returns
Human-readable error explanation
size_t purple_ssl_write ( PurpleSslConnection gsc,
const void *  buffer,
size_t  len 
)

Writes data to an SSL connection.

Parameters
gscThe SSL connection handle.
bufferThe buffer to write.
lenThe length of the data to write.
Returns
The number of bytes written.
All information, including names and email addresses, entered onto this website or sent to mailing lists affiliated with this website will be public. Do not post confidential information, especially passwords!