1 /* 2 * Copyright (c) 2019, The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 #include <memory> 20 #include <vector> 21 #include "aidl/android/hardware/security/keymint/IRemotelyProvisionedComponent.h" 22 23 #include <keymaster/cppcose/cppcose.h> 24 25 namespace aidl::android::hardware::security::keymint::remote_prov { 26 27 using bytevec = std::vector<uint8_t>; 28 using namespace cppcose; 29 30 extern bytevec kTestMacKey; 31 32 // The Google root key for the Endpoint Encryption Key chain, encoded as COSE_Sign1 33 inline constexpr uint8_t kCoseEncodedRootCert[] = { 34 0x84, 0x43, 0xa1, 0x01, 0x27, 0xa0, 0x58, 0x2a, 0xa4, 0x01, 0x01, 0x03, 0x27, 0x20, 0x06, 35 0x21, 0x58, 0x20, 0x99, 0xb9, 0xee, 0xdd, 0x5e, 0xe4, 0x52, 0xf6, 0x85, 0xc6, 0x4c, 0x62, 36 0xdc, 0x3e, 0x61, 0xab, 0x57, 0x48, 0x7d, 0x75, 0x37, 0x29, 0xad, 0x76, 0x80, 0x32, 0xd2, 37 0xb3, 0xcb, 0x63, 0x58, 0xd9, 0x58, 0x40, 0x1e, 0x22, 0x08, 0x4b, 0xa4, 0xb7, 0xa4, 0xc8, 38 0xd7, 0x4e, 0x03, 0x0e, 0xfe, 0xb8, 0xaf, 0x14, 0x4c, 0xa7, 0x3b, 0x6f, 0xa5, 0xcd, 0xdc, 39 0xda, 0x79, 0xc6, 0x2b, 0x64, 0xfe, 0x99, 0x39, 0xaf, 0x76, 0xe7, 0x80, 0xfa, 0x66, 0x00, 40 0x85, 0x0d, 0x07, 0x98, 0x2a, 0xac, 0x91, 0x5c, 0xa7, 0x25, 0x14, 0x49, 0x06, 0x34, 0x75, 41 0xca, 0x8a, 0x27, 0x7a, 0xd9, 0xe3, 0x5a, 0x49, 0xeb, 0x02, 0x03}; 42 43 // The Google Endpoint Encryption Key certificate, encoded as COSE_Sign1 44 inline constexpr uint8_t kCoseEncodedGeekCert[] = { 45 0x84, 0x43, 0xa1, 0x01, 0x27, 0xa0, 0x58, 0x4e, 0xa5, 0x01, 0x01, 0x02, 0x58, 0x20, 46 0xd0, 0xae, 0xc1, 0x15, 0xca, 0x2a, 0xcf, 0x73, 0xae, 0x6b, 0xcc, 0xcb, 0xd1, 0x96, 47 0x1d, 0x65, 0xe8, 0xb1, 0xdd, 0xd7, 0x4a, 0x1a, 0x37, 0xb9, 0x43, 0x3a, 0x97, 0xd5, 48 0x99, 0xdf, 0x98, 0x08, 0x03, 0x38, 0x18, 0x20, 0x04, 0x21, 0x58, 0x20, 0xbe, 0x85, 49 0xe7, 0x46, 0xc4, 0xa3, 0x42, 0x5a, 0x40, 0xd9, 0x36, 0x3a, 0xa6, 0x15, 0xd0, 0x2c, 50 0x58, 0x7e, 0x3d, 0xdc, 0x33, 0x02, 0x32, 0xd2, 0xfc, 0x5e, 0x1e, 0x87, 0x25, 0x5f, 51 0x72, 0x60, 0x58, 0x40, 0x9b, 0xcf, 0x90, 0xe2, 0x2e, 0x4b, 0xab, 0xd1, 0x18, 0xb1, 52 0x0e, 0x8e, 0x5d, 0x20, 0x27, 0x4b, 0x84, 0x58, 0xfe, 0xfc, 0x32, 0x90, 0x7e, 0x72, 53 0x05, 0x83, 0xbc, 0xd7, 0x82, 0xbe, 0xfa, 0x64, 0x78, 0x2d, 0x54, 0x10, 0x4b, 0xc0, 54 0x31, 0xbf, 0x6b, 0xe8, 0x1e, 0x35, 0xe2, 0xf0, 0x2d, 0xce, 0x6c, 0x2f, 0x4f, 0xf2, 55 0xf5, 0x4f, 0xa5, 0xd4, 0x83, 0xad, 0x96, 0xa2, 0xf1, 0x87, 0x58, 0x04}; 56 57 // The Google ECDSA P256 root key for the Endpoint Encryption Key chain, encoded as COSE_Sign1 58 inline constexpr uint8_t kCoseEncodedEcdsa256RootCert[] = { 59 0x84, 0x43, 0xa1, 0x01, 0x26, 0xa0, 0x58, 0x4d, 0xa5, 0x01, 0x02, 0x03, 0x26, 0x20, 0x01, 0x21, 60 0x58, 0x20, 0xf7, 0x14, 0x8a, 0xdb, 0x97, 0xf4, 0xcc, 0x53, 0xef, 0xd2, 0x64, 0x11, 0xc4, 0xe3, 61 0x75, 0x1f, 0x66, 0x1f, 0xa4, 0x71, 0x0c, 0x6c, 0xcf, 0xfa, 0x09, 0x46, 0x80, 0x74, 0x87, 0x54, 62 0xf2, 0xad, 0x22, 0x58, 0x20, 0x5e, 0x7f, 0x5b, 0xf6, 0xec, 0xe4, 0xf6, 0x19, 0xcc, 0xff, 0x13, 63 0x37, 0xfd, 0x0f, 0xa1, 0xc8, 0x93, 0xdb, 0x18, 0x06, 0x76, 0xc4, 0x5d, 0xe6, 0xd7, 0x6a, 0x77, 64 0x86, 0xc3, 0x2d, 0xaf, 0x8f, 0x58, 0x40, 0x2f, 0x97, 0x8e, 0x42, 0xfb, 0xbe, 0x07, 0x2d, 0x95, 65 0x47, 0x85, 0x47, 0x93, 0x40, 0xb0, 0x1f, 0xd4, 0x9b, 0x47, 0xa4, 0xc4, 0x44, 0xa9, 0xf2, 0xa1, 66 0x07, 0x87, 0x10, 0xc7, 0x9f, 0xcb, 0x11, 0xf4, 0xbf, 0x9f, 0xe8, 0x3b, 0xe0, 0xe7, 0x34, 0x4c, 67 0x15, 0xfc, 0x7b, 0xc3, 0x7e, 0x33, 0x05, 0xf4, 0xd1, 0x34, 0x3c, 0xed, 0x02, 0x04, 0x60, 0x7a, 68 0x15, 0xe0, 0x79, 0xd3, 0x8a, 0xff, 0x24}; 69 70 // The Google ECDSA P256 Endpoint Encryption Key certificate, encoded as COSE_Sign1 71 inline constexpr uint8_t kCoseEncodedEcdsa256GeekCert[] = { 72 0x84, 0x43, 0xa1, 0x01, 0x26, 0xa0, 0x58, 0x71, 0xa6, 0x01, 0x02, 0x02, 0x58, 0x20, 0x35, 0x73, 73 0xb7, 0x3f, 0xa0, 0x8a, 0x80, 0x89, 0xb1, 0x26, 0x67, 0xe9, 0xcb, 0x7c, 0x75, 0xa1, 0xaf, 0x02, 74 0x61, 0xfc, 0x6e, 0x65, 0x03, 0x91, 0x3b, 0xd3, 0x4b, 0x7d, 0x14, 0x94, 0x3e, 0x46, 0x03, 0x38, 75 0x18, 0x20, 0x01, 0x21, 0x58, 0x20, 0xe0, 0x41, 0xcf, 0x2f, 0x0f, 0x34, 0x0f, 0x1c, 0x33, 0x2c, 76 0x41, 0xb0, 0xcf, 0xd7, 0x0c, 0x30, 0x55, 0x35, 0xd2, 0x1e, 0x6a, 0x47, 0x13, 0x4b, 0x2e, 0xd1, 77 0x48, 0x96, 0x7e, 0x24, 0x9c, 0x68, 0x22, 0x58, 0x20, 0x1f, 0xce, 0x45, 0xc5, 0xfb, 0x61, 0xba, 78 0x81, 0x21, 0xf9, 0xe5, 0x05, 0x9b, 0x9b, 0x39, 0x0e, 0x76, 0x86, 0x86, 0x47, 0xb8, 0x1e, 0x2f, 79 0x45, 0xf1, 0xce, 0xaf, 0xda, 0x3f, 0x80, 0x68, 0xdb, 0x58, 0x40, 0x8c, 0xb3, 0xba, 0x7e, 0x20, 80 0x3e, 0x32, 0xb0, 0x68, 0xdf, 0x60, 0xd1, 0x1d, 0x7d, 0xf0, 0xac, 0x38, 0x8e, 0x51, 0xbc, 0xff, 81 0x6c, 0xe1, 0x67, 0x3b, 0x4a, 0x79, 0xbc, 0x56, 0x78, 0xb3, 0x99, 0xd8, 0x7c, 0x8a, 0x07, 0xd8, 82 0xda, 0xb5, 0xb5, 0x7f, 0x71, 0xf4, 0xd8, 0x6b, 0xdf, 0x33, 0x27, 0x34, 0x7b, 0x65, 0xd1, 0x2a, 83 0xeb, 0x86, 0x99, 0x98, 0xab, 0x3a, 0xb4, 0x80, 0xaa, 0xbd, 0x50}; 84 85 /** 86 * Generates random bytes. 87 */ 88 bytevec randomBytes(size_t numBytes); 89 90 struct EekChain { 91 bytevec chain; 92 bytevec last_pubkey; 93 bytevec last_privkey; 94 }; 95 96 /** 97 * Based on the supportedEekCurve, Generates an X25519/ECDH with the specified eekId 98 * and an Ed25519/ECDSA chain of the specified length. All keys are generated randomly. 99 */ 100 ErrMsgOr<EekChain> generateEekChain(int32_t supportedEekCurve, size_t length, const bytevec& eekId); 101 102 /** 103 * Returns the CBOR-encoded, production Google Endpoint Encryption Key chain. 104 */ 105 bytevec getProdEekChain(int32_t supportedEekCurve); 106 107 struct BccEntryData { 108 bytevec pubKey; 109 }; 110 111 struct JsonOutput { OkJsonOutput112 static JsonOutput Ok(std::string json) { return {std::move(json), ""}; } ErrorJsonOutput113 static JsonOutput Error(std::string error) { return {"", std::move(error)}; } 114 115 std::string output; 116 std::string error; // if non-empty, this describes what went wrong 117 }; 118 119 /** 120 * Take a given instance name and certificate request, then output a JSON blob 121 * containing the name, build fingerprint and certificate request. This data may 122 * be serialized, then later uploaded to the remote provisioning service. The 123 * input csr is not validated, only encoded. 124 * 125 * Output format: 126 * { 127 * "build_fingerprint": <string> 128 * "csr": <base64 CBOR CSR> 129 * "name": <string> 130 * } 131 */ 132 JsonOutput jsonEncodeCsrWithBuild(const std::string instance_name, 133 const cppbor::Array& csr); 134 135 /** 136 * Parses a DeviceInfo structure from the given CBOR data. The parsed data is then validated to 137 * ensure it contains the minimum required data at the time of manufacturing. This is only a 138 * partial validation, as some fields may not be provisioned yet at the time this information 139 * is parsed in the manufacturing process. 140 */ 141 ErrMsgOr<std::unique_ptr<cppbor::Map>> parseAndValidateFactoryDeviceInfo( 142 const std::vector<uint8_t>& deviceInfoBytes, IRemotelyProvisionedComponent* provisionable); 143 144 /** 145 * Parses a DeviceInfo structure from the given CBOR data. The parsed data is then validated to 146 * ensure it is formatted correctly and that it contains the required values for Remote Key 147 * Provisioning. This is a full validation, and assumes the device is provisioned as if it is 148 * suitable for the end user. 149 */ 150 ErrMsgOr<std::unique_ptr<cppbor::Map>> parseAndValidateProductionDeviceInfo( 151 const std::vector<uint8_t>& deviceInfoBytes, IRemotelyProvisionedComponent* provisionable); 152 153 /** 154 * Verify the protected data as if the device is still early in the factory process and may not 155 * have all device identifiers provisioned yet. 156 */ 157 ErrMsgOr<std::vector<BccEntryData>> verifyFactoryProtectedData( 158 const DeviceInfo& deviceInfo, const cppbor::Array& keysToSign, 159 const std::vector<uint8_t>& keysToSignMac, const ProtectedData& protectedData, 160 const EekChain& eekChain, const std::vector<uint8_t>& eekId, int32_t supportedEekCurve, 161 IRemotelyProvisionedComponent* provisionable, const std::vector<uint8_t>& challenge); 162 /** 163 * Verify the protected data as if the device is a final production sample. 164 */ 165 ErrMsgOr<std::vector<BccEntryData>> verifyProductionProtectedData( 166 const DeviceInfo& deviceInfo, const cppbor::Array& keysToSign, 167 const std::vector<uint8_t>& keysToSignMac, const ProtectedData& protectedData, 168 const EekChain& eekChain, const std::vector<uint8_t>& eekId, int32_t supportedEekCurve, 169 IRemotelyProvisionedComponent* provisionable, const std::vector<uint8_t>& challenge); 170 171 /** 172 * Verify the CSR as if the device is still early in the factory process and may not 173 * have all device identifiers provisioned yet. 174 */ 175 ErrMsgOr<std::unique_ptr<cppbor::Array>> verifyFactoryCsr( 176 const cppbor::Array& keysToSign, const std::vector<uint8_t>& csr, 177 IRemotelyProvisionedComponent* provisionable, const std::vector<uint8_t>& challenge); 178 /** 179 * Verify the CSR as if the device is a final production sample. 180 */ 181 ErrMsgOr<std::unique_ptr<cppbor::Array>> verifyProductionCsr( 182 const cppbor::Array& keysToSign, const std::vector<uint8_t>& csr, 183 IRemotelyProvisionedComponent* provisionable, const std::vector<uint8_t>& challenge); 184 185 } // namespace aidl::android::hardware::security::keymint::remote_prov 186