src/ssl.h File Reference

SSL. More...

#include <glib.h>

Go to the source code of this file.

Defines

#define SSL_H   1
#define SSL_ERROR   ssl_error_quark()

Enumerations

enum  SSLType { SSL_TYPE_CLIENT = 0, SSL_TYPE_SERVER }
 SSLType: : the client side of an SSL connection : the server side of an SSL connection. More...
enum  SocketError { SSL_ERROR_HANDSHAKE_NEEDS_READ, SSL_ERROR_HANDSHAKE_NEEDS_WRITE, SSL_ERROR_CERTIFICATE }

Functions

gpointer ssl_get_client_credentials (const char *ca_file)
 ssl_get_client_credentials: : path to a file containing X509-encoded Certificate Authority certificates.
void ssl_free_client_credentials (gpointer creds)
 ssl_free_client_credentials: : a client credentials structure returned by ssl_get_client_credentials().
gpointer ssl_get_server_credentials (const char *cert_file, const char *key_file)
 ssl_get_server_credentials: : path to a file containing an X509-encoded server certificate : path to a file containing an X509-encoded key for .
void ssl_free_server_credentials (gpointer creds)
 ssl_free_server_credentials: : a server credentials structure returned by ssl_get_server_credentials().
GIOChannel * ssl_wrap_iochannel (GIOChannel *sock, SSLType type, const char *remote_host, gpointer credentials)
 ssl_wrap_iochannel: : a GIOChannel wrapping a TCP socket.
GQuark ssl_error_quark (void)
 soup_ssl_error_quark:
void ssl_cert_generate (const char *keyfile, const char *certfile, const char *cafile)
gpointer ssl_create_server_credentials (struct ctrlproxy_config *cfg, GKeyFile *kf, const char *group)


Detailed Description

SSL.


Enumeration Type Documentation

enum SSLType

SSLType: : the client side of an SSL connection : the server side of an SSL connection.

What kind of SSL connection this is.


Function Documentation

GQuark ssl_error_quark ( void   ) 

soup_ssl_error_quark:

Return value: The quark used as SOUP_SSL_ERROR

void ssl_free_client_credentials ( gpointer  creds  ) 

ssl_free_client_credentials: : a client credentials structure returned by ssl_get_client_credentials().

Frees .

void ssl_free_server_credentials ( gpointer  creds  ) 

ssl_free_server_credentials: : a server credentials structure returned by ssl_get_server_credentials().

Frees .

gpointer ssl_get_client_credentials ( const char *  ca_file  ) 

ssl_get_client_credentials: : path to a file containing X509-encoded Certificate Authority certificates.

Creates an opaque client credentials object which can later be passed to ssl_wrap_iochannel().

If is non-NULL, any certificate received from a server must be signed by one of the CAs in the file, or an error will be returned.

Return value: the client credentials, which must be freed with ssl_free_client_credentials().

gpointer ssl_get_server_credentials ( const char *  cert_file,
const char *  key_file 
)

ssl_get_server_credentials: : path to a file containing an X509-encoded server certificate : path to a file containing an X509-encoded key for .

Creates an opaque server credentials object which can later be passed to ssl_wrap_iochannel().

Return value: the server credentials, which must be freed with ssl_free_server_credentials().

GIOChannel* ssl_wrap_iochannel ( GIOChannel *  sock,
SSLType  type,
const char *  remote_host,
gpointer  credentials 
)

ssl_wrap_iochannel: : a GIOChannel wrapping a TCP socket.

: whether this is a client or server socket : the hostname of the remote machine : a client or server credentials structure

This attempts to wrap a new GIOChannel around that will SSL-encrypt/decrypt all traffic through it.

Return value: an SSL-encrypting GIOChannel, or NULL on failure.


Generated on Mon Apr 14 00:44:20 2008 for ctrlproxy by  doxygen 1.5.5