0d85646c0a8dd06d80a5f6c4c50b27588ca61447
[public/netxms.git] / include / nxcpapi.h
1 /*
2 ** NetXMS - Network Management System
3 ** NXCP API
4 ** Copyright (C) 2003-2010 Victor Kirhenshtein
5 **
6 ** This program is free software; you can redistribute it and/or modify
7 ** it under the terms of the GNU Lesser General Public License as published by
8 ** the Free Software Foundation; either version 3 of the License, or
9 ** (at your option) any later version.
10 **
11 ** This program is distributed in the hope that it will be useful,
12 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ** GNU General Public License for more details.
15 **
16 ** You should have received a copy of the GNU Lesser General Public License
17 ** along with this program; if not, write to the Free Software
18 ** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 **
20 ** File: nxcpapi.h
21 **
22 **/
23
24 #ifndef _nxcpapi_h_
25 #define _nxcpapi_h_
26
27 #include <nms_util.h>
28 #include <nms_threads.h>
29
30 #ifdef _WIN32
31 #include <wincrypt.h>
32 #endif
33
34 /**
35 * Temporary buffer structure for RecvNXCPMessage() function
36 */
37 typedef struct
38 {
39 UINT32 bufferSize;
40 UINT32 bufferPos;
41 char buffer[NXCP_TEMP_BUF_SIZE];
42 } NXCP_BUFFER;
43
44
45 #ifdef __cplusplus
46
47 struct MessageField;
48
49 /**
50 * Parsed NXCP message
51 */
52 class LIBNETXMS_EXPORTABLE NXCPMessage
53 {
54 private:
55 UINT16 m_code;
56 UINT16 m_flags;
57 UINT32 m_id;
58 MessageField *m_fields; // Message fields
59 int m_version; // Protocol version
60 BYTE *m_data; // binary data
61 size_t m_dataSize; // binary data size
62
63 void *set(UINT32 fieldId, BYTE type, const void *value, bool isSigned = false, size_t size = 0);
64 void *get(UINT32 fieldId, BYTE requiredType, BYTE *fieldType = NULL);
65 NXCP_MESSAGE_FIELD *find(UINT32 fieldId);
66
67 public:
68 NXCPMessage(int version = NXCP_VERSION);
69 NXCPMessage(NXCPMessage *msg);
70 NXCPMessage(NXCP_MESSAGE *rawMag, int version = NXCP_VERSION);
71 ~NXCPMessage();
72
73 NXCP_MESSAGE *createMessage();
74
75 UINT16 getCode() { return m_code; }
76 void setCode(UINT16 code) { m_code = code; }
77
78 UINT32 getId() { return m_id; }
79 void setId(UINT32 id) { m_id = id; }
80
81 bool isEndOfFile() { return (m_flags & MF_END_OF_FILE) ? true : false; }
82 bool isEndOfSequence() { return (m_flags & MF_END_OF_SEQUENCE) ? true : false; }
83 bool isReverseOrder() { return (m_flags & MF_REVERSE_ORDER) ? true : false; }
84 bool isBinary() { return (m_flags & MF_BINARY) ? true : false; }
85
86 BYTE *getBinaryData() { return m_data; }
87 size_t getBinaryDataSize() { return m_dataSize; }
88
89 bool isFieldExist(UINT32 fieldId) { return find(fieldId) != NULL; }
90 int getFieldType(UINT32 fieldId);
91
92 void setField(UINT32 fieldId, INT16 value) { set(fieldId, NXCP_DT_INT16, &value, true); }
93 void setField(UINT32 fieldId, UINT16 value) { set(fieldId, NXCP_DT_INT16, &value, false); }
94 void setField(UINT32 fieldId, INT32 value) { set(fieldId, NXCP_DT_INT32, &value, true); }
95 void setField(UINT32 fieldId, UINT32 value) { set(fieldId, NXCP_DT_INT32, &value, false); }
96 void setField(UINT32 fieldId, INT64 value) { set(fieldId, NXCP_DT_INT64, &value, true); }
97 void setField(UINT32 fieldId, UINT64 value) { set(fieldId, NXCP_DT_INT64, &value, false); }
98 void setField(UINT32 fieldId, double value) { set(fieldId, NXCP_DT_FLOAT, &value); }
99 void setField(UINT32 fieldId, const TCHAR *value) { if (value != NULL) set(fieldId, NXCP_DT_STRING, value); }
100 void setField(UINT32 fieldId, const TCHAR *value, size_t maxLen) { if (value != NULL) set(fieldId, NXCP_DT_STRING, value, false, maxLen); }
101 void setField(UINT32 fieldId, BYTE *value, size_t size) { set(fieldId, NXCP_DT_BINARY, value, false, size); }
102 void setField(UINT32 fieldId, const InetAddress &value) { set(fieldId, NXCP_DT_INETADDR, (void *)&value); }
103 #ifdef UNICODE
104 void setFieldFromMBString(UINT32 fieldId, const char *value);
105 #else
106 void setFieldFromMBString(UINT32 fieldId, const char *value) { set(fieldId, NXCP_DT_STRING, value); }
107 #endif
108 void setFieldFromTime(UINT32 fieldId, time_t value) { UINT64 t = (UINT64)value; set(fieldId, NXCP_DT_INT64, &t); }
109 void setFieldFromInt32Array(UINT32 fieldId, size_t numElements, const UINT32 *elements);
110 void setFieldFromInt32Array(UINT32 fieldId, IntegerArray<UINT32> *data);
111 bool setFieldFromFile(UINT32 fieldId, const TCHAR *pszFileName);
112
113 INT16 getFieldAsInt16(UINT32 fieldId);
114 UINT16 getFieldAsUInt16(UINT32 fieldId);
115 INT32 getFieldAsInt32(UINT32 fieldId);
116 UINT32 getFieldAsUInt32(UINT32 fieldId);
117 INT64 getFieldAsInt64(UINT32 fieldId);
118 UINT64 getFieldAsUInt64(UINT32 fieldId);
119 double getFieldAsDouble(UINT32 fieldId);
120 bool getFieldAsBoolean(UINT32 fieldId);
121 time_t getFieldAsTime(UINT32 fieldId);
122 UINT32 getFieldAsInt32Array(UINT32 fieldId, UINT32 numElements, UINT32 *buffer);
123 UINT32 getFieldAsInt32Array(UINT32 fieldId, IntegerArray<UINT32> *data);
124 BYTE *getBinaryFieldPtr(UINT32 fieldId, size_t *size);
125 TCHAR *getFieldAsString(UINT32 fieldId, TCHAR *buffer = NULL, size_t bufferSize = 0);
126 char *getFieldAsMBString(UINT32 fieldId, char *buffer = NULL, size_t bufferSize = 0);
127 char *getFieldAsUtf8String(UINT32 fieldId, char *buffer = NULL, size_t bufferSize = 0);
128 UINT32 getFieldAsBinary(UINT32 fieldId, BYTE *buffer, size_t bufferSize);
129 InetAddress getFieldAsInetAddress(UINT32 fieldId);
130
131 void deleteAllFields();
132
133 void disableEncryption() { m_flags |= MF_DONT_ENCRYPT; }
134 void setEndOfSequence() { m_flags |= MF_END_OF_SEQUENCE; }
135 void setReverseOrderFlag() { m_flags |= MF_REVERSE_ORDER; }
136
137 static String dump(NXCP_MESSAGE *msg, int version);
138 };
139
140 /**
141 * Message waiting queue element structure
142 */
143 typedef struct
144 {
145 void *msg; // Pointer to message, either to NXCPMessage object or raw message
146 UINT64 sequence; // Sequence number
147 UINT32 id; // Message ID
148 UINT32 ttl; // Message time-to-live in milliseconds
149 UINT16 code; // Message code
150 UINT16 isBinary; // 1 for binary (raw) messages
151 } WAIT_QUEUE_ELEMENT;
152
153 /**
154 * Max number of waiting threads in message queue
155 */
156 #define MAX_MSGQUEUE_WAITERS 32
157
158 /**
159 * Message waiting queue class
160 */
161 class LIBNETXMS_EXPORTABLE MsgWaitQueue
162 {
163 private:
164 #ifdef _WIN32
165 CRITICAL_SECTION m_mutex;
166 HANDLE m_wakeupEvents[MAX_MSGQUEUE_WAITERS];
167 BYTE m_waiters[MAX_MSGQUEUE_WAITERS];
168 #else
169 pthread_mutex_t m_mutex;
170 pthread_cond_t m_wakeupCondition;
171 #endif
172 CONDITION m_stopCondition;
173 UINT32 m_holdTime;
174 int m_size;
175 int m_allocated;
176 WAIT_QUEUE_ELEMENT *m_elements;
177 UINT64 m_sequence;
178 THREAD m_hHkThread;
179
180 void housekeeperThread();
181 void *waitForMessageInternal(UINT16 isBinary, UINT16 code, UINT32 id, UINT32 timeout);
182
183 void lock()
184 {
185 #ifdef _WIN32
186 EnterCriticalSection(&m_mutex);
187 #else
188 pthread_mutex_lock(&m_mutex);
189 #endif
190 }
191
192 void unlock()
193 {
194 #ifdef _WIN32
195 LeaveCriticalSection(&m_mutex);
196 #else
197 pthread_mutex_unlock(&m_mutex);
198 #endif
199 }
200
201 static THREAD_RESULT THREAD_CALL mwqThreadStarter(void *);
202
203 public:
204 MsgWaitQueue();
205 ~MsgWaitQueue();
206
207 void put(NXCPMessage *pMsg);
208 void put(NXCP_MESSAGE *pMsg);
209 NXCPMessage *waitForMessage(WORD wCode, UINT32 dwId, UINT32 dwTimeOut)
210 {
211 return (NXCPMessage *)waitForMessageInternal(0, wCode, dwId, dwTimeOut);
212 }
213 NXCP_MESSAGE *waitForRawMessage(WORD wCode, UINT32 dwId, UINT32 dwTimeOut)
214 {
215 return (NXCP_MESSAGE *)waitForMessageInternal(1, wCode, dwId, dwTimeOut);
216 }
217
218 void clear();
219 void setHoldTime(UINT32 holdTime) { m_holdTime = holdTime; }
220 };
221
222 /**
223 * NXCP encryption context
224 */
225 class LIBNETXMS_EXPORTABLE NXCPEncryptionContext : public RefCountObject
226 {
227 private:
228 int m_cipher;
229 BYTE *m_sessionKey;
230 int m_keyLength;
231 BYTE m_iv[EVP_MAX_IV_LENGTH];
232 #ifdef _WITH_ENCRYPTION
233 EVP_CIPHER_CTX m_encryptor;
234 EVP_CIPHER_CTX m_decryptor;
235 MUTEX m_encryptorLock;
236 #endif
237
238 NXCPEncryptionContext();
239 bool initCipher(int cipher);
240
241 public:
242 static NXCPEncryptionContext *create(NXCPMessage *msg, RSA *privateKey);
243 static NXCPEncryptionContext *create(UINT32 ciphers);
244
245 virtual ~NXCPEncryptionContext();
246
247 NXCP_ENCRYPTED_MESSAGE *encryptMessage(NXCP_MESSAGE *msg);
248 bool decryptMessage(NXCP_ENCRYPTED_MESSAGE *msg, BYTE *decryptionBuffer);
249
250 int getCipher() { return m_cipher; }
251 BYTE *getSessionKey() { return m_sessionKey; }
252 int getKeyLength() { return m_keyLength; }
253 BYTE *getIV() { return m_iv; }
254 };
255
256 /**
257 * Message receiver result codes
258 */
259 enum MessageReceiverResult
260 {
261 MSGRECV_SUCCESS = 0,
262 MSGRECV_CLOSED = 1,
263 MSGRECV_TIMEOUT = 2,
264 MSGRECV_COMM_FAILURE = 3,
265 MSGRECV_DECRYPTION_FAILURE = 4
266 };
267
268 /**
269 * Message receiver - abstract base class
270 */
271 class LIBNETXMS_EXPORTABLE AbstractMessageReceiver
272 {
273 private:
274 BYTE *m_buffer;
275 BYTE *m_decryptionBuffer;
276 NXCPEncryptionContext *m_encryptionContext;
277 size_t m_initialSize;
278 size_t m_size;
279 size_t m_maxSize;
280 size_t m_dataSize;
281 size_t m_bytesToSkip;
282
283 NXCPMessage *getMessageFromBuffer();
284
285 protected:
286 virtual int readBytes(BYTE *buffer, size_t size, UINT32 timeout) = 0;
287
288 public:
289 AbstractMessageReceiver(size_t initialSize, size_t maxSize);
290 virtual ~AbstractMessageReceiver();
291
292 void setEncryptionContext(NXCPEncryptionContext *ctx) { m_encryptionContext = ctx; }
293
294 NXCPMessage *readMessage(UINT32 timeout, MessageReceiverResult *result);
295 NXCP_MESSAGE *getRawMessageBuffer() { return (NXCP_MESSAGE *)m_buffer; }
296
297 static const TCHAR *resultToText(MessageReceiverResult result);
298 };
299
300 /**
301 * Message receiver - socket implementation
302 */
303 class LIBNETXMS_EXPORTABLE SocketMessageReceiver : public AbstractMessageReceiver
304 {
305 private:
306 SOCKET m_socket;
307
308 protected:
309 virtual int readBytes(BYTE *buffer, size_t size, UINT32 timeout);
310
311 public:
312 SocketMessageReceiver(SOCKET socket, size_t initialSize, size_t maxSize);
313 virtual ~SocketMessageReceiver();
314 };
315
316 /**
317 * Message receiver - UNIX socket/named pipe implementation
318 */
319 class LIBNETXMS_EXPORTABLE PipeMessageReceiver : public AbstractMessageReceiver
320 {
321 private:
322 HPIPE m_pipe;
323 #ifdef _WIN32
324 HANDLE m_readEvent;
325 #endif
326
327 protected:
328 virtual int readBytes(BYTE *buffer, size_t size, UINT32 timeout);
329
330 public:
331 PipeMessageReceiver(HPIPE pipe, size_t initialSize, size_t maxSize);
332 virtual ~PipeMessageReceiver();
333 };
334
335 /**
336 * NXCP compression methods
337 */
338 enum NXCPCompressionMethod
339 {
340 NXCP_COMPRESSION_NONE = 0,
341 NXCP_COMPRESSION_LZ4 = 1
342 };
343
344 /**
345 * Abstract stream compressor
346 */
347 class LIBNETXMS_EXPORTABLE StreamCompressor
348 {
349 public:
350 virtual size_t compress(const BYTE *in, size_t inSize, BYTE *out, size_t maxOutSize) = 0;
351 virtual size_t decompress(const BYTE *in, size_t inSize, const BYTE **out) = 0;
352 virtual size_t compressBufferSize(size_t dataSize) = 0;
353
354 static StreamCompressor *create(NXCPCompressionMethod method, bool compress, size_t maxBlockSize);
355 };
356
357 /**
358 * Dummy stream compressor
359 */
360 class LIBNETXMS_EXPORTABLE DummyStreamCompressor : public StreamCompressor
361 {
362 public:
363 virtual size_t compress(const BYTE *in, size_t inSize, BYTE *out, size_t maxOutSize);
364 virtual size_t decompress(const BYTE *in, size_t inSize, const BYTE **out);
365 virtual size_t compressBufferSize(size_t dataSize);
366 };
367
368 struct __LZ4_stream_t;
369 struct __LZ4_streamDecode_t;
370
371 /**
372 * LZ4 stream compressor
373 */
374 class LIBNETXMS_EXPORTABLE LZ4StreamCompressor : public StreamCompressor
375 {
376 private:
377 union
378 {
379 __LZ4_stream_t *encoder;
380 __LZ4_streamDecode_t *decoder;
381 } m_stream;
382 char *m_buffer;
383 size_t m_maxBlockSize;
384 size_t m_bufferSize;
385 size_t m_bufferPos;
386 bool m_compress;
387
388 public:
389 LZ4StreamCompressor(bool compress, size_t maxBlockSize);
390 virtual ~LZ4StreamCompressor();
391
392 virtual size_t compress(const BYTE *in, size_t inSize, BYTE *out, size_t maxOutSize);
393 virtual size_t decompress(const BYTE *in, size_t inSize, const BYTE **out);
394 virtual size_t compressBufferSize(size_t dataSize);
395 };
396
397 #else /* __cplusplus */
398
399 typedef void NXCPMessage;
400 typedef void NXCPEncryptionContext;
401
402 #endif
403
404
405 //
406 // Functions
407 //
408
409 #ifdef __cplusplus
410
411 int LIBNETXMS_EXPORTABLE RecvNXCPMessage(SOCKET hSocket, NXCP_MESSAGE *pMsg,
412 NXCP_BUFFER *pBuffer, UINT32 dwMaxMsgSize,
413 NXCPEncryptionContext **ppCtx,
414 BYTE *pDecryptionBuffer, UINT32 dwTimeout);
415 int LIBNETXMS_EXPORTABLE RecvNXCPMessageEx(SOCKET hSocket, NXCP_MESSAGE **msgBuffer,
416 NXCP_BUFFER *nxcpBuffer, UINT32 *bufferSize,
417 NXCPEncryptionContext **ppCtx,
418 BYTE **decryptionBuffer, UINT32 dwTimeout,
419 UINT32 maxMsgSize);
420 NXCP_MESSAGE LIBNETXMS_EXPORTABLE *CreateRawNXCPMessage(WORD wCode, UINT32 dwId, WORD flags,
421 UINT32 dwDataSize, void *pData,
422 NXCP_MESSAGE *pBuffer);
423 TCHAR LIBNETXMS_EXPORTABLE *NXCPMessageCodeName(WORD wCode, TCHAR *buffer);
424 BOOL LIBNETXMS_EXPORTABLE SendFileOverNXCP(SOCKET hSocket, UINT32 dwId, const TCHAR *pszFile,
425 NXCPEncryptionContext *pCtx, long offset,
426 void (* progressCallback)(INT64, void *), void *cbArg,
427 MUTEX mutex, NXCPCompressionMethod compressionMethod = NXCP_COMPRESSION_NONE);
428 BOOL LIBNETXMS_EXPORTABLE NXCPGetPeerProtocolVersion(SOCKET hSocket, int *pnVersion, MUTEX mutex);
429
430 bool LIBNETXMS_EXPORTABLE InitCryptoLib(UINT32 dwEnabledCiphers, void (*debugCallback)(int, const TCHAR *, va_list args));
431 UINT32 LIBNETXMS_EXPORTABLE NXCPGetSupportedCiphers();
432 String LIBNETXMS_EXPORTABLE NXCPGetSupportedCiphersAsText();
433 NXCP_ENCRYPTED_MESSAGE LIBNETXMS_EXPORTABLE *NXCPEncryptMessage(NXCPEncryptionContext *pCtx, NXCP_MESSAGE *pMsg);
434 bool LIBNETXMS_EXPORTABLE NXCPDecryptMessage(NXCPEncryptionContext *pCtx,
435 NXCP_ENCRYPTED_MESSAGE *pMsg,
436 BYTE *pDecryptionBuffer);
437 UINT32 LIBNETXMS_EXPORTABLE SetupEncryptionContext(NXCPMessage *pMsg,
438 NXCPEncryptionContext **ppCtx,
439 NXCPMessage **ppResponse,
440 RSA *pPrivateKey, int nNXCPVersion);
441 void LIBNETXMS_EXPORTABLE PrepareKeyRequestMsg(NXCPMessage *pMsg, RSA *pServerKey, bool useX509Format);
442 RSA LIBNETXMS_EXPORTABLE *LoadRSAKeys(const TCHAR *pszKeyFile);
443
444 #ifdef _WIN32
445 BOOL LIBNETXMS_EXPORTABLE SignMessageWithCAPI(BYTE *pMsg, UINT32 dwMsgLen, const CERT_CONTEXT *pCert,
446 BYTE *pBuffer, size_t bufferSize, UINT32 *pdwSigLen);
447 #endif
448
449 #endif
450
451 #endif /* _nxcpapi_h_ */