summaryrefslogtreecommitdiff
path: root/src/modules/m_md5.h
blob: 448637359ce242c856abc44a71d9e8f0266f1771 (plain)
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
 *                       E-mail:
 *                <brain@chatspike.net>
 *                <Craig@chatspike.net>
 *     
 * Written by Craig Edwards, Craig McLure, and others.
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

#ifndef __MD5_H__
#define __MD5_H__

#include "modules.h"

/** MD5Request is the base class used to send MD5 requests to m_md5.so.
 * You should not instantiate classes of type MD5Request directly, instead
 * you should instantiate classes of type MD5ResetRequest, MD5SumRequest,
 * MD5KeyRequest and MD5HexRequest, shown below.
 */
class MD5Request : public Request
{
	/** The keys (IV) to use */
	unsigned int* keys;
	/** The output characters (hex sequence) to use */
	const char* outputs;
	/** The string to hash */
	std::string tohash;
 public:
	/** Initialize MD5Request as an MD5_RESET message */
	MD5Request(Module* Me, Module* Target) : Request(Me, Target, "MD5_RESET")
	{
	}

	/** Initialize MD5Request as an MD5_SUM message */
	MD5Request(Module* Me, Module* Target, const std::string &hashable) : Request(Me, Target, "MD5_SUM"), keys(NULL), outputs(NULL), tohash(hashable)
	{
	}

	/** Initialize MD5Request as an MD5_KEY message */
	MD5Request(Module* Me, Module* Target, unsigned int* k) : Request(Me, Target, "MD5_KEY"), keys(k), outputs(NULL), tohash("")
	{
	}

	/** Initialize MD5Request as an MD5_HEX message */
	MD5Request(Module* Me, Module* Target, const char* out) : Request(Me, Target, "MD5_HEX"), keys(NULL), outputs(out), tohash("")
	{
	}

	/** Get data to be hashed */
	const char* GetHashData()
	{
		return tohash.c_str();
	}

	/** Get keys (IVs) to be used */
	unsigned int* GetKeyData()
	{
		return keys;
	}

	/** Get output characters (hex sequence) to be used */
	const char* GetOutputs()
	{
		return outputs;
	}
};

/** Send this class to m_md5.so to reset the MD5 module to a known state.
 * This will reset the IV to the defaults specified by the MD5 spec,
 * and reset the hex sequence to "0123456789abcdef". It should be sent before
 * ANY other Request types.
 *
 * Example:
 * \code
 * // Reset the MD5 module.
 * MD5ResetRequest(this, MD5Module).Send();
 * \endcode
 */
class MD5ResetRequest : public MD5Request
{
 public:
	/** Initialize MD5ResetRequest for sending.
	 * @param Me A pointer to the sending module
	 * @param Target A pointer to the m_md5.so module
	 */
	MD5ResetRequest(Module* Me, Module* Target) : MD5Request(Me, Target)
	{
	}
};

/** Send this class to m_md5.so to MD5SUM a std::string.
 * You should make sure you know the state of the module before you send this
 * class, e.g. by first sending an MD5ResetRequest class. The hash will be
 * returned when you call Send().
 *
 * Example:
 * \code
 * // ALWAYS ALWAYS reset first, or set your own IV and hex chars.
 * MD5ResetRequest(this, MD5Module).Send();
 * // Get the MD5 sum of the string 'doodads'.
 * std::string result = MD5SumRequest(this, MD5Module, "doodads").Send();
 * \endcode
 */
class MD5SumRequest : public MD5Request
{
 public:
	/** Initialize MD5SumRequest for sending.
	 * @param Me A pointer to the sending module
	 * @param Target A pointer to the m_md5.so module
	 * @param data The data to be hashed
	 */
	MD5SumRequest(Module* Me, Module* Target, const std::string &data) : MD5Request(Me, Target, data)
	{
	}
};

/** Send this class to m_md5.so to change the IVs (keys) to use for hashing.
 * You should make sure you know the state of the module before you send this
 * class, e.g. by first sending an MD5ResetRequest class. The default values for
 * the IV's are those specified in the MD5 specification. Only in very special
 * circumstances should you need to change the IV's (see for example m_cloaking.cpp)
 *
 * Example:
 * \code
 * unsigned int iv[] = { 0xFFFFFFFF, 0x00000000, 0xAAAAAAAA, 0xCCCCCCCC };
 * MD5KeyRequest(this, MD5Module, iv);
 * \endcode
 */
class MD5KeyRequest : public MD5Request
{
 public:
	/** Initialize MD5KeyRequest for sending.
	 * @param Me A pointer to the sending module
	 * @param Target A pointer to the m_md5.so module
	 * @param data The new IV's. This should be an array of exactly four 32 bit values.
	 * On 64-bit architectures, the upper 32 bits of the values will be discarded.
	 */
	MD5KeyRequest(Module* Me, Module* Target, unsigned int* data) : MD5Request(Me, Target, data)
	{
	}
};

/** Send this class to m_md5.so to change the hex sequence to use for generating the returned value.
 * You should make sure you know the state of the module before you send this
 * class, e.g. by first sending an MD5ResetRequest class. The default value for
 * the hex sequence is "0123456789abcdef". Only in very special circumstances should
 * you need to change the hex sequence (see for example m_cloaking.cpp).
 *
 * Example:
 * \code
 * static const char tab[] = "fedcba9876543210";
 * MD5HexRequest(this, MD5Module, tab);
 * \endcode
 */
class MD5HexRequest : public MD5Request
{
 public:
	/** Initialize MD5HexRequest for sending.
	 * @param Me A pointer to the sending module
	 * @param Target A pointer to the m_md5.so module
	 * @param data The hex sequence to use. This should contain exactly 16 ASCII characters,
	 * terminated by a NULL char.
	 */
	MD5HexRequest(Module* Me, Module* Target, const char* data) : MD5Request(Me, Target, data)
	{
	}
};

#endif