resource/csdk/security/include/securevirtualresourcetypes.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 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  * Data type definitions for all oic.sec.* types defined in the
  23  * OIC Security Specification.
  24  *
  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.
  32  *
  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).
  36  *
  37  * TODO reconcile against latest OIC Security Spec to ensure all fields correct.
  38  * (Last checked against v0.95)
  39  */
  40
  41 #ifndef OC_SECURITY_RESOURCE_TYPES_H
  42 #define OC_SECURITY_RESOURCE_TYPES_H
  43
  44 #include <stdint.h> // for uint8_t typedef
  45 #include <stdbool.h>
  46 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
  47 #include "byte_array.h"
  48 #endif /* __WITH_X509__  or __WITH_TLS__*/
  49
  50 #include "platform_features.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 /**
  57  * Values used to create bit-maskable enums for single-value response with
  58  * embedded code.
  59  */
  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)
  74
  75
  76 /**
  77  * Access policy in least significant bits (from Spec):
  78  * 1st lsb:  C (Create)
  79  * 2nd lsb:  R (Read, Observe, Discover)
  80  * 3rd lsb:  U (Write, Update)
  81  * 4th lsb:  D (Delete)
  82  * 5th lsb:  N (Notify)
  83  */
  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 | \
  90                                  PERMISSION_READ | \
  91                                  PERMISSION_WRITE | \
  92                                  PERMISSION_DELETE | \
  93                                  PERMISSION_NOTIFY)
  94
  95 /**
  96  * @brief   Response type for all Action requests from CA layer;
  97  *          may include a reason code.
  98  *
  99  * To extract codes use GetReasonCode function on SRMAccessResponse:
 100  *
 101  * SRMAccessResponse_t response = SRMRequestHandler(obj, info);
 102  * if(SRM_TRUE == IsAccessGranted(response)) {
 103  *     SRMAccessResponseReasonCode_t reason = GetReasonCode(response);
 104  *     switch(reason) {
 105  *         case INSUFFICIENT_PERMISSION:
 106  *         ...etc.
 107  *     }
 108  * }
 109  */
 110 typedef enum
 111 {
 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
 125         | AMS_SERVICE_DEF,
 126     ACCESS_DENIED_AMS_SERVICE_ERROR = ACCESS_DENIED
 127         | AMS_SERVICE_DEF
 128 } SRMAccessResponse_t;
 129
 130 /**
 131  * Reason code for SRMAccessResponse.
 132  */
 133 typedef enum
 134 {
 135     NO_REASON_GIVEN = 0,
 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;
 140
 141 /**
 142  * Extract Reason Code from Access Response.
 143  */
 144 INLINE_API SRMAccessResponseReasonCode_t GetReasonCode(
 145     SRMAccessResponse_t response)
 146 {
 147     SRMAccessResponseReasonCode_t reason =
 148         (SRMAccessResponseReasonCode_t)(response & REASON_MASK_DEF);
 149     return reason;
 150 }
 151
 152 /**
 153  * Returns 'true' iff request should be passed on to RI layer.
 154  */
 155 INLINE_API bool IsAccessGranted(SRMAccessResponse_t response)
 156 {
 157     if(ACCESS_GRANTED == (response & ACCESS_GRANTED))
 158     {
 159         return true;
 160     }
 161     else
 162     {
 163         return false;
 164     }
 165 }
 166
 167 typedef struct OicSecRsrc OicSecRsrc_t;
 168
 169 typedef struct OicSecValidity OicSecValidity_t;
 170
 171 typedef struct OicSecAce OicSecAce_t;
 172
 173 typedef struct OicSecAcl OicSecAcl_t;
 174
 175 typedef struct OicSecAmacl OicSecAmacl_t;
 176
 177 typedef struct OicSecCred OicSecCred_t;
 178
 179 /**
 180  * Aid for assigning/testing vals with OicSecCredType_t.
 181  * Example:
 182  *  OicSecCredType_t ct = PIN_PASSWORD | ASYMMETRIC_KEY;
 183  *  if((ct & PIN_PASSWORD) == PIN_PASSWORD)
 184  *  {
 185  *      // ct contains PIN_PASSWORD flag.
 186  *  }
 187  */
 188 typedef enum OSCTBitmask
 189 {
 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),
 197 } OSCTBitmask_t;
 198
 199 /**
 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
 205  *              4:  asymmetric key
 206  *              8:  signed asymmetric key (aka certificate)
 207  *              16: PIN /password
 208  */
 209 typedef OSCTBitmask_t OicSecCredType_t;
 210
 211 typedef struct OicSecDoxm OicSecDoxm_t;
 212
 213 typedef enum OicSecDpm
 214 {
 215     NORMAL                          = 0x0,
 216     RESET                           = (0x1 << 0),
 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
 223 } OicSecDpm_t;
 224
 225 typedef enum OicSecDpom
 226 {
 227     MULTIPLE_SERVICE_SERVER_DRIVEN  = 0x0,
 228     SINGLE_SERVICE_SERVER_DRIVEN    = 0x1,
 229     MULTIPLE_SERVICE_CLIENT_DRIVEN  = 0x2,
 230     SINGLE_SERVICE_CLIENT_DRIVEN    = 0x3,
 231 } OicSecDpom_t;
 232
 233 typedef enum OicSecSvcType
 234 {
 235     SERVICE_UNKNOWN                 = 0x0,
 236     ACCESS_MGMT_SERVICE             = 0x1,  //urn:oic.sec.ams
 237 } OicSecSvcType_t;
 238
 239
 240 //TODO: Need more clarification on deviceIDFormat field type.
 241 #if 0
 242 typedef enum
 243 {
 244     URN = 0x0
 245 }OicSecDvcIdFrmt_t;
 246 #endif
 247
 248 typedef enum
 249 {
 250     OIC_R_ACL_TYPE = 0,
 251     OIC_R_AMACL_TYPE,
 252     OIC_R_CRED_TYPE,
 253     OIC_R_CRL_TYPE,
 254     OIC_R_DOXM_TYPE,
 255     OIC_R_DPAIRING_TYPE,
 256     OIC_R_PCONF_TYPE,
 257     OIC_R_PSTAT_TYPE,
 258     OIC_R_SACL_TYPE,
 259     OIC_R_SVC_TYPE,
 260     OIC_SEC_SVR_TYPE_COUNT, //define the value to number of SVR
 261     NOT_A_SVR_RESOURCE = 99
 262 }OicSecSvrType_t;
 263
 264 typedef enum
 265 {
 266     OIC_JUST_WORKS                          = 0x0,
 267     OIC_RANDOM_DEVICE_PIN                   = 0x1,
 268     OIC_MANUFACTURER_CERTIFICATE           = 0x2,
 269     OIC_OXM_COUNT
 270 }OicSecOxm_t;
 271
 272 typedef enum
 273 {
 274     OIC_ENCODING_UNKNOW = 0,
 275     OIC_ENCODING_RAW = 1,
 276     OIC_ENCODING_BASE64 = 2
 277 }OicEncodingType_t;
 278
 279 typedef struct OicSecKey OicSecKey_t;
 280
 281 typedef struct OicSecPstat OicSecPstat_t;
 282
 283 typedef struct OicSecRole OicSecRole_t;
 284
 285 typedef struct OicSecSacl OicSecSacl_t;
 286
 287 typedef struct OicSecSvc OicSecSvc_t;
 288
 289 typedef char *OicUrn_t; //TODO is URN type defined elsewhere?
 290
 291 typedef struct OicUuid OicUuid_t; //TODO is UUID type defined elsewhere?
 292
 293
 294 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
 295 typedef struct OicSecCrl OicSecCrl_t;
 296 typedef ByteArray OicSecCert_t;
 297 #else
 298 typedef void OicSecCert_t;
 299 #endif /* __WITH_X509__ or __WITH_TLS__*/
 300
 301 /**
 302  * /oic/uuid (Universal Unique Identifier) data type.
 303  */
 304 #define UUID_LENGTH 128/8 // 128-bit GUID length
 305 //TODO: Confirm the length and type of ROLEID.
 306 #define ROLEID_LENGTH 128/8 // 128-bit ROLEID length
 307 #define OWNER_PSK_LENGTH_128 128/8 //byte size of 128-bit key size
 308 #define OWNER_PSK_LENGTH_256 256/8 //byte size of 256-bit key size
 309
 310 struct OicUuid
 311 {
 312     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 313     //TODO fill in unless this is defined elsewhere?
 314     uint8_t             id[UUID_LENGTH];
 315 };
 316
 317 /**
 318  * /oic/sec/jwk (JSON Web Key) data type.
 319  * See JSON Web Key (JWK)  draft-ietf-jose-json-web-key-41
 320  */
 321 #define JWK_LENGTH 256/8 // 256 bit key length
 322 struct OicSecKey
 323 {
 324     uint8_t                *data;
 325     size_t                  len;
 326
 327     // TODO: This field added as workaround. Will be replaced soon.
 328     OicEncodingType_t encoding;
 329
 330 };
 331
 332 struct OicSecRsrc
 333 {
 334     char *href; // 0:R:S:Y:String
 335     char *rel; // 1:R:S:N:String
 336     char** types; // 2:R:S:N:String Array
 337     size_t typeLen; // the number of elts in types
 338     char** interfaces; // 3:R:S:N:String Array
 339     size_t interfaceLen; // the number of elts in interfaces
 340     OicSecRsrc_t *next;
 341 };
 342
 343 struct OicSecValidity
 344 {
 345     char* period; // 0:R:S:Y:String
 346     char** recurrences; // 1:R:M:Y:Array of String
 347     size_t recurrenceLen; // the number of elts in recurrence
 348     OicSecValidity_t *next;
 349 };
 350
 351 struct OicSecAce
 352 {
 353     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 354     OicUuid_t subjectuuid; // 0:R:S:Y:uuid
 355     OicSecRsrc_t *resources; // 1:R:M:Y:Resource
 356     uint16_t permission; // 2:R:S:Y:UINT16
 357     OicSecValidity_t *validities; // 3:R:M:N:Time-interval
 358     OicSecAce_t *next;
 359 };
 360
 361 /**
 362  * /oic/sec/acl (Access Control List) data type.
 363  * Derived from OIC Security Spec; see Spec for details.
 364  */
 365 struct OicSecAcl
 366 {
 367     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 368     OicUuid_t           rownerID;        // 0:R:S:Y:oic.uuid
 369     OicSecAce_t         *aces; // 1:R:M:N:ACE
 370 };
 371
 372 /**
 373  * /oic/sec/amacl (Access Manager Service Accesss Control List) data type.
 374  * Derived from OIC Security Spec; see Spec for details.
 375  */
 376 struct OicSecAmacl
 377 {
 378     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 379     size_t              resourcesLen;   // the number of elts in Resources
 380     char                **resources;    // 0:R:M:Y:String
 381     size_t              amssLen;        // the number of elts in Amss
 382     OicUuid_t           *amss;          // 1:R:M:Y:acl
 383     OicUuid_t           rownerID;        // 2:R:S:Y:oic.uuid
 384     OicSecAmacl_t         *next;
 385 };
 386
 387 /**
 388  * /oic/sec/cred (Credential) data type.
 389  * Derived from OIC Security Spec; see Spec for details.
 390  */
 391 struct OicSecCred
 392 {
 393     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 394     uint16_t            credId;         // 0:R:S:Y:UINT16
 395     OicUuid_t           subject;        // 1:R:S:Y:oic.uuid
 396     //Note: Need further clarification on roleID data type
 397     //NOTE: Need further clarification on roleId datatype.
 398     //size_t              roleIdsLen;     // the number of elts in RoleIds
 399     //OicSecRole_t        *roleIds;       // 2:R:M:N:oic.sec.role
 400     OicSecCredType_t    credType;       // 3:R:S:Y:oic.sec.credtype
 401 #if defined(__WITH_X509__) || defined(__WITH_TLS__)
 402     OicSecCert_t        publicData;     // own cerificate chain
 403     OicSecCert_t        optionalData;   // CA's cerificate chain
 404 #endif /* __WITH_X509__  or __WITH_TLS__*/
 405     OicSecKey_t         privateData;    // 6:R:S:N:oic.sec.key
 406     char                *period;        // 7:R:S:N:String
 407     OicUuid_t           rownerID;        // 8:R:S:Y:oic.uuid
 408     OicSecCred_t        *next;
 409 };
 410
 411 /**
 412  * /oic/sec/doxm (Device Owner Transfer Methods) data type
 413  * Derived from OIC Security Spec; see Spec for details.
 414  */
 415 struct OicSecDoxm
 416 {
 417     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 418     OicUrn_t            *oxmType;       // 0:R:M:N:URN
 419     size_t              oxmTypeLen;     // the number of elts in OxmType
 420     OicSecOxm_t         *oxm;           // 1:R:M:N:UINT16
 421     size_t              oxmLen;         // the number of elts in Oxm
 422     OicSecOxm_t         oxmSel;         // 2:R/W:S:Y:UINT16
 423     OicSecCredType_t    sct;            // 3:R:S:Y:oic.sec.credtype
 424     bool                owned;          // 4:R:S:Y:Boolean
 425     //TODO: Need more clarification on deviceIDFormat field type.
 426     //OicSecDvcIdFrmt_t   deviceIDFormat; // 5:R:S:Y:UINT8
 427     OicUuid_t           deviceID;       // 6:R:S:Y:oic.uuid
 428     bool                dpc;            // 7:R:S:Y:Boolean
 429     OicUuid_t           owner;          // 8:R:S:Y:oic.uuid
 430     OicUuid_t           rownerID;       // 9:R:S:Y:oic.uuid
 431 };
 432
 433 /**
 434  * /oic/sec/pstat (Provisioning Status) data type.
 435  * NOTE: this struct is ahead of Spec v0.95 in definition to include Sm.
 436  * TODO: change comment when reconciled to Spec v0.96.
 437  */
 438 struct OicSecPstat
 439 {
 440     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 441     bool                isOp;           // 0:R:S:Y:Boolean
 442     OicSecDpm_t         cm;             // 1:R:S:Y:oic.sec.dpm
 443     OicSecDpm_t         tm;             // 2:RW:S:Y:oic.sec.dpm
 444     OicUuid_t           deviceID;       // 3:R:S:Y:oic.uuid
 445     OicSecDpom_t        om;             // 4:RW:M:Y:oic.sec.dpom
 446     size_t              smLen;          // the number of elts in Sm
 447     OicSecDpom_t        *sm;            // 5:R:M:Y:oic.sec.dpom
 448     uint16_t            commitHash;     // 6:R:S:Y:oic.sec.sha256
 449     OicUuid_t           rownerID;       // 7:R:S:Y:oic.uuid
 450 };
 451
 452 /**
 453  * /oic/sec/role (Role) data type.
 454  * Derived from OIC Security Spec; see Spec for details.
 455  */
 456 struct OicSecRole
 457 {
 458     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 459     //TODO fill in with Role definition
 460     uint8_t             id[ROLEID_LENGTH];
 461 };
 462
 463 /**
 464  * /oic/sec/sacl (Signed Access Control List) data type.
 465  * Derived from OIC Security Spec; see Spec for details.
 466  */
 467 struct OicSecSacl
 468 {
 469     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 470     //TODO fill in from OIC Security Spec
 471 #if defined(_MSC_VER)
 472     uint8_t unused; // VS doesn't like empty structs
 473 #endif
 474 };
 475
 476 /**
 477  * /oic/sec/svc (Service requiring a secure connection) data type.
 478  * Derived from OIC Security Spec; see Spec for details.
 479  */
 480 struct OicSecSvc
 481 {
 482     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 483     OicUuid_t               svcdid;                 //0:R:S:Y:oic.uuid
 484     OicSecSvcType_t         svct;                   //1:R:M:Y:OIC Service Type
 485     size_t                  ownersLen;              //2:the number of elts in Owners
 486     OicUuid_t               *owners;                //3:R:M:Y:oic.uuid
 487     OicSecSvc_t             *next;
 488 };
 489
 490 #if defined(__WITH_X509__) ||  defined(__WITH_TLS__)
 491 struct OicSecCrl
 492 {
 493     uint16_t CrlId;
 494     ByteArray ThisUpdate;
 495     ByteArray CrlData;
 496 };
 497 #endif /* __WITH_X509__ or __WITH_TLS__ */
 498
 499 /**
 500  * @brief   direct pairing data type
 501  */
 502 typedef struct OicPin OicDpPin_t;
 503
 504 typedef struct OicSecPdAcl OicSecPdAcl_t;
 505
 506 typedef struct OicSecPconf OicSecPconf_t;
 507
 508 typedef struct OicSecDpairing OicSecDpairing_t;
 509
 510 #define DP_PIN_LENGTH 8 // temporary length
 511
 512 /**
 513  * @brief   /oic/sec/prmtype (Pairing Method Type) data type.
 514  *              0:  not allowed
 515  *              1:  pre-configured pin
 516  *              2:  random pin
 517  */
 518 typedef enum PRMBitmask
 519 {
 520     PRM_NOT_ALLOWED             = 0x0,
 521     PRM_PRE_CONFIGURED        = (0x1 << 0),
 522     PRM_RANDOM_PIN               = (0x1 << 1),
 523 } PRMBitmask_t;
 524
 525 typedef PRMBitmask_t OicSecPrm_t;
 526
 527
 528 struct OicPin
 529 {
 530     uint8_t             val[DP_PIN_LENGTH];
 531 };
 532
 533 /**
 534  * @brief   oic.sec.dpacltype (Device Pairing Access Control List) data type.
 535  */
 536 struct OicSecPdAcl
 537 {
 538     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 539     char                  **resources;        // 0:R:M:Y:String
 540     size_t                resourcesLen;      // the number of elts in Resources
 541     uint16_t             permission;        // 1:R:S:Y:UINT16
 542     char                  **periods;            // 2:R:M*:N:String (<--M*; see Spec)
 543     char                  **recurrences;    // 3:R:M:N:String
 544     size_t                prdRecrLen;         // the number of elts in Periods/Recurrences
 545     OicSecPdAcl_t    *next;
 546 };
 547
 548 /**
 549  * @brief   /oic/sec/pconf (Pairing Configuration) data type
 550  */
 551 struct OicSecPconf
 552 {
 553     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 554     bool                  edp;                // 0:W:S:M:Boolean
 555     OicSecPrm_t      *prm;              // 1:R:M:N:UINT16
 556     size_t                prmLen;          // the number of elts in Prm
 557     OicDpPin_t          pin;               // 2:R:S:Y:String
 558     OicSecPdAcl_t    *pdacls;         // 3:R:M:Y:oic.sec.pdacltype
 559     OicUuid_t           *pddevs;        // 4:R:M:Y:oic.uuid
 560     size_t                 pddevLen;     // the number of elts in pddev
 561     OicUuid_t           deviceID;       // 5:R:S:Y:oic.uuid
 562     OicUuid_t           rownerID;          // 6:R:S:Y:oic.uuid
 563 };
 564
 565 /**
 566  * @brief   /oic/sec/dpairing (Device Pairing) data type
 567  */
 568 struct OicSecDpairing
 569 {
 570     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 571     OicSecPrm_t      spm;               // 0:R/W:S:Y:UINT16
 572     OicUuid_t           pdeviceID;     // 1:R:S:Y:oic.uuid
 573     OicUuid_t           rownerID;          // 2:R:S:Y:oic.uuid
 574 };
 575
 576 #define MAX_VERSION_LEN 16 // Security Version length. i.e., 00.00.000 + reserved space
 577
 578 /**
 579  * @brief   security version data type
 580  */
 581 typedef struct OicSecVer OicSecVer_t;
 582
 583 /**
 584  * @brief   /oic/sec/ver (Security Version) data type
 585  */
 586 struct OicSecVer
 587 {
 588     // <Attribute ID>:<Read/Write>:<Multiple/Single>:<Mandatory?>:<Type>
 589     char              secv[MAX_VERSION_LEN];          // 0:R:S:Y:String
 590     OicUuid_t       deviceID;     // 1:R:S:Y:oic.uuid
 591 };
 592
 593 #ifdef __cplusplus
 594 }
 595 #endif
 596
 597 #endif //OC_SECURITY_RESOURCE_TYPES_H