BIO结构和BIO相关文件介绍
(作者:DragonKing Mail:wzhah@263.net 发布于:http://gdwzh.126.com openssl专业论坛)
BIO的结构定义和相关项解析如下:
(包含在bio.h文件中,其主文件为bio_lib.c)
typedef struct bio_st BIO;
struct bio_st
{
BIO_METHOD *method;//BIO方法结构,是决定BIO类型和行为的重要参数,各种BIO的不同之处主要也正在于此项。
/* bio, mode, argp, argi, argl, ret */
long (*callback)(struct bio_st *,int,const char *,int, long,long);//BIO回调函数
char *cb_arg; /* first argument for the callback *//回调函数的第一个参量
int init;//初始化标志,初始化了为1,否则为0
int shutdown;//BIO开关标志,如果为1,则处于关闭状态,如果为0,则处于打开的状态。
int flags; /* extra storage */
int retry_reason;
int num;
void *ptr;
struct bio_st *next_bio; /* used by filter BIOs */BIO下联
struct bio_st *prev_bio; /* used by filter BIOs */BIO上联
int references;
unsigned long num_read;//读出的数据长度
unsigned long num_write;//写入的数据长度
CRYPTO_EX_DATA ex_data;
};
在BIO的所用成员中,method可以说是最关键的一个成员,它决定了BIO的类型,可以看到,在声明一个新的BIO结构时,总是使用下面的声明:
BIO* BIO_new(BIO_METHOD *type);
在源代码可以看出,BIO_new函数除了给一些初始变量赋值外,主要就是把type中的各个变量赋值给BIO结构中的method成员。
一般来说,上述type参数是以一个类型生成函数的形式提供的,如生成一个mem型的BIO结构,就使用下面的语句:
BIO *mem = BIO_new(BIO_s_mem());
这样的函数有以下一些:
【source/sink型】
BIO_s_accept():是一个封装了类似TCP/IP socket Accept规则的接口,并且使TCP/IP操作对于BIO接口是透明的。
BIO_s_bio():封装了一个BIO对,数据从其中一个BIO写入,从另外一个BIO读出
BIO_s_connect():是一个封装了类似TCP/IP socket Connect规则的接口,并且使TCP/IP操作对于BIO接口是透明的
BIO_s_fd():是一个封装了文件描述符的BIO接口,提供类似文件读写操作的功能
BIO_s_file():封装了标准的文件接口的BIO,包括标志的输入输出设备如stdin等
BIO_s_mem():封装了内存操作的BIO接口,包括了对内存的读写操作
BIO_s_null():返回空的sink型BIO接口,写入这种接口的所有数据读被丢弃,读的时候总是返回EOF
BIO_s_socket():封装了socket接口的BIO类型
【filter型】
BIO_f_base64():封装了base64编码方法的BIO,写的时候进行编码,读的时候解码
BIO_f_buffer():封装了缓冲区操作的BIO,写入该接口的数据一般是准备传入下一个BIO接口的,从该接口读出的数据一般也是从另一个BIO传过来的。
BIO_f_cipher():封装了加解密方法的BIO,写的时候加密,读的时候解密
BIO_f_md():封装了信息摘要方法的BIO,通过该接口读写的数据都是已经经过摘要的。
BIO_f_null():一个不作任何事情的BIO,对它的操作都简单传到下一个BIO去了,相当于不存在。
BIO_f_ssl():封装了openssl 的SSL协议的BIO类型,也就是为SSL协议增加了一些BIO操作方法。
上述各种类型的函数正是构成BIO强大功能的基本单元,所以,要了解BIO的各种结构和功能,也就应该了解这些函数类型相关的操作函数。
所有这些源文件,都基本上包含于/crypto/bio/目录下的同名.c文件(大部分是同名的)中。
在BIO_METHOD里面,定义了一组行为函数,上述不通类型的BIO_METHOD行为函数的定义是不同的,其结构如下(以非16位系统为例):
typedef struct bio_method_st
{
int type;
const char *name;
int (*bwrite)(BIO *, const char *, int);
int (*bread)(BIO *, char *, int);
int (*bputs)(BIO *, const char *);
int (*bgets)(BIO *, char *, int);
long (*ctrl)(BIO *, int, long, void *);
int (*create)(BIO *);
int (*destroy)(BIO *);
long (*callback_ctrl)(BIO *, int, bio_info_cb *);
} BIO_METHOD;
在BIO的成员中,callback也是比较重要的,它能够用于程序调试用或者自定义改变BIO的行为。详细会在以后相关的部分介绍。
BIO的很多操作,都是BIO_ctrl系列函数根据不通参数组成的宏定义来完成的。所以要了解BIO的行为,了解BIO_ctrl系列函数以及其各个参数的意义也是很重要的。
【BIO目录文件的简要说明】
bio.h:主定义的头文件,包括了很多通用的宏的定义。
bio_lib.c主要的BIO操作定义文件,是比较上层的函数了。
bss_*系列:是soruce/sink型BIO具体的操作实现文件
bf_*系列:是filter型BIO具体的操作实现文件
bio_err.c:是错误信息处理文件
bio_cb.c:是callback函数的相关文件
b_print.c:是信息输出的处理函数文件
b_socket.c:是Socket连接的一些相关信息处理文件
b_dump.c:是对内存内容的存储操作处理
由于时间和能力有限,这个概述就写到这儿了,以后的文章主要根据openssl的帮助文档,并结合源代码做一些分析。