acl/lib_acl_cpp/include/acl_cpp/stream/polarssl_conf.hpp

122 lines
3.0 KiB
C++

#pragma once
#include "../acl_cpp_define.hpp"
#include "../stdlib/thread_mutex.hpp"
#include "sslbase_conf.hpp"
#include <vector>
namespace acl
{
/**
* SSL 证书校验级别类型定义
*/
typedef enum
{
POLARSSL_VERIFY_NONE, // 不校验证书
POLARSSL_VERIFY_OPT, // 选择性校验,可以在握手时或握手后校验
POLARSSL_VERIFY_REQ // 要求在握手时校验
} polarssl_verify_t;
class polarssl_io;
/**
* SSL 连接对象的配置类,该类对象一般可以声明为全局对象,用来对每一个 SSL
* 连接对象进行证书配置;该类加载了全局性的证书、密钥等信息;每一个 SSL 对象
* (polarssl_io) 调用本对象的setup_certs 方法来初始化自身的证书、密钥等信息
*/
class ACL_CPP_API polarssl_conf : public sslbase_conf
{
public:
polarssl_conf(void);
virtual ~polarssl_conf(void);
/**
* 加载 CA 根证书(每个配置实例只需调用一次本方法)
* @param ca_file {const char*} CA 证书文件全路径
* @param ca_path {const char*} 多个 CA 证书文件所在目录
* @return {bool} 加载 CA 根证书是否成功
* 注:如果 ca_file、ca_path 均非空,则会依次加载所有证书
*/
bool load_ca(const char* ca_file, const char* ca_path);
/**
* 添加一个服务端/客户端自己的证书,可以多次调用本方法加载多个证书
* @param crt_file {const char*} 证书文件全路径,非空
* @return {bool} 添加证书是否成功
*/
bool add_cert(const char* crt_file);
/**
* 添加服务端/客户端的密钥(每个配置实例只需调用一次本方法)
* @param key_file {const char*} 密钥文件全路径,非空
* @param key_pass {const char*} 密钥文件的密码,没有密钥密码可写 NULL
* @return {bool} 设置是否成功
*/
bool set_key(const char* key_file, const char* key_pass = NULL);
/**
* 设置 SSL 证书校验方式,内部缺省为不校验证书
* @param verify_mode {polarssl_verify_t}
*/
void set_authmode(polarssl_verify_t verify_mode);
/**
* 当为服务端模式时是否启用会话缓存功能,有助于提高 SSL 握手效率
* @param on {bool}
* 注:该函数仅对服务端模式有效
*/
void enable_cache(bool on);
/**
* 获得随机数生成器的熵对象
* @return {void*},返回值为 entropy_context 类型
*/
void* get_entropy(void)
{
return entropy_;
}
/**
* polarssl_io::open 内部会调用本方法用来安装当前 SSL 连接对象的证书
* @param ssl {void*} SSL 连接对象,为 ssl_context 类型
* @param server_side {bool} 该连接对象是否为服务端连接
* @return {bool} 配置 SSL 对象是否成功
*/
bool setup_certs(void* ssl, bool server_side);
public:
/**
* 必须首先调用此函数设置 libpolarssl.so 的全路径
* @param path {const char*} libpolarssl.so 的全路径
*/
static void set_libpath(const char* path);
/**
* 可以显式调用本方法,动态加载 polarssl 动态库
*/
static void load(void);
public:
// @override sslbase_conf
sslbase_io* open(bool server_side, bool nblock);
private:
friend class polarssl_io;
bool has_inited_;
thread_mutex lock_;
void* entropy_;
void* cacert_;
void* pkey_;
void* cert_chain_;
void* cache_;
polarssl_verify_t verify_mode_;
private:
void init_once(void);
void free_ca(void);
};
} // namespace acl