1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //******************************************************************
25 * This file contains the definition, types and APIs for resource(s) be implemented.
31 #include "iotivity_config.h"
32 #include "ocstackconfig.h"
42 #include "ocpresence.h"
44 // TODO : need for secure psi
45 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
46 #define __SECURE_PSI__
49 //-----------------------------------------------------------------------------
51 //-----------------------------------------------------------------------------
53 #define IOTIVITY_VERSION "1.2.1"
56 * OIC Virtual resources supported by every OIC device.
59 * Default discovery mechanism using '/oic/res' is supported by all OIC devices
60 * That are Discoverable.
62 #define OC_RSRVD_WELL_KNOWN_URI "/oic/res"
65 #define OC_RSRVD_DEVICE_URI "/oic/d"
68 #define OC_RSRVD_PLATFORM_URI "/oic/p"
71 #define OC_RSRVD_RESOURCE_TYPES_URI "/oic/res/types/d"
74 #define OC_RSRVD_GATEWAY_URI "/oic/gateway"
77 #define OC_RSRVD_WELL_KNOWN_MQ_URI "/oic/ps"
80 #define OC_RSRVD_KEEPALIVE_URI "/oic/ping"
82 /** Presence URI through which the OIC devices advertise their presence.*/
83 #define OC_RSRVD_PRESENCE_URI "/oic/ad"
85 /** Presence URI through which the OIC devices advertise their device presence.*/
86 #define OC_RSRVD_DEVICE_PRESENCE_URI "/oic/prs"
88 /** For multicast Discovery mechanism.*/
89 #define OC_MULTICAST_DISCOVERY_URI "/oic/res"
91 /** Separator for multiple query string.*/
92 #define OC_QUERY_SEPARATOR "&;"
95 * OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
97 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
100 * OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
101 * NOTE: Changing the setting to a longer duration may lead to unsupported and untested
103 * 60 sec/min * 60 min/hr * 24 hr/day
105 #define OC_MAX_PRESENCE_TTL_SECONDS (60 * 60 * 24)
109 * Presence "Announcement Triggers".
113 #define OC_RSRVD_TRIGGER_CREATE "create"
116 #define OC_RSRVD_TRIGGER_CHANGE "change"
119 #define OC_RSRVD_TRIGGER_DELETE "delete"
122 * Attributes used to form a proper OIC conforming JSON message.
125 #define OC_RSRVD_OC "oic"
130 #define OC_RSRVD_PAYLOAD "payload"
132 /** To represent href */
133 #define OC_RSRVD_HREF "href"
135 /** To represent property*/
136 #define OC_RSRVD_PROPERTY "prop"
138 /** For representation.*/
139 #define OC_RSRVD_REPRESENTATION "rep"
141 /** To represent content type.*/
142 #define OC_RSRVD_CONTENT_TYPE "ct"
144 /** To represent resource type.*/
145 #define OC_RSRVD_RESOURCE_TYPE "rt"
147 /** To represent resource type with presence.*/
148 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
150 /** To represent resource type with device.*/
151 #define OC_RSRVD_RESOURCE_TYPE_DEVICE "oic.wk.d"
153 /** To represent resource type with platform.*/
154 #define OC_RSRVD_RESOURCE_TYPE_PLATFORM "oic.wk.p"
156 /** To represent resource type with collection.*/
157 #define OC_RSRVD_RESOURCE_TYPE_COLLECTION "oic.wk.col"
159 /** To represent resource type with RES.*/
160 #define OC_RSRVD_RESOURCE_TYPE_RES "oic.wk.res"
162 /** To represent content type with MQ Broker.*/
163 #define OC_RSRVD_RESOURCE_TYPE_MQ_BROKER "oic.wk.ps"
165 /** To represent content type with MQ Topic.*/
166 #define OC_RSRVD_RESOURCE_TYPE_MQ_TOPIC "oic.wk.ps.topic"
169 /** To represent interface.*/
170 #define OC_RSRVD_INTERFACE "if"
172 /** To indicate how long RD should publish this item.*/
173 #define OC_RSRVD_DEVICE_TTL "lt"
175 /** To represent time to live.*/
176 #define OC_RSRVD_TTL "ttl"
178 /** To represent non*/
179 #define OC_RSRVD_NONCE "non"
181 /** To represent trigger type.*/
182 #define OC_RSRVD_TRIGGER "trg"
184 /** To represent links.*/
185 #define OC_RSRVD_LINKS "links"
187 /** To represent default interface.*/
188 #define OC_RSRVD_INTERFACE_DEFAULT "oic.if.baseline"
190 /** To represent read-only interface.*/
191 #define OC_RSRVD_INTERFACE_READ "oic.if.r"
193 /** To represent ll interface.*/
194 #define OC_RSRVD_INTERFACE_LL "oic.if.ll"
196 /** To represent batch interface.*/
197 #define OC_RSRVD_INTERFACE_BATCH "oic.if.b"
199 /** To represent interface group.*/
200 #define OC_RSRVD_INTERFACE_GROUP "oic.mi.grp"
202 /** To represent MFG date.*/
203 #define OC_RSRVD_MFG_DATE "mndt"
205 /** To represent FW version.*/
206 #define OC_RSRVD_FW_VERSION "mnfv"
208 /** To represent host name.*/
209 #define OC_RSRVD_HOST_NAME "hn"
211 /** To represent policy.*/
212 #define OC_RSRVD_POLICY "p"
214 /** To represent bitmap.*/
215 #define OC_RSRVD_BITMAP "bm"
218 #define OC_RSRVD_SECURE "sec"
221 #define OC_RSRVD_HOSTING_PORT "port"
224 #define OC_RSRVD_TCP_PORT "x.org.iotivity.tcp"
227 #define OC_RSRVD_TLS_PORT "x.org.iotivity.tls"
229 /** For Server instance ID.*/
230 #define OC_RSRVD_SERVER_INSTANCE_ID "sid"
237 #define OC_RSRVD_PLATFORM_ID "pi"
239 /** Platform MFG NAME. */
240 #define OC_RSRVD_MFG_NAME "mnmn"
243 #define OC_RSRVD_MFG_URL "mnml"
246 #define OC_RSRVD_MODEL_NUM "mnmo"
248 /** Platform MFG Date.*/
249 #define OC_RSRVD_MFG_DATE "mndt"
251 /** Platform versio.n */
252 #define OC_RSRVD_PLATFORM_VERSION "mnpv"
254 /** Platform Operating system version. */
255 #define OC_RSRVD_OS_VERSION "mnos"
257 /** Platform Hardware version. */
258 #define OC_RSRVD_HARDWARE_VERSION "mnhw"
260 /**Platform Firmware version. */
261 #define OC_RSRVD_FIRMWARE_VERSION "mnfv"
263 /** Support URL for the platform. */
264 #define OC_RSRVD_SUPPORT_URL "mnsl"
266 /** System time for the platform. */
267 #define OC_RSRVD_SYSTEM_TIME "st"
269 /** VID for the platform. */
270 #define OC_RSRVD_VID "vid"
276 #define OC_RSRVD_DEVICE_ID "di"
279 #define OC_RSRVD_DEVICE_NAME "n"
281 /** Device specification version.*/
282 #define OC_RSRVD_SPEC_VERSION "icv"
284 /** Device data model.*/
285 #define OC_RSRVD_DATA_MODEL_VERSION "dmv"
287 /** Device specification version.*/
288 #define OC_SPEC_VERSION "core.1.1.0"
290 /** Device Data Model version.*/
291 #define OC_DATA_MODEL_VERSION "res.1.1.0,sh.1.1.0"
293 * These provide backward compatibility - their use is deprecated.
297 /** Multicast Prefix.*/
298 #define OC_MULTICAST_PREFIX "224.0.1.187:5683"
300 /** Multicast IP address.*/
301 #define OC_MULTICAST_IP "224.0.1.187"
303 /** Multicast Port.*/
304 #define OC_MULTICAST_PORT (5683)
307 /** Max Device address size. */
309 #define MAX_ADDR_STR_SIZE (256)
311 /** Max Address could be
312 * "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
313 * +1 for null terminator.
315 #define MAX_ADDR_STR_SIZE (66)
318 /** Length of MAC address */
319 #define MAC_ADDR_STR_SIZE (17)
321 /** Blocks of MAC address */
322 #define MAC_ADDR_BLOCKS (6)
324 /** Max identity size. */
325 #define MAX_IDENTITY_SIZE (37)
327 /** Universal unique identity size. */
328 #define UUID_IDENTITY_SIZE (128/8)
330 /** Resource Directory */
332 /** Resource Directory URI used to Discover RD and Publish resources.*/
333 #define OC_RSRVD_RD_URI "/oic/rd"
335 /** To represent resource type with rd.*/
336 #define OC_RSRVD_RESOURCE_TYPE_RD "oic.wk.rd"
338 /** RD Discovery bias factor type. */
339 #define OC_RSRVD_RD_DISCOVERY_SEL "sel"
341 /** Resource URI used to discover Proxy */
342 #define OC_RSRVD_PROXY_URI "/oic/chp"
344 /** Resource URI used to discover Proxy */
345 #define OC_RSRVD_PROXY_OPTION_ID 35
348 #define OC_RSRVD_BASE_URI "baseURI"
350 /** Unique value per collection/link. */
351 #define OC_RSRVD_INS "ins"
353 /** Allowable resource types in the links. */
354 #define OC_RSRVD_RTS "rts"
356 /** Default relationship. */
357 #define OC_RSRVD_DREL "drel"
359 /** Defines relationship between links. */
360 #define OC_RSRVD_REL "rel"
362 /** Defines title. */
363 #define OC_RSRVD_TITLE "title"
366 #define OC_RSRVD_URI "anchor"
368 /** Defines media type. */
369 #define OC_RSRVD_MEDIA_TYPE "type"
371 /** To represent resource type with Publish RD.*/
372 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdpub"
377 #define OC_RSRVD_ACCOUNT_URI "/oic/account"
379 /** Account user URI.*/
380 #define OC_RSRVD_ACCOUNT_SEARCH_URI "/oic/account/search"
382 /** Account session URI.*/
383 #define OC_RSRVD_ACCOUNT_SESSION_URI "/oic/account/session"
385 /** Account token refresh URI.*/
386 #define OC_RSRVD_ACCOUNT_TOKEN_REFRESH_URI "/oic/account/tokenrefresh"
389 #define OC_RSRVD_ACL_GROUP_URI "/oic/acl/group"
391 /** ACL invite URI.*/
392 #define OC_RSRVD_ACL_INVITE_URI "/oic/acl/invite"
394 /** Defines auth provider. */
395 #define OC_RSRVD_AUTHPROVIDER "authprovider"
397 /** Defines auth code. */
398 #define OC_RSRVD_AUTHCODE "authcode"
400 /** Defines access token. */
401 #define OC_RSRVD_ACCESS_TOKEN "accesstoken"
403 /** Defines login. */
404 #define OC_RSRVD_LOGIN "login"
406 /** Defines search. */
407 #define OC_RSRVD_SEARCH "search"
409 /** Defines grant type. */
410 #define OC_RSRVD_GRANT_TYPE "granttype"
412 /** Defines refresh token. */
413 #define OC_RSRVD_REFRESH_TOKEN "refreshtoken"
415 /** Defines user UUID. */
416 #define OC_RSRVD_USER_UUID "uid"
418 /** Defines group ID. */
419 #define OC_RSRVD_GROUP_ID "gid"
421 /** Defines member of group ID. */
422 #define OC_RSRVD_MEMBER_ID "mid"
424 /** Defines invite. */
425 #define OC_RSRVD_INVITE "invite"
427 /** Defines accept. */
428 #define OC_RSRVD_ACCEPT "accept"
430 /** Defines operation. */
431 #define OC_RSRVD_OPERATION "op"
434 #define OC_RSRVD_ADD "add"
436 /** Defines delete. */
437 #define OC_RSRVD_DELETE "delete"
439 /** Defines owner. */
440 #define OC_RSRVD_OWNER "owner"
442 /** Defines members. */
443 #define OC_RSRVD_MEMBERS "members"
445 /** To represent grant type with refresh token. */
446 #define OC_RSRVD_GRANT_TYPE_REFRESH_TOKEN "refresh_token"
449 #define OC_RSRVD_PROV_CRL_URL "/oic/credprov/crl"
451 #define OC_RSRVD_LAST_UPDATE "lu"
453 #define OC_RSRVD_THIS_UPDATE "tu"
455 #define OC_RSRVD_NEXT_UPDATE "nu"
457 #define OC_RSRVD_SERIAL_NUMBERS "rcsn"
459 #define OC_RSRVD_CRL "crl"
461 #define OC_RSRVD_CRL_ID "crlid"
464 #define OC_RSRVD_GROUP_URL "/oic/group"
466 #define OC_RSRVD_ACL_GROUP_URL "/oic/acl/group"
468 #define OC_RSRVD_ACL_INVITE_URL "/oic/acl/invite"
470 #define OC_RSRVD_ACL_VERIFY_URL "/oic/acl/verify"
472 #define OC_RSRVD_ACL_ID_URL "/oic/acl/id"
474 #define OC_RSRVD_MEMBER_ID "mid"
476 #define OC_RSRVD_GROUP_ID "gid"
478 #define OC_RSRVD_OWNER_ID "oid"
480 #define OC_RSRVD_ACL_ID "aclid"
482 #define OC_RSRVD_ACE_ID "aceid"
484 #define OC_RSRVD_DEVICE_ID "di"
486 #define OC_RSRVD_SUBJECT_ID "sid"
488 #define OC_RSRVD_REQUEST_METHOD "rm"
490 #define OC_RSRVD_REQUEST_URI "uri"
492 #define OC_RSRVD_GROUP_MASTER_ID "gmid"
494 #define OC_RSRVD_GROUP_TYPE "gtype"
496 #define OC_RSRVD_SUBJECT_TYPE "stype"
498 #define OC_RSRVD_GROUP_ID_LIST "gidlist"
500 #define OC_RSRVD_MEMBER_ID_LIST "midlist"
502 #define OC_RSRVD_DEVICE_ID_LIST "dilist"
504 #define OC_RSRVD_ACCESS_CONTROL_LIST "aclist"
506 #define OC_RSRVD_RESOURCES "resources"
508 #define OC_RSRVD_VALIDITY "validity"
510 #define OC_RSRVD_PERIOD "period"
512 #define OC_RSRVD_RECURRENCE "recurrence"
514 #define OC_RSRVD_INVITE "invite"
516 #define OC_RSRVD_INVITED "invited"
518 #define OC_RSRVD_ENCODING "encoding"
520 #define OC_OIC_SEC "oic.sec"
522 #define OC_RSRVD_BASE64 "base64"
524 #define OC_RSRVD_DER "der"
526 #define OC_RSRVD_PEM "pem"
528 #define OC_RSRVD_RAW "raw"
530 #define OC_RSRVD_UNKNOWN "unknown"
532 #define OC_RSRVD_DATA "data"
534 #define OC_RSRVD_RESOURCE_OWNER_UUID "rowneruuid"
536 #define OC_RSRVD_SUBJECT_UUID "subjectuuid"
538 #define OC_RSRVD_PERMISSION_MASK "permission"
540 #define OC_RSRVD_GROUP_PERMISSION "gp"
542 #define OC_RSRVD_GROUP_ACL "gacl"
544 /** Certificete Sign Request */
545 #define OC_RSRVD_PROV_CERT_URI "/oic/credprov/cert"
547 #define OC_RSRVD_CSR "csr"
549 #define OC_RSRVD_CERT "cert"
551 #define OC_RSRVD_CACERT "certchain"
553 #define OC_RSRVD_TOKEN_TYPE "tokentype"
555 #define OC_RSRVD_EXPIRES_IN "expiresin"
557 #define OC_RSRVD_REDIRECT_URI "redirecturi"
559 #define OC_RSRVD_CERTIFICATE "certificate"
561 * Mark a parameter as unused. Used to prevent unused variable compiler warnings.
562 * Used in three cases:
563 * 1. in callbacks when one of the parameters are unused
564 * 2. when due to code changes a functions parameter is no longer
565 * used but must be left in place for backward compatibility
567 * 3. a variable is only used in the debug build variant and would
568 * give a build warning in release mode.
570 #define OC_UNUSED(x) (void)(x)
573 * These enums (OCTransportAdapter and OCTransportFlags) must
574 * be kept synchronized with OCConnectivityType (below) as well as
575 * CATransportAdapter and CATransportFlags (in CACommon.h).
579 /** value zero indicates discovery.*/
580 OC_DEFAULT_ADAPTER = 0,
582 /** IPv4 and IPv6, including 6LoWPAN.*/
583 OC_ADAPTER_IP = (1 << 0),
585 /** GATT over Bluetooth LE.*/
586 OC_ADAPTER_GATT_BTLE = (1 << 1),
588 /** RFCOMM over Bluetooth EDR.*/
589 OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
591 /**Remote Access over XMPP.*/
592 OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
595 OC_ADAPTER_TCP = (1 << 4),
597 /** NFC Transport for Messaging.*/
598 OC_ADAPTER_NFC = (1 << 5)
599 } OCTransportAdapter;
603 OC_DEFAULT_BT_FLAGS = 0,
604 // flags for BLE transport
605 OC_LE_ADV_DISABLE = 0x1, // disable BLE advertisement.
606 OC_LE_ADV_ENABLE = 0x2, // enable BLE advertisement.
607 OC_LE_SERVER_DISABLE = (1 << 4), // disable gatt server.
608 // flags for EDR transport
609 OC_EDR_SERVER_DISABLE = (1 << 7) // disable rfcomm server.
610 } OCTransportBTFlags_t;
613 * Log level to print can be controlled through this enum.
614 * And privacy logs contained uid, Token, Device id, etc can also disable.
615 * This enum (OCLogLevel) must be kept synchronized with
616 * CAUtilLogLevel_t (in CACommon.h).
620 OC_LOG_LEVEL_ALL = 1, // all logs.
621 OC_LOG_LEVEL_INFO, // debug level is disabled.
625 * Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
629 /** default flag is 0*/
630 OC_DEFAULT_FLAGS = 0,
632 /** Insecure transport is the default (subject to change).*/
633 /** secure the transport path*/
634 OC_FLAG_SECURE = (1 << 4),
636 /** IPv4 & IPv6 auto-selection is the default.*/
637 /** IP & TCP adapter only.*/
638 OC_IP_USE_V6 = (1 << 5),
640 /** IP & TCP adapter only.*/
641 OC_IP_USE_V4 = (1 << 6),
643 /** Multicast only.*/
644 OC_MULTICAST = (1 << 7),
646 /** Link-Local multicast is the default multicast scope for IPv6.
647 * These are placed here to correspond to the IPv6 multicast address bits.*/
649 /** IPv6 Interface-Local scope (loopback).*/
650 OC_SCOPE_INTERFACE = 0x1,
652 /** IPv6 Link-Local scope (default).*/
655 /** IPv6 Realm-Local scope. */
656 OC_SCOPE_REALM = 0x3,
658 /** IPv6 Admin-Local scope. */
659 OC_SCOPE_ADMIN = 0x4,
661 /** IPv6 Site-Local scope. */
664 /** IPv6 Organization-Local scope. */
667 /**IPv6 Global scope. */
668 OC_SCOPE_GLOBAL = 0xE,
672 /** Bit mask for scope.*/
673 #define OC_MASK_SCOPE (0x000F)
675 /** Bit mask for Mods.*/
676 #define OC_MASK_MODS (0x0FF0)
677 #define OC_MASK_FAMS (OC_IP_USE_V6|OC_IP_USE_V4)
679 typedef struct OCStringLL
681 struct OCStringLL *next;
686 * End point identity.
690 /** Identity Length */
693 /** Array of end point identity.*/
694 unsigned char id[MAX_IDENTITY_SIZE];
698 * Universally unique identifier.
702 /** identitifier string.*/
703 unsigned char id[UUID_IDENTITY_SIZE];
707 * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
708 * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
713 OCTransportAdapter adapter;
715 /** transport modifiers.*/
716 OCTransportFlags flags;
721 /** address for all adapters.*/
722 char addr[MAX_ADDR_STR_SIZE];
724 /** usually zero for default interface.*/
727 /** destination GatewayID:ClientId.*/
728 char routeData[MAX_ADDR_STR_SIZE];
730 /** device ID of remote.*/
731 char remoteId[MAX_IDENTITY_SIZE];
735 * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
736 * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
737 * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
740 * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
744 /** use when defaults are ok. */
747 /** IPv4 and IPv6, including 6LoWPAN.*/
748 CT_ADAPTER_IP = (1 << 16),
750 /** GATT over Bluetooth LE.*/
751 CT_ADAPTER_GATT_BTLE = (1 << 17),
753 /** RFCOMM over Bluetooth EDR.*/
754 CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
757 /** Remote Access over XMPP.*/
758 CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
761 CT_ADAPTER_TCP = (1 << 20),
764 CT_ADAPTER_NFC = (1 << 21),
766 /** Insecure transport is the default (subject to change).*/
768 /** secure the transport path.*/
769 CT_FLAG_SECURE = (1 << 4),
771 /** IPv4 & IPv6 autoselection is the default.*/
773 /** IP adapter only.*/
774 CT_IP_USE_V6 = (1 << 5),
776 /** IP adapter only.*/
777 CT_IP_USE_V4 = (1 << 6),
779 /** Link-Local multicast is the default multicast scope for IPv6.
780 * These are placed here to correspond to the IPv6 address bits.*/
782 /** IPv6 Interface-Local scope(loopback).*/
783 CT_SCOPE_INTERFACE = 0x1,
785 /** IPv6 Link-Local scope (default).*/
788 /** IPv6 Realm-Local scope.*/
789 CT_SCOPE_REALM = 0x3,
791 /** IPv6 Admin-Local scope.*/
792 CT_SCOPE_ADMIN = 0x4,
794 /** IPv6 Site-Local scope.*/
797 /** IPv6 Organization-Local scope.*/
800 /** IPv6 Global scope.*/
801 CT_SCOPE_GLOBAL = 0xE,
802 } OCConnectivityType;
804 /** bit shift required for connectivity adapter.*/
805 #define CT_ADAPTER_SHIFT 16
808 #define CT_MASK_FLAGS 0xFFFF
811 #define CT_MASK_ADAPTER 0xFFFF0000
814 * OCDoResource methods to dispatch the request
818 OC_REST_NOMETHOD = 0,
821 OC_REST_GET = (1 << 0),
824 OC_REST_PUT = (1 << 1),
827 OC_REST_POST = (1 << 2),
830 OC_REST_DELETE = (1 << 3),
832 /** Register observe request for most up date notifications ONLY.*/
833 OC_REST_OBSERVE = (1 << 4),
835 /** Register observe request for all notifications, including stale notifications.*/
836 OC_REST_OBSERVE_ALL = (1 << 5),
838 /** Subscribe for all presence notifications of a particular resource.*/
839 OC_REST_PRESENCE = (1 << 7),
841 /** Allows OCDoResource caller to do discovery.*/
842 OC_REST_DISCOVER = (1 << 8)
846 * Formats for payload encoding.
853 OC_FORMAT_UNSUPPORTED,
857 * Host Mode of Operation.
864 OC_GATEWAY /**< Client server mode along with routing capabilities.*/
868 * Quality of Service attempts to abstract the guarantees provided by the underlying transport
869 * protocol. The precise definitions of each quality of service level depend on the
870 * implementation. In descriptions below are for the current implementation and may changed
875 /** Packet delivery is best effort.*/
878 /** Packet delivery is best effort.*/
881 /** Acknowledgments are used to confirm delivery.*/
884 /** No Quality is defined, let the stack decide.*/
888 } OCQualityOfService;
891 * Resource Properties.
892 * The value of a policy property is defined as bitmap.
893 * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
894 * Not including the policy property is equivalent to zero.
899 /** When none of the bits are set, the resource is non-discoverable &
900 * non-observable by the client.*/
901 OC_RES_PROP_NONE = (0),
903 /** When this bit is set, the resource is allowed to be discovered by clients.*/
904 OC_DISCOVERABLE = (1 << 0),
906 /** When this bit is set, the resource is allowed to be observed by clients.*/
907 OC_OBSERVABLE = (1 << 1),
909 /** When this bit is set, the resource is initialized, otherwise the resource
910 * is 'inactive'. 'inactive' signifies that the resource has been marked for
911 * deletion or is already deleted.*/
912 OC_ACTIVE = (1 << 2),
914 /** When this bit is set, the resource has been marked as 'slow'.
915 * 'slow' signifies that responses from this resource can expect delays in
916 * processing its requests from clients.*/
919 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
920 /** When this bit is set, the resource is a secure resource.*/
921 OC_SECURE = (1 << 4),
926 /** When this bit is set, the resource is allowed to be discovered only
927 * if discovery request contains an explicit querystring.
928 * Ex: GET /oic/res?rt=oic.sec.acl */
929 OC_EXPLICIT_DISCOVERABLE = (1 << 5)
932 /** When this bit is set, the resource is allowed to be published */
933 ,OC_MQ_PUBLISHER = (1 << 6)
937 /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
938 ,OC_MQ_BROKER = (1 << 7)
940 } OCResourceProperty;
943 * Transport Protocol IDs.
947 /** For invalid ID.*/
948 OC_INVALID_ID = (1 << 0),
951 OC_COAP_ID = (1 << 1)
952 } OCTransportProtocolID;
955 * Declares Stack Results & Errors.
959 /** Success status code - START HERE.*/
961 OC_STACK_RESOURCE_CREATED,
962 OC_STACK_RESOURCE_DELETED,
964 OC_STACK_RESOURCE_CHANGED,
965 /** Success status code - END HERE.*/
967 /** Error status code - START HERE.*/
968 OC_STACK_INVALID_URI = 20,
969 OC_STACK_INVALID_QUERY,
971 OC_STACK_INVALID_PORT,
972 OC_STACK_INVALID_CALLBACK,
973 OC_STACK_INVALID_METHOD,
975 /** Invalid parameter.*/
976 OC_STACK_INVALID_PARAM,
977 OC_STACK_INVALID_OBSERVE_PARAM,
981 OC_STACK_ADAPTER_NOT_ENABLED,
984 /** Resource not found.*/
985 OC_STACK_NO_RESOURCE,
987 /** e.g: not supported method or interface.*/
988 OC_STACK_RESOURCE_ERROR,
989 OC_STACK_SLOW_RESOURCE,
990 OC_STACK_DUPLICATE_REQUEST,
992 /** Resource has no registered observers.*/
993 OC_STACK_NO_OBSERVERS,
994 OC_STACK_OBSERVER_NOT_FOUND,
995 OC_STACK_VIRTUAL_DO_NOT_HANDLE,
996 OC_STACK_INVALID_OPTION,
998 /** The remote reply contained malformed data.*/
999 OC_STACK_MALFORMED_RESPONSE,
1000 OC_STACK_PERSISTENT_BUFFER_REQUIRED,
1001 OC_STACK_INVALID_REQUEST_HANDLE,
1002 OC_STACK_INVALID_DEVICE_INFO,
1003 OC_STACK_INVALID_JSON,
1005 /** Request is not authorized by Resource Server. */
1006 OC_STACK_UNAUTHORIZED_REQ,
1007 OC_STACK_TOO_LARGE_REQ,
1009 /** Error code from PDM */
1010 OC_STACK_PDM_IS_NOT_INITIALIZED,
1011 OC_STACK_DUPLICATE_UUID,
1012 OC_STACK_INCONSISTENT_DB,
1013 OC_STACK_SVR_DB_NOT_EXIST,
1016 * Error code from OTM
1017 * This error is pushed from DTLS interface when handshake failure happens
1019 OC_STACK_AUTHENTICATION_FAILURE,
1020 OC_STACK_NOT_ALLOWED_OXM,
1022 /** Insert all new error codes here!.*/
1023 OC_STACK_PRESENCE_STOPPED = 128,
1024 OC_STACK_PRESENCE_TIMEOUT,
1025 OC_STACK_PRESENCE_DO_NOT_HANDLE,
1027 /** Request is denied by the user*/
1028 OC_STACK_USER_DENIED_REQ,
1029 OC_STACK_NOT_ACCEPTABLE,
1030 OC_STACK_METHOD_NOT_ALLOWED,
1032 /** ERROR code from server */
1033 OC_STACK_FORBIDDEN_REQ, /** 403*/
1034 OC_STACK_TOO_MANY_REQUESTS, /** 429*/
1035 OC_STACK_INTERNAL_SERVER_ERROR, /** 500*/
1036 OC_STACK_NOT_IMPLEMENTED, /** 501*/
1037 OC_STACK_BAD_GATEWAY, /** 502*/
1038 OC_STACK_SERVICE_UNAVAILABLE, /** 503*/
1039 OC_STACK_GATEWAY_TIMEOUT, /** 504*/
1040 OC_STACK_PROXY_NOT_SUPPORTED, /** 505*/
1042 /** ERROR in stack.*/
1043 OC_STACK_ERROR = 255
1044 /** Error status code - END HERE.*/
1048 * Handle to an OCDoResource invocation.
1050 typedef void * OCDoHandle;
1053 * Handle to an OCResource object owned by the OCStack.
1055 typedef void * OCResourceHandle;
1058 * Handle to an OCRequest object owned by the OCStack.
1060 typedef uint32_t OCRequestHandle;
1063 * Unique identifier for each observation request. Used when observations are
1064 * registered or de-registered. Used by entity handler to signal specific
1065 * observers to be notified of resource changes.
1066 * There can be maximum of 3840 observations per server.
1068 typedef uint16_t OCObservationId;
1071 * Sequence number is a 24 bit field,
1072 * per https://tools.ietf.org/html/rfc7641.
1074 #define MAX_SEQUENCE_NUMBER (0xFFFFFF)
1077 * Action associated with observation.
1082 OC_OBSERVE_REGISTER = 0,
1084 /** To Deregister. */
1085 OC_OBSERVE_DEREGISTER = 1,
1088 OC_OBSERVE_NO_OPTION = 2,
1094 * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
1095 * when it calls OCRegisterPersistentStorageHandler.
1096 * Persistent storage open handler points to default file path.
1097 * It should check file path and whether the file is symbolic link or no.
1098 * Application can point to appropriate SVR database path for it's IoTivity Server.
1101 /** Persistent storage file path.*/
1102 FILE* (* open)(const char *path, const char *mode);
1104 /** Persistent storage read handler.*/
1105 size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
1107 /** Persistent storage write handler.*/
1108 size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
1110 /** Persistent storage close handler.*/
1111 int (* close)(FILE *fp);
1113 /** Persistent storage unlink handler.*/
1114 int (* unlink)(const char *path);
1116 /** Persistent Storage Handler for Encryption.*/
1117 int (* encrypt)(const unsigned char *pt, size_t size,
1118 unsigned char**ct, size_t *ct_len);
1120 /**Persistent Storage Handler for Decryption.*/
1121 int (* decrypt)(const unsigned char *ct, size_t size,
1122 unsigned char**pt, size_t *pt_len);
1123 } OCPersistentStorage;
1126 * Possible returned values from entity handler.
1130 /** Action associated with observation request.*/
1131 OCObserveAction action;
1133 /** Identifier for observation being registered/deregistered.*/
1134 OCObservationId obsId;
1135 } OCObservationInfo;
1138 * Possible returned values from entity handler.
1145 OC_EH_RESOURCE_CREATED = 201,
1146 OC_EH_RESOURCE_DELETED = 202,
1148 OC_EH_CHANGED = 204,
1149 OC_EH_CONTENT = 205,
1150 OC_EH_BAD_REQ = 400,
1151 OC_EH_UNAUTHORIZED_REQ = 401,
1152 OC_EH_BAD_OPT = 402,
1153 OC_EH_FORBIDDEN = 403,
1154 OC_EH_RESOURCE_NOT_FOUND = 404,
1155 OC_EH_METHOD_NOT_ALLOWED = 405,
1156 OC_EH_NOT_ACCEPTABLE = 406,
1157 OC_EH_TOO_LARGE = 413,
1158 OC_EH_UNSUPPORTED_MEDIA_TYPE = 415,
1159 OC_EH_TOO_MANY_REQUESTS = 429,
1160 OC_EH_INTERNAL_SERVER_ERROR = 500,
1161 OC_EH_NOT_IMPLEMENTED = 501,
1162 OC_EH_BAD_GATEWAY = 502,
1163 OC_EH_SERVICE_UNAVAILABLE = 503,
1164 OC_EH_RETRANSMIT_TIMEOUT = 504,
1165 OC_EH_PROXY_NOT_SUPPORTED = 505
1166 } OCEntityHandlerResult;
1169 * This structure will be used to define the vendor specific header options to be included
1170 * in communication packets.
1172 typedef struct OCHeaderOption
1174 /** The protocol ID this option applies to.*/
1175 OCTransportProtocolID protocolID;
1177 /** The header option ID which will be added to communication packets.*/
1180 /** its length 191.*/
1181 uint16_t optionLength;
1183 /** pointer to its data.*/
1184 uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
1186 #ifdef SUPPORTS_DEFAULT_CTOR
1187 OCHeaderOption() = default;
1188 OCHeaderOption(OCTransportProtocolID pid,
1191 const uint8_t* optData)
1194 optionLength(optlen)
1197 // parameter includes the null terminator.
1198 optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
1199 optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
1200 memcpy(optionData, optData, optionLength);
1201 optionData[optionLength - 1] = '\0';
1207 * This structure describes the platform properties. All non-Null properties will be
1208 * included in a platform discovery request.
1209 * @deprecated: Use OCSetPropertyValue to set platform value.
1216 /** Manufacturer name.*/
1217 char *manufacturerName;
1219 /** Manufacturer URL for platform property.*/
1220 char *manufacturerUrl;
1225 /** Manufacturer date.*/
1226 char *dateOfManufacture;
1228 /** Platform version.*/
1229 char *platformVersion;
1231 /** Operating system version.*/
1232 char *operatingSystemVersion;
1235 char *hardwareVersion;
1238 char *firmwareVersion;
1240 /** Platform support URL.*/
1249 * This structure is expected as input for device properties.
1250 * device name is mandatory and expected from the application.
1251 * device id of type UUID will be generated by the stack.
1252 * @deprecated: Use OCSetPropertyValue to set device value.
1256 /** Pointer to the device name.*/
1258 /** Pointer to the types.*/
1260 /** Pointer to the device specification version.*/
1262 /** Pointer to the device data model versions (in CSV format).*/
1263 OCStringLL *dataModelVersions;
1268 * callback for bound JID
1270 typedef void (*jid_bound_cb)(char *jid);
1273 * CA Remote Access information for XMPP Client
1278 char *hostname; /**< XMPP server hostname */
1279 uint16_t port; /**< XMPP server serivce port */
1280 char *xmpp_domain; /**< XMPP login domain */
1281 char *username; /**< login username */
1282 char *password; /**< login password */
1283 char *resource; /**< specific resource for login */
1284 char *user_jid; /**< specific JID for login */
1285 jid_bound_cb jidbound; /**< callback when JID bound */
1287 #endif /* RA_ADAPTER */
1290 /** Enum to describe the type of object held by the OCPayload object.*/
1293 /** Contents of the payload are invalid */
1294 PAYLOAD_TYPE_INVALID,
1295 /** The payload is an OCDiscoveryPayload */
1296 PAYLOAD_TYPE_DISCOVERY,
1297 /** The payload of the device */
1298 PAYLOAD_TYPE_DEVICE,
1299 /** The payload type of the platform */
1300 PAYLOAD_TYPE_PLATFORM,
1301 /** The payload is an OCRepPayload */
1302 PAYLOAD_TYPE_REPRESENTATION,
1303 /** The payload is an OCSecurityPayload */
1304 PAYLOAD_TYPE_SECURITY,
1305 /** The payload is an OCPresencePayload */
1306 PAYLOAD_TYPE_PRESENCE
1310 * A generic struct representing a payload returned from a resource operation
1312 * A pointer to OCPayLoad can be cast to a more specific struct to access members
1317 /** The type of message that was received */
1328 OCREP_PROP_BYTE_STRING,
1331 }OCRepPayloadPropType;
1333 /** This structure will be used to represent a binary string for CBOR payloads.*/
1336 /** pointer to data bytes.*/
1339 /** number of data bytes.*/
1343 #define MAX_REP_ARRAY_DEPTH 3
1346 OCRepPayloadPropType type;
1347 size_t dimensions[MAX_REP_ARRAY_DEPTH];
1356 /** pointer to ByteString array.*/
1357 OCByteString* ocByteStrArray;
1359 struct OCRepPayload** objArray;
1361 } OCRepPayloadValueArray;
1363 typedef struct OCRepPayloadValue
1366 OCRepPayloadPropType type;
1374 /** ByteString object.*/
1375 OCByteString ocByteStr;
1377 struct OCRepPayload* obj;
1378 OCRepPayloadValueArray arr;
1380 struct OCRepPayloadValue* next;
1382 } OCRepPayloadValue;
1384 // used for get/set/put/observe/etc representations
1385 typedef struct OCRepPayload
1390 OCStringLL* interfaces;
1391 OCRepPayloadValue* values;
1392 struct OCRepPayload* next;
1395 // used inside a discovery payload
1396 typedef struct OCResourcePayload
1400 OCStringLL* interfaces;
1407 struct OCResourcePayload* next;
1408 } OCResourcePayload;
1410 typedef struct OCDiscoveryPayload
1417 /** A special case for handling RD address. */
1423 /** Resource Type */
1429 /** This structure holds the old /oic/res response. */
1430 OCResourcePayload *resources;
1432 /** Holding address of the next DiscoveryPayload. */
1433 struct OCDiscoveryPayload *next;
1435 } OCDiscoveryPayload;
1440 uint8_t* securityData;
1442 } OCSecurityPayload;
1447 uint32_t sequenceNumber;
1449 OCPresenceTrigger trigger;
1451 } OCPresencePayload;
1454 * Incoming requests handled by the server. Requests are passed in as a parameter to the
1455 * OCEntityHandler callback API.
1456 * The OCEntityHandler callback API must be implemented in the application in order
1457 * to receive these requests.
1461 /** Associated resource.*/
1462 OCResourceHandle resource;
1464 /** Associated request handle.*/
1465 OCRequestHandle requestHandle;
1467 /** the REST method retrieved from received request PDU.*/
1470 /** description of endpoint that sent the request.*/
1473 /** resource query send by client.*/
1476 /** Information associated with observation - valid only when OCEntityHandler flag includes
1477 * ::OC_OBSERVE_FLAG.*/
1478 OCObservationInfo obsInfo;
1480 /** Number of the received vendor specific header options.*/
1481 uint8_t numRcvdVendorSpecificHeaderOptions;
1483 /** Pointer to the array of the received vendor specific header options.*/
1484 OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1489 /** the payload from the request PDU.*/
1492 } OCEntityHandlerRequest;
1496 * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1500 /** Address of remote server.*/
1503 /** backward compatibility (points to devAddr).*/
1506 /** backward compatibility.*/
1507 OCConnectivityType connType;
1509 /** the security identity of the remote server.*/
1510 OCIdentity identity;
1512 /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1513 OCStackResult result;
1515 /** If associated with observe, this will represent the sequence of notifications from server.*/
1516 uint32_t sequenceNumber;
1519 const char * resourceUri;
1521 /** the payload for the response PDU.*/
1524 /** Number of the received vendor specific header options.*/
1525 uint8_t numRcvdVendorSpecificHeaderOptions;
1527 /** An array of the received vendor specific header options.*/
1528 OCHeaderOption *rcvdVendorSpecificHeaderOptions;
1532 * Request handle is passed to server via the entity handler for each incoming request.
1533 * Stack assigns when request is received, server sets to indicate what request response is for.
1537 /** Request handle.*/
1538 OCRequestHandle requestHandle;
1540 /** Resource handle.*/
1541 OCResourceHandle resourceHandle;
1543 /** Allow the entity handler to pass a result with the response.*/
1544 OCEntityHandlerResult ehResult;
1546 /** This is the pointer to server payload data to be transferred.*/
1549 /** number of the vendor specific header options .*/
1550 uint8_t numSendVendorSpecificHeaderOptions;
1552 /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1553 OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1555 /** URI of new resource that entity handler might create.*/
1556 char resourceUri[MAX_URI_LENGTH];
1558 /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1559 uint8_t persistentBufferFlag;
1560 } OCEntityHandlerResponse;
1567 /** Request state.*/
1568 OC_REQUEST_FLAG = (1 << 1),
1569 /** Observe state.*/
1570 OC_OBSERVE_FLAG = (1 << 2)
1571 } OCEntityHandlerFlag;
1574 * Possible return values from client application callback
1576 * A client application callback returns an OCStackApplicationResult to indicate whether
1577 * the stack should continue to keep the callback registered.
1581 /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1582 OC_STACK_DELETE_TRANSACTION = 0,
1583 /** Keep this callback registered and call it if an apropriate event occurs */
1584 OC_STACK_KEEP_TRANSACTION
1585 } OCStackApplicationResult;
1588 //#ifdef DIRECT_PAIRING
1590 * @brief direct pairing Method Type.
1592 * 1: pre-configured pin
1597 DP_NOT_ALLOWED = 0x0,
1598 DP_PRE_CONFIGURED = (0x1 << 0),
1599 DP_RANDOM_PIN = (0x1 << 1),
1603 * Device Information of discoverd direct pairing device(s).
1605 typedef struct OCDPDev
1608 OCConnectivityType connType;
1609 uint16_t securePort;
1613 OCUUIdentity deviceID;
1614 OCUUIdentity rowner;
1615 struct OCDPDev *next;
1617 //#endif // DIRECT_PAIRING
1620 * -------------------------------------------------------------------------------------------
1621 * Callback function definitions
1622 * -------------------------------------------------------------------------------------------
1626 * Client applications implement this callback to consume responses received from Servers.
1628 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1629 OCClientResponse * clientResponse);
1632 * Client applications using a context pointer implement this callback to delete the
1633 * context upon removal of the callback/context pointer from the internal callback-list.
1635 typedef void (* OCClientContextDeleter)(void *context);
1638 * This info is passed from application to OC Stack when initiating a request to Server.
1640 typedef struct OCCallbackData
1642 /** Pointer to the context.*/
1645 /** The pointer to a function the stack will call to handle the requests.*/
1646 OCClientResponseHandler cb;
1648 /** A pointer to a function to delete the context when this callback is removed.*/
1649 OCClientContextDeleter cd;
1651 #ifdef SUPPORTS_DEFAULT_CTOR
1652 OCCallbackData() = default;
1653 OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1654 :context(ctx), cb(callback), cd(deleter){}
1659 * Application server implementations must implement this callback to consume requests OTA.
1660 * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1662 * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1663 * OC_EH_SLOW and etc in entity handler callback,
1664 * ocstack will be not send response automatically to client
1665 * except for error return value like OC_EH_ERROR.
1667 * If you want to send response to client with specific result,
1668 * OCDoResponse API should be called with the result value.
1672 * OCEntityHandlerResponse response;
1676 * response.ehResult = OC_EH_CHANGED;
1680 * OCDoResponse(&response)
1686 typedef OCEntityHandlerResult (*OCEntityHandler)
1687 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1690 * Device Entity handler need to use this call back instead of OCEntityHandler.
1692 * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1693 * OC_EH_SLOW and etc in entity handler callback,
1694 * ocstack will be not send response automatically to client
1695 * except for error return value like OC_EH_ERROR.
1697 * If you want to send response to client with specific result,
1698 * OCDoResponse API should be called with the result value.
1702 * OCEntityHandlerResponse response;
1706 * response.ehResult = OC_EH_CHANGED;
1710 * OCDoResponse(&response)
1716 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1717 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1719 //#ifdef DIRECT_PAIRING
1721 * Callback function definition of direct-pairing
1723 * @param[OUT] ctx - user context returned in the callback.
1724 * @param[OUT] peer - pairing device info.
1725 * @param[OUT] result - It's returned with 'OC_STACK_XXX'. It will return 'OC_STACK_OK'
1726 * if D2D pairing is success without error
1728 typedef void (*OCDirectPairingCB)(void *ctx, OCDPDev_t *peer, OCStackResult result);
1729 //#endif // DIRECT_PAIRING
1730 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1732 * Callback function definition for Change in TrustCertChain
1734 * @param[IN] ctx - user context returned in the callback.
1735 * @param[IN] credId - trustCertChain changed for this ID
1736 * @param[IN] trustCertChain - trustcertchain binary blob.
1737 * @param[IN] chainSize - size of trustchain
1739 typedef void (*TrustCertChainChangeCB)(void *ctx, uint16_t credId, uint8_t *trustCertChain,
1743 * certChain context structure.
1745 typedef struct trustCertChainContext
1747 TrustCertChainChangeCB callback;
1749 } trustCertChainContext_t;
1764 * Callback function to receive the OTM event on server side.
1766 * @param[in] ctx user context returned in the callback
1767 * @param[in] addr PT's address (address can be NULL in case of init state)
1768 * @param[in] port PT's port (It is meaningless in case of init state & BLE)
1769 * @param[in] uuid PT's UUID (UUID can be NULL in case of init state & coap reqest)
1770 * @param[in] event OTM state (@ref OCOtmEvent_t)
1772 typedef void (*OCOtmEventHandler)(void *ctx, const char *addr, uint16_t port,
1773 const char *ownerId, OCOtmEvent_t event);
1777 #endif // __cplusplus
1779 #endif /* OCTYPES_H_ */