ucommon
|
Common secure socket support. More...
#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. | |
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_valid (void) const |
Determine if the current security context is valid. | |
operator bool () | |
bool | operator! () |
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, const char *ciphers) |
Assign a non-default cipher to the context. | |
static client_t | client (const char *authority=((void *) 0)) |
Create an anonymous client context with an optional authority to validate. | |
template<typename T > | |
static void | erase (T *object) |
static bool | fips (void) |
Initialize secure stack with fips support. | |
static bool | init (void) |
Initialize secure stack for first use, and report if SSL support is compiled in. | |
static int | oscerts (const char *path) |
Copy system certificates to a local path. | |
static const char * | oscerts (void) |
Get path to system certificates. | |
static server_t | server (const char *keyfile=((void *) 0), const char *authority=((void *) 0)) |
Create a sever context. | |
static client_t | user (const char *authority) |
Create a peer user client context. | |
static void | uuid (char *string) |
Create 36 character traditional version 1 uuid. | |
static String | uuid (void) |
static error_t | verify (session_t session, const char *peername=((void *) 0)) |
Verify a certificate chain through your certificate authority. | |
Protected Attributes | |
error_t | error |
Last error flagged for this context. |
Common secure socket support.
This offers common routines needed for secure/ssl socket support code.
static void ucommon::secure::cipher | ( | secure * | context, |
const char * | ciphers | ||
) | [static] |
Assign a non-default cipher to the context.
context | to set cipher for. |
ciphers | to set. |
static client_t ucommon::secure::client | ( | const 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 ucommon::secure::err | ( | void | ) | [inline] |
static bool ucommon::secure::fips | ( | void | ) | [static] |
Initialize secure stack with fips support.
If fips support is not successfully enabled, the secure stack is also not initialized. Hence init() can be used for non-fips certified operation if fips fails.
static bool ucommon::secure::init | ( | void | ) | [static] |
Initialize secure stack for first use, and report if SSL support is compiled in.
bool ucommon::secure::is_valid | ( | void | ) | const [inline] |
static int ucommon::secure::oscerts | ( | const char * | path | ) | [static] |
Copy system certificates to a local path.
path | to copy to. |
static const char* ucommon::secure::oscerts | ( | void | ) | [static] |
Get path to system certificates.
static server_t ucommon::secure::server | ( | const char * | keyfile = ((void *) 0) , |
const 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 ucommon::secure::user | ( | const 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 ucommon::secure::uuid | ( | char * | string | ) | [static] |
Create 36 character traditional version 1 uuid.
string | to write uuid into, must be 37 bytes or more. |
static error_t ucommon::secure::verify | ( | session_t | session, |
const char * | peername = ((void *) 0) |
||
) | [static] |
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. |