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);
166 if (g_networkPacketCallback)
168 g_networkPacketCallback(sep, data, dataLength);
173 static ssize_t CATCPPacketSendCB(CAEndpoint_t *endpoint, const void *data, size_t dataLength)
175 OIC_LOG_V(DEBUG, TAG, "In %s", __func__);
176 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint is NULL", -1);
177 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", -1);
179 OIC_LOG_V(DEBUG, TAG, "Address: %s, port:%d", endpoint->addr, endpoint->port);
180 OIC_LOG_BUFFER(DEBUG, TAG, data, dataLength);
182 ssize_t ret = CATCPSendData(endpoint, data, dataLength);
183 OIC_LOG_V(DEBUG, TAG, "Out %s : %d bytes sent", __func__, ret);
188 static void CATCPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
189 size_t dataLength, CAResult_t result)
191 VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
192 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
196 g_errorCallback(endpoint, data, dataLength, result);
200 static void CATCPConnectionHandler(const CAEndpoint_t *endpoint, bool isConnected)
202 // Pass the changed connection status to RI Layer for keepalive.
203 if (g_connKeepAliveCallback)
205 g_connKeepAliveCallback(endpoint, isConnected);
208 // Pass the changed connection status to CAUtil.
209 if (g_connectionChangeCallback)
211 g_connectionChangeCallback(endpoint, isConnected);
215 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler)
217 g_connKeepAliveCallback = ConnHandler;
220 void CATCPAdapterHandler(CATransportAdapter_t adapter, CANetworkStatus_t status)
222 if (g_networkChangeCallback)
224 g_networkChangeCallback(adapter, status);
227 if (CA_INTERFACE_DOWN == status)
229 OIC_LOG(DEBUG, TAG, "Network status is down, close all session");
232 else if (CA_INTERFACE_UP == status)
234 OIC_LOG(DEBUG, TAG, "Network status is up, create new socket for listening");
236 CAResult_t ret = CA_STATUS_FAILED;
237 #ifndef SINGLE_THREAD
238 ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
240 ret = CATCPStartServer();
242 if (CA_STATUS_OK != ret)
244 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
249 static void CAInitializeTCPGlobals()
251 caglobals.tcp.ipv4.fd = -1;
252 caglobals.tcp.ipv6.fd = -1;
253 caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
254 caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
255 caglobals.tcp.svrlist = NULL;
257 CATransportFlags_t flags = 0;
258 if (caglobals.client)
260 flags |= caglobals.clientFlags;
262 if (caglobals.server)
264 flags |= caglobals.serverFlags;
267 caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
268 caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
271 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
272 CANetworkPacketReceivedCallback networkPacketCallback,
273 CAAdapterChangeCallback netCallback,
274 CAConnectionChangeCallback connCallback,
275 CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
277 OIC_LOG(DEBUG, TAG, "IN");
278 VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
279 VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
280 VERIFY_NON_NULL(netCallback, TAG, "netCallback");
281 #ifndef SINGLE_THREAD
282 VERIFY_NON_NULL(handle, TAG, "thread pool handle");
285 g_networkChangeCallback = netCallback;
286 g_connectionChangeCallback = connCallback;
287 g_networkPacketCallback = networkPacketCallback;
288 g_errorCallback = errorCallback;
290 CAInitializeTCPGlobals();
291 #ifndef SINGLE_THREAD
292 caglobals.tcp.threadpool = handle;
295 CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
296 CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
297 CATCPSetErrorHandler(CATCPErrorHandler);
300 if (CA_STATUS_OK != CAinitSslAdapter())
302 OIC_LOG(ERROR, TAG, "Failed to init SSL adapter");
306 CAsetSslAdapterCallbacks(CATCPPacketReceivedCB, CATCPPacketSendCB, CA_ADAPTER_TCP);
310 CAConnectivityHandler_t tcpHandler = {
311 .startAdapter = CAStartTCP,
312 .startListenServer = CAStartTCPListeningServer,
313 .stopListenServer = CAStopTCPListeningServer,
314 .startDiscoveryServer = CAStartTCPDiscoveryServer,
315 .sendData = CASendTCPUnicastData,
316 .sendDataToAll = CASendTCPMulticastData,
317 .GetnetInfo = CAGetTCPInterfaceInformation,
318 .readData = CAReadTCPData,
319 .stopAdapter = CAStopTCP,
320 .terminate = CATerminateTCP,
321 .cType = CA_ADAPTER_TCP};
323 registerCallback(tcpHandler);
325 OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
329 CAResult_t CAStartTCP()
331 OIC_LOG(DEBUG, TAG, "IN");
333 // Start network monitoring to receive adapter status changes.
334 CAIPStartNetworkMonitor(CATCPAdapterHandler, CA_ADAPTER_TCP);
336 // Set the port number received from application.
337 caglobals.tcp.ipv4.port = caglobals.ports.tcp.u4;
338 caglobals.tcp.ipv6.port = caglobals.ports.tcp.u6;
340 #ifndef SINGLE_THREAD
341 if (CA_STATUS_OK != CATCPInitializeQueueHandles())
343 OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
345 return CA_STATUS_FAILED;
348 // Start send queue thread
349 if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
351 OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
352 return CA_STATUS_FAILED;
355 CAResult_t ret = CATCPStartServer();
356 if (CA_STATUS_OK != ret)
358 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
366 CAResult_t CAStartTCPListeningServer()
368 #ifndef SINGLE_THREAD
369 if (!caglobals.server)
371 caglobals.server = true; // only needed to run CA tests
374 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
375 if (CA_STATUS_OK != ret)
377 OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
385 CAResult_t CAStopTCPListeningServer()
390 CAResult_t CAStartTCPDiscoveryServer()
392 if (!caglobals.client)
394 caglobals.client = true; // only needed to run CA tests
397 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
398 if (CA_STATUS_OK != ret)
400 OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
407 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
408 const void *data, size_t dataLength)
410 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
411 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
415 OIC_LOG(ERROR, TAG, "Invalid Data Length");
419 VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
421 // Create TCPData to add to queue
422 CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
425 OIC_LOG(ERROR, TAG, "Failed to create ipData!");
428 // Add message to send queue
429 CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
434 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
435 const void *data, uint32_t dataLength,
436 CADataType_t dataType)
438 OIC_LOG(DEBUG, TAG, "IN");
440 #ifndef SINGLE_THREAD
441 return CAQueueTCPData(false, endpoint, data, dataLength);
443 return CATCPSendData(endpoint, data, dataLength);
447 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
448 const void *data, uint32_t dataLength,
449 CADataType_t dataType)
452 return CAQueueTCPData(true, endpoint, data, dataLength);
455 CAResult_t CAReadTCPData()
457 OIC_LOG(DEBUG, TAG, "IN");
464 CAResult_t CAStopTCP()
466 CAIPStopNetworkMonitor(CA_ADAPTER_TCP);
468 #ifndef SINGLE_THREAD
469 if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
471 CAQueueingThreadStop(g_sendQueueHandle);
473 CATCPDeinitializeQueueHandles();
478 //Re-initializing the Globals to start them again
479 CAInitializeTCPGlobals();
482 CAdeinitSslAdapter();
488 void CATerminateTCP()
491 CATCPSetPacketReceiveCallback(NULL);
494 void CATCPSendDataThread(void *threadData)
496 CATCPData *tcpData = (CATCPData *) threadData;
499 OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
503 if (caglobals.tcp.terminate)
505 OIC_LOG(DEBUG, TAG, "Adapter is not enabled");
506 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
511 if (tcpData->isMulticast)
513 //Processing for sending multicast
514 OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
519 // Check payload length from CoAP over TCP format header.
520 CAResult_t result = CA_STATUS_OK;
521 size_t payloadLen = CACheckPayloadLengthFromHeader(tcpData->data, tcpData->dataLen);
524 // if payload length is zero, disconnect from remote device.
525 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
527 if (CA_STATUS_OK != CAcloseSslConnection(tcpData->remoteEndpoint))
529 OIC_LOG(ERROR, TAG, "Failed to close TLS session");
532 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
537 if (tcpData->remoteEndpoint && tcpData->remoteEndpoint->flags & CA_SECURE)
539 OIC_LOG(DEBUG, TAG, "CAencryptSsl called!");
540 result = CAencryptSsl(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
542 if (CA_STATUS_OK != result)
544 OIC_LOG(ERROR, TAG, "CAAdapterNetDtlsEncrypt failed!");
545 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
546 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
549 OIC_LOG_V(DEBUG, TAG,
550 "CAAdapterNetDtlsEncrypt returned with result[%d]", result);
554 //Processing for sending unicast
555 ssize_t dlen = CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
558 OIC_LOG(ERROR, TAG, "CATCPSendData failed");
559 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
560 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
566 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
567 size_t dataLength, bool isMulticast)
569 VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
570 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
572 CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
575 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
579 tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
580 tcpData->data = (void *) OICMalloc(dataLength);
583 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
584 CAFreeTCPData(tcpData);
588 memcpy(tcpData->data, data, dataLength);
589 tcpData->dataLen = dataLength;
591 tcpData->isMulticast = isMulticast;
596 void CAFreeTCPData(CATCPData *tcpData)
598 VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
600 CAFreeEndpoint(tcpData->remoteEndpoint);
601 OICFree(tcpData->data);
605 void CADataDestroyer(void *data, uint32_t size)
607 if (size < sizeof(CATCPData))
609 OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
611 CATCPData *TCPData = (CATCPData *) data;
613 CAFreeTCPData(TCPData);
617 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size)
619 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
621 if (NULL == recvBuffer || !size)
623 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
627 coap_transport_t transport = coap_get_tcp_header_type_from_initbyte(
628 ((unsigned char *)recvBuffer)[0] >> 4);
629 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
631 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
633 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
634 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
635 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
637 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
638 return headerLen + optPaylaodLen;
641 void CAGetTCPHeaderDetails(unsigned char* recvBuffer, coap_transport_t *transport,
644 if (NULL == recvBuffer)
646 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
650 if (NULL == transport)
652 OIC_LOG(ERROR, TAG, "transport is NULL");
656 if (NULL == headerlen)
658 OIC_LOG(ERROR, TAG, "headerlen is NULL");
662 *transport = coap_get_tcp_header_type_from_initbyte(
663 ((unsigned char *)recvBuffer)[0] >> 4);
664 *headerlen = coap_get_tcp_header_length_for_transport(*transport);