1 //******************************************************************
3 // Copyright 2015 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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
22 * Data type definitions for all oic.sec.* types defined in the
23 * OIC Security Specification.
25 * Note that throughout, ptrs are used rather than arrays. There
26 * are two primary reasons for this:
27 * 1) The Spec defines many structures with optional fields, so pre-
28 * allocating these would be wasteful.
29 * 2) There are in many cases arrays of Strings or arrays of Structs,
30 * which could not be defined as variable length arrays (e.g. array[])
31 * without breaking from the structure order and definition in the Spec.
33 * The primary drawback to this decision is that marshalling functions
34 * will have to be written by hand to marshal these structures (e.g. to/from
35 * Persistent Storage, or across memory boundaries).
37 * TODO reconcile against latest OIC Security Spec to ensure all fields correct.
38 * (Last checked against v0.95)
41 #ifndef OC_SECURITY_RESOURCE_TYPES_H
42 #define OC_SECURITY_RESOURCE_TYPES_H
44 #include "iotivity_config.h"
46 #include <stdint.h> // for uint8_t typedef
48 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
49 #include "byte_array.h"
50 #endif /* __WITH_X509__ or __WITH_TLS__*/
57 * Values used to create bit-maskable enums for single-value response with
60 #define ACCESS_GRANTED_DEF (1 << 0)
61 #define ACCESS_DENIED_DEF (1 << 1)
62 #define INSUFFICIENT_PERMISSION_DEF (1 << 2)
63 #define SUBJECT_NOT_FOUND_DEF (1 << 3)
64 #define RESOURCE_NOT_FOUND_DEF (1 << 4)
65 #define POLICY_ENGINE_ERROR_DEF (1 << 5)
66 #define INVALID_PERIOD_DEF (1 << 6)
67 #define ACCESS_WAITING_DEF (1 << 7)
68 #define AMS_SERVICE_DEF (1 << 8)
69 #define REASON_MASK_DEF (INSUFFICIENT_PERMISSION_DEF | \
70 INVALID_PERIOD_DEF | \
71 SUBJECT_NOT_FOUND_DEF | \
72 RESOURCE_NOT_FOUND_DEF | \
73 POLICY_ENGINE_ERROR_DEF)
77 * Access policy in least significant bits (from Spec):
79 * 2nd lsb: R (Read, Observe, Discover)
80 * 3rd lsb: U (Write, Update)
84 #define PERMISSION_CREATE (1 << 0)
85 #define PERMISSION_READ (1 << 1)
86 #define PERMISSION_WRITE (1 << 2)
87 #define PERMISSION_DELETE (1 << 3)
88 #define PERMISSION_NOTIFY (1 << 4)
89 #define PERMISSION_FULL_CONTROL (PERMISSION_CREATE | \
96 * @brief Response type for all Action requests from CA layer;
97 * may include a reason code.
99 * To extract codes use GetReasonCode function on SRMAccessResponse:
101 * SRMAccessResponse_t response = SRMRequestHandler(obj, info);
102 * if(SRM_TRUE == IsAccessGranted(response)) {
103 * SRMAccessResponseReasonCode_t reason = GetReasonCode(response);
105 * case INSUFFICIENT_PERMISSION:
112 ACCESS_GRANTED = ACCESS_GRANTED_DEF,
113 ACCESS_DENIED = ACCESS_DENIED_DEF,
114 ACCESS_DENIED_INVALID_PERIOD = ACCESS_DENIED_DEF
115 | INVALID_PERIOD_DEF,
116 ACCESS_DENIED_INSUFFICIENT_PERMISSION = ACCESS_DENIED_DEF
117 | INSUFFICIENT_PERMISSION_DEF,
118 ACCESS_DENIED_SUBJECT_NOT_FOUND = ACCESS_DENIED_DEF
119 | SUBJECT_NOT_FOUND_DEF,
120 ACCESS_DENIED_RESOURCE_NOT_FOUND = ACCESS_DENIED_DEF
121 | RESOURCE_NOT_FOUND_DEF,
122 ACCESS_DENIED_POLICY_ENGINE_ERROR = ACCESS_DENIED_DEF
123 | POLICY_ENGINE_ERROR_DEF,
124 ACCESS_WAITING_FOR_AMS = ACCESS_WAITING_DEF
126 ACCESS_DENIED_AMS_SERVICE_ERROR = ACCESS_DENIED
128 } SRMAccessResponse_t;
131 * Reason code for SRMAccessResponse.
136 INSUFFICIENT_PERMISSION = INSUFFICIENT_PERMISSION_DEF,
137 SUBJECT_NOT_FOUND = SUBJECT_NOT_FOUND_DEF,
138 RESOURCE_NOT_FOUND = RESOURCE_NOT_FOUND_DEF,
139 } SRMAccessResponseReasonCode_t;
142 * Extract Reason Code from Access Response.
144 INLINE_API SRMAccessResponseReasonCode_t GetReasonCode(
145 SRMAccessResponse_t response)
147 SRMAccessResponseReasonCode_t reason =
148 (SRMAccessResponseReasonCode_t)(response & REASON_MASK_DEF);
153 * Returns 'true' iff request should be passed on to RI layer.
155 INLINE_API bool IsAccessGranted(SRMAccessResponse_t response)
157 if(ACCESS_GRANTED == (response & ACCESS_GRANTED))
167 typedef struct OicSecRsrc OicSecRsrc_t;
169 typedef struct OicSecValidity OicSecValidity_t;
171 typedef struct OicSecAce OicSecAce_t;
173 typedef struct OicSecAcl OicSecAcl_t;
175 typedef struct OicSecAmacl OicSecAmacl_t;
177 typedef struct OicSecCred OicSecCred_t;
180 * Aid for assigning/testing vals with OicSecCredType_t.
182 * OicSecCredType_t ct = PIN_PASSWORD | ASYMMETRIC_KEY;
183 * if((ct & PIN_PASSWORD) == PIN_PASSWORD)
185 * // ct contains PIN_PASSWORD flag.
188 typedef enum OSCTBitmask
190 NO_SECURITY_MODE = 0x0,
191 SYMMETRIC_PAIR_WISE_KEY = (0x1 << 0),
192 SYMMETRIC_GROUP_KEY = (0x1 << 1),
193 ASYMMETRIC_KEY = (0x1 << 2),
194 SIGNED_ASYMMETRIC_KEY = (0x1 << 3),
195 PIN_PASSWORD = (0x1 << 4),
196 ASYMMETRIC_ENCRYPTION_KEY = (0x1 << 5),
200 * /oic/sec/credtype (Credential Type) data type.
201 * Derived from OIC Security Spec /oic/sec/cred; see Spec for details.
202 * 0: no security mode
203 * 1: symmetric pair-wise key
204 * 2: symmetric group key
206 * 8: signed asymmetric key (aka certificate)
209 typedef OSCTBitmask_t OicSecCredType_t;
211 typedef struct OicSecDoxm OicSecDoxm_t;
213 typedef enum OicSecDpm
217 TAKE_OWNER = (0x1 << 1),
218 BOOTSTRAP_SERVICE = (0x1 << 2),
219 SECURITY_MANAGEMENT_SERVICES = (0x1 << 3),
220 PROVISION_CREDENTIALS = (0x1 << 4),
221 PROVISION_ACLS = (0x1 << 5),
222 // << 6 THROUGH 15 RESERVED
225 typedef enum OicSecDpom
227 MULTIPLE_SERVICE_SERVER_DRIVEN = 0x0,
228 SINGLE_SERVICE_SERVER_DRIVEN = 0x1,
229 MULTIPLE_SERVICE_CLIENT_DRIVEN = 0x2,
230 SINGLE_SERVICE_CLIENT_DRIVEN = 0x3,
233 typedef enum OicSecSvcType
235 SERVICE_UNKNOWN = 0x0,
236 ACCESS_MGMT_SERVICE = 0x1, //urn:oic.sec.ams
240 //TODO: Need more clarification on deviceIDFormat field type.
260 OIC_SEC_SVR_TYPE_COUNT, //define the value to number of SVR
261 NOT_A_SVR_RESOURCE = 99
266 OIC_JUST_WORKS = 0x0,
267 OIC_RANDOM_DEVICE_PIN = 0x1,
268 OIC_MANUFACTURER_CERTIFICATE = 0x2,
274 OIC_ENCODING_UNKNOW = 0,
275 OIC_ENCODING_RAW = 1,
276 OIC_ENCODING_BASE64 = 2,
277 OIC_ENCODING_PEM = 3,
281 typedef struct OicSecKey OicSecKey_t;
283 typedef struct OicSecPstat OicSecPstat_t;
285 typedef struct OicSecRole OicSecRole_t;
287 typedef struct OicSecSacl OicSecSacl_t;
289 typedef struct OicSecSvc OicSecSvc_t;
291 typedef char *OicUrn_t; //TODO is URN type defined elsewhere?
293 typedef struct OicUuid OicUuid_t; //TODO is UUID type defined elsewhere?
296 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
297 typedef struct OicSecCrl OicSecCrl_t;
298 typedef ByteArray OicSecCert_t;
300 typedef void OicSecCert_t;
301 #endif /* __WITH_X509__ or __WITH_TLS__*/
304 * /oic/uuid (Universal Unique Identifier) data type.
306 #define UUID_LENGTH 128/8 // 128-bit GUID length
307 //TODO: Confirm the length and type of ROLEID.
308 #define ROLEID_LENGTH 128/8 // 128-bit ROLEID length
309 #define OWNER_PSK_LENGTH_128 128/8 //byte size of 128-bit key size
310 #define OWNER_PSK_LENGTH_256 256/8 //byte size of 256-bit key size
314 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
315 //TODO fill in unless this is defined elsewhere?
316 uint8_t id[UUID_LENGTH];
320 * /oic/sec/jwk (JSON Web Key) data type.
321 * See JSON Web Key (JWK) draft-ietf-jose-json-web-key-41
323 #define JWK_LENGTH 256/8 // 256 bit key length
329 // TODO: This field added as workaround. Will be replaced soon.
330 OicEncodingType_t encoding;
336 char *href; // 0:R:S:Y:String
337 char *rel; // 1:R:S:N:String
338 char** types; // 2:R:S:N:String Array
339 size_t typeLen; // the number of elts in types
340 char** interfaces; // 3:R:S:N:String Array
341 size_t interfaceLen; // the number of elts in interfaces
345 struct OicSecValidity
347 char* period; // 0:R:S:Y:String
348 char** recurrences; // 1:R:M:Y:Array of String
349 size_t recurrenceLen; // the number of elts in recurrence
350 OicSecValidity_t *next;
355 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
356 OicUuid_t subjectuuid; // 0:R:S:Y:uuid
357 OicSecRsrc_t *resources; // 1:R:M:Y:Resource
358 uint16_t permission; // 2:R:S:Y:UINT16
359 OicSecValidity_t *validities; // 3:R:M:N:Time-interval
364 * /oic/sec/acl (Access Control List) data type.
365 * Derived from OIC Security Spec; see Spec for details.
369 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
370 OicUuid_t rownerID; // 0:R:S:Y:oic.uuid
371 OicSecAce_t *aces; // 1:R:M:N:ACE
375 * /oic/sec/amacl (Access Manager Service Accesss Control List) data type.
376 * Derived from OIC Security Spec; see Spec for details.
380 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
381 size_t resourcesLen; // the number of elts in Resources
382 char **resources; // 0:R:M:Y:String
383 size_t amssLen; // the number of elts in Amss
384 OicUuid_t *amss; // 1:R:M:Y:acl
385 OicUuid_t rownerID; // 2:R:S:Y:oic.uuid
390 * /oic/sec/cred (Credential) data type.
391 * Derived from OIC Security Spec; see Spec for details.
395 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
396 uint16_t credId; // 0:R:S:Y:UINT16
397 OicUuid_t subject; // 1:R:S:Y:oic.uuid
398 //Note: Need further clarification on roleID data type
399 //NOTE: Need further clarification on roleId datatype.
400 //size_t roleIdsLen; // the number of elts in RoleIds
401 //OicSecRole_t *roleIds; // 2:R:M:N:oic.sec.role
402 OicSecCredType_t credType; // 3:R:S:Y:oic.sec.credtype
403 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
404 OicSecCert_t publicData; // own cerificate chain
405 char *credUsage; // 4:R:S:N:String
406 OicSecKey_t optionalData; // CA's cerificate chain
407 #endif /* __WITH_X509__ or __WITH_TLS__*/
408 OicSecKey_t privateData; // 6:R:S:N:oic.sec.key
409 char *period; // 7:R:S:N:String
410 OicUuid_t rownerID; // 8:R:S:Y:oic.uuid
415 * /oic/sec/doxm (Device Owner Transfer Methods) data type
416 * Derived from OIC Security Spec; see Spec for details.
420 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
421 OicUrn_t *oxmType; // 0:R:M:N:URN
422 size_t oxmTypeLen; // the number of elts in OxmType
423 OicSecOxm_t *oxm; // 1:R:M:N:UINT16
424 size_t oxmLen; // the number of elts in Oxm
425 OicSecOxm_t oxmSel; // 2:R/W:S:Y:UINT16
426 OicSecCredType_t sct; // 3:R:S:Y:oic.sec.credtype
427 bool owned; // 4:R:S:Y:Boolean
428 //TODO: Need more clarification on deviceIDFormat field type.
429 //OicSecDvcIdFrmt_t deviceIDFormat; // 5:R:S:Y:UINT8
430 OicUuid_t deviceID; // 6:R:S:Y:oic.uuid
431 bool dpc; // 7:R:S:Y:Boolean
432 OicUuid_t owner; // 8:R:S:Y:oic.uuid
433 OicUuid_t rownerID; // 9:R:S:Y:oic.uuid
437 * /oic/sec/pstat (Provisioning Status) data type.
438 * NOTE: this struct is ahead of Spec v0.95 in definition to include Sm.
439 * TODO: change comment when reconciled to Spec v0.96.
443 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
444 bool isOp; // 0:R:S:Y:Boolean
445 OicSecDpm_t cm; // 1:R:S:Y:oic.sec.dpm
446 OicSecDpm_t tm; // 2:RW:S:Y:oic.sec.dpm
447 OicUuid_t deviceID; // 3:R:S:Y:oic.uuid
448 OicSecDpom_t om; // 4:RW:M:Y:oic.sec.dpom
449 size_t smLen; // the number of elts in Sm
450 OicSecDpom_t *sm; // 5:R:M:Y:oic.sec.dpom
451 uint16_t commitHash; // 6:R:S:Y:oic.sec.sha256
452 OicUuid_t rownerID; // 7:R:S:Y:oic.uuid
456 * /oic/sec/role (Role) data type.
457 * Derived from OIC Security Spec; see Spec for details.
461 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
462 //TODO fill in with Role definition
463 uint8_t id[ROLEID_LENGTH];
467 * /oic/sec/sacl (Signed Access Control List) data type.
468 * Derived from OIC Security Spec; see Spec for details.
472 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
473 //TODO fill in from OIC Security Spec
474 #if defined(_MSC_VER)
475 uint8_t unused; // VS doesn't like empty structs
480 * /oic/sec/svc (Service requiring a secure connection) data type.
481 * Derived from OIC Security Spec; see Spec for details.
485 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
486 OicUuid_t svcdid; //0:R:S:Y:oic.uuid
487 OicSecSvcType_t svct; //1:R:M:Y:OIC Service Type
488 size_t ownersLen; //2:the number of elts in Owners
489 OicUuid_t *owners; //3:R:M:Y:oic.uuid
493 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
497 ByteArray ThisUpdate;
500 #endif /* __WITH_X509__ or __WITH_TLS__ */
503 * @brief direct pairing data type
505 typedef struct OicPin OicDpPin_t;
507 typedef struct OicSecPdAcl OicSecPdAcl_t;
509 typedef struct OicSecPconf OicSecPconf_t;
511 typedef struct OicSecDpairing OicSecDpairing_t;
513 #define DP_PIN_LENGTH 8 // temporary length
516 * @brief /oic/sec/prmtype (Pairing Method Type) data type.
518 * 1: pre-configured pin
521 typedef enum PRMBitmask
523 PRM_NOT_ALLOWED = 0x0,
524 PRM_PRE_CONFIGURED = (0x1 << 0),
525 PRM_RANDOM_PIN = (0x1 << 1),
528 typedef PRMBitmask_t OicSecPrm_t;
533 uint8_t val[DP_PIN_LENGTH];
537 * @brief oic.sec.dpacltype (Device Pairing Access Control List) data type.
541 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
542 char **resources; // 0:R:M:Y:String
543 size_t resourcesLen; // the number of elts in Resources
544 uint16_t permission; // 1:R:S:Y:UINT16
545 char **periods; // 2:R:M*:N:String (<--M*; see Spec)
546 char **recurrences; // 3:R:M:N:String
547 size_t prdRecrLen; // the number of elts in Periods/Recurrences
552 * @brief /oic/sec/pconf (Pairing Configuration) data type
556 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
557 bool edp; // 0:W:S:M:Boolean
558 OicSecPrm_t *prm; // 1:R:M:N:UINT16
559 size_t prmLen; // the number of elts in Prm
560 OicDpPin_t pin; // 2:R:S:Y:String
561 OicSecPdAcl_t *pdacls; // 3:R:M:Y:oic.sec.pdacltype
562 OicUuid_t *pddevs; // 4:R:M:Y:oic.uuid
563 size_t pddevLen; // the number of elts in pddev
564 OicUuid_t deviceID; // 5:R:S:Y:oic.uuid
565 OicUuid_t rownerID; // 6:R:S:Y:oic.uuid
569 * @brief /oic/sec/dpairing (Device Pairing) data type
571 struct OicSecDpairing
573 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
574 OicSecPrm_t spm; // 0:R/W:S:Y:UINT16
575 OicUuid_t pdeviceID; // 1:R:S:Y:oic.uuid
576 OicUuid_t rownerID; // 2:R:S:Y:oic.uuid
579 #define MAX_VERSION_LEN 16 // Security Version length. i.e., 00.00.000 + reserved space
582 * @brief security version data type
584 typedef struct OicSecVer OicSecVer_t;
587 * @brief /oic/sec/ver (Security Version) data type
591 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
592 char secv[MAX_VERSION_LEN]; // 0:R:S:Y:String
593 OicUuid_t deviceID; // 1:R:S:Y:oic.uuid
600 #endif //OC_SECURITY_RESOURCE_TYPES_H