authorization_set.h revision 43786c8ca4e9034b5aa1528b52f9eaaa7551b05f
15ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden/* 25ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Copyright 2014 The Android Open Source Project 35ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * 45ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Licensed under the Apache License, Version 2.0 (the "License"); 55ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * you may not use this file except in compliance with the License. 65ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * You may obtain a copy of the License at 75ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * 85ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * http://www.apache.org/licenses/LICENSE-2.0 95ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * 105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Unless required by applicable law or agreed to in writing, software 115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * distributed under the License is distributed on an "AS IS" BASIS, 125ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 135ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * See the License for the specific language governing permissions and 145ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * limitations under the License. 155ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 165ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 17b10f3b26af1e3b382d9ef361b3eb5279d16a9c05Shawn Willden#ifndef SYSTEM_KEYMASTER_AUTHORIZATION_SET_H_ 18b10f3b26af1e3b382d9ef361b3eb5279d16a9c05Shawn Willden#define SYSTEM_KEYMASTER_AUTHORIZATION_SET_H_ 195ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 205ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden#include <UniquePtr.h> 215ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 22b9d584d3dacc8041e5502cd0d036e21895eb6dc6Shawn Willden#include <hardware/keymaster_defs.h> 2398d9b92547a9a7553b99e3e941a4175926f95b62Shawn Willden#include <keymaster/keymaster_tags.h> 2498d9b92547a9a7553b99e3e941a4175926f95b62Shawn Willden#include <keymaster/serializable.h> 255ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 265ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willdennamespace keymaster { 275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 282c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdenclass AuthorizationSetBuilder; 292c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 305ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden/** 31bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden * An extension of the keymaster_key_param_set_t struct, which provides serialization memory 32bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden * management and methods for easy manipulation and construction. 335ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 34bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willdenclass AuthorizationSet : public Serializable, public keymaster_key_param_set_t { 355ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden public: 365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 375ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Construct an empty, dynamically-allocated, growable AuthorizationSet. Does not actually 385ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * allocate any storage until elements are added, so there is no cost to creating an 395ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * AuthorizationSet with this constructor and then reinitializing it to point at pre-allocated 405ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * buffers, with \p Reinitialize. 415ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 425ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden AuthorizationSet() 43bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden : elems_capacity_(0), indirect_data_(NULL), indirect_data_size_(0), 44bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden indirect_data_capacity_(0), error_(OK) { 45bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_ = nullptr; 46bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_size_ = 0; 47bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden } 485ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 495ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 505ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Construct an AuthorizationSet from the provided array. The AuthorizationSet copies the data 515ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * from the provided array (and the data referenced by its embedded pointers, if any) into 525ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * dynamically-allocated storage. If allocation of the needed storage fails, \p is_valid() will 535ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * return ALLOCATION_FAILURE. It is the responsibility of the caller to check before using the 545ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * set, if allocations might fail. 555ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 56bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden AuthorizationSet(const keymaster_key_param_t* elems, size_t count) : indirect_data_(nullptr) { 57bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_ = nullptr; 585ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden Reinitialize(elems, count); 595ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 605ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 61bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden explicit AuthorizationSet(const keymaster_key_param_set_t& set) : indirect_data_(nullptr) { 62bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_ = nullptr; 63cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden Reinitialize(set.params, set.length); 64cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden } 65cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden 66bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden explicit AuthorizationSet(const uint8_t* serialized_set, size_t serialized_size) 67bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden : indirect_data_(nullptr) { 68bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_ = nullptr; 6958e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden Deserialize(&serialized_set, serialized_set + serialized_size); 705ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 715ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 722c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden /** 732c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * Construct an AuthorizationSet from the provided builder. This extracts the data from the 742c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * builder, rather than copying it, so after this call the builder is empty. 752c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden */ 76bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden explicit AuthorizationSet(/* NOT const */ AuthorizationSetBuilder& builder); 772c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 7858e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden // Copy constructor. 79bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden AuthorizationSet(const AuthorizationSet& set) : Serializable(), indirect_data_(nullptr) { 80bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden elems_ = nullptr; 81bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden Reinitialize(set.elems_, set.elems_size_); 8243786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley error_ = set.error_; 8343786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley } 8443786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley 8543786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley // Move constructor. 8643786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley AuthorizationSet(AuthorizationSet&& set) : Serializable() { 8743786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley MoveFrom(set); 8843786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley } 8943786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley 9043786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley // Copy assignment. 9143786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley AuthorizationSet& operator=(const AuthorizationSet& set) { 9243786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley Reinitialize(set.elems_, set.elems_size_); 9343786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley error_ = set.error_; 9443786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley return *this; 9543786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley } 9643786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley 9743786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley // Move assignment. 9843786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley AuthorizationSet& operator=(AuthorizationSet&& set) { 9943786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley FreeData(); 10043786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley MoveFrom(set); 10143786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley return *this; 102bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden } 10358e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden 1045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 105941d1c4ad4422a796d90010191c11aef0580295eShawn Willden * Clear existing authorization set data 106941d1c4ad4422a796d90010191c11aef0580295eShawn Willden */ 107941d1c4ad4422a796d90010191c11aef0580295eShawn Willden void Clear(); 108941d1c4ad4422a796d90010191c11aef0580295eShawn Willden 109941d1c4ad4422a796d90010191c11aef0580295eShawn Willden /** 1105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Reinitialize an AuthorizationSet as a dynamically-allocated, growable copy of the data in the 1115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * provided array (and the data referenced by its embedded pointers, if any). If the allocation 1125ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * of the needed storage fails this method will return false and \p is_valid() will return 1135ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * ALLOCATION_FAILURE. 1145ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1155ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool Reinitialize(const keymaster_key_param_t* elems, size_t count); 1165ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1177636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool Reinitialize(const AuthorizationSet& set) { 1187636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return Reinitialize(set.elems_, set.elems_size_); 1197636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 1207636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 121bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden bool Reinitialize(const keymaster_key_param_set_t& set) { 122bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden return Reinitialize(set.params, set.length); 123bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden } 124bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden 12558e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden ~AuthorizationSet(); 1265ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden enum Error { 12858e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden OK, 1295ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden ALLOCATION_FAILURE, 1305ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden MALFORMED_DATA, 1315ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden }; 1325ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 133172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden Error is_valid() const { return error_; } 1345ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1355ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the size of the set. 1375ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 138172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden size_t size() const { return elems_size_; } 1397636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 1407636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden /** 141cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden * Returns true if the set is empty. 142cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden */ 143cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden bool empty() const { return size() == 0; } 144cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden 145cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden /** 146370121346777e13437c275fbe7a975d899cc325cShawn Willden * Returns the total size of all indirect data referenced by set elements. 147370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 148370121346777e13437c275fbe7a975d899cc325cShawn Willden size_t indirect_size() const { return indirect_data_size_; } 149370121346777e13437c275fbe7a975d899cc325cShawn Willden 150370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 1517636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden * Returns the data in the set, directly. Be careful with this. 1527636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden */ 153be4a2a3e70ada1ee026eaffb7163211161396215Shawn Willden const keymaster_key_param_t* data() const { return elems_; } 154cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden 155cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 156f21afff128ac22479c49bdda84f13335ae17d009Shawn Willden * Sorts the set 157f21afff128ac22479c49bdda84f13335ae17d009Shawn Willden */ 158f21afff128ac22479c49bdda84f13335ae17d009Shawn Willden void Sort(); 159f21afff128ac22479c49bdda84f13335ae17d009Shawn Willden 160f21afff128ac22479c49bdda84f13335ae17d009Shawn Willden /** 1612c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * Sorts the set and removes duplicates (inadvertently duplicating tags is easy to do with the 1622c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * AuthorizationSetBuilder). 1632c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden */ 1642c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden void Deduplicate(); 1652c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 1662c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden /** 167cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Returns the data in a keymaster_key_param_set_t, suitable for returning to C code. For C 168056ec1531752b6e8491269661581036a95c5d3e5Shawn Willden * compatibility, the contents are malloced, not new'ed, and so must be freed with free(), or 169056ec1531752b6e8491269661581036a95c5d3e5Shawn Willden * better yet with keymaster_free_param_set, not delete. The caller takes ownership. 170cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 171cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden void CopyToParamSet(keymaster_key_param_set_t* set) const; 1725ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1735ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1745ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the offset of the next entry that matches \p tag, starting from the element after \p 1755ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * begin. If not found, returns -1. 1765ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1775ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden int find(keymaster_tag_t tag, int begin = -1) const; 1785ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1795ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 180cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden * Removes the entry at the specified index. Returns true if successful, false if the index was 181cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden * out of bounds. 182cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden */ 183cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden bool erase(size_t index); 184cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden 185cb647fec03f71929fd316d2b8f0750f7b24824f3Shawn Willden /** 1863e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden * Returns iterator (pointer) to beginning of elems array, to enable STL-style iteration 1873e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden */ 1883e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden const keymaster_key_param_t* begin() const { return elems_; } 1893e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden 1903e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden /** 1913e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden * Returns iterator (pointer) one past end of elems array, to enable STL-style iteration 1923e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden */ 1933e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden const keymaster_key_param_t* end() const { return elems_ + elems_size_; } 1943e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden 1953e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden /** 1965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the nth element of the set. 1975ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 198d599b15c0693950bdc72fb867872044fdc484ef5Shawn Willden keymaster_key_param_t& operator[](int n); 199d599b15c0693950bdc72fb867872044fdc484ef5Shawn Willden 200d599b15c0693950bdc72fb867872044fdc484ef5Shawn Willden /** 201d599b15c0693950bdc72fb867872044fdc484ef5Shawn Willden * Returns the nth element of the set. 202d599b15c0693950bdc72fb867872044fdc484ef5Shawn Willden */ 2035ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden keymaster_key_param_t operator[](int n) const; 2045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2055ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2061fa5d591fe6807665092753a5628d8d470888da4Shawn Willden * Returns the number of \p tag entries. 2071fa5d591fe6807665092753a5628d8d470888da4Shawn Willden */ 2081fa5d591fe6807665092753a5628d8d470888da4Shawn Willden size_t GetTagCount(keymaster_tag_t tag) const; 2091fa5d591fe6807665092753a5628d8d470888da4Shawn Willden 2101fa5d591fe6807665092753a5628d8d470888da4Shawn Willden /** 211edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden * Returns true if the set contains the specified tag and value. 212edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden */ 213edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden template <keymaster_tag_t Tag, typename T> 214edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden bool Contains(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, T val) const { 215edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden return ContainsEnumValue(tag, val); 216edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden } 217edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden 218edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden /** 219226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden * Returns true if the set contains the specified tag and value. 220226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden */ 221226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden template <keymaster_tag_t Tag, typename T> 222226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden bool Contains(TypedEnumTag<KM_ENUM, Tag, T> tag, T val) const { 223226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden return ContainsEnumValue(tag, val); 224226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden } 225226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden 226226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden /** 2275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified integer-typed \p tag exists, places its value in \p val and returns true. 2285ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If \p tag is not present, leaves \p val unmodified and returns false. 2295ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2305ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t T> 231c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden inline bool GetTagValue(TypedTag<KM_UINT, T> tag, uint32_t* val) const { 2325ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueInt(tag, val); 2335ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2345ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2355ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified instance of the specified integer-typed \p tag exists, places its value 2375ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 2385ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * false. 2395ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2405ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 241c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden bool GetTagValue(TypedTag<KM_UINT_REP, Tag> tag, size_t instance, uint32_t* val) const { 2425ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueIntRep(tag, instance, val); 2435ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2445ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2455ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2465ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified long-typed \p tag exists, places its value in \p val and returns true. 2475ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If \p tag is not present, leaves \p val unmodified and returns false. 2485ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2495ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t T> 250c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden inline bool GetTagValue(TypedTag<KM_ULONG, T> tag, uint64_t* val) const { 2515ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueLong(tag, val); 2525ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2535ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2545ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 255eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * If the specified instance of the specified integer-typed \p tag exists, places its value 256eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 257eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * false. 258eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden */ 259eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden template <keymaster_tag_t Tag> 260c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden bool GetTagValue(TypedTag<KM_ULONG_REP, Tag> tag, size_t instance, uint64_t* val) const { 261eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden return GetTagValueLongRep(tag, instance, val); 262eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden } 263eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden 264eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden /** 2655ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified enumeration-typed \p tag exists, places its value in \p val and returns 2665ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 2675ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2685ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, typename T> 2695ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM, Tag, T> tag, T* val) const { 2705ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueEnum(tag, reinterpret_cast<uint32_t*>(val)); 2715ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2725ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2735ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2745ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified instance of the specified enumeration-typed \p tag exists, places its value 2755ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 2765ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * false. 2775ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2785ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, typename T> 2795ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, size_t instance, T* val) const { 2805ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueEnumRep(tag, instance, reinterpret_cast<uint32_t*>(val)); 2815ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2825ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2835ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 284d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * If exactly one instance of the specified enumeration-typed \p tag exists, places its value in 285d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * \p val and returns true. If \p tag is not present or if multiple copies are present, leaves 286d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * \p val unmodified and returns false. 287d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden */ 288d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden template <keymaster_tag_t Tag, typename T> 289d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, T* val) const { 290d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden if (GetTagCount(tag) != 1) 291d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden return false; 292d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden return GetTagValueEnumRep(tag, 0, reinterpret_cast<uint32_t*>(val)); 293d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden } 294d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden 295d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden /** 2965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified date-typed \p tag exists, places its value in \p val and returns 2975ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 2985ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2995ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 300c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden bool GetTagValue(TypedTag<KM_UINT_REP, Tag> tag, size_t instance, 301c3ac84f04c4d6d74fa36abfd1cc2e5ac763a8af3Shawn Willden typename TypedTag<KM_UINT_REP, Tag>::value_type* val) const { 3025ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueIntRep(tag, instance, val); 3035ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3055ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 3065ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified bytes-typed \p tag exists, places its value in \p val and returns 3075ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 3085ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 3095ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 3105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_BYTES, Tag> tag, keymaster_blob_t* val) const { 3115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueBlob(tag, val); 3125ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3135ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3145ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 3155ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified bignum-typed \p tag exists, places its value in \p val and returns 3165ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 3175ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 3185ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 3195ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_BIGNUM, Tag> tag, keymaster_blob_t* val) const { 32028e41475a2559824a0f3f2c850ed92a65c586f95Shawn Willden return GetTagValueBlob(tag, val); 3215ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3225ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3235ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 324dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden * Returns true if the specified tag is present, and therefore has the value 'true'. 325dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden */ 3262c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> bool GetTagValue(TypedTag<KM_BOOL, Tag> tag) const { 327dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden return GetTagValueBool(tag); 328dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden } 329dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden 330dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden /** 3315ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified \p tag exists, places its value in \p val and returns true. If \p tag is 3325ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * not present, leaves \p val unmodified and returns false. 3335ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 3345ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 3355ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<Type, Tag> tag, typename TagValueType<Type>::value_type* val) const { 3365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueLong(tag, val); 3375ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3385ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3395ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(keymaster_key_param_t elem); 3405ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 341370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 342370121346777e13437c275fbe7a975d899cc325cShawn Willden * Grow the elements array to ensure it can contain \p count entries. Preserves any existing 343370121346777e13437c275fbe7a975d899cc325cShawn Willden * entries. 344370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 345370121346777e13437c275fbe7a975d899cc325cShawn Willden bool reserve_elems(size_t count); 346370121346777e13437c275fbe7a975d899cc325cShawn Willden 347370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 348370121346777e13437c275fbe7a975d899cc325cShawn Willden * Grow the indirect data array to ensure it can contain \p length bytes. Preserves any 349370121346777e13437c275fbe7a975d899cc325cShawn Willden * existing indirect data. 350370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 351370121346777e13437c275fbe7a975d899cc325cShawn Willden bool reserve_indirect(size_t length); 352370121346777e13437c275fbe7a975d899cc325cShawn Willden 353b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool push_back(const keymaster_key_param_set_t& set); 354370121346777e13437c275fbe7a975d899cc325cShawn Willden 355cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 356cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and enumerated value to the set. 357cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3585ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type, typename KeymasterEnum> 3595ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedEnumTag<Type, Tag, KeymasterEnum> tag, KeymasterEnum val) { 3605ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, val)); 3615ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3625ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 363cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 364cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the boolean tag (value "true") to the set. 365cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3665ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> bool push_back(TypedTag<KM_BOOL, Tag> tag) { 3675ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag)); 3685ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3695ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 370cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 371cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and byte array to the set. Copies the array into internal storage; does not 372cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the passed-in array. 373cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3747636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden template <keymaster_tag_t Tag> 3757636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool push_back(TypedTag<KM_BYTES, Tag> tag, const void* bytes, size_t bytes_len) { 3767636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return push_back(keymaster_param_blob(tag, static_cast<const uint8_t*>(bytes), bytes_len)); 3777636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 3787636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 379cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 380cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and blob to the set. Copies the blob contents into internal storage; does not 381cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the blob's data. 382cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 383cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden template <keymaster_tag_t Tag> 384cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden bool push_back(TypedTag<KM_BYTES, Tag> tag, const keymaster_blob_t& blob) { 385cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden return push_back(tag, blob.data, blob.data_length); 386cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden } 387cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden 388cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 389cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and bignum array to the set. Copies the array into internal storage; does not 390cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the passed-in array. 391cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3927636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden template <keymaster_tag_t Tag> 3937636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool push_back(TypedTag<KM_BIGNUM, Tag> tag, const void* bytes, size_t bytes_len) { 3947636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return push_back(keymaster_param_blob(tag, static_cast<const uint8_t*>(bytes), bytes_len)); 3957636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 3967636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 3975ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 3985ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedTag<Type, Tag> tag, typename TypedTag<Type, Tag>::value_type val) { 3995ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, val)); 4005ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 4015ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 4025ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 4035ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedTag<Type, Tag> tag, const void* bytes, size_t bytes_len) { 4045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, bytes, bytes_len)); 4055ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 4065ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 40758e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden /* Virtual methods from Serializable */ 40858e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden size_t SerializedSize() const; 40958e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden uint8_t* Serialize(uint8_t* serialized_set, const uint8_t* end) const; 410172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden bool Deserialize(const uint8_t** buf_ptr, const uint8_t* end); 4115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 4128d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden size_t SerializedSizeOfElements() const; 4138d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden 4145ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden private: 4155ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void FreeData(); 41643786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley void MoveFrom(AuthorizationSet& set); 41743786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley 4185ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void set_invalid(Error err); 4195ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 4205ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden static size_t ComputeIndirectDataSize(const keymaster_key_param_t* elems, size_t count); 4215ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void CopyIndirectData(); 4228d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden bool CheckIndirectData(); 4235ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 424370121346777e13437c275fbe7a975d899cc325cShawn Willden bool DeserializeIndirectData(const uint8_t** buf_ptr, const uint8_t* end); 425370121346777e13437c275fbe7a975d899cc325cShawn Willden bool DeserializeElementsData(const uint8_t** buf_ptr, const uint8_t* end); 426370121346777e13437c275fbe7a975d899cc325cShawn Willden 4275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueEnum(keymaster_tag_t tag, uint32_t* val) const; 4285ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueEnumRep(keymaster_tag_t tag, size_t instance, uint32_t* val) const; 4295ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueInt(keymaster_tag_t tag, uint32_t* val) const; 4305ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueIntRep(keymaster_tag_t tag, size_t instance, uint32_t* val) const; 4315ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueLong(keymaster_tag_t tag, uint64_t* val) const; 432eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden bool GetTagValueLongRep(keymaster_tag_t tag, size_t instance, uint64_t* val) const; 4335ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueDate(keymaster_tag_t tag, uint64_t* val) const; 4345ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueBlob(keymaster_tag_t tag, keymaster_blob_t* val) const; 435dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden bool GetTagValueBool(keymaster_tag_t tag) const; 4365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 437edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden bool ContainsEnumValue(keymaster_tag_t tag, uint32_t val) const; 438edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden 43943786c8ca4e9034b5aa1528b52f9eaaa7551b05fPaul Crowley // Define elems_ and elems_size_ as aliases to params and length, respectively. This is to 440bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden // avoid using the variables without the trailing underscore in the implementation. 441bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden keymaster_key_param_t*& elems_ = keymaster_key_param_set_t::params; 442bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden size_t& elems_size_ = keymaster_key_param_set_t::length; 443bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden 4445ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t elems_capacity_; 4455ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden uint8_t* indirect_data_; 4465ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t indirect_data_size_; 4475ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t indirect_data_capacity_; 4485ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden Error error_; 4495ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden}; 4505ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 4512c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdenclass AuthorizationSetBuilder { 4522c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden public: 4532c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <typename TagType, typename ValueType> 4542c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TagType tag, ValueType value) { 4552c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag, value); 4562c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4572c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4582c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4592c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4602c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BOOL, Tag> tag) { 4612c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag); 4622c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4632c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4642c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4652c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4662c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_INVALID, Tag> tag) { 4672c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden keymaster_key_param_t param; 4682c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden param.tag = tag; 4692c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(param); 4702c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4712c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4722c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4732c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4742c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BYTES, Tag> tag, const uint8_t* data, 4752c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden size_t data_length) { 4762c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag, data, data_length); 4772c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4782c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4792c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4802c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4812c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BYTES, Tag> tag, const char* data, 4822c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden size_t data_length) { 4832c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(tag, reinterpret_cast<const uint8_t*>(data), data_length); 4842c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4852c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4862c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& RsaKey(uint32_t key_size, uint64_t public_exponent); 4872c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& EcdsaKey(uint32_t key_size); 4882c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& AesKey(uint32_t key_size); 489af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& HmacKey(uint32_t key_size); 4902c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 491af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& RsaSigningKey(uint32_t key_size, uint64_t public_exponent); 492af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& RsaEncryptionKey(uint32_t key_size, uint64_t public_exponent); 493af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& EcdsaSigningKey(uint32_t key_size); 4942c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& AesEncryptionKey(uint32_t key_size); 495af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 4962c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& SigningKey(); 4972c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& EncryptionKey(); 4982c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& NoDigestOrPadding(); 499c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willden AuthorizationSetBuilder& EcbMode(); 5002c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 501af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& Digest(keymaster_digest_t digest) { 502af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return Authorization(TAG_DIGEST, digest); 503af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden } 504af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 505af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& Padding(keymaster_padding_t padding) { 506af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return Authorization(TAG_PADDING, padding); 507af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden } 508af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 5092c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Deduplicate() { 5102c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.Deduplicate(); 5112c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 5122c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 5132c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5142c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSet build() const { return set; } 5152c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5162c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden private: 5172c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden friend AuthorizationSet; 5182c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSet set; 5192c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden}; 5202c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5212c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::RsaKey(uint32_t key_size, 5222c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden uint64_t public_exponent) { 5232c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_RSA); 5242c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 5252c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_RSA_PUBLIC_EXPONENT, public_exponent); 5262c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 5272c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5282c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5292c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcdsaKey(uint32_t key_size) { 5309c65b2bd1978a918b52a459596dafc7dde992416Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_EC); 5312c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 5322c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 5332c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5342c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5352c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::AesKey(uint32_t key_size) { 5362c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_AES); 5372c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_KEY_SIZE, key_size); 5382c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5392c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 540af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::HmacKey(uint32_t key_size) { 5412c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_HMAC); 5422c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 543af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5442c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5452c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 546af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::RsaSigningKey(uint32_t key_size, 547af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden uint64_t public_exponent) { 5482c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden RsaKey(key_size, public_exponent); 549af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5502c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5512c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5522c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& 553af533990df2265e48d01b187a8e86eefa04d1be3Shawn WilldenAuthorizationSetBuilder::RsaEncryptionKey(uint32_t key_size, uint64_t public_exponent) { 5542c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden RsaKey(key_size, public_exponent); 555af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return EncryptionKey(); 5562c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5572c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 558af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcdsaSigningKey(uint32_t key_size) { 5592c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden EcdsaKey(key_size); 560af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5612c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5622c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5632c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::AesEncryptionKey(uint32_t key_size) { 5642c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AesKey(key_size); 5652c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return EncryptionKey(); 5662c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5672c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5682c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::SigningKey() { 5692c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_PURPOSE, KM_PURPOSE_SIGN); 5702c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PURPOSE, KM_PURPOSE_VERIFY); 5712c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5722c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5732c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EncryptionKey() { 5742c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_PURPOSE, KM_PURPOSE_ENCRYPT); 5752c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PURPOSE, KM_PURPOSE_DECRYPT); 5762c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5772c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5782c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::NoDigestOrPadding() { 5792c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_DIGEST, KM_DIGEST_NONE); 5802c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PADDING, KM_PAD_NONE); 5812c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5822c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 583c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcbMode() { 584c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willden return Authorization(TAG_BLOCK_MODE, KM_MODE_ECB); 5852c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5862c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5875ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden} // namespace keymaster 5885ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 589b10f3b26af1e3b382d9ef361b3eb5279d16a9c05Shawn Willden#endif // SYSTEM_KEYMASTER_KEY_AUTHORIZATION_SET_H_ 590