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.ipv4s.fd = -1;
298 caglobals.tcp.ipv6.fd = -1;
299 caglobals.tcp.ipv6s.fd = -1;
301 // Set the port number received from application.
302 caglobals.tcp.ipv4.port = caglobals.ports.tcp.u4;
303 caglobals.tcp.ipv4s.port = caglobals.ports.tcp.u4s;
304 caglobals.tcp.ipv6.port = caglobals.ports.tcp.u6;
305 caglobals.tcp.ipv6s.port = caglobals.ports.tcp.u6s;
307 caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
308 caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
309 caglobals.tcp.svrlist = NULL;
311 CATransportFlags_t flags = 0;
312 if (caglobals.client)
314 flags |= caglobals.clientFlags;
316 if (caglobals.server)
318 flags |= caglobals.serverFlags;
321 caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
322 caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
325 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
326 CANetworkPacketReceivedCallback networkPacketCallback,
327 CAAdapterChangeCallback netCallback,
328 CAConnectionChangeCallback connCallback,
329 CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
331 OIC_LOG(DEBUG, TAG, "IN");
332 VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
333 VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
334 VERIFY_NON_NULL(netCallback, TAG, "netCallback");
335 #ifndef SINGLE_THREAD
336 VERIFY_NON_NULL(handle, TAG, "thread pool handle");
339 g_networkChangeCallback = netCallback;
340 g_connectionChangeCallback = connCallback;
341 g_networkPacketCallback = networkPacketCallback;
342 g_errorCallback = errorCallback;
344 CAInitializeTCPGlobals();
345 #ifndef SINGLE_THREAD
346 caglobals.tcp.threadpool = handle;
349 CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
350 CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
351 CATCPSetErrorHandler(CATCPErrorHandler);
354 if (CA_STATUS_OK != CAinitSslAdapter())
356 OIC_LOG(ERROR, TAG, "Failed to init SSL adapter");
360 CAsetSslAdapterCallbacks(CATCPPacketReceivedCB, CATCPPacketSendCB, CA_ADAPTER_TCP);
364 CAConnectivityHandler_t tcpHandler = {
365 .startAdapter = CAStartTCP,
366 .startListenServer = CAStartTCPListeningServer,
367 .stopListenServer = CAStopTCPListeningServer,
368 .startDiscoveryServer = CAStartTCPDiscoveryServer,
369 .sendData = CASendTCPUnicastData,
370 .sendDataToAll = CASendTCPMulticastData,
371 .GetnetInfo = CAGetTCPInterfaceInformation,
372 .readData = CAReadTCPData,
373 .stopAdapter = CAStopTCP,
374 .terminate = CATerminateTCP,
375 .cType = CA_ADAPTER_TCP};
377 registerCallback(tcpHandler);
379 OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
383 CAResult_t CAStartTCP()
385 OIC_LOG(DEBUG, TAG, "IN");
387 // Start network monitoring to receive adapter status changes.
388 CAIPStartNetworkMonitor(CATCPAdapterHandler, CA_ADAPTER_TCP);
390 #ifndef SINGLE_THREAD
391 if (CA_STATUS_OK != CATCPInitializeQueueHandles())
393 OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
395 return CA_STATUS_FAILED;
398 // Start send queue thread
399 if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
401 OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
402 return CA_STATUS_FAILED;
405 CAResult_t ret = CATCPStartServer();
406 if (CA_STATUS_OK != ret)
408 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
416 CAResult_t CAStartTCPListeningServer()
418 #ifndef SINGLE_THREAD
419 if (!caglobals.server)
421 caglobals.server = true; // only needed to run CA tests
424 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
425 if (CA_STATUS_OK != ret)
427 OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
435 CAResult_t CAStopTCPListeningServer()
440 CAResult_t CAStartTCPDiscoveryServer()
442 if (!caglobals.client)
444 caglobals.client = true; // only needed to run CA tests
447 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
448 if (CA_STATUS_OK != ret)
450 OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
457 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
458 const void *data, size_t dataLength)
460 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
461 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
465 OIC_LOG(ERROR, TAG, "Invalid Data Length");
469 VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
471 // Create TCPData to add to queue
472 CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
475 OIC_LOG(ERROR, TAG, "Failed to create ipData!");
478 // Add message to send queue
479 CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
484 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
485 const void *data, uint32_t dataLength,
486 CADataType_t dataType)
488 OIC_LOG(DEBUG, TAG, "IN");
490 #ifndef SINGLE_THREAD
491 return CAQueueTCPData(false, endpoint, data, dataLength);
493 return CATCPSendData(endpoint, data, dataLength);
497 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
498 const void *data, uint32_t dataLength,
499 CADataType_t dataType)
502 return CAQueueTCPData(true, endpoint, data, dataLength);
505 CAResult_t CAReadTCPData()
507 OIC_LOG(DEBUG, TAG, "IN");
514 CAResult_t CAStopTCP()
516 CAIPStopNetworkMonitor(CA_ADAPTER_TCP);
518 #ifndef SINGLE_THREAD
519 if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
521 CAQueueingThreadStop(g_sendQueueHandle);
523 CATCPDeinitializeQueueHandles();
528 //Re-initializing the Globals to start them again
529 CAInitializeTCPGlobals();
532 CAdeinitSslAdapter();
538 void CATerminateTCP()
541 CATCPSetPacketReceiveCallback(NULL);
544 void CATCPSendDataThread(void *threadData)
546 CATCPData *tcpData = (CATCPData *) threadData;
549 OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
553 if (caglobals.tcp.terminate)
555 OIC_LOG(DEBUG, TAG, "Adapter is not enabled");
556 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
561 if (tcpData->isMulticast)
563 //Processing for sending multicast
564 OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
569 // Check payload length from CoAP over TCP format header.
570 CAResult_t result = CA_STATUS_OK;
571 size_t payloadLen = CACheckPayloadLengthFromHeader(tcpData->data, tcpData->dataLen);
574 // if payload length is zero, disconnect from remote device.
575 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
577 if (CA_STATUS_OK != CAcloseSslConnection(tcpData->remoteEndpoint))
579 OIC_LOG(ERROR, TAG, "Failed to close TLS session");
582 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
587 if (tcpData->remoteEndpoint && tcpData->remoteEndpoint->flags & CA_SECURE)
589 OIC_LOG(DEBUG, TAG, "CAencryptSsl called!");
590 result = CAencryptSsl(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
592 if (CA_STATUS_OK != result)
594 OIC_LOG(ERROR, TAG, "CAAdapterNetDtlsEncrypt failed!");
595 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
596 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
599 OIC_LOG_V(DEBUG, TAG,
600 "CAAdapterNetDtlsEncrypt returned with result[%d]", result);
604 //Processing for sending unicast
605 ssize_t dlen = CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
608 OIC_LOG(ERROR, TAG, "CATCPSendData failed");
609 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
610 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
616 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
617 size_t dataLength, bool isMulticast)
619 VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
620 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
622 CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
625 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
629 tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
630 tcpData->data = (void *) OICMalloc(dataLength);
633 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
634 CAFreeTCPData(tcpData);
638 memcpy(tcpData->data, data, dataLength);
639 tcpData->dataLen = dataLength;
641 tcpData->isMulticast = isMulticast;
646 void CAFreeTCPData(CATCPData *tcpData)
648 VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
650 CAFreeEndpoint(tcpData->remoteEndpoint);
651 OICFree(tcpData->data);
655 void CADataDestroyer(void *data, uint32_t size)
657 if (size < sizeof(CATCPData))
659 OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
661 CATCPData *TCPData = (CATCPData *) data;
663 CAFreeTCPData(TCPData);
667 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size)
669 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
671 if (NULL == recvBuffer || !size)
673 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
677 coap_transport_t transport = coap_get_tcp_header_type_from_initbyte(
678 ((unsigned char *)recvBuffer)[0] >> 4);
679 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
681 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
683 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
684 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
685 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
687 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
688 return headerLen + optPaylaodLen;
691 void CAGetTCPHeaderDetails(unsigned char* recvBuffer, coap_transport_t *transport,
694 if (NULL == recvBuffer)
696 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
700 if (NULL == transport)
702 OIC_LOG(ERROR, TAG, "transport is NULL");
706 if (NULL == headerlen)
708 OIC_LOG(ERROR, TAG, "headerlen is NULL");
712 *transport = coap_get_tcp_header_type_from_initbyte(
713 ((unsigned char *)recvBuffer)[0] >> 4);
714 *headerlen = coap_get_tcp_header_length_for_transport(*transport);