1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-md5-utils">
<refmeta>
<refentrytitle role="top_of_page" id="libedataserver-md5-utils.top_of_page">MD5 Utility Functions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>MD5 Utility Functions</refname>
<refpurpose>Functions for manipulating MD5 checksums.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libedataserver-md5-utils.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="MD5Context">MD5Context</link>;
<link linkend="void">void</link> <link linkend="md5-get-digest">md5_get_digest</link> (const <link linkend="gchar">gchar</link> *buffer,
<link linkend="gint">gint</link> buffer_size,
<link linkend="guchar">guchar</link> digest[16]);
<link linkend="void">void</link> <link linkend="md5-get-digest-from-file">md5_get_digest_from_file</link> (const <link linkend="gchar">gchar</link> *filename,
<link linkend="guchar">guchar</link> digest[16]);
<link linkend="void">void</link> <link linkend="md5-init">md5_init</link> (<link linkend="MD5Context">MD5Context</link> *ctx);
<link linkend="void">void</link> <link linkend="md5-update">md5_update</link> (<link linkend="MD5Context">MD5Context</link> *ctx,
const <link linkend="guchar">guchar</link> *buf,
<link linkend="guint32">guint32</link> len);
<link linkend="void">void</link> <link linkend="md5-final">md5_final</link> (<link linkend="MD5Context">MD5Context</link> *ctx,
<link linkend="guchar">guchar</link> digest[16]);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libedataserver-md5-utils.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libedataserver-md5-utils.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="MD5Context" role="struct">
<title>MD5Context</title>
<indexterm zone="MD5Context"><primary>MD5Context</primary></indexterm><programlisting>typedef struct {
} MD5Context;
</programlisting>
<para>
A buffer structure used for md5 calculation.</para>
<para>
</para></refsect2>
<refsect2 id="md5-get-digest" role="function">
<title>md5_get_digest ()</title>
<indexterm zone="md5-get-digest"><primary>md5_get_digest</primary></indexterm><programlisting><link linkend="void">void</link> md5_get_digest (const <link linkend="gchar">gchar</link> *buffer,
<link linkend="gint">gint</link> buffer_size,
<link linkend="guchar">guchar</link> digest[16]);</programlisting>
<para>
Get the md5 hash of a buffer. The result is put in
the 16 bytes buffer <parameter>digest</parameter> .</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter> :</term>
<listitem><simpara> byte buffer
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buffer_size</parameter> :</term>
<listitem><simpara> buffer size (in bytes)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>digest</parameter> :</term>
<listitem><simpara> 16 bytes buffer receiving the hash code.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="md5-get-digest-from-file" role="function">
<title>md5_get_digest_from_file ()</title>
<indexterm zone="md5-get-digest-from-file"><primary>md5_get_digest_from_file</primary></indexterm><programlisting><link linkend="void">void</link> md5_get_digest_from_file (const <link linkend="gchar">gchar</link> *filename,
<link linkend="guchar">guchar</link> digest[16]);</programlisting>
<para>
Get the md5 hash of a file. The result is put in
the 16 bytes buffer <parameter>digest</parameter> .</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> file name
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>digest</parameter> :</term>
<listitem><simpara> 16 bytes buffer receiving the hash code.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="md5-init" role="function">
<title>md5_init ()</title>
<indexterm zone="md5-init"><primary>md5_init</primary></indexterm><programlisting><link linkend="void">void</link> md5_init (<link linkend="MD5Context">MD5Context</link> *ctx);</programlisting>
<para>
Initialise an md5 buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter> :</term>
<listitem><simpara> md5 context
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="md5-update" role="function">
<title>md5_update ()</title>
<indexterm zone="md5-update"><primary>md5_update</primary></indexterm><programlisting><link linkend="void">void</link> md5_update (<link linkend="MD5Context">MD5Context</link> *ctx,
const <link linkend="guchar">guchar</link> *buf,
<link linkend="guint32">guint32</link> len);</programlisting>
<para>
Update context to reflect the concatenation of another buffer full
of bytes. Use this to progressively construct an md5 hash.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter> :</term>
<listitem><simpara> context object used for md5 computaion
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> buffer to add
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> buffer length
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="md5-final" role="function">
<title>md5_final ()</title>
<indexterm zone="md5-final"><primary>md5_final</primary></indexterm><programlisting><link linkend="void">void</link> md5_final (<link linkend="MD5Context">MD5Context</link> *ctx,
<link linkend="guchar">guchar</link> digest[16]);</programlisting>
<para>
copy the final md5 hash to a bufer</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ctx</parameter> :</term>
<listitem><simpara> context containing the calculated md5
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>digest</parameter> :</term>
<listitem><simpara> 16 bytes buffer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
