resource/csdk/include/octypes.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 Intel Mobile Communications GmbH 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
  22 /**
  23  * @file
  24  *
  25  * This file contains the definitions, types and APIs for resources to be implemented.
  26  */
  27
  28 #ifndef OCTYPES_H_
  29 #define OCTYPES_H_
  30
  31 #include "ocstackconfig.h"
  32 #include <stdbool.h>
  33 #include <stdint.h>
  34 #include <stdio.h>
  35 #ifdef __cplusplus
  36 #include <string.h>
  37
  38 extern "C" {
  39 #endif // __cplusplus
  40
  41 /** For the feature presence.*/
  42 #define WITH_PRESENCE
  43
  44 #include "ocpresence.h"
  45
  46 //-----------------------------------------------------------------------------
  47 // Defines
  48 //-----------------------------------------------------------------------------
  49
  50 /** Version of IoTivity. */
  51 #define IOTIVITY_VERSION                      "2.0.0"
  52
  53 /**
  54  * OIC Virtual resources supported by every OIC device.
  55  */
  56 /**
  57  *  Default discovery mechanism using '/oic/res' is supported by all OIC devices
  58  *  That are Discoverable.
  59  */
  60 #define OC_RSRVD_WELL_KNOWN_URI               "/oic/res"
  61
  62 /** Device URI.*/
  63 #define OC_RSRVD_DEVICE_URI                   "/oic/d"
  64
  65 /** Platform URI.*/
  66 #define OC_RSRVD_PLATFORM_URI                 "/oic/p"
  67
  68 /** Resource Type.*/
  69 #define OC_RSRVD_RESOURCE_TYPES_URI           "/oic/res/types/d"
  70
  71 /** Gateway URI.*/
  72 #define OC_RSRVD_GATEWAY_URI                  "/oic/gateway"
  73
  74 /** MQ Broker URI.*/
  75 #define OC_RSRVD_WELL_KNOWN_MQ_URI            "/oic/ps"
  76
  77 /** KeepAlive URI.*/
  78 #define OC_RSRVD_KEEPALIVE_URI                "/oic/ping"
  79
  80 /** Cloudconf URI.*/
  81 #define OC_RSRVD_CLOUDCONF_URI                "/CoapCloudConfResURI"
  82
  83 /** Presence */
  84
  85 /** Presence URI through which the OIC devices advertise their presence.*/
  86 #define OC_RSRVD_PRESENCE_URI                 "/oic/ad"
  87
  88 /** Presence URI through which the OIC devices advertise their device presence.*/
  89 #define OC_RSRVD_DEVICE_PRESENCE_URI         "/oic/prs"
  90
  91 /** Sets the default time to live (TTL) for presence.*/
  92 #define OC_DEFAULT_PRESENCE_TTL_SECONDS       (60)
  93
  94 /** For multicast Discovery mechanism.*/
  95 #define OC_MULTICAST_DISCOVERY_URI            "/oic/res"
  96
  97 /** Separator for multiple query string.*/
  98 #define OC_QUERY_SEPARATOR                    "&;"
  99
 100 /** Delimeter for keys and values in query string.*/
 101 #define OC_KEY_VALUE_DELIMITER                "="
 102
 103 /**
 104  *  OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
 105  */
 106 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
 107
 108 /**
 109  *  OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
 110  *  NOTE: Changing the setting to a longer duration may lead to unsupported and untested
 111  *  operation.
 112  *  60 sec/min * 60 min/hr * 24 hr/day
 113  */
 114 #define OC_MAX_PRESENCE_TTL_SECONDS     (60 * 60 * 24)
 115
 116
 117 /**
 118  *  Presence "Announcement Triggers".
 119  */
 120
 121 /** To create.*/
 122 #define OC_RSRVD_TRIGGER_CREATE         "create"
 123
 124 /** To change.*/
 125 #define OC_RSRVD_TRIGGER_CHANGE         "change"
 126
 127 /** To delete.*/
 128 #define OC_RSRVD_TRIGGER_DELETE         "delete"
 129
 130 /**
 131  *  Attributes used to form a proper OIC conforming JSON message.
 132  */
 133
 134 #define OC_RSRVD_OC                     "oic"
 135
 136
 137 /** For payload. */
 138
 139 #define OC_RSRVD_PAYLOAD                "payload"
 140
 141 /** To represent href */
 142 #define OC_RSRVD_HREF                   "href"
 143
 144 /** To represent property*/
 145 #define OC_RSRVD_PROPERTY               "prop"
 146
 147 /** For representation.*/
 148 #define OC_RSRVD_REPRESENTATION         "rep"
 149
 150 /** To represent content type.*/
 151 #define OC_RSRVD_CONTENT_TYPE           "ct"
 152
 153 /** To represent resource type.*/
 154 #define OC_RSRVD_RESOURCE_TYPE          "rt"
 155
 156 /** To represent resource type with presence.*/
 157 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
 158
 159 /** To represent resource type with device.*/
 160 #define OC_RSRVD_RESOURCE_TYPE_DEVICE   "oic.wk.d"
 161
 162 /** To represent resource type with platform.*/
 163 #define OC_RSRVD_RESOURCE_TYPE_PLATFORM "oic.wk.p"
 164
 165 /** To represent resource type with maintenance.*/
 166 #define OC_RSRVD_RESOURCE_TYPE_MAINTENANCE "oic.wk.mnt"
 167
 168 /** To represent resource type with collection.*/
 169 #define OC_RSRVD_RESOURCE_TYPE_COLLECTION "oic.wk.col"
 170
 171 /** To represent resource type with RES.*/
 172 #define OC_RSRVD_RESOURCE_TYPE_RES      "oic.wk.res"
 173
 174 /** To represent content type with MQ Broker.*/
 175 #define OC_RSRVD_RESOURCE_TYPE_MQ_BROKER "oic.wk.ps"
 176
 177 /** To represent content type with MQ Topic.*/
 178 #define OC_RSRVD_RESOURCE_TYPE_MQ_TOPIC  "oic.wk.ps.topic"
 179
 180 /** To represent resource type with introspection.*/
 181 #define OC_RSRVD_RESOURCE_TYPE_INTROSPECTION "oic.wk.introspection"
 182
 183 /** To represent resource type with introspection payload.*/
 184 #define OC_RSRVD_RESOURCE_TYPE_INTROSPECTION_PAYLOAD "oic.wk.introspection.payload"
 185
 186 /** To represent interface.*/
 187 #define OC_RSRVD_INTERFACE              "if"
 188
 189 /** To represent time to live.*/
 190 #define OC_RSRVD_TTL                    "ttl"
 191
 192 /** To indicate how long RD should publish this item.*/
 193 #define OC_RSRVD_DEVICE_TTL             OC_RSRVD_TTL
 194
 195 /** To represent non*/
 196 #define OC_RSRVD_NONCE                  "non"
 197
 198 /** To represent trigger type.*/
 199 #define OC_RSRVD_TRIGGER                "trg"
 200
 201 /** To represent links.*/
 202 #define OC_RSRVD_LINKS                  "links"
 203
 204 /** To represent default interface.*/
 205 #define OC_RSRVD_INTERFACE_DEFAULT      "oic.if.baseline"
 206
 207 /** To represent read-only interface.*/
 208 #define OC_RSRVD_INTERFACE_READ         "oic.if.r"
 209
 210 /** To represent read-write interface.*/
 211 #define OC_RSRVD_INTERFACE_READ_WRITE   "oic.if.rw"
 212
 213 /** To represent ll interface.*/
 214 #define OC_RSRVD_INTERFACE_LL           "oic.if.ll"
 215
 216 /** To represent batch interface.*/
 217 #define OC_RSRVD_INTERFACE_BATCH        "oic.if.b"
 218
 219 /** To represent actuator interface.*/
 220 #define OC_RSRVD_INTERFACE_ACTUATOR     "oic.if.a"
 221
 222 /** To represent sensor interface.*/
 223 #define OC_RSRVD_INTERFACE_SENSOR       "oic.if.s"
 224
 225 /** To represent interface group.*/
 226 #define OC_RSRVD_INTERFACE_GROUP        "oic.mi.grp"
 227
 228 /** To represent FW version.*/
 229 #define OC_RSRVD_FW_VERSION             "mnfv"
 230
 231 /** To represent host name.*/
 232 #define OC_RSRVD_HOST_NAME              "hn"
 233
 234 /** To represent policy.*/
 235 #define OC_RSRVD_POLICY                 "p"
 236
 237 /** To represent bitmap.*/
 238 #define OC_RSRVD_BITMAP                 "bm"
 239
 240 /** For security.*/
 241 #define OC_RSRVD_SECURE                 "sec"
 242
 243 /** Security Database persistent store name(json).*/
 244 #define OC_SECURITY_DB_FILE_NAME        "oic_svr_db.json"
 245
 246 /** Security Database persistent store name(dat).*/
 247 #define OC_SECURITY_DB_DAT_FILE_NAME    "oic_svr_db.dat"
 248
 249 /** Port. */
 250 #define OC_RSRVD_HOSTING_PORT           "port"
 251
 252 /** TCP Port. */
 253 #define OC_RSRVD_TCP_PORT               "x.org.iotivity.tcp"
 254
 255 /** TLS Port. */
 256 #define OC_RSRVD_TLS_PORT               "x.org.iotivity.tls"
 257
 258 /** For Server instance ID.*/
 259 #define OC_RSRVD_SERVER_INSTANCE_ID     "sid"
 260
 261 /** To represent endpoints.*/
 262 #define OC_RSRVD_ENDPOINTS              "eps"
 263
 264 /** To represent endpoint.*/
 265 #define OC_RSRVD_ENDPOINT               "ep"
 266
 267 /** To represent priority.*/
 268 #define OC_RSRVD_PRIORITY               "pri"
 269
 270 /** For resource instance ID.*/
 271 #define OC_RSRVD_INSTANCE_ID            "id"
 272
 273 /**
 274  *  Platform.
 275  */
 276
 277 /** Platform ID. */
 278 #define OC_RSRVD_PLATFORM_ID            "pi"
 279
 280 /** Platform MFG NAME. */
 281 #define OC_RSRVD_MFG_NAME               "mnmn"
 282
 283 /** Platform URL. */
 284 #define OC_RSRVD_MFG_URL                "mnml"
 285
 286 /** Model Number.*/
 287 #define OC_RSRVD_MODEL_NUM              "mnmo"
 288
 289 /** Platform MFG Date.*/
 290 #define OC_RSRVD_MFG_DATE               "mndt"
 291
 292 /** Platform versio.n */
 293 #define OC_RSRVD_PLATFORM_VERSION       "mnpv"
 294
 295 /** Platform Operating system version. */
 296 #define OC_RSRVD_OS_VERSION             "mnos"
 297
 298 /** Platform Hardware version. */
 299 #define OC_RSRVD_HARDWARE_VERSION       "mnhw"
 300
 301 /**Platform Firmware version. */
 302 #define OC_RSRVD_FIRMWARE_VERSION       "mnfv"
 303
 304 /** Support URL for the platform. */
 305 #define OC_RSRVD_SUPPORT_URL            "mnsl"
 306
 307 /** System time for the platform. */
 308 #define OC_RSRVD_SYSTEM_TIME            "st"
 309
 310 /** VID for the platform. */
 311 #define OC_RSRVD_VID                    "vid"
 312
 313 /**
 314  *  Device.
 315  */
 316
 317 /** Device ID.*/
 318 #define OC_RSRVD_DEVICE_ID               "di"
 319
 320 /** Device Name.*/
 321 #define OC_RSRVD_DEVICE_NAME             "n"
 322
 323 /** Device specification version.*/
 324 #define OC_RSRVD_SPEC_VERSION            "icv"
 325
 326 /** Device data model.*/
 327 #define OC_RSRVD_DATA_MODEL_VERSION      "dmv"
 328
 329 /** Device description, localized */
 330 #define OC_RSRVD_DEVICE_DESCRIPTION      "ld"
 331
 332 /** Device software version */
 333 #define OC_RSRVD_SOFTWARE_VERSION        "sv"
 334
 335 /** Device manufacturer name, localized */
 336 #define OC_RSRVD_DEVICE_MFG_NAME         "dmn"
 337
 338 /** Device model number */
 339 #define OC_RSRVD_DEVICE_MODEL_NUM        "dmno"
 340
 341 /** Protocol-Independent ID.*/
 342 #define OC_RSRVD_PROTOCOL_INDEPENDENT_ID "piid"
 343
 344 /** Device specification version.*/
 345 #define OC_SPEC_VERSION                  "ocf.1.1.0"
 346
 347 /** Integer value of spec version (OCF1.0 0b0000:1000:0000:0000).*/
 348 #define OC_SPEC_VERSION_VALUE            2048
 349
 350 /** Device Data Model version.*/
 351 #define OC_DATA_MODEL_VERSION            "ocf.res.1.1.0,ocf.sh.1.1.0"
 352
 353 /**
 354  *  Introspection.
 355  */
 356 /** Name property name(n).*/
 357 #define OC_RSRVD_INTROSPECTION_NAME     "n"
 358
 359 /** Value of name.*/
 360 #define OC_RSRVD_INTROSPECTION_NAME_VALUE "Introspection"
 361
 362 /** Url info Object.*/
 363 #define OC_RSRVD_INTROSPECTION_URL_INFO "urlInfo"
 364
 365 /** Url property.*/
 366 #define OC_RSRVD_INTROSPECTION_URL      "url"
 367
 368 /** Protocol property.*/
 369 #define OC_RSRVD_INTROSPECTION_PROTOCOL    "protocol"
 370
 371 /** Content-Type property.*/
 372 #define OC_RSRVD_INTROSPECTION_CONTENT_TYPE "content-type"
 373
 374 /** Content-Type property value.*/
 375 #define OC_RSRVD_INTROSPECTION_CONTENT_TYPE_VALUE "application/cbor"
 376
 377 /** Version property.*/
 378 #define OC_RSRVD_INTROSPECTION_VERSION    "version"
 379
 380 /** Version property value.*/
 381 #define OC_RSRVD_INTROSPECTION_VERSION_VALUE 1
 382
 383 /** Introspection persistent store name.*/
 384 #define OC_INTROSPECTION_FILE_NAME      "introspection.dat"
 385
 386 /**
 387  *  These provide backward compatibility - their use is deprecated.
 388  */
 389 #ifndef GOING_AWAY
 390
 391 /** Multicast Prefix.*/
 392 #define OC_MULTICAST_PREFIX             "224.0.1.187:5683"
 393
 394 /** Multicast IP address.*/
 395 #define OC_MULTICAST_IP                 "224.0.1.187"
 396
 397 /** Multicast Port.*/
 398 #define OC_MULTICAST_PORT               (5683)
 399 #endif // GOING_AWAY
 400
 401 /** Max Device address size. */
 402 #ifdef RA_ADAPTER
 403 #define MAX_ADDR_STR_SIZE (256)
 404 #else
 405 /** Max Address could be
 406  * "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
 407  * +1 for null terminator.
 408  */
 409 #define MAX_ADDR_STR_SIZE (66)
 410 #endif
 411
 412 /** Length of MAC address */
 413 #define MAC_ADDR_STR_SIZE (17)
 414
 415 /** Blocks of MAC address */
 416 #define MAC_ADDR_BLOCKS (6)
 417
 418 /** Max identity size. */
 419 #define MAX_IDENTITY_SIZE (37)
 420
 421 /** Universal unique identity size. */
 422 #define UUID_IDENTITY_SIZE (128/8)
 423
 424 /** Resource Directory */
 425
 426 /** Resource Directory URI used to Discover RD and Publish resources.*/
 427 #define OC_RSRVD_RD_URI                  "/oic/rd"
 428
 429 /** To represent resource type with rd.*/
 430 #define OC_RSRVD_RESOURCE_TYPE_RD        "oic.wk.rd"
 431
 432 /** RD Discovery bias factor type. */
 433 #define OC_RSRVD_RD_DISCOVERY_SEL        "sel"
 434
 435 /** Resource URI used to discover Proxy */
 436 #define OC_RSRVD_PROXY_URI "/oic/chp"
 437
 438 /** Resource URI used to discover Proxy */
 439 #define OC_RSRVD_PROXY_OPTION_ID 35
 440
 441 /** Unique value per collection/link. */
 442 #define OC_RSRVD_INS                     "ins"
 443
 444 /** Allowable resource types in the links. */
 445 #define OC_RSRVD_RTS                     "rts"
 446
 447 /** Default relationship. */
 448 #define OC_RSRVD_DREL                    "drel"
 449
 450 /** Defines relationship between links. */
 451 #define OC_RSRVD_REL                     "rel"
 452
 453 /** Defines title. */
 454 #define OC_RSRVD_TITLE                   "title"
 455
 456 /** Defines URI. */
 457 #define OC_RSRVD_URI                     "anchor"
 458
 459 /** Defines media type. */
 460 #define OC_RSRVD_MEDIA_TYPE              "type"
 461
 462 /** To represent resource type with Publish RD.*/
 463 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdpub"
 464
 465 /** Cloud Account */
 466
 467 /** Account URI.*/
 468 #define OC_RSRVD_ACCOUNT_URI               "/oic/sec/account"
 469
 470 /** Account user URI.*/
 471 #define OC_RSRVD_ACCOUNT_SEARCH_URI        "/oic/account/search"
 472
 473 /** Account session URI.*/
 474 #define OC_RSRVD_ACCOUNT_SESSION_URI       "/oic/sec/session"
 475
 476 /** Account token refresh URI.*/
 477 #define OC_RSRVD_ACCOUNT_TOKEN_REFRESH_URI "/oic/sec/tokenrefresh"
 478
 479 /** ACL group URI.*/
 480 #define OC_RSRVD_ACL_GROUP_URI             "/oic/acl/group"
 481
 482 /** ACL invite URI.*/
 483 #define OC_RSRVD_ACL_INVITE_URI            "/oic/acl/invite"
 484
 485 /** Defines auth provider. */
 486 #define OC_RSRVD_AUTHPROVIDER              "authprovider"
 487
 488 /** Defines auth code. */
 489 #define OC_RSRVD_AUTHCODE                  "authcode"
 490
 491 /** Defines access token. */
 492 #define OC_RSRVD_ACCESS_TOKEN              "accesstoken"
 493
 494 /** Defines login. */
 495 #define OC_RSRVD_LOGIN                     "login"
 496
 497 /** Defines search. */
 498 #define OC_RSRVD_SEARCH                    "search"
 499
 500 /** Defines grant type. */
 501 #define OC_RSRVD_GRANT_TYPE                "granttype"
 502
 503 /** Defines refresh token. */
 504 #define OC_RSRVD_REFRESH_TOKEN             "refreshtoken"
 505
 506 /** Defines user UUID. */
 507 #define OC_RSRVD_USER_UUID                 "uid"
 508
 509 /** Defines group ID. */
 510 #define OC_RSRVD_GROUP_ID                  "gid"
 511
 512 /** Defines member of group ID. */
 513 #define OC_RSRVD_MEMBER_ID                 "mid"
 514
 515 /** Defines invite. */
 516 #define OC_RSRVD_INVITE                    "invite"
 517
 518 /** Defines accept. */
 519 #define OC_RSRVD_ACCEPT                    "accept"
 520
 521 /** Defines operation. */
 522 #define OC_RSRVD_OPERATION                 "op"
 523
 524 /** Defines add. */
 525 #define OC_RSRVD_ADD                       "add"
 526
 527 /** Defines delete. */
 528 #define OC_RSRVD_DELETE                    "delete"
 529
 530 /** Defines owner. */
 531 #define OC_RSRVD_OWNER                     "owner"
 532
 533 /** Defines members. */
 534 #define OC_RSRVD_MEMBERS                   "members"
 535
 536 /** To represent grant type with refresh token. */
 537 #define OC_RSRVD_GRANT_TYPE_REFRESH_TOKEN  "refresh_token"
 538
 539 /** Cloud CRL */
 540 #define OC_RSRVD_PROV_CRL_URL              "/oic/credprov/crl"
 541
 542 #define OC_RSRVD_LAST_UPDATE              "lu"
 543
 544 #define OC_RSRVD_THIS_UPDATE              "thisupdate"
 545
 546 #define OC_RSRVD_NEXT_UPDATE              "nu"
 547
 548 #define OC_RSRVD_SERIAL_NUMBERS           "rcsn"
 549
 550 #define OC_RSRVD_CRL                      "crldata"
 551
 552 #define OC_RSRVD_CRL_ID                   "crlid"
 553
 554 /** Cloud ACL */
 555 #define OC_RSRVD_GROUP_URL                "/oic/group"
 556
 557 #define OC_RSRVD_ACL_GROUP_URL            "/oic/acl/group"
 558
 559 #define OC_RSRVD_ACL_INVITE_URL           "/oic/acl/invite"
 560
 561 #define OC_RSRVD_ACL_VERIFY_URL           "/oic/acl/verify"
 562
 563 #define OC_RSRVD_ACL_ID_URL               "/oic/acl/id"
 564
 565 #define OC_RSRVD_MEMBER_ID                "mid"
 566
 567 #define OC_RSRVD_GROUP_ID                 "gid"
 568
 569 #define OC_RSRVD_OWNER_ID                 "oid"
 570
 571 #define OC_RSRVD_ACL_ID                   "aclid"
 572
 573 #define OC_RSRVD_ACE_ID                   "aceid"
 574
 575 #define OC_RSRVD_DEVICE_ID                "di"
 576
 577 #define OC_RSRVD_SUBJECT_ID               "sid"
 578
 579 #define OC_RSRVD_REQUEST_METHOD           "rm"
 580
 581 #define OC_RSRVD_REQUEST_URI              "uri"
 582
 583 #define OC_RSRVD_GROUP_MASTER_ID          "gmid"
 584
 585 #define OC_RSRVD_GROUP_TYPE               "gtype"
 586
 587 #define OC_RSRVD_SUBJECT_TYPE             "stype"
 588
 589 #define OC_RSRVD_GROUP_ID_LIST            "gidlist"
 590
 591 #define OC_RSRVD_MEMBER_ID_LIST           "midlist"
 592
 593 #define OC_RSRVD_DEVICE_ID_LIST           "dilist"
 594
 595 #define OC_RSRVD_ACCESS_CONTROL_LIST      "aclist"
 596
 597 #define OC_RSRVD_RESOURCES                "resources"
 598
 599 #define OC_RSRVD_VALIDITY                 "validity"
 600
 601 #define OC_RSRVD_PERIOD                   "period"
 602
 603 #define OC_RSRVD_RECURRENCE               "recurrence"
 604
 605 #define OC_RSRVD_INVITE                   "invite"
 606
 607 #define OC_RSRVD_INVITED                  "invited"
 608
 609 #define OC_RSRVD_ENCODING                 "encoding"
 610
 611 #define OC_OIC_SEC                        "oic.sec"
 612
 613 #define OC_RSRVD_BASE64                   "base64"
 614
 615 #define OC_RSRVD_DER                      "der"
 616
 617 #define OC_RSRVD_PEM                      "pem"
 618
 619 #define OC_RSRVD_RAW                      "raw"
 620
 621 #define OC_RSRVD_UNKNOWN                  "unknown"
 622
 623 #define OC_RSRVD_DATA                     "data"
 624
 625 #define OC_RSRVD_RESOURCE_OWNER_UUID      "rowneruuid"
 626
 627 #define OC_RSRVD_SUBJECT_UUID             "subjectuuid"
 628
 629 #define OC_RSRVD_PERMISSION_MASK          "permission"
 630
 631 #define OC_RSRVD_GROUP_PERMISSION         "gp"
 632
 633 #define OC_RSRVD_GROUP_ACL                "gacl"
 634
 635 /** Certificete Sign Request */
 636 #define OC_RSRVD_PROV_CERT_URI            "/oic/credprov/cert"
 637
 638 #define OC_RSRVD_CSR                      "csr"
 639
 640 #define OC_RSRVD_CERT                     "cert"
 641
 642 #define OC_RSRVD_CACERT                   "certchain"
 643
 644 #define OC_RSRVD_TOKEN_TYPE               "tokentype"
 645
 646 #define OC_RSRVD_EXPIRES_IN               "expiresin"
 647
 648 #define OC_RSRVD_REDIRECT_URI             "redirecturi"
 649
 650 #define OC_RSRVD_CERTIFICATE              "certificate"
 651
 652 /**
 653  * TODO: Move these COAP defines to CoAP lib once approved.
 654  */
 655 #define COAP_OPTION_ACCEPT_VERSION 2049
 656 #define COAP_OPTION_CONTENT_VERSION 2053
 657
 658 /**
 659  * These enums (OCTransportAdapter and OCTransportFlags) must
 660  * be kept synchronized with OCConnectivityType (below) as well as
 661  * CATransportAdapter and CATransportFlags (in CACommon.h).
 662  */
 663 typedef enum
 664 {
 665     /** value zero indicates discovery.*/
 666     OC_DEFAULT_ADAPTER = 0,
 667
 668     /** IPv4 and IPv6, including 6LoWPAN.*/
 669     OC_ADAPTER_IP           = (1 << 0),
 670
 671     /** GATT over Bluetooth LE.*/
 672     OC_ADAPTER_GATT_BTLE    = (1 << 1),
 673
 674     /** RFCOMM over Bluetooth EDR.*/
 675     OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
 676 #ifdef RA_ADAPTER
 677     /**Remote Access over XMPP.*/
 678     OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
 679 #endif
 680     /** CoAP over TCP.*/
 681     OC_ADAPTER_TCP           = (1 << 4),
 682
 683     /** NFC Transport for Messaging.*/
 684     OC_ADAPTER_NFC           = (1 << 5)
 685 } OCTransportAdapter;
 686
 687 typedef enum
 688 {
 689     /** default flag is 0.*/
 690     OC_DEFAULT_BT_FLAGS = 0,
 691     /** disable BLE advertisement.*/
 692     OC_LE_ADV_DISABLE   = 0x1,
 693     /** enable BLE advertisement.*/
 694     OC_LE_ADV_ENABLE    = 0x2,
 695     /** disable gatt server.*/
 696     OC_LE_SERVER_DISABLE = (1 << 4),
 697     /** disable rfcomm server.*/
 698     OC_EDR_SERVER_DISABLE = (1 << 7)
 699 } OCTransportBTFlags_t;
 700
 701 /**
 702  * Log level to print can be controlled through this enum.
 703  * And privacy logs contained uid, Token, Device id, etc can also disable.
 704  * This enum (OCLogLevel) must be kept synchronized with
 705  * CAUtilLogLevel_t (in CACommon.h).
 706  */
 707 typedef enum
 708 {
 709     OC_LOG_LEVEL_ALL = 1,             // all logs.
 710     OC_LOG_LEVEL_INFO,                // debug level is disabled.
 711 } OCLogLevel;
 712
 713 /**
 714  *  Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
 715  */
 716 typedef enum
 717 {
 718     /** default flag is 0*/
 719     OC_DEFAULT_FLAGS = 0,
 720
 721     /** Insecure transport is the default (subject to change).*/
 722     /** secure the transport path*/
 723     OC_FLAG_SECURE     = (1 << 4),
 724
 725     /** IPv4 & IPv6 auto-selection is the default.*/
 726     /** IP & TCP adapter only.*/
 727     OC_IP_USE_V6       = (1 << 5),
 728
 729     /** IP & TCP adapter only.*/
 730     OC_IP_USE_V4       = (1 << 6),
 731
 732     /** Multicast only.*/
 733     OC_MULTICAST       = (1 << 7),
 734
 735     /** Link-Local multicast is the default multicast scope for IPv6.
 736      *  These are placed here to correspond to the IPv6 multicast address bits.*/
 737
 738     /** IPv6 Interface-Local scope (loopback).*/
 739     OC_SCOPE_INTERFACE = 0x1,
 740
 741     /** IPv6 Link-Local scope (default).*/
 742     OC_SCOPE_LINK      = 0x2,
 743
 744     /** IPv6 Realm-Local scope. */
 745     OC_SCOPE_REALM     = 0x3,
 746
 747     /** IPv6 Admin-Local scope. */
 748     OC_SCOPE_ADMIN     = 0x4,
 749
 750     /** IPv6 Site-Local scope. */
 751     OC_SCOPE_SITE      = 0x5,
 752
 753     /** IPv6 Organization-Local scope. */
 754     OC_SCOPE_ORG       = 0x8,
 755
 756     /**IPv6 Global scope. */
 757     OC_SCOPE_GLOBAL    = 0xE,
 758
 759 } OCTransportFlags;
 760
 761 /** Bit mask for scope.*/
 762 #define OC_MASK_SCOPE    (0x000F)
 763
 764 /** Bit mask for Mods.*/
 765 #define OC_MASK_MODS     (0x0FF0)
 766 #define OC_MASK_FAMS     (OC_IP_USE_V6|OC_IP_USE_V4)
 767
 768 typedef struct OCStringLL
 769 {
 770     struct OCStringLL *next;
 771     char* value;
 772 } OCStringLL;
 773
 774 /**
 775  * End point identity.
 776  */
 777 typedef struct
 778 {
 779     /** Identity Length */
 780     uint16_t id_length;
 781
 782     /** Array of end point identity.*/
 783     unsigned char id[MAX_IDENTITY_SIZE];
 784 } OCIdentity;
 785
 786 /**
 787  * Universally unique identifier.
 788  */
 789 typedef struct
 790 {
 791     /** identitifier string.*/
 792     unsigned char id[UUID_IDENTITY_SIZE];
 793 } OCUUIdentity;
 794
 795 /**
 796  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
 797  * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
 798  */
 799 typedef struct
 800 {
 801     /** adapter type.*/
 802     OCTransportAdapter      adapter;
 803
 804     /** transport modifiers.*/
 805     OCTransportFlags        flags;
 806
 807     /** for IP.*/
 808     uint16_t                port;
 809
 810     /** address for all adapters.*/
 811     char                    addr[MAX_ADDR_STR_SIZE];
 812
 813     /** usually zero for default interface.*/
 814     uint32_t                ifindex;
 815
 816     /** destination GatewayID:ClientId.*/
 817     char                    routeData[MAX_ADDR_STR_SIZE];
 818
 819     /** device ID of remote.*/
 820     char                    remoteId[MAX_IDENTITY_SIZE];
 821
 822 } OCDevAddr;
 823
 824 /**
 825  * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
 826  * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
 827  * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
 828  * like Arduino.
 829  *
 830  * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
 831  */
 832 typedef enum
 833 {
 834     /** use when defaults are ok. */
 835     CT_DEFAULT = 0,
 836
 837     /** IPv4 and IPv6, including 6LoWPAN.*/
 838     CT_ADAPTER_IP           = (1 << 16),
 839
 840     /** GATT over Bluetooth LE.*/
 841     CT_ADAPTER_GATT_BTLE    = (1 << 17),
 842
 843     /** RFCOMM over Bluetooth EDR.*/
 844     CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
 845
 846 #ifdef RA_ADAPTER
 847     /** Remote Access over XMPP.*/
 848     CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
 849 #endif
 850     /** CoAP over TCP.*/
 851     CT_ADAPTER_TCP     = (1 << 20),
 852
 853     /** NFC Transport.*/
 854     CT_ADAPTER_NFC     = (1 << 21),
 855
 856     /** Insecure transport is the default (subject to change).*/
 857
 858     /** secure the transport path.*/
 859     CT_FLAG_SECURE     = (1 << 4),
 860
 861     /** IPv4 & IPv6 autoselection is the default.*/
 862
 863     /** IP adapter only.*/
 864     CT_IP_USE_V6       = (1 << 5),
 865
 866     /** IP adapter only.*/
 867     CT_IP_USE_V4       = (1 << 6),
 868
 869     /** Link-Local multicast is the default multicast scope for IPv6.
 870      * These are placed here to correspond to the IPv6 address bits.*/
 871
 872     /** IPv6 Interface-Local scope(loopback).*/
 873     CT_SCOPE_INTERFACE = 0x1,
 874
 875     /** IPv6 Link-Local scope (default).*/
 876     CT_SCOPE_LINK      = 0x2,
 877
 878     /** IPv6 Realm-Local scope.*/
 879     CT_SCOPE_REALM     = 0x3,
 880
 881     /** IPv6 Admin-Local scope.*/
 882     CT_SCOPE_ADMIN     = 0x4,
 883
 884     /** IPv6 Site-Local scope.*/
 885     CT_SCOPE_SITE      = 0x5,
 886
 887     /** IPv6 Organization-Local scope.*/
 888     CT_SCOPE_ORG       = 0x8,
 889
 890     /** IPv6 Global scope.*/
 891     CT_SCOPE_GLOBAL    = 0xE,
 892 } OCConnectivityType;
 893
 894 /** bit shift required for connectivity adapter.*/
 895 #define CT_ADAPTER_SHIFT 16
 896
 897 /** Mask Flag.*/
 898 #define CT_MASK_FLAGS 0xFFFF
 899
 900 /** Mask Adapter.*/
 901 #define CT_MASK_ADAPTER 0xFFFF0000
 902
 903 /**
 904  *  OCDoResource methods to dispatch the request
 905  */
 906 typedef enum
 907 {
 908     OC_REST_NOMETHOD       = 0,
 909
 910     /** Read.*/
 911     OC_REST_GET            = (1 << 0),
 912
 913     /** Write.*/
 914     OC_REST_PUT            = (1 << 1),
 915
 916     /** Update.*/
 917     OC_REST_POST           = (1 << 2),
 918
 919     /** Delete.*/
 920     OC_REST_DELETE         = (1 << 3),
 921
 922     /** Register observe request for most up date notifications ONLY.*/
 923     OC_REST_OBSERVE        = (1 << 4),
 924
 925     /** Register observe request for all notifications, including stale notifications.*/
 926     OC_REST_OBSERVE_ALL    = (1 << 5),
 927
 928 #ifdef WITH_PRESENCE
 929     /** Subscribe for all presence notifications of a particular resource.*/
 930     OC_REST_PRESENCE       = (1 << 7),
 931
 932 #endif
 933     /** Allows OCDoResource caller to do discovery.*/
 934     OC_REST_DISCOVER       = (1 << 8)
 935 } OCMethod;
 936
 937 /**
 938  *  Formats for payload encoding.
 939  */
 940 typedef enum
 941 {
 942     OC_FORMAT_CBOR,
 943     OC_FORMAT_VND_OCF_CBOR,
 944     OC_FORMAT_JSON,
 945     OC_FORMAT_UNDEFINED,
 946     OC_FORMAT_UNSUPPORTED,
 947 } OCPayloadFormat;
 948
 949 /**
 950  * Host Mode of Operation.
 951  */
 952 typedef enum
 953 {
 954     OC_CLIENT = 0,
 955     OC_SERVER,
 956     OC_CLIENT_SERVER,
 957     OC_GATEWAY          /**< Client server mode along with routing capabilities.*/
 958 } OCMode;
 959
 960 /**
 961  * Quality of Service attempts to abstract the guarantees provided by the underlying transport
 962  * protocol. The precise definitions of each quality of service level depend on the
 963  * implementation. In descriptions below are for the current implementation and may changed
 964  * over time.
 965  */
 966 typedef enum
 967 {
 968     /** Packet delivery is best effort.*/
 969     OC_LOW_QOS = 0,
 970
 971     /** Packet delivery is best effort.*/
 972     OC_MEDIUM_QOS,
 973
 974     /** Acknowledgments are used to confirm delivery.*/
 975     OC_HIGH_QOS,
 976
 977     /** No Quality is defined, let the stack decide.*/
 978     OC_NA_QOS
 979 } OCQualityOfService;
 980
 981 /**
 982  * Resource Properties.
 983  * The value of a policy property is defined as bitmap.
 984  * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
 985  * Not including the policy property is equivalent to zero.
 986  *
 987  */
 988 typedef enum
 989 {
 990     /** When none of the bits are set, the resource is non-secure, non-discoverable &
 991      *  non-observable by the client.*/
 992     OC_RES_PROP_NONE = (0),
 993
 994     /** When this bit is set, the resource is allowed to be discovered by clients.*/
 995     OC_DISCOVERABLE  = (1 << 0),
 996
 997     /** When this bit is set, the resource is allowed to be observed by clients.*/
 998     OC_OBSERVABLE    = (1 << 1),
 999
1000     /** When this bit is set, the resource is initialized, otherwise the resource
1001      *  is 'inactive'. 'inactive' signifies that the resource has been marked for
1002      *  deletion or is already deleted.*/
1003     OC_ACTIVE        = (1 << 2),
1004
1005     /** When this bit is set, the resource has been marked as 'slow'.
1006      * 'slow' signifies that responses from this resource can expect delays in
1007      *  processing its requests from clients.*/
1008     OC_SLOW          = (1 << 3),
1009
1010     /** When this bit is set, the resource supports access via non-secure endpoints. */
1011     OC_NONSECURE     = (1 << 6),
1012
1013 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1014     /** When this bit is set, the resource is a secure resource.*/
1015     OC_SECURE        = (1 << 4),
1016 #else
1017     OC_SECURE        = (0),
1018 #endif
1019
1020     /** When this bit is set, the resource is allowed to be discovered only
1021      *  if discovery request contains an explicit querystring.
1022      *  Ex: GET /oic/res?rt=oic.sec.acl */
1023     OC_EXPLICIT_DISCOVERABLE   = (1 << 5)
1024
1025 #ifdef WITH_MQ
1026     /** When this bit is set, the resource is allowed to be published */
1027     // @todo
1028     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1029     ,OC_MQ_PUBLISHER     = (0)
1030 #endif
1031
1032 #ifdef MQ_BROKER
1033     /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
1034     // @todo
1035     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1036     ,OC_MQ_BROKER        = (0)
1037 #endif
1038 } OCResourceProperty;
1039
1040 #define OC_MASK_RESOURCE_SECURE    (OC_NONSECURE | OC_SECURE)
1041
1042 /**
1043  * Transport Protocol IDs.
1044  */
1045 typedef enum
1046 {
1047     /** For invalid ID.*/
1048     OC_INVALID_ID   = (1 << 0),
1049
1050     /* For coap ID.*/
1051     OC_COAP_ID      = (1 << 1)
1052 } OCTransportProtocolID;
1053
1054 /**
1055  * Declares Stack Results & Errors.
1056  */
1057 typedef enum
1058 {
1059     /** Success status code - START HERE.*/
1060     OC_STACK_OK = 0,                /** 203, 205*/
1061     OC_STACK_RESOURCE_CREATED,      /** 201*/
1062     OC_STACK_RESOURCE_DELETED,      /** 202*/
1063     OC_STACK_CONTINUE,
1064     OC_STACK_RESOURCE_CHANGED,      /** 204*/
1065     /** Success status code - END HERE.*/
1066
1067     /** Error status code - START HERE.*/
1068     OC_STACK_INVALID_URI = 20,
1069     OC_STACK_INVALID_QUERY,         /** 400*/
1070     OC_STACK_INVALID_IP,
1071     OC_STACK_INVALID_PORT,
1072     OC_STACK_INVALID_CALLBACK,
1073     OC_STACK_INVALID_METHOD,        /** 405 */
1074
1075     /** Invalid parameter.*/
1076     OC_STACK_INVALID_PARAM,
1077     OC_STACK_INVALID_OBSERVE_PARAM,
1078     OC_STACK_NO_MEMORY,
1079     OC_STACK_COMM_ERROR,            /** 504*/
1080     OC_STACK_TIMEOUT,
1081     OC_STACK_ADAPTER_NOT_ENABLED,
1082     OC_STACK_NOTIMPL,
1083
1084     /** Resource not found.*/
1085     OC_STACK_NO_RESOURCE,           /** 404*/
1086
1087     /** e.g: not supported method or interface.*/
1088     OC_STACK_RESOURCE_ERROR,
1089     OC_STACK_SLOW_RESOURCE,
1090     OC_STACK_DUPLICATE_REQUEST,
1091
1092     /** Resource has no registered observers.*/
1093     OC_STACK_NO_OBSERVERS,
1094     OC_STACK_OBSERVER_NOT_FOUND,
1095     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
1096     OC_STACK_INVALID_OPTION,        /** 402*/
1097
1098     /** The remote reply contained malformed data.*/
1099     OC_STACK_MALFORMED_RESPONSE,
1100     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
1101     OC_STACK_INVALID_REQUEST_HANDLE,
1102     OC_STACK_INVALID_DEVICE_INFO,
1103     OC_STACK_INVALID_JSON,
1104
1105     /** Request is not authorized by Resource Server. */
1106     OC_STACK_UNAUTHORIZED_REQ,      /** 401*/
1107     OC_STACK_TOO_LARGE_REQ,         /** 413*/
1108
1109     /** Error code from PDM */
1110     OC_STACK_PDM_IS_NOT_INITIALIZED,
1111     OC_STACK_DUPLICATE_UUID,
1112     OC_STACK_INCONSISTENT_DB,
1113
1114     /**
1115      * Error code from OTM
1116      * This error is pushed from DTLS interface when handshake failure happens
1117      */
1118     OC_STACK_AUTHENTICATION_FAILURE,
1119     OC_STACK_NOT_ALLOWED_OXM,
1120     OC_STACK_CONTINUE_OPERATION,
1121
1122     /** Request come from endpoint which is not mapped to the resource. */
1123     OC_STACK_BAD_ENDPOINT,
1124
1125     /** Insert all new error codes here!.*/
1126 #ifdef WITH_PRESENCE
1127     OC_STACK_PRESENCE_STOPPED = 128,
1128     OC_STACK_PRESENCE_TIMEOUT,
1129     OC_STACK_PRESENCE_DO_NOT_HANDLE,
1130 #endif
1131
1132     /** Request is denied by the user*/
1133     OC_STACK_USER_DENIED_REQ,
1134     OC_STACK_NOT_ACCEPTABLE,         /** 406 */
1135
1136     /** ERROR code from server */
1137     OC_STACK_FORBIDDEN_REQ,          /** 403*/
1138     OC_STACK_INTERNAL_SERVER_ERROR,  /** 500*/
1139     OC_STACK_GATEWAY_TIMEOUT,        /** 504*/
1140     OC_STACK_SERVICE_UNAVAILABLE,    /** 503*/
1141
1142     /** ERROR in stack.*/
1143     OC_STACK_ERROR = 255
1144     /** Error status code - END HERE.*/
1145 } OCStackResult;
1146
1147 /**
1148  * Handle to an OCDoResource invocation.
1149  */
1150 typedef void * OCDoHandle;
1151
1152 /**
1153  * Handle to an OCResource object owned by the OCStack.
1154  */
1155 typedef void * OCResourceHandle;
1156
1157 /**
1158  * Handle to an OCRequest object owned by the OCStack.
1159  */
1160 typedef void * OCRequestHandle;
1161
1162 /**
1163  * Unique identifier for each observation request. Used when observations are
1164  * registered or de-registered. Used by entity handler to signal specific
1165  * observers to be notified of resource changes.
1166  * There can be maximum of 256 observations per server.
1167  */
1168 typedef uint8_t OCObservationId;
1169
1170 /**
1171  * Sequence number is a 24 bit field,
1172  * per https://tools.ietf.org/html/rfc7641.
1173  */
1174 #define MAX_SEQUENCE_NUMBER              (0xFFFFFF)
1175
1176 /**
1177  * Action associated with observation.
1178  */
1179 typedef enum
1180 {
1181     /** To Register. */
1182     OC_OBSERVE_REGISTER = 0,
1183
1184     /** To Deregister. */
1185     OC_OBSERVE_DEREGISTER = 1,
1186
1187     /** Others. */
1188     OC_OBSERVE_NO_OPTION = 2,
1189
1190 } OCObserveAction;
1191
1192
1193 /**
1194  * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
1195  * when it calls OCRegisterPersistentStorageHandler.
1196  * Persistent storage open handler points to default file path.
1197  * It should check file path and whether the file is symbolic link or no.
1198  * Application can point to appropriate SVR database path for it's IoTivity Server.
1199  */
1200 typedef struct {
1201     /** Persistent storage file path.*/
1202     FILE* (* open)(const char *path, const char *mode);
1203
1204     /** Persistent storage read handler.*/
1205     size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
1206
1207     /** Persistent storage write handler.*/
1208     size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
1209
1210     /** Persistent storage close handler.*/
1211     int (* close)(FILE *fp);
1212
1213     /** Persistent storage unlink handler.*/
1214     int (* unlink)(const char *path);
1215 } OCPersistentStorage;
1216
1217 /**
1218  * Possible returned values from entity handler.
1219  */
1220 typedef struct
1221 {
1222     /** Action associated with observation request.*/
1223     OCObserveAction action;
1224
1225     /** Identifier for observation being registered/deregistered.*/
1226     OCObservationId obsId;
1227 } OCObservationInfo;
1228
1229 /**
1230  * Possible returned values from entity handler.
1231  */
1232 typedef enum
1233 {
1234     OC_EH_OK = 0,
1235     OC_EH_ERROR,
1236     OC_EH_SLOW,
1237     OC_EH_RESOURCE_CREATED = 201,
1238     OC_EH_RESOURCE_DELETED = 202,
1239     OC_EH_VALID = 203,
1240     OC_EH_CHANGED = 204,
1241     OC_EH_CONTENT = 205,
1242     OC_EH_BAD_REQ = 400,
1243     OC_EH_UNAUTHORIZED_REQ = 401,
1244     OC_EH_BAD_OPT = 402,
1245     OC_EH_FORBIDDEN = 403,
1246     OC_EH_RESOURCE_NOT_FOUND = 404,
1247     OC_EH_METHOD_NOT_ALLOWED = 405,
1248     OC_EH_NOT_ACCEPTABLE = 406,
1249     OC_EH_TOO_LARGE = 413,
1250     OC_EH_UNSUPPORTED_MEDIA_TYPE = 415,
1251     OC_EH_INTERNAL_SERVER_ERROR = 500,
1252     OC_EH_BAD_GATEWAY = 502,
1253     OC_EH_SERVICE_UNAVAILABLE = 503,
1254     OC_EH_RETRANSMIT_TIMEOUT = 504
1255 } OCEntityHandlerResult;
1256
1257 /**
1258  * This structure will be used to define the vendor specific header options to be included
1259  * in communication packets.
1260  */
1261 typedef struct OCHeaderOption
1262 {
1263     /** The protocol ID this option applies to.*/
1264     OCTransportProtocolID protocolID;
1265
1266     /** The header option ID which will be added to communication packets.*/
1267     uint16_t optionID;
1268
1269     /** its length 191.*/
1270     uint16_t optionLength;
1271
1272     /** pointer to its data.*/
1273     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
1274
1275 #ifdef __cplusplus
1276     OCHeaderOption() = default;
1277     OCHeaderOption(OCTransportProtocolID pid,
1278                    uint16_t optId,
1279                    uint16_t optlen,
1280                    const uint8_t* optData)
1281         : protocolID(pid),
1282           optionID(optId),
1283           optionLength(optlen)
1284     {
1285
1286         // parameter includes the null terminator.
1287         optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
1288                         optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
1289         memcpy(optionData, optData, optionLength);
1290         optionData[optionLength - 1] = '\0';
1291     }
1292 #endif // __cplusplus
1293 } OCHeaderOption;
1294
1295 /**
1296  * This structure describes the platform properties. All non-Null properties will be
1297  * included in a platform discovery request.
1298  * @deprecated: Use OCSetPropertyValue  to set platform value.
1299  */
1300 typedef struct
1301 {
1302     /** Platform ID.*/
1303     char *platformID;
1304
1305     /** Manufacturer name.*/
1306     char *manufacturerName;
1307
1308     /** Manufacturer URL for platform property.*/
1309     char *manufacturerUrl;
1310
1311     /** Model number.*/
1312     char *modelNumber;
1313
1314     /** Manufacturer date.*/
1315     char *dateOfManufacture;
1316
1317     /** Platform version.*/
1318     char *platformVersion;
1319
1320     /** Operating system version.*/
1321     char *operatingSystemVersion;
1322
1323     /** HW version.*/
1324     char *hardwareVersion;
1325
1326     /** FW version.*/
1327     char *firmwareVersion;
1328
1329     /** Platform support URL.*/
1330     char *supportUrl;
1331
1332     /** System time.*/
1333     char *systemTime;
1334
1335 } OCPlatformInfo;
1336
1337 /**
1338  * This structure is expected as input for device properties.
1339  * device name is mandatory and expected from the application.
1340  * device id of type UUID will be generated by the stack.
1341  * @deprecated: Use OCSetPropertyValue  to set device value.
1342  */
1343 typedef struct
1344 {
1345     /** Pointer to the device name.*/
1346     char *deviceName;
1347     /** Pointer to the types.*/
1348     OCStringLL *types;
1349     /** Pointer to the device specification version.*/
1350     char *specVersion;
1351     /** Pointer to the device data model versions (in CSV format).*/
1352     OCStringLL *dataModelVersions;
1353 } OCDeviceInfo;
1354
1355 /**
1356  *  This enum type for indicate Transport Protocol Suites
1357  */
1358 typedef enum
1359 {
1360     /** For initialize */
1361     OC_NO_TPS         = 0,
1362
1363     /** coap + udp */
1364     OC_COAP           = 1,
1365
1366     /** coaps + udp */
1367     OC_COAPS          = (1 << 1),
1368
1369 #ifdef TCP_ADAPTER
1370     /** coap + tcp */
1371     OC_COAP_TCP       = (1 << 2),
1372
1373     /** coaps + tcp */
1374     OC_COAPS_TCP      = (1 << 3),
1375 #endif
1376 #ifdef HTTP_ADAPTER
1377     /** http + tcp */
1378     OC_HTTP           = (1 << 4),
1379
1380     /** https + tcp */
1381     OC_HTTPS          = (1 << 5),
1382 #endif
1383 #ifdef EDR_ADAPTER
1384     /** coap + rfcomm */
1385     OC_COAP_RFCOMM    = (1 << 6),
1386 #endif
1387 #ifdef LE_ADAPTER
1388     /** coap + gatt */
1389     OC_COAP_GATT      = (1 << 7),
1390 #endif
1391 #ifdef NFC_ADAPTER
1392     /** coap + nfc */
1393     OC_COAP_NFC       = (1 << 8),
1394 #endif
1395 #ifdef RA_ADAPTER
1396     /** coap + remote_access */
1397     OC_COAP_RA        = (1 << 9),
1398 #endif
1399     /** Allow all endpoint.*/
1400     OC_ALL       = 0xffff
1401 } OCTpsSchemeFlags;
1402
1403 #ifdef RA_ADAPTER
1404 /**
1405  * callback for bound JID
1406  */
1407 typedef void (*jid_bound_cb)(char *jid);
1408
1409 /**
1410  * CA Remote Access information for XMPP Client
1411  *
1412  */
1413 typedef struct
1414 {
1415     char *hostname;     /**< XMPP server hostname */
1416     uint16_t   port;    /**< XMPP server serivce port */
1417     char *xmpp_domain;  /**< XMPP login domain */
1418     char *username;     /**< login username */
1419     char *password;     /**< login password */
1420     char *resource;     /**< specific resource for login */
1421     char *user_jid;     /**< specific JID for login */
1422     jid_bound_cb jidbound;  /**< callback when JID bound */
1423 } OCRAInfo_t;
1424 #endif  /* RA_ADAPTER */
1425
1426
1427 /** Enum to describe the type of object held by the OCPayload object.*/
1428 typedef enum
1429 {
1430     /** Contents of the payload are invalid */
1431     PAYLOAD_TYPE_INVALID,
1432     /** The payload is an OCDiscoveryPayload */
1433     PAYLOAD_TYPE_DISCOVERY,
1434     /** The payload of the device */
1435     PAYLOAD_TYPE_DEVICE,
1436     /** The payload type of the platform */
1437     PAYLOAD_TYPE_PLATFORM,
1438     /** The payload is an OCRepPayload */
1439     PAYLOAD_TYPE_REPRESENTATION,
1440     /** The payload is an OCSecurityPayload */
1441     PAYLOAD_TYPE_SECURITY,
1442     /** The payload is an OCPresencePayload */
1443     PAYLOAD_TYPE_PRESENCE,
1444     /** The payload is an OCDiagnosticPayload */
1445     PAYLOAD_TYPE_DIAGNOSTIC,
1446     /** The payload is an OCIntrospectionPayload */
1447     PAYLOAD_TYPE_INTROSPECTION
1448 } OCPayloadType;
1449
1450 /**
1451  * A generic struct representing a payload returned from a resource operation
1452  *
1453  * A pointer to OCPayLoad can be cast to a more specific struct to access members
1454  * for the its type.
1455  */
1456 typedef struct
1457 {
1458     /** The type of message that was received */
1459     OCPayloadType type;
1460 } OCPayload;
1461
1462 typedef enum
1463 {
1464     OCREP_PROP_NULL,
1465     OCREP_PROP_INT,
1466     OCREP_PROP_DOUBLE,
1467     OCREP_PROP_BOOL,
1468     OCREP_PROP_STRING,
1469     OCREP_PROP_BYTE_STRING,
1470     OCREP_PROP_OBJECT,
1471     OCREP_PROP_ARRAY
1472 }OCRepPayloadPropType;
1473
1474 /** This structure will be used to represent a binary string for CBOR payloads.*/
1475 typedef struct
1476 {
1477     /** pointer to data bytes.*/
1478     uint8_t* bytes;
1479
1480     /** number of data bytes.*/
1481     size_t   len;
1482 } OCByteString;
1483
1484 #define MAX_REP_ARRAY_DEPTH 3
1485 typedef struct
1486 {
1487     OCRepPayloadPropType type;
1488     size_t dimensions[MAX_REP_ARRAY_DEPTH];
1489
1490     union
1491     {
1492         int64_t* iArray;
1493         double* dArray;
1494         bool* bArray;
1495         char** strArray;
1496
1497         /** pointer to ByteString array.*/
1498         OCByteString* ocByteStrArray;
1499
1500         struct OCRepPayload** objArray;
1501     };
1502 } OCRepPayloadValueArray;
1503
1504 typedef struct OCRepPayloadValue
1505 {
1506     char* name;
1507     OCRepPayloadPropType type;
1508     union
1509     {
1510         int64_t i;
1511         double d;
1512         bool b;
1513         char* str;
1514
1515         /** ByteString object.*/
1516         OCByteString ocByteStr;
1517
1518         struct OCRepPayload* obj;
1519         OCRepPayloadValueArray arr;
1520     };
1521     struct OCRepPayloadValue* next;
1522
1523 } OCRepPayloadValue;
1524
1525 // used for get/set/put/observe/etc representations
1526 typedef struct OCRepPayload
1527 {
1528     OCPayload base;
1529     char* uri;
1530     OCStringLL* types;
1531     OCStringLL* interfaces;
1532     OCRepPayloadValue* values;
1533     struct OCRepPayload* next;
1534 } OCRepPayload;
1535
1536 // used inside a resource payload
1537 typedef struct OCEndpointPayload
1538 {
1539     char* tps;
1540     char* addr;
1541     OCTransportFlags family;
1542     uint16_t port;
1543     uint16_t pri;
1544     struct OCEndpointPayload* next;
1545 } OCEndpointPayload;
1546
1547 // used inside a discovery payload
1548 typedef struct OCResourcePayload
1549 {
1550     char* uri;
1551     char* rel;
1552     char* anchor;
1553     OCStringLL* types;
1554     OCStringLL* interfaces;
1555     uint8_t bitmap;
1556     bool secure;
1557     uint16_t port;
1558 #ifdef TCP_ADAPTER
1559     uint16_t tcpPort;
1560 #endif
1561     struct OCResourcePayload* next;
1562     OCEndpointPayload* eps;
1563 } OCResourcePayload;
1564
1565 typedef struct OCDiscoveryPayload
1566 {
1567     OCPayload base;
1568
1569     /** Device Id */
1570     char *sid;
1571
1572     /** Name */
1573     char *name;
1574
1575     /** Resource Type */
1576     OCStringLL *type;
1577
1578     /** Interface */
1579     OCStringLL *iface;
1580
1581     /** This structure holds the old /oic/res response. */
1582     OCResourcePayload *resources;
1583
1584     /** Holding address of the next DiscoveryPayload. */
1585     struct OCDiscoveryPayload *next;
1586
1587 } OCDiscoveryPayload;
1588
1589 typedef struct
1590 {
1591     OCPayload base;
1592     uint8_t* securityData;
1593     size_t payloadSize;
1594 } OCSecurityPayload;
1595
1596 #ifdef WITH_PRESENCE
1597 typedef struct
1598 {
1599     OCPayload base;
1600     uint32_t sequenceNumber;
1601     uint32_t maxAge;
1602     OCPresenceTrigger trigger;
1603     char* resourceType;
1604 } OCPresencePayload;
1605 #endif
1606
1607 typedef struct
1608 {
1609     OCPayload base;
1610     char* message;
1611 } OCDiagnosticPayload;
1612
1613 typedef struct
1614 {
1615     OCPayload base;
1616     OCByteString cborPayload;
1617 } OCIntrospectionPayload;
1618
1619 /**
1620  * Incoming requests handled by the server. Requests are passed in as a parameter to the
1621  * OCEntityHandler callback API.
1622  * The OCEntityHandler callback API must be implemented in the application in order
1623  * to receive these requests.
1624  */
1625 typedef struct
1626 {
1627     /** Associated resource.*/
1628     OCResourceHandle resource;
1629
1630     /** Associated request handle.*/
1631     OCRequestHandle requestHandle;
1632
1633     /** the REST method retrieved from received request PDU.*/
1634     OCMethod method;
1635
1636     /** description of endpoint that sent the request.*/
1637     OCDevAddr devAddr;
1638
1639     /** resource query send by client.*/
1640     char * query;
1641
1642     /** Information associated with observation - valid only when OCEntityHandler flag includes
1643      * ::OC_OBSERVE_FLAG.*/
1644     OCObservationInfo obsInfo;
1645
1646     /** Number of the received vendor specific header options.*/
1647     uint8_t numRcvdVendorSpecificHeaderOptions;
1648
1649     /** Pointer to the array of the received vendor specific header options.*/
1650     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1651
1652     /** Message id.*/
1653     uint16_t messageID;
1654
1655     /** the payload from the request PDU.*/
1656     OCPayload *payload;
1657
1658 } OCEntityHandlerRequest;
1659
1660
1661 /**
1662  * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1663  */
1664 typedef struct
1665 {
1666     /** Address of remote server.*/
1667     OCDevAddr devAddr;
1668
1669     /** backward compatibility (points to devAddr).*/
1670     OCDevAddr *addr;
1671
1672     /** backward compatibility.*/
1673     OCConnectivityType connType;
1674
1675     /** the security identity of the remote server.*/
1676     OCIdentity identity;
1677
1678     /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1679     OCStackResult result;
1680
1681     /** If associated with observe, this will represent the sequence of notifications from server.*/
1682     uint32_t sequenceNumber;
1683
1684     /** resourceURI.*/
1685     const char * resourceUri;
1686
1687     /** the payload for the response PDU.*/
1688     OCPayload *payload;
1689
1690     /** Number of the received vendor specific header options.*/
1691     uint8_t numRcvdVendorSpecificHeaderOptions;
1692
1693     /** An array of the received vendor specific header options.*/
1694     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1695 } OCClientResponse;
1696
1697 /**
1698  * Request handle is passed to server via the entity handler for each incoming request.
1699  * Stack assigns when request is received, server sets to indicate what request response is for.
1700  */
1701 typedef struct
1702 {
1703     /** Request handle.*/
1704     OCRequestHandle requestHandle;
1705
1706     /** Resource handle. (@deprecated: This parameter is not used.) */
1707     OCResourceHandle resourceHandle;
1708
1709     /** Allow the entity handler to pass a result with the response.*/
1710     OCEntityHandlerResult  ehResult;
1711
1712     /** This is the pointer to server payload data to be transferred.*/
1713     OCPayload* payload;
1714
1715     /** number of the vendor specific header options .*/
1716     uint8_t numSendVendorSpecificHeaderOptions;
1717
1718     /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1719     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1720
1721     /** Resource path of new resource that entity handler might create.*/
1722     char resourceUri[MAX_URI_LENGTH];
1723
1724     /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1725     uint8_t persistentBufferFlag;
1726 } OCEntityHandlerResponse;
1727
1728 /**
1729  * Entity's state
1730  */
1731 typedef enum
1732 {
1733     /** Request state.*/
1734     OC_REQUEST_FLAG = (1 << 1),
1735     /** Observe state.*/
1736     OC_OBSERVE_FLAG = (1 << 2)
1737 } OCEntityHandlerFlag;
1738
1739 /**
1740  * Possible return values from client application callback
1741  *
1742  * A client application callback returns an OCStackApplicationResult to indicate whether
1743  * the stack should continue to keep the callback registered.
1744  */
1745 typedef enum
1746 {
1747     /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1748     OC_STACK_DELETE_TRANSACTION = 0,
1749     /** Keep this callback registered and call it if an apropriate event occurs */
1750     OC_STACK_KEEP_TRANSACTION
1751 } OCStackApplicationResult;
1752
1753
1754 //#ifdef DIRECT_PAIRING
1755 /**
1756  * @brief   direct pairing Method Type.
1757  *              0:  not allowed
1758  *              1:  pre-configured pin
1759  *              2:  random pin
1760  */
1761 typedef enum OCPrm
1762 {
1763     DP_NOT_ALLOWED             = 0x0,
1764     DP_PRE_CONFIGURED        = (0x1 << 0),
1765     DP_RANDOM_PIN               = (0x1 << 1),
1766 } OCPrm_t;
1767
1768 /**
1769  * Device Information of discoverd direct pairing device(s).
1770  */
1771 typedef struct OCDPDev
1772 {
1773     OCDevAddr               endpoint;
1774     OCConnectivityType   connType;
1775     uint16_t                     securePort;
1776     bool                  edp;
1777     OCPrm_t           *prm;
1778     size_t                prmLen;
1779     OCUUIdentity     deviceID;
1780     OCUUIdentity     rowner;
1781     struct OCDPDev *next;
1782 } OCDPDev_t;
1783 //#endif // DIRECT_PAIRING
1784
1785 /*
1786  * -------------------------------------------------------------------------------------------
1787  * Callback function definitions
1788  * -------------------------------------------------------------------------------------------
1789  */
1790
1791 /**
1792  * Client applications implement this callback to consume responses received from Servers.
1793  */
1794 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1795     OCClientResponse * clientResponse);
1796
1797 /**
1798  * Client applications using a context pointer implement this callback to delete the
1799  * context upon removal of the callback/context pointer from the internal callback-list.
1800  */
1801 typedef void (* OCClientContextDeleter)(void *context);
1802
1803 /**
1804  * This info is passed from application to OC Stack when initiating a request to Server.
1805  */
1806 typedef struct OCCallbackData
1807 {
1808     /** Pointer to the context.*/
1809     void *context;
1810
1811     /** The pointer to a function the stack will call to handle the requests.*/
1812     OCClientResponseHandler cb;
1813
1814     /** A pointer to a function to delete the context when this callback is removed.*/
1815     OCClientContextDeleter cd;
1816
1817 #ifdef __cplusplus
1818     OCCallbackData() = default;
1819     OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1820         :context(ctx), cb(callback), cd(deleter){}
1821 #endif // __cplusplus
1822 } OCCallbackData;
1823
1824 /**
1825  * Application server implementations must implement this callback to consume requests OTA.
1826  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1827  *
1828  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1829  * OC_EH_SLOW and etc in entity handler callback,
1830  * ocstack will be not send response automatically to client
1831  * except for error return value like OC_EH_ERROR.
1832  *
1833  * If you want to send response to client with specific result,
1834  * OCDoResponse API should be called with the result value.
1835  *
1836  * e.g)
1837  *
1838  * OCEntityHandlerResponse response;
1839  *
1840  * ..
1841  *
1842  * response.ehResult = OC_EH_CHANGED;
1843  *
1844  * ..
1845  *
1846  * OCDoResponse(&response)
1847  *
1848  * ..
1849  *
1850  * return OC_EH_OK;
1851  */
1852 typedef OCEntityHandlerResult (*OCEntityHandler)
1853 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1854
1855 /**
1856  * Device Entity handler need to use this call back instead of OCEntityHandler.
1857  *
1858  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1859  * OC_EH_SLOW and etc in entity handler callback,
1860  * ocstack will be not send response automatically to client
1861  * except for error return value like OC_EH_ERROR.
1862  *
1863  * If you want to send response to client with specific result,
1864  * OCDoResponse API should be called with the result value.
1865  *
1866  * e.g)
1867  *
1868  * OCEntityHandlerResponse response;
1869  *
1870  * ..
1871  *
1872  * response.ehResult = OC_EH_CHANGED;
1873  *
1874  * ..
1875  *
1876  * OCDoResponse(&response)
1877  *
1878  * ..
1879  *
1880  * return OC_EH_OK;
1881  */
1882 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1883 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1884
1885 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1886 /**
1887  * Callback function definition for Change in TrustCertChain
1888  *
1889  * @param[in] ctx - user context returned in the callback.
1890  * @param[in] credId - trustCertChain changed for this ID
1891  * @param[in] trustCertChain - trustcertchain binary blob.
1892  * @param[in] chainSize - size of trustchain
1893  */
1894 typedef void (*TrustCertChainChangeCB)(void *ctx, uint16_t credId, uint8_t *trustCertChain,
1895         size_t chainSize);
1896
1897 /**
1898  * certChain context structure.
1899  */
1900 typedef struct trustCertChainContext
1901 {
1902     TrustCertChainChangeCB callback;
1903     void *context;
1904 } trustCertChainContext_t;
1905 #endif
1906
1907 #if defined(TCP_ADAPTER) && defined(WITH_CLOUD)
1908 /**
1909  * User Preference of connectivity channel
1910  */
1911 typedef enum
1912 {
1913     /** Cloud TCP */
1914     OC_USER_PREF_CLOUD = 0,
1915     /** local UDP */
1916     OC_USER_PREF_LOCAL_UDP = 1,
1917     /** local TCP */
1918     OC_USER_PREF_LOCAL_TCP =2
1919 } OCConnectUserPref_t;
1920
1921 #endif
1922
1923 #ifdef __cplusplus
1924 }
1925 #endif // __cplusplus
1926
1927 #endif /* OCTYPES_H_ */