/usr/include/x86_64-linux-gnu/alljoyn/PermissionPolicy.h is in liballjoyn-dev-1604 16.04a+dfsg.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 | #ifndef _ALLJOYN_PERMISSION_POLICY_H
#define _ALLJOYN_PERMISSION_POLICY_H
/**
* @file
* This file defines the Permission Policy classes that provide the interface to
* parse the authorization data
*/
/******************************************************************************
* Copyright AllSeen Alliance. All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
******************************************************************************/
#ifndef __cplusplus
#error Only include PermissionPolicy.h in C++ code.
#endif
#include <qcc/platform.h>
#include <qcc/String.h>
#include <qcc/KeyInfoECC.h>
#include <qcc/GUID.h>
#include <qcc/CertificateECC.h>
#include <alljoyn/Status.h>
#include <alljoyn/MsgArg.h>
#include <alljoyn/Message.h>
#include <vector>
#include <string>
namespace ajn {
/**
* Class to allow the application to specify a permission policy
*/
class PermissionPolicy {
public:
/**
* The current specification version.
*/
static const uint16_t SPEC_VERSION = 1;
/**
* Class to allow the application to specify a permission rule
*/
class Rule {
public:
/**
* Class to allow the application to specify a permission rule at the interface member level
*/
class Member {
public:
/**
* Enumeration for the different type of members
*/
typedef enum {
NOT_SPECIFIED = 0, ///< not specified
METHOD_CALL = 1, ///< method call
SIGNAL = 2, ///< signal
PROPERTY = 3 ///< property
} MemberType;
/**
* The permission action masks
*/
static const uint8_t ACTION_PROVIDE = 0x01; /** < allow to provide */
static const uint8_t ACTION_OBSERVE = 0x02; /** < allow to observe */
static const uint8_t ACTION_MODIFY = 0x04; /** < allow to modify */
/**
* Constructor
*
*/
Member() : memberName(), memberType(NOT_SPECIFIED), actionMask(0)
{
}
/**
* virtual destructor
*/
virtual ~Member()
{
}
/**
* Set the MemberName, MemberType and action mask
*
* @param[in] memberName the name of the interface member
* @param[in] memberType the type of member
* @param[in] actionMask the permission action mask
*/
void Set(const qcc::String& memberName, MemberType memberType, uint8_t actionMask);
/**
* Set the MemberName
* @param[in] memberName the name of the interface member
*/
void SetMemberName(const qcc::String& memberName);
/**
* Get the MemberName
* @return the MemberName
*/
const qcc::String GetMemberName() const;
/**
* Set the MemberType
* @param[in] memberType the type of the member
*/
void SetMemberType(MemberType memberType);
/**
* Get the MemberType
* @return the MemberType
*/
const MemberType GetMemberType() const;
/**
* Set the ActionMask
* param[in] actionMask Action mask value
*/
void SetActionMask(uint8_t actionMask);
/**
* Get the ActionMask
* @return the ActionMask
*/
const uint8_t GetActionMask() const;
/**
* A String representation of the Member
*
* @param indent Number of space chars to indent the start of each line
*
* @return A String representation of the Member
*/
qcc::String ToString(size_t indent = 0) const;
/**
* Comparison operators equality
* @param[in] other right hand side Member
* @return true if Members are equal
*/
bool operator==(const Member& other) const;
/**
* Comparison operators non-equality
* @param[in] other right hand side Member
* @return true if Members are not equal
*/
bool operator!=(const Member& other) const;
private:
qcc::String memberName;
MemberType memberType;
uint8_t actionMask;
};
/**
* Constructor
*
*/
Rule() : objPath("*"), interfaceName(), members(NULL), membersSize(0)
{
}
/**
* virtual destructor
*/
virtual ~Rule()
{
delete [] members;
}
/**
* Set the object path
* @param[in] objPath the object path
*/
void SetObjPath(const qcc::String& objPath);
/**
* Get the Object Path
* @return the Object Path
*/
const qcc::String GetObjPath() const;
/**
* Set the Interface Name
* @param[in] interfaceName the interface name.
*/
void SetInterfaceName(const qcc::String& interfaceName);
/**
* Get the InterfaceName
* @return the interface name
*/
const qcc::String GetInterfaceName() const;
/**
* Set the array of members for the given interface.
* @param[in] count the size of the array
* @param[in] members The array of member fields.
*/
void SetMembers(size_t count, Member* members);
/**
* Get the array of inferface members.
* @return the array of interface members.
*/
const Member* GetMembers() const;
/**
* Get the number of Members in the Rule
* @return the number of Members in the rule.
*/
const size_t GetMembersSize() const;
/**
* String representation of the Rule
*
* @param indent Number of space chars to indent the start of each line
*
* @return string representation of the rule
*/
qcc::String ToString(size_t indent = 0) const;
/**
* Comparison operators equality
* @param[in] other right hand side Rule
* @return true if Rules are equal
*/
bool operator==(const Rule& other) const;
/**
* Comparison operators non-equality
* @param[in] other right hand side Rule
* @return true if Rules are not equal
*/
bool operator!=(const Rule& other) const;
/**
* Assignment operator for Rule
*/
Rule& operator=(const Rule& other);
/**
* Copy constructor for Rule
*/
Rule(const Rule& other);
private:
qcc::String objPath;
qcc::String interfaceName;
Member* members;
size_t membersSize;
};
/**
* Class to allow the application to specify a permission peer
*/
class Peer {
public:
/**
* Enumeration for the different types of peer
*/
typedef enum {
PEER_ALL = 0, ///< all peers including anonymous peers
PEER_ANY_TRUSTED = 1, ///< any peer trusted by the application
PEER_FROM_CERTIFICATE_AUTHORITY = 2, ///< peers with identity certificates issued by the specified certificate authority
PEER_WITH_PUBLIC_KEY = 3, ///< peer identified by specific public key
PEER_WITH_MEMBERSHIP = 4 ///< all members of a security group
} PeerType;
/**
* Constructor
*
*/
Peer() : type(PEER_ANY_TRUSTED), securityGroupId(0), keyInfo(NULL)
{
}
/**
* virtual destructor
*/
virtual ~Peer()
{
delete keyInfo;
}
/**
* Set the peer type
*/
void SetType(PeerType peerType);
/**
* Get the peer type
*/
const PeerType GetType() const;
/**
* Set the security group id
* @param guid the security group id
*/
void SetSecurityGroupId(const qcc::GUID128& guid);
/**
* Get the security group id
* @return the security group id
*/
const qcc::GUID128& GetSecurityGroupId() const;
/**
* Set the keyInfo field.
* When peer type is PEER_ALL the keyInfo is not relevant.
* When peer type is PEER_ANY_TRUSTED the keyInfo is not relevant.
* When peer type is PEER_FROM_CERTIFICATE_AUTHORITY the
* keyInfo.PublicKey is the public key of the certificate authority.
* When peer type is PEER_WITH_PUBLIC_KEY the keyInfo.PublicKey is
* the public key of the peer.
* When peer type is PEER_WITH_MEMBERSHIP the keyInfo.PublicKey is the
* public key of the security group authority.
* @param[in] keyInfo the keyInfo. Set to NULL to removed keyInfo.
*/
void SetKeyInfo(const qcc::KeyInfoNISTP256* keyInfo);
/**
* Get the keyInfo field.
* @return keyInfo the keyInfo.
*/
const qcc::KeyInfoNISTP256* GetKeyInfo() const;
/**
* A String representation of the Peer
*
* @param indent Number of space chars to indent the start of each line
*
* @return A String representation of the Peer
*/
qcc::String ToString(size_t indent = 0) const;
/**
* Comparison operators equality
* @param[in] other right hand side Peer
* @return true is Peers are equal
*/
bool operator==(const Peer& other) const;
/**
* Comparison operators non-equality
* @param[in] other right hand side Peer
* @return true if Peers are not equal
*/
bool operator!=(const Peer& other) const;
/**
* Assignment operator for Peer
* @param[in] other right hand side of the `=` operator
*/
Peer& operator=(const Peer& other);
/**
* Copy constructor for Peer
* @param[in] other the Peer to copy
*/
Peer(const Peer& other);
private:
PeerType type;
qcc::GUID128 securityGroupId;
qcc::KeyInfoNISTP256* keyInfo;
};
/**
* Class to allow the application to specify an access control list
*/
class Acl {
public:
/**
* Constructor
*
*/
Acl() : peersSize(0), peers(NULL), rulesSize(0), rules(NULL)
{
}
/**
* virtual destructor
*/
virtual ~Acl()
{
delete [] peers;
delete [] rules;
}
/**
* Set the array of peers
* @param[in] count the number of peers
* @param[in] peers the array of peers.
*/
void SetPeers(size_t count, const Peer* peers);
/**
* Get the number of Peers in the Acl
* @return the number of Peers in the Acl
*/
const size_t GetPeersSize() const;
/**
* Get a pointer to the Peers array stored in the Acl
*/
const Peer* GetPeers() const;
/**
* Set the array of rules.
* @param[in] count the number of rules
* @param[in] rules the array of rules.
*/
void SetRules(size_t count, const Rule* rules);
/**
* Get the number of Rules in the Acl
* @return the number of Rules in the Acl
*/
const size_t GetRulesSize() const;
/**
* Get a pointer to the Rules array stored in the Acl
*/
const Rule* GetRules() const;
/**
* Get a string representation of the Acl
*
* @param indent Number of space chars to indent the start of each line
*
* @return a string representation of the Acl
*/
qcc::String ToString(size_t indent = 0) const;
/**
* Comparison operators equality
* @param[in] other right hand side Acl
* @return true if Acls are equal
*/
bool operator==(const Acl& other) const;
/**
* Comparison operators non-equality
* @param[in] other right hand side Acl
* @return true if Acls are not equal
*/
bool operator!=(const Acl& other) const;
/**
* Assignment operator for Term
*/
Acl& operator=(const Acl& other);
/**
* Copy constructor for Term
*/
Acl(const Acl& other);
private:
size_t peersSize;
Peer* peers;
size_t rulesSize;
Rule* rules;
};
/**
* Class to specify the marshal/unmarshal utility for the policy data
*/
class Marshaller {
public:
Marshaller()
{
}
virtual ~Marshaller()
{
}
/**
* Marshal the permission policy to a byte array.
* @param[in] policy the policy to marshal into a byte array
* @param[out] buf the buffer containing the marshalled data. The buffer is new[]'d by this object and will be delete[]'d by the caller of this method.
* @param[out] size the variable holding the size of the allocated byte array
* @return
* - #ER_OK if export was successful.
* - error code if fail
*/
virtual QStatus Marshal(PermissionPolicy& policy, uint8_t** buf, size_t* size)
{
QCC_UNUSED(policy);
QCC_UNUSED(buf);
QCC_UNUSED(size);
return ER_NOT_IMPLEMENTED;
}
/**
* Unmarshal the permission policy from a byte array.
* @param[out] policy the policy the byte array will be unmarshalled into
* @param buf the byte array holding the serialized data. The serialized data must be generated by the Export call.
* @param size the size of the byte array
* @return
* - #ER_OK if import was successful.
* - error code if fail
*/
virtual QStatus Unmarshal(PermissionPolicy& policy, const uint8_t* buf, size_t size)
{
QCC_UNUSED(policy);
QCC_UNUSED(buf);
QCC_UNUSED(size);
return ER_NOT_IMPLEMENTED;
}
/**
* Generate a hash digest for the policy data. Each marshaller can use its own digest algorithm.
* @param[in] policy the policy used to generate the hash digest
* @param[out] digest the buffer to hold the output digest. It must be new[] by the caller and must have enough space to hold the digest
* @param len the length of the digest buffer.
* @return
* - #ER_OK if digest was generated successfully.
* - error code if fail
*/
virtual QStatus Digest(PermissionPolicy& policy, uint8_t* digest, size_t len)
{
QCC_UNUSED(policy);
QCC_UNUSED(digest);
QCC_UNUSED(len);
return ER_NOT_IMPLEMENTED;
}
/**
* Generate a hash digest for the manifest data. Each marshaller can use its own digest algorithm.
* @param[in] rules the array of rules in the manifest
* @param[in] count the number of rules in the manifest
* @param[out] digest the buffer to hold the output digest. It must be new[] by the caller and must have enough space to hold the digest
* @param len the length of the digest buffer.
* @return
* - #ER_OK if digest was successful.
* - error code if fail
*/
virtual QStatus Digest(const PermissionPolicy::Rule* rules, size_t count, uint8_t* digest, size_t len)
{
QCC_UNUSED(rules);
QCC_UNUSED(count);
QCC_UNUSED(digest);
QCC_UNUSED(len);
return ER_NOT_IMPLEMENTED;
}
};
/**
* Constructor
*
*/
PermissionPolicy() : specificationVersion(SPEC_VERSION), version(0), aclsSize(0), acls(NULL)
{
}
/**
* virtual destructor
*/
virtual ~PermissionPolicy()
{
delete [] acls;
}
void SetSpecificationVersion(uint16_t specificationVersion)
{
this->specificationVersion = specificationVersion;
}
const uint16_t GetSpecificationVersion() const
{
return specificationVersion;
}
void SetVersion(uint32_t version)
{
this->version = version;
}
const uint32_t GetVersion() const
{
return version;
}
/**
* Set the array of permission acls
* @param[in] count the number of permission acls
* @param[in] acls the array of permission acls.
*/
void SetAcls(size_t count, const Acl* acls);
const size_t GetAclsSize() const
{
return aclsSize;
}
const Acl* GetAcls() const
{
return acls;
}
/**
* A String representation of the PermissionPolicy
*
* @param indent Number of space chars to indent the start of each line
*
* @return A String representation of the PermissionPolicy
*/
qcc::String ToString(size_t indent = 0) const;
/**
* Comparison operator equality
* @param[in] other right hand side PermissionPolicy
* @return true if PermissionPolicies are equal
*/
bool operator==(const PermissionPolicy& other) const;
/**
* Comparison operator non-equality
* @param[in] other right hand side PermissionPolicy
* @return true if PermissionPolicies are not equal
*/
bool operator!=(const PermissionPolicy& other) const;
/**
* Serialize the permission policy to a byte array.
* @param marshaller the marshaller
* @param[out] buf the newly allocated byte array holding the serialized data. The caller must delete[] this buffer after use.
* @param[out] size the variable holding the size of the allocated byte array
* @return
* - #ER_OK if export was successful.
* - error code if fail
*/
QStatus Export(Marshaller& marshaller, uint8_t** buf, size_t* size);
/**
* Deserialize the permission policy from a byte array.
* @param marshaller the marshaller
* @param buf the byte array holding the serialized data. The serialized data must be generated by the Export call.
* @param size the size of the byte array
* @return
* - #ER_OK if import was successful.
* - error code if fail
*/
QStatus Import(Marshaller& marshaller, const uint8_t* buf, size_t size);
/**
* Export the Policy to a MsgArg object.
* @param[out] msgArg the resulting message arg
* @return
* - #ER_OK if creation was successful.
* - error code if fail
*/
QStatus Export(MsgArg& msgArg) const;
/**
* Build a MsgArg object to represent the array of rules.
* @param rules the array of rules
* @param count the number of rules
* @param[out] msgArg the resulting message arg
* @return
* - #ER_OK if creation was successful.
* - error code if fail
*/
static QStatus GenerateRules(const Rule* rules, size_t count, MsgArg& msgArg);
/**
* Parse the MsgArg object to retrieve the rules.
* @param msgArg the message arg
* @param[out] rules the buffer to hold the array of rules
* @param[out] count the output number of rules
* @return
* - #ER_OK if creation was successful.
* - error code if fail
*/
static QStatus ParseRules(const MsgArg& msgArg, Rule** rules, size_t* count);
/**
* Build the policy object from the message arg object
* @param specificationVersion the specification version
* @param msgArg the message arg
* @return
* - #ER_OK if creation was successful.
* - error code if fail
*/
QStatus Import(uint16_t specificationVersion, const MsgArg& msgArg);
/**
* Generate a hash digest for the policy data
* @param marshaller the marshaller utility
* @param[out] digest the buffer to hold the output digest. It must be new[] by the caller and must have enough space to hold the digest
* @param len the length of the digest buffer.
* @return
* - #ER_OK if digest was successful.
* - error code if fail
*/
QStatus Digest(Marshaller& marshaller, uint8_t* digest, size_t len);
/**
* Assignment operator for PermissionPolicy
*/
PermissionPolicy& operator=(const PermissionPolicy& other);
/**
* Copy constructor for PermissionPolicy
*/
PermissionPolicy(const PermissionPolicy& other);
private:
uint16_t specificationVersion;
uint32_t version;
size_t aclsSize;
Acl* acls;
};
/**
* Class used to serialize/deserialize the permission policy.
*/
class DefaultPolicyMarshaller : public PermissionPolicy::Marshaller {
public:
/**
* Default constructor
*/
DefaultPolicyMarshaller(Message& msg) : Marshaller(), msg(msg)
{
}
/**
* Destructor
*/
~DefaultPolicyMarshaller()
{
}
/**
* Marshal the permission policy to a byte array.
*
* @param[in] policy the policy to marshal into a byte array
* @param[out] buf the newly allocated byte array holding the serialized data. The caller must delete[] this buffer after use.
* @param[out] size the variable holding the size of the allocated byte array
* @return
* - #ER_OK if export was successful.
* - error code if fail
*/
QStatus Marshal(PermissionPolicy& policy, uint8_t** buf, size_t* size);
/**
* Unmarshal the permission policy from a byte array.
*
* @param[out] policy the policy the byte array will be unmarshalled into
* @param buf the byte array holding the serialized data. The serialized data must be generated by the Export call.
* @param size the size of the byte array
* @return
* - #ER_OK if import was successful.
* - error code if fail
*/
QStatus Unmarshal(PermissionPolicy& policy, const uint8_t* buf, size_t size);
/**
* Generate a hash digest for the policy data
*
* @param[in] policy the policy used to generate the hash digest
* @param[out] digest the buffer to hold the output digest. It must be new[] by the caller and must have enough space to hold the digest
* @param len the length of the digest buffer.
* @return
* - #ER_OK if digest was successful.
* - error code if fail
*/
QStatus Digest(PermissionPolicy& policy, uint8_t* digest, size_t len);
/**
* Generate a hash digest for the manifest data. Each marshaller can use its own digest algorithm.
* @param[in] rules the array of rules in the manifest
* @param[in] count the number of rules in the manifest
* @param[out] digest the buffer to hold the output digest. It must be new[] by the caller and must have enough space to hold the digest
* @param len the length of the digest buffer.
* @return
* - #ER_OK if digest was successful.
* - error code if fail
*/
QStatus Digest(const PermissionPolicy::Rule* rules, size_t count, uint8_t* digest, size_t len);
private:
/**
* Assignment operator is private
*/
DefaultPolicyMarshaller& operator=(const DefaultPolicyMarshaller& other);
/**
* Copy constructor is private
*/
DefaultPolicyMarshaller(const DefaultPolicyMarshaller& other);
QStatus MarshalPrep(PermissionPolicy& policy);
QStatus MarshalPrep(const PermissionPolicy::Rule* rules, size_t count);
Message& msg;
};
/**
* Class used to encapsulate and manipulate a manifest.
*/
class _Manifest;
typedef qcc::ManagedObj<_Manifest> Manifest;
class _Manifest {
friend class AllJoynPeerObj;
friend class PermissionMgmtObj;
friend class SecurityApplicationObj;
friend class SecurityApplicationProxy;
friend class XmlManifestConverter;
public:
/** MsgArg signature for an array of signed manifests. */
static AJ_PCSTR s_MsgArgArraySignature;
/** MsgArg signature for a single signed manifest. */
static AJ_PCSTR s_MsgArgSignature;
/** MsgArg signature for a single signed manifest without the cryptographic signature field. */
static AJ_PCSTR s_MsgArgDigestSignature;
/** MsgArg signature for a 15.09-format MsgArg. */
static AJ_PCSTR s_TemplateMsgArgSignature;
/** Default version number for new manifests. */
static const uint32_t DefaultVersion;
/**
* Constructor.
*/
_Manifest();
/**
* Copy constructor.
* @param[in] other Manifest being copied
*/
_Manifest(const _Manifest& other);
/**
* Destructor.
*/
~_Manifest();
/**
* Assignment operator.
* @param[in] other Manifest being assigned from
*/
_Manifest& operator=(const _Manifest& other);
/**
* Equality operator.
* @param[in] other Manifest to compare against
*
* @return true if contents are equal, false otherwise
*/
bool operator==(const _Manifest& other) const;
/**
* Inequality operator.
* @param[in] other Manifest to compare against
*
* @return true if the contents are different, false if they are equal
*/
bool operator!=(const _Manifest& other) const;
/**
* Set the rules to be set on this manifest. After calling SetRules, the cryptographic
* signature on this Manifest will no lnoger be valid; it will need to be signed again with the
* Sign method before applying to an application.
*
* @param[in] rules Array of PermissionPolicy::Rule objects
* @param[in] ruleCount Number of elements in rules array
*
* @return
* - #ER_OK if successful
* - other error indicating failure
*/
QStatus SetRules(const PermissionPolicy::Rule* rules, size_t rulesCount);
/**
* Cryptographically sign this manifest for the use of a particular subject certificate using
* the provided signing key. issuerPrivateKey must be the private key that signed subjectCertificate for
* apps to consider it valid. Caller must ensure the correct issuer public key is provided; this method
* does not verify the correct key is provided.
*
* Caller is responsible for verifying subjectCertificate is the signed certificate which will be used
* by the peer using this manifest; no validation of this is done.
*
* @param[in] subjectCertificate Signed certificate of the app which will use this manifest
* @param[in] issuerPrivateKey Private key of subjectCertificate's issuer to sign the manifest
*
* @return
* - #ER_OK if successful
* - other error indicating failure
*/
QStatus ComputeThumbprintAndSign(const qcc::CertificateX509& subjectCertificate, const qcc::ECCPrivateKey* issuerPrivateKey);
/**
* Cryptographically sign this manifest for the use of a particular subject certificate using
* the provided signing key. issuerPrivateKey must be the private key that signed the certificate
* corresponding to the given thumbprint for apps to consider it valid. Caller must ensure the correct
* issuer public key is provided; this method does not verify the correct key is provided.
*
* @param[in] subjectThumbprint SHA-256 thumbprint of the signed certificate of the app which will use this manifest
* @param[in] issuerPrivateKey Private key of the issuer of a Subject Certificate corresponding to the subjectThumbprint
*
* @return
* - #ER_OK if successful
* - other error indicating failure
*/
QStatus Sign(const std::vector<uint8_t>& subjectThumbprint, const qcc::ECCPrivateKey* issuerPrivateKey);
/**
* Cryptographically verify this manifest for the use of a particular subject certificate using
* the provided issuer public key. issuerPublicKey must be the public key corresponding to the private key
* which signed subjectCertificate.
*
* @param[in] subjectCertificate Signed certificate of the app using this manifest
* @param[in] issuerPublicKey Public key of the issuer to verify the signature of this manifest
*
* @return
* - #ER_OK if the manifest is cryptographically verified for use by subjectCertificate
* - #ER_UNKNOWN_CERTIFICATE if the manifest is not for the use of subjectCertificate
* - #ER_DIGEST_MISMATCH if the cryptographic signature is invalid
* - #ER_NOT_IMPLEMENTED if the manifest uses an unsupported thumbprint or signature algorithm
* - other error indicating failure
*/
QStatus ComputeThumbprintAndVerify(const qcc::CertificateX509& subjectCertificate, const qcc::ECCPublicKey* issuerPublicKey) const;
/**
* @internal
*
* Cryptographically verify this manifest for the use of a particular subject certificate thumbprint using
* the provided issuer public key.
*
* @param[in] subjectThumbprint SHA-256 thumbprint of the signed certificate of the app using this manifest
* @param[in] issuerPublicKey Public key of the issuer of a Subject Certificate corresponding to the subjectThumbprint
*
* @return
* - #ER_OK if the manifest is cryptographically verified for use by subjectThumbprint
* - #ER_UNKNOWN_CERTIFICATE if the manifest is not for the use of subjectThumbprint
* - #ER_DIGEST_MISMATCH if the cryptographic signature is invalid
* - #ER_NOT_IMPLEMENTED if the manifest uses an unsupported thumbprint or signature algorithm
* - other error indicating failure
*/
QStatus Verify(const std::vector<uint8_t>& subjectThumbprint, const qcc::ECCPublicKey* issuerPublicKey) const;
/**
* Get version number of this manifest.
*
* @return version number
*/
uint32_t GetVersion() const;
/**
* Get rules of this manifest.
*
* @return Vector of PermissionPolicy::Rule objects
*/
const std::vector<PermissionPolicy::Rule>& GetRules() const;
/**
* Get the OID of the algorithm used to compute the certificate thumbprint.
*
* @return std::string containing the OID
*/
std::string GetThumbprintAlgorithmOid() const;
/**
* Get the certificate thumbprint.
*
* @return Vector of bytes containing the thumbprint
*/
std::vector<uint8_t> GetThumbprint() const;
/**
* Get the OID used to compute the signature.
*
* @return std::string containing the OID
*/
std::string GetSignatureAlgorithmOid() const;
/**
* Get the signature.
*
* @return Vector of bytes containing the signature
*/
std::vector<uint8_t> GetSignature() const;
/**
* Get a serialized form of this signed manifest.
*
* @param[out] serializedForm Vector containing the bytes of the serialized manifest.
*
* @return
* - #ER_OK if serialization was successful
* - other error code indicating failure
*/
QStatus Serialize(std::vector<uint8_t>& seralizedForm) const;
/**
* Deserialize a manifest from a vector of bytes.
*
* @param[in] serializedForm Vector of bytes containing the serialized manifest
*
* @return
* - #ER_OK if the manifest was successfully deserialized
* - other error indicating failure
*/
QStatus Deserialize(const std::vector<uint8_t>& serializedForm);
/*
* Get a string representation of this manifest.
*
* @return String containing the representation.
*/
std::string ToString() const;
private:
typedef enum {
MANIFEST_FULL = 0,
MANIFEST_FOR_DIGEST = 1,
MANIFEST_PURPOSE_MAX
} ManifestPurpose;
/**
* @internal
*
* Set the contents of this Manifest from a signed manifest MsgArg.
*
* @param[in] manifestArg A MsgArg with the MsgArgSignature signature containing a signed manifest
*
* @return
* - #ER_OK if successful
* - #ER_INVALID_DATA if the version number is unsupported
* - other error indicating failure
*/
QStatus SetFromMsgArg(const MsgArg& manifestArg);
/**
* @internal
*
* Get a MsgArg containing the contents of this manifest.
*
* @param[in] manifestPurpose Specifies the purpose for the output form of this manifest
* @param[out] outputArg MsgArg to receive the output
*
* @return
* - #ER_OK if successful
* - other error indicating failure
*/
QStatus GetMsgArg(ManifestPurpose manifestPurpose, MsgArg& outputArg) const;
/**
* @internal
*
* Serialize a manifest to a vector of bytes
*
* @param[in] manifestPurpose Specifies the purpose for the serialized form of this manifest
* @param[out] serializedForm Vector of bytes to receive serialized form
*
* @return
* - #ER_OK if the manifest was successfully serialized
* - other error indicating failure
*/
QStatus Serialize(ManifestPurpose manifestPurpose, std::vector<uint8_t>& serializedForm) const;
/**
* @internal
*
* Serialize a vector of manifests into a vector of bytes.
*
* @param[in] manifests Vector of manifests to serialize.
* @param[out] serializedForm Vector to receive bytes of serialized array.
*
* @return
* - #ER_OK if manifests are successfully serialized
* - other error indicating failure
*/
static QStatus SerializeArray(const std::vector<Manifest>& manifests, std::vector<uint8_t>& serializedForm);
/**
* @internal
* Deserialize a vector of manifests from a vector of bytes.
*
* @param[in] serializedForm Vector of bytes containing serialized array of manifests
* @param[out] manifests Vector to receive deserialized manifests
*
* @return
* - #ER_OK if manifests are successfully deserialized
* - other error indicating failure
*/
static QStatus DeserializeArray(const std::vector<uint8_t>& serializedForm, std::vector<Manifest>& manifests);
/**
* @internal
*
* Deserialize a vector of manifests from a byte array.
*
* @param[in] serializedForm Array of bytes containing serialized array of manifests
* @param[in] serializedSize Number of bytes in serializedForm
* @param[out] manifests Vector to receive deserialized manifests
*
* @return
* - #ER_OK if manifests are successfully deserialized
* - other error indicating failure
*/
static QStatus DeserializeArray(const uint8_t* serializedForm, size_t serializedSize, std::vector<Manifest>& manifests);
/**
* @internal
*
* Get a MsgArg that contains an array of signed manifests suitable for method calls that transport
* arrays of signed manifests.
*
* @param[in] manifests Vector of manifests to put into the array MsgArg.
* @param[out] outputArg MsgArg to receive the output.
*
* @return
* - #ER_OK if outputArg is successfully populated with the array of signed manifests.
* - other error indicating failure
*/
static QStatus GetArrayMsgArg(const std::vector<Manifest>& manifests, MsgArg& outputArg);
/**
* @internal
*
* Get a MsgArg that contains an array of signed manifests suitable for method calls that transport
* arrays of signed manifests.
*
* @param[in] manifests Array of manifests to put into the array MsgArg.
* @param[in] manifestCount Number of elements in manifests array
* @param[out] outputArg MsgArg to receive the output.
*
* @return
* - #ER_OK if outputArg is successfully populated with the array of signed manifests.
* - other error indicating failure
*/
static QStatus GetArrayMsgArg(const Manifest* manifests, size_t manifestCount, MsgArg& outputArg);
/**
* @internal
*
* Determine whether or not a given manifest version number is supported by this version of AllJoyn.
*
* @param[in] version Version number to check.
*
* @return true if manifest version is supported, false otherwise
*/
static bool IsVersionSupported(uint32_t version);
/**
* @internal
*
* Determine if a manifest has been signed by looking for the presence of the thumbprint and
* signature fields. This does not verify the cryptographic signature, as that requires access
* to the public key of the signer which may not be available. Instead, this allows rejecting
* unsigned manifests which can never be valid.
*
* @return true if the manifest has been signed, false otherwise
*/
bool HasSignature() const;
QStatus GetDigest(std::vector<uint8_t>& digest) const;
QStatus GetECCSignature(qcc::ECCSignature& signature) const;
QStatus SetECCSignature(const qcc::ECCSignature& signature);
uint32_t m_version;
std::vector<PermissionPolicy::Rule> m_rules;
std::string m_thumbprintAlgorithmOid;
std::vector<uint8_t> m_thumbprint;
std::string m_signatureAlgorithmOid;
std::vector<uint8_t> m_signature;
};
}
#endif
|