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_APPLICATION_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     if (CA_FORMAT_UNDEFINED != info->acceptFormat)
 535     {
 536         coap_list_t* node = NULL;
 537         uint8_t buf[3] = {0};
 538         switch (info->acceptFormat) {
 539             case CA_FORMAT_APPLICATION_CBOR:
 540                 node = CACreateNewOptionNode(
 541                         COAP_OPTION_ACCEPT,
 542                         coap_encode_var_bytes(buf, (uint16_t)COAP_MEDIATYPE_APPLICATION_CBOR),
 543                         (char *)buf);
 544                 break;
 545             default:
 546                 OIC_LOG_V(ERROR, TAG, "format option:[%d] not supported", info->acceptFormat);
 547         }
 548         if (!node)
 549         {
 550             OIC_LOG(ERROR, TAG, "format option not created");
 551             return CA_STATUS_INVALID_PARAM;
 552         }
 553         int ret = coap_insert(optlist, node, CAOrderOpts);
 554         if (ret <= 0)
 555         {
 556             coap_delete(node);
 557             OIC_LOG(ERROR, TAG, "format option not inserted in header");
 558             return CA_STATUS_INVALID_PARAM;
 559         }
 560     }
 561
 562     OIC_LOG(DEBUG, TAG, "OUT");
 563     return CA_STATUS_OK;
 564 }
 565
 566 coap_list_t *CACreateNewOptionNode(uint16_t key, uint32_t length, const char *data)
 567 {
 568     OIC_LOG(DEBUG, TAG, "IN");
 569
 570     if (!data)
 571     {
 572         OIC_LOG(ERROR, TAG, "invalid pointer parameter");
 573         return NULL;
 574     }
 575
 576     coap_option *option = coap_malloc(sizeof(coap_option) + length + 1);
 577     if (!option)
 578     {
 579         OIC_LOG(ERROR, TAG, "Out of memory");
 580         return NULL;
 581     }
 582     memset(option, 0, sizeof(coap_option) + length + 1);
 583
 584     COAP_OPTION_KEY(*option) = key;
 585
 586     coap_option_def_t* def = coap_opt_def(key);
 587     if (NULL != def && coap_is_var_bytes(def))
 588     {
 589        if (length > def->max)
 590         {
 591             // make sure we shrink the value so it fits the coap option definition
 592             // by truncating the value, disregard the leading bytes.
 593             OIC_LOG_V(DEBUG, TAG, "Option [%d] data size [%d] shrunk to [%d]",
 594                     def->key, length, def->max);
 595             data = &(data[length-def->max]);
 596             length = def->max;
 597         }
 598         // Shrink the encoding length to a minimum size for coap
 599         // options that support variable length encoding.
 600          COAP_OPTION_LENGTH(*option) = coap_encode_var_bytes(
 601                 COAP_OPTION_DATA(*option),
 602                 coap_decode_var_bytes((unsigned char *)data, length));
 603     }
 604     else
 605     {
 606         COAP_OPTION_LENGTH(*option) = length;
 607         memcpy(COAP_OPTION_DATA(*option), data, length);
 608     }
 609
 610     /* we can pass NULL here as delete function since option is released automatically  */
 611     coap_list_t *node = coap_new_listnode(option, NULL);
 612
 613     if (!node)
 614     {
 615         OIC_LOG(ERROR, TAG, "node is NULL");
 616         coap_free(option);
 617         return NULL;
 618     }
 619
 620     OIC_LOG(DEBUG, TAG, "OUT");
 621     return node;
 622 }
 623
 624 int CAOrderOpts(void *a, void *b)
 625 {
 626     OIC_LOG(DEBUG, TAG, "IN");
 627     if (!a || !b)
 628     {
 629         return a < b ? -1 : 1;
 630     }
 631
 632     if (COAP_OPTION_KEY(*(coap_option *) a) < COAP_OPTION_KEY(*(coap_option * ) b))
 633     {
 634         return -1;
 635     }
 636
 637     OIC_LOG(DEBUG, TAG, "OUT");
 638     return COAP_OPTION_KEY(*(coap_option *) a) == COAP_OPTION_KEY(*(coap_option * ) b);
 639 }
 640
 641 uint32_t CAGetOptionCount(coap_opt_iterator_t opt_iter)
 642 {
 643     OIC_LOG(DEBUG, TAG, "IN");
 644     uint32_t count = 0;
 645     coap_opt_t *option;
 646
 647     while ((option = coap_option_next(&opt_iter)))
 648     {
 649         if (COAP_OPTION_URI_PATH != opt_iter.type && COAP_OPTION_URI_QUERY != opt_iter.type
 650             && COAP_OPTION_BLOCK1 != opt_iter.type && COAP_OPTION_BLOCK2 != opt_iter.type
 651             && COAP_OPTION_SIZE1 != opt_iter.type && COAP_OPTION_SIZE2 != opt_iter.type
 652             && COAP_OPTION_CONTENT_FORMAT != opt_iter.type
 653             && COAP_OPTION_ACCEPT != opt_iter.type)
 654         {
 655             count++;
 656         }
 657     }
 658
 659     OIC_LOG(DEBUG, TAG, "OUT");
 660     return count;
 661 }
 662
 663 CAResult_t CAGetInfoFromPDU(const coap_pdu_t *pdu, uint32_t *outCode, CAInfo_t *outInfo)
 664 {
 665     OIC_LOG(DEBUG, TAG, "IN");
 666
 667     if (!pdu || !outCode || !outInfo)
 668     {
 669         OIC_LOG(ERROR, TAG, "NULL pointer param");
 670         return CA_STATUS_INVALID_PARAM;
 671     }
 672
 673     coap_opt_iterator_t opt_iter;
 674     coap_option_iterator_init((coap_pdu_t *) pdu, &opt_iter, COAP_OPT_ALL);
 675
 676     if (outCode)
 677     {
 678         (*outCode) = (uint32_t) CA_RESPONSE_CODE(pdu->hdr->code);
 679     }
 680
 681     // init HeaderOption list
 682     uint32_t count = CAGetOptionCount(opt_iter);
 683     memset(outInfo, 0, sizeof(*outInfo));
 684
 685     outInfo->numOptions = count;
 686
 687     // set type
 688     outInfo->type = pdu->hdr->type;
 689
 690     // set message id
 691     outInfo->messageId = pdu->hdr->id;
 692     outInfo->payloadFormat = CA_FORMAT_UNDEFINED;
 693     outInfo->acceptFormat = CA_FORMAT_UNDEFINED;
 694
 695     if (count > 0)
 696     {
 697         outInfo->options = (CAHeaderOption_t *) OICCalloc(count, sizeof(CAHeaderOption_t));
 698         if (NULL == outInfo->options)
 699         {
 700             OIC_LOG(ERROR, TAG, "Out of memory");
 701             return CA_MEMORY_ALLOC_FAILED;
 702         }
 703     }
 704
 705     coap_opt_t *option;
 706     char optionResult[CA_MAX_URI_LENGTH] = {0};
 707     uint32_t idx = 0;
 708     uint32_t optionLength = 0;
 709     bool isfirstsetflag = false;
 710     bool isQueryBeingProcessed = false;
 711
 712     while ((option = coap_option_next(&opt_iter)))
 713     {
 714         char buf[COAP_MAX_PDU_SIZE] = {0};
 715         uint32_t bufLength =
 716             CAGetOptionData(opt_iter.type, (uint8_t *)(COAP_OPT_VALUE(option)),
 717                     COAP_OPT_LENGTH(option), (uint8_t *)buf, sizeof(buf));
 718         if (bufLength)
 719         {
 720             OIC_LOG_V(DEBUG, TAG, "COAP URI element : %s", buf);
 721             if (COAP_OPTION_URI_PATH == opt_iter.type || COAP_OPTION_URI_QUERY == opt_iter.type)
 722             {
 723                 if (false == isfirstsetflag)
 724                 {
 725                     isfirstsetflag = true;
 726                     optionResult[optionLength] = '/';
 727                     optionLength++;
 728                     // Make sure there is enough room in the optionResult buffer
 729                     if ((optionLength + bufLength) < sizeof(optionResult))
 730                     {
 731                         memcpy(&optionResult[optionLength], buf, bufLength);
 732                         optionLength += bufLength;
 733                     }
 734                     else
 735                     {
 736                         goto exit;
 737                     }
 738                 }
 739                 else
 740                 {
 741                     if (COAP_OPTION_URI_PATH == opt_iter.type)
 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                     else if (COAP_OPTION_URI_QUERY == opt_iter.type)
 755                     {
 756                         if (false == isQueryBeingProcessed)
 757                         {
 758                             // Make sure there is enough room in the optionResult buffer
 759                             if (optionLength < sizeof(optionResult))
 760                             {
 761                                 optionResult[optionLength] = '?';
 762                                 optionLength++;
 763                                 isQueryBeingProcessed = true;
 764                             }
 765                             else
 766                             {
 767                                 goto exit;
 768                             }
 769                         }
 770                         else
 771                         {
 772                             // Make sure there is enough room in the optionResult buffer
 773                             if (optionLength < sizeof(optionResult))
 774                             {
 775                                 optionResult[optionLength] = ';';
 776                                 optionLength++;
 777                             }
 778                             else
 779                             {
 780                                 goto exit;
 781                             }
 782                         }
 783                     }
 784                     // Make sure there is enough room in the optionResult buffer
 785                     if ((optionLength + bufLength) < sizeof(optionResult))
 786                     {
 787                         memcpy(&optionResult[optionLength], buf, bufLength);
 788                         optionLength += bufLength;
 789                     }
 790                     else
 791                     {
 792                         goto exit;
 793                     }
 794                 }
 795             }
 796             else if (COAP_OPTION_BLOCK1 == opt_iter.type || COAP_OPTION_BLOCK2 == opt_iter.type
 797                     || COAP_OPTION_SIZE1 == opt_iter.type || COAP_OPTION_SIZE2 == opt_iter.type)
 798             {
 799                 OIC_LOG_V(DEBUG, TAG, "option[%d] will be filtering", opt_iter.type);
 800             }
 801             else if (COAP_OPTION_CONTENT_FORMAT == opt_iter.type)
 802             {
 803                 if (1 == COAP_OPT_LENGTH(option))
 804                 {
 805                     outInfo->payloadFormat = CAConvertFormat((uint8_t)buf[0]);
 806                 }
 807                 else
 808                 {
 809                     outInfo->payloadFormat = CA_FORMAT_UNSUPPORTED;
 810                     OIC_LOG_V(DEBUG, TAG, "option[%d] has an unsupported format [%d]",
 811                             opt_iter.type, (uint8_t)buf[0]);
 812                 }
 813             }
 814             else if (COAP_OPTION_ACCEPT == opt_iter.type)
 815             {
 816                 if (1 == COAP_OPT_LENGTH(option))
 817                 {
 818                     outInfo->acceptFormat = CAConvertFormat((uint8_t)buf[0]);
 819                 }
 820                 else
 821                 {
 822                     outInfo->acceptFormat = CA_FORMAT_UNSUPPORTED;
 823                 }
 824                 OIC_LOG_V(DEBUG, TAG, "option[%d] has an unsupported format [%d]",
 825                         opt_iter.type, (uint8_t)buf[0]);
 826             }
 827             else
 828             {
 829                 if (idx < count)
 830                 {
 831                     uint32_t length = bufLength;
 832
 833                     if (length <= CA_MAX_HEADER_OPTION_DATA_LENGTH)
 834                     {
 835                         outInfo->options[idx].optionID = opt_iter.type;
 836                         outInfo->options[idx].optionLength = length;
 837                         outInfo->options[idx].protocolID = CA_COAP_ID;
 838                         memcpy(outInfo->options[idx].optionData, buf, length);
 839                         idx++;
 840                     }
 841                 }
 842             }
 843         }
 844     }
 845
 846     // set token data
 847     if (pdu->hdr->token_length > 0)
 848     {
 849         OIC_LOG_V(DEBUG, TAG, "inside token length : %d", pdu->hdr->token_length);
 850         outInfo->token = (char *) OICMalloc(pdu->hdr->token_length);
 851         if (NULL == outInfo->token)
 852         {
 853             OIC_LOG(ERROR, TAG, "Out of memory");
 854             OICFree(outInfo->options);
 855             return CA_MEMORY_ALLOC_FAILED;
 856         }
 857         memcpy(outInfo->token, pdu->hdr->token, pdu->hdr->token_length);
 858     }
 859
 860     outInfo->tokenLength = pdu->hdr->token_length;
 861
 862     // set payload data
 863     size_t dataSize;
 864     uint8_t *data;
 865     if (coap_get_data(pdu, &dataSize, &data))
 866     {
 867         OIC_LOG(DEBUG, TAG, "inside pdu->data");
 868         outInfo->payload = (uint8_t *) OICMalloc(dataSize);
 869         if (NULL == outInfo->payload)
 870         {
 871             OIC_LOG(ERROR, TAG, "Out of memory");
 872             OICFree(outInfo->options);
 873             OICFree(outInfo->token);
 874             return CA_MEMORY_ALLOC_FAILED;
 875         }
 876         memcpy(outInfo->payload, pdu->data, dataSize);
 877         outInfo->payloadSize = dataSize;
 878     }
 879
 880     if (optionResult[0] != '\0')
 881     {
 882         OIC_LOG_V(DEBUG, TAG, "URL length:%d", strlen(optionResult));
 883         outInfo->resourceUri = OICStrdup(optionResult);
 884         if (!outInfo->resourceUri)
 885         {
 886             OIC_LOG(ERROR, TAG, "Out of memory");
 887             OICFree(outInfo->options);
 888             OICFree(outInfo->token);
 889             return CA_MEMORY_ALLOC_FAILED;
 890         }
 891     }
 892
 893     OIC_LOG(DEBUG, TAG, "OUT");
 894     return CA_STATUS_OK;
 895
 896 exit:
 897     OIC_LOG(ERROR, TAG, "buffer too small");
 898     OICFree(outInfo->options);
 899     return CA_STATUS_FAILED;
 900 }
 901
 902 CAResult_t CAGetTokenFromPDU(const coap_hdr_t *pdu_hdr, CAInfo_t *outInfo)
 903 {
 904     OIC_LOG(DEBUG, TAG, "IN");
 905     if (NULL == pdu_hdr)
 906     {
 907         OIC_LOG(ERROR, TAG, "pdu_hdr is null");
 908         return CA_STATUS_INVALID_PARAM;
 909     }
 910
 911     if (NULL == outInfo)
 912     {
 913         OIC_LOG(ERROR, TAG, "outInfo is null");
 914         return CA_STATUS_INVALID_PARAM;
 915     }
 916
 917     // set token data
 918     if (pdu_hdr->token_length > 0)
 919     {
 920         OIC_LOG_V(DEBUG, TAG, "token len:%d", pdu_hdr->token_length);
 921         outInfo->token = (char *) OICMalloc(pdu_hdr->token_length);
 922         if (NULL == outInfo->token)
 923         {
 924             OIC_LOG(ERROR, TAG, "out of memory");
 925             return CA_MEMORY_ALLOC_FAILED;
 926         }
 927         memcpy(outInfo->token, pdu_hdr->token, pdu_hdr->token_length);
 928     }
 929
 930     outInfo->tokenLength = pdu_hdr->token_length;
 931
 932     OIC_LOG(DEBUG, TAG, "OUT");
 933
 934     return CA_STATUS_OK;
 935 }
 936
 937 CAResult_t CAGenerateTokenInternal(CAToken_t *token, uint8_t tokenLength)
 938 {
 939     OIC_LOG(DEBUG, TAG, "IN");
 940
 941     if (!token)
 942     {
 943         OIC_LOG(ERROR, TAG, "invalid token pointer");
 944         return CA_STATUS_INVALID_PARAM;
 945     }
 946
 947     if ((tokenLength > CA_MAX_TOKEN_LEN) || (0 == tokenLength))
 948     {
 949         OIC_LOG(ERROR, TAG, "invalid token length");
 950         return CA_STATUS_INVALID_PARAM;
 951     }
 952
 953     if (SEED == 0)
 954     {
 955 #ifdef ARDUINO
 956         SEED = now();
 957 #else
 958         SEED = time(NULL);
 959 #endif
 960         if (SEED == (unsigned int)((time_t)-1))
 961         {
 962             OIC_LOG(ERROR, TAG, "seed is not made");
 963             SEED = 0;
 964             return CA_STATUS_FAILED;
 965         }
 966 #if HAVE_SRANDOM
 967         srandom(SEED);
 968 #else
 969         srand(SEED);
 970 #endif
 971     }
 972
 973     // memory allocation
 974     char *temp = (char *) OICCalloc(tokenLength, sizeof(char));
 975     if (NULL == temp)
 976     {
 977         OIC_LOG(ERROR, TAG, "Out of memory");
 978         return CA_MEMORY_ALLOC_FAILED;
 979     }
 980
 981     // set random byte
 982     for (uint8_t index = 0; index < tokenLength; index++)
 983     {
 984         // use valid characters
 985 #ifdef ARDUINO
 986         temp[index] = rand() & 0x00FF;
 987 #else
 988         temp[index] = random() & 0x00FF;
 989 #endif
 990     }
 991
 992     // save token
 993     *token = temp;
 994
 995     OIC_LOG_V(DEBUG, TAG, "token len:%d, token:", tokenLength);
 996     OIC_LOG_BUFFER(DEBUG, TAG, (const uint8_t *)(*token), tokenLength);
 997
 998     OIC_LOG(DEBUG, TAG, "OUT");
 999     return CA_STATUS_OK;
1000 }
1001
1002 void CADestroyTokenInternal(CAToken_t token)
1003 {
1004     OIC_LOG(DEBUG, TAG, "IN");
1005     OICFree(token);
1006     OIC_LOG(DEBUG, TAG, "OUT");
1007 }
1008
1009 void CADestroyInfo(CAInfo_t *info)
1010 {
1011     OIC_LOG(DEBUG, TAG, "IN");
1012
1013     if (NULL != info)
1014     {
1015         OIC_LOG(DEBUG, TAG, "free options");
1016         OICFree(info->options);
1017
1018         OIC_LOG(DEBUG, TAG, "free token");
1019         OICFree(info->token);
1020
1021         OIC_LOG(DEBUG, TAG, "free payload");
1022         OICFree(info->payload);
1023     }
1024
1025     OIC_LOG(DEBUG, TAG, "OUT");
1026 }
1027
1028 uint32_t CAGetOptionData(uint16_t key, const uint8_t *data, uint32_t len,
1029         uint8_t *option, uint32_t buflen)
1030 {
1031     if (0 == buflen)
1032     {
1033         OIC_LOG(ERROR, TAG, "buflen 0");
1034         return 0;
1035     }
1036
1037     if (NULL == data || NULL == option)
1038     {
1039         OIC_LOG(ERROR, TAG, "data/option NULL");
1040         return 0;
1041     }
1042
1043     if (buflen <= len)
1044     {
1045         OIC_LOG(ERROR, TAG, "option buffer too small");
1046         return 0;
1047     }
1048
1049     coap_option_def_t* def = coap_opt_def(key);
1050     if(NULL != def && coap_is_var_bytes(def) && 0 == len) {
1051         // A 0 length option is permitted in CoAP but the
1052         // rest or the stack is unaware of variable byte encoding
1053         // should remain that way so a 0 byte of length 1 is inserted.
1054         len = 1;
1055         option[0]=0;
1056     } else {
1057         memcpy(option, data, len);
1058         option[len] = '\0';
1059     }
1060
1061     return len;
1062 }
1063
1064 CAMessageType_t CAGetMessageTypeFromPduBinaryData(const void *pdu, uint32_t size)
1065 {
1066     if (NULL == pdu)
1067     {
1068         OIC_LOG(ERROR, TAG, "pdu is null");
1069         return CA_MSG_NONCONFIRM;
1070     }
1071
1072     // pdu minimum size is 4 byte.
1073     if (size < CA_PDU_MIN_SIZE)
1074     {
1075         OIC_LOG(ERROR, TAG, "min size");
1076         return CA_MSG_NONCONFIRM;
1077     }
1078
1079     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1080
1081     return (CAMessageType_t) hdr->type;
1082 }
1083
1084 uint16_t CAGetMessageIdFromPduBinaryData(const void *pdu, uint32_t size)
1085 {
1086     if (NULL == pdu)
1087     {
1088         OIC_LOG(ERROR, TAG, "pdu is null");
1089         return 0;
1090     }
1091
1092     // pdu minimum size is 4 byte.
1093     if (size < CA_PDU_MIN_SIZE)
1094     {
1095         OIC_LOG(ERROR, TAG, "min size");
1096         return 0;
1097     }
1098
1099     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1100
1101     return hdr->id;
1102 }
1103
1104 CAResponseResult_t CAGetCodeFromPduBinaryData(const void *pdu, uint32_t size)
1105 {
1106     if (NULL == pdu)
1107     {
1108         OIC_LOG(ERROR, TAG, "pdu is null");
1109         return CA_NOT_FOUND;
1110     }
1111
1112     // pdu minimum size is 4 byte.
1113     if (size < CA_PDU_MIN_SIZE)
1114     {
1115         OIC_LOG(ERROR, TAG, "min size");
1116         return CA_NOT_FOUND;
1117     }
1118
1119     coap_hdr_t *hdr = (coap_hdr_t *) pdu;
1120
1121     return (CAResponseResult_t) CA_RESPONSE_CODE(hdr->code);
1122 }
1123
1124 CAPayloadFormat_t CAConvertFormat(uint8_t format)
1125 {
1126     switch (format)
1127     {
1128         case COAP_MEDIATYPE_TEXT_PLAIN:
1129             return CA_FORMAT_TEXT_PLAIN;
1130         case COAP_MEDIATYPE_APPLICATION_LINK_FORMAT:
1131             return CA_FORMAT_APPLICATION_LINK_FORMAT;
1132         case COAP_MEDIATYPE_APPLICATION_XML:
1133             return CA_FORMAT_APPLICATION_XML;
1134         case COAP_MEDIATYPE_APPLICATION_OCTET_STREAM:
1135             return CA_FORMAT_APPLICATION_OCTET_STREAM;
1136         case COAP_MEDIATYPE_APPLICATION_RDF_XML:
1137             return CA_FORMAT_APPLICATION_RDF_XML;
1138         case COAP_MEDIATYPE_APPLICATION_EXI:
1139             return CA_FORMAT_APPLICATION_EXI;
1140         case COAP_MEDIATYPE_APPLICATION_JSON:
1141             return CA_FORMAT_APPLICATION_JSON;
1142         case COAP_MEDIATYPE_APPLICATION_CBOR:
1143             return CA_FORMAT_APPLICATION_CBOR;
1144         default:
1145             return CA_FORMAT_UNSUPPORTED;
1146     }
1147 }