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 * @brief Values used to create bit-maskable enums for single-value
56 * response with embedded code.
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 OicSecAcl OicSecAcl_t;
167 typedef struct OicSecAmacl OicSecAmacl_t;
169 typedef struct OicSecCred OicSecCred_t;
172 * Aid for assigning/testing vals with OicSecCredType_t.
174 * OicSecCredType_t ct = PIN_PASSWORD | ASYMMETRIC_KEY;
175 * if((ct & PIN_PASSWORD) == PIN_PASSWORD)
177 * // ct contains PIN_PASSWORD flag.
180 typedef enum OSCTBitmask
182 NO_SECURITY_MODE = 0x0,
183 SYMMETRIC_PAIR_WISE_KEY = (0x1 << 0),
184 SYMMETRIC_GROUP_KEY = (0x1 << 1),
185 ASYMMETRIC_KEY = (0x1 << 2),
186 SIGNED_ASYMMETRIC_KEY = (0x1 << 3),
187 PIN_PASSWORD = (0x1 << 4),
188 ASYMMETRIC_ENCRYPTION_KEY = (0x1 << 5),
192 * @brief /oic/sec/credtype (Credential Type) data type.
193 * Derived from OIC Security Spec /oic/sec/cred; see Spec for details.
194 * 0: no security mode
195 * 1: symmetric pair-wise key
196 * 2: symmetric group key
198 * 8: signed asymmetric key (aka certificate)
201 typedef OSCTBitmask_t OicSecCredType_t;
203 typedef struct OicSecDoxm OicSecDoxm_t;
205 typedef enum OicSecDpm
209 TAKE_OWNER = (0x1 << 1),
210 BOOTSTRAP_SERVICE = (0x1 << 2),
211 SECURITY_MANAGEMENT_SERVICES = (0x1 << 3),
212 PROVISION_CREDENTIALS = (0x1 << 4),
213 PROVISION_ACLS = (0x1 << 5),
214 // << 6 THROUGH 15 RESERVED
217 typedef enum OicSecDpom
219 MULTIPLE_SERVICE_SERVER_DRIVEN = 0x0,
220 SINGLE_SERVICE_SERVER_DRIVEN = 0x1,
221 MULTIPLE_SERVICE_CLIENT_DRIVEN = 0x2,
222 SINGLE_SERVICE_CLIENT_DRIVEN = 0x3,
225 typedef enum OicSecSvcType
227 SERVICE_UNKNOWN = 0x0,
228 ACCESS_MGMT_SERVICE = 0x1, //urn:oic.sec.ams
232 //TODO: Need more clarification on deviceIDFormat field type.
242 OIC_JUST_WORKS = 0x0,
243 OIC_MODE_SWITCH = 0x1,
244 OIC_RANDOM_DEVICE_PIN = 0x2,
245 OIC_PRE_PROVISIONED_DEVICE_PIN = 0x3,
246 OIC_PRE_PROVISION_STRONG_CREDENTIAL = 0x4,
250 typedef struct OicSecJwk OicSecJwk_t;
252 typedef struct OicSecPstat OicSecPstat_t;
254 typedef struct OicSecRole OicSecRole_t;
256 typedef struct OicSecSacl OicSecSacl_t;
258 typedef struct OicSecSvc OicSecSvc_t;
260 typedef char *OicUrn_t; //TODO is URN type defined elsewhere?
262 typedef struct OicUuid OicUuid_t; //TODO is UUID type defined elsewhere?
266 typedef struct OicSecCrl OicSecCrl_t;
267 #endif /* __WITH_X509__ */
270 * @brief /oic/uuid (Universal Unique Identifier) data type.
272 #define UUID_LENGTH 128/8 // 128-bit GUID length
273 //TODO: Confirm the length and type of ROLEID.
274 #define ROLEID_LENGTH 128/8 // 128-bit ROLEID length
275 #define OWNER_PSK_LENGTH_128 128/8 //byte size of 128-bit key size
276 #define OWNER_PSK_LENGTH_256 256/8 //byte size of 256-bit key size
280 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
281 //TODO fill in unless this is defined elsewhere?
282 uint8_t id[UUID_LENGTH];
286 * @brief /oic/sec/jwk (JSON Web Key) data type.
287 * See JSON Web Key (JWK) draft-ietf-jose-json-web-key-41
289 #define JWK_LENGTH 256/8 // 256 bit key length
296 * @brief /oic/sec/acl (Access Control List) data type.
297 * Derived from OIC Security Spec; see Spec for details.
301 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
302 OicUuid_t subject; // 0:R:S:Y:uuid TODO: this deviates
303 // from spec and needs to be updated
304 // in spec (where it's a String).
305 size_t resourcesLen; // the number of elts in Resources
306 char **resources; // 1:R:M:Y:String
307 uint16_t permission; // 2:R:S:Y:UINT16
308 size_t prdRecrLen; // the number of elts in Periods
309 char **periods; // 3:R:M*:N:String (<--M*; see Spec)
310 char **recurrences; // 5:R:M:N:String
311 size_t ownersLen; // the number of elts in Owners
312 OicUuid_t *owners; // 8:R:M:Y:oic.uuid
313 // NOTE: we are using UUID for Owners instead of Svc type for mid-April
314 // SRM version only; this will change to Svc type for full implementation.
315 //TODO change Owners type to oic.sec.svc
316 //OicSecSvc_t *Owners; // 6:R:M:Y:oic.sec.svc
321 * @brief /oic/sec/amacl (Access Manager Service Accesss Control List)
323 * Derived from OIC Security Spec; see Spec for details.
327 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
328 size_t resourcesLen; // the number of elts in Resources
329 char **resources; // 0:R:M:Y:String
330 size_t amssLen; // the number of elts in Amss
331 OicUuid_t *amss; // 1:R:M:Y:acl
332 size_t ownersLen; // the number of elts in Owners
333 OicUuid_t *owners; // 2:R:M:Y:oic.uuid
334 // NOTE: we are using UUID for Owners instead of Svc type for mid-April
335 // SRM version only; this will change to Svc type for full implementation.
336 //TODO change Owners type to oic.sec.svc
337 //OicSecSvc_t *Owners; // 2:R:M:Y:oic.sec.svc
342 * @brief /oic/sec/cred (Credential) data type.
343 * Derived from OIC Security Spec; see Spec for details.
347 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
348 uint16_t credId; // 0:R:S:Y:UINT16
349 OicUuid_t subject; // 1:R:S:Y:oic.uuid
350 //Note: Need further clarification on roleID data type
351 //NOTE: Need further clarification on roleId datatype.
352 //size_t roleIdsLen; // the number of elts in RoleIds
353 //OicSecRole_t *roleIds; // 2:R:M:N:oic.sec.role
354 OicSecCredType_t credType; // 3:R:S:Y:oic.sec.credtype
355 OicSecJwk_t publicData; // 5:R:S:N:oic.sec.jwk
356 OicSecJwk_t privateData; // 6:R:S:N:oic.sec.jwk
357 char *period; // 7:R:S:N:String
358 size_t ownersLen; // the number of elts in Owners
359 OicUuid_t *owners; // 8:R:M:Y:oic.uuid
360 // NOTE: we are using UUID for Owners instead of Svc type for mid-April
361 // SRM version only; this will change to Svc type for full implementation.
362 //OicSecSvc_t *Owners; // 8:R:M:Y:oic.sec.svc
363 //TODO change Owners type to oic.sec.svc
368 * @brief /oic/sec/doxm (Device Owner Transfer Methods) data type
369 * Derived from OIC Security Spec; see Spec for details.
373 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
374 OicUrn_t *oxmType; // 0:R:M:N:URN
375 size_t oxmTypeLen; // the number of elts in OxmType
376 OicSecOxm_t *oxm; // 1:R:M:N:UINT16
377 size_t oxmLen; // the number of elts in Oxm
378 OicSecOxm_t oxmSel; // 2:R/W:S:Y:UINT16
379 OicSecCredType_t sct; // 3:R:S:Y:oic.sec.credtype
380 bool owned; // 4:R:S:Y:Boolean
381 //TODO: Need more clarification on deviceIDFormat field type.
382 //OicSecDvcIdFrmt_t deviceIDFormat; // 5:R:S:Y:UINT8
383 OicUuid_t deviceID; // 6:R:S:Y:oic.uuid
384 OicUuid_t owner; // 7:R:S:Y:oic.uuid
385 // NOTE: we are using UUID for Owner instead of Svc type for mid-April
386 // SRM version only; this will change to Svc type for full implementation.
387 //OicSecSvc_t devOwner; // 7:R:S:Y:oic.sec.svc
388 //OicSecSvc_t rOwner; // 8:R:S:Y:oic.sec.svc
389 //TODO change Owner type to oic.sec.svc
393 * @brief /oic/sec/pstat (Provisioning Status) data type.
394 * NOTE: this struct is ahead of Spec v0.95 in definition to include Sm.
395 * TODO: change comment when reconciled to Spec v0.96.
399 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
400 bool isOp; // 0:R:S:Y:Boolean
401 OicSecDpm_t cm; // 1:R:S:Y:oic.sec.dpm
402 OicSecDpm_t tm; // 2:RW:S:Y:oic.sec.dpm
403 OicUuid_t deviceID; // 3:R:S:Y:oic.uuid
404 OicSecDpom_t om; // 4:RW:M:Y:oic.sec.dpom
405 size_t smLen; // the number of elts in Sm
406 OicSecDpom_t *sm; // 5:R:M:Y:oic.sec.dpom
407 uint16_t commitHash; // 6:R:S:Y:oic.sec.sha256
408 //TODO: this is supposed to be a 256-bit uint; temporarily use uint16_t
409 //TODO: need to decide which 256 bit and 128 bit types to use... boost?
413 * @brief /oic/sec/role (Role) data type.
414 * Derived from OIC Security Spec; see Spec for details.
418 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
419 //TODO fill in with Role definition
420 uint8_t id[ROLEID_LENGTH];
424 * @brief /oic/sec/sacl (Signed Access Control List) data type.
425 * Derived from OIC Security Spec; see Spec for details.
429 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
430 //TODO fill in from OIC Security Spec
434 * @brief /oic/sec/svc (Service requiring a secure connection) data type.
435 * Derived from OIC Security Spec; see Spec for details.
439 // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
440 OicUuid_t svcdid; //0:R:S:Y:oic.uuid
441 OicSecSvcType_t svct; //1:R:M:Y:OIC Service Type
442 size_t ownersLen; //2:the number of elts in Owners
443 OicUuid_t *owners; //3:R:M:Y:oic.uuid
451 ByteArray ThisUpdate;
454 #endif /* __WITH_X509__ */
460 #endif //OC_SECURITY_RESOURCE_TYPES_H