resource/csdk/connectivity/src/caprotocolmessage.c

   1 /******************************************************************
   2  *
   3  * Copyright 2014 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  ******************************************************************/
  20
  21 // Defining _BSD_SOURCE or _DEFAULT_SOURCE causes header files to expose
  22 // definitions that may otherwise be skipped. Skipping can cause implicit
  23 // declaration warnings and/or bugs and subtle problems in code execution.
  24 // For glibc information on feature test macros,
  25 // Refer http://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html
  26 //
  27 // For details on compatibility and glibc support,
  28 // Refer http://www.gnu.org/software/libc/manual/html_node/BSD-Random.html
  29 #define _DEFAULT_SOURCE
  30
  31 #include "iotivity_config.h"
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35 #include <stdbool.h>
  36 #ifdef HAVE_TIME_H
  37 #include <time.h>
  38 #endif
  39
  40 #include "caprotocolmessage.h"
  41 #include "logger.h"
  42 #include "oic_malloc.h"
  43 #include "oic_string.h"
  44 #include "ocrandom.h"
  45 #include "cacommonutil.h"
  46
  47 #define TAG "OIC_CA_PRTCL_MSG"
  48
  49 #define CA_PDU_MIN_SIZE (4)
  50 #define CA_ENCODE_BUFFER_SIZE (4)
  51
  52 static const char COAP_URI_HEADER[] = "coap://[::]/";
  53
  54 static char g_chproxyUri[CA_MAX_URI_LENGTH];
  55
  56 CAResult_t CASetProxyUri(const char *uri)
  57 {
  58     VERIFY_NON_NULL(uri, TAG, "uri");
  59     OICStrcpy(g_chproxyUri, sizeof (g_chproxyUri), uri);
  60     return CA_STATUS_OK;
  61 }
  62
  63 CAResult_t CAGetRequestInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
  64                                    CARequestInfo_t *outReqInfo)
  65 {
  66     VERIFY_NON_NULL(pdu, TAG, "pdu");
  67     VERIFY_NON_NULL(outReqInfo, TAG, "outReqInfo");
  68
  69     uint32_t code = CA_NOT_FOUND;
  70     CAResult_t ret = CAGetInfoFromPDU(pdu, endpoint, &code, &(outReqInfo->info));
  71     outReqInfo->method = code;
  72
  73     return ret;
  74 }
  75
  76 CAResult_t CAGetResponseInfoFromPDU(const coap_pdu_t *pdu, CAResponseInfo_t *outResInfo,
  77                                     const CAEndpoint_t *endpoint)
  78 {
  79     VERIFY_NON_NULL(pdu, TAG, "pdu");
  80     VERIFY_NON_NULL(outResInfo, TAG, "outResInfo");
  81
  82     uint32_t code = CA_NOT_FOUND;
  83     CAResult_t ret = CAGetInfoFromPDU(pdu, endpoint, &code, &(outResInfo->info));
  84     outResInfo->result = code;
  85
  86     return ret;
  87 }
  88
  89 CAResult_t CAGetErrorInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
  90                                  CAErrorInfo_t *errorInfo)
  91 {
  92     VERIFY_NON_NULL(pdu, TAG, "pdu");
  93
  94     uint32_t code = 0;
  95     CAResult_t ret = CAGetInfoFromPDU(pdu, endpoint, &code, &errorInfo->info);
  96
  97     return ret;
  98 }
  99
 100 coap_pdu_t *CAGeneratePDU(uint32_t code, const CAInfo_t *info, const CAEndpoint_t *endpoint,
 101                           coap_list_t **optlist, coap_transport_t *transport)
 102 {
 103     VERIFY_NON_NULL_RET(info, TAG, "info", NULL);
 104     VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
 105     VERIFY_NON_NULL_RET(optlist, TAG, "optlist", NULL);
 106
 107     OIC_LOG_V(DEBUG, TAG, "generate pdu for [%d]adapter, [%d]flags",
 108               endpoint->adapter, endpoint->flags);
 109
 110     coap_pdu_t *pdu = NULL;
 111
 112     // RESET have to use only 4byte (empty message)
 113     // and ACKNOWLEDGE can use empty message when code is empty.
 114     if (CA_MSG_RESET == info->type || (CA_EMPTY == code && CA_MSG_ACKNOWLEDGE == info->type))
 115     {
 116         if (CA_EMPTY != code)
 117         {
 118             OIC_LOG(ERROR, TAG, "reset is not empty message");
 119             return NULL;
 120         }
 121
 122         if (info->payloadSize > 0 || info->payload || info->token || info->tokenLength > 0)
 123         {
 124             OIC_LOG(ERROR, TAG, "Empty message has unnecessary data after messageID");
 125             return NULL;
 126         }
 127
 128         OIC_LOG(DEBUG, TAG, "code is empty");
 129         if (!(pdu = CAGeneratePDUImpl((code_t) code, info, endpoint, NULL, transport)))
 130         {
 131             OIC_LOG(ERROR, TAG, "pdu NULL");
 132             return NULL;
 133         }
 134     }
 135     else
 136     {
 137         if (info->resourceUri)
 138         {
 139             OIC_LOG_V(DEBUG, TAG, "uri : %s", info->resourceUri);
 140
 141             uint32_t length = strlen(info->resourceUri);
 142             if (CA_MAX_URI_LENGTH < length)
 143             {
 144                 OIC_LOG(ERROR, TAG, "URI len err");
 145                 return NULL;
 146             }
 147
 148             uint32_t uriLength = length + sizeof(COAP_URI_HEADER);
 149             char *coapUri = (char *) OICCalloc(1, uriLength);
 150             if (NULL == coapUri)
 151             {
 152                 OIC_LOG(ERROR, TAG, "out of memory");
 153                 return NULL;
 154             }
 155             OICStrcat(coapUri, uriLength, COAP_URI_HEADER);
 156             OICStrcat(coapUri, uriLength, info->resourceUri);
 157
 158             // parsing options in URI
 159             CAResult_t res = CAParseURI(coapUri, optlist);
 160             if (CA_STATUS_OK != res)
 161             {
 162                 OICFree(coapUri);
 163                 return NULL;
 164             }
 165
 166             OICFree(coapUri);
 167         }
 168         // parsing options in HeadOption
 169         CAResult_t ret = CAParseHeadOption(code, info, optlist);
 170         if (CA_STATUS_OK != ret)
 171         {
 172             return NULL;
 173         }
 174
 175         pdu = CAGeneratePDUImpl((code_t) code, info, endpoint, *optlist, transport);
 176         if (NULL == pdu)
 177         {
 178             OIC_LOG(ERROR, TAG, "pdu NULL");
 179             return NULL;
 180         }
 181     }
 182
 183     // pdu print method : coap_show_pdu(pdu);
 184     return pdu;
 185 }
 186
 187 coap_pdu_t *CAParsePDU(const char *data, size_t length, uint32_t *outCode,
 188                        const CAEndpoint_t *endpoint)
 189 {
 190     VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
 191     VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
 192
 193     coap_transport_t transport = COAP_UDP;
 194 #ifdef WITH_TCP
 195     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 196     {
 197         transport = coap_get_tcp_header_type_from_initbyte(((unsigned char *)data)[0] >> 4);
 198     }
 199 #endif
 200
 201     coap_pdu_t *outpdu =
 202         coap_pdu_init2(0, 0, ntohs(COAP_INVALID_TID), length, transport);
 203     if (NULL == outpdu)
 204     {
 205         OIC_LOG(ERROR, TAG, "outpdu is null");
 206         return NULL;
 207     }
 208
 209     OIC_LOG_V(DEBUG, TAG, "pdu parse-transport type : %d", transport);
 210
 211     int ret = coap_pdu_parse2((unsigned char *) data, length, outpdu, transport);
 212     OIC_LOG_V(DEBUG, TAG, "pdu parse ret: %d", ret);
 213     if (0 >= ret)
 214     {
 215         OIC_LOG(ERROR, TAG, "pdu parse failed");
 216         goto exit;
 217     }
 218
 219 #ifdef WITH_TCP
 220     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 221     {
 222         OIC_LOG(INFO, TAG, "there is no version info in coap header");
 223     }
 224     else
 225 #endif
 226     {
 227         if (outpdu->transport_hdr->udp.version != COAP_DEFAULT_VERSION)
 228         {
 229             OIC_LOG_V(ERROR, TAG, "coap version is not available : %d",
 230                       outpdu->transport_hdr->udp.version);
 231             goto exit;
 232         }
 233         if (outpdu->transport_hdr->udp.token_length > CA_MAX_TOKEN_LEN)
 234         {
 235             OIC_LOG_V(ERROR, TAG, "token length has been exceed : %d",
 236                       outpdu->transport_hdr->udp.token_length);
 237             goto exit;
 238         }
 239     }
 240
 241     if (outCode)
 242     {
 243         (*outCode) = (uint32_t) CA_RESPONSE_CODE(coap_get_code(outpdu, transport));
 244     }
 245
 246     return outpdu;
 247
 248 exit:
 249     coap_delete_pdu(outpdu);
 250     return NULL;
 251 }
 252
 253 coap_pdu_t *CAGeneratePDUImpl(code_t code, const CAInfo_t *info,
 254                               const CAEndpoint_t *endpoint, coap_list_t *options,
 255                               coap_transport_t *transport)
 256 {
 257     VERIFY_NON_NULL_RET(info, TAG, "info", NULL);
 258     VERIFY_NON_NULL_RET(endpoint, TAG, "endpoint", NULL);
 259     VERIFY_NON_NULL_RET(transport, TAG, "transport", NULL);
 260
 261     unsigned int length = COAP_MAX_PDU_SIZE;
 262 #ifdef WITH_TCP
 263     unsigned int msgLength = 0;
 264     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 265     {
 266         if (options)
 267         {
 268             unsigned short prevOptNumber = 0;
 269             for (coap_list_t *opt = options; opt; opt = opt->next)
 270             {
 271                 unsigned short curOptNumber = COAP_OPTION_KEY(*(coap_option *) opt->data);
 272                 if (prevOptNumber > curOptNumber)
 273                 {
 274                     OIC_LOG(ERROR, TAG, "option list is wrong");
 275                     return NULL;
 276                 }
 277
 278                 size_t optValueLen = COAP_OPTION_LENGTH(*(coap_option *) opt->data);
 279                 size_t optLength = coap_get_opt_header_length(curOptNumber - prevOptNumber, optValueLen);
 280                 if (0 == optLength)
 281                 {
 282                     OIC_LOG(ERROR, TAG, "Reserved for the Payload marker for the option");
 283                     return NULL;
 284                 }
 285                 msgLength += optLength;
 286                 prevOptNumber = curOptNumber;
 287                 OIC_LOG_V(DEBUG, TAG, "curOptNumber[%d], prevOptNumber[%d], optValueLen[%zu], "
 288                         "optLength[%zu], msgLength[%d]",
 289                           curOptNumber, prevOptNumber, optValueLen, optLength, msgLength);
 290             }
 291         }
 292
 293         if (info->payloadSize > 0)
 294         {
 295             msgLength = msgLength + info->payloadSize + PAYLOAD_MARKER;
 296         }
 297         *transport = coap_get_tcp_header_type_from_size(msgLength);
 298         length = msgLength + coap_get_tcp_header_length_for_transport(*transport)
 299                 + info->tokenLength;
 300     }
 301     else
 302 #endif
 303     {
 304         *transport = COAP_UDP;
 305     }
 306
 307     coap_pdu_t *pdu = coap_new_pdu2(*transport, length);
 308
 309     if (NULL == pdu)
 310     {
 311         OIC_LOG(ERROR, TAG, "malloc failed");
 312         return NULL;
 313     }
 314
 315     OIC_LOG_V(DEBUG, TAG, "transport type: %d, payload size: %zu",
 316               *transport, info->payloadSize);
 317
 318 #ifdef WITH_TCP
 319     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 320     {
 321         coap_add_length(pdu, *transport, msgLength);
 322     }
 323     else
 324 #endif
 325     {
 326         OIC_LOG_V(DEBUG, TAG, "msgID is %d", info->messageId);
 327         uint16_t message_id = 0;
 328         if (0 == info->messageId)
 329         {
 330             /* initialize message id */
 331             prng((uint8_t * ) &message_id, sizeof(message_id));
 332
 333             OIC_LOG_V(DEBUG, TAG, "gen msg id=%d", message_id);
 334         }
 335         else
 336         {
 337             /* use saved message id */
 338             message_id = info->messageId;
 339         }
 340         pdu->transport_hdr->udp.id = message_id;
 341         OIC_LOG_V(DEBUG, TAG, "messageId in pdu is %d, %d", message_id, pdu->transport_hdr->udp.id);
 342
 343         pdu->transport_hdr->udp.type = info->type;
 344     }
 345
 346     coap_add_code(pdu, *transport, code);
 347
 348     if (info->token && CA_EMPTY != code)
 349     {
 350         uint32_t tokenLength = info->tokenLength;
 351         OIC_LOG_V(DEBUG, TAG, "token info token length: %d, token :", tokenLength);
 352         OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)info->token, tokenLength);
 353
 354         int32_t ret = coap_add_token2(pdu, tokenLength, (unsigned char *)info->token, *transport);
 355         if (0 == ret)
 356         {
 357             OIC_LOG(ERROR, TAG, "can't add token");
 358         }
 359     }
 360
 361 #ifdef WITH_BWT
 362     if (CA_ADAPTER_GATT_BTLE != endpoint->adapter
 363 #ifdef WITH_TCP
 364             && !CAIsSupportedCoAPOverTCP(endpoint->adapter)
 365 #endif
 366             )
 367     {
 368         // option list will be added in blockwise-transfer
 369         return pdu;
 370     }
 371 #endif
 372
 373     if (options)
 374     {
 375         for (coap_list_t *opt = options; opt; opt = opt->next)
 376         {
 377             OIC_LOG_V(DEBUG, TAG, "[%s] opt will be added.",
 378                       COAP_OPTION_DATA(*(coap_option *) opt->data));
 379
 380             OIC_LOG_V(DEBUG, TAG, "[%d] pdu length", pdu->length);
 381             coap_add_option2(pdu, COAP_OPTION_KEY(*(coap_option *) opt->data),
 382                              COAP_OPTION_LENGTH(*(coap_option *) opt->data),
 383                              COAP_OPTION_DATA(*(coap_option *) opt->data), *transport);
 384         }
 385     }
 386
 387     OIC_LOG_V(DEBUG, TAG, "[%d] pdu length after option", pdu->length);
 388
 389     if (NULL != info->payload && 0 < info->payloadSize)
 390     {
 391         OIC_LOG(DEBUG, TAG, "payload is added");
 392         coap_add_data(pdu, info->payloadSize, (const unsigned char *) info->payload);
 393     }
 394
 395     return pdu;
 396 }
 397
 398 CAResult_t CAParseURI(const char *uriInfo, coap_list_t **optlist)
 399 {
 400     VERIFY_NON_NULL(uriInfo, TAG, "uriInfo");
 401     VERIFY_NON_NULL(optlist, TAG, "optlist");
 402
 403     /* split arg into Uri-* options */
 404     coap_uri_t uri;
 405     coap_split_uri((unsigned char *) uriInfo, strlen(uriInfo), &uri);
 406
 407     if (uri.port != COAP_DEFAULT_PORT)
 408     {
 409         unsigned char portbuf[CA_ENCODE_BUFFER_SIZE] = { 0 };
 410         int ret = coap_insert(optlist,
 411                               CACreateNewOptionNode(COAP_OPTION_URI_PORT,
 412                                                     coap_encode_var_bytes(portbuf, uri.port),
 413                                                     (char *)portbuf),
 414                               CAOrderOpts);
 415         if (ret <= 0)
 416         {
 417             return CA_STATUS_INVALID_PARAM;
 418         }
 419     }
 420
 421     if (uri.path.s && uri.path.length)
 422     {
 423         CAResult_t ret = CAParseUriPartial(uri.path.s, uri.path.length,
 424                                            COAP_OPTION_URI_PATH, optlist);
 425         if (CA_STATUS_OK != ret)
 426         {
 427             OIC_LOG(ERROR, TAG, "CAParseUriPartial failed(uri path)");
 428             return ret;
 429         }
 430     }
 431
 432     if (uri.query.s && uri.query.length)
 433     {
 434         CAResult_t ret = CAParseUriPartial(uri.query.s, uri.query.length, COAP_OPTION_URI_QUERY,
 435                                            optlist);
 436         if (CA_STATUS_OK != ret)
 437         {
 438             OIC_LOG(ERROR, TAG, "CAParseUriPartial failed(uri query)");
 439             return ret;
 440         }
 441     }
 442
 443     return CA_STATUS_OK;
 444 }
 445
 446 CAResult_t CAParseUriPartial(const unsigned char *str, size_t length, int target,
 447                              coap_list_t **optlist)
 448 {
 449     VERIFY_NON_NULL(optlist, TAG, "optlist");
 450
 451     if ((target != COAP_OPTION_URI_PATH) && (target != COAP_OPTION_URI_QUERY))
 452     {
 453         // should never occur. Log just in case.
 454         OIC_LOG(DEBUG, TAG, "Unexpected URI component.");
 455         return CA_NOT_SUPPORTED;
 456     }
 457     else if (str && length)
 458     {
 459         unsigned char uriBuffer[CA_MAX_URI_LENGTH] = { 0 };
 460         unsigned char *pBuf = uriBuffer;
 461         size_t buflen = sizeof(uriBuffer);
 462         int res = (target == COAP_OPTION_URI_PATH) ? coap_split_path(str, length, pBuf, &buflen) :
 463                                                      coap_split_query(str, length, pBuf, &buflen);
 464
 465         if (res > 0)
 466         {
 467             size_t prevIdx = 0;
 468             while (res--)
 469             {
 470                 int ret = coap_insert(optlist,
 471                                       CACreateNewOptionNode(target, COAP_OPT_LENGTH(pBuf),
 472                                                             (char *)COAP_OPT_VALUE(pBuf)),
 473                                       CAOrderOpts);
 474                 if (ret <= 0)
 475                 {
 476                     return CA_STATUS_INVALID_PARAM;
 477                 }
 478
 479                 size_t optSize = COAP_OPT_SIZE(pBuf);
 480                 if ((prevIdx + optSize) < buflen)
 481                 {
 482                     pBuf += optSize;
 483                     prevIdx += optSize;
 484                 }
 485             }
 486         }
 487         else
 488         {
 489             OIC_LOG_V(ERROR, TAG, "Problem parsing URI : %d for %d", res, target);
 490             return CA_STATUS_FAILED;
 491         }
 492     }
 493     else
 494     {
 495         OIC_LOG(ERROR, TAG, "str or length is not available");
 496         return CA_STATUS_FAILED;
 497     }
 498
 499     return CA_STATUS_OK;
 500 }
 501
 502 CAResult_t CAParseHeadOption(uint32_t code, const CAInfo_t *info, coap_list_t **optlist)
 503 {
 504     (void)code;
 505     VERIFY_NON_NULL_RET(info, TAG, "info", CA_STATUS_INVALID_PARAM);
 506
 507     OIC_LOG_V(DEBUG, TAG, "parse Head Opt: %d", info->numOptions);
 508
 509     if (!optlist)
 510     {
 511         OIC_LOG(ERROR, TAG, "optlist is null");
 512         return CA_STATUS_INVALID_PARAM;
 513     }
 514
 515     for (uint32_t i = 0; i < info->numOptions; i++)
 516     {
 517         if(!(info->options + i))
 518         {
 519             OIC_LOG(ERROR, TAG, "options is not available");
 520             return CA_STATUS_FAILED;
 521         }
 522
 523         uint32_t id = (info->options + i)->optionID;
 524         if (COAP_OPTION_URI_PATH == id || COAP_OPTION_URI_QUERY == id)
 525         {
 526             OIC_LOG_V(DEBUG, TAG, "not Header Opt: %d", id);
 527         }
 528         else
 529         {
 530             OIC_LOG_V(DEBUG, TAG, "Head opt ID: %d", id);
 531             OIC_LOG_V(DEBUG, TAG, "Head opt data: %s", (info->options + i)->optionData);
 532             OIC_LOG_V(DEBUG, TAG, "Head opt length: %d", (info->options + i)->optionLength);
 533             int ret = coap_insert(optlist,
 534                                   CACreateNewOptionNode(id, (info->options + i)->optionLength,
 535                                                         (info->options + i)->optionData),
 536                                   CAOrderOpts);
 537             if (ret <= 0)
 538             {
 539                 return CA_STATUS_INVALID_PARAM;
 540             }
 541         }
 542     }
 543
 544     // insert one extra header with the payload format if applicable.
 545     if (CA_FORMAT_UNDEFINED != info->payloadFormat)
 546     {
 547         coap_list_t* node = NULL;
 548         uint8_t buf[CA_ENCODE_BUFFER_SIZE] = {0};
 549         switch (info->payloadFormat)
 550         {
 551             case CA_FORMAT_APPLICATION_CBOR:
 552                 node = CACreateNewOptionNode(
 553                         COAP_OPTION_CONTENT_FORMAT,
 554                         coap_encode_var_bytes(buf, (unsigned short)COAP_MEDIATYPE_APPLICATION_CBOR),
 555                         (char *)buf);
 556                 break;
 557             default:
 558                 OIC_LOG_V(ERROR, TAG, "format option:[%d] not supported", info->payloadFormat);
 559         }
 560         if (!node)
 561         {
 562             OIC_LOG(ERROR, TAG, "format option not created");
 563             return CA_STATUS_INVALID_PARAM;
 564         }
 565         int ret = coap_insert(optlist, node, CAOrderOpts);
 566         if (ret <= 0)
 567         {
 568             coap_delete(node);
 569             OIC_LOG(ERROR, TAG, "format option not inserted in header");
 570             return CA_STATUS_INVALID_PARAM;
 571         }
 572     }
 573     if (CA_FORMAT_UNDEFINED != info->acceptFormat)
 574     {
 575         coap_list_t* node = NULL;
 576         uint8_t buf[CA_ENCODE_BUFFER_SIZE] = {0};
 577         switch (info->acceptFormat)
 578         {
 579             case CA_FORMAT_APPLICATION_CBOR:
 580                 node = CACreateNewOptionNode(
 581                         COAP_OPTION_ACCEPT,
 582                         coap_encode_var_bytes(buf, (unsigned short)COAP_MEDIATYPE_APPLICATION_CBOR),
 583                         (char *)buf);
 584                 break;
 585             default:
 586                 OIC_LOG_V(ERROR, TAG, "format option:[%d] not supported", info->acceptFormat);
 587         }
 588         if (!node)
 589         {
 590             OIC_LOG(ERROR, TAG, "format option not created");
 591             return CA_STATUS_INVALID_PARAM;
 592         }
 593         int ret = coap_insert(optlist, node, CAOrderOpts);
 594         if (ret <= 0)
 595         {
 596             coap_delete(node);
 597             OIC_LOG(ERROR, TAG, "format option not inserted in header");
 598             return CA_STATUS_INVALID_PARAM;
 599         }
 600     }
 601
 602     return CA_STATUS_OK;
 603 }
 604
 605 coap_list_t *CACreateNewOptionNode(uint16_t key, uint32_t length, const char *data)
 606 {
 607     VERIFY_NON_NULL_RET(data, TAG, "data", NULL);
 608
 609     coap_option *option = coap_malloc(sizeof(coap_option) + length + 1);
 610     if (!option)
 611     {
 612         OIC_LOG(ERROR, TAG, "Out of memory");
 613         return NULL;
 614     }
 615     memset(option, 0, sizeof(coap_option) + length + 1);
 616
 617     COAP_OPTION_KEY(*option) = key;
 618
 619     coap_option_def_t* def = coap_opt_def(key);
 620     if (NULL != def && coap_is_var_bytes(def))
 621     {
 622        if (length > def->max)
 623         {
 624             // make sure we shrink the value so it fits the coap option definition
 625             // by truncating the value, disregard the leading bytes.
 626             OIC_LOG_V(DEBUG, TAG, "Option [%d] data size [%d] shrunk to [%d]",
 627                     def->key, length, def->max);
 628             data = &(data[length-def->max]);
 629             length = def->max;
 630         }
 631         // Shrink the encoding length to a minimum size for coap
 632         // options that support variable length encoding.
 633          COAP_OPTION_LENGTH(*option) = coap_encode_var_bytes(
 634                 COAP_OPTION_DATA(*option),
 635                 coap_decode_var_bytes((unsigned char *)data, length));
 636     }
 637     else
 638     {
 639         COAP_OPTION_LENGTH(*option) = length;
 640         memcpy(COAP_OPTION_DATA(*option), data, length);
 641     }
 642
 643     /* we can pass NULL here as delete function since option is released automatically  */
 644     coap_list_t *node = coap_new_listnode(option, NULL);
 645
 646     if (!node)
 647     {
 648         OIC_LOG(ERROR, TAG, "node is NULL");
 649         coap_free(option);
 650         return NULL;
 651     }
 652
 653     return node;
 654 }
 655
 656 int CAOrderOpts(void *a, void *b)
 657 {
 658     if (!a || !b)
 659     {
 660         return a < b ? -1 : 1;
 661     }
 662
 663     if (COAP_OPTION_KEY(*(coap_option *) a) < COAP_OPTION_KEY(*(coap_option * ) b))
 664     {
 665         return -1;
 666     }
 667
 668     return COAP_OPTION_KEY(*(coap_option *) a) == COAP_OPTION_KEY(*(coap_option * ) b);
 669 }
 670
 671 uint32_t CAGetOptionCount(coap_opt_iterator_t opt_iter)
 672 {
 673     uint32_t count = 0;
 674     coap_opt_t *option = NULL;
 675
 676     while ((option = coap_option_next(&opt_iter)))
 677     {
 678         if (COAP_OPTION_URI_PATH != opt_iter.type && COAP_OPTION_URI_QUERY != opt_iter.type
 679             && COAP_OPTION_BLOCK1 != opt_iter.type && COAP_OPTION_BLOCK2 != opt_iter.type
 680             && COAP_OPTION_SIZE1 != opt_iter.type && COAP_OPTION_SIZE2 != opt_iter.type
 681             && COAP_OPTION_CONTENT_FORMAT != opt_iter.type
 682             && COAP_OPTION_ACCEPT != opt_iter.type
 683             && COAP_OPTION_URI_HOST != opt_iter.type && COAP_OPTION_URI_PORT != opt_iter.type
 684             && COAP_OPTION_ETAG != opt_iter.type && COAP_OPTION_MAXAGE != opt_iter.type
 685             && COAP_OPTION_PROXY_SCHEME != opt_iter.type)
 686         {
 687             count++;
 688         }
 689     }
 690
 691     return count;
 692 }
 693
 694 CAResult_t CAGetInfoFromPDU(const coap_pdu_t *pdu, const CAEndpoint_t *endpoint,
 695                             uint32_t *outCode, CAInfo_t *outInfo)
 696 {
 697     VERIFY_NON_NULL(pdu, TAG, "pdu");
 698     VERIFY_NON_NULL(endpoint, TAG, "endpoint");
 699     VERIFY_NON_NULL(outCode, TAG, "outCode");
 700     VERIFY_NON_NULL(outInfo, TAG, "outInfo");
 701
 702     coap_transport_t transport;
 703 #ifdef WITH_TCP
 704     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 705     {
 706         transport = coap_get_tcp_header_type_from_initbyte(((unsigned char *)pdu->transport_hdr)[0] >> 4);
 707     }
 708     else
 709 #endif
 710     {
 711         transport = COAP_UDP;
 712     }
 713
 714     coap_opt_iterator_t opt_iter;
 715     coap_option_iterator_init2((coap_pdu_t *) pdu, &opt_iter, COAP_OPT_ALL, transport);
 716
 717     if (outCode)
 718     {
 719         (*outCode) = (uint32_t) CA_RESPONSE_CODE(coap_get_code(pdu, transport));
 720     }
 721
 722     // init HeaderOption list
 723     uint32_t count = CAGetOptionCount(opt_iter);
 724     memset(outInfo, 0, sizeof(*outInfo));
 725
 726     outInfo->numOptions = count;
 727
 728 #ifdef WITH_TCP
 729     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 730     {
 731         // set type
 732         outInfo->type = CA_MSG_NONCONFIRM;
 733         outInfo->payloadFormat = CA_FORMAT_UNDEFINED;
 734     }
 735     else
 736 #else
 737     (void) endpoint;
 738 #endif
 739     {
 740         // set type
 741         outInfo->type = pdu->transport_hdr->udp.type;
 742
 743         // set message id
 744         outInfo->messageId = pdu->transport_hdr->udp.id;
 745         outInfo->payloadFormat = CA_FORMAT_UNDEFINED;
 746         outInfo->acceptFormat = CA_FORMAT_UNDEFINED;
 747     }
 748
 749     if (count > 0)
 750     {
 751         outInfo->options = (CAHeaderOption_t *) OICCalloc(count, sizeof(CAHeaderOption_t));
 752         if (NULL == outInfo->options)
 753         {
 754             OIC_LOG(ERROR, TAG, "Out of memory");
 755             return CA_MEMORY_ALLOC_FAILED;
 756         }
 757     }
 758
 759     coap_opt_t *option = NULL;
 760     char optionResult[CA_MAX_URI_LENGTH] = {0};
 761     uint32_t idx = 0;
 762     uint32_t optionLength = 0;
 763     bool isfirstsetflag = false;
 764     bool isQueryBeingProcessed = false;
 765     bool isProxyRequest = false;
 766
 767     while ((option = coap_option_next(&opt_iter)))
 768     {
 769         char buf[COAP_MAX_PDU_SIZE] = {0};
 770         uint32_t bufLength =
 771             CAGetOptionData(opt_iter.type, (uint8_t *)(COAP_OPT_VALUE(option)),
 772                     COAP_OPT_LENGTH(option), (uint8_t *)buf, sizeof(buf));
 773         if (bufLength)
 774         {
 775             OIC_LOG_V(DEBUG, TAG, "COAP URI element : %s", buf);
 776             if (COAP_OPTION_URI_PATH == opt_iter.type || COAP_OPTION_URI_QUERY == opt_iter.type)
 777             {
 778                 if (false == isfirstsetflag)
 779                 {
 780                     isfirstsetflag = true;
 781                     optionResult[optionLength] = '/';
 782                     optionLength++;
 783                     // Make sure there is enough room in the optionResult buffer
 784                     if ((optionLength + bufLength) < sizeof(optionResult))
 785                     {
 786                         memcpy(&optionResult[optionLength], buf, bufLength);
 787                         optionLength += bufLength;
 788                     }
 789                     else
 790                     {
 791                         goto exit;
 792                     }
 793                 }
 794                 else
 795                 {
 796                     if (COAP_OPTION_URI_PATH == opt_iter.type)
 797                     {
 798                         // Make sure there is enough room in the optionResult buffer
 799                         if (optionLength < sizeof(optionResult))
 800                         {
 801                             optionResult[optionLength] = '/';
 802                             optionLength++;
 803                         }
 804                         else
 805                         {
 806                             goto exit;
 807                         }
 808                     }
 809                     else if (COAP_OPTION_URI_QUERY == opt_iter.type)
 810                     {
 811                         if (false == isQueryBeingProcessed)
 812                         {
 813                             // Make sure there is enough room in the optionResult buffer
 814                             if (optionLength < sizeof(optionResult))
 815                             {
 816                                 optionResult[optionLength] = '?';
 817                                 optionLength++;
 818                                 isQueryBeingProcessed = true;
 819                             }
 820                             else
 821                             {
 822                                 goto exit;
 823                             }
 824                         }
 825                         else
 826                         {
 827                             // Make sure there is enough room in the optionResult buffer
 828                             if (optionLength < sizeof(optionResult))
 829                             {
 830                                 optionResult[optionLength] = ';';
 831                                 optionLength++;
 832                             }
 833                             else
 834                             {
 835                                 goto exit;
 836                             }
 837                         }
 838                     }
 839                     // Make sure there is enough room in the optionResult buffer
 840                     if ((optionLength + bufLength) < sizeof(optionResult))
 841                     {
 842                         memcpy(&optionResult[optionLength], buf, bufLength);
 843                         optionLength += bufLength;
 844                     }
 845                     else
 846                     {
 847                         goto exit;
 848                     }
 849                 }
 850             }
 851             else if (COAP_OPTION_BLOCK1 == opt_iter.type || COAP_OPTION_BLOCK2 == opt_iter.type
 852                     || COAP_OPTION_SIZE1 == opt_iter.type || COAP_OPTION_SIZE2 == opt_iter.type)
 853             {
 854                 OIC_LOG_V(DEBUG, TAG, "option[%d] will be filtering", opt_iter.type);
 855             }
 856             else if (COAP_OPTION_CONTENT_FORMAT == opt_iter.type)
 857             {
 858                 if (1 == COAP_OPT_LENGTH(option))
 859                 {
 860                     outInfo->payloadFormat = CAConvertFormat((uint8_t)buf[0]);
 861                 }
 862                 else
 863                 {
 864                     outInfo->payloadFormat = CA_FORMAT_UNSUPPORTED;
 865                     OIC_LOG_V(DEBUG, TAG, "option[%d] has an unsupported format [%d]",
 866                               opt_iter.type, (uint8_t)buf[0]);
 867                 }
 868             }
 869             else if (COAP_OPTION_ACCEPT == opt_iter.type)
 870             {
 871                 if (1 == COAP_OPT_LENGTH(option))
 872                 {
 873                     outInfo->acceptFormat = CAConvertFormat((uint8_t)buf[0]);
 874                 }
 875                 else
 876                 {
 877                     outInfo->acceptFormat = CA_FORMAT_UNSUPPORTED;
 878                 }
 879                 OIC_LOG_V(DEBUG, TAG, "option[%d] has an unsupported format [%d]",
 880                           opt_iter.type, (uint8_t)buf[0]);
 881             }
 882             else if (COAP_OPTION_URI_PORT == opt_iter.type ||
 883                     COAP_OPTION_URI_HOST == opt_iter.type ||
 884                     COAP_OPTION_ETAG == opt_iter.type ||
 885                     COAP_OPTION_MAXAGE == opt_iter.type ||
 886                     COAP_OPTION_PROXY_SCHEME== opt_iter.type)
 887             {
 888                 OIC_LOG_V(INFO, TAG, "option[%d] has an unsupported format [%d]",
 889                           opt_iter.type, (uint8_t)buf[0]);
 890             }
 891             else
 892             {
 893                 if (COAP_OPTION_PROXY_URI == opt_iter.type)
 894                 {
 895                     isProxyRequest = true;
 896                 }
 897                 if (idx < count)
 898                 {
 899                     if (bufLength <= sizeof(outInfo->options[0].optionData))
 900                     {
 901                         outInfo->options[idx].optionID = opt_iter.type;
 902                         outInfo->options[idx].optionLength = bufLength;
 903                         outInfo->options[idx].protocolID = CA_COAP_ID;
 904                         memcpy(outInfo->options[idx].optionData, buf, bufLength);
 905                         idx++;
 906                     }
 907                 }
 908             }
 909         }
 910     }
 911
 912     unsigned char* token = NULL;
 913     unsigned int token_length = 0;
 914     coap_get_token2(pdu->transport_hdr, transport, &token, &token_length);
 915
 916     // set token data
 917     if (token_length > 0)
 918     {
 919         OIC_LOG_V(DEBUG, TAG, "inside token length : %d", token_length);
 920         outInfo->token = (char *) OICMalloc(token_length);
 921         if (NULL == outInfo->token)
 922         {
 923             OIC_LOG(ERROR, TAG, "Out of memory");
 924             OICFree(outInfo->options);
 925             return CA_MEMORY_ALLOC_FAILED;
 926         }
 927         memcpy(outInfo->token, token, token_length);
 928     }
 929
 930     outInfo->tokenLength = token_length;
 931
 932     // set payload data
 933     size_t dataSize;
 934     uint8_t *data;
 935     if (coap_get_data(pdu, &dataSize, &data))
 936     {
 937         OIC_LOG(DEBUG, TAG, "inside pdu->data");
 938         outInfo->payload = (uint8_t *) OICMalloc(dataSize);
 939         if (NULL == outInfo->payload)
 940         {
 941             OIC_LOG(ERROR, TAG, "Out of memory");
 942             OICFree(outInfo->options);
 943             OICFree(outInfo->token);
 944             return CA_MEMORY_ALLOC_FAILED;
 945         }
 946         memcpy(outInfo->payload, pdu->data, dataSize);
 947         outInfo->payloadSize = dataSize;
 948     }
 949
 950     if (optionResult[0] != '\0')
 951     {
 952         OIC_LOG_V(DEBUG, TAG, "URL length:%zu", strlen(optionResult));
 953         outInfo->resourceUri = OICStrdup(optionResult);
 954         if (!outInfo->resourceUri)
 955         {
 956             OIC_LOG(ERROR, TAG, "Out of memory");
 957             OICFree(outInfo->options);
 958             OICFree(outInfo->token);
 959             return CA_MEMORY_ALLOC_FAILED;
 960         }
 961     }
 962     else if(isProxyRequest && g_chproxyUri[0] != '\0')
 963     {
 964        /*
 965         *   A request for Proxy will not have any uri element as per CoAP specs
 966         *   and only COAP_OPTION_PROXY_URI will be present. Use preset proxy uri
 967         *   for such requests.
 968         */
 969         outInfo->resourceUri = OICStrdup(g_chproxyUri);
 970         if (!outInfo->resourceUri)
 971         {
 972             OIC_LOG(ERROR, TAG, "Out of memory");
 973             OICFree(outInfo->options);
 974             OICFree(outInfo->token);
 975             return CA_MEMORY_ALLOC_FAILED;
 976         }
 977     }
 978     return CA_STATUS_OK;
 979
 980 exit:
 981     OIC_LOG(ERROR, TAG, "buffer too small");
 982     OICFree(outInfo->options);
 983     return CA_STATUS_FAILED;
 984 }
 985
 986 CAResult_t CAGetTokenFromPDU(const coap_hdr_transport_t *pdu_hdr,
 987                              CAInfo_t *outInfo,
 988                              const CAEndpoint_t *endpoint)
 989 {
 990     VERIFY_NON_NULL(pdu_hdr, TAG, "pdu_hdr");
 991     VERIFY_NON_NULL(outInfo, TAG, "outInfo");
 992     VERIFY_NON_NULL(endpoint, TAG, "endpoint");
 993
 994     coap_transport_t transport = COAP_UDP;
 995 #ifdef WITH_TCP
 996     if (CAIsSupportedCoAPOverTCP(endpoint->adapter))
 997     {
 998         transport = coap_get_tcp_header_type_from_initbyte(((unsigned char *)pdu_hdr)[0] >> 4);
 999     }
1000 #endif
1001
1002     unsigned char* token = NULL;
1003     unsigned int token_length = 0;
1004     coap_get_token2(pdu_hdr, transport, &token, &token_length);
1005
1006     // set token data
1007     if (token_length > 0)
1008     {
1009         OIC_LOG_V(DEBUG, TAG, "token len:%d", token_length);
1010         outInfo->token = (char *) OICMalloc(token_length);
1011         if (NULL == outInfo->token)
1012         {
1013             OIC_LOG(ERROR, TAG, "Out of memory");
1014             return CA_MEMORY_ALLOC_FAILED;
1015         }
1016         memcpy(outInfo->token, token, token_length);
1017     }
1018
1019     outInfo->tokenLength = token_length;
1020
1021     return CA_STATUS_OK;
1022 }
1023
1024 CAResult_t CAGenerateTokenInternal(CAToken_t *token, uint8_t tokenLength)
1025 {
1026     VERIFY_NON_NULL(token, TAG, "token");
1027
1028     if ((tokenLength > CA_MAX_TOKEN_LEN) || (0 == tokenLength))
1029     {
1030         OIC_LOG(ERROR, TAG, "invalid token length");
1031         return CA_STATUS_INVALID_PARAM;
1032     }
1033
1034     // memory allocation
1035     char *temp = (char *) OICCalloc(tokenLength, sizeof(char));
1036     if (NULL == temp)
1037     {
1038         OIC_LOG(ERROR, TAG, "Out of memory");
1039         return CA_MEMORY_ALLOC_FAILED;
1040     }
1041
1042     OCFillRandomMem((uint8_t *)temp, tokenLength);
1043
1044     // save token
1045     *token = temp;
1046
1047     OIC_LOG_V(DEBUG, TAG, "token len:%d, token:", tokenLength);
1048     OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)(*token), tokenLength);
1049
1050     return CA_STATUS_OK;
1051 }
1052
1053 void CADestroyTokenInternal(CAToken_t token)
1054 {
1055     OICFree(token);
1056 }
1057
1058 uint32_t CAGetOptionData(uint16_t key, const uint8_t *data, uint32_t len,
1059         uint8_t *option, uint32_t buflen)
1060 {
1061     if (0 == buflen)
1062     {
1063         OIC_LOG(ERROR, TAG, "buflen 0");
1064         return 0;
1065     }
1066
1067     if (buflen <= len)
1068     {
1069         OIC_LOG(ERROR, TAG, "option buffer too small");
1070         return 0;
1071     }
1072
1073     coap_option_def_t* def = coap_opt_def(key);
1074     if (NULL != def && coap_is_var_bytes(def) && 0 == len)
1075     {
1076         // A 0 length option is permitted in CoAP but the
1077         // rest or the stack is unaware of variable byte encoding
1078         // should remain that way so a 0 byte of length 1 is inserted.
1079         len = 1;
1080         option[0]=0;
1081     }
1082     else
1083     {
1084         memcpy(option, data, len);
1085         option[len] = '\0';
1086     }
1087
1088     return len;
1089 }
1090
1091 CAMessageType_t CAGetMessageTypeFromPduBinaryData(const void *pdu, uint32_t size)
1092 {
1093     VERIFY_NON_NULL_RET(pdu, TAG, "pdu", CA_MSG_NONCONFIRM);
1094
1095     // pdu minimum size is 4 byte.
1096     if (size < CA_PDU_MIN_SIZE)
1097     {
1098         OIC_LOG(ERROR, TAG, "min size");
1099         return CA_MSG_NONCONFIRM;
1100     }
1101
1102     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1103
1104     return (CAMessageType_t) hdr->type;
1105 }
1106
1107 uint16_t CAGetMessageIdFromPduBinaryData(const void *pdu, uint32_t size)
1108 {
1109     VERIFY_NON_NULL_RET(pdu, TAG, "pdu", 0);
1110
1111     // pdu minimum size is 4 byte.
1112     if (size < CA_PDU_MIN_SIZE)
1113     {
1114         OIC_LOG(ERROR, TAG, "min size");
1115         return 0;
1116     }
1117
1118     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1119
1120     return hdr->id;
1121 }
1122
1123 CAResponseResult_t CAGetCodeFromPduBinaryData(const void *pdu, uint32_t size)
1124 {
1125     VERIFY_NON_NULL_RET(pdu, TAG, "pdu", CA_NOT_FOUND);
1126
1127     // pdu minimum size is 4 byte.
1128     if (size < CA_PDU_MIN_SIZE)
1129     {
1130         OIC_LOG(ERROR, TAG, "min size");
1131         return CA_NOT_FOUND;
1132     }
1133
1134     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1135
1136     return (CAResponseResult_t) CA_RESPONSE_CODE(hdr->code);
1137 }
1138
1139 CAPayloadFormat_t CAConvertFormat(uint8_t format)
1140 {
1141     switch (format)
1142     {
1143         case COAP_MEDIATYPE_TEXT_PLAIN:
1144             return CA_FORMAT_TEXT_PLAIN;
1145         case COAP_MEDIATYPE_APPLICATION_LINK_FORMAT:
1146             return CA_FORMAT_APPLICATION_LINK_FORMAT;
1147         case COAP_MEDIATYPE_APPLICATION_XML:
1148             return CA_FORMAT_APPLICATION_XML;
1149         case COAP_MEDIATYPE_APPLICATION_OCTET_STREAM:
1150             return CA_FORMAT_APPLICATION_OCTET_STREAM;
1151         case COAP_MEDIATYPE_APPLICATION_RDF_XML:
1152             return CA_FORMAT_APPLICATION_RDF_XML;
1153         case COAP_MEDIATYPE_APPLICATION_EXI:
1154             return CA_FORMAT_APPLICATION_EXI;
1155         case COAP_MEDIATYPE_APPLICATION_JSON:
1156             return CA_FORMAT_APPLICATION_JSON;
1157         case COAP_MEDIATYPE_APPLICATION_CBOR:
1158             return CA_FORMAT_APPLICATION_CBOR;
1159         default:
1160             return CA_FORMAT_UNSUPPORTED;
1161     }
1162 }
1163
1164 #ifdef WITH_BWT
1165 bool CAIsSupportedBlockwiseTransfer(CATransportAdapter_t adapter)
1166 {
1167     if (CA_ADAPTER_IP & adapter || CA_ADAPTER_NFC & adapter
1168             || CA_DEFAULT_ADAPTER == adapter)
1169     {
1170         return true;
1171     }
1172     return false;
1173 }
1174 #endif
1175
1176 #ifdef WITH_TCP
1177 bool CAIsSupportedCoAPOverTCP(CATransportAdapter_t adapter)
1178 {
1179     if (CA_ADAPTER_GATT_BTLE & adapter || CA_ADAPTER_RFCOMM_BTEDR & adapter
1180             || CA_ADAPTER_TCP & adapter || CA_DEFAULT_ADAPTER == adapter)
1181     {
1182         return true;
1183     }
1184     return false;
1185 }
1186 #endif