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);
185 CASearchAndDeleteTCPSession(endpoint);
186 CATCPErrorHandler(endpoint, data, dataLength, CA_SEND_FAILED);
188 OIC_LOG_V(DEBUG, TAG, "Out %s : %d bytes sent", __func__, ret);
193 static void CATCPErrorHandler(const CAEndpoint_t *endpoint, const void *data,
194 size_t dataLength, CAResult_t result)
196 VERIFY_NON_NULL_VOID(endpoint, TAG, "endpoint is NULL");
197 VERIFY_NON_NULL_VOID(data, TAG, "data is NULL");
201 g_errorCallback(endpoint, data, dataLength, result);
205 static void CATCPConnectionHandler(const CAEndpoint_t *endpoint, bool isConnected)
207 // Pass the changed connection status to RI Layer for keepalive.
208 if (g_connKeepAliveCallback)
210 g_connKeepAliveCallback(endpoint, isConnected);
213 // Pass the changed connection status to CAUtil.
214 if (g_connectionChangeCallback)
216 g_connectionChangeCallback(endpoint, isConnected);
220 void CATCPSetKeepAliveCallbacks(CAKeepAliveConnectionCallback ConnHandler)
222 g_connKeepAliveCallback = ConnHandler;
225 void CATCPAdapterHandler(CATransportAdapter_t adapter, CANetworkStatus_t status)
227 if (g_networkChangeCallback)
229 g_networkChangeCallback(adapter, status);
232 if (CA_INTERFACE_DOWN == status)
234 OIC_LOG(DEBUG, TAG, "Network status is down, close all session");
237 else if (CA_INTERFACE_UP == status)
239 OIC_LOG(DEBUG, TAG, "Network status is up, create new socket for listening");
241 CAResult_t ret = CA_STATUS_FAILED;
242 #ifndef SINGLE_THREAD
243 ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
245 ret = CATCPStartServer();
247 if (CA_STATUS_OK != ret)
249 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
254 static void CAInitializeTCPGlobals()
256 caglobals.tcp.ipv4.fd = -1;
257 caglobals.tcp.ipv6.fd = -1;
258 caglobals.tcp.selectTimeout = CA_TCP_SELECT_TIMEOUT;
259 caglobals.tcp.listenBacklog = CA_TCP_LISTEN_BACKLOG;
260 caglobals.tcp.svrlist = NULL;
262 CATransportFlags_t flags = 0;
263 if (caglobals.client)
265 flags |= caglobals.clientFlags;
267 if (caglobals.server)
269 flags |= caglobals.serverFlags;
272 caglobals.tcp.ipv4tcpenabled = flags & CA_IPV4;
273 caglobals.tcp.ipv6tcpenabled = flags & CA_IPV6;
276 CAResult_t CAInitializeTCP(CARegisterConnectivityCallback registerCallback,
277 CANetworkPacketReceivedCallback networkPacketCallback,
278 CAAdapterChangeCallback netCallback,
279 CAConnectionChangeCallback connCallback,
280 CAErrorHandleCallback errorCallback, ca_thread_pool_t handle)
282 OIC_LOG(DEBUG, TAG, "IN");
283 VERIFY_NON_NULL(registerCallback, TAG, "registerCallback");
284 VERIFY_NON_NULL(networkPacketCallback, TAG, "networkPacketCallback");
285 VERIFY_NON_NULL(netCallback, TAG, "netCallback");
286 #ifndef SINGLE_THREAD
287 VERIFY_NON_NULL(handle, TAG, "thread pool handle");
290 g_networkChangeCallback = netCallback;
291 g_connectionChangeCallback = connCallback;
292 g_networkPacketCallback = networkPacketCallback;
293 g_errorCallback = errorCallback;
295 CAInitializeTCPGlobals();
296 #ifndef SINGLE_THREAD
297 caglobals.tcp.threadpool = handle;
300 CATCPSetConnectionChangedCallback(CATCPConnectionHandler);
301 CATCPSetPacketReceiveCallback(CATCPPacketReceivedCB);
302 CATCPSetErrorHandler(CATCPErrorHandler);
305 if (CA_STATUS_OK != CAinitSslAdapter())
307 OIC_LOG(ERROR, TAG, "Failed to init SSL adapter");
311 CAsetSslAdapterCallbacks(CATCPPacketReceivedCB, CATCPPacketSendCB, CA_ADAPTER_TCP);
315 CAConnectivityHandler_t tcpHandler = {
316 .startAdapter = CAStartTCP,
317 .startListenServer = CAStartTCPListeningServer,
318 .stopListenServer = CAStopTCPListeningServer,
319 .startDiscoveryServer = CAStartTCPDiscoveryServer,
320 .sendData = CASendTCPUnicastData,
321 .sendDataToAll = CASendTCPMulticastData,
322 .GetnetInfo = CAGetTCPInterfaceInformation,
323 .readData = CAReadTCPData,
324 .stopAdapter = CAStopTCP,
325 .terminate = CATerminateTCP,
326 .cType = CA_ADAPTER_TCP};
328 registerCallback(tcpHandler);
330 OIC_LOG(INFO, TAG, "OUT IntializeTCP is Success");
334 CAResult_t CAStartTCP()
336 OIC_LOG(DEBUG, TAG, "IN");
338 // Start network monitoring to receive adapter status changes.
339 CAIPStartNetworkMonitor(CATCPAdapterHandler, CA_ADAPTER_TCP);
341 // Set the port number received from application.
342 caglobals.tcp.ipv4.port = caglobals.ports.tcp.u4;
343 caglobals.tcp.ipv6.port = caglobals.ports.tcp.u6;
345 #ifndef SINGLE_THREAD
346 if (CA_STATUS_OK != CATCPInitializeQueueHandles())
348 OIC_LOG(ERROR, TAG, "Failed to Initialize Queue Handle");
350 return CA_STATUS_FAILED;
353 // Start send queue thread
354 if (CA_STATUS_OK != CAQueueingThreadStart(g_sendQueueHandle))
356 OIC_LOG(ERROR, TAG, "Failed to Start Send Data Thread");
357 return CA_STATUS_FAILED;
360 CAResult_t ret = CATCPStartServer();
361 if (CA_STATUS_OK != ret)
363 OIC_LOG_V(DEBUG, TAG, "CATCPStartServer failed[%d]", ret);
371 CAResult_t CAStartTCPListeningServer()
373 #ifndef SINGLE_THREAD
374 if (!caglobals.server)
376 caglobals.server = true; // only needed to run CA tests
379 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
380 if (CA_STATUS_OK != ret)
382 OIC_LOG_V(ERROR, TAG, "Failed to start listening server![%d]", ret);
390 CAResult_t CAStopTCPListeningServer()
395 CAResult_t CAStartTCPDiscoveryServer()
397 if (!caglobals.client)
399 caglobals.client = true; // only needed to run CA tests
402 CAResult_t ret = CATCPStartServer((const ca_thread_pool_t)caglobals.tcp.threadpool);
403 if (CA_STATUS_OK != ret)
405 OIC_LOG_V(ERROR, TAG, "Failed to start discovery server![%d]", ret);
412 static size_t CAQueueTCPData(bool isMulticast, const CAEndpoint_t *endpoint,
413 const void *data, size_t dataLength)
415 VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", -1);
416 VERIFY_NON_NULL_RET(data, TAG, "data", -1);
420 OIC_LOG(ERROR, TAG, "Invalid Data Length");
424 VERIFY_NON_NULL_RET(g_sendQueueHandle, TAG, "sendQueueHandle", -1);
426 // Create TCPData to add to queue
427 CATCPData *tcpData = CACreateTCPData(endpoint, data, dataLength, isMulticast);
430 OIC_LOG(ERROR, TAG, "Failed to create ipData!");
433 // Add message to send queue
434 CAQueueingThreadAddData(g_sendQueueHandle, tcpData, sizeof(CATCPData));
439 int32_t CASendTCPUnicastData(const CAEndpoint_t *endpoint,
440 const void *data, uint32_t dataLength,
441 CADataType_t dataType)
443 OIC_LOG(DEBUG, TAG, "IN");
445 #ifndef SINGLE_THREAD
446 return CAQueueTCPData(false, endpoint, data, dataLength);
448 return CATCPSendData(endpoint, data, dataLength);
452 int32_t CASendTCPMulticastData(const CAEndpoint_t *endpoint,
453 const void *data, uint32_t dataLength,
454 CADataType_t dataType)
457 return CAQueueTCPData(true, endpoint, data, dataLength);
460 CAResult_t CAReadTCPData()
462 OIC_LOG(DEBUG, TAG, "IN");
469 CAResult_t CAStopTCP()
471 CAIPStopNetworkMonitor(CA_ADAPTER_TCP);
473 #ifndef SINGLE_THREAD
474 if (g_sendQueueHandle && g_sendQueueHandle->threadMutex)
476 CAQueueingThreadStop(g_sendQueueHandle);
478 CATCPDeinitializeQueueHandles();
483 //Re-initializing the Globals to start them again
484 CAInitializeTCPGlobals();
487 CAdeinitSslAdapter();
493 void CATerminateTCP()
496 CATCPSetPacketReceiveCallback(NULL);
499 void CATCPSendDataThread(void *threadData)
501 CATCPData *tcpData = (CATCPData *) threadData;
504 OIC_LOG(DEBUG, TAG, "Invalid TCP data!");
508 if (caglobals.tcp.terminate)
510 OIC_LOG(DEBUG, TAG, "Adapter is not enabled");
511 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
516 if (tcpData->isMulticast)
518 //Processing for sending multicast
519 OIC_LOG(DEBUG, TAG, "Send Multicast Data is called, not supported");
524 // Check payload length from CoAP over TCP format header.
525 CAResult_t result = CA_STATUS_OK;
526 size_t payloadLen = CACheckPayloadLengthFromHeader(tcpData->data, tcpData->dataLen);
529 // if payload length is zero, disconnect from remote device.
530 OIC_LOG(DEBUG, TAG, "payload length is zero, disconnect from remote device");
532 if (CA_STATUS_OK != CAcloseSslConnection(tcpData->remoteEndpoint))
534 OIC_LOG(ERROR, TAG, "Failed to close TLS session");
537 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
542 if (tcpData->remoteEndpoint && tcpData->remoteEndpoint->flags & CA_SECURE)
544 OIC_LOG(DEBUG, TAG, "CAencryptSsl called!");
545 result = CAencryptSsl(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
547 if (CA_STATUS_OK != result)
549 OIC_LOG(ERROR, TAG, "CAAdapterNetDtlsEncrypt failed!");
551 OIC_LOG_V(DEBUG, TAG,
552 "CAAdapterNetDtlsEncrypt returned with result[%d]", result);
556 //Processing for sending unicast
557 ssize_t dlen = CATCPSendData(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen);
560 CASearchAndDeleteTCPSession(tcpData->remoteEndpoint);
561 CATCPErrorHandler(tcpData->remoteEndpoint, tcpData->data, tcpData->dataLen,
567 CATCPData *CACreateTCPData(const CAEndpoint_t *remoteEndpoint, const void *data,
568 size_t dataLength, bool isMulticast)
570 VERIFY_NON_NULL_RET(remoteEndpoint, TAG, "remoteEndpoint is NULL", NULL);
571 VERIFY_NON_NULL_RET(data, TAG, "data is NULL", NULL);
573 CATCPData *tcpData = (CATCPData *) OICCalloc(1, sizeof(*tcpData));
576 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
580 tcpData->remoteEndpoint = CACloneEndpoint(remoteEndpoint);
581 tcpData->data = (void *) OICMalloc(dataLength);
584 OIC_LOG(ERROR, TAG, "Memory allocation failed!");
585 CAFreeTCPData(tcpData);
589 memcpy(tcpData->data, data, dataLength);
590 tcpData->dataLen = dataLength;
592 tcpData->isMulticast = isMulticast;
597 void CAFreeTCPData(CATCPData *tcpData)
599 VERIFY_NON_NULL_VOID(tcpData, TAG, "tcpData is NULL");
601 CAFreeEndpoint(tcpData->remoteEndpoint);
602 OICFree(tcpData->data);
606 void CADataDestroyer(void *data, uint32_t size)
608 if (size < sizeof(CATCPData))
610 OIC_LOG_V(ERROR, TAG, "Destroy data too small %p %" PRIu32, data, size);
612 CATCPData *TCPData = (CATCPData *) data;
614 CAFreeTCPData(TCPData);
618 size_t CAGetTotalLengthFromPacketHeader(const unsigned char *recvBuffer, size_t size)
620 OIC_LOG(DEBUG, TAG, "IN - CAGetTotalLengthFromHeader");
622 if (NULL == recvBuffer || !size)
624 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
628 coap_transport_t transport = coap_get_tcp_header_type_from_initbyte(
629 ((unsigned char *)recvBuffer)[0] >> 4);
630 size_t optPaylaodLen = coap_get_length_from_header((unsigned char *)recvBuffer,
632 size_t headerLen = coap_get_tcp_header_length((unsigned char *)recvBuffer);
634 OIC_LOG_V(DEBUG, TAG, "option/paylaod length [%d]", optPaylaodLen);
635 OIC_LOG_V(DEBUG, TAG, "header length [%d]", headerLen);
636 OIC_LOG_V(DEBUG, TAG, "total data length [%d]", headerLen + optPaylaodLen);
638 OIC_LOG(DEBUG, TAG, "OUT - CAGetTotalLengthFromHeader");
639 return headerLen + optPaylaodLen;
642 void CAGetTCPHeaderDetails(unsigned char* recvBuffer, coap_transport_t *transport,
645 if (NULL == recvBuffer)
647 OIC_LOG(ERROR, TAG, "recvBuffer is NULL");
651 if (NULL == transport)
653 OIC_LOG(ERROR, TAG, "transport is NULL");
657 if (NULL == headerlen)
659 OIC_LOG(ERROR, TAG, "headerlen is NULL");
663 *transport = coap_get_tcp_header_type_from_initbyte(
664 ((unsigned char *)recvBuffer)[0] >> 4);
665 *headerlen = coap_get_tcp_header_length_for_transport(*transport);