mbedtls_io.hpp

浏览该文件的文档.

#pragma once
#include "../acl_cpp_define.hpp"
#include "sslbase_io.hpp"

struct ACL_VSTREAM;

namespace acl {

class mbedtls_conf;

/**
 * stream/aio_stream 流对象底层 IO 处理过程的处理类，该类对象中的读写的过程将会替代
 * stream/aio_stream 流对象中 默认的底层 IO 过程；该类对象必须是动态创建的(即为堆对象)，
 * stream/aio_stream 流对象通过调用本类对象的 destroy()　方法释放本类对象
 */
class ACL_CPP_API mbedtls_io : public sslbase_io
{
public:
        /**
         * 构造函数
         * @param conf {mbedtls_conf&} 对每一个 SSL 连接进行配置的类对象
         * @param server_side {bool} 是否为服务端模式，因为客户端模式与服务端
         *  模式的握手方法不同，所以通过此参数来进行区分
         * @param nblock {bool} 是否为非阻塞模式
         */
        mbedtls_io(mbedtls_conf& conf, bool server_side, bool nblock = false);

        /**
         * @override stream_hook
         * 销毁 SSL IO 对象
         */
        void destroy(void);

        /**
         * @override sslbase_io
         * 调用此方法进行 SSL 握手，在非阻塞 IO 模式下该函数需要与 handshake_ok()
         * 函数组合使用来判断 SSL 握手是否成功
         * @return {bool}
         *  1、返回 false 表示握手失败，需要关闭连接；
         *  2、当返回 true 时：
         *  2.1、如果为阻塞 IO 模式则表示 SSL 握手成功
         *  2.2、在非阻塞 IO 模式下仅代表本次握手过程中 IO 是成功的，还需要调用
         *       handshake_ok() 函数判断 SSL 握手是否成功
         */
        bool handshake(void);

        /**
         * 检查对方证书是否有效（一般不必调用此函数）
         * @return {bool}
         */
        bool check_peer(void);

protected:
        ~mbedtls_io(void);

        // 实现 stream_hook 类的虚方法

        // @override stream_hook
        bool open(ACL_VSTREAM* s);

        // @override stream_hook
        bool on_close(bool alive);

        // @override stream_hook
        int read(void* buf, size_t len);

        // @override stream_hook
        int send(const void* buf, size_t len);

private:
        mbedtls_conf& conf_;
        void* ssl_;
        void* ssn_;

private:
        static int sock_read(void *ctx, unsigned char *buf, size_t len);
        static int sock_send(void *ctx, const unsigned char *buf, size_t len);
};

} // namespace acl