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