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