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 <stdint.h> // for uint8_t typedef
47 #include "byte_array.h"
48 #endif /* __WITH_X509__ */
55 * Values used to create bit-maskable enums for single-value response with
58 #define ACCESS_GRANTED_DEF (1 << 0)
59 #define ACCESS_DENIED_DEF (1 << 1)
60 #define INSUFFICIENT_PERMISSION_DEF (1 << 2)
61 #define SUBJECT_NOT_FOUND_DEF (1 << 3)
62 #define RESOURCE_NOT_FOUND_DEF (1 << 4)
63 #define POLICY_ENGINE_ERROR_DEF (1 << 5)
64 #define INVALID_PERIOD_DEF (1 << 6)
65 #define ACCESS_WAITING_DEF (1 << 7)
66 #define AMS_SERVICE_DEF (1 << 8)
67 #define REASON_MASK_DEF (INSUFFICIENT_PERMISSION_DEF | \
68 INVALID_PERIOD_DEF | \
69 SUBJECT_NOT_FOUND_DEF | \
70 RESOURCE_NOT_FOUND_DEF | \
71 POLICY_ENGINE_ERROR_DEF)
75 * Access policy in least significant bits (from Spec):
77 * 2nd lsb: R (Read, Observe, Discover)
78 * 3rd lsb: U (Write, Update)
82 #define PERMISSION_CREATE (1 << 0)
83 #define PERMISSION_READ (1 << 1)
84 #define PERMISSION_WRITE (1 << 2)
85 #define PERMISSION_DELETE (1 << 3)
86 #define PERMISSION_NOTIFY (1 << 4)
87 #define PERMISSION_FULL_CONTROL (PERMISSION_CREATE | \
94 * @brief Response type for all Action requests from CA layer;
95 * may include a reason code.
97 * To extract codes use GetReasonCode function on SRMAccessResponse:
99 * SRMAccessResponse_t response = SRMRequestHandler(obj, info);
100 * if(SRM_TRUE == IsAccessGranted(response)) {
101 * SRMAccessResponseReasonCode_t reason = GetReasonCode(response);
103 * case INSUFFICIENT_PERMISSION:
110 ACCESS_GRANTED = ACCESS_GRANTED_DEF,
111 ACCESS_DENIED = ACCESS_DENIED_DEF,
112 ACCESS_DENIED_INVALID_PERIOD = ACCESS_DENIED_DEF
113 | INVALID_PERIOD_DEF,
114 ACCESS_DENIED_INSUFFICIENT_PERMISSION = ACCESS_DENIED_DEF
115 | INSUFFICIENT_PERMISSION_DEF,
116 ACCESS_DENIED_SUBJECT_NOT_FOUND = ACCESS_DENIED_DEF
117 | SUBJECT_NOT_FOUND_DEF,
118 ACCESS_DENIED_RESOURCE_NOT_FOUND = ACCESS_DENIED_DEF
119 | RESOURCE_NOT_FOUND_DEF,
120 ACCESS_DENIED_POLICY_ENGINE_ERROR = ACCESS_DENIED_DEF
121 | POLICY_ENGINE_ERROR_DEF,
122 ACCESS_WAITING_FOR_AMS = ACCESS_WAITING_DEF
124 ACCESS_DENIED_AMS_SERVICE_ERROR = ACCESS_DENIED
126 } SRMAccessResponse_t;
129 * Reason code for SRMAccessResponse.
134 INSUFFICIENT_PERMISSION = INSUFFICIENT_PERMISSION_DEF,
135 SUBJECT_NOT_FOUND = SUBJECT_NOT_FOUND_DEF,
136 RESOURCE_NOT_FOUND = RESOURCE_NOT_FOUND_DEF,
137 } SRMAccessResponseReasonCode_t;
140 * Extract Reason Code from Access Response.
142 static inline SRMAccessResponseReasonCode_t GetReasonCode(
143 SRMAccessResponse_t response)
145 SRMAccessResponseReasonCode_t reason =
146 (SRMAccessResponseReasonCode_t)(response & REASON_MASK_DEF);
151 * Returns 'true' iff request should be passed on to RI layer.
153 static inline bool IsAccessGranted(SRMAccessResponse_t response)
155 if(ACCESS_GRANTED == (response & ACCESS_GRANTED))
165 typedef struct OicSecRsrc OicSecRsrc_t;
167 typedef struct OicSecValidity OicSecValidity_t;
169 typedef struct OicSecAce OicSecAce_t;
171 typedef struct OicSecAcl OicSecAcl_t;
173 typedef struct OicSecAmacl OicSecAmacl_t;
175 typedef struct OicSecCred OicSecCred_t;
178 * Aid for assigning/testing vals with OicSecCredType_t.
180 * OicSecCredType_t ct = PIN_PASSWORD | ASYMMETRIC_KEY;
181 * if((ct & PIN_PASSWORD) == PIN_PASSWORD)
183 * // ct contains PIN_PASSWORD flag.
186 typedef enum OSCTBitmask
188 NO_SECURITY_MODE = 0x0,
189 SYMMETRIC_PAIR_WISE_KEY = (0x1 << 0),
190 SYMMETRIC_GROUP_KEY = (0x1 << 1),
191 ASYMMETRIC_KEY = (0x1 << 2),
192 SIGNED_ASYMMETRIC_KEY = (0x1 << 3),
193 PIN_PASSWORD = (0x1 << 4),
194 ASYMMETRIC_ENCRYPTION_KEY = (0x1 << 5),
198 * /oic/sec/credtype (Credential Type) data type.
199 * Derived from OIC Security Spec /oic/sec/cred; see Spec for details.
200 * 0: no security mode
201 * 1: symmetric pair-wise key
202 * 2: symmetric group key
204 * 8: signed asymmetric key (aka certificate)
207 typedef OSCTBitmask_t OicSecCredType_t;
209 typedef struct OicSecDoxm OicSecDoxm_t;
211 typedef enum OicSecDpm
215 TAKE_OWNER = (0x1 << 1),
216 BOOTSTRAP_SERVICE = (0x1 << 2),
217 SECURITY_MANAGEMENT_SERVICES = (0x1 << 3),
218 PROVISION_CREDENTIALS = (0x1 << 4),
219 PROVISION_ACLS = (0x1 << 5),
220 // << 6 THROUGH 15 RESERVED
223 typedef enum OicSecDpom
225 MULTIPLE_SERVICE_SERVER_DRIVEN = 0x0,
226 SINGLE_SERVICE_SERVER_DRIVEN = 0x1,
227 MULTIPLE_SERVICE_CLIENT_DRIVEN = 0x2,
228 SINGLE_SERVICE_CLIENT_DRIVEN = 0x3,
231 typedef enum OicSecSvcType
233 SERVICE_UNKNOWN = 0x0,
234 ACCESS_MGMT_SERVICE = 0x1, //urn:oic.sec.ams
238 //TODO: Need more clarification on deviceIDFormat field type.
258 OIC_SEC_SVR_TYPE_COUNT, //define the value to number of SVR
259 NOT_A_SVR_RESOURCE = 99
264 OIC_JUST_WORKS = 0x0,
265 OIC_RANDOM_DEVICE_PIN = 0x1,
266 OIC_MANUFACTURER_CERTIFICATE = 0x2,
272 OIC_ENCODING_UNKNOW = 0,
273 OIC_ENCODING_RAW = 1,
274 OIC_ENCODING_BASE64 = 2
277 typedef struct OicSecKey OicSecKey_t;
279 typedef struct OicSecPstat OicSecPstat_t;
281 typedef struct OicSecRole OicSecRole_t;
283 typedef struct OicSecSacl OicSecSacl_t;
285 typedef struct OicSecSvc OicSecSvc_t;
287 typedef char *OicUrn_t; //TODO is URN type defined elsewhere?
289 typedef struct OicUuid OicUuid_t; //TODO is UUID type defined elsewhere?
293 typedef struct OicSecCrl OicSecCrl_t;
294 typedef ByteArray OicSecCert_t;
296 typedef void OicSecCert_t;
297 #endif /* __WITH_X509__ */
300 * /oic/uuid (Universal Unique Identifier) data type.
302 #define UUID_LENGTH 128/8 // 128-bit GUID length
303 //TODO: Confirm the length and type of ROLEID.
304 #define ROLEID_LENGTH 128/8 // 128-bit ROLEID length
305 #define OWNER_PSK_LENGTH_128 128/8 //byte size of 128-bit key size
306 #define OWNER_PSK_LENGTH_256 256/8 //byte size of 256-bit key size
310 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
311 //TODO fill in unless this is defined elsewhere?
312 uint8_t id[UUID_LENGTH];
316 * /oic/sec/jwk (JSON Web Key) data type.
317 * See JSON Web Key (JWK) draft-ietf-jose-json-web-key-41
319 #define JWK_LENGTH 256/8 // 256 bit key length
325 // TODO: This field added as workaround. Will be replaced soon.
326 OicEncodingType_t encoding;
332 char *href; // 0:R:S:Y:String
333 char *rel; // 1:R:S:N:String
334 char** types; // 2:R:S:N:String Array
335 size_t typeLen; // the number of elts in types
336 char** interfaces; // 3:R:S:N:String Array
337 size_t interfaceLen; // the number of elts in interfaces
341 struct OicSecValidity
343 char* period; // 0:R:S:Y:String
344 char** recurrences; // 1:R:M:Y:Array of String
345 size_t recurrenceLen; // the number of elts in recurrence
346 OicSecValidity_t *next;
351 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
352 OicUuid_t subjectuuid; // 0:R:S:Y:uuid
353 OicSecRsrc_t *resources; // 1:R:M:Y:Resource
354 uint16_t permission; // 2:R:S:Y:UINT16
355 OicSecValidity_t *validities; // 3:R:M:N:Time-interval
360 * /oic/sec/acl (Access Control List) data type.
361 * Derived from OIC Security Spec; see Spec for details.
365 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
366 OicUuid_t rownerID; // 0:R:S:Y:oic.uuid
367 OicSecAce_t *aces; // 1:R:M:N:ACE
371 * /oic/sec/amacl (Access Manager Service Accesss Control List) data type.
372 * Derived from OIC Security Spec; see Spec for details.
376 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
377 size_t resourcesLen; // the number of elts in Resources
378 char **resources; // 0:R:M:Y:String
379 size_t amssLen; // the number of elts in Amss
380 OicUuid_t *amss; // 1:R:M:Y:acl
381 OicUuid_t rownerID; // 2:R:S:Y:oic.uuid
386 * /oic/sec/cred (Credential) data type.
387 * Derived from OIC Security Spec; see Spec for details.
391 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
392 uint16_t credId; // 0:R:S:Y:UINT16
393 OicUuid_t subject; // 1:R:S:Y:oic.uuid
394 //Note: Need further clarification on roleID data type
395 //NOTE: Need further clarification on roleId datatype.
396 //size_t roleIdsLen; // the number of elts in RoleIds
397 //OicSecRole_t *roleIds; // 2:R:M:N:oic.sec.role
398 OicSecCredType_t credType; // 3:R:S:Y:oic.sec.credtype
400 OicSecCert_t publicData; // chain of certificates
401 #endif /* __WITH_X509__ */
402 OicSecKey_t privateData; // 6:R:S:N:oic.sec.key
403 char *period; // 7:R:S:N:String
404 OicUuid_t rownerID; // 8:R:S:Y:oic.uuid
409 * /oic/sec/doxm (Device Owner Transfer Methods) data type
410 * Derived from OIC Security Spec; see Spec for details.
414 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
415 OicUrn_t *oxmType; // 0:R:M:N:URN
416 size_t oxmTypeLen; // the number of elts in OxmType
417 OicSecOxm_t *oxm; // 1:R:M:N:UINT16
418 size_t oxmLen; // the number of elts in Oxm
419 OicSecOxm_t oxmSel; // 2:R/W:S:Y:UINT16
420 OicSecCredType_t sct; // 3:R:S:Y:oic.sec.credtype
421 bool owned; // 4:R:S:Y:Boolean
422 //TODO: Need more clarification on deviceIDFormat field type.
423 //OicSecDvcIdFrmt_t deviceIDFormat; // 5:R:S:Y:UINT8
424 OicUuid_t deviceID; // 6:R:S:Y:oic.uuid
425 bool dpc; // 7:R:S:Y:Boolean
426 OicUuid_t owner; // 8:R:S:Y:oic.uuid
427 OicUuid_t rownerID; // 9:R:S:Y:oic.uuid
431 * /oic/sec/pstat (Provisioning Status) data type.
432 * NOTE: this struct is ahead of Spec v0.95 in definition to include Sm.
433 * TODO: change comment when reconciled to Spec v0.96.
437 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
438 bool isOp; // 0:R:S:Y:Boolean
439 OicSecDpm_t cm; // 1:R:S:Y:oic.sec.dpm
440 OicSecDpm_t tm; // 2:RW:S:Y:oic.sec.dpm
441 OicUuid_t deviceID; // 3:R:S:Y:oic.uuid
442 OicSecDpom_t om; // 4:RW:M:Y:oic.sec.dpom
443 size_t smLen; // the number of elts in Sm
444 OicSecDpom_t *sm; // 5:R:M:Y:oic.sec.dpom
445 uint16_t commitHash; // 6:R:S:Y:oic.sec.sha256
446 OicUuid_t rownerID; // 7:R:S:Y:oic.uuid
450 * /oic/sec/role (Role) data type.
451 * Derived from OIC Security Spec; see Spec for details.
455 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
456 //TODO fill in with Role definition
457 uint8_t id[ROLEID_LENGTH];
461 * /oic/sec/sacl (Signed Access Control List) data type.
462 * Derived from OIC Security Spec; see Spec for details.
466 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
467 //TODO fill in from OIC Security Spec
471 * /oic/sec/svc (Service requiring a secure connection) data type.
472 * Derived from OIC Security Spec; see Spec for details.
476 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
477 OicUuid_t svcdid; //0:R:S:Y:oic.uuid
478 OicSecSvcType_t svct; //1:R:M:Y:OIC Service Type
479 size_t ownersLen; //2:the number of elts in Owners
480 OicUuid_t *owners; //3:R:M:Y:oic.uuid
488 ByteArray ThisUpdate;
491 #endif /* __WITH_X509__ */
494 * @brief direct pairing data type
496 typedef struct OicPin OicDpPin_t;
498 typedef struct OicSecPdAcl OicSecPdAcl_t;
500 typedef struct OicSecPconf OicSecPconf_t;
502 typedef struct OicSecDpairing OicSecDpairing_t;
504 #define DP_PIN_LENGTH 8 // temporary length
507 * @brief /oic/sec/prmtype (Pairing Method Type) data type.
509 * 1: pre-configured pin
512 typedef enum PRMBitmask
514 PRM_NOT_ALLOWED = 0x0,
515 PRM_PRE_CONFIGURED = (0x1 << 0),
516 PRM_RANDOM_PIN = (0x1 << 1),
519 typedef PRMBitmask_t OicSecPrm_t;
524 uint8_t val[DP_PIN_LENGTH];
528 * @brief oic.sec.dpacltype (Device Pairing Access Control List) data type.
532 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
533 char **resources; // 0:R:M:Y:String
534 size_t resourcesLen; // the number of elts in Resources
535 uint16_t permission; // 1:R:S:Y:UINT16
536 char **periods; // 2:R:M*:N:String (<--M*; see Spec)
537 char **recurrences; // 3:R:M:N:String
538 size_t prdRecrLen; // the number of elts in Periods/Recurrences
543 * @brief /oic/sec/pconf (Pairing Configuration) data type
547 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
548 bool edp; // 0:W:S:M:Boolean
549 OicSecPrm_t *prm; // 1:R:M:N:UINT16
550 size_t prmLen; // the number of elts in Prm
551 OicDpPin_t pin; // 2:R:S:Y:String
552 OicSecPdAcl_t *pdacls; // 3:R:M:Y:oic.sec.pdacltype
553 OicUuid_t *pddevs; // 4:R:M:Y:oic.uuid
554 size_t pddevLen; // the number of elts in pddev
555 OicUuid_t deviceID; // 5:R:S:Y:oic.uuid
556 OicUuid_t rownerID; // 6:R:S:Y:oic.uuid
560 * @brief /oic/sec/dpairing (Device Pairing) data type
562 struct OicSecDpairing
564 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
565 OicSecPrm_t spm; // 0:R/W:S:Y:UINT16
566 OicUuid_t pdeviceID; // 1:R:S:Y:oic.uuid
567 OicUuid_t rownerID; // 2:R:S:Y:oic.uuid
570 #define MAX_VERSION_LEN 16 // Security Version length. i.e., 00.00.000 + reserved space
573 * @brief security version data type
575 typedef struct OicSecVer OicSecVer_t;
578 * @brief /oic/sec/ver (Security Version) data type
582 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
583 char secv[MAX_VERSION_LEN]; // 0:R:S:Y:String
584 OicUuid_t deviceID; // 1:R:S:Y:oic.uuid
591 #endif //OC_SECURITY_RESOURCE_TYPES_H