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
|
.TH "Digest" 3 "19 Jul 2003" "CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Digest \- The digest base class is used for implementing and deriving one way hashing functions. base class for hashing services.
.SH SYNOPSIS
.br
.PP
\fC#include <digest.h>\fP
.PP
Inherited by \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, \fBSHADigest< uint_type, blockSizeInBytes >\fP, and \fBSHADigest< uint64, 64 >\fP.
.PP
.SS "Protected Methods"
.in +1c
.ti -1c
.RI "\fBDigest\fP ()"
.br
.ti -1c
.RI "virtual void \fBinitDigest\fP (void)=0"
.br
.RI "\fIReset the digest table to an initial default value.\fP"
.ti -1c
.RI "virtual unsigned \fBgetSize\fP (void)=0"
.br
.RI "\fIGet the size of a digest in octets.\fP"
.ti -1c
.RI "virtual unsigned \fBgetDigest\fP (unsigned char *buffer)=0"
.br
.RI "\fICopy the binary digest buffer to user memory.\fP"
.ti -1c
.RI "virtual void \fBputDigest\fP (const unsigned char *buffer, unsigned length)=0"
.br
.RI "\fIPut data into the digest bypassing the stream subsystem.\fP"
.ti -1c
.RI "virtual std::ostream & \fBstrDigest\fP (std::ostream &os)=0"
.br
.RI "\fIprint a digest string for export.\fP"
.in -1c
.SS "Friends"
.in +1c
.ti -1c
.RI "std::ostream & \fBoperator<<\fP (std::ostream &os, Digest &ia)"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
The digest base class is used for implementing and deriving one way hashing functions. base class for hashing services.
.PP
\fBAuthor: \fP
.in +1c
David Sugar <dyfet@ostel.com>
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP
.SS "Digest::Digest ()\fC [protected]\fP"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "virtual unsigned Digest::getDigest (unsigned char * buffer)\fC [protected, pure virtual]\fP"
.PP
Copy the binary digest buffer to user memory.
.PP
\fBReturns: \fP
.in +1c
number of bytes in digest.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIbuffer\fP\fP
to write into.
.PP
Implemented in \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, and \fBSHA64DigestHelper\fP.
.SS "virtual unsigned Digest::getSize (void)\fC [protected, pure virtual]\fP"
.PP
Get the size of a digest in octets.
.PP
\fBReturns: \fP
.in +1c
number of bytes in digest.
.PP
Implemented in \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, \fBSHADigest< uint_type, blockSizeInBytes >\fP, \fBSHA1Digest\fP, \fBSHA256Digest\fP, and \fBSHADigest< uint64, 64 >\fP.
.SS "virtual void Digest::initDigest (void)\fC [protected, pure virtual]\fP"
.PP
Reset the digest table to an initial default value.
.PP
Implemented in \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, \fBSHADigest< uint_type, blockSizeInBytes >\fP, \fBSHA1Digest\fP, \fBSHA256Digest\fP, and \fBSHADigest< uint64, 64 >\fP.
.SS "virtual void Digest::putDigest (const unsigned char * buffer, unsigned length)\fC [protected, pure virtual]\fP"
.PP
Put data into the digest bypassing the stream subsystem.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIbuffer\fP\fP
to read from.
.TP
\fB\fIlength\fP\fP
of data.
.PP
Implemented in \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, \fBSHADigest< uint_type, blockSizeInBytes >\fP, and \fBSHADigest< uint64, 64 >\fP.
.SS "virtual std::ostream& Digest::strDigest (std::ostream & os)\fC [protected, pure virtual]\fP"
.PP
print a digest string for export.
.PP
\fBReturns: \fP
.in +1c
string representation of digest.
.PP
Implemented in \fBChecksumDigest\fP, \fBCRC16Digest\fP, \fBCRC32Digest\fP, \fBMD5Digest\fP, \fBSHADigest< uint_type, blockSizeInBytes >\fP, \fBSHA64DigestHelper\fP, and \fBSHADigest< uint64, 64 >\fP.
.SH "FRIENDS AND RELATED FUNCTION DOCUMENTATION"
.PP
.SS "std::ostream& operator<< (std::ostream & os, Digest & ia)\fC [friend]\fP"
.PP
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for CommonC++ from the source code.
|
