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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
/**************************************************************************/
/* */
/* Copyright (c) 2001, 2011 NoMachine (http://www.nomachine.com) */
/* Copyright (c) 2008-2017 Oleksandr Shneyder <o.shneyder@phoca-gmbh.de> */
/* Copyright (c) 2014-2022 Ulrich Sibiller <uli42@gmx.de> */
/* Copyright (c) 2014-2019 Mihai Moldovan <ionic@ionic.de> */
/* Copyright (c) 2011-2022 Mike Gabriel <mike.gabriel@das-netzwerkteam.de>*/
/* Copyright (c) 2015-2016 Qindel Group (http://www.qindel.com) */
/* */
/* NXCOMP, NX protocol compression and NX extensions to this software */
/* are copyright of the aforementioned persons and companies. */
/* */
/* Redistribution and use of the present software is allowed according */
/* to terms specified in the file LICENSE.nxcomp which comes in the */
/* source distribution. */
/* */
/* All rights reserved. */
/* */
/* NOTE: This software has received contributions from various other */
/* contributors, only the core maintainers and supporters are listed as */
/* copyright holders. Please contact us, if you feel you should be listed */
/* as copyright holder, as well. */
/* */
/**************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "GenericRequest.h"
#include "ClientCache.h"
#include "EncodeBuffer.h"
#include "DecodeBuffer.h"
#include "WriteBuffer.h"
//
// Set the verbosity level.
//
#define PANIC
#define WARNING
#undef TEST
#undef DEBUG
#undef DUMP
//
// Constructors and destructors.
//
GenericRequestStore::GenericRequestStore(StaticCompressor *compressor)
: MessageStore(compressor)
{
enableCache = GENERICREQUEST_ENABLE_CACHE;
enableData = GENERICREQUEST_ENABLE_DATA;
enableSplit = GENERICREQUEST_ENABLE_SPLIT;
// Since ProtoStep7 (#issue 108)
enableCompress = GENERICREQUEST_ENABLE_COMPRESS_IF_PROTO_STEP_7;
dataLimit = GENERICREQUEST_DATA_LIMIT;
dataOffset = GENERICREQUEST_DATA_OFFSET;
cacheSlots = GENERICREQUEST_CACHE_SLOTS;
cacheThreshold = GENERICREQUEST_CACHE_THRESHOLD;
cacheLowerThreshold = GENERICREQUEST_CACHE_LOWER_THRESHOLD;
messages_ -> resize(cacheSlots);
for (T_messages::iterator i = messages_ -> begin();
i < messages_ -> end(); i++)
{
*i = NULL;
}
temporary_ = NULL;
}
GenericRequestStore::~GenericRequestStore()
{
for (T_messages::iterator i = messages_ -> begin();
i < messages_ -> end(); i++)
{
destroy(*i);
}
destroy(temporary_);
}
//
// Here are the methods to handle messages' content.
//
int GenericRequestStore::encodeIdentity(EncodeBuffer &encodeBuffer, const unsigned char *buffer,
const unsigned int size, int bigEndian,
ChannelCache *channelCache) const
{
ClientCache *clientCache = (ClientCache *) channelCache;
#ifdef DEBUG
*logofs << name() << ": Encoding full message identity.\n" << logofs_flush;
#endif
encodeBuffer.encodeValue(size >> 2, 16, 10);
encodeBuffer.encodeCachedValue(*(buffer + 1), 8,
clientCache -> genericRequestOpcodeCache);
for (unsigned int i = 0; i < 8 && (i * 2 + 4) < size; i++)
{
#ifdef DEBUG
*logofs << name() << ": Encoding data[" << i << "] "
<< "at position " << i * 2 + 4 << " with value "
<< GetUINT(buffer + (i * 2) + 4, bigEndian)
<< ".\n" << logofs_flush;
#endif
encodeBuffer.encodeCachedValue(GetUINT(buffer + (i * 2) + 4, bigEndian), 16,
*clientCache -> genericRequestDataCache[i]);
}
#ifdef DEBUG
*logofs << name() << ": Encoded full message identity.\n" << logofs_flush;
#endif
return 1;
}
int GenericRequestStore::decodeIdentity(DecodeBuffer &decodeBuffer, unsigned char *&buffer,
unsigned int &size, int bigEndian, WriteBuffer *writeBuffer,
ChannelCache *channelCache) const
{
ClientCache *clientCache = (ClientCache *) channelCache;
#ifdef DEBUG
*logofs << name() << ": Decoding full message identity.\n" << logofs_flush;
#endif
decodeBuffer.decodeValue(size, 16, 10);
size <<= 2;
buffer = writeBuffer -> addMessage(size);
decodeBuffer.decodeCachedValue(*(buffer + 1), 8,
clientCache -> genericRequestOpcodeCache);
unsigned int value;
for (unsigned int i = 0; i < 8 && (i * 2 + 4) < size; i++)
{
decodeBuffer.decodeCachedValue(value, 16,
*clientCache -> genericRequestDataCache[i]);
#ifdef DEBUG
*logofs << name() << ": Decoding data[" << i << "] "
<< "at position " << i * 2 + 4 << " with value "
<< value << ".\n" << logofs_flush;
#endif
PutUINT(value, buffer + 4 + (i * 2), bigEndian);
}
#ifdef DEBUG
*logofs << name() << ": Decoded full message identity.\n" << logofs_flush;
#endif
return 1;
}
int GenericRequestStore::parseIdentity(Message *message, const unsigned char *buffer,
unsigned int size, int bigEndian) const
{
GenericRequestMessage *genericRequest = (GenericRequestMessage *) message;
genericRequest -> opcode = *(buffer + 1);
for (unsigned int i = 0; i < 8; i++)
{
if ((i * 2 + 4) < size)
{
genericRequest -> data[i] = GetUINT(buffer + i * 2 + 4, bigEndian);
#ifdef DEBUG
*logofs << name() << ": Parsed data[" << i << "] "
<< "with value " << genericRequest -> data[i]
<< ".\n" << logofs_flush;
#endif
}
else
{
genericRequest -> data[i] = 0;
}
}
#ifdef DEBUG
*logofs << name() << ": Parsed identity for message at "
<< this << ".\n" << logofs_flush;
#endif
return 1;
}
int GenericRequestStore::unparseIdentity(const Message *message, unsigned char *buffer,
unsigned int size, int bigEndian) const
{
GenericRequestMessage *genericRequest = (GenericRequestMessage *) message;
*(buffer + 1) = genericRequest -> opcode;
for (unsigned int i = 0; i < 8 && (i * 2 + 4) < size; i++)
{
#ifdef DEBUG
*logofs << name() << ": Unparsed data[" << i << "] "
<< "with value " << genericRequest -> data[i]
<< ".\n" << logofs_flush;
#endif
PutUINT(genericRequest -> data[i], buffer + i * 2 + 4, bigEndian);
}
#ifdef DEBUG
*logofs << name() << ": Unparsed identity for message at "
<< this << ".\n" << logofs_flush;
#endif
return 1;
}
void GenericRequestStore::dumpIdentity(const Message *message) const
{
#ifdef DUMP
GenericRequestMessage *genericRequest = (GenericRequestMessage *) message;
*logofs << name() << ": Identity opcode " << (unsigned) genericRequest -> opcode;
for (int i = 0; i < 8; i++)
{
*logofs << ", data[" << i << "] " << genericRequest -> data[i];
}
*logofs << ", size " << genericRequest -> size_ << ".\n" << logofs_flush;
#endif
}
void GenericRequestStore::identityChecksum(const Message *message, const unsigned char *buffer,
unsigned int size, int bigEndian) const
{
//
// As data offset can be beyond the real end of
// the message, we need to include the message's
// size or we will match any message whose size
// is less or equal to the data offset.
//
md5_append(md5_state_, buffer + 2, 2);
}
void GenericRequestStore::updateIdentity(EncodeBuffer &encodeBuffer, const Message *message,
const Message *cachedMessage,
ChannelCache *channelCache) const
{
//
// Encode the variant part.
//
GenericRequestMessage *genericRequest = (GenericRequestMessage *) message;
GenericRequestMessage *cachedGenericRequest = (GenericRequestMessage *) cachedMessage;
ClientCache *clientCache = (ClientCache *) channelCache;
#ifdef TEST
*logofs << name() << ": Updating value "
<< (unsigned) genericRequest -> opcode
<< " as opcode field.\n" << logofs_flush;
#endif
encodeBuffer.encodeCachedValue((unsigned int) genericRequest -> opcode, 8,
clientCache -> genericRequestOpcodeCache);
cachedGenericRequest -> opcode = genericRequest -> opcode;
for (int i = 0; i < 8 && (i * 2 + 4) < genericRequest -> size_; i++)
{
#ifdef TEST
*logofs << name() << ": Updating data[" << i << "] "
<< "with value " << genericRequest -> data[i]
<< ".\n" << logofs_flush;
#endif
encodeBuffer.encodeCachedValue((unsigned int) genericRequest -> data[i], 16,
*clientCache -> genericRequestDataCache[i]);
cachedGenericRequest -> data[i] = genericRequest -> data[i];
}
}
void GenericRequestStore::updateIdentity(DecodeBuffer &decodeBuffer, const Message *message,
ChannelCache *channelCache) const
{
GenericRequestMessage *genericRequest = (GenericRequestMessage *) message;
ClientCache *clientCache = (ClientCache *) channelCache;
decodeBuffer.decodeCachedValue(genericRequest -> opcode, 8,
clientCache -> genericRequestOpcodeCache);
#ifdef TEST
*logofs << name() << ": Updated value "
<< (unsigned) genericRequest -> opcode
<< " as opcode field.\n" << logofs_flush;
#endif
unsigned int value;
for (int i = 0; i < 8 && (i * 2 + 4) < genericRequest -> size_; i++)
{
decodeBuffer.decodeCachedValue(value, 16,
*clientCache -> genericRequestDataCache[i]);
genericRequest -> data[i] = (unsigned short) value;
#ifdef TEST
*logofs << name() << ": Updated data[" << i << "] "
<< "with value " << genericRequest -> data[i]
<< ".\n" << logofs_flush;
#endif
}
}
|