parser.l and parser.y added to EXTRA_DIST
[public/netxms.git] / include / nxcscpapi.h
CommitLineData
0d9c1b96
VK
1/*
2** NetXMS - Network Management System
3** CSCP API Library
4** Copyright (C) 2003, 2004 Victor Kirhenshtein
5**
6** This program is free software; you can redistribute it and/or modify
7** it under the terms of the GNU General Public License as published by
8** the Free Software Foundation; either version 2 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 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** $module: nxcscpapi.h
21**
22**/
23
24#ifndef _nxcscpapi_h_
25#define _nxcscpapi_h_
26
b50f1100
VK
27#include <nms_threads.h>
28
0d9c1b96
VK
29
30#ifdef _WIN32
31#ifdef LIBNXCSCP_EXPORTS
32#define LIBNXCSCP_EXPORTABLE __declspec(dllexport)
33#else
34#define LIBNXCSCP_EXPORTABLE __declspec(dllimport)
35#endif
36#else /* _WIN32 */
37#define LIBNXCSCP_EXPORTABLE
38#endif
39
40
8c290af0
VK
41//
42// Encryption methods
43//
44
45#define CSCP_ENCRYPTION_NONE 0
46#define CSCP_ENCRYPTION_BLOWFISH_SHA1 1
47
48
0d9c1b96
VK
49//
50// Temporary buffer structure for RecvCSCPMessage() function
51//
52
53typedef struct
54{
55 DWORD dwBufSize;
56 DWORD dwBufPos;
57 char szBuffer[CSCP_TEMP_BUF_SIZE];
58} CSCP_BUFFER;
59
60
61//
62// Class for holding CSCP messages
63//
64
65class LIBNXCSCP_EXPORTABLE CSCPMessage
66{
67private:
68 WORD m_wCode;
23b8cd4f 69 WORD m_wFlags;
0d9c1b96
VK
70 DWORD m_dwId;
71 DWORD m_dwNumVar; // Number of variables
72 CSCP_DF **m_ppVarList; // List of variables
73
a7d07192 74 void *Set(DWORD dwVarId, BYTE bType, void *pValue, DWORD dwSize = 0);
0d9c1b96
VK
75 void *Get(DWORD dwVarId, BYTE bType);
76 DWORD FindVariable(DWORD dwVarId);
77
78public:
79 CSCPMessage();
80 CSCPMessage(CSCP_MESSAGE *pMsg);
81 ~CSCPMessage();
82
83 CSCP_MESSAGE *CreateMessage(void);
84
85 WORD GetCode(void) { return m_wCode; }
86 void SetCode(WORD wCode) { m_wCode = wCode; }
87
88 DWORD GetId(void) { return m_dwId; }
89 void SetId(DWORD dwId) { m_dwId = dwId; }
90
91 BOOL IsVariableExist(DWORD dwVarId) { return (FindVariable(dwVarId) != INVALID_INDEX) ? TRUE : FALSE; }
23b8cd4f 92 BOOL IsEndOfSequence(void) { return (m_wFlags & MF_END_OF_SEQUENCE) ? TRUE : FALSE; }
0d9c1b96 93
42d7ed00
VK
94 void SetVariable(DWORD dwVarId, WORD wValue) { Set(dwVarId, CSCP_DT_INT16, &wValue); }
95 void SetVariable(DWORD dwVarId, DWORD dwValue) { Set(dwVarId, CSCP_DT_INTEGER, &dwValue); }
96 void SetVariable(DWORD dwVarId, QWORD qwValue) { Set(dwVarId, CSCP_DT_INT64, &qwValue); }
97 void SetVariable(DWORD dwVarId, double dValue) { Set(dwVarId, CSCP_DT_FLOAT, &dValue); }
cb27dff1 98 void SetVariable(DWORD dwVarId, TCHAR *pszValue) { Set(dwVarId, CSCP_DT_STRING, pszValue); }
42d7ed00 99 void SetVariable(DWORD dwVarId, BYTE *pValue, DWORD dwSize) { Set(dwVarId, CSCP_DT_BINARY, pValue, dwSize); }
a7d07192 100 void SetVariableToInt32Array(DWORD dwVarId, DWORD dwNumElements, DWORD *pdwData);
cb27dff1 101 BOOL SetVariableFromFile(DWORD dwVarId, TCHAR *pszFileName);
0d9c1b96
VK
102
103 DWORD GetVariableLong(DWORD dwVarId);
104 QWORD GetVariableInt64(DWORD dwVarId);
105 WORD GetVariableShort(DWORD dwVarId);
f86ffdd2 106 double GetVariableDouble(DWORD dwVarId);
4332e9d8 107 TCHAR *GetVariableStr(DWORD dwVarId, TCHAR *szBuffer = NULL, DWORD dwBufSize = 0);
0d9c1b96 108 DWORD GetVariableBinary(DWORD dwVarId, BYTE *pBuffer, DWORD dwBufSize);
a7d07192 109 DWORD GetVariableInt32Array(DWORD dwVarId, DWORD dwNumElements, DWORD *pdwBuffer);
0d9c1b96
VK
110
111 void DeleteAllVariables(void);
e44ac467 112
23b8cd4f
VK
113 void DisableEncryption(void) { m_wFlags |= MF_DONT_ENCRYPT; }
114 void SetEndOfSequence(void) { m_wFlags |= MF_END_OF_SEQUENCE; }
0d9c1b96
VK
115};
116
117
deaa4491
VK
118//
119// Message waiting queue element structure
120//
121
122typedef struct
123{
124 WORD wCode; // Message code
125 WORD wIsBinary; // 1 for binary (raw) messages
126 DWORD dwId; // Message ID
127 DWORD dwTTL; // Message time-to-live in milliseconds
128 void *pMsg; // Pointer to message, either to CSCPMessage object or raw message
129} WAIT_QUEUE_ELEMENT;
130
131
132//
133// Message waiting queue class
134//
135
136class LIBNXCSCP_EXPORTABLE MsgWaitQueue
137{
deaa4491 138private:
5f743326
VK
139 MUTEX m_mutexDataAccess;
140 CONDITION m_condStop;
141 CONDITION m_condNewMsg;
deaa4491
VK
142 DWORD m_dwMsgHoldTime;
143 DWORD m_dwNumElements;
144 WAIT_QUEUE_ELEMENT *m_pElements;
ccdbbb52 145 THREAD m_hHkThread;
deaa4491 146
5f743326
VK
147 void Lock(void) { MutexLock(m_mutexDataAccess, INFINITE); }
148 void Unlock(void) { MutexUnlock(m_mutexDataAccess); }
deaa4491
VK
149 void HousekeeperThread(void);
150 void *WaitForMessageInternal(WORD wIsBinary, WORD wCode, DWORD dwId, DWORD dwTimeOut);
1ba9a162 151
ccdbbb52 152 static THREAD_RESULT THREAD_CALL MWQThreadStarter(void *);
deaa4491
VK
153
154public:
155 MsgWaitQueue();
156 ~MsgWaitQueue();
157
158 void Put(CSCPMessage *pMsg);
159 void Put(CSCP_MESSAGE *pMsg);
160 CSCPMessage *WaitForMessage(WORD wCode, DWORD dwId, DWORD dwTimeOut)
161 {
162 return (CSCPMessage *)WaitForMessageInternal(0, wCode, dwId, dwTimeOut);
163 }
164 CSCP_MESSAGE *WaitForRawMessage(WORD wCode, DWORD dwId, DWORD dwTimeOut)
165 {
166 return (CSCP_MESSAGE *)WaitForMessageInternal(1, wCode, dwId, dwTimeOut);
167 }
168
169 void Clear(void);
170 void SetHoldTime(DWORD dwHoldTime) { m_dwMsgHoldTime = dwHoldTime; }
171};
172
173
0d9c1b96
VK
174//
175// Functions
176//
177
178#ifdef __cplusplus
179extern "C" {
180#endif
181
e44ac467
VK
182int LIBNXCSCP_EXPORTABLE RecvCSCPMessage(SOCKET hSocket, CSCP_MESSAGE *pMsg,
183 CSCP_BUFFER *pBuffer, DWORD dwMaxMsgSize,
1ba3c17a 184 CSCP_ENCRYPTION_CONTEXT **ppCtx,
e44ac467 185 BYTE *pDecryptionBuffer);
b9b4ec17
VK
186CSCP_MESSAGE LIBNXCSCP_EXPORTABLE *CreateRawCSCPMessage(WORD wCode, DWORD dwId,
187 DWORD dwDataSize, void *pData,
0d9c1b96 188 CSCP_MESSAGE *pBuffer);
4332e9d8 189TCHAR LIBNXCSCP_EXPORTABLE *CSCPMessageCodeName(WORD wCode, TCHAR *pszBuffer);
1ba3c17a
VK
190BOOL LIBNXCSCP_EXPORTABLE SendFileOverCSCP(SOCKET hSocket, DWORD dwId, TCHAR *pszFile,
191 CSCP_ENCRYPTION_CONTEXT *pCtx);
0d9c1b96 192
e44ac467 193BOOL LIBNXCSCP_EXPORTABLE InitCryptoLib(DWORD dwEnabledCiphers);
c14b66ca 194DWORD LIBNXCSCP_EXPORTABLE CSCPGetSupportedCiphers(void);
e44ac467
VK
195CSCP_ENCRYPTED_MESSAGE LIBNXCSCP_EXPORTABLE
196 *CSCPEncryptMessage(CSCP_ENCRYPTION_CONTEXT *pCtx, CSCP_MESSAGE *pMsg);
197BOOL LIBNXCSCP_EXPORTABLE CSCPDecryptMessage(CSCP_ENCRYPTION_CONTEXT *pCtx,
198 CSCP_ENCRYPTED_MESSAGE *pMsg,
199 BYTE *pDecryptionBuffer);
200DWORD LIBNXCSCP_EXPORTABLE SetupEncryptionContext(CSCPMessage *pMsg,
201 CSCP_ENCRYPTION_CONTEXT **ppCtx,
1a17feb0 202 CSCPMessage **ppResponse,
e44ac467
VK
203 RSA *pPrivateKey);
204void LIBNXCSCP_EXPORTABLE DestroyEncryptionContext(CSCP_ENCRYPTION_CONTEXT *pCtx);
205void LIBNXCSCP_EXPORTABLE PrepareKeyRequestMsg(CSCPMessage *pMsg, RSA *pServerKey);
206RSA LIBNXCSCP_EXPORTABLE *LoadRSAKeys(TCHAR *pszKeyFile);
15cf5acc 207
0d9c1b96
VK
208#ifdef __cplusplus
209}
210#endif
211
212#endif /* _nxcscpapi_h_ */