1 /* ****************************************************************
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
19 ******************************************************************/
26 #ifndef __STDC_FORMAT_MACROS
27 #define __STDC_FORMAT_MACROS
31 #include "cainterface.h"
32 #include "caipnwmonitor.h"
33 #include "catcpadapter.h"
34 #include "catcpinterface.h"
35 #include "caqueueingthread.h"
36 #include "caadapterutils.h"
38 #include "uarraylist.h"
39 #include "caremotehandler.h"
41 #include "oic_malloc.h"
43 #include "ca_adapter_net_ssl.h"
47 * Logging tag for module name.
49 #define TAG "OIC_CA_TCP_ADAP"
52 * Holds internal thread TCP data information.
56 CAEndpoint_t *remoteEndpoint;
62 #define CA_TCP_LISTEN_BACKLOG 3
64 #define CA_TCP_SELECT_TIMEOUT 10
67 * Queue handle for Send Data.
69 static CAQueueingThread_t *g_sendQueueHandle = NULL;
72 * Network Packet Received Callback to CA.
74 static CANetworkPacketReceivedCallback g_networkPacketCallback = NULL;
77 * Adapter Changed Callback to CA.
79 static CAAdapterChangeCallback g_networkChangeCallback = NULL;
82 * Connection Changed Callback to CA.
84 static CAConnectionChangeCallback g_connectionChangeCallback = NULL;
87 * error Callback to CA adapter.
89 static CAErrorHandleCallback g_errorCallback = NULL;
91 static void CATCPPacketReceivedCB(const CASecureEndpoint_t *sep,
92 const void *data, uint32_t dataLength);
94 static void CATCPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
95 size_t dataLength, CAResult_t result);
98 * KeepAlive Connected or Disconnected Callback to CA adapter.
100 static CAKeepAliveConnectionCallback g_connKeepAliveCallback = NULL;
102 static CAResult_t CATCPInitializeQueueHandles();
104 static void CATCPDeinitializeQueueHandles();
106 static void CATCPSendDataThread(void *threadData);
108 static CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint,
109 const void *data, size_t dataLength,
111 void CAFreeTCPData(CATCPData *ipData);
113 static void CADataDestroyer(void *data, uint32_t size);
115 CAResult_t CATCPInitializeQueueHandles()
117 // Check if the message queue is already initialized
118 if (g_sendQueueHandle)
120 OIC_LOG(DEBUG, TAG, "send queue handle is already initialized!");
124 // Create send message queue
125 g_sendQueueHandle = OICMalloc(sizeof(CAQueueingThread_t));
126 if (!g_sendQueueHandle)
128 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
129 return CA_MEMORY_ALLOC_FAILED;
132 if (CA_STATUS_OK != CAQueueingThreadInitialize(g_sendQueueHandle,
133 (const ca_thread_pool_t)caglobals.tcp.threadpool,
134 CATCPSendDataThread, CADataDestroyer))
136 OIC_LOG(ERROR, TAG, "Failed to Initialize send queue thread");
137 OICFree(g_sendQueueHandle);
138 g_sendQueueHandle = NULL;
139 return CA_STATUS_FAILED;
145 void CATCPDeinitializeQueueHandles()
147 CAQueueingThreadDestroy(g_sendQueueHandle);
148 OICFree(g_sendQueueHandle);
149 g_sendQueueHandle = NULL;
152 void CATCPConnectionStateCB(const char *ipAddress, CANetworkStatus_t status)
158 void CATCPPacketReceivedCB(const CASecureEndpoint_t *sep, const void *data,
161 VERIFY_NON_NULL_VOID(sep, TAG, "sep is NULL");
162 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
164 OIC_LOG_V(DEBUG, TAG, "Address: %s, port:%d", sep->endpoint.addr, sep->endpoint.port);
167 if (g_networkPacketCallback)
169 g_networkPacketCallback(sep, data, dataLength);
172 unsigned char *buffer = (unsigned char*)data;
173 size_t bufferLen = dataLength;
176 //get remote device information from file descriptor.
177 CATCPSessionInfo_t *svritem = CAGetTCPSessionInfoFromEndpoint(&sep->endpoint, &index);
180 OIC_LOG(ERROR, TAG, "there is no connection information in list");
183 if (UNKNOWN == svritem->protocol)
185 OIC_LOG(ERROR, TAG, "invalid protocol type");
189 //totalLen filled only when header fully read and parsed
190 while (0 != bufferLen)
192 CAResult_t res = CAConstructCoAP(svritem, &buffer, &bufferLen);
193 if (CA_STATUS_OK != res)
195 OIC_LOG_V(ERROR, TAG, "CAConstructCoAP return error : %d", res);
199 //when successfully read all required data - pass them to upper layer.
200 if (svritem->len == svritem->totalLen)
202 if (g_networkPacketCallback)
204 g_networkPacketCallback(sep, svritem->data, svritem->totalLen);
206 CACleanData(svritem);
210 OIC_LOG_V(DEBUG, TAG, "%u bytes required for complete CoAP",
211 svritem->totalLen - svritem->len);
218 static ssize_t CATCPPacketSendCB(CAEndpoint_t *endpoint, const void *data, size_t dataLength)
220 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
221 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", -1);
222 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", -1);
224 OIC_LOG_V(DEBUG, TAG, "Address: %s, port:%d", endpoint->addr, endpoint->port);
225 OIC_LOG_BUFFER(DEBUG, TAG, data, dataLength);
227 ssize_t ret = CATCPSendData(endpoint, data, dataLength);
228 OIC_LOG_V(DEBUG, TAG, "Out %s : %d bytes sent", __func__, ret);
233 static void CATCPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
234 size_t dataLength, CAResult_t result)
236 VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
237 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
241 g_errorCallback(endpoint, data, dataLength, result);
245 static void CATCPConnectionHandler(const CAEndpoint_t *endpoint, bool isConnected)
247 // Pass the changed connection status to RI Layer for keepalive.
248 if (g_connKeepAliveCallback)
250 g_connKeepAliveCallback(endpoint, isConnected);
253 // Pass the changed connection status to CAUtil.
254 if (g_connectionChangeCallback)
256 g_connectionChangeCallback(endpoint, isConnected);
260 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler)
262 g_connKeepAliveCallback = ConnHandler;
265 void CATCPAdapterHandler(CATransportAdapter_t adapter, CANetworkStatus_t status)
267 if (g_networkChangeCallback)
269 g_networkChangeCallback(adapter, status);
272 if (CA_INTERFACE_DOWN == status)
274 OIC_LOG(DEBUG, TAG, "Network status is down, close all session");
277 else if (CA_INTERFACE_UP == status)
279 OIC_LOG(DEBUG, TAG, "Network status is up, create new socket for listening");
281 CAResult_t ret = CA_STATUS_FAILED;
282 #ifndef SINGLE_THREAD
283 ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
285 ret = CATCPStartServer();
287 if (CA_STATUS_OK != ret)
289 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
294 static void CAInitializeTCPGlobals()
296 caglobals.tcp.ipv4.fd = -1;
297 caglobals.tcp.ipv6.fd = -1;
298 caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
299 caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
300 caglobals.tcp.svrlist = NULL;
302 CATransportFlags_t flags = 0;
303 if (caglobals.client)
305 flags |= caglobals.clientFlags;
307 if (caglobals.server)
309 flags |= caglobals.serverFlags;
312 caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
313 caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
316 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
317 CANetworkPacketReceivedCallback networkPacketCallback,
318 CAAdapterChangeCallback netCallback,
319 CAConnectionChangeCallback connCallback,
320 CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
322 OIC_LOG(DEBUG, TAG, "IN");
323 VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
324 VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
325 VERIFY_NON_NULL(netCallback, TAG, "netCallback");
326 #ifndef SINGLE_THREAD
327 VERIFY_NON_NULL(handle, TAG, "thread pool handle");
330 g_networkChangeCallback = netCallback;
331 g_connectionChangeCallback = connCallback;
332 g_networkPacketCallback = networkPacketCallback;
333 g_errorCallback = errorCallback;
335 CAInitializeTCPGlobals();
336 #ifndef SINGLE_THREAD
337 caglobals.tcp.threadpool = handle;
340 CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
341 CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
342 CATCPSetErrorHandler(CATCPErrorHandler);
345 if (CA_STATUS_OK != CAinitSslAdapter())
347 OIC_LOG(ERROR, TAG, "Failed to init SSL adapter");
351 CAsetSslAdapterCallbacks(CATCPPacketReceivedCB, CATCPPacketSendCB, CA_ADAPTER_TCP);
355 CAConnectivityHandler_t tcpHandler = {
356 .startAdapter = CAStartTCP,
357 .startListenServer = CAStartTCPListeningServer,
358 .stopListenServer = CAStopTCPListeningServer,
359 .startDiscoveryServer = CAStartTCPDiscoveryServer,
360 .sendData = CASendTCPUnicastData,
361 .sendDataToAll = CASendTCPMulticastData,
362 .GetnetInfo = CAGetTCPInterfaceInformation,
363 .readData = CAReadTCPData,
364 .stopAdapter = CAStopTCP,
365 .terminate = CATerminateTCP,
366 .cType = CA_ADAPTER_TCP};
368 registerCallback(tcpHandler);
370 OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
374 CAResult_t CAStartTCP()
376 OIC_LOG(DEBUG, TAG, "IN");
378 // Start network monitoring to receive adapter status changes.
379 CAIPStartNetworkMonitor(CATCPAdapterHandler, CA_ADAPTER_TCP);
381 // Set the port number received from application.
382 caglobals.tcp.ipv4.port = caglobals.ports.tcp.u4;
383 caglobals.tcp.ipv6.port = caglobals.ports.tcp.u6;
385 #ifndef SINGLE_THREAD
386 if (CA_STATUS_OK != CATCPInitializeQueueHandles())
388 OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
390 return CA_STATUS_FAILED;
393 // Start send queue thread
394 if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
396 OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
397 return CA_STATUS_FAILED;
400 CAResult_t ret = CATCPStartServer();
401 if (CA_STATUS_OK != ret)
403 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
411 CAResult_t CAStartTCPListeningServer()
413 #ifndef SINGLE_THREAD
414 if (!caglobals.server)
416 caglobals.server = true; // only needed to run CA tests
419 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
420 if (CA_STATUS_OK != ret)
422 OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
430 CAResult_t CAStopTCPListeningServer()
435 CAResult_t CAStartTCPDiscoveryServer()
437 if (!caglobals.client)
439 caglobals.client = true; // only needed to run CA tests
442 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
443 if (CA_STATUS_OK != ret)
445 OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
452 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
453 const void *data, size_t dataLength)
455 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
456 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
460 OIC_LOG(ERROR, TAG, "Invalid Data Length");
464 VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
466 // Create TCPData to add to queue
467 CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
470 OIC_LOG(ERROR, TAG, "Failed to create ipData!");
473 // Add message to send queue
474 CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
479 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
480 const void *data, uint32_t dataLength,
481 CADataType_t dataType)
483 OIC_LOG(DEBUG, TAG, "IN");
485 #ifndef SINGLE_THREAD
486 return CAQueueTCPData(false, endpoint, data, dataLength);
488 return CATCPSendData(endpoint, data, dataLength);
492 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
493 const void *data, uint32_t dataLength,
494 CADataType_t dataType)
497 return CAQueueTCPData(true, endpoint, data, dataLength);
500 CAResult_t CAReadTCPData()
502 OIC_LOG(DEBUG, TAG, "IN");
509 CAResult_t CAStopTCP()
511 CAIPStopNetworkMonitor(CA_ADAPTER_TCP);
513 #ifndef SINGLE_THREAD
514 if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
516 CAQueueingThreadStop(g_sendQueueHandle);
518 CATCPDeinitializeQueueHandles();
523 //Re-initializing the Globals to start them again
524 CAInitializeTCPGlobals();
527 CAdeinitSslAdapter();
533 void CATerminateTCP()
536 CATCPSetPacketReceiveCallback(NULL);
539 void CATCPSendDataThread(void *threadData)
541 CATCPData *tcpData = (CATCPData *) threadData;
544 OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
548 if (caglobals.tcp.terminate)
550 OIC_LOG(DEBUG, TAG, "Adapter is not enabled");
551 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
556 if (tcpData->isMulticast)
558 //Processing for sending multicast
559 OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
564 // Check payload length from CoAP over TCP format header.
565 CAResult_t result = CA_STATUS_OK;
566 size_t payloadLen = CACheckPayloadLengthFromHeader(tcpData->data, tcpData->dataLen);
569 // if payload length is zero, disconnect from remote device.
570 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
572 if (CA_STATUS_OK != CAcloseSslConnection(tcpData->remoteEndpoint))
574 OIC_LOG(ERROR, TAG, "Failed to close TLS session");
577 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
582 if (tcpData->remoteEndpoint && tcpData->remoteEndpoint->flags & CA_SECURE)
584 OIC_LOG(DEBUG, TAG, "CAencryptSsl called!");
585 result = CAencryptSsl(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
587 if (CA_STATUS_OK != result)
589 OIC_LOG(ERROR, TAG, "CAAdapterNetDtlsEncrypt failed!");
590 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
591 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
594 OIC_LOG_V(DEBUG, TAG,
595 "CAAdapterNetDtlsEncrypt returned with result[%d]", result);
599 //Processing for sending unicast
600 ssize_t dlen = CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
603 OIC_LOG(ERROR, TAG, "CATCPSendData failed");
604 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
605 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
611 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
612 size_t dataLength, bool isMulticast)
614 VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
615 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
617 CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
620 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
624 tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
625 tcpData->data = (void *) OICMalloc(dataLength);
628 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
629 CAFreeTCPData(tcpData);
633 memcpy(tcpData->data, data, dataLength);
634 tcpData->dataLen = dataLength;
636 tcpData->isMulticast = isMulticast;
641 void CAFreeTCPData(CATCPData *tcpData)
643 VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
645 CAFreeEndpoint(tcpData->remoteEndpoint);
646 OICFree(tcpData->data);
650 void CADataDestroyer(void *data, uint32_t size)
652 if (size < sizeof(CATCPData))
654 OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
656 CATCPData *TCPData = (CATCPData *) data;
658 CAFreeTCPData(TCPData);
662 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size)
664 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
666 if (NULL == recvBuffer || !size)
668 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
672 coap_transport_t transport = coap_get_tcp_header_type_from_initbyte(
673 ((unsigned char *)recvBuffer)[0] >> 4);
674 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
676 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
678 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
679 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
680 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
682 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
683 return headerLen + optPaylaodLen;
686 void CAGetTCPHeaderDetails(unsigned char* recvBuffer, coap_transport_t *transport,
689 if (NULL == recvBuffer)
691 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
695 if (NULL == transport)
697 OIC_LOG(ERROR, TAG, "transport is NULL");
701 if (NULL == headerlen)
703 OIC_LOG(ERROR, TAG, "headerlen is NULL");
707 *transport = coap_get_tcp_header_type_from_initbyte(
708 ((unsigned char *)recvBuffer)[0] >> 4);
709 *headerlen = coap_get_tcp_header_length_for_transport(*transport);