#include <secure.h>
Public Types | |
typedef void * | bufio_t |
Convenience type to represent a secure socket buf i/o stream. | |
typedef secure * | client_t |
Convenience type to represent a security context. | |
enum | error_t { OK = 0, INVALID, MISSING_CERTIFICATE, MISSING_PRIVATEKEY, INVALID_CERTIFICATE, INVALID_AUTHORITY, INVALID_PEERNAME, INVALID_CIPHER } |
Different error states of the security context. | |
enum | path_t { SYSTEM_CERTIFICATES, SYSTEM_KEYS } |
Path types to retrieve. | |
typedef secure * | server_t |
typedef void * | session_t |
Convenience type to represent a secure socket session. | |
Public Member Functions | |
error_t | err (void) |
Get last error code associated with the security context. | |
bool | is (void) |
Determine if the current security context is valid. | |
virtual | ~secure () |
This is derived in different back-end libraries, and will be used to clear certificate credentials. | |
Static Public Member Functions | |
static void | cipher (secure *context, char *ciphers) |
Assign a non-default cipher to the context. | |
static client_t | client (char *authority=((void *) 0)) |
Create an anonymous client context with an optional authority to validate. | |
static bool | init (char *program=((void *) 0)) |
Initialize secure stack for first use, and report if SSL support is compiled in. | |
static int | oscerts (char *path) |
Copy system certificates to a local path. | |
static String | path (path_t id) |
Get a certificate path. | |
static server_t | server (char *authority=((void *) 0)) |
Create a sever context. | |
static client_t | user (char *authority) |
Create a peer user client context. | |
static String | uuid (void) |
static void | uuid (char *string) |
Create 36 character traditional version 1 uuid. | |
static error_t | verify (session_t session, char *peername=((void *) 0)) |
Verify a certificate chain through your certificate authority. | |
Protected Attributes | |
error_t | error |
Last error flagged for this context. |
This offers common routines needed for secure/ssl socket support code.
Definition at line 62 of file secure.h.
static void ucc::secure::cipher | ( | secure * | context, | |
char * | ciphers | |||
) | [static] |
Assign a non-default cipher to the context.
context | to set cipher for. | |
ciphers | to set. |
static client_t ucc::secure::client | ( | char * | authority = ((void *) 0) |
) | [static] |
Create an anonymous client context with an optional authority to validate.
authority | path to use or NULL if none. |
error_t ucc::secure::err | ( | void | ) | [inline] |
static bool ucc::secure::init | ( | char * | program = ((void *) 0) |
) | [static] |
bool ucc::secure::is | ( | void | ) | [inline] |
static int ucc::secure::oscerts | ( | char * | path | ) | [static] |
Copy system certificates to a local path.
path | to copy to. |
static server_t ucc::secure::server | ( | char * | authority = ((void *) 0) |
) | [static] |
Create a sever context.
The certificate file used will be based on the init() method name. This may often be /etc/ssl/certs/initname.pem. Similarly, a matching private key certificate will also be loaded. An optional certificate authority document can be used when we are establishing a service which ssl clients have their own certificates.
authority | path to use or NULL if none. |
static client_t ucc::secure::user | ( | char * | authority | ) | [static] |
Create a peer user client context.
This assumes a user certificate in ~/.ssl/certs and the user private key in ~/.ssl/private. The path to an authority is also sent.
authority | path to use. |
static void ucc::secure::uuid | ( | char * | string | ) | [static] |
Create 36 character traditional version 1 uuid.
string | to write uuid into, must be 37 bytes or more. |
Verify a certificate chain through your certificate authority.
This uses the ca loaded as an optional argument for client and server. Optionally the hostname of the connection can also be verified by pulling the peer certificate.
session | that is connected. | |
peername | that we expect. |