ua_server_binary.c 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. #include "ua_util.h"
  2. #include "ua_server_internal.h"
  3. #include "ua_types_encoding_binary.h"
  4. #include "ua_transport_generated.h"
  5. #include "ua_services.h"
  6. #include "ua_statuscodes.h"
  7. #include "ua_securechannel_manager.h"
  8. #include "ua_session_manager.h"
  9. #include "ua_nodeids.h"
  10. /** Max size of messages that are allocated on the stack */
  11. #define MAX_STACK_MESSAGE 65536
  12. static UA_StatusCode UA_ByteStringArray_deleteMembers(UA_ByteStringArray *stringarray) {
  13. if(!stringarray)
  14. return UA_STATUSCODE_BADINTERNALERROR;
  15. for(UA_UInt32 i = 0; i < stringarray->stringsSize; i++)
  16. UA_String_deleteMembers(&stringarray->strings[i]);
  17. return UA_STATUSCODE_GOOD;
  18. }
  19. static void processHEL(UA_Connection *connection, const UA_ByteString *msg, size_t *pos) {
  20. UA_TcpHelloMessage helloMessage;
  21. if(UA_TcpHelloMessage_decodeBinary(msg, pos, &helloMessage) != UA_STATUSCODE_GOOD) {
  22. connection->close(connection);
  23. return;
  24. }
  25. connection->remoteConf.maxChunkCount = helloMessage.maxChunkCount;
  26. connection->remoteConf.maxMessageSize = helloMessage.maxMessageSize;
  27. connection->remoteConf.protocolVersion = helloMessage.protocolVersion;
  28. connection->remoteConf.recvBufferSize = helloMessage.receiveBufferSize;
  29. connection->remoteConf.sendBufferSize = helloMessage.sendBufferSize;
  30. connection->state = UA_CONNECTION_ESTABLISHED;
  31. // build acknowledge response
  32. UA_TcpAcknowledgeMessage ackMessage;
  33. ackMessage.protocolVersion = connection->localConf.protocolVersion;
  34. ackMessage.receiveBufferSize = connection->localConf.recvBufferSize;
  35. ackMessage.sendBufferSize = connection->localConf.sendBufferSize;
  36. ackMessage.maxMessageSize = connection->localConf.maxMessageSize;
  37. ackMessage.maxChunkCount = connection->localConf.maxChunkCount;
  38. UA_TcpMessageHeader ackHeader;
  39. ackHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_ACKF;
  40. ackHeader.messageSize = UA_TcpAcknowledgeMessage_calcSizeBinary(&ackMessage) +
  41. UA_TcpMessageHeader_calcSizeBinary(&ackHeader);
  42. // The message is on the stack. That's ok since ack is very small.
  43. UA_ByteString ack_msg = (UA_ByteString){ .length = ackHeader.messageSize,
  44. .data = UA_alloca(ackHeader.messageSize) };
  45. size_t tmpPos = 0;
  46. UA_TcpMessageHeader_encodeBinary(&ackHeader, &ack_msg, &tmpPos);
  47. UA_TcpAcknowledgeMessage_encodeBinary(&ackMessage, &ack_msg, &tmpPos);
  48. UA_ByteStringArray answer_buf = { .stringsSize = 1, .strings = &ack_msg };
  49. connection->write(connection, answer_buf);
  50. UA_TcpHelloMessage_deleteMembers(&helloMessage);
  51. }
  52. static void processOPN(UA_Connection *connection, UA_Server *server, const UA_ByteString *msg,
  53. size_t *pos) {
  54. if(connection->state != UA_CONNECTION_ESTABLISHED) {
  55. connection->close(connection);
  56. return;
  57. }
  58. UA_UInt32 secureChannelId;
  59. UA_StatusCode retval = UA_UInt32_decodeBinary(msg, pos, &secureChannelId);
  60. UA_AsymmetricAlgorithmSecurityHeader asymHeader;
  61. retval |= UA_AsymmetricAlgorithmSecurityHeader_decodeBinary(msg, pos, &asymHeader);
  62. UA_SequenceHeader seqHeader;
  63. retval |= UA_SequenceHeader_decodeBinary(msg, pos, &seqHeader);
  64. UA_NodeId requestType;
  65. retval |= UA_NodeId_decodeBinary(msg, pos, &requestType);
  66. UA_OpenSecureChannelRequest r;
  67. retval |= UA_OpenSecureChannelRequest_decodeBinary(msg, pos, &r);
  68. if(retval != UA_STATUSCODE_GOOD || requestType.identifier.numeric != 446) {
  69. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  70. UA_SequenceHeader_deleteMembers(&seqHeader);
  71. UA_NodeId_deleteMembers(&requestType);
  72. UA_OpenSecureChannelRequest_deleteMembers(&r);
  73. connection->close(connection);
  74. return;
  75. }
  76. UA_OpenSecureChannelResponse p;
  77. UA_OpenSecureChannelResponse_init(&p);
  78. Service_OpenSecureChannel(server, connection, &r, &p);
  79. UA_SecureConversationMessageHeader respHeader;
  80. respHeader.messageHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_OPNF;
  81. respHeader.messageHeader.messageSize = 0;
  82. respHeader.secureChannelId = p.securityToken.channelId;
  83. UA_NodeId responseType = UA_NODEID_NUMERIC(0, UA_NS0ID_OPENSECURECHANNELRESPONSE +
  84. UA_ENCODINGOFFSET_BINARY);
  85. respHeader.messageHeader.messageSize =
  86. UA_SecureConversationMessageHeader_calcSizeBinary(&respHeader)
  87. + UA_AsymmetricAlgorithmSecurityHeader_calcSizeBinary(&asymHeader)
  88. + UA_SequenceHeader_calcSizeBinary(&seqHeader)
  89. + UA_NodeId_calcSizeBinary(&responseType)
  90. + UA_OpenSecureChannelResponse_calcSizeBinary(&p);
  91. UA_ByteString resp_msg = (UA_ByteString){
  92. .length = respHeader.messageHeader.messageSize,
  93. .data = UA_alloca(respHeader.messageHeader.messageSize)
  94. };
  95. size_t tmpPos = 0;
  96. UA_SecureConversationMessageHeader_encodeBinary(&respHeader, &resp_msg, &tmpPos);
  97. UA_AsymmetricAlgorithmSecurityHeader_encodeBinary(&asymHeader, &resp_msg, &tmpPos); // just mirror back
  98. UA_SequenceHeader_encodeBinary(&seqHeader, &resp_msg, &tmpPos); // just mirror back
  99. UA_NodeId_encodeBinary(&responseType, &resp_msg, &tmpPos);
  100. UA_OpenSecureChannelResponse_encodeBinary(&p, &resp_msg, &tmpPos);
  101. UA_OpenSecureChannelRequest_deleteMembers(&r);
  102. UA_OpenSecureChannelResponse_deleteMembers(&p);
  103. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  104. connection->write(connection, (UA_ByteStringArray){ .stringsSize = 1, .strings = &resp_msg });
  105. }
  106. static void init_response_header(const UA_RequestHeader *p, UA_ResponseHeader *r) {
  107. r->requestHandle = p->requestHandle;
  108. r->stringTableSize = 0;
  109. r->timestamp = UA_DateTime_now();
  110. }
  111. #define INVOKE_SERVICE(TYPE) do { \
  112. UA_##TYPE##Request p; \
  113. UA_##TYPE##Response r; \
  114. if(UA_##TYPE##Request_decodeBinary(msg, pos, &p)) \
  115. return; \
  116. if(clientChannel->session && \
  117. UA_NodeId_equal(&clientChannel->session->authenticationToken, \
  118. &p.requestHeader.authenticationToken)) \
  119. clientSession = clientChannel->session; \
  120. UA_##TYPE##Response_init(&r); \
  121. init_response_header(&p.requestHeader, &r.responseHeader); \
  122. if(!clientSession) \
  123. r.responseHeader.serviceResult = UA_STATUSCODE_BADSESSIONNOTACTIVATED; \
  124. else \
  125. Service_##TYPE(server, clientSession, &p, &r); \
  126. connection->getBuffer(connection, message, UA_##TYPE##Response_calcSizeBinary(&r)); \
  127. UA_##TYPE##Response_encodeBinary(&r, message, &sendOffset); \
  128. UA_##TYPE##Request_deleteMembers(&p); \
  129. UA_##TYPE##Response_deleteMembers(&r); \
  130. responseType = requestType.identifier.numeric + 3; \
  131. } while(0)
  132. static void processMSG(UA_Connection *connection, UA_Server *server, const UA_ByteString *msg, size_t *pos) {
  133. // 1) Read in the securechannel
  134. UA_UInt32 secureChannelId;
  135. UA_StatusCode retval = UA_UInt32_decodeBinary(msg, pos, &secureChannelId);
  136. if(retval != UA_STATUSCODE_GOOD)
  137. return;
  138. UA_SecureChannel *clientChannel = connection->channel;
  139. #ifdef EXTENSION_STATELESS
  140. UA_SecureChannel anonymousChannel;
  141. if(!clientChannel) {
  142. UA_SecureChannel_init(&anonymousChannel);
  143. clientChannel = &anonymousChannel;
  144. }
  145. #endif
  146. // 2) Read the security header
  147. UA_UInt32 tokenId;
  148. UA_SequenceHeader sequenceHeader;
  149. retval = UA_UInt32_decodeBinary(msg, pos, &tokenId);
  150. retval |= UA_SequenceHeader_decodeBinary(msg, pos, &sequenceHeader);
  151. if(retval != UA_STATUSCODE_GOOD)
  152. return;
  153. //UA_SecureChannel_checkSequenceNumber(channel,sequenceHeader.sequenceNumber);
  154. //UA_SecureChannel_checkRequestId(channel,sequenceHeader.requestId);
  155. clientChannel->sequenceNumber = sequenceHeader.sequenceNumber;
  156. clientChannel->requestId = sequenceHeader.requestId;
  157. UA_Session *clientSession = UA_NULL;
  158. #ifdef EXTENSION_STATELESS
  159. if(clientChannel == &anonymousChannel)
  160. clientSession = &anonymousSession;
  161. #endif
  162. // 3) Read the nodeid of the request
  163. UA_NodeId requestType;
  164. if(UA_NodeId_decodeBinary(msg, pos, &requestType))
  165. return;
  166. if(requestType.identifierType != UA_NODEIDTYPE_NUMERIC) {
  167. // That must not happen. The requestType does not have to be deleted at the end.
  168. UA_NodeId_deleteMembers(&requestType);
  169. return;
  170. }
  171. // 4) process the request
  172. UA_ByteString responseBufs[2]; // 0->header, 1->response payload
  173. UA_UInt32 responseType;
  174. UA_ByteString *header = &responseBufs[0];
  175. UA_ByteString *message = &responseBufs[1];
  176. size_t sendOffset = 0;
  177. //subtract UA_ENCODINGOFFSET_BINARY for binary encoding, if retval is set, this forces the default path
  178. switch(requestType.identifier.numeric - UA_ENCODINGOFFSET_BINARY + retval) {
  179. case UA_NS0ID_GETENDPOINTSREQUEST: {
  180. UA_GetEndpointsRequest p;
  181. UA_GetEndpointsResponse r;
  182. if(UA_GetEndpointsRequest_decodeBinary(msg, pos, &p))
  183. return;
  184. UA_GetEndpointsResponse_init(&r);
  185. init_response_header(&p.requestHeader, &r.responseHeader);
  186. Service_GetEndpoints(server, &p, &r);
  187. connection->getBuffer(connection, message, UA_GetEndpointsResponse_calcSizeBinary(&r));
  188. UA_GetEndpointsResponse_encodeBinary(&r, message, &sendOffset);
  189. UA_GetEndpointsRequest_deleteMembers(&p);
  190. UA_GetEndpointsResponse_deleteMembers(&r);
  191. responseType = requestType.identifier.numeric + 3;
  192. break;
  193. }
  194. case UA_NS0ID_FINDSERVERSREQUEST: {
  195. UA_FindServersRequest p;
  196. UA_FindServersResponse r;
  197. if(UA_FindServersRequest_decodeBinary(msg, pos, &p))
  198. return;
  199. UA_FindServersResponse_init(&r);
  200. init_response_header(&p.requestHeader, &r.responseHeader);
  201. Service_FindServers(server, &p, &r);
  202. connection->getBuffer(connection, message, UA_FindServersResponse_calcSizeBinary(&r));
  203. UA_FindServersResponse_encodeBinary(&r, message, &sendOffset);
  204. UA_FindServersRequest_deleteMembers(&p);
  205. UA_FindServersResponse_deleteMembers(&r);
  206. responseType = requestType.identifier.numeric + 3;
  207. break;
  208. }
  209. case UA_NS0ID_CREATESESSIONREQUEST: {
  210. UA_CreateSessionRequest p;
  211. UA_CreateSessionResponse r;
  212. if(UA_CreateSessionRequest_decodeBinary(msg, pos, &p))
  213. return;
  214. UA_CreateSessionResponse_init(&r);
  215. init_response_header(&p.requestHeader, &r.responseHeader);
  216. Service_CreateSession(server, clientChannel, &p, &r);
  217. connection->getBuffer(connection, message, UA_CreateSessionResponse_calcSizeBinary(&r));
  218. UA_CreateSessionResponse_encodeBinary(&r, message, &sendOffset);
  219. UA_CreateSessionRequest_deleteMembers(&p);
  220. UA_CreateSessionResponse_deleteMembers(&r);
  221. responseType = requestType.identifier.numeric + 3;
  222. break;
  223. }
  224. case UA_NS0ID_ACTIVATESESSIONREQUEST: {
  225. UA_ActivateSessionRequest p;
  226. UA_ActivateSessionResponse r;
  227. if(UA_ActivateSessionRequest_decodeBinary(msg, pos, &p))
  228. return;
  229. UA_ActivateSessionResponse_init(&r);
  230. init_response_header(&p.requestHeader, &r.responseHeader);
  231. Service_ActivateSession(server, clientChannel, &p, &r);
  232. connection->getBuffer(connection, message, UA_ActivateSessionResponse_calcSizeBinary(&r));
  233. UA_ActivateSessionResponse_encodeBinary(&r, message, &sendOffset);
  234. UA_ActivateSessionRequest_deleteMembers(&p);
  235. UA_ActivateSessionResponse_deleteMembers(&r);
  236. responseType = requestType.identifier.numeric + 3;
  237. break;
  238. }
  239. case UA_NS0ID_CLOSESESSIONREQUEST:
  240. INVOKE_SERVICE(CloseSession);
  241. break;
  242. case UA_NS0ID_READREQUEST:
  243. INVOKE_SERVICE(Read);
  244. break;
  245. case UA_NS0ID_WRITEREQUEST:
  246. INVOKE_SERVICE(Write);
  247. break;
  248. case UA_NS0ID_BROWSEREQUEST:
  249. INVOKE_SERVICE(Browse);
  250. break;
  251. case UA_NS0ID_BROWSENEXTREQUEST:
  252. INVOKE_SERVICE(BrowseNext);
  253. break;
  254. case UA_NS0ID_ADDREFERENCESREQUEST:
  255. INVOKE_SERVICE(AddReferences);
  256. break;
  257. case UA_NS0ID_REGISTERNODESREQUEST:
  258. INVOKE_SERVICE(RegisterNodes);
  259. break;
  260. case UA_NS0ID_UNREGISTERNODESREQUEST:
  261. INVOKE_SERVICE(UnregisterNodes);
  262. break;
  263. case UA_NS0ID_TRANSLATEBROWSEPATHSTONODEIDSREQUEST:
  264. INVOKE_SERVICE(TranslateBrowsePathsToNodeIds);
  265. break;
  266. default: {
  267. UA_LOG_INFO(server->logger, UA_LOGGERCATEGORY_COMMUNICATION, "Unknown request: NodeId(ns=%d, i=%d)",
  268. requestType.namespaceIndex, requestType.identifier.numeric);
  269. UA_RequestHeader p;
  270. UA_ResponseHeader r;
  271. if(UA_RequestHeader_decodeBinary(msg, pos, &p) != UA_STATUSCODE_GOOD)
  272. return;
  273. UA_ResponseHeader_init(&r);
  274. init_response_header(&p, &r);
  275. r.serviceResult = UA_STATUSCODE_BADSERVICEUNSUPPORTED;
  276. #ifdef EXTENSION_STATELESS
  277. if(retval != UA_STATUSCODE_GOOD)
  278. r.serviceResult = retval;
  279. #endif
  280. connection->getBuffer(connection, message, UA_ResponseHeader_calcSizeBinary(&r));
  281. UA_ResponseHeader_encodeBinary(&r, message, &sendOffset);
  282. UA_RequestHeader_deleteMembers(&p);
  283. UA_ResponseHeader_deleteMembers(&r);
  284. responseType = UA_NS0ID_RESPONSEHEADER + UA_ENCODINGOFFSET_BINARY;
  285. break;
  286. }
  287. }
  288. // 5) Build the header
  289. UA_SecureConversationMessageHeader respHeader;
  290. respHeader.messageHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_MSGF;
  291. respHeader.messageHeader.messageSize = 0;
  292. respHeader.secureChannelId = clientChannel->securityToken.channelId;
  293. UA_SymmetricAlgorithmSecurityHeader symSecHeader;
  294. symSecHeader.tokenId = clientChannel->securityToken.tokenId;
  295. UA_SequenceHeader seqHeader;
  296. seqHeader.sequenceNumber = clientChannel->sequenceNumber;
  297. seqHeader.requestId = clientChannel->requestId;
  298. UA_NodeId response_nodeid = { .namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC,
  299. .identifier.numeric = responseType };
  300. UA_UInt32 headerSize =
  301. UA_SecureConversationMessageHeader_calcSizeBinary(&respHeader)
  302. + UA_SymmetricAlgorithmSecurityHeader_calcSizeBinary(&symSecHeader)
  303. + UA_SequenceHeader_calcSizeBinary(&seqHeader)
  304. + UA_NodeId_calcSizeBinary(&response_nodeid);
  305. respHeader.messageHeader.messageSize = headerSize + message->length;
  306. size_t rpos = 0;
  307. connection->getBuffer(connection, header, headerSize);
  308. UA_SecureConversationMessageHeader_encodeBinary(&respHeader, header, &rpos);
  309. UA_SymmetricAlgorithmSecurityHeader_encodeBinary(&symSecHeader, header, &rpos);
  310. UA_SequenceHeader_encodeBinary(&seqHeader, header, &rpos);
  311. UA_NodeId_encodeBinary(&response_nodeid, header, &rpos);
  312. // todo: sign & encrypt
  313. // 6) Send it over the wire.
  314. UA_ByteStringArray responseBufArray;
  315. responseBufArray.strings = responseBufs;
  316. responseBufArray.stringsSize = 2;
  317. connection->write(connection, responseBufArray);
  318. connection->releaseBuffer(connection, header);
  319. connection->releaseBuffer(connection, message);
  320. }
  321. static void processCLO(UA_Connection *connection, UA_Server *server, const UA_ByteString *msg, size_t *pos) {
  322. UA_UInt32 secureChannelId;
  323. UA_StatusCode retval = UA_UInt32_decodeBinary(msg, pos, &secureChannelId);
  324. if(retval != UA_STATUSCODE_GOOD || !connection->channel ||
  325. connection->channel->securityToken.channelId != secureChannelId)
  326. return;
  327. Service_CloseSecureChannel(server, secureChannelId);
  328. }
  329. void UA_Server_processBinaryMessage(UA_Server *server, UA_Connection *connection, UA_ByteString *msg) {
  330. if(msg->length <= 0)
  331. return;
  332. size_t pos = 0;
  333. UA_TcpMessageHeader tcpMessageHeader;
  334. do {
  335. if(UA_TcpMessageHeader_decodeBinary(msg, &pos, &tcpMessageHeader) != UA_STATUSCODE_GOOD) {
  336. UA_LOG_INFO(server->logger, UA_LOGGERCATEGORY_COMMUNICATION, "Decoding of message header failed");
  337. connection->close(connection);
  338. break;
  339. }
  340. size_t targetpos = pos - 8 + tcpMessageHeader.messageSize;
  341. switch(tcpMessageHeader.messageTypeAndFinal & 0xffffff) {
  342. case UA_MESSAGETYPEANDFINAL_HELF & 0xffffff:
  343. processHEL(connection, msg, &pos);
  344. break;
  345. case UA_MESSAGETYPEANDFINAL_OPNF & 0xffffff:
  346. processOPN(connection, server, msg, &pos);
  347. break;
  348. case UA_MESSAGETYPEANDFINAL_MSGF & 0xffffff:
  349. #ifdef EXTENSION_STATELESS
  350. processMSG(connection, server, msg, &pos);
  351. break;
  352. #endif
  353. if(connection->state != UA_CONNECTION_ESTABLISHED) {
  354. connection->close(connection);
  355. break;
  356. }
  357. processMSG(connection, server, msg, &pos);
  358. break;
  359. case UA_MESSAGETYPEANDFINAL_CLOF & 0xffffff:
  360. processCLO(connection, server, msg, &pos);
  361. connection->close(connection);
  362. return;
  363. }
  364. UA_TcpMessageHeader_deleteMembers(&tcpMessageHeader);
  365. if(pos != targetpos) {
  366. UA_LOG_INFO(server->logger, UA_LOGGERCATEGORY_COMMUNICATION,
  367. "The message was not entirely processed, skipping to the end");
  368. pos = targetpos;
  369. }
  370. } while(msg->length > (UA_Int32)pos);
  371. }