acl::sslbase_conf类 参考

#include <sslbase_conf.hpp>

类 acl::sslbase_conf 继承关系图:

acl::sslbase_conf 的协作图:

Public 成员函数
	sslbase_conf (void)
virtual	~sslbase_conf (void)
virtual sslbase_io *	create (bool nblock)=0
virtual bool	load_ca (const char *ca_file, const char *ca_path)
virtual bool	append_key_cert (const char *crt_file, const char *key_file, const char *key_pass=NULL)
virtual bool	add_cert (const char *crt_file)
virtual bool	set_key (const char *key_file, const char *key_pass=NULL)
virtual void	enable_cache (bool on)

额外继承的成员函数
Protected 成员函数 继承自 acl::acl::noncopyable
	noncopyable ()
	~noncopyable ()

详细描述

在文件 sslbase_conf.hpp 第 10 行定义.

构造及析构函数说明

sslbase_conf()

acl::sslbase_conf::sslbase_conf ( void  )

inline

在文件 sslbase_conf.hpp 第 13 行定义.

{}

~sslbase_conf()

virtual acl::sslbase_conf::~sslbase_conf ( void  )

inlinevirtual

在文件 sslbase_conf.hpp 第 14 行定义.

{}

成员函数说明

add_cert()

virtual bool acl::sslbase_conf::add_cert ( const char *  crt_file )

inlinevirtual

添加一个服务端/客户端自己的证书，可以多次调用本方法加载多个证书

参数

crt_file

{const char*} 证书文件全路径，非空

返回

{bool} 添加证书是否成功

弃用:

use append_key_cert

被 acl::mbedtls_conf , 以及 acl::polarssl_conf 重载.

在文件 sslbase_conf.hpp 第 60 行定义.

        {
                (void) crt_file;
                return false;
        }

append_key_cert()

virtual bool acl::sslbase_conf::append_key_cert ( const char *  crt_file, const char *  key_file, const char *  key_pass = NULL  )

inlinevirtual

添加一个服务端/客户端自己的证书，可以多次调用本方法加载多个证书

参数

crt_file	{const char*} 证书文件全路径，非空
key_file	{const char*} 密钥文件全路径，非空
key_pass	{const char*} 密钥文件的密码，没有密钥密码可写 NULL

返回

{bool} 添加证书是否成功

被 acl::mbedtls_conf 重载.

在文件 sslbase_conf.hpp 第 45 行定义.

        {
                (void) crt_file;
                (void) key_file;
                (void) key_pass;
                return false;
        }

create()

virtual sslbase_io* acl::sslbase_conf::create ( bool  nblock )

pure virtual

纯虚方法，创建 SSL IO 对象

参数

nblock

{bool} 是否为非阻塞模式

返回

{sslbase_io*}

在 acl::mbedtls_conf , 以及 acl::polarssl_conf 内被实现.

enable_cache()

virtual void acl::sslbase_conf::enable_cache ( bool  on )

inlinevirtual

当为服务端模式时是否启用会话缓存功能，有助于提高 SSL 握手效率

参数

on	{bool} 注：该函数仅对服务端模式有效

被 acl::mbedtls_conf , 以及 acl::polarssl_conf 重载.

在文件 sslbase_conf.hpp 第 85 行定义.

        {
                (void) on;
        }

load_ca()

virtual bool acl::sslbase_conf::load_ca ( const char *  ca_file, const char *  ca_path  )

inlinevirtual

加载 CA 根证书(每个配置实例只需调用一次本方法)

参数

ca_file	{const char*} CA 证书文件全路径
ca_path	{const char*} 多个 CA 证书文件所在目录

返回

{bool} 加载 CA 根证书是否成功 注：如果 ca_file、ca_path 均非空，则会依次加载所有证书

被 acl::mbedtls_conf , 以及 acl::polarssl_conf 重载.

在文件 sslbase_conf.hpp 第 31 行定义.

        {
                (void) ca_file;
                (void) ca_path;
                return false;
        }

set_key()

virtual bool acl::sslbase_conf::set_key ( const char *  key_file, const char *  key_pass = NULL  )

inlinevirtual

添加服务端/客户端的密钥(每个配置实例只需调用一次本方法)

参数

key_file	{const char*} 密钥文件全路径，非空
key_pass	{const char*} 密钥文件的密码，没有密钥密码可写 NULL

返回

{bool} 设置是否成功

弃用:

use append_key_cert

被 acl::mbedtls_conf , 以及 acl::polarssl_conf 重载.

在文件 sslbase_conf.hpp 第 73 行定义.

        {
                (void) key_file;
                (void) key_pass;
                return false;
        }

---

该类的文档由以下文件生成:

• include/acl_cpp/stream/sslbase_conf.hpp