ua_client.c 49 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205
  1. #include "ua_util.h"
  2. #include "ua_client.h"
  3. #include "ua_types_generated.h"
  4. #include "ua_nodeids.h"
  5. #include "ua_securechannel.h"
  6. #include "ua_types_encoding_binary.h"
  7. #include "ua_transport_generated.h"
  8. #include "ua_types_generated_encoding_binary.h"
  9. #include "ua_transport_generated_encoding_binary.h"
  10. #include "ua_client_internal.h"
  11. typedef enum {
  12. UA_CLIENTSTATE_READY,
  13. UA_CLIENTSTATE_CONNECTED,
  14. UA_CLIENTSTATE_ERRORED
  15. } UA_Client_State;
  16. struct UA_Client {
  17. /* State */ //maybe it should be visible to user
  18. UA_Client_State state;
  19. /* Connection */
  20. UA_Connection connection;
  21. UA_SecureChannel channel;
  22. UA_String endpointUrl;
  23. UA_UInt32 requestId;
  24. /* Session */
  25. UA_UserTokenPolicy token;
  26. UA_NodeId sessionId;
  27. UA_NodeId authenticationToken;
  28. UA_UInt32 requestHandle;
  29. #ifdef ENABLE_SUBSCRIPTIONS
  30. UA_Int32 monitoredItemHandles;
  31. LIST_HEAD(UA_ListOfUnacknowledgedNotificationNumbers, UA_Client_NotificationsAckNumber_s) pendingNotificationsAcks;
  32. LIST_HEAD(UA_ListOfClientSubscriptionItems, UA_Client_Subscription_s) subscriptions;
  33. #endif
  34. /* Config */
  35. UA_Logger logger;
  36. UA_ClientConfig config;
  37. UA_DateTime scExpiresAt;
  38. };
  39. const UA_EXPORT UA_ClientConfig UA_ClientConfig_standard =
  40. { .timeout = 500 /* ms receive timout */, .secureChannelLifeTime = 30000, .timeToRenewSecureChannel = 2000,
  41. {.protocolVersion = 0, .sendBufferSize = 65536, .recvBufferSize = 65536,
  42. .maxMessageSize = 65536, .maxChunkCount = 1}};
  43. UA_Client * UA_Client_new(UA_ClientConfig config, UA_Logger logger) {
  44. UA_Client *client = UA_calloc(1, sizeof(UA_Client));
  45. if(!client)
  46. return UA_NULL;
  47. UA_Client_init(client, config, logger);
  48. return client;
  49. }
  50. void UA_Client_reset(UA_Client* client){
  51. UA_Client_deleteMembers(client);
  52. UA_Client_init(client, client->config, client->logger);
  53. }
  54. void UA_Client_init(UA_Client* client, UA_ClientConfig config, UA_Logger logger){
  55. client->state = UA_CLIENTSTATE_READY;
  56. UA_Connection_init(&client->connection);
  57. UA_SecureChannel_init(&client->channel);
  58. client->channel.connection = &client->connection;
  59. UA_String_init(&client->endpointUrl);
  60. client->requestId = 0;
  61. UA_NodeId_init(&client->authenticationToken);
  62. client->requestHandle = 0;
  63. client->logger = logger;
  64. client->config = config;
  65. client->scExpiresAt = 0;
  66. #ifdef ENABLE_SUBSCRIPTIONS
  67. client->monitoredItemHandles = 0;
  68. LIST_INIT(&client->pendingNotificationsAcks);
  69. LIST_INIT(&client->subscriptions);
  70. #endif
  71. }
  72. void UA_Client_deleteMembers(UA_Client* client){
  73. if(client->state == UA_CLIENTSTATE_READY) //initialized client has no dynamic memory allocated
  74. return;
  75. UA_Connection_deleteMembers(&client->connection);
  76. UA_SecureChannel_deleteMembersCleanup(&client->channel);
  77. if(client->endpointUrl.data)
  78. UA_String_deleteMembers(&client->endpointUrl);
  79. UA_UserTokenPolicy_deleteMembers(&client->token);
  80. }
  81. void UA_Client_delete(UA_Client* client){
  82. if(client->state != UA_CLIENTSTATE_READY)
  83. UA_Client_deleteMembers(client);
  84. UA_free(client);
  85. }
  86. static UA_StatusCode
  87. HelAckHandshake(UA_Client *c) {
  88. UA_TcpMessageHeader messageHeader;
  89. messageHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_HELF;
  90. UA_TcpHelloMessage hello;
  91. UA_String_copy(&c->endpointUrl, &hello.endpointUrl); /* must be less than 4096 bytes */
  92. UA_Connection *conn = &c->connection;
  93. hello.maxChunkCount = conn->localConf.maxChunkCount;
  94. hello.maxMessageSize = conn->localConf.maxMessageSize;
  95. hello.protocolVersion = conn->localConf.protocolVersion;
  96. hello.receiveBufferSize = conn->localConf.recvBufferSize;
  97. hello.sendBufferSize = conn->localConf.sendBufferSize;
  98. UA_ByteString message;
  99. UA_StatusCode retval;
  100. retval = c->connection.getSendBuffer(&c->connection, c->connection.remoteConf.recvBufferSize, &message);
  101. if(retval != UA_STATUSCODE_GOOD)
  102. return retval;
  103. size_t offset = 8;
  104. retval |= UA_TcpHelloMessage_encodeBinary(&hello, &message, &offset);
  105. messageHeader.messageSize = offset;
  106. offset = 0;
  107. retval |= UA_TcpMessageHeader_encodeBinary(&messageHeader, &message, &offset);
  108. UA_TcpHelloMessage_deleteMembers(&hello);
  109. if(retval != UA_STATUSCODE_GOOD) {
  110. c->connection.releaseSendBuffer(&c->connection, &message);
  111. return retval;
  112. }
  113. message.length = messageHeader.messageSize;
  114. retval = c->connection.send(&c->connection, &message);
  115. if(retval != UA_STATUSCODE_GOOD) {
  116. UA_LOG_DEBUG(c->logger, UA_LOGCATEGORY_NETWORK, "Sending HEL failed");
  117. return retval;
  118. }
  119. UA_LOG_DEBUG(c->logger, UA_LOGCATEGORY_NETWORK, "Sent HEL message");
  120. UA_ByteString reply;
  121. UA_ByteString_init(&reply);
  122. do {
  123. retval = c->connection.recv(&c->connection, &reply, c->config.timeout);
  124. if(retval != UA_STATUSCODE_GOOD) {
  125. UA_LOG_DEBUG(c->logger, UA_LOGCATEGORY_NETWORK, "Receiving ACK message failed");
  126. return retval;
  127. }
  128. } while(!reply.data);
  129. offset = 0;
  130. UA_TcpMessageHeader_decodeBinary(&reply, &offset, &messageHeader);
  131. UA_TcpAcknowledgeMessage ackMessage;
  132. retval = UA_TcpAcknowledgeMessage_decodeBinary(&reply, &offset, &ackMessage);
  133. UA_ByteString_deleteMembers(&reply);
  134. if(retval != UA_STATUSCODE_GOOD) {
  135. UA_LOG_DEBUG(c->logger, UA_LOGCATEGORY_NETWORK, "Decoding ACK message failed");
  136. return retval;
  137. }
  138. UA_LOG_DEBUG(c->logger, UA_LOGCATEGORY_NETWORK, "Received ACK message");
  139. conn->remoteConf.maxChunkCount = ackMessage.maxChunkCount;
  140. conn->remoteConf.maxMessageSize = ackMessage.maxMessageSize;
  141. conn->remoteConf.protocolVersion = ackMessage.protocolVersion;
  142. conn->remoteConf.recvBufferSize = ackMessage.receiveBufferSize;
  143. conn->remoteConf.sendBufferSize = ackMessage.sendBufferSize;
  144. conn->state = UA_CONNECTION_ESTABLISHED;
  145. return UA_STATUSCODE_GOOD;
  146. }
  147. static UA_StatusCode SecureChannelHandshake(UA_Client *client, UA_Boolean renew) {
  148. /* Check if sc is still valid */
  149. if(renew && client->scExpiresAt - UA_DateTime_now() > client->config.timeToRenewSecureChannel * 10000 ){
  150. return UA_STATUSCODE_GOOD;
  151. }
  152. UA_SecureConversationMessageHeader messageHeader;
  153. messageHeader.messageHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_OPNF;
  154. messageHeader.secureChannelId = 0;
  155. UA_SequenceHeader seqHeader;
  156. seqHeader.sequenceNumber = ++client->channel.sequenceNumber;
  157. seqHeader.requestId = ++client->requestId;
  158. UA_AsymmetricAlgorithmSecurityHeader asymHeader;
  159. UA_AsymmetricAlgorithmSecurityHeader_init(&asymHeader);
  160. asymHeader.securityPolicyUri = UA_STRING_ALLOC("http://opcfoundation.org/UA/SecurityPolicy#None");
  161. /* id of opensecurechannelrequest */
  162. UA_NodeId requestType = UA_NODEID_NUMERIC(0, UA_NS0ID_OPENSECURECHANNELREQUEST + UA_ENCODINGOFFSET_BINARY);
  163. UA_OpenSecureChannelRequest opnSecRq;
  164. UA_OpenSecureChannelRequest_init(&opnSecRq);
  165. opnSecRq.requestHeader.timestamp = UA_DateTime_now();
  166. opnSecRq.requestHeader.authenticationToken = client->authenticationToken;
  167. opnSecRq.requestedLifetime = client->config.secureChannelLifeTime;
  168. if(renew) {
  169. opnSecRq.requestType = UA_SECURITYTOKENREQUESTTYPE_RENEW;
  170. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL, "Requesting to renew the SecureChannel");
  171. } else {
  172. opnSecRq.requestType = UA_SECURITYTOKENREQUESTTYPE_ISSUE;
  173. UA_ByteString_init(&client->channel.clientNonce);
  174. UA_ByteString_copy(&client->channel.clientNonce, &opnSecRq.clientNonce);
  175. opnSecRq.securityMode = UA_MESSAGESECURITYMODE_NONE;
  176. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL, "Requesting to open a SecureChannel");
  177. }
  178. UA_ByteString message;
  179. UA_Connection *c = &client->connection;
  180. UA_StatusCode retval = c->getSendBuffer(c, c->remoteConf.recvBufferSize, &message);
  181. if(retval != UA_STATUSCODE_GOOD) {
  182. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  183. UA_OpenSecureChannelRequest_deleteMembers(&opnSecRq);
  184. return retval;
  185. }
  186. size_t offset = 12;
  187. retval = UA_AsymmetricAlgorithmSecurityHeader_encodeBinary(&asymHeader, &message, &offset);
  188. retval |= UA_SequenceHeader_encodeBinary(&seqHeader, &message, &offset);
  189. retval |= UA_NodeId_encodeBinary(&requestType, &message, &offset);
  190. retval |= UA_OpenSecureChannelRequest_encodeBinary(&opnSecRq, &message, &offset);
  191. messageHeader.messageHeader.messageSize = offset;
  192. offset = 0;
  193. retval |= UA_SecureConversationMessageHeader_encodeBinary(&messageHeader, &message, &offset);
  194. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  195. UA_OpenSecureChannelRequest_deleteMembers(&opnSecRq);
  196. if(retval != UA_STATUSCODE_GOOD) {
  197. client->connection.releaseSendBuffer(&client->connection, &message);
  198. return retval;
  199. }
  200. message.length = messageHeader.messageHeader.messageSize;
  201. retval = client->connection.send(&client->connection, &message);
  202. if(retval != UA_STATUSCODE_GOOD)
  203. return retval;
  204. UA_ByteString reply;
  205. UA_ByteString_init(&reply);
  206. do {
  207. retval = client->connection.recv(&client->connection, &reply, client->config.timeout);
  208. if(retval != UA_STATUSCODE_GOOD) {
  209. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL, "Receiving OpenSecureChannelResponse failed");
  210. return retval;
  211. }
  212. } while(!reply.data);
  213. offset = 0;
  214. UA_SecureConversationMessageHeader_decodeBinary(&reply, &offset, &messageHeader);
  215. UA_AsymmetricAlgorithmSecurityHeader_decodeBinary(&reply, &offset, &asymHeader);
  216. UA_SequenceHeader_decodeBinary(&reply, &offset, &seqHeader);
  217. UA_NodeId_decodeBinary(&reply, &offset, &requestType);
  218. UA_NodeId expectedRequest = UA_NODEID_NUMERIC(0, UA_NS0ID_OPENSECURECHANNELRESPONSE +
  219. UA_ENCODINGOFFSET_BINARY);
  220. if(!UA_NodeId_equal(&requestType, &expectedRequest)) {
  221. UA_ByteString_deleteMembers(&reply);
  222. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  223. UA_NodeId_deleteMembers(&requestType);
  224. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_CLIENT,
  225. "Reply answers the wrong request. Expected OpenSecureChannelResponse.");
  226. return UA_STATUSCODE_BADINTERNALERROR;
  227. }
  228. UA_OpenSecureChannelResponse response;
  229. UA_OpenSecureChannelResponse_init(&response);
  230. retval = UA_OpenSecureChannelResponse_decodeBinary(&reply, &offset, &response);
  231. if(retval != UA_STATUSCODE_GOOD) {
  232. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL,
  233. "Decoding OpenSecureChannelResponse failed");
  234. UA_ByteString_deleteMembers(&reply);
  235. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  236. UA_OpenSecureChannelResponse_init(&response);
  237. response.responseHeader.serviceResult = retval;
  238. return retval;
  239. }
  240. client->scExpiresAt = UA_DateTime_now() + response.securityToken.revisedLifetime * 10000;
  241. UA_ByteString_deleteMembers(&reply);
  242. retval = response.responseHeader.serviceResult;
  243. if(retval != UA_STATUSCODE_GOOD)
  244. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL,
  245. "SecureChannel could not be opened / renewed");
  246. else if(!renew) {
  247. UA_ChannelSecurityToken_copy(&response.securityToken, &client->channel.securityToken);
  248. /* if the handshake is repeated, replace the old nonce */
  249. UA_ByteString_deleteMembers(&client->channel.serverNonce);
  250. UA_ByteString_copy(&response.serverNonce, &client->channel.serverNonce);
  251. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL, "SecureChannel opened");
  252. } else
  253. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_SECURECHANNEL, "SecureChannel renewed");
  254. UA_OpenSecureChannelResponse_deleteMembers(&response);
  255. UA_AsymmetricAlgorithmSecurityHeader_deleteMembers(&asymHeader);
  256. return retval;
  257. }
  258. /** If the request fails, then the response is cast to UA_ResponseHeader (at the beginning of every
  259. response) and filled with theaappropriate error code */
  260. static void synchronousRequest(UA_Client *client, void *r, const UA_DataType *requestType,
  261. void *response, const UA_DataType *responseType) {
  262. /* Requests always begin witih a RequestHeader, therefore we can cast. */
  263. UA_RequestHeader *request = r;
  264. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  265. if(!response)
  266. return;
  267. UA_init(response, responseType);
  268. UA_ResponseHeader *respHeader = (UA_ResponseHeader*)response;
  269. //make sure we have a valid session
  270. retval = UA_Client_renewSecureChannel(client);
  271. if(retval != UA_STATUSCODE_GOOD) {
  272. respHeader->serviceResult = retval;
  273. client->state = UA_CLIENTSTATE_ERRORED;
  274. return;
  275. }
  276. /* handling request parameters */
  277. UA_NodeId_copy(&client->authenticationToken, &request->authenticationToken);
  278. request->timestamp = UA_DateTime_now();
  279. request->requestHandle = ++client->requestHandle;
  280. /* Send the request */
  281. UA_UInt32 requestId = ++client->requestId;
  282. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_CLIENT,
  283. "Sending a request of type %i", requestType->typeId.identifier.numeric);
  284. retval = UA_SecureChannel_sendBinaryMessage(&client->channel, requestId, request, requestType);
  285. if(retval) {
  286. if(retval == UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED)
  287. respHeader->serviceResult = UA_STATUSCODE_BADREQUESTTOOLARGE;
  288. else
  289. respHeader->serviceResult = retval;
  290. client->state = UA_CLIENTSTATE_ERRORED;
  291. return;
  292. }
  293. /* Retrieve the response */
  294. // Todo: push this into the generic securechannel implementation for client and server
  295. UA_ByteString reply;
  296. UA_ByteString_init(&reply);
  297. do {
  298. retval = client->connection.recv(&client->connection, &reply, client->config.timeout);
  299. if(retval != UA_STATUSCODE_GOOD) {
  300. respHeader->serviceResult = retval;
  301. client->state = UA_CLIENTSTATE_ERRORED;
  302. return;
  303. }
  304. } while(!reply.data);
  305. size_t offset = 0;
  306. UA_SecureConversationMessageHeader msgHeader;
  307. retval |= UA_SecureConversationMessageHeader_decodeBinary(&reply, &offset, &msgHeader);
  308. UA_SymmetricAlgorithmSecurityHeader symHeader;
  309. retval |= UA_SymmetricAlgorithmSecurityHeader_decodeBinary(&reply, &offset, &symHeader);
  310. UA_SequenceHeader seqHeader;
  311. retval |= UA_SequenceHeader_decodeBinary(&reply, &offset, &seqHeader);
  312. UA_NodeId responseId;
  313. retval |= UA_NodeId_decodeBinary(&reply, &offset, &responseId);
  314. UA_NodeId expectedNodeId = UA_NODEID_NUMERIC(0, responseType->typeId.identifier.numeric +
  315. UA_ENCODINGOFFSET_BINARY);
  316. if(retval != UA_STATUSCODE_GOOD) {
  317. goto finish;
  318. }
  319. /* Todo: we need to demux responses since a publish responses may come at any time */
  320. if(!UA_NodeId_equal(&responseId, &expectedNodeId) || seqHeader.requestId != requestId) {
  321. if(responseId.identifier.numeric != UA_NS0ID_SERVICEFAULT + UA_ENCODINGOFFSET_BINARY) {
  322. UA_LOG_ERROR(client->logger, UA_LOGCATEGORY_CLIENT,
  323. "Reply answers the wrong request. Expected ns=%i,i=%i. But retrieved ns=%i,i=%i",
  324. expectedNodeId.namespaceIndex, expectedNodeId.identifier.numeric,
  325. responseId.namespaceIndex, responseId.identifier.numeric);
  326. respHeader->serviceResult = UA_STATUSCODE_BADINTERNALERROR;
  327. } else
  328. retval = UA_decodeBinary(&reply, &offset, respHeader, &UA_TYPES[UA_TYPES_SERVICEFAULT]);
  329. goto finish;
  330. }
  331. retval = UA_decodeBinary(&reply, &offset, response, responseType);
  332. if(retval == UA_STATUSCODE_BADENCODINGLIMITSEXCEEDED)
  333. retval = UA_STATUSCODE_BADRESPONSETOOLARGE;
  334. finish:
  335. UA_SymmetricAlgorithmSecurityHeader_deleteMembers(&symHeader);
  336. UA_ByteString_deleteMembers(&reply);
  337. if(retval != UA_STATUSCODE_GOOD){
  338. UA_LOG_INFO(client->logger, UA_LOGCATEGORY_CLIENT, "Error receiving the response");
  339. client->state = UA_CLIENTSTATE_ERRORED;
  340. respHeader->serviceResult = retval;
  341. }
  342. UA_LOG_DEBUG(client->logger, UA_LOGCATEGORY_CLIENT, "Received a response of type %i", responseId.identifier.numeric);
  343. }
  344. static UA_StatusCode ActivateSession(UA_Client *client) {
  345. UA_ActivateSessionRequest request;
  346. UA_ActivateSessionRequest_init(&request);
  347. request.requestHeader.requestHandle = 2; //TODO: is it a magic number?
  348. request.requestHeader.authenticationToken = client->authenticationToken;
  349. request.requestHeader.timestamp = UA_DateTime_now();
  350. request.requestHeader.timeoutHint = 10000;
  351. UA_AnonymousIdentityToken identityToken;
  352. UA_AnonymousIdentityToken_init(&identityToken);
  353. UA_String_copy(&client->token.policyId, &identityToken.policyId);
  354. //manual ExtensionObject encoding of the identityToken
  355. request.userIdentityToken.encoding = UA_EXTENSIONOBJECT_ENCODINGMASK_BODYISBYTESTRING;
  356. request.userIdentityToken.typeId = UA_TYPES[UA_TYPES_ANONYMOUSIDENTITYTOKEN].typeId;
  357. request.userIdentityToken.typeId.identifier.numeric+=UA_ENCODINGOFFSET_BINARY;
  358. if (identityToken.policyId.length >= 0)
  359. UA_ByteString_newMembers(&request.userIdentityToken.body, identityToken.policyId.length+4);
  360. else {
  361. identityToken.policyId.length = -1;
  362. UA_ByteString_newMembers(&request.userIdentityToken.body, 4);
  363. }
  364. size_t offset = 0;
  365. UA_ByteString_encodeBinary(&identityToken.policyId,&request.userIdentityToken.body,&offset);
  366. UA_ActivateSessionResponse response;
  367. synchronousRequest(client, &request, &UA_TYPES[UA_TYPES_ACTIVATESESSIONREQUEST],
  368. &response, &UA_TYPES[UA_TYPES_ACTIVATESESSIONRESPONSE]);
  369. UA_AnonymousIdentityToken_deleteMembers(&identityToken);
  370. UA_ActivateSessionRequest_deleteMembers(&request);
  371. UA_ActivateSessionResponse_deleteMembers(&response);
  372. return response.responseHeader.serviceResult; // not deleted
  373. }
  374. static UA_StatusCode EndpointsHandshake(UA_Client *client) {
  375. UA_GetEndpointsRequest request;
  376. UA_GetEndpointsRequest_init(&request);
  377. UA_NodeId_copy(&client->authenticationToken, &request.requestHeader.authenticationToken);
  378. request.requestHeader.timestamp = UA_DateTime_now();
  379. request.requestHeader.timeoutHint = 10000;
  380. UA_String_copy(&client->endpointUrl, &request.endpointUrl);
  381. request.profileUrisSize = 1;
  382. request.profileUris = UA_Array_new(&UA_TYPES[UA_TYPES_STRING], request.profileUrisSize);
  383. *request.profileUris = UA_STRING_ALLOC("http://opcfoundation.org/UA-Profile/Transport/uatcp-uasc-uabinary");
  384. UA_GetEndpointsResponse response;
  385. UA_GetEndpointsResponse_init(&response);
  386. synchronousRequest(client, &request, &UA_TYPES[UA_TYPES_GETENDPOINTSREQUEST],
  387. &response, &UA_TYPES[UA_TYPES_GETENDPOINTSRESPONSE]);
  388. UA_Boolean endpointFound = UA_FALSE;
  389. UA_Boolean tokenFound = UA_FALSE;
  390. UA_String securityNone = UA_STRING("http://opcfoundation.org/UA/SecurityPolicy#None");
  391. for(UA_Int32 i=0; i<response.endpointsSize; ++i){
  392. UA_EndpointDescription* endpoint = &response.endpoints[i];
  393. /* look out for an endpoint without security */
  394. if(!UA_String_equal(&endpoint->securityPolicyUri,
  395. &securityNone))
  396. continue;
  397. endpointFound = UA_TRUE;
  398. /* endpoint with no security found */
  399. /* look for a user token policy with an anonymous token */
  400. for(UA_Int32 j=0; j<endpoint->userIdentityTokensSize; ++j) {
  401. UA_UserTokenPolicy* userToken = &endpoint->userIdentityTokens[j];
  402. if(userToken->tokenType != UA_USERTOKENTYPE_ANONYMOUS)
  403. continue;
  404. tokenFound = UA_TRUE;
  405. UA_UserTokenPolicy_copy(userToken, &client->token);
  406. break;
  407. }
  408. }
  409. UA_GetEndpointsRequest_deleteMembers(&request);
  410. UA_GetEndpointsResponse_deleteMembers(&response);
  411. if(!endpointFound){
  412. UA_LOG_ERROR(client->logger, UA_LOGCATEGORY_CLIENT, "No suitable endpoint found");
  413. return UA_STATUSCODE_BADINTERNALERROR;
  414. }
  415. if(!tokenFound){
  416. UA_LOG_ERROR(client->logger, UA_LOGCATEGORY_CLIENT, "No anonymous token found");
  417. return UA_STATUSCODE_BADINTERNALERROR;
  418. }
  419. return response.responseHeader.serviceResult;
  420. }
  421. static UA_StatusCode SessionHandshake(UA_Client *client) {
  422. UA_CreateSessionRequest request;
  423. UA_CreateSessionRequest_init(&request);
  424. // todo: is this needed for all requests?
  425. UA_NodeId_copy(&client->authenticationToken, &request.requestHeader.authenticationToken);
  426. request.requestHeader.timestamp = UA_DateTime_now();
  427. request.requestHeader.timeoutHint = 10000;
  428. UA_ByteString_copy(&client->channel.clientNonce, &request.clientNonce);
  429. request.requestedSessionTimeout = 1200000;
  430. request.maxResponseMessageSize = UA_INT32_MAX;
  431. UA_CreateSessionResponse response;
  432. UA_CreateSessionResponse_init(&response);
  433. synchronousRequest(client, &request, &UA_TYPES[UA_TYPES_CREATESESSIONREQUEST],
  434. &response, &UA_TYPES[UA_TYPES_CREATESESSIONRESPONSE]);
  435. UA_NodeId_copy(&response.authenticationToken, &client->authenticationToken);
  436. UA_CreateSessionRequest_deleteMembers(&request);
  437. UA_CreateSessionResponse_deleteMembers(&response);
  438. return response.responseHeader.serviceResult; // not deleted
  439. }
  440. static UA_StatusCode CloseSession(UA_Client *client) {
  441. UA_CloseSessionRequest request;
  442. UA_CloseSessionRequest_init(&request);
  443. request.requestHeader.timestamp = UA_DateTime_now();
  444. request.requestHeader.timeoutHint = 10000;
  445. request.deleteSubscriptions = UA_TRUE;
  446. UA_NodeId_copy(&client->authenticationToken, &request.requestHeader.authenticationToken);
  447. UA_CloseSessionResponse response;
  448. synchronousRequest(client, &request, &UA_TYPES[UA_TYPES_CLOSESESSIONREQUEST],
  449. &response, &UA_TYPES[UA_TYPES_CLOSESESSIONRESPONSE]);
  450. UA_CloseSessionRequest_deleteMembers(&request);
  451. UA_CloseSessionResponse_deleteMembers(&response);
  452. return response.responseHeader.serviceResult; // not deleted
  453. }
  454. static UA_StatusCode CloseSecureChannel(UA_Client *client) {
  455. UA_SecureChannel *channel = &client->channel;
  456. UA_CloseSecureChannelRequest request;
  457. UA_CloseSecureChannelRequest_init(&request);
  458. request.requestHeader.requestHandle = 1; //TODO: magic number?
  459. request.requestHeader.timestamp = UA_DateTime_now();
  460. request.requestHeader.timeoutHint = 10000;
  461. request.requestHeader.authenticationToken = client->authenticationToken;
  462. UA_SecureConversationMessageHeader msgHeader;
  463. msgHeader.messageHeader.messageTypeAndFinal = UA_MESSAGETYPEANDFINAL_CLOF;
  464. msgHeader.secureChannelId = client->channel.securityToken.channelId;
  465. UA_SymmetricAlgorithmSecurityHeader symHeader;
  466. symHeader.tokenId = channel->securityToken.tokenId;
  467. UA_SequenceHeader seqHeader;
  468. seqHeader.sequenceNumber = ++channel->sequenceNumber;
  469. seqHeader.requestId = ++client->requestId;
  470. UA_NodeId typeId = UA_NODEID_NUMERIC(0, UA_NS0ID_CLOSESECURECHANNELREQUEST + UA_ENCODINGOFFSET_BINARY);
  471. UA_ByteString message;
  472. UA_Connection *c = &client->connection;
  473. UA_StatusCode retval = c->getSendBuffer(c, c->remoteConf.recvBufferSize, &message);
  474. if(retval != UA_STATUSCODE_GOOD)
  475. return retval;
  476. size_t offset = 12;
  477. retval |= UA_SymmetricAlgorithmSecurityHeader_encodeBinary(&symHeader, &message, &offset);
  478. retval |= UA_SequenceHeader_encodeBinary(&seqHeader, &message, &offset);
  479. retval |= UA_NodeId_encodeBinary(&typeId, &message, &offset);
  480. retval |= UA_encodeBinary(&request, &UA_TYPES[UA_TYPES_CLOSESECURECHANNELREQUEST], &message, &offset);
  481. msgHeader.messageHeader.messageSize = offset;
  482. offset = 0;
  483. retval |= UA_SecureConversationMessageHeader_encodeBinary(&msgHeader, &message, &offset);
  484. if(retval != UA_STATUSCODE_GOOD) {
  485. client->connection.releaseSendBuffer(&client->connection, &message);
  486. return retval;
  487. }
  488. message.length = msgHeader.messageHeader.messageSize;
  489. retval = client->connection.send(&client->connection, &message);
  490. return retval;
  491. }
  492. /*************************/
  493. /* User-Facing Functions */
  494. /*************************/
  495. UA_StatusCode UA_Client_connect(UA_Client *client, UA_ConnectClientConnection connectFunc, char *endpointUrl) {
  496. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  497. /** make the function more convenient to the end-user **/
  498. if(client->state == UA_CLIENTSTATE_CONNECTED){
  499. UA_Client_disconnect(client);
  500. }
  501. if(client->state == UA_CLIENTSTATE_ERRORED){
  502. UA_Client_reset(client);
  503. }
  504. client->connection = connectFunc(UA_ConnectionConfig_standard, endpointUrl, client->logger);
  505. if(client->connection.state != UA_CONNECTION_OPENING){
  506. retval = UA_STATUSCODE_BADCONNECTIONCLOSED;
  507. goto cleanup;
  508. }
  509. client->endpointUrl = UA_STRING_ALLOC(endpointUrl);
  510. if(client->endpointUrl.length < 0){
  511. retval = UA_STATUSCODE_BADOUTOFMEMORY;
  512. goto cleanup;
  513. }
  514. client->connection.localConf = client->config.localConnectionConfig;
  515. retval = HelAckHandshake(client);
  516. if(retval == UA_STATUSCODE_GOOD)
  517. retval = SecureChannelHandshake(client, UA_FALSE);
  518. if(retval == UA_STATUSCODE_GOOD)
  519. retval = EndpointsHandshake(client);
  520. if(retval == UA_STATUSCODE_GOOD)
  521. retval = SessionHandshake(client);
  522. if(retval == UA_STATUSCODE_GOOD)
  523. retval = ActivateSession(client);
  524. if(retval == UA_STATUSCODE_GOOD){
  525. client->connection.state = UA_CONNECTION_ESTABLISHED;
  526. client->state = UA_CLIENTSTATE_CONNECTED;
  527. }else{
  528. goto cleanup;
  529. }
  530. return retval;
  531. cleanup:
  532. client->state = UA_CLIENTSTATE_ERRORED;
  533. UA_Client_reset(client);
  534. return retval;
  535. }
  536. UA_StatusCode UA_Client_disconnect(UA_Client *client) {
  537. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  538. if(client->channel.connection->state == UA_CONNECTION_ESTABLISHED){
  539. retval = CloseSession(client);
  540. if(retval == UA_STATUSCODE_GOOD)
  541. retval = CloseSecureChannel(client);
  542. }
  543. UA_Client_reset(client);
  544. return retval;
  545. }
  546. UA_StatusCode UA_Client_renewSecureChannel(UA_Client *client) {
  547. return SecureChannelHandshake(client, UA_TRUE);
  548. }
  549. UA_ReadResponse UA_Client_read(UA_Client *client, UA_ReadRequest *request) {
  550. UA_ReadResponse response;
  551. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_READREQUEST], &response,
  552. &UA_TYPES[UA_TYPES_READRESPONSE]);
  553. return response;
  554. }
  555. UA_WriteResponse UA_Client_write(UA_Client *client, UA_WriteRequest *request) {
  556. UA_WriteResponse response;
  557. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_WRITEREQUEST], &response,
  558. &UA_TYPES[UA_TYPES_WRITERESPONSE]);
  559. return response;
  560. }
  561. UA_BrowseResponse UA_Client_browse(UA_Client *client, UA_BrowseRequest *request) {
  562. UA_BrowseResponse response;
  563. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_BROWSEREQUEST], &response,
  564. &UA_TYPES[UA_TYPES_BROWSERESPONSE]);
  565. return response;
  566. }
  567. UA_StatusCode UA_Client_NamespaceGetIndex(UA_Client *client, UA_String *namespaceUri, UA_UInt16 *namespaceIndex){
  568. UA_ReadRequest ReadRequest;
  569. UA_ReadResponse ReadResponse;
  570. UA_StatusCode retval = UA_STATUSCODE_BADUNEXPECTEDERROR;
  571. UA_ReadRequest_init(&ReadRequest);
  572. ReadRequest.nodesToRead = UA_ReadValueId_new();
  573. ReadRequest.nodesToReadSize = 1;
  574. ReadRequest.nodesToRead[0].attributeId = UA_ATTRIBUTEID_VALUE;
  575. ReadRequest.nodesToRead[0].nodeId = UA_NODEID_NUMERIC(0, UA_NS0ID_SERVER_NAMESPACEARRAY);
  576. ReadResponse = UA_Client_read(client, &ReadRequest);
  577. UA_ReadRequest_deleteMembers(&ReadRequest);
  578. if(ReadResponse.responseHeader.serviceResult != UA_STATUSCODE_GOOD){
  579. retval = ReadResponse.responseHeader.serviceResult;
  580. goto cleanup;
  581. }
  582. if(ReadResponse.resultsSize != 1 || !ReadResponse.results[0].hasValue){
  583. retval = UA_STATUSCODE_BADNODEATTRIBUTESINVALID;
  584. goto cleanup;
  585. }
  586. if(ReadResponse.results[0].value.type != &UA_TYPES[UA_TYPES_STRING]){
  587. retval = UA_STATUSCODE_BADTYPEMISMATCH;
  588. goto cleanup;
  589. }
  590. retval = UA_STATUSCODE_BADNOTFOUND;
  591. for(UA_UInt16 iterator = 0; iterator < ReadResponse.results[0].value.arrayLength; iterator++){
  592. if(UA_String_equal(namespaceUri, &((UA_String*)ReadResponse.results[0].value.data)[iterator] )){
  593. *namespaceIndex = iterator;
  594. retval = UA_STATUSCODE_GOOD;
  595. break;
  596. }
  597. }
  598. cleanup:
  599. UA_ReadResponse_deleteMembers(&ReadResponse);
  600. return retval;
  601. }
  602. UA_BrowseNextResponse UA_Client_browseNext(UA_Client *client, UA_BrowseNextRequest *request) {
  603. UA_BrowseNextResponse response;
  604. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_BROWSENEXTREQUEST], &response,
  605. &UA_TYPES[UA_TYPES_BROWSENEXTRESPONSE]);
  606. return response;
  607. }
  608. UA_TranslateBrowsePathsToNodeIdsResponse
  609. UA_Client_translateTranslateBrowsePathsToNodeIds(UA_Client *client,
  610. UA_TranslateBrowsePathsToNodeIdsRequest *request) {
  611. UA_TranslateBrowsePathsToNodeIdsResponse response;
  612. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_TRANSLATEBROWSEPATHSTONODEIDSREQUEST],
  613. &response, &UA_TYPES[UA_TYPES_TRANSLATEBROWSEPATHSTONODEIDSRESPONSE]);
  614. return response;
  615. }
  616. UA_AddNodesResponse UA_Client_addNodes(UA_Client *client, UA_AddNodesRequest *request) {
  617. UA_AddNodesResponse response;
  618. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_ADDNODESREQUEST],
  619. &response, &UA_TYPES[UA_TYPES_ADDNODESRESPONSE]);
  620. return response;
  621. }
  622. UA_AddReferencesResponse UA_Client_addReferences(UA_Client *client, UA_AddReferencesRequest *request) {
  623. UA_AddReferencesResponse response;
  624. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_ADDREFERENCESREQUEST],
  625. &response, &UA_TYPES[UA_TYPES_ADDREFERENCESRESPONSE]);
  626. return response;
  627. }
  628. UA_DeleteNodesResponse UA_Client_deleteNodes(UA_Client *client, UA_DeleteNodesRequest *request) {
  629. UA_DeleteNodesResponse response;
  630. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_DELETENODESREQUEST],
  631. &response, &UA_TYPES[UA_TYPES_DELETENODESRESPONSE]);
  632. return response;
  633. }
  634. UA_DeleteReferencesResponse UA_Client_deleteReferences(UA_Client *client, UA_DeleteReferencesRequest *request) {
  635. UA_DeleteReferencesResponse response;
  636. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_DELETEREFERENCESREQUEST],
  637. &response, &UA_TYPES[UA_TYPES_DELETEREFERENCESRESPONSE]);
  638. return response;
  639. }
  640. #ifdef ENABLE_SUBSCRIPTIONS
  641. UA_CreateSubscriptionResponse UA_Client_createSubscription(UA_Client *client, UA_CreateSubscriptionRequest *request) {
  642. UA_CreateSubscriptionResponse response;
  643. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_CREATESUBSCRIPTIONREQUEST],
  644. &response, &UA_TYPES[UA_TYPES_CREATESUBSCRIPTIONRESPONSE]);
  645. return response;
  646. }
  647. UA_DeleteSubscriptionsResponse UA_Client_deleteSubscriptions(UA_Client *client, UA_DeleteSubscriptionsRequest *request) {
  648. UA_DeleteSubscriptionsResponse response;
  649. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_DELETESUBSCRIPTIONSREQUEST],
  650. &response, &UA_TYPES[UA_TYPES_DELETESUBSCRIPTIONSRESPONSE]);
  651. return response;
  652. }
  653. UA_ModifySubscriptionResponse UA_Client_modifySubscription(UA_Client *client, UA_ModifySubscriptionRequest *request) {
  654. UA_ModifySubscriptionResponse response;
  655. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_MODIFYSUBSCRIPTIONREQUEST],
  656. &response, &UA_TYPES[UA_TYPES_MODIFYSUBSCRIPTIONRESPONSE]);
  657. return response;
  658. }
  659. UA_CreateMonitoredItemsResponse UA_Client_createMonitoredItems(UA_Client *client, UA_CreateMonitoredItemsRequest *request) {
  660. UA_CreateMonitoredItemsResponse response;
  661. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_CREATEMONITOREDITEMSREQUEST],
  662. &response, &UA_TYPES[UA_TYPES_CREATEMONITOREDITEMSRESPONSE]);
  663. return response;
  664. }
  665. UA_DeleteMonitoredItemsResponse UA_Client_deleteMonitoredItems(UA_Client *client, UA_DeleteMonitoredItemsRequest *request) {
  666. UA_DeleteMonitoredItemsResponse response;
  667. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_DELETEMONITOREDITEMSREQUEST],
  668. &response, &UA_TYPES[UA_TYPES_DELETEMONITOREDITEMSRESPONSE]);
  669. return response;
  670. }
  671. UA_PublishResponse UA_Client_publish(UA_Client *client, UA_PublishRequest *request) {
  672. UA_PublishResponse response;
  673. synchronousRequest(client, request, &UA_TYPES[UA_TYPES_PUBLISHREQUEST],
  674. &response, &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  675. return response;
  676. }
  677. UA_Int32 UA_Client_newSubscription(UA_Client *client, UA_Int32 publishInterval) {
  678. UA_Int32 retval;
  679. UA_CreateSubscriptionRequest aReq;
  680. UA_CreateSubscriptionResponse aRes;
  681. UA_CreateSubscriptionRequest_init(&aReq);
  682. UA_CreateSubscriptionResponse_init(&aRes);
  683. aReq.maxNotificationsPerPublish = 10;
  684. aReq.priority = 0;
  685. aReq.publishingEnabled = UA_TRUE;
  686. aReq.requestedLifetimeCount = 100;
  687. aReq.requestedMaxKeepAliveCount = 10;
  688. aReq.requestedPublishingInterval = publishInterval;
  689. aRes = UA_Client_createSubscription(client, &aReq);
  690. if (aRes.responseHeader.serviceResult == UA_STATUSCODE_GOOD) {
  691. UA_Client_Subscription *newSub = UA_malloc(sizeof(UA_Client_Subscription));
  692. LIST_INIT(&newSub->MonitoredItems);
  693. newSub->LifeTime = aRes.revisedLifetimeCount;
  694. newSub->KeepAliveCount = aRes.revisedMaxKeepAliveCount;
  695. newSub->PublishingInterval = aRes.revisedPublishingInterval;
  696. newSub->SubscriptionID = aRes.subscriptionId;
  697. newSub->NotificationsPerPublish = aReq.maxNotificationsPerPublish;
  698. newSub->Priority = aReq.priority;
  699. retval = newSub->SubscriptionID;
  700. LIST_INSERT_HEAD(&(client->subscriptions), newSub, listEntry);
  701. } else
  702. retval = 0;
  703. UA_CreateSubscriptionResponse_deleteMembers(&aRes);
  704. UA_CreateSubscriptionRequest_deleteMembers(&aReq);
  705. return retval;
  706. }
  707. UA_StatusCode UA_Client_removeSubscription(UA_Client *client, UA_UInt32 subscriptionId) {
  708. UA_Client_Subscription *sub;
  709. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  710. LIST_FOREACH(sub, &(client->subscriptions), listEntry) {
  711. if (sub->SubscriptionID == subscriptionId)
  712. break;
  713. }
  714. // Problem? We do not have this subscription registeres. Maybe the server should
  715. // be consulted at this point?
  716. if (sub == NULL)
  717. return UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  718. UA_DeleteSubscriptionsRequest request;
  719. UA_DeleteSubscriptionsResponse response;
  720. UA_DeleteSubscriptionsRequest_init(&request);
  721. UA_DeleteSubscriptionsResponse_init(&response);
  722. request.subscriptionIdsSize=1;
  723. request.subscriptionIds = (UA_UInt32 *) UA_malloc(sizeof(UA_UInt32));
  724. *(request.subscriptionIds) = sub->SubscriptionID;
  725. UA_Client_MonitoredItem *mon, *tmpmon;
  726. LIST_FOREACH_SAFE(mon, &(sub->MonitoredItems), listEntry, tmpmon) {
  727. retval |= UA_Client_unMonitorItemChanges(client, sub->SubscriptionID, mon->MonitoredItemId);
  728. }
  729. if (retval != UA_STATUSCODE_GOOD){
  730. UA_DeleteSubscriptionsRequest_deleteMembers(&request);
  731. return retval;
  732. }
  733. response = UA_Client_deleteSubscriptions(client, &request);
  734. if (response.resultsSize > 0)
  735. retval = response.results[0];
  736. else
  737. retval = response.responseHeader.serviceResult;
  738. if (retval == UA_STATUSCODE_GOOD) {
  739. LIST_REMOVE(sub, listEntry);
  740. UA_free(sub);
  741. }
  742. UA_DeleteSubscriptionsRequest_deleteMembers(&request);
  743. UA_DeleteSubscriptionsResponse_deleteMembers(&response);
  744. return retval;
  745. }
  746. UA_UInt32 UA_Client_monitorItemChanges(UA_Client *client, UA_UInt32 subscriptionId,
  747. UA_NodeId nodeId, UA_UInt32 attributeID, void *handlingFunction) {
  748. UA_Client_Subscription *sub;
  749. UA_StatusCode retval = 0;
  750. LIST_FOREACH(sub, &(client->subscriptions), listEntry) {
  751. if (sub->SubscriptionID == subscriptionId)
  752. break;
  753. }
  754. // Maybe the same problem as in DeleteSubscription... ask the server?
  755. if (sub == NULL)
  756. return UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  757. UA_CreateMonitoredItemsRequest request;
  758. UA_CreateMonitoredItemsResponse response;
  759. UA_CreateMonitoredItemsRequest_init(&request);
  760. UA_CreateMonitoredItemsResponse_init(&response);
  761. request.subscriptionId = subscriptionId;
  762. request.itemsToCreateSize = 1;
  763. request.itemsToCreate = UA_MonitoredItemCreateRequest_new();
  764. UA_NodeId_copy(&nodeId, &((request.itemsToCreate[0]).itemToMonitor.nodeId));
  765. (request.itemsToCreate[0]).itemToMonitor.attributeId = attributeID;
  766. (request.itemsToCreate[0]).monitoringMode = UA_MONITORINGMODE_REPORTING;
  767. (request.itemsToCreate[0]).requestedParameters.clientHandle = ++(client->monitoredItemHandles);
  768. (request.itemsToCreate[0]).requestedParameters.samplingInterval = sub->PublishingInterval;
  769. (request.itemsToCreate[0]).requestedParameters.discardOldest = UA_TRUE;
  770. (request.itemsToCreate[0]).requestedParameters.queueSize = 1;
  771. // Filter can be left void for now, only changes are supported (UA_Expert does the same with changeItems)
  772. response = UA_Client_createMonitoredItems(client, &request);
  773. // slight misuse of retval here to check if the deletion was successfull.
  774. if (response.resultsSize == 0)
  775. retval = response.responseHeader.serviceResult;
  776. else
  777. retval = response.results[0].statusCode;
  778. if (retval == UA_STATUSCODE_GOOD) {
  779. UA_Client_MonitoredItem *newMon = (UA_Client_MonitoredItem *) UA_malloc(sizeof(UA_Client_MonitoredItem));
  780. newMon->MonitoringMode = UA_MONITORINGMODE_REPORTING;
  781. UA_NodeId_copy(&nodeId, &(newMon->monitoredNodeId));
  782. newMon->AttributeID = attributeID;
  783. newMon->ClientHandle = client->monitoredItemHandles;
  784. newMon->SamplingInterval = sub->PublishingInterval;
  785. newMon->QueueSize = 1;
  786. newMon->DiscardOldest = UA_TRUE;
  787. newMon->handler = handlingFunction;
  788. newMon->MonitoredItemId = response.results[0].monitoredItemId;
  789. LIST_INSERT_HEAD(&(sub->MonitoredItems), newMon, listEntry);
  790. retval = newMon->MonitoredItemId ;
  791. }
  792. else {
  793. retval = 0;
  794. }
  795. UA_CreateMonitoredItemsRequest_deleteMembers(&request);
  796. UA_CreateMonitoredItemsResponse_deleteMembers(&response);
  797. return retval;
  798. }
  799. UA_StatusCode UA_Client_unMonitorItemChanges(UA_Client *client, UA_UInt32 subscriptionId, UA_UInt32 monitoredItemId ) {
  800. UA_Client_Subscription *sub;
  801. UA_StatusCode retval = 0;
  802. LIST_FOREACH(sub, &(client->subscriptions), listEntry) {
  803. if (sub->SubscriptionID == subscriptionId)
  804. break;
  805. }
  806. // Maybe the same problem as in DeleteSubscription... ask the server?
  807. if (sub == NULL)
  808. return UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  809. UA_Client_MonitoredItem *mon, *tmpmon;
  810. LIST_FOREACH_SAFE(mon, &(sub->MonitoredItems), listEntry, tmpmon) {
  811. if (mon->MonitoredItemId == monitoredItemId)
  812. break;
  813. }
  814. // Also... ask the server?
  815. if(mon==NULL) {
  816. return UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  817. }
  818. UA_DeleteMonitoredItemsRequest request;
  819. UA_DeleteMonitoredItemsResponse response;
  820. UA_DeleteMonitoredItemsRequest_init(&request);
  821. UA_DeleteMonitoredItemsResponse_init(&response);
  822. request.subscriptionId = sub->SubscriptionID;
  823. request.monitoredItemIdsSize = 1;
  824. request.monitoredItemIds = (UA_UInt32 *) UA_malloc(sizeof(UA_UInt32));
  825. request.monitoredItemIds[0] = mon->MonitoredItemId;
  826. response = UA_Client_deleteMonitoredItems(client, &request);
  827. if (response.resultsSize > 1)
  828. retval = response.results[0];
  829. else
  830. retval = response.responseHeader.serviceResult;
  831. if (retval == 0) {
  832. LIST_REMOVE(mon, listEntry);
  833. UA_NodeId_deleteMembers(&mon->monitoredNodeId);
  834. UA_free(mon);
  835. }
  836. UA_DeleteMonitoredItemsRequest_deleteMembers(&request);
  837. UA_DeleteMonitoredItemsResponse_deleteMembers(&response);
  838. return retval;
  839. }
  840. UA_Boolean UA_Client_processPublishRx(UA_Client *client, UA_PublishResponse response) {
  841. UA_Client_Subscription *sub;
  842. UA_Client_MonitoredItem *mon;
  843. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  844. if(response.responseHeader.serviceResult != UA_STATUSCODE_GOOD)
  845. return UA_FALSE;
  846. // Check if the server has acknowledged any of our ACKS
  847. // Note that a list of serverside status codes may be send without valid publish data, i.e.
  848. // during keepalives or no data availability
  849. UA_Client_NotificationsAckNumber *tmpAck = client->pendingNotificationsAcks.lh_first;
  850. UA_Client_NotificationsAckNumber *nxtAck = tmpAck;
  851. for(int i=0; i<response.resultsSize && nxtAck != NULL; i++) {
  852. tmpAck = nxtAck;
  853. nxtAck = tmpAck->listEntry.le_next;
  854. if (response.results[i] == UA_STATUSCODE_GOOD || response.results[i] == UA_STATUSCODE_BADSEQUENCENUMBERINVALID) {
  855. LIST_REMOVE(tmpAck, listEntry);
  856. UA_free(tmpAck);
  857. }
  858. }
  859. if(response.subscriptionId == 0)
  860. return UA_FALSE;
  861. LIST_FOREACH(sub, &(client->subscriptions), listEntry) {
  862. if (sub->SubscriptionID == response.subscriptionId)
  863. break;
  864. }
  865. if (sub == NULL)
  866. return UA_FALSE;
  867. UA_NotificationMessage msg = response.notificationMessage;
  868. UA_DataChangeNotification dataChangeNotification;
  869. size_t decodingOffset = 0;
  870. for (int k=0; k<msg.notificationDataSize; k++) {
  871. if (msg.notificationData[k].encoding == UA_EXTENSIONOBJECT_ENCODINGMASK_BODYISBYTESTRING) {
  872. if (msg.notificationData[k].typeId.namespaceIndex == 0 && msg.notificationData[k].typeId.identifier.numeric == 811 ) {
  873. // This is a dataChangeNotification
  874. retval |= UA_DataChangeNotification_decodeBinary(&(msg.notificationData[k].body), &decodingOffset, &dataChangeNotification);
  875. UA_MonitoredItemNotification *mitemNot;
  876. for(int i=0; i<dataChangeNotification.monitoredItemsSize; i++) {
  877. mitemNot = &dataChangeNotification.monitoredItems[i];
  878. // find this client handle
  879. LIST_FOREACH(mon, &(sub->MonitoredItems), listEntry) {
  880. if (mon->ClientHandle == mitemNot->clientHandle) {
  881. mon->handler(mitemNot->clientHandle, &(mitemNot->value));
  882. break;
  883. }
  884. }
  885. }
  886. UA_DataChangeNotification_deleteMembers(&dataChangeNotification);
  887. }
  888. else if (msg.notificationData[k].typeId.namespaceIndex == 0 && msg.notificationData[k].typeId.identifier.numeric == 820 ) {
  889. //FIXME: This is a statusChangeNotification (not supported yet)
  890. continue;
  891. }
  892. else if (msg.notificationData[k].typeId.namespaceIndex == 0 && msg.notificationData[k].typeId.identifier.numeric == 916 ) {
  893. //FIXME: This is an EventNotification
  894. continue;
  895. }
  896. }
  897. }
  898. // We processed this message, add it to the list of pending acks (but make sure it's not in the list first)
  899. LIST_FOREACH(tmpAck, &(client->pendingNotificationsAcks), listEntry) {
  900. if (tmpAck->subAck.sequenceNumber == msg.sequenceNumber &&
  901. tmpAck->subAck.subscriptionId == response.subscriptionId)
  902. break;
  903. }
  904. if (tmpAck == NULL ){
  905. tmpAck = (UA_Client_NotificationsAckNumber *) UA_malloc(sizeof(UA_Client_NotificationsAckNumber));
  906. tmpAck->subAck.sequenceNumber = msg.sequenceNumber;
  907. tmpAck->subAck.subscriptionId = sub->SubscriptionID;
  908. tmpAck->listEntry.le_next = UA_NULL;
  909. tmpAck->listEntry.le_prev = UA_NULL;
  910. LIST_INSERT_HEAD(&(client->pendingNotificationsAcks), tmpAck, listEntry);
  911. }
  912. return response.moreNotifications;
  913. }
  914. void UA_Client_doPublish(UA_Client *client) {
  915. UA_PublishRequest request;
  916. UA_PublishResponse response;
  917. UA_Client_NotificationsAckNumber *ack;
  918. UA_Boolean moreNotifications = UA_TRUE;
  919. int index = 0 ;
  920. do {
  921. UA_PublishRequest_init(&request);
  922. UA_PublishResponse_init(&response);
  923. request.subscriptionAcknowledgementsSize = 0;
  924. LIST_FOREACH(ack, &(client->pendingNotificationsAcks), listEntry) {
  925. request.subscriptionAcknowledgementsSize++;
  926. }
  927. request.subscriptionAcknowledgements = (UA_SubscriptionAcknowledgement *) UA_malloc(sizeof(UA_SubscriptionAcknowledgement)*request.subscriptionAcknowledgementsSize);
  928. index = 0;
  929. LIST_FOREACH(ack, &(client->pendingNotificationsAcks), listEntry) {
  930. request.subscriptionAcknowledgements[index].sequenceNumber = ack->subAck.sequenceNumber;
  931. request.subscriptionAcknowledgements[index].subscriptionId = ack->subAck.subscriptionId;
  932. index++;
  933. }
  934. response = UA_Client_publish(client, &request);
  935. if (response.responseHeader.serviceResult == UA_STATUSCODE_GOOD)
  936. moreNotifications = UA_Client_processPublishRx(client, response);
  937. else
  938. moreNotifications = UA_FALSE;
  939. UA_PublishResponse_deleteMembers(&response);
  940. UA_PublishRequest_deleteMembers(&request);
  941. } while(moreNotifications == UA_TRUE);
  942. return;
  943. }
  944. #endif
  945. /**********************************/
  946. /* User-Facing Macros-Function */
  947. /**********************************/
  948. #ifdef ENABLE_METHODCALLS
  949. UA_CallResponse UA_Client_call(UA_Client *client, UA_CallRequest *request) {
  950. UA_CallResponse response;
  951. synchronousRequest(client, (UA_RequestHeader*)request, &UA_TYPES[UA_TYPES_CALLREQUEST],
  952. &response, &UA_TYPES[UA_TYPES_CALLRESPONSE]);
  953. return response;
  954. }
  955. UA_StatusCode UA_Client_CallServerMethod(UA_Client *client, UA_NodeId objectNodeId, UA_NodeId methodNodeId,
  956. UA_Int32 inputSize, const UA_Variant *input,
  957. UA_Int32 *outputSize, UA_Variant **output) {
  958. UA_CallRequest request;
  959. UA_CallRequest_init(&request);
  960. request.methodsToCallSize = 1;
  961. request.methodsToCall = UA_CallMethodRequest_new();
  962. if(!request.methodsToCall)
  963. return UA_STATUSCODE_BADOUTOFMEMORY;
  964. UA_CallMethodRequest *rq = &request.methodsToCall[0];
  965. UA_NodeId_copy(&methodNodeId, &rq->methodId);
  966. UA_NodeId_copy(&objectNodeId, &rq->objectId);
  967. rq->inputArguments = (void*)(uintptr_t)input; // cast const...
  968. rq->inputArgumentsSize = inputSize;
  969. UA_CallResponse response;
  970. response = UA_Client_call(client, &request);
  971. rq->inputArguments = UA_NULL;
  972. rq->inputArgumentsSize = -1;
  973. UA_CallRequest_deleteMembers(&request);
  974. UA_StatusCode retval = response.responseHeader.serviceResult;
  975. if(response.resultsSize > 0){
  976. retval |= response.results[0].statusCode;
  977. if(retval == UA_STATUSCODE_GOOD) {
  978. *output = response.results[0].outputArguments;
  979. *outputSize = response.results[0].outputArgumentsSize;
  980. response.results[0].outputArguments = UA_NULL;
  981. response.results[0].outputArgumentsSize = -1;
  982. }
  983. }
  984. UA_CallResponse_deleteMembers(&response);
  985. return retval;
  986. }
  987. #endif
  988. UA_StatusCode __UA_Client_addNode(UA_Client *client, const UA_NodeClass nodeClass,
  989. const UA_NodeId requestedNewNodeId, const UA_NodeId parentNodeId,
  990. const UA_NodeId referenceTypeId, const UA_QualifiedName browseName,
  991. const UA_NodeId typeDefinition, const UA_NodeAttributes *attr,
  992. const UA_DataType *attributeType, UA_NodeId *outNewNodeId) {
  993. UA_StatusCode retval = UA_STATUSCODE_GOOD;
  994. UA_AddNodesRequest request;
  995. UA_AddNodesRequest_init(&request);
  996. UA_AddNodesItem item;
  997. UA_AddNodesItem_init(&item);
  998. item.parentNodeId.nodeId = parentNodeId;
  999. item.referenceTypeId = referenceTypeId;
  1000. item.requestedNewNodeId.nodeId = requestedNewNodeId;
  1001. item.browseName = browseName;
  1002. item.nodeClass = nodeClass;
  1003. item.typeDefinition.nodeId = typeDefinition;
  1004. size_t attributes_length = UA_calcSizeBinary(attr, attributeType);
  1005. item.nodeAttributes.typeId = attributeType->typeId;
  1006. item.nodeAttributes.encoding = UA_EXTENSIONOBJECT_ENCODINGMASK_BODYISBYTESTRING;
  1007. retval = UA_ByteString_newMembers(&item.nodeAttributes.body, attributes_length);
  1008. if(retval != UA_STATUSCODE_GOOD)
  1009. return retval;
  1010. size_t offset = 0;
  1011. retval = UA_encodeBinary(attr, attributeType, &item.nodeAttributes.body, &offset);
  1012. if(retval != UA_STATUSCODE_GOOD) {
  1013. UA_ByteString_deleteMembers(&item.nodeAttributes.body);
  1014. return retval;
  1015. }
  1016. request.nodesToAdd = &item;
  1017. request.nodesToAddSize = 1;
  1018. UA_AddNodesResponse response = UA_Client_addNodes(client, &request);
  1019. UA_ByteString_deleteMembers(&item.nodeAttributes.body);
  1020. if(response.responseHeader.serviceResult != UA_STATUSCODE_GOOD) {
  1021. retval = response.responseHeader.serviceResult;
  1022. UA_AddNodesResponse_deleteMembers(&response);
  1023. return retval;
  1024. }
  1025. if(response.resultsSize != 1) {
  1026. UA_AddNodesResponse_deleteMembers(&response);
  1027. return UA_STATUSCODE_BADTOOMANYOPERATIONS;
  1028. }
  1029. if(outNewNodeId && response.results[0].statusCode) {
  1030. *outNewNodeId = response.results[0].addedNodeId;
  1031. UA_NodeId_init(&response.results[0].addedNodeId);
  1032. }
  1033. return response.results[0].statusCode;
  1034. }