resource/csdk/connectivity/src/caprotocolmessage.c

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