openssl之BIO系列之11---文件(file)类型BIO

文件(file)类型BIO

    ---根据openssl doc/crypto/bio/bio_s_file.pod翻译和自己的理解写成

    （作者：DragonKing Mail:wzhah@263.net 发布于：http://gdwzh.126.com之open

ssl专业论坛）

    前面我们已经介绍了很多BIO的基本构造和操作，现在，我们开始针对每一个类型B

IO进行进一步的介绍，这些介绍都是基本基于openssl的帮助文档的，我尽可能加入自己

的一些理解，理清思路。在开始这部分之前，我一直在想该从哪一种类型的BIO开始比较

合适，因为这些BIO类型之间有些还是有相互联系的，比如BIO_s_bio型就和BIO_f_ssl有

关系，最后，考虑到大家对文件操作都比较熟悉，而且该类型BIO比较独立，我决定从这

个BIO开始介绍，随后逐步介绍其它source/sink型BIO，然后再介绍filter型BIO。

    文件(file)类型BIO的相关函数和定义如下（openssl\bio.h）：

     BIO_METHOD * BIO_s_file(void);

     BIO *BIO_new_file(const char *filename, const char *mode);

     BIO *BIO_new_fp(FILE *stream, int flags);

     BIO_set_fp(BIO *b,FILE *fp, int flags);

     BIO_get_fp(BIO *b,FILE **fpp);

     int BIO_read_filename(BIO *b, char *name)

     int BIO_write_filename(BIO *b, char *name)

     int BIO_append_filename(BIO *b, char *name)

     int BIO_rw_filename(BIO *b, char *name)

    下面逐一介绍它们的作用和用法。

    【BIO_s_file】

    经过前面的介绍，大家应该对这种类型的函数结构很熟悉了，他们就是生成BIO类型

的基本构造函数，BIO_s_file返回file类型的BIO，file类型的BIO封装了一个标准的文

件结构，它是一种source/sink型BIO。file类型的BIO_METHOD结构定义如下：

    static BIO_METHOD methods_filep=

     {

     BIO_TYPE_FILE,

     "FILE pointer",

     file_write,

     file_read,

     file_puts,

     file_gets,

     file_ctrl,

     file_new,

     file_free,

     NULL,

     };

    可以看到，file类型的BIO定义了7个函数，这些函数的实现都在Crypto\bio\bss_f

ile.c里面，大家如果要了解该类型BIO的函数实现，可以参考该文件。事实上，BIO_s_

file只是简单返回一个file类型的BIO_METHOD的结构的指针，其函数实现如下：

    BIO_METHOD *BIO_s_file(void)

     {

     return(&methods_filep);

     }

    其实，从这个结构可以略见BIO的实现的一班，即BIO的所有动作都是根据它的BIO_

METHOD的类型（第一个参数）来决定它的动作和行为的，从而实现BIO对各种类型的多态

实现。

    在file类型中，使用前面介绍过的BIO_read和BIO_write对底层的file数据流进行读

写操作，file类型BIO是支持BIO_gets和BIO_puts函数的（大家如果忘了这些函数的作用

，请参考前面的《BIO系列之6---BIO的IO操作函数》）。

    BIO_flush函数在file类型BIO中只是简单调用了API函数fflush。

    BIO_reset函数则将文件指针重新指向文件的开始位置，它调用fseek(stream,0,0)

函数实现该功能。

    BIO_seek函数将文件指针位置至于所定义的位置ofs上（从文件开头开始计算的偏移

ofs），它调用了文件的操作函数fseek(stream,ofs,0)，是一个宏定义形式的函数，需

要注意的是，因为该函数调用了fseek函数，所以成功的时候返回0，失败的时候返回－

1，这是跟标准BIO_seek函数定义不一样的，因为标准的定义是成功返回1，失败返回非

正值。

    BIO_eof调用了feof函数。

    如果在BIO结构中设置了BIO_CLOSE的标志，则在BIO释放的时候会自动调用fclose函

数。

    【BIO_new_file】

    该函数根据给定的mode类型创建了一个文件BIO，mode参数的函数跟fopen函数中mo

de参数的含义是一样的。返回的BIO设置了BIO_CLOSE标志。调用成功返回一个BIO，否则

返回NULL。

    事实上，该函数先调用了fopen函数打开一个文件，然后调用BIO_new函数创建一个

file类型BIO，最后调用函数BIO_set_fp函数给BIO结构跟相关的file帮定。

    【BIO_new_fp】

    用文件描述符创建一个file类型BIO，参数Flags可以为BIO_CLOSE,BIO_NOCLOSE（关

闭标志）以及BIO_FP_TEXT（将文件设置为文本模式，默认的是二进制模式，该选项只对

Win32平台有效）。事实上，该函数调用BIO_new函数创建一个file类型BIO，然后调用函

数BIO_set_fp函数给BIO结构跟相关的file帮定。需要注意的是，如果下层封装的是std

out,stdin和stderr，他们因为跟一般的是不关闭的，所以应该设置BIO_NOCLOSE标志。

调用成功返回一个BIO，否则返回NULL。

    【BIO_set_fp】

    该函数将BIO跟文件描述符fp帮定在一起，其参数flags的含义跟BIO_new_fp是一样

的。该函数是一个宏定义函数。调用成功返回1，否则返回0，不过目前的实现是从来不

会出现失败情况的。

    【BIO_get_fp】

    该函数返回file类型BIO中文件描述符，也是一个宏定义。调用成功返回1，否则返

回0，不过目前的实现是从来不会出现失败情况的。

    【BIO_tell】

    返回位置指针的值。是一个宏定义函数。

    【BIO_read_filename, BIO_write_filename, BIO_append_filename， BIO_rw_fi

lename】

    这四个函数分别设置BIO的读文件名，写文件名，附加文件名以及读写的文件名。他

们都是一些宏定义函数。调用成功返回1，否则返回0。

    从上面各函数的介绍可以看出，因为BIO调用了底层的各种操作函数，所以，如果底

层函数的调用有任何异常，都会反映在BIO的调用上。

    下面举几个BIO文件类型操作的简单例子：

    1.最简单的实例程序

     BIO *bio_out;

     bio_out = BIO_new_fp(stdout, BIO_NOCLOSE);

     BIO_printf(bio_out, "Hello World\n");

    2.上述例子的另一种实现方法

     BIO *bio_out;

     bio_out = BIO_new(BIO_s_file());

     if(bio_out == NULL) /* 出错*/

     if(!BIO_set_fp(bio_out, stdout, BIO_NOCLOSE)) /* 出错则将文件流定向到标

准输出*/

     BIO_printf(bio_out, "Hello World\n");

    3.写文件操作

     BIO *out;

     out = BIO_new_file("filename.txt", "w");

     if(!out) /*出错 */

     BIO_printf(out, "Hello World\n");

     BIO_free(out);

    4.上述例子的另一种实现方法

     BIO *out;

     out = BIO_new(BIO_s_file());

     if(out == NULL) /* Error ... */

     if(!BIO_write_filename(out, "filename.txt")) /* Error ... */

     BIO_printf(out, "Hello World\n");

     BIO_free(out);