acl  3.5.3.0
acl::md5类 参考

#include <md5.hpp>

+ 类 acl::md5 继承关系图:
+ acl::md5 的协作图:

Public 成员函数

 md5 (void)
 
 ~md5 (void)
 
md5update (const void *dat, size_t len)
 
md5finish (void)
 
md5reset (void)
 
const char * get_digest () const
 
const char * get_string () const
 

静态 Public 成员函数

static const char * md5_digest (const void *dat, size_t dlen, const void *key, size_t klen, void *out, size_t size)
 
static const char * md5_string (const void *dat, size_t dlen, const void *key, size_t klen, char *out, size_t size)
 
static long long int md5_file (const char *path, const void *key, size_t klen, char *out, size_t size)
 
static long long int md5_file (istream &in, const void *key, size_t klen, char *out, size_t size)
 
static const char * hex_encode (const void *in, char *out, size_t size)
 

额外继承的成员函数

- Protected 成员函数 继承自 acl::acl::noncopyable
 noncopyable ()
 
 ~noncopyable ()
 

详细描述

在文件 md5.hpp9 行定义.

构造及析构函数说明

◆ md5()

acl::md5::md5 ( void  )

◆ ~md5()

acl::md5::~md5 ( void  )

成员函数说明

◆ finish()

md5& acl::md5::finish ( void  )

必须调用本函数表示 md5 过程结束

返回
{md5&}

◆ get_digest()

const char* acl::md5::get_digest ( ) const

获得二进制格式的 md5 结果值

返回
{const char*} 返回值永远非空,且缓冲区长度为 16 字节

◆ get_string()

const char* acl::md5::get_string ( ) const

获得以字符串形式表示的 m5 结果值

返回
{const char*} 返回值永远非空,且以 \0 结尾,且字符串 长度为 32 字节

◆ hex_encode()

static const char* acl::md5::hex_encode ( const void *  in,
char *  out,
size_t  size 
)
static

将 16 字节长度的 MD5 二进制结果转换为 32 字节长度的字符串

参数
in{const void*} 128 位(即 16 字节)的 md5 值,即 in 的数据长度 至少应该 >= 16,否则会引起内存起越界
out{char*} 存储字符串形式的结果
size{size_t} out 内存大小,至少为 33 字节,否则内部产生断言
返回
{const char*} 返回存储结果的地址(即 out 地址), 且返回值为以 \0 结尾的 32 字节长度(不含 \0)字符串

◆ md5_digest()

static const char* acl::md5::md5_digest ( const void *  dat,
size_t  dlen,
const void *  key,
size_t  klen,
void *  out,
size_t  size 
)
static

将数据用 md5 算法计算签名值,取得 128 位 (即 16 字节) 二进制结果

参数
dat{const void*} 源数据
dlen{size_t} dat 数据长度
key{const char*} 非空时做为键数据
klen{size_t} key 非空时表示 key 的长度
out{void*} 存储 md5 结果
size{size_t} out 大小,至少应该为 16 字节
返回
{const char*} 返回存储结果的地址(即 out 地址)

◆ md5_file() [1/2]

static long long int acl::md5::md5_file ( const char *  path,
const void *  key,
size_t  klen,
char *  out,
size_t  size 
)
static

将文件中的内容用 md5 算法计算签名值,并取得字符串形式结果

参数
path{const char*} 文件全路径
key{const char*} 非空时做为键数据
klen{size_t} key 非空时表示 key 的长度
out{void*} 存储 md5 结果
size{size_t} out 大小,至少应该为 33 字节
返回
{int64) 返回所读取的文件数据的长度,下列情况下返回 -1 1) 打开文件失败 2) 未从文件中读到数据 3) out 缓冲区大小 size 小于 33 字节长度

◆ md5_file() [2/2]

static long long int acl::md5::md5_file ( istream in,
const void *  key,
size_t  klen,
char *  out,
size_t  size 
)
static

将文件中的内容用 md5 算法计算签名值,并取得字符串形式结果

参数
in{istream&} 输入文件流
key{const char*} 非空时做为键数据
klen{size_t} key 非空时表示 key 的长度
out{void*} 存储 md5 结果
size{size_t} out 大小,至少应该为 33 字节
返回
{int64) 返回所读取的文件数据的长度,下列情况下返回 -1: 1) 未从输入流中读取数据时 2) out 缓冲区大小 size 小于 33 字节长度

◆ md5_string()

static const char* acl::md5::md5_string ( const void *  dat,
size_t  dlen,
const void *  key,
size_t  klen,
char *  out,
size_t  size 
)
static

将数据用 md5 算法计算签名值,取得字符串形式的结果

参数
dat{const void*} 源数据
dlen{size_t} dat 数据长度
key{const char*} 非空时做为键数据
klen{size_t} key 非空时表示 key 的长度
out{void*} 存储 md5 结果
size{size_t} out 大小,至少应该为 33 字节
返回
{const char*} 返回存储结果的地址(即 out 地址), 且返回值为以 \0 结尾的 32 字节长度(不含 \0)字符串

◆ reset()

md5& acl::md5::reset ( void  )

重置 md5 算法器的状态,从而允许重复使用同一个 md5 对象

返回
{md5&}

◆ update()

md5& acl::md5::update ( const void *  dat,
size_t  len 
)

可以循环调用此函数添加需要被 md5 的数据

参数
dat{const void*} 数据地址
len{size_t} dat 数据长度
返回
{md5&}

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