authorization_set.h revision b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7
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_); 82bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden } 8358e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden 845ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 85941d1c4ad4422a796d90010191c11aef0580295eShawn Willden * Clear existing authorization set data 86941d1c4ad4422a796d90010191c11aef0580295eShawn Willden */ 87941d1c4ad4422a796d90010191c11aef0580295eShawn Willden void Clear(); 88941d1c4ad4422a796d90010191c11aef0580295eShawn Willden 89941d1c4ad4422a796d90010191c11aef0580295eShawn Willden /** 905ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Reinitialize an AuthorizationSet as a dynamically-allocated, growable copy of the data in the 915ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * provided array (and the data referenced by its embedded pointers, if any). If the allocation 925ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * of the needed storage fails this method will return false and \p is_valid() will return 935ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * ALLOCATION_FAILURE. 945ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 955ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool Reinitialize(const keymaster_key_param_t* elems, size_t count); 965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 977636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool Reinitialize(const AuthorizationSet& set) { 987636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return Reinitialize(set.elems_, set.elems_size_); 997636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 1007636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 101bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden bool Reinitialize(const keymaster_key_param_set_t& set) { 102bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden return Reinitialize(set.params, set.length); 103bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden } 104bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden 10558e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden ~AuthorizationSet(); 1065ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1075ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden enum Error { 10858e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden OK, 1095ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden ALLOCATION_FAILURE, 1105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden MALFORMED_DATA, 1115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden }; 1125ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 113172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden Error is_valid() const { return error_; } 1145ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1155ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1165ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the size of the set. 1175ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 118172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden size_t size() const { return elems_size_; } 1197636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 1207636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden /** 121370121346777e13437c275fbe7a975d899cc325cShawn Willden * Returns the total size of all indirect data referenced by set elements. 122370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 123370121346777e13437c275fbe7a975d899cc325cShawn Willden size_t indirect_size() const { return indirect_data_size_; } 124370121346777e13437c275fbe7a975d899cc325cShawn Willden 125370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 1267636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden * Returns the data in the set, directly. Be careful with this. 1277636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden */ 128be4a2a3e70ada1ee026eaffb7163211161396215Shawn Willden const keymaster_key_param_t* data() const { return elems_; } 129cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden 130cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 1312c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * Sorts the set and removes duplicates (inadvertently duplicating tags is easy to do with the 1322c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden * AuthorizationSetBuilder). 1332c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden */ 1342c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden void Deduplicate(); 1352c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 1362c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden /** 137cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Returns the data in a keymaster_key_param_set_t, suitable for returning to C code. For C 138056ec1531752b6e8491269661581036a95c5d3e5Shawn Willden * compatibility, the contents are malloced, not new'ed, and so must be freed with free(), or 139056ec1531752b6e8491269661581036a95c5d3e5Shawn Willden * better yet with keymaster_free_param_set, not delete. The caller takes ownership. 140cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 141cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden void CopyToParamSet(keymaster_key_param_set_t* set) const; 1425ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1435ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1445ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the offset of the next entry that matches \p tag, starting from the element after \p 1455ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * begin. If not found, returns -1. 1465ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1475ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden int find(keymaster_tag_t tag, int begin = -1) const; 1485ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1495ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1503e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden * Returns iterator (pointer) to beginning of elems array, to enable STL-style iteration 1513e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden */ 1523e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden const keymaster_key_param_t* begin() const { return elems_; } 1533e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden 1543e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden /** 1553e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden * Returns iterator (pointer) one past end of elems array, to enable STL-style iteration 1563e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden */ 1573e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden const keymaster_key_param_t* end() const { return elems_ + elems_size_; } 1583e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden 1593e35dbcecbc5ae9de32be2c437c08a9faa940d5bShawn Willden /** 1605ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * Returns the nth element of the set. 1615ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1625ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden keymaster_key_param_t operator[](int n) const; 1635ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1645ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1651fa5d591fe6807665092753a5628d8d470888da4Shawn Willden * Returns the number of \p tag entries. 1661fa5d591fe6807665092753a5628d8d470888da4Shawn Willden */ 1671fa5d591fe6807665092753a5628d8d470888da4Shawn Willden size_t GetTagCount(keymaster_tag_t tag) const; 1681fa5d591fe6807665092753a5628d8d470888da4Shawn Willden 1691fa5d591fe6807665092753a5628d8d470888da4Shawn Willden /** 170edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden * Returns true if the set contains the specified tag and value. 171edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden */ 172edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden template <keymaster_tag_t Tag, typename T> 173edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden bool Contains(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, T val) const { 174edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden return ContainsEnumValue(tag, val); 175edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden } 176edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden 177edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden /** 178226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden * Returns true if the set contains the specified tag and value. 179226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden */ 180226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden template <keymaster_tag_t Tag, typename T> 181226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden bool Contains(TypedEnumTag<KM_ENUM, Tag, T> tag, T val) const { 182226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden return ContainsEnumValue(tag, val); 183226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden } 184226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden 185226746bfb5f79857145d5f3ebdfd6f49b6c114acShawn Willden /** 1865ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified integer-typed \p tag exists, places its value in \p val and returns true. 1875ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If \p tag is not present, leaves \p val unmodified and returns false. 1885ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1895ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t T> 1905ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden inline bool GetTagValue(TypedTag<KM_INT, T> tag, uint32_t* val) const { 1915ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueInt(tag, val); 1925ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 1935ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 1945ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 1955ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified instance of the specified integer-typed \p tag exists, places its value 1965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 1975ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * false. 1985ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 1995ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 2005ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_INT_REP, Tag> tag, size_t instance, uint32_t* val) const { 2015ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueIntRep(tag, instance, val); 2025ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2035ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2055ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified long-typed \p tag exists, places its value in \p val and returns true. 2065ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If \p tag is not present, leaves \p val unmodified and returns false. 2075ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2085ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t T> 2095ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden inline bool GetTagValue(TypedTag<KM_LONG, T> tag, uint64_t* val) const { 2105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueLong(tag, val); 2115ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2125ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2135ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 214eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * If the specified instance of the specified integer-typed \p tag exists, places its value 215eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 216eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden * false. 217eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden */ 218eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden template <keymaster_tag_t Tag> 219eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden bool GetTagValue(TypedTag<KM_LONG_REP, Tag> tag, size_t instance, uint64_t* val) const { 220eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden return GetTagValueLongRep(tag, instance, val); 221eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden } 222eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden 223eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden /** 2245ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified enumeration-typed \p tag exists, places its value in \p val and returns 2255ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 2265ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, typename T> 2285ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM, Tag, T> tag, T* val) const { 2295ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueEnum(tag, reinterpret_cast<uint32_t*>(val)); 2305ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2315ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2325ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2335ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified instance of the specified enumeration-typed \p tag exists, places its value 2345ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * in \p val and returns true. If \p tag is not present, leaves \p val unmodified and returns 2355ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * false. 2365ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2375ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, typename T> 2385ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, size_t instance, T* val) const { 2395ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueEnumRep(tag, instance, reinterpret_cast<uint32_t*>(val)); 2405ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2415ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2425ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 243d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * If exactly one instance of the specified enumeration-typed \p tag exists, places its value in 244d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * \p val and returns true. If \p tag is not present or if multiple copies are present, leaves 245d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden * \p val unmodified and returns false. 246d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden */ 247d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden template <keymaster_tag_t Tag, typename T> 248d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden bool GetTagValue(TypedEnumTag<KM_ENUM_REP, Tag, T> tag, T* val) const { 249d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden if (GetTagCount(tag) != 1) 250d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden return false; 251d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden return GetTagValueEnumRep(tag, 0, reinterpret_cast<uint32_t*>(val)); 252d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden } 253d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden 254d9d7acff7c43f52ebd038eb77afd67d597844b35Shawn Willden /** 2555ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified date-typed \p tag exists, places its value in \p val and returns 2565ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 2575ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2585ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 2595ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_INT_REP, Tag> tag, size_t instance, 2605ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden typename TypedTag<KM_INT_REP, Tag>::value_type* val) const { 2615ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueIntRep(tag, instance, val); 2625ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2635ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2645ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2655ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified bytes-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> 2695ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_BYTES, Tag> tag, keymaster_blob_t* val) const { 2705ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueBlob(tag, val); 2715ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2725ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2735ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 2745ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified bignum-typed \p tag exists, places its value in \p val and returns 2755ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * true. If \p tag is not present, leaves \p val unmodified and returns false. 2765ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2775ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> 2785ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<KM_BIGNUM, Tag> tag, keymaster_blob_t* val) const { 27928e41475a2559824a0f3f2c850ed92a65c586f95Shawn Willden return GetTagValueBlob(tag, val); 2805ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2815ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2825ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden /** 283dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden * Returns true if the specified tag is present, and therefore has the value 'true'. 284dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden */ 2852c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> bool GetTagValue(TypedTag<KM_BOOL, Tag> tag) const { 286dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden return GetTagValueBool(tag); 287dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden } 288dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden 289dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden /** 2905ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * If the specified \p tag exists, places its value in \p val and returns true. If \p tag is 2915ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden * not present, leaves \p val unmodified and returns false. 2925ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden */ 2935ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 2945ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValue(TypedTag<Type, Tag> tag, typename TagValueType<Type>::value_type* val) const { 2955ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return GetTagValueLong(tag, val); 2965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 2975ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 2985ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(keymaster_key_param_t elem); 2995ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 300370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 301370121346777e13437c275fbe7a975d899cc325cShawn Willden * Grow the elements array to ensure it can contain \p count entries. Preserves any existing 302370121346777e13437c275fbe7a975d899cc325cShawn Willden * entries. 303370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 304370121346777e13437c275fbe7a975d899cc325cShawn Willden bool reserve_elems(size_t count); 305370121346777e13437c275fbe7a975d899cc325cShawn Willden 306370121346777e13437c275fbe7a975d899cc325cShawn Willden /** 307370121346777e13437c275fbe7a975d899cc325cShawn Willden * Grow the indirect data array to ensure it can contain \p length bytes. Preserves any 308370121346777e13437c275fbe7a975d899cc325cShawn Willden * existing indirect data. 309370121346777e13437c275fbe7a975d899cc325cShawn Willden */ 310370121346777e13437c275fbe7a975d899cc325cShawn Willden bool reserve_indirect(size_t length); 311370121346777e13437c275fbe7a975d899cc325cShawn Willden 312b5508298cdb1d42eaf8c81aa8a6ac2cbfdeef3c7Shawn Willden bool push_back(const keymaster_key_param_set_t& set); 313370121346777e13437c275fbe7a975d899cc325cShawn Willden 314cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 315cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and enumerated value to the set. 316cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3175ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type, typename KeymasterEnum> 3185ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedEnumTag<Type, Tag, KeymasterEnum> tag, KeymasterEnum val) { 3195ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, val)); 3205ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3215ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 322cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 323cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the boolean tag (value "true") to the set. 324cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3255ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag> bool push_back(TypedTag<KM_BOOL, Tag> tag) { 3265ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag)); 3275ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3285ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 329cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 330cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and byte array to the set. Copies the array into internal storage; does not 331cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the passed-in array. 332cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3337636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden template <keymaster_tag_t Tag> 3347636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool push_back(TypedTag<KM_BYTES, Tag> tag, const void* bytes, size_t bytes_len) { 3357636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return push_back(keymaster_param_blob(tag, static_cast<const uint8_t*>(bytes), bytes_len)); 3367636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 3377636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 338cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 339cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and blob to the set. Copies the blob contents into internal storage; does not 340cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the blob's data. 341cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 342cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden template <keymaster_tag_t Tag> 343cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden bool push_back(TypedTag<KM_BYTES, Tag> tag, const keymaster_blob_t& blob) { 344cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden return push_back(tag, blob.data, blob.data_length); 345cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden } 346cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden 347cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden /** 348cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * Append the tag and bignum array to the set. Copies the array into internal storage; does not 349cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden * take ownership of the passed-in array. 350cb0d64b02d0df2b9eb692c5b0ea5c36db1000e9aShawn Willden */ 3517636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden template <keymaster_tag_t Tag> 3527636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden bool push_back(TypedTag<KM_BIGNUM, Tag> tag, const void* bytes, size_t bytes_len) { 3537636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden return push_back(keymaster_param_blob(tag, static_cast<const uint8_t*>(bytes), bytes_len)); 3547636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden } 3557636471bd1c553ac179f0dddc17133491d0e1fafShawn Willden 3565ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 3575ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedTag<Type, Tag> tag, typename TypedTag<Type, Tag>::value_type val) { 3585ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, val)); 3595ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3605ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3615ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden template <keymaster_tag_t Tag, keymaster_tag_type_t Type> 3625ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool push_back(TypedTag<Type, Tag> tag, const void* bytes, size_t bytes_len) { 3635ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden return push_back(Authorization(tag, bytes, bytes_len)); 3645ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden } 3655ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 36658e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden /* Virtual methods from Serializable */ 36758e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden size_t SerializedSize() const; 36858e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden uint8_t* Serialize(uint8_t* serialized_set, const uint8_t* end) const; 369172f8c9be706e27f43022063bbc7f4b0177583acShawn Willden bool Deserialize(const uint8_t** buf_ptr, const uint8_t* end); 3705ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3718d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden size_t SerializedSizeOfElements() const; 3728d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden 3735ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden private: 37458e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden // Disallow assignment 37558e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden void operator=(const AuthorizationSet&); 37658e1a5486219a1be9264d4e863a9dd3e393906c3Shawn Willden 3775ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void FreeData(); 3785ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void set_invalid(Error err); 3795ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 3805ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden static size_t ComputeIndirectDataSize(const keymaster_key_param_t* elems, size_t count); 3815ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden void CopyIndirectData(); 3828d336ae10df66da4c0433f17c2d42e85baea32c5Shawn Willden bool CheckIndirectData(); 3835ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 384370121346777e13437c275fbe7a975d899cc325cShawn Willden bool DeserializeIndirectData(const uint8_t** buf_ptr, const uint8_t* end); 385370121346777e13437c275fbe7a975d899cc325cShawn Willden bool DeserializeElementsData(const uint8_t** buf_ptr, const uint8_t* end); 386370121346777e13437c275fbe7a975d899cc325cShawn Willden 3875ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueEnum(keymaster_tag_t tag, uint32_t* val) const; 3885ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueEnumRep(keymaster_tag_t tag, size_t instance, uint32_t* val) const; 3895ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueInt(keymaster_tag_t tag, uint32_t* val) const; 3905ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueIntRep(keymaster_tag_t tag, size_t instance, uint32_t* val) const; 3915ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueLong(keymaster_tag_t tag, uint64_t* val) const; 392eb63b9799eadcaa6ef206f8b804d7432e0dab14aShawn Willden bool GetTagValueLongRep(keymaster_tag_t tag, size_t instance, uint64_t* val) const; 3935ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueDate(keymaster_tag_t tag, uint64_t* val) const; 3945ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden bool GetTagValueBlob(keymaster_tag_t tag, keymaster_blob_t* val) const; 395dfa1c030e941cba4e66b362854d84b19298353c9Shawn Willden bool GetTagValueBool(keymaster_tag_t tag) const; 3965ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 397edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden bool ContainsEnumValue(keymaster_tag_t tag, uint32_t val) const; 398edb7994f7d5764fcf06188dc005743f4209deb0fShawn Willden 399bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden // Define elems_ and elems_size_ as aliases to params and length, respectivley. This is to 400bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden // avoid using the variables without the trailing underscore in the implementation. 401bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden keymaster_key_param_t*& elems_ = keymaster_key_param_set_t::params; 402bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden size_t& elems_size_ = keymaster_key_param_set_t::length; 403bf0679a97499f92abc664179ddb8c1e3974f5c85Shawn Willden 4045ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t elems_capacity_; 4055ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden uint8_t* indirect_data_; 4065ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t indirect_data_size_; 4075ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden size_t indirect_data_capacity_; 4085ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden Error error_; 4095ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden}; 4105ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 4112c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdenclass AuthorizationSetBuilder { 4122c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden public: 4132c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <typename TagType, typename ValueType> 4142c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TagType tag, ValueType value) { 4152c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag, value); 4162c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4172c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4182c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4192c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4202c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BOOL, Tag> tag) { 4212c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag); 4222c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4232c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4242c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4252c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4262c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_INVALID, Tag> tag) { 4272c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden keymaster_key_param_t param; 4282c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden param.tag = tag; 4292c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(param); 4302c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4312c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4322c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4332c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4342c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BYTES, Tag> tag, const uint8_t* data, 4352c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden size_t data_length) { 4362c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.push_back(tag, data, data_length); 4372c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4382c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4392c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4402c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden template <keymaster_tag_t Tag> 4412c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Authorization(TypedTag<KM_BYTES, Tag> tag, const char* data, 4422c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden size_t data_length) { 4432c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(tag, reinterpret_cast<const uint8_t*>(data), data_length); 4442c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4452c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4462c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& RsaKey(uint32_t key_size, uint64_t public_exponent); 4472c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& EcdsaKey(uint32_t key_size); 4482c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& AesKey(uint32_t key_size); 449af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& HmacKey(uint32_t key_size); 4502c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 451af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& RsaSigningKey(uint32_t key_size, uint64_t public_exponent); 452af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& RsaEncryptionKey(uint32_t key_size, uint64_t public_exponent); 453af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& EcdsaSigningKey(uint32_t key_size); 4542c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& AesEncryptionKey(uint32_t key_size); 455af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 4562c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& SigningKey(); 4572c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& EncryptionKey(); 4582c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& NoDigestOrPadding(); 459c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willden AuthorizationSetBuilder& EcbMode(); 4602c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 461af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& Digest(keymaster_digest_t digest) { 462af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return Authorization(TAG_DIGEST, digest); 463af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden } 464af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 465af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden AuthorizationSetBuilder& Padding(keymaster_padding_t padding) { 466af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return Authorization(TAG_PADDING, padding); 467af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden } 468af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden 4692c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSetBuilder& Deduplicate() { 4702c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden set.Deduplicate(); 4712c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4722c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden } 4732c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4742c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSet build() const { return set; } 4752c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4762c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden private: 4772c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden friend AuthorizationSet; 4782c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AuthorizationSet set; 4792c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden}; 4802c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4812c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::RsaKey(uint32_t key_size, 4822c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden uint64_t public_exponent) { 4832c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_RSA); 4842c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 4852c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_RSA_PUBLIC_EXPONENT, public_exponent); 4862c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4872c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 4882c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4892c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcdsaKey(uint32_t key_size) { 4909c65b2bd1978a918b52a459596dafc7dde992416Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_EC); 4912c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 4922c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return *this; 4932c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 4942c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 4952c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::AesKey(uint32_t key_size) { 4962c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_AES); 4972c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_KEY_SIZE, key_size); 4982c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 4992c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 500af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::HmacKey(uint32_t key_size) { 5012c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_ALGORITHM, KM_ALGORITHM_HMAC); 5022c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_KEY_SIZE, key_size); 503af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5042c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5052c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 506af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::RsaSigningKey(uint32_t key_size, 507af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden uint64_t public_exponent) { 5082c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden RsaKey(key_size, public_exponent); 509af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5102c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5112c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5122c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& 513af533990df2265e48d01b187a8e86eefa04d1be3Shawn WilldenAuthorizationSetBuilder::RsaEncryptionKey(uint32_t key_size, uint64_t public_exponent) { 5142c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden RsaKey(key_size, public_exponent); 515af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return EncryptionKey(); 5162c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5172c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 518af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcdsaSigningKey(uint32_t key_size) { 5192c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden EcdsaKey(key_size); 520af533990df2265e48d01b187a8e86eefa04d1be3Shawn Willden return SigningKey(); 5212c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5222c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5232c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::AesEncryptionKey(uint32_t key_size) { 5242c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden AesKey(key_size); 5252c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return EncryptionKey(); 5262c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5272c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5282c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::SigningKey() { 5292c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_PURPOSE, KM_PURPOSE_SIGN); 5302c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PURPOSE, KM_PURPOSE_VERIFY); 5312c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5322c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5332c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EncryptionKey() { 5342c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_PURPOSE, KM_PURPOSE_ENCRYPT); 5352c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PURPOSE, KM_PURPOSE_DECRYPT); 5362c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5372c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5382c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::NoDigestOrPadding() { 5392c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden Authorization(TAG_DIGEST, KM_DIGEST_NONE); 5402c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden return Authorization(TAG_PADDING, KM_PAD_NONE); 5412c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5422c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 543c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willdeninline AuthorizationSetBuilder& AuthorizationSetBuilder::EcbMode() { 544c47c88f1a9ec3fce5e8116b9b5572b58783f56d0Shawn Willden return Authorization(TAG_BLOCK_MODE, KM_MODE_ECB); 5452c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden} 5462c242009007a38b5c8003137fb8ba5a1fdb73b70Shawn Willden 5475ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden} // namespace keymaster 5485ada7b6c525d2bfd5b556a698ccb11db23e052bbShawn Willden 549b10f3b26af1e3b382d9ef361b3eb5279d16a9c05Shawn Willden#endif // SYSTEM_KEYMASTER_KEY_AUTHORIZATION_SET_H_ 550