ua_server_binary.c 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright 2014-2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2014-2016 (c) Sten Grüner
  7. * Copyright 2014-2015, 2017 (c) Florian Palm
  8. * Copyright 2015-2016 (c) Chris Iatrou
  9. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  10. * Copyright 2016 (c) Joakim L. Gilje
  11. * Copyright 2016-2017 (c) Stefan Profanter, fortiss GmbH
  12. * Copyright 2016 (c) TorbenD
  13. * Copyright 2017 (c) frax2222
  14. * Copyright 2017 (c) Mark Giraud, Fraunhofer IOSB
  15. * Copyright 2019 (c) Kalycito Infotech Private Limited
  16. */
  17. #include <open62541/transport_generated.h>
  18. #include <open62541/transport_generated_encoding_binary.h>
  19. #include <open62541/transport_generated_handling.h>
  20. #include <open62541/types_generated_encoding_binary.h>
  21. #include <open62541/types_generated_handling.h>
  22. #include "ua_securechannel_manager.h"
  23. #include "ua_server_internal.h"
  24. #include "ua_services.h"
  25. #include "ua_session_manager.h"
  26. #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
  27. // store the authentication token and session ID so we can help fuzzing by setting
  28. // these values in the next request automatically
  29. UA_NodeId unsafe_fuzz_authenticationToken = {0, UA_NODEIDTYPE_NUMERIC, {0}};
  30. #endif
  31. #ifdef UA_DEBUG_DUMP_PKGS_FILE
  32. void UA_debug_dumpCompleteChunk(UA_Server *const server, UA_Connection *const connection,
  33. UA_ByteString *messageBuffer);
  34. #endif
  35. /********************/
  36. /* Helper Functions */
  37. /********************/
  38. static UA_StatusCode
  39. sendServiceFaultWithRequest(UA_SecureChannel *channel,
  40. const UA_RequestHeader *requestHeader,
  41. const UA_DataType *responseType,
  42. UA_UInt32 requestId, UA_StatusCode error) {
  43. UA_STACKARRAY(UA_Byte, response, responseType->memSize);
  44. UA_init(response, responseType);
  45. UA_ResponseHeader *responseHeader = (UA_ResponseHeader*)response;
  46. responseHeader->requestHandle = requestHeader->requestHandle;
  47. responseHeader->timestamp = UA_DateTime_now();
  48. responseHeader->serviceResult = error;
  49. /* Send error message. Message type is MSG and not ERR, since we are on a
  50. * SecureChannel! */
  51. UA_StatusCode retval =
  52. UA_SecureChannel_sendSymmetricMessage(channel, requestId, UA_MESSAGETYPE_MSG,
  53. response, responseType);
  54. UA_LOG_DEBUG(channel->securityPolicy->logger, UA_LOGCATEGORY_SERVER,
  55. "Sent ServiceFault with error code %s", UA_StatusCode_name(error));
  56. return retval;
  57. }
  58. /* This is not an ERR message, the connection is not closed afterwards */
  59. static UA_StatusCode
  60. sendServiceFault(UA_SecureChannel *channel, const UA_ByteString *msg,
  61. size_t offset, const UA_DataType *responseType,
  62. UA_UInt32 requestId, UA_StatusCode error) {
  63. UA_RequestHeader requestHeader;
  64. UA_StatusCode retval = UA_RequestHeader_decodeBinary(msg, &offset, &requestHeader);
  65. if(retval != UA_STATUSCODE_GOOD)
  66. return retval;
  67. retval = sendServiceFaultWithRequest(channel, &requestHeader, responseType,
  68. requestId, error);
  69. UA_RequestHeader_clear(&requestHeader);
  70. return retval;
  71. }
  72. static void
  73. getServicePointers(UA_UInt32 requestTypeId, const UA_DataType **requestType,
  74. const UA_DataType **responseType, UA_Service *service,
  75. UA_Boolean *requiresSession) {
  76. switch(requestTypeId) {
  77. case UA_NS0ID_GETENDPOINTSREQUEST_ENCODING_DEFAULTBINARY:
  78. *service = (UA_Service)Service_GetEndpoints;
  79. *requestType = &UA_TYPES[UA_TYPES_GETENDPOINTSREQUEST];
  80. *responseType = &UA_TYPES[UA_TYPES_GETENDPOINTSRESPONSE];
  81. *requiresSession = false;
  82. break;
  83. case UA_NS0ID_FINDSERVERSREQUEST_ENCODING_DEFAULTBINARY:
  84. *service = (UA_Service)Service_FindServers;
  85. *requestType = &UA_TYPES[UA_TYPES_FINDSERVERSREQUEST];
  86. *responseType = &UA_TYPES[UA_TYPES_FINDSERVERSRESPONSE];
  87. *requiresSession = false;
  88. break;
  89. #ifdef UA_ENABLE_DISCOVERY
  90. # ifdef UA_ENABLE_DISCOVERY_MULTICAST
  91. case UA_NS0ID_FINDSERVERSONNETWORKREQUEST_ENCODING_DEFAULTBINARY:
  92. *service = (UA_Service)Service_FindServersOnNetwork;
  93. *requestType = &UA_TYPES[UA_TYPES_FINDSERVERSONNETWORKREQUEST];
  94. *responseType = &UA_TYPES[UA_TYPES_FINDSERVERSONNETWORKRESPONSE];
  95. *requiresSession = false;
  96. break;
  97. # endif
  98. case UA_NS0ID_REGISTERSERVERREQUEST_ENCODING_DEFAULTBINARY:
  99. *service = (UA_Service)Service_RegisterServer;
  100. *requestType = &UA_TYPES[UA_TYPES_REGISTERSERVERREQUEST];
  101. *responseType = &UA_TYPES[UA_TYPES_REGISTERSERVERRESPONSE];
  102. *requiresSession = false;
  103. break;
  104. case UA_NS0ID_REGISTERSERVER2REQUEST_ENCODING_DEFAULTBINARY:
  105. *service = (UA_Service)Service_RegisterServer2;
  106. *requestType = &UA_TYPES[UA_TYPES_REGISTERSERVER2REQUEST];
  107. *responseType = &UA_TYPES[UA_TYPES_REGISTERSERVER2RESPONSE];
  108. *requiresSession = false;
  109. break;
  110. #endif
  111. case UA_NS0ID_CREATESESSIONREQUEST_ENCODING_DEFAULTBINARY:
  112. *service = NULL; //(UA_Service)Service_CreateSession;
  113. *requestType = &UA_TYPES[UA_TYPES_CREATESESSIONREQUEST];
  114. *responseType = &UA_TYPES[UA_TYPES_CREATESESSIONRESPONSE];
  115. *requiresSession = false;
  116. break;
  117. case UA_NS0ID_ACTIVATESESSIONREQUEST_ENCODING_DEFAULTBINARY:
  118. *service = NULL; //(UA_Service)Service_ActivateSession;
  119. *requestType = &UA_TYPES[UA_TYPES_ACTIVATESESSIONREQUEST];
  120. *responseType = &UA_TYPES[UA_TYPES_ACTIVATESESSIONRESPONSE];
  121. break;
  122. case UA_NS0ID_CLOSESESSIONREQUEST_ENCODING_DEFAULTBINARY:
  123. *service = (UA_Service)Service_CloseSession;
  124. *requestType = &UA_TYPES[UA_TYPES_CLOSESESSIONREQUEST];
  125. *responseType = &UA_TYPES[UA_TYPES_CLOSESESSIONRESPONSE];
  126. break;
  127. case UA_NS0ID_READREQUEST_ENCODING_DEFAULTBINARY:
  128. *service = NULL;
  129. *service = (UA_Service)Service_Read;
  130. *requestType = &UA_TYPES[UA_TYPES_READREQUEST];
  131. *responseType = &UA_TYPES[UA_TYPES_READRESPONSE];
  132. break;
  133. case UA_NS0ID_WRITEREQUEST_ENCODING_DEFAULTBINARY:
  134. *service = (UA_Service)Service_Write;
  135. *requestType = &UA_TYPES[UA_TYPES_WRITEREQUEST];
  136. *responseType = &UA_TYPES[UA_TYPES_WRITERESPONSE];
  137. break;
  138. case UA_NS0ID_BROWSEREQUEST_ENCODING_DEFAULTBINARY:
  139. *service = (UA_Service)Service_Browse;
  140. *requestType = &UA_TYPES[UA_TYPES_BROWSEREQUEST];
  141. *responseType = &UA_TYPES[UA_TYPES_BROWSERESPONSE];
  142. break;
  143. case UA_NS0ID_BROWSENEXTREQUEST_ENCODING_DEFAULTBINARY:
  144. *service = (UA_Service)Service_BrowseNext;
  145. *requestType = &UA_TYPES[UA_TYPES_BROWSENEXTREQUEST];
  146. *responseType = &UA_TYPES[UA_TYPES_BROWSENEXTRESPONSE];
  147. break;
  148. case UA_NS0ID_REGISTERNODESREQUEST_ENCODING_DEFAULTBINARY:
  149. *service = (UA_Service)Service_RegisterNodes;
  150. *requestType = &UA_TYPES[UA_TYPES_REGISTERNODESREQUEST];
  151. *responseType = &UA_TYPES[UA_TYPES_REGISTERNODESRESPONSE];
  152. break;
  153. case UA_NS0ID_UNREGISTERNODESREQUEST_ENCODING_DEFAULTBINARY:
  154. *service = (UA_Service)Service_UnregisterNodes;
  155. *requestType = &UA_TYPES[UA_TYPES_UNREGISTERNODESREQUEST];
  156. *responseType = &UA_TYPES[UA_TYPES_UNREGISTERNODESRESPONSE];
  157. break;
  158. case UA_NS0ID_TRANSLATEBROWSEPATHSTONODEIDSREQUEST_ENCODING_DEFAULTBINARY:
  159. *service = (UA_Service)Service_TranslateBrowsePathsToNodeIds;
  160. *requestType = &UA_TYPES[UA_TYPES_TRANSLATEBROWSEPATHSTONODEIDSREQUEST];
  161. *responseType = &UA_TYPES[UA_TYPES_TRANSLATEBROWSEPATHSTONODEIDSRESPONSE];
  162. break;
  163. #ifdef UA_ENABLE_SUBSCRIPTIONS
  164. case UA_NS0ID_CREATESUBSCRIPTIONREQUEST_ENCODING_DEFAULTBINARY:
  165. *service = (UA_Service)Service_CreateSubscription;
  166. *requestType = &UA_TYPES[UA_TYPES_CREATESUBSCRIPTIONREQUEST];
  167. *responseType = &UA_TYPES[UA_TYPES_CREATESUBSCRIPTIONRESPONSE];
  168. break;
  169. case UA_NS0ID_PUBLISHREQUEST_ENCODING_DEFAULTBINARY:
  170. *requestType = &UA_TYPES[UA_TYPES_PUBLISHREQUEST];
  171. *responseType = &UA_TYPES[UA_TYPES_PUBLISHRESPONSE];
  172. break;
  173. case UA_NS0ID_REPUBLISHREQUEST_ENCODING_DEFAULTBINARY:
  174. *service = (UA_Service)Service_Republish;
  175. *requestType = &UA_TYPES[UA_TYPES_REPUBLISHREQUEST];
  176. *responseType = &UA_TYPES[UA_TYPES_REPUBLISHRESPONSE];
  177. break;
  178. case UA_NS0ID_MODIFYSUBSCRIPTIONREQUEST_ENCODING_DEFAULTBINARY:
  179. *service = (UA_Service)Service_ModifySubscription;
  180. *requestType = &UA_TYPES[UA_TYPES_MODIFYSUBSCRIPTIONREQUEST];
  181. *responseType = &UA_TYPES[UA_TYPES_MODIFYSUBSCRIPTIONRESPONSE];
  182. break;
  183. case UA_NS0ID_SETPUBLISHINGMODEREQUEST_ENCODING_DEFAULTBINARY:
  184. *service = (UA_Service)Service_SetPublishingMode;
  185. *requestType = &UA_TYPES[UA_TYPES_SETPUBLISHINGMODEREQUEST];
  186. *responseType = &UA_TYPES[UA_TYPES_SETPUBLISHINGMODERESPONSE];
  187. break;
  188. case UA_NS0ID_DELETESUBSCRIPTIONSREQUEST_ENCODING_DEFAULTBINARY:
  189. *service = (UA_Service)Service_DeleteSubscriptions;
  190. *requestType = &UA_TYPES[UA_TYPES_DELETESUBSCRIPTIONSREQUEST];
  191. *responseType = &UA_TYPES[UA_TYPES_DELETESUBSCRIPTIONSRESPONSE];
  192. break;
  193. case UA_NS0ID_CREATEMONITOREDITEMSREQUEST_ENCODING_DEFAULTBINARY:
  194. *service = (UA_Service)Service_CreateMonitoredItems;
  195. *requestType = &UA_TYPES[UA_TYPES_CREATEMONITOREDITEMSREQUEST];
  196. *responseType = &UA_TYPES[UA_TYPES_CREATEMONITOREDITEMSRESPONSE];
  197. break;
  198. case UA_NS0ID_DELETEMONITOREDITEMSREQUEST_ENCODING_DEFAULTBINARY:
  199. *service = (UA_Service)Service_DeleteMonitoredItems;
  200. *requestType = &UA_TYPES[UA_TYPES_DELETEMONITOREDITEMSREQUEST];
  201. *responseType = &UA_TYPES[UA_TYPES_DELETEMONITOREDITEMSRESPONSE];
  202. break;
  203. case UA_NS0ID_MODIFYMONITOREDITEMSREQUEST_ENCODING_DEFAULTBINARY:
  204. *service = (UA_Service)Service_ModifyMonitoredItems;
  205. *requestType = &UA_TYPES[UA_TYPES_MODIFYMONITOREDITEMSREQUEST];
  206. *responseType = &UA_TYPES[UA_TYPES_MODIFYMONITOREDITEMSRESPONSE];
  207. break;
  208. case UA_NS0ID_SETMONITORINGMODEREQUEST_ENCODING_DEFAULTBINARY:
  209. *service = (UA_Service)Service_SetMonitoringMode;
  210. *requestType = &UA_TYPES[UA_TYPES_SETMONITORINGMODEREQUEST];
  211. *responseType = &UA_TYPES[UA_TYPES_SETMONITORINGMODERESPONSE];
  212. break;
  213. #endif
  214. #ifdef UA_ENABLE_HISTORIZING
  215. /* For History read */
  216. case UA_NS0ID_HISTORYREADREQUEST_ENCODING_DEFAULTBINARY:
  217. *service = (UA_Service)Service_HistoryRead;
  218. *requestType = &UA_TYPES[UA_TYPES_HISTORYREADREQUEST];
  219. *responseType = &UA_TYPES[UA_TYPES_HISTORYREADRESPONSE];
  220. break;
  221. /* For History update */
  222. case UA_NS0ID_HISTORYUPDATEREQUEST_ENCODING_DEFAULTBINARY:
  223. *service = (UA_Service)Service_HistoryUpdate;
  224. *requestType = &UA_TYPES[UA_TYPES_HISTORYUPDATEREQUEST];
  225. *responseType = &UA_TYPES[UA_TYPES_HISTORYUPDATERESPONSE];
  226. break;
  227. #endif
  228. #ifdef UA_ENABLE_METHODCALLS
  229. case UA_NS0ID_CALLREQUEST_ENCODING_DEFAULTBINARY:
  230. *service = (UA_Service)Service_Call;
  231. *requestType = &UA_TYPES[UA_TYPES_CALLREQUEST];
  232. *responseType = &UA_TYPES[UA_TYPES_CALLRESPONSE];
  233. break;
  234. #endif
  235. #ifdef UA_ENABLE_NODEMANAGEMENT
  236. case UA_NS0ID_ADDNODESREQUEST_ENCODING_DEFAULTBINARY:
  237. *service = (UA_Service)Service_AddNodes;
  238. *requestType = &UA_TYPES[UA_TYPES_ADDNODESREQUEST];
  239. *responseType = &UA_TYPES[UA_TYPES_ADDNODESRESPONSE];
  240. break;
  241. case UA_NS0ID_ADDREFERENCESREQUEST_ENCODING_DEFAULTBINARY:
  242. *service = (UA_Service)Service_AddReferences;
  243. *requestType = &UA_TYPES[UA_TYPES_ADDREFERENCESREQUEST];
  244. *responseType = &UA_TYPES[UA_TYPES_ADDREFERENCESRESPONSE];
  245. break;
  246. case UA_NS0ID_DELETENODESREQUEST_ENCODING_DEFAULTBINARY:
  247. *service = (UA_Service)Service_DeleteNodes;
  248. *requestType = &UA_TYPES[UA_TYPES_DELETENODESREQUEST];
  249. *responseType = &UA_TYPES[UA_TYPES_DELETENODESRESPONSE];
  250. break;
  251. case UA_NS0ID_DELETEREFERENCESREQUEST_ENCODING_DEFAULTBINARY:
  252. *service = (UA_Service)Service_DeleteReferences;
  253. *requestType = &UA_TYPES[UA_TYPES_DELETEREFERENCESREQUEST];
  254. *responseType = &UA_TYPES[UA_TYPES_DELETEREFERENCESRESPONSE];
  255. break;
  256. #endif
  257. default:
  258. break;
  259. }
  260. }
  261. /*************************/
  262. /* Process Message Types */
  263. /*************************/
  264. /* HEL -> Open up the connection */
  265. static UA_StatusCode
  266. processHEL(UA_Server *server, UA_Connection *connection,
  267. const UA_ByteString *msg, size_t *offset) {
  268. UA_TcpHelloMessage helloMessage;
  269. UA_StatusCode retval = UA_TcpHelloMessage_decodeBinary(msg, offset, &helloMessage);
  270. if(retval != UA_STATUSCODE_GOOD)
  271. return retval;
  272. /* Currently not checked */
  273. UA_String_clear(&helloMessage.endpointUrl);
  274. /* TODO: Use the config of the exact NetworkLayer */
  275. if(server->config.networkLayersSize == 0)
  276. return UA_STATUSCODE_BADOUTOFMEMORY;
  277. const UA_ConnectionConfig *localConfig = &server->config.networkLayers[0].localConnectionConfig;
  278. /* Parameterize the connection */
  279. UA_ConnectionConfig remoteConfig;
  280. remoteConfig.protocolVersion = helloMessage.protocolVersion;
  281. remoteConfig.sendBufferSize = helloMessage.sendBufferSize;
  282. remoteConfig.recvBufferSize = helloMessage.receiveBufferSize;
  283. remoteConfig.maxMessageSize = helloMessage.maxMessageSize;
  284. remoteConfig.maxChunkCount = helloMessage.maxChunkCount;
  285. retval = UA_Connection_processHELACK(connection, localConfig, &remoteConfig);
  286. if(retval != UA_STATUSCODE_GOOD) {
  287. UA_LOG_INFO(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  288. "Connection %i | Error during the HEL/ACK handshake",
  289. (int)(connection->sockfd));
  290. return retval;
  291. }
  292. /* Build acknowledge response */
  293. UA_TcpAcknowledgeMessage ackMessage;
  294. memcpy(&ackMessage, &connection->config, sizeof(UA_TcpAcknowledgeMessage)); /* Same struct layout.. */
  295. UA_TcpMessageHeader ackHeader;
  296. ackHeader.messageTypeAndChunkType = UA_MESSAGETYPE_ACK + UA_CHUNKTYPE_FINAL;
  297. ackHeader.messageSize = 8 + 20; /* ackHeader + ackMessage */
  298. /* Get the send buffer from the network layer */
  299. UA_ByteString ack_msg;
  300. UA_ByteString_init(&ack_msg);
  301. retval = connection->getSendBuffer(connection, connection->config.sendBufferSize, &ack_msg);
  302. if(retval != UA_STATUSCODE_GOOD)
  303. return retval;
  304. /* Encode and send the response */
  305. UA_Byte *bufPos = ack_msg.data;
  306. const UA_Byte *bufEnd = &ack_msg.data[ack_msg.length];
  307. retval = UA_TcpMessageHeader_encodeBinary(&ackHeader, &bufPos, bufEnd);
  308. if(retval != UA_STATUSCODE_GOOD) {
  309. connection->releaseSendBuffer(connection, &ack_msg);
  310. return retval;
  311. }
  312. retval = UA_TcpAcknowledgeMessage_encodeBinary(&ackMessage, &bufPos, bufEnd);
  313. if(retval != UA_STATUSCODE_GOOD) {
  314. connection->releaseSendBuffer(connection, &ack_msg);
  315. return retval;
  316. }
  317. ack_msg.length = ackHeader.messageSize;
  318. return connection->send(connection, &ack_msg);
  319. }
  320. /* OPN -> Open up/renew the securechannel */
  321. static UA_StatusCode
  322. processOPN(UA_Server *server, UA_SecureChannel *channel,
  323. const UA_UInt32 requestId, const UA_ByteString *msg) {
  324. /* Decode the request */
  325. size_t offset = 0;
  326. UA_NodeId requestType;
  327. UA_OpenSecureChannelRequest openSecureChannelRequest;
  328. UA_StatusCode retval = UA_NodeId_decodeBinary(msg, &offset, &requestType);
  329. if(retval != UA_STATUSCODE_GOOD) {
  330. UA_NodeId_clear(&requestType);
  331. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  332. "Could not decode the NodeId. Closing the connection");
  333. UA_SecureChannelManager_close(&server->secureChannelManager, channel->securityToken.channelId);
  334. return retval;
  335. }
  336. retval = UA_OpenSecureChannelRequest_decodeBinary(msg, &offset, &openSecureChannelRequest);
  337. /* Error occurred */
  338. if(retval != UA_STATUSCODE_GOOD ||
  339. requestType.identifier.numeric != UA_TYPES[UA_TYPES_OPENSECURECHANNELREQUEST].binaryEncodingId) {
  340. UA_NodeId_clear(&requestType);
  341. UA_OpenSecureChannelRequest_clear(&openSecureChannelRequest);
  342. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  343. "Could not decode the OPN message. Closing the connection.");
  344. UA_SecureChannelManager_close(&server->secureChannelManager, channel->securityToken.channelId);
  345. return retval;
  346. }
  347. UA_NodeId_clear(&requestType);
  348. /* Call the service */
  349. UA_OpenSecureChannelResponse openScResponse;
  350. UA_OpenSecureChannelResponse_init(&openScResponse);
  351. Service_OpenSecureChannel(server, channel, &openSecureChannelRequest, &openScResponse);
  352. UA_OpenSecureChannelRequest_clear(&openSecureChannelRequest);
  353. if(openScResponse.responseHeader.serviceResult != UA_STATUSCODE_GOOD) {
  354. UA_LOG_INFO_CHANNEL(&server->config.logger, channel, "Could not open a SecureChannel. "
  355. "Closing the connection.");
  356. UA_SecureChannelManager_close(&server->secureChannelManager,
  357. channel->securityToken.channelId);
  358. return openScResponse.responseHeader.serviceResult;
  359. }
  360. /* Send the response */
  361. retval = UA_SecureChannel_sendAsymmetricOPNMessage(channel, requestId, &openScResponse,
  362. &UA_TYPES[UA_TYPES_OPENSECURECHANNELRESPONSE]);
  363. UA_OpenSecureChannelResponse_clear(&openScResponse);
  364. if(retval != UA_STATUSCODE_GOOD) {
  365. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  366. "Could not send the OPN answer with error code %s",
  367. UA_StatusCode_name(retval));
  368. UA_SecureChannelManager_close(&server->secureChannelManager,
  369. channel->securityToken.channelId);
  370. return retval;
  371. }
  372. return retval;
  373. }
  374. UA_StatusCode
  375. sendResponse(UA_SecureChannel *channel, UA_UInt32 requestId, UA_UInt32 requestHandle,
  376. UA_ResponseHeader *responseHeader, const UA_DataType *responseType) {
  377. /* Prepare the ResponseHeader */
  378. responseHeader->requestHandle = requestHandle;
  379. responseHeader->timestamp = UA_DateTime_now();
  380. /* Start the message context */
  381. UA_MessageContext mc;
  382. UA_StatusCode retval = UA_MessageContext_begin(&mc, channel, requestId, UA_MESSAGETYPE_MSG);
  383. if(retval != UA_STATUSCODE_GOOD)
  384. return retval;
  385. /* Assert's required for clang-analyzer */
  386. UA_assert(mc.buf_pos == &mc.messageBuffer.data[UA_SECURE_MESSAGE_HEADER_LENGTH]);
  387. UA_assert(mc.buf_end <= &mc.messageBuffer.data[mc.messageBuffer.length]);
  388. /* Encode the response type */
  389. UA_NodeId typeId = UA_NODEID_NUMERIC(0, responseType->binaryEncodingId);
  390. retval = UA_MessageContext_encode(&mc, &typeId, &UA_TYPES[UA_TYPES_NODEID]);
  391. if(retval != UA_STATUSCODE_GOOD)
  392. return retval;
  393. /* Encode the response */
  394. retval = UA_MessageContext_encode(&mc, responseHeader, responseType);
  395. if(retval != UA_STATUSCODE_GOOD)
  396. return retval;
  397. /* Finish / send out */
  398. return UA_MessageContext_finish(&mc);
  399. }
  400. static UA_StatusCode
  401. processMSGDecoded(UA_Server *server, UA_SecureChannel *channel, UA_UInt32 requestId,
  402. UA_Service service, const UA_RequestHeader *requestHeader,
  403. const UA_DataType *requestType, UA_ResponseHeader *responseHeader,
  404. const UA_DataType *responseType, UA_Boolean sessionRequired) {
  405. /* CreateSession doesn't need a session */
  406. if(requestType == &UA_TYPES[UA_TYPES_CREATESESSIONREQUEST]) {
  407. UA_LOCK(server->serviceMutex);
  408. Service_CreateSession(server, channel,
  409. (const UA_CreateSessionRequest *)requestHeader,
  410. (UA_CreateSessionResponse *)responseHeader);
  411. UA_UNLOCK(server->serviceMutex);
  412. #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
  413. /* Store the authentication token and session ID so we can help fuzzing
  414. * by setting these values in the next request automatically */
  415. UA_CreateSessionResponse *res = (UA_CreateSessionResponse *)responseHeader;
  416. UA_NodeId_copy(&res->authenticationToken, &unsafe_fuzz_authenticationToken);
  417. #endif
  418. return sendResponse(channel, requestId, requestHeader->requestHandle,
  419. responseHeader, responseType);
  420. }
  421. /* Find the matching session */
  422. UA_Session *session = (UA_Session*)
  423. UA_SecureChannel_getSession(channel, &requestHeader->authenticationToken);
  424. if(!session && !UA_NodeId_isNull(&requestHeader->authenticationToken)) {
  425. UA_LOCK(server->serviceMutex);
  426. session = UA_SessionManager_getSessionByToken(&server->sessionManager,
  427. &requestHeader->authenticationToken);
  428. UA_UNLOCK(server->serviceMutex)
  429. }
  430. if(requestType == &UA_TYPES[UA_TYPES_ACTIVATESESSIONREQUEST]) {
  431. if(!session) {
  432. UA_LOG_DEBUG_CHANNEL(&server->config.logger, channel,
  433. "Trying to activate a session that is " \
  434. "not known in the server");
  435. return sendServiceFaultWithRequest(channel, requestHeader, responseType,
  436. requestId, UA_STATUSCODE_BADSESSIONIDINVALID);
  437. }
  438. UA_LOCK(server->serviceMutex);
  439. Service_ActivateSession(server, channel, session,
  440. (const UA_ActivateSessionRequest*)requestHeader,
  441. (UA_ActivateSessionResponse*)responseHeader);
  442. UA_UNLOCK(server->serviceMutex);
  443. return sendResponse(channel, requestId, requestHeader->requestHandle,
  444. responseHeader, responseType);
  445. }
  446. /* Set an anonymous, inactive session for services that need no session */
  447. UA_Session anonymousSession;
  448. if(!session) {
  449. if(sessionRequired) {
  450. #ifdef UA_ENABLE_TYPEDESCRIPTION
  451. UA_LOG_WARNING_CHANNEL(&server->config.logger, channel,
  452. "%s refused without a valid session",
  453. requestType->typeName);
  454. #else
  455. UA_LOG_WARNING_CHANNEL(&server->config.logger, channel,
  456. "Service %i refused without a valid session",
  457. requestType->binaryEncodingId);
  458. #endif
  459. return sendServiceFaultWithRequest(channel, requestHeader, responseType,
  460. requestId, UA_STATUSCODE_BADSESSIONIDINVALID);
  461. }
  462. UA_Session_init(&anonymousSession);
  463. anonymousSession.sessionId = UA_NODEID_GUID(0, UA_GUID_NULL);
  464. anonymousSession.header.channel = channel;
  465. session = &anonymousSession;
  466. }
  467. /* Trying to use a non-activated session? Do not allow if request is of type
  468. * CloseSessionRequest */
  469. if(sessionRequired && !session->activated &&
  470. requestType != &UA_TYPES[UA_TYPES_CLOSESESSIONREQUEST]) {
  471. #ifdef UA_ENABLE_TYPEDESCRIPTION
  472. UA_LOG_WARNING_SESSION(&server->config.logger, session,
  473. "%s refused on a non-activated session",
  474. requestType->typeName);
  475. #else
  476. UA_LOG_WARNING_SESSION(&server->config.logger, session,
  477. "Service %i refused on a non-activated session",
  478. requestType->binaryEncodingId);
  479. #endif
  480. UA_LOCK(server->serviceMutex);
  481. UA_SessionManager_removeSession(&server->sessionManager,
  482. &session->header.authenticationToken);
  483. UA_UNLOCK(server->serviceMutex);
  484. return sendServiceFaultWithRequest(channel, requestHeader, responseType,
  485. requestId, UA_STATUSCODE_BADSESSIONNOTACTIVATED);
  486. }
  487. /* The session is bound to another channel */
  488. if(session != &anonymousSession && session->header.channel != channel) {
  489. UA_LOG_WARNING_CHANNEL(&server->config.logger, channel,
  490. "Client tries to use a Session that is not "
  491. "bound to this SecureChannel");
  492. return sendServiceFaultWithRequest(channel, requestHeader, responseType,
  493. requestId, UA_STATUSCODE_BADSECURECHANNELIDINVALID);
  494. }
  495. /* Update the session lifetime */
  496. UA_Session_updateLifetime(session);
  497. #ifdef UA_ENABLE_SUBSCRIPTIONS
  498. /* The publish request is not answered immediately */
  499. if(requestType == &UA_TYPES[UA_TYPES_PUBLISHREQUEST]) {
  500. UA_LOCK(server->serviceMutex);
  501. Service_Publish(server, session, (const UA_PublishRequest*)requestHeader, requestId);
  502. UA_UNLOCK(server->serviceMutex);
  503. return UA_STATUSCODE_GOOD;
  504. }
  505. #endif
  506. #if UA_MULTITHREADING >= 100
  507. /* The call request might not be answered immediately */
  508. if(requestType == &UA_TYPES[UA_TYPES_CALLREQUEST]) {
  509. UA_Boolean finished = true;
  510. UA_LOCK(server->serviceMutex);
  511. Service_CallAsync(server, session, requestId, (const UA_CallRequest*)requestHeader,
  512. (UA_CallResponse*)responseHeader, &finished);
  513. UA_UNLOCK(server->serviceMutex);
  514. /* Async method calls remain. Don't send a response now */
  515. if(!finished)
  516. return UA_STATUSCODE_GOOD;
  517. /* We are done here */
  518. return sendResponse(channel, requestId, requestHeader->requestHandle,
  519. responseHeader, responseType);
  520. }
  521. #endif
  522. /* Dispatch the synchronous service call and send the response */
  523. UA_LOCK(server->serviceMutex);
  524. service(server, session, requestHeader, responseHeader);
  525. UA_UNLOCK(server->serviceMutex);
  526. return sendResponse(channel, requestId, requestHeader->requestHandle,
  527. responseHeader, responseType);
  528. }
  529. static UA_StatusCode
  530. processMSG(UA_Server *server, UA_SecureChannel *channel,
  531. UA_UInt32 requestId, const UA_ByteString *msg) {
  532. /* Decode the nodeid */
  533. size_t offset = 0;
  534. UA_NodeId requestTypeId;
  535. UA_StatusCode retval = UA_NodeId_decodeBinary(msg, &offset, &requestTypeId);
  536. if(retval != UA_STATUSCODE_GOOD)
  537. return retval;
  538. if(requestTypeId.namespaceIndex != 0 ||
  539. requestTypeId.identifierType != UA_NODEIDTYPE_NUMERIC)
  540. UA_NodeId_clear(&requestTypeId); /* leads to badserviceunsupported */
  541. size_t requestPos = offset; /* Store the offset (for sendServiceFault) */
  542. /* Get the service pointers */
  543. UA_Service service = NULL;
  544. UA_Boolean sessionRequired = true;
  545. const UA_DataType *requestType = NULL;
  546. const UA_DataType *responseType = NULL;
  547. getServicePointers(requestTypeId.identifier.numeric, &requestType,
  548. &responseType, &service, &sessionRequired);
  549. if(!requestType) {
  550. if(requestTypeId.identifier.numeric == 787) {
  551. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  552. "Client requested a subscription, " \
  553. "but those are not enabled in the build");
  554. } else {
  555. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  556. "Unknown request with type identifier %i",
  557. requestTypeId.identifier.numeric);
  558. }
  559. return sendServiceFault(channel, msg, requestPos, &UA_TYPES[UA_TYPES_SERVICEFAULT],
  560. requestId, UA_STATUSCODE_BADSERVICEUNSUPPORTED);
  561. }
  562. UA_assert(responseType);
  563. /* Decode the request */
  564. UA_STACKARRAY(UA_Byte, request, requestType->memSize);
  565. retval = UA_decodeBinary(msg, &offset, request, requestType, server->config.customDataTypes);
  566. if(retval != UA_STATUSCODE_GOOD) {
  567. UA_LOG_DEBUG_CHANNEL(&server->config.logger, channel,
  568. "Could not decode the request");
  569. return sendServiceFault(channel, msg, requestPos, responseType, requestId, retval);
  570. }
  571. /* Check timestamp in the request header */
  572. UA_RequestHeader *requestHeader = (UA_RequestHeader*)request;
  573. if(requestHeader->timestamp == 0) {
  574. if(server->config.verifyRequestTimestamp <= UA_RULEHANDLING_WARN) {
  575. UA_LOG_WARNING_CHANNEL(&server->config.logger, channel,
  576. "The server sends no timestamp in the request header. "
  577. "See the 'verifyRequestTimestamp' setting.");
  578. if(server->config.verifyRequestTimestamp <= UA_RULEHANDLING_ABORT) {
  579. retval = sendServiceFaultWithRequest(channel, requestHeader, responseType,
  580. requestId, UA_STATUSCODE_BADINVALIDTIMESTAMP);
  581. UA_clear(request, requestType);
  582. return retval;
  583. }
  584. }
  585. }
  586. #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
  587. /* Set the authenticationToken from the create session request to help
  588. * fuzzing cover more lines */
  589. UA_NodeId_clear(&requestHeader->authenticationToken);
  590. if(!UA_NodeId_isNull(&unsafe_fuzz_authenticationToken))
  591. UA_NodeId_copy(&unsafe_fuzz_authenticationToken, &requestHeader->authenticationToken);
  592. #endif
  593. /* Prepare the respone */
  594. UA_STACKARRAY(UA_Byte, response, responseType->memSize);
  595. UA_ResponseHeader *responseHeader = (UA_ResponseHeader*)response;
  596. UA_init(response, responseType);
  597. /* Continue with the decoded Request */
  598. retval = processMSGDecoded(server, channel, requestId, service, requestHeader, requestType,
  599. responseHeader, responseType, sessionRequired);
  600. /* Clean up */
  601. UA_clear(request, requestType);
  602. UA_clear(responseHeader, responseType);
  603. return retval;
  604. }
  605. /* Takes decoded messages starting at the nodeid of the content type. */
  606. static void
  607. processSecureChannelMessage(void *application, UA_SecureChannel *channel,
  608. UA_MessageType messagetype, UA_UInt32 requestId,
  609. const UA_ByteString *message) {
  610. UA_Server *server = (UA_Server*)application;
  611. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  612. switch(messagetype) {
  613. case UA_MESSAGETYPE_OPN:
  614. UA_LOG_TRACE_CHANNEL(&server->config.logger, channel,
  615. "Process an OPN on an open channel");
  616. retval = processOPN(server, channel, requestId, message);
  617. break;
  618. case UA_MESSAGETYPE_MSG:
  619. UA_LOG_TRACE_CHANNEL(&server->config.logger, channel, "Process a MSG");
  620. retval = processMSG(server, channel, requestId, message);
  621. break;
  622. case UA_MESSAGETYPE_CLO:
  623. UA_LOG_TRACE_CHANNEL(&server->config.logger, channel, "Process a CLO");
  624. Service_CloseSecureChannel(server, channel);
  625. break;
  626. default:
  627. UA_LOG_TRACE_CHANNEL(&server->config.logger, channel, "Invalid message type");
  628. retval = UA_STATUSCODE_BADTCPMESSAGETYPEINVALID;
  629. break;
  630. }
  631. if(retval != UA_STATUSCODE_GOOD) {
  632. UA_LOG_INFO_CHANNEL(&server->config.logger, channel,
  633. "Processing the message failed with StatusCode %s. "
  634. "Closing the channel.", UA_StatusCode_name(retval));
  635. Service_CloseSecureChannel(server, channel);
  636. }
  637. }
  638. static UA_StatusCode
  639. createSecureChannel(void *application, UA_Connection *connection,
  640. UA_AsymmetricAlgorithmSecurityHeader *asymHeader) {
  641. UA_Server *server = (UA_Server*)application;
  642. /* Iterate over available endpoints and choose the correct one */
  643. UA_SecurityPolicy *securityPolicy = NULL;
  644. for(size_t i = 0; i < server->config.securityPoliciesSize; ++i) {
  645. UA_SecurityPolicy *policy = &server->config.securityPolicies[i];
  646. if(!UA_ByteString_equal(&asymHeader->securityPolicyUri, &policy->policyUri))
  647. continue;
  648. UA_StatusCode retval = policy->asymmetricModule.
  649. compareCertificateThumbprint(policy, &asymHeader->receiverCertificateThumbprint);
  650. if(retval != UA_STATUSCODE_GOOD)
  651. continue;
  652. /* We found the correct policy (except for security mode). The endpoint
  653. * needs to be selected by the client / server to match the security
  654. * mode in the endpoint for the session. */
  655. securityPolicy = policy;
  656. break;
  657. }
  658. if(!securityPolicy)
  659. return UA_STATUSCODE_BADSECURITYPOLICYREJECTED;
  660. /* Create a new channel */
  661. return UA_SecureChannelManager_create(&server->secureChannelManager, connection,
  662. securityPolicy, asymHeader);
  663. }
  664. static UA_StatusCode
  665. processCompleteChunkWithoutChannel(UA_Server *server, UA_Connection *connection,
  666. UA_ByteString *message) {
  667. /* Process chunk without a channel; must be OPN */
  668. UA_LOG_TRACE(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  669. "Connection %i | No channel attached to the connection. "
  670. "Process the chunk directly", (int)(connection->sockfd));
  671. size_t offset = 0;
  672. UA_TcpMessageHeader tcpMessageHeader;
  673. UA_StatusCode retval =
  674. UA_TcpMessageHeader_decodeBinary(message, &offset, &tcpMessageHeader);
  675. if(retval != UA_STATUSCODE_GOOD)
  676. return retval;
  677. // Only HEL and OPN messages possible without a channel (on the server side)
  678. switch(tcpMessageHeader.messageTypeAndChunkType & 0x00ffffffu) {
  679. case UA_MESSAGETYPE_HEL:
  680. retval = processHEL(server, connection, message, &offset);
  681. break;
  682. case UA_MESSAGETYPE_OPN:
  683. {
  684. UA_LOG_TRACE(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  685. "Connection %i | Process OPN message", (int)(connection->sockfd));
  686. /* Called before HEL */
  687. if(connection->state != UA_CONNECTION_ESTABLISHED) {
  688. retval = UA_STATUSCODE_BADCOMMUNICATIONERROR;
  689. break;
  690. }
  691. // Decode the asymmetric algorithm security header since it is not encrypted and
  692. // needed to decide what security policy to use.
  693. UA_AsymmetricAlgorithmSecurityHeader asymHeader;
  694. UA_AsymmetricAlgorithmSecurityHeader_init(&asymHeader);
  695. size_t messageHeaderOffset = UA_SECURE_CONVERSATION_MESSAGE_HEADER_LENGTH;
  696. retval = UA_AsymmetricAlgorithmSecurityHeader_decodeBinary(message,
  697. &messageHeaderOffset,
  698. &asymHeader);
  699. if(retval != UA_STATUSCODE_GOOD)
  700. break;
  701. retval = createSecureChannel(server, connection, &asymHeader);
  702. UA_AsymmetricAlgorithmSecurityHeader_clear(&asymHeader);
  703. if(retval != UA_STATUSCODE_GOOD)
  704. break;
  705. retval = UA_SecureChannel_decryptAddChunk(connection->channel, message, false);
  706. if(retval != UA_STATUSCODE_GOOD)
  707. break;
  708. UA_SecureChannel_processCompleteMessages(connection->channel, server,
  709. processSecureChannelMessage);
  710. break;
  711. }
  712. default:
  713. UA_LOG_TRACE(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  714. "Connection %i | Expected OPN or HEL message on a connection "
  715. "without a SecureChannel", (int)(connection->sockfd));
  716. retval = UA_STATUSCODE_BADTCPMESSAGETYPEINVALID;
  717. break;
  718. }
  719. return retval;
  720. }
  721. static UA_StatusCode
  722. processCompleteChunk(void *const application, UA_Connection *connection,
  723. UA_ByteString *chunk) {
  724. UA_Server *server = (UA_Server*)application;
  725. #ifdef UA_DEBUG_DUMP_PKGS_FILE
  726. UA_debug_dumpCompleteChunk(server, connection, chunk);
  727. #endif
  728. if(!connection->channel)
  729. return processCompleteChunkWithoutChannel(server, connection, chunk);
  730. return UA_SecureChannel_decryptAddChunk(connection->channel, chunk, false);
  731. }
  732. void
  733. UA_Server_processBinaryMessage(UA_Server *server, UA_Connection *connection,
  734. UA_ByteString *message) {
  735. UA_LOG_TRACE(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  736. "Connection %i | Received a packet.", (int)(connection->sockfd));
  737. #ifdef UA_DEBUG_DUMP_PKGS
  738. UA_dump_hex_pkg(message->data, message->length);
  739. #endif
  740. UA_StatusCode retval = UA_Connection_processChunks(connection, server,
  741. processCompleteChunk, message);
  742. if(retval != UA_STATUSCODE_GOOD) {
  743. UA_LOG_INFO(&server->config.logger, UA_LOGCATEGORY_NETWORK,
  744. "Connection %i | Processing the message failed with "
  745. "error %s", (int)(connection->sockfd), UA_StatusCode_name(retval));
  746. /* Send an ERR message and close the connection */
  747. UA_TcpErrorMessage error;
  748. error.error = retval;
  749. error.reason = UA_STRING_NULL;
  750. UA_Connection_sendError(connection, &error);
  751. connection->close(connection);
  752. return;
  753. }
  754. UA_SecureChannel *channel = connection->channel;
  755. if(!channel)
  756. return;
  757. /* Process complete messages */
  758. UA_SecureChannel_processCompleteMessages(channel, server, processSecureChannelMessage);
  759. /* Is the channel still open? */
  760. if(channel->state == UA_SECURECHANNELSTATE_CLOSED)
  761. return;
  762. /* Store unused decoded chunks internally in the SecureChannel */
  763. UA_SecureChannel_persistIncompleteMessages(connection->channel);
  764. }
  765. #if UA_MULTITHREADING >= 200
  766. static void
  767. deleteConnection(UA_Server *server, UA_Connection *connection) {
  768. connection->free(connection);
  769. }
  770. #endif
  771. void
  772. UA_Server_removeConnection(UA_Server *server, UA_Connection *connection) {
  773. UA_Connection_detachSecureChannel(connection);
  774. #if UA_MULTITHREADING >= 200
  775. UA_DelayedCallback *dc = (UA_DelayedCallback*)UA_malloc(sizeof(UA_DelayedCallback));
  776. if(!dc)
  777. return; /* Malloc cannot fail on OS's that support multithreading. They
  778. * rather kill the process. */
  779. dc->callback = (UA_ApplicationCallback)deleteConnection;
  780. dc->application = server;
  781. dc->data = connection;
  782. UA_WorkQueue_enqueueDelayed(&server->workQueue, dc);
  783. #else
  784. connection->free(connection);
  785. #endif
  786. }