Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceDevices/DS28E83_DS28E84.hpp@8:5ea891c7d1a1, 2019-09-16 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Sep 16 11:13:37 2019 -0500
Revision:
8:5ea891c7d1a1
Parent:
7:9cd16581b578
Child:
12:7eb41621ba22
Updated to version 2.0.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 8:5ea891c7d1a1 33 #ifndef MaximInterfaceDevices_DS28E83_DS28E84_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceDevices_DS28E83_DS28E84_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <stdint.h>
IanBenzMaxim 8:5ea891c7d1a1 37 #include <utility>
IanBenzMaxim 7:9cd16581b578 38 #include <MaximInterfaceCore/Algorithm.hpp>
IanBenzMaxim 7:9cd16581b578 39 #include <MaximInterfaceCore/array_span.hpp>
IanBenzMaxim 7:9cd16581b578 40 #include <MaximInterfaceCore/Ecc256.hpp>
IanBenzMaxim 7:9cd16581b578 41 #include <MaximInterfaceCore/FlagSet.hpp>
IanBenzMaxim 7:9cd16581b578 42 #include <MaximInterfaceCore/ManId.hpp>
IanBenzMaxim 7:9cd16581b578 43 #include <MaximInterfaceCore/Optional.hpp>
IanBenzMaxim 7:9cd16581b578 44 #include <MaximInterfaceCore/RomId.hpp>
IanBenzMaxim 7:9cd16581b578 45 #include <MaximInterfaceCore/RunCommand.hpp>
IanBenzMaxim 7:9cd16581b578 46 #include <MaximInterfaceCore/system_error.hpp>
IanBenzMaxim 7:9cd16581b578 47 #include "Config.hpp"
IanBenzMaxim 7:9cd16581b578 48
IanBenzMaxim 7:9cd16581b578 49 namespace MaximInterfaceDevices {
IanBenzMaxim 7:9cd16581b578 50
IanBenzMaxim 7:9cd16581b578 51 class DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 52 public:
IanBenzMaxim 7:9cd16581b578 53 /// Device command results.
IanBenzMaxim 7:9cd16581b578 54 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 55 InternalError = 0x22,
IanBenzMaxim 7:9cd16581b578 56 InvalidSequenceError = 0x33,
IanBenzMaxim 7:9cd16581b578 57 InvalidOperationError = 0x55,
IanBenzMaxim 7:9cd16581b578 58 InvalidParameterError = 0x77,
IanBenzMaxim 7:9cd16581b578 59 DeviceDisabledError = 0x88,
IanBenzMaxim 7:9cd16581b578 60 AuthenticationError = 0x100,
IanBenzMaxim 7:9cd16581b578 61 InvalidResponseError ///< Command response does not match expected format.
IanBenzMaxim 7:9cd16581b578 62 };
IanBenzMaxim 7:9cd16581b578 63
IanBenzMaxim 7:9cd16581b578 64 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 65 /// @{
IanBenzMaxim 7:9cd16581b578 66
IanBenzMaxim 7:9cd16581b578 67 static const int publicKeyAxPage = 28;
IanBenzMaxim 7:9cd16581b578 68 static const int publicKeyAyPage = 29;
IanBenzMaxim 7:9cd16581b578 69 static const int publicKeyBxPage = 30;
IanBenzMaxim 7:9cd16581b578 70 static const int publicKeyByPage = 31;
IanBenzMaxim 7:9cd16581b578 71 static const int authorityPublicKeyAxPage = 32;
IanBenzMaxim 7:9cd16581b578 72 static const int authorityPublicKeyAyPage = 33;
IanBenzMaxim 7:9cd16581b578 73 static const int authorityPublicKeyBxPage = 34;
IanBenzMaxim 7:9cd16581b578 74 static const int authorityPublicKeyByPage = 35;
IanBenzMaxim 7:9cd16581b578 75 static const int privateKeyAPage = 36;
IanBenzMaxim 7:9cd16581b578 76 static const int privateKeyBPage = 37;
IanBenzMaxim 7:9cd16581b578 77 static const int secretAPage = 38;
IanBenzMaxim 7:9cd16581b578 78 static const int secretBPage = 39;
IanBenzMaxim 7:9cd16581b578 79 static const int romOptionsPage = 40;
IanBenzMaxim 7:9cd16581b578 80 static const int gpioControlPage = 41;
IanBenzMaxim 7:9cd16581b578 81 static const int publicKeySxPage = 42;
IanBenzMaxim 7:9cd16581b578 82 static const int publicKeySyPage = 43;
IanBenzMaxim 7:9cd16581b578 83
IanBenzMaxim 7:9cd16581b578 84 /// @}
IanBenzMaxim 7:9cd16581b578 85
IanBenzMaxim 7:9cd16581b578 86 /// Key or secret to use for operation.
IanBenzMaxim 7:9cd16581b578 87 enum KeySecret { KeySecretA = 0, KeySecretB = 1, KeySecretS = 2 };
IanBenzMaxim 7:9cd16581b578 88
IanBenzMaxim 7:9cd16581b578 89 /// Available PIO states when verifying an ECDSA signature.
IanBenzMaxim 7:9cd16581b578 90 enum GpioState { Unchanged, Conducting, HighImpedance };
IanBenzMaxim 7:9cd16581b578 91
IanBenzMaxim 7:9cd16581b578 92 /// Holds a device memory page.
IanBenzMaxim 7:9cd16581b578 93 typedef Core::array_span<uint_least8_t, 32> Page;
IanBenzMaxim 7:9cd16581b578 94
IanBenzMaxim 7:9cd16581b578 95 /// Challenge for an encrypted device memory page.
IanBenzMaxim 7:9cd16581b578 96 typedef Core::array_span<uint_least8_t, 8> EncryptionChallenge;
IanBenzMaxim 7:9cd16581b578 97
IanBenzMaxim 7:9cd16581b578 98 // Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 99 class PageAuthenticationData;
IanBenzMaxim 7:9cd16581b578 100
IanBenzMaxim 7:9cd16581b578 101 // Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 102 class WriteAuthenticationData;
IanBenzMaxim 7:9cd16581b578 103
IanBenzMaxim 7:9cd16581b578 104 // Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 105 class ComputeSecretData;
IanBenzMaxim 7:9cd16581b578 106
IanBenzMaxim 7:9cd16581b578 107 // Format decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 108 class DecryptionHmacData;
IanBenzMaxim 7:9cd16581b578 109
IanBenzMaxim 7:9cd16581b578 110 // Format encryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 111 class EncryptionHmacData;
IanBenzMaxim 7:9cd16581b578 112
IanBenzMaxim 7:9cd16581b578 113 // Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 114 class RomOptions;
IanBenzMaxim 7:9cd16581b578 115
IanBenzMaxim 7:9cd16581b578 116 // Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 117 class GpioControl;
IanBenzMaxim 7:9cd16581b578 118
IanBenzMaxim 7:9cd16581b578 119 /// Page protection types.
IanBenzMaxim 7:9cd16581b578 120 enum BlockProtectionType {
IanBenzMaxim 7:9cd16581b578 121 RP = 0x01, ///< Read protection.
IanBenzMaxim 7:9cd16581b578 122 WP = 0x02, ///< Write protection.
IanBenzMaxim 7:9cd16581b578 123 EM = 0x04, ///< EPROM emulation mode.
IanBenzMaxim 7:9cd16581b578 124 APH = 0x08, ///< Authentication Write Protection HMAC
IanBenzMaxim 7:9cd16581b578 125 EPH = 0x10, ///< Encryption and Authentication Write Protection HMAC
IanBenzMaxim 7:9cd16581b578 126 ECH = 0x40, ///< Encryption and write using shared key from ECDH
IanBenzMaxim 7:9cd16581b578 127 ECW = 0x80 ///< Authentication Write Protection ECDSA
IanBenzMaxim 7:9cd16581b578 128 };
IanBenzMaxim 7:9cd16581b578 129 typedef Core::FlagSet<BlockProtectionType, 8> BlockProtection;
IanBenzMaxim 7:9cd16581b578 130
IanBenzMaxim 7:9cd16581b578 131 protected:
IanBenzMaxim 7:9cd16581b578 132 explicit DS28E83_DS28E84(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 133 : doRunCommand(runCommand) {}
IanBenzMaxim 7:9cd16581b578 134
IanBenzMaxim 7:9cd16581b578 135 ~DS28E83_DS28E84() {}
IanBenzMaxim 7:9cd16581b578 136
IanBenzMaxim 7:9cd16581b578 137 public:
IanBenzMaxim 7:9cd16581b578 138 void setRunCommand(const Core::RunCommand & runCommand) {
IanBenzMaxim 7:9cd16581b578 139 doRunCommand = runCommand;
IanBenzMaxim 7:9cd16581b578 140 }
IanBenzMaxim 7:9cd16581b578 141
IanBenzMaxim 7:9cd16581b578 142 /// @brief Write memory with no protection.
IanBenzMaxim 7:9cd16581b578 143 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 144 /// @param page Data to write.
IanBenzMaxim 8:5ea891c7d1a1 145 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 146 writeMemory(int pageNum, Page::const_span page);
IanBenzMaxim 7:9cd16581b578 147
IanBenzMaxim 7:9cd16581b578 148 /// @brief Read memory with no protection.
IanBenzMaxim 7:9cd16581b578 149 /// @param pageNum Number of page to read.
IanBenzMaxim 8:5ea891c7d1a1 150 /// @returns Data that was read.
IanBenzMaxim 8:5ea891c7d1a1 151 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 152 readMemory(int pageNum) const;
IanBenzMaxim 7:9cd16581b578 153
IanBenzMaxim 7:9cd16581b578 154 /// @brief Read memory with encryption.
IanBenzMaxim 7:9cd16581b578 155 /// @param pageNum Number of page to read from.
IanBenzMaxim 7:9cd16581b578 156 /// @param secret Secret to use for encryption.
IanBenzMaxim 8:5ea891c7d1a1 157 /// @returns Encryption challenge and encrypted page data that was read.
IanBenzMaxim 8:5ea891c7d1a1 158 MaximInterfaceDevices_EXPORT
IanBenzMaxim 8:5ea891c7d1a1 159 Core::Result<std::pair<EncryptionChallenge::array, Page::array> >
IanBenzMaxim 8:5ea891c7d1a1 160 encryptedReadMemory(int pageNum, KeySecret secret) const;
IanBenzMaxim 7:9cd16581b578 161
IanBenzMaxim 7:9cd16581b578 162 /// @brief Read the protection settings of a block.
IanBenzMaxim 7:9cd16581b578 163 /// @param blockNum Number of block to read.
IanBenzMaxim 8:5ea891c7d1a1 164 /// @returns Secret/Key and protection set on the block.
IanBenzMaxim 8:5ea891c7d1a1 165 MaximInterfaceDevices_EXPORT
IanBenzMaxim 8:5ea891c7d1a1 166 Core::Result<std::pair<Core::Optional<KeySecret>, BlockProtection> >
IanBenzMaxim 8:5ea891c7d1a1 167 readBlockProtection(int blockNum) const;
IanBenzMaxim 7:9cd16581b578 168
IanBenzMaxim 7:9cd16581b578 169 /// @brief Set the protection settings of a block.
IanBenzMaxim 7:9cd16581b578 170 /// @param blockNum Number of block to write.
IanBenzMaxim 7:9cd16581b578 171 /// @param keySecret Secret/Key A or B.
IanBenzMaxim 7:9cd16581b578 172 /// @param protection Protection to write.
IanBenzMaxim 8:5ea891c7d1a1 173 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 174 setBlockProtection(int blockNum, KeySecret keySecret,
IanBenzMaxim 7:9cd16581b578 175 const BlockProtection & protection);
IanBenzMaxim 7:9cd16581b578 176
IanBenzMaxim 7:9cd16581b578 177 /// @brief Compute and read page authentication with ECDSA.
IanBenzMaxim 7:9cd16581b578 178 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 179 /// @param key
IanBenzMaxim 7:9cd16581b578 180 /// Private key to use for authentication.
IanBenzMaxim 7:9cd16581b578 181 /// Key S cannot be used with this command.
IanBenzMaxim 7:9cd16581b578 182 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 183 /// @returns Computed page signature.
IanBenzMaxim 8:5ea891c7d1a1 184 MaximInterfaceDevices_EXPORT Core::Result<Core::Ecc256::Signature::array>
IanBenzMaxim 8:5ea891c7d1a1 185 computeAndReadEcdsaPageAuthentication(int pageNum, KeySecret key,
IanBenzMaxim 8:5ea891c7d1a1 186 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 187
IanBenzMaxim 7:9cd16581b578 188 /// @brief Compute and read page authentication with HMAC.
IanBenzMaxim 7:9cd16581b578 189 /// @param pageNum Number of page to authenticate.
IanBenzMaxim 7:9cd16581b578 190 /// @param secret
IanBenzMaxim 7:9cd16581b578 191 /// Secret to use for authentication.
IanBenzMaxim 7:9cd16581b578 192 /// Secret S cannot be used with this command.
IanBenzMaxim 7:9cd16581b578 193 /// @param challenge Random challenge used to prevent replay attacks.
IanBenzMaxim 8:5ea891c7d1a1 194 /// @returns Computed page HMAC.
IanBenzMaxim 8:5ea891c7d1a1 195 MaximInterfaceDevices_EXPORT Core::Result<Page::array>
IanBenzMaxim 8:5ea891c7d1a1 196 computeAndReadSha256PageAuthentication(int pageNum, KeySecret secret,
IanBenzMaxim 8:5ea891c7d1a1 197 Page::const_span challenge) const;
IanBenzMaxim 7:9cd16581b578 198
IanBenzMaxim 7:9cd16581b578 199 /// @brief Compute a hash over multiple blocks.
IanBenzMaxim 7:9cd16581b578 200 /// @param firstBlock True if this is the first block being hashed.
IanBenzMaxim 7:9cd16581b578 201 /// @param lastBlock True if this is the last block being hashed.
IanBenzMaxim 7:9cd16581b578 202 /// @param data
IanBenzMaxim 7:9cd16581b578 203 /// Data block to hash. Should be 64 bytes unless this is the last block.
IanBenzMaxim 8:5ea891c7d1a1 204 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 205 computeMultiblockHash(bool firstBlock, bool lastBlock,
IanBenzMaxim 7:9cd16581b578 206 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 207
IanBenzMaxim 7:9cd16581b578 208 /// @brief Verify ECDSA signature with data input.
IanBenzMaxim 7:9cd16581b578 209 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 210 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 211 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 212 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 213 /// @param data Data to verify with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 214 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 215 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 216 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 217 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 218
IanBenzMaxim 7:9cd16581b578 219 /// @brief Verify ECDSA signature with hash input.
IanBenzMaxim 7:9cd16581b578 220 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 221 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 222 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 223 /// @param signature Signature to verify.
IanBenzMaxim 7:9cd16581b578 224 /// @param hash Hash of data to verify.
IanBenzMaxim 8:5ea891c7d1a1 225 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 226 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 227 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 228 Page::const_span hash);
IanBenzMaxim 7:9cd16581b578 229
IanBenzMaxim 7:9cd16581b578 230 /// @brief
IanBenzMaxim 7:9cd16581b578 231 /// Verify ECDSA signature with THASH input from Compute Multiblock Hash.
IanBenzMaxim 7:9cd16581b578 232 /// @param key Public key to use for verification.
IanBenzMaxim 7:9cd16581b578 233 /// @param authorityKey Use the authority key instead of the standard key.
IanBenzMaxim 7:9cd16581b578 234 /// @param gpioState New state of the GPIO pin if verification successful.
IanBenzMaxim 7:9cd16581b578 235 /// @param signature Signature to verify.
IanBenzMaxim 8:5ea891c7d1a1 236 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 237 verifyEcdsaSignature(KeySecret key, bool authorityKey, GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 238 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 239
IanBenzMaxim 7:9cd16581b578 240 /// @brief Authenticate a public key for authenticated writes.
IanBenzMaxim 7:9cd16581b578 241 /// @param key
IanBenzMaxim 7:9cd16581b578 242 /// Authority key to use for authentication. Key A or B can be selected.
IanBenzMaxim 7:9cd16581b578 243 /// @param cert Certificate to use for authentication of Public Key S.
IanBenzMaxim 7:9cd16581b578 244 /// @param certCustomization
IanBenzMaxim 7:9cd16581b578 245 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 8:5ea891c7d1a1 246 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 247 authenticateEcdsaPublicKey(KeySecret key,
IanBenzMaxim 7:9cd16581b578 248 Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 249 Core::span<const uint_least8_t> certCustomization);
IanBenzMaxim 7:9cd16581b578 250
IanBenzMaxim 7:9cd16581b578 251 /// @brief
IanBenzMaxim 7:9cd16581b578 252 /// Authenticate a public key for ECDH and optionally authenticated writes.
IanBenzMaxim 7:9cd16581b578 253 /// @param key
IanBenzMaxim 7:9cd16581b578 254 /// Keys to use for authentication and ECDH key exchange.
IanBenzMaxim 7:9cd16581b578 255 /// Key A or B can be selected.
IanBenzMaxim 7:9cd16581b578 256 /// @param authWrites True to select authentication for writes.
IanBenzMaxim 7:9cd16581b578 257 /// @param cert Certificate to use for authentication of Public Key S.
IanBenzMaxim 7:9cd16581b578 258 /// @param certCustomization
IanBenzMaxim 7:9cd16581b578 259 /// Certificate customization with length from 1 to 32.
IanBenzMaxim 7:9cd16581b578 260 /// @param ecdhCustomization ECDH customization with length from 1 to 48.
IanBenzMaxim 7:9cd16581b578 261 /// @note The maximum total customization length is 60 bytes.
IanBenzMaxim 8:5ea891c7d1a1 262 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 263 authenticateEcdsaPublicKey(KeySecret key, bool authWrites,
IanBenzMaxim 7:9cd16581b578 264 Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 265 Core::span<const uint_least8_t> certCustomization,
IanBenzMaxim 7:9cd16581b578 266 Core::span<const uint_least8_t> ecdhCustomization);
IanBenzMaxim 7:9cd16581b578 267
IanBenzMaxim 7:9cd16581b578 268 /// @brief Write with ECDSA authentication.
IanBenzMaxim 7:9cd16581b578 269 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 270 /// @param useKeyS
IanBenzMaxim 7:9cd16581b578 271 /// Use Public Key S instead of the authority key set in the block protection.
IanBenzMaxim 7:9cd16581b578 272 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 273 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 8:5ea891c7d1a1 274 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 275 authenticatedEcdsaWriteMemory(int pageNum, bool useKeyS,
IanBenzMaxim 7:9cd16581b578 276 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 277 Core::Ecc256::Signature::const_span signature);
IanBenzMaxim 7:9cd16581b578 278
IanBenzMaxim 7:9cd16581b578 279 /// @brief Write with ECDSA authentication and encryption.
IanBenzMaxim 7:9cd16581b578 280 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 281 /// @param useKeyS
IanBenzMaxim 7:9cd16581b578 282 /// Use Public Key S instead of the authority key set in the block protection.
IanBenzMaxim 7:9cd16581b578 283 /// @param newPageData Encrypted data to write.
IanBenzMaxim 7:9cd16581b578 284 /// @param signature Signature to use for authentication of page data.
IanBenzMaxim 7:9cd16581b578 285 /// @param challenge Challenge to use for decryption of page data.
IanBenzMaxim 8:5ea891c7d1a1 286 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 287 authenticatedEcdsaWriteMemory(int pageNum, bool useKeyS,
IanBenzMaxim 7:9cd16581b578 288 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 289 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 290 EncryptionChallenge::const_span challenge);
IanBenzMaxim 7:9cd16581b578 291
IanBenzMaxim 7:9cd16581b578 292 /// @brief Write with SHA-256 HMAC authentication.
IanBenzMaxim 7:9cd16581b578 293 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 294 /// @param useSecretS
IanBenzMaxim 7:9cd16581b578 295 /// Use Secret S instead of the secret set in the block protection.
IanBenzMaxim 7:9cd16581b578 296 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 297 /// @param hmac HMAC to use for authentication of page data.
IanBenzMaxim 8:5ea891c7d1a1 298 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 299 authenticatedSha256WriteMemory(int pageNum, bool useSecretS,
IanBenzMaxim 7:9cd16581b578 300 Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 301 Page::const_span hmac);
IanBenzMaxim 7:9cd16581b578 302
IanBenzMaxim 7:9cd16581b578 303 /// @brief Write with SHA-256 HMAC authentication and encryption.
IanBenzMaxim 7:9cd16581b578 304 /// @param pageNum Number of page to write.
IanBenzMaxim 7:9cd16581b578 305 /// @param useSecretS
IanBenzMaxim 7:9cd16581b578 306 /// Use Secret S instead of the secret set in the block protection.
IanBenzMaxim 7:9cd16581b578 307 /// @param newPageData Data to write.
IanBenzMaxim 7:9cd16581b578 308 /// @param hmac HMAC to use for authentication of page data.
IanBenzMaxim 7:9cd16581b578 309 /// @param challenge Challenge to use for decryption of page data.
IanBenzMaxim 8:5ea891c7d1a1 310 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 311 authenticatedSha256WriteMemory(int pageNum, bool useSecretS,
IanBenzMaxim 8:5ea891c7d1a1 312 Page::const_span newPageData,
IanBenzMaxim 8:5ea891c7d1a1 313 Page::const_span hmac,
IanBenzMaxim 8:5ea891c7d1a1 314 EncryptionChallenge::const_span challenge);
IanBenzMaxim 7:9cd16581b578 315
IanBenzMaxim 7:9cd16581b578 316 /// @brief Compute a derivative SHA-256 secret from an existing secret.
IanBenzMaxim 7:9cd16581b578 317 /// @param pageNum Number of page to use in computation.
IanBenzMaxim 7:9cd16581b578 318 /// @param masterSecret Master secret to use in computation.
IanBenzMaxim 7:9cd16581b578 319 /// @param destinationSecret
IanBenzMaxim 7:9cd16581b578 320 /// Destination secret to receive the computation result.
IanBenzMaxim 7:9cd16581b578 321 /// @param partialSecret Partial secret to use in computation.
IanBenzMaxim 8:5ea891c7d1a1 322 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 323 computeAndWriteSha256Secret(int pageNum, KeySecret masterSecret,
IanBenzMaxim 7:9cd16581b578 324 KeySecret destinationSecret,
IanBenzMaxim 7:9cd16581b578 325 Page::const_span partialSecret);
IanBenzMaxim 7:9cd16581b578 326
IanBenzMaxim 7:9cd16581b578 327 /// @brief Generate a new ECDSA key pair.
IanBenzMaxim 7:9cd16581b578 328 /// @param key Key to generate. Key S cannot be used with this command.
IanBenzMaxim 8:5ea891c7d1a1 329 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 330 generateEcc256KeyPair(KeySecret key);
IanBenzMaxim 7:9cd16581b578 331
IanBenzMaxim 7:9cd16581b578 332 /// @brief Read a block of random data from the RNG.
IanBenzMaxim 7:9cd16581b578 333 /// @param[out] data Random data from RNG with length from 1 to 64.
IanBenzMaxim 8:5ea891c7d1a1 334 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 335 readRng(Core::span<uint_least8_t> data) const;
IanBenzMaxim 7:9cd16581b578 336
IanBenzMaxim 7:9cd16581b578 337 /// Run entropy health test on the RNG.
IanBenzMaxim 8:5ea891c7d1a1 338 MaximInterfaceDevices_EXPORT Core::Result<void> entropyHealthTest() const;
IanBenzMaxim 7:9cd16581b578 339
IanBenzMaxim 7:9cd16581b578 340 MaximInterfaceDevices_EXPORT static const Core::error_category &
IanBenzMaxim 7:9cd16581b578 341 errorCategory();
IanBenzMaxim 7:9cd16581b578 342
IanBenzMaxim 7:9cd16581b578 343 protected:
IanBenzMaxim 8:5ea891c7d1a1 344 MaximInterfaceDevices_EXPORT Core::Result<Core::span<uint_least8_t> >
IanBenzMaxim 7:9cd16581b578 345 runCommand(Core::span<const uint_least8_t> request, int delayTime,
IanBenzMaxim 8:5ea891c7d1a1 346 Core::span<uint_least8_t> response) const;
IanBenzMaxim 7:9cd16581b578 347
IanBenzMaxim 8:5ea891c7d1a1 348 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 8:5ea891c7d1a1 349 runCommand(Core::span<const uint_least8_t> request, int delayTime) const;
IanBenzMaxim 7:9cd16581b578 350
IanBenzMaxim 7:9cd16581b578 351 private:
IanBenzMaxim 7:9cd16581b578 352 enum HashType { HashInput, DataInput, THASH };
IanBenzMaxim 7:9cd16581b578 353
IanBenzMaxim 8:5ea891c7d1a1 354 Core::Result<void>
IanBenzMaxim 7:9cd16581b578 355 verifyEcdsaSignature(KeySecret key, bool authorityKey, HashType hashType,
IanBenzMaxim 7:9cd16581b578 356 GpioState gpioState,
IanBenzMaxim 7:9cd16581b578 357 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 358 Core::span<const uint_least8_t> buffer);
IanBenzMaxim 7:9cd16581b578 359
IanBenzMaxim 8:5ea891c7d1a1 360 Core::Result<void> authenticateEcdsaPublicKey(
IanBenzMaxim 7:9cd16581b578 361 KeySecret key, bool authWrites, Core::Ecc256::Signature::const_span cert,
IanBenzMaxim 7:9cd16581b578 362 Core::span<const uint_least8_t> certCustomization,
IanBenzMaxim 7:9cd16581b578 363 const Core::span<const uint_least8_t> * ecdhCustomization);
IanBenzMaxim 7:9cd16581b578 364
IanBenzMaxim 8:5ea891c7d1a1 365 Core::Result<void> authenticatedEcdsaWriteMemory(
IanBenzMaxim 7:9cd16581b578 366 int pageNum, bool useKeyS, Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 367 Core::Ecc256::Signature::const_span signature,
IanBenzMaxim 7:9cd16581b578 368 const EncryptionChallenge::const_span * challenge);
IanBenzMaxim 7:9cd16581b578 369
IanBenzMaxim 8:5ea891c7d1a1 370 Core::Result<void> authenticatedSha256WriteMemory(
IanBenzMaxim 7:9cd16581b578 371 int pageNum, bool useSecretS, Page::const_span newPageData,
IanBenzMaxim 7:9cd16581b578 372 Page::const_span hmac, const EncryptionChallenge::const_span * challenge);
IanBenzMaxim 7:9cd16581b578 373
IanBenzMaxim 7:9cd16581b578 374 Core::RunCommand doRunCommand;
IanBenzMaxim 7:9cd16581b578 375 };
IanBenzMaxim 7:9cd16581b578 376
IanBenzMaxim 8:5ea891c7d1a1 377 } // namespace MaximInterfaceDevices
IanBenzMaxim 8:5ea891c7d1a1 378 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 379
IanBenzMaxim 8:5ea891c7d1a1 380 template <>
IanBenzMaxim 8:5ea891c7d1a1 381 struct is_error_code_enum<MaximInterfaceDevices::DS28E83_DS28E84::ErrorValue>
IanBenzMaxim 8:5ea891c7d1a1 382 : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 383
IanBenzMaxim 8:5ea891c7d1a1 384 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 385 namespace MaximInterfaceDevices {
IanBenzMaxim 8:5ea891c7d1a1 386
IanBenzMaxim 7:9cd16581b578 387 inline Core::error_code make_error_code(DS28E83_DS28E84::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 388 return Core::error_code(e, DS28E83_DS28E84::errorCategory());
IanBenzMaxim 7:9cd16581b578 389 }
IanBenzMaxim 7:9cd16581b578 390
IanBenzMaxim 7:9cd16581b578 391 class DS28E83 : public DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 392 public:
IanBenzMaxim 7:9cd16581b578 393 static const int memoryPages = 44;
IanBenzMaxim 7:9cd16581b578 394 static const int protectionBlocks = 9;
IanBenzMaxim 7:9cd16581b578 395
IanBenzMaxim 7:9cd16581b578 396 explicit DS28E83(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 397 : DS28E83_DS28E84(runCommand) {}
IanBenzMaxim 7:9cd16581b578 398 };
IanBenzMaxim 7:9cd16581b578 399
IanBenzMaxim 7:9cd16581b578 400 class DS28E84 : public DS28E83_DS28E84 {
IanBenzMaxim 7:9cd16581b578 401 public:
IanBenzMaxim 7:9cd16581b578 402 /// @name Device memory pages
IanBenzMaxim 7:9cd16581b578 403 /// @{
IanBenzMaxim 7:9cd16581b578 404
IanBenzMaxim 7:9cd16581b578 405 static const int publicKeySxBackupPage = 104;
IanBenzMaxim 7:9cd16581b578 406 static const int publicKeySyBackupPage = 105;
IanBenzMaxim 7:9cd16581b578 407 static const int decrementCounterPage = 106;
IanBenzMaxim 7:9cd16581b578 408
IanBenzMaxim 7:9cd16581b578 409 /// @}
IanBenzMaxim 7:9cd16581b578 410
IanBenzMaxim 7:9cd16581b578 411 static const int memoryPages = 107;
IanBenzMaxim 7:9cd16581b578 412 static const int protectionBlocks = 24;
IanBenzMaxim 7:9cd16581b578 413
IanBenzMaxim 8:5ea891c7d1a1 414 enum StateOperation { Restore, Backup };
IanBenzMaxim 7:9cd16581b578 415
IanBenzMaxim 7:9cd16581b578 416 explicit DS28E84(const Core::RunCommand & runCommand)
IanBenzMaxim 7:9cd16581b578 417 : DS28E83_DS28E84(runCommand) {}
IanBenzMaxim 7:9cd16581b578 418
IanBenzMaxim 7:9cd16581b578 419 /// Decrement the decrement-only counter.
IanBenzMaxim 8:5ea891c7d1a1 420 MaximInterfaceDevices_EXPORT Core::Result<void> decrementCounter();
IanBenzMaxim 7:9cd16581b578 421
IanBenzMaxim 7:9cd16581b578 422 /// Back up or restore the state of the device to non-volatile memory.
IanBenzMaxim 8:5ea891c7d1a1 423 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 424 deviceStateControl(StateOperation operation);
IanBenzMaxim 7:9cd16581b578 425 };
IanBenzMaxim 7:9cd16581b578 426
IanBenzMaxim 7:9cd16581b578 427 /// @brief
IanBenzMaxim 7:9cd16581b578 428 /// Hash arbitrary length data with successive Compute Multiblock Hash commands.
IanBenzMaxim 7:9cd16581b578 429 /// @param device Device for computation.
IanBenzMaxim 7:9cd16581b578 430 /// @param data Data to hash.
IanBenzMaxim 8:5ea891c7d1a1 431 MaximInterfaceDevices_EXPORT Core::Result<void>
IanBenzMaxim 7:9cd16581b578 432 computeMultiblockHash(DS28E83_DS28E84 & device,
IanBenzMaxim 7:9cd16581b578 433 Core::span<const uint_least8_t> data);
IanBenzMaxim 7:9cd16581b578 434
IanBenzMaxim 7:9cd16581b578 435 /// Format page authentication input data.
IanBenzMaxim 7:9cd16581b578 436 class DS28E83_DS28E84::PageAuthenticationData {
IanBenzMaxim 7:9cd16581b578 437 public:
IanBenzMaxim 7:9cd16581b578 438 typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
IanBenzMaxim 7:9cd16581b578 439 1 + Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 440 Result;
IanBenzMaxim 7:9cd16581b578 441
IanBenzMaxim 7:9cd16581b578 442 PageAuthenticationData() : result_() {}
IanBenzMaxim 7:9cd16581b578 443
IanBenzMaxim 7:9cd16581b578 444 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 445 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 446
IanBenzMaxim 7:9cd16581b578 447 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 448 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 449 /// @{
IanBenzMaxim 7:9cd16581b578 450
IanBenzMaxim 7:9cd16581b578 451 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 452 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 453 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 454 }
IanBenzMaxim 7:9cd16581b578 455
IanBenzMaxim 7:9cd16581b578 456 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 457 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 458 return const_cast<PageAuthenticationData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 459 }
IanBenzMaxim 7:9cd16581b578 460
IanBenzMaxim 7:9cd16581b578 461 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 462 PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 463 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 464 return *this;
IanBenzMaxim 7:9cd16581b578 465 }
IanBenzMaxim 7:9cd16581b578 466
IanBenzMaxim 7:9cd16581b578 467 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 468 MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 469
IanBenzMaxim 7:9cd16581b578 470 /// @}
IanBenzMaxim 7:9cd16581b578 471
IanBenzMaxim 7:9cd16581b578 472 /// @name Page
IanBenzMaxim 7:9cd16581b578 473 /// @brief Data from a device memory page.
IanBenzMaxim 7:9cd16581b578 474 /// @{
IanBenzMaxim 7:9cd16581b578 475
IanBenzMaxim 7:9cd16581b578 476 /// Get mutable page.
IanBenzMaxim 7:9cd16581b578 477 Page::span page() {
IanBenzMaxim 7:9cd16581b578 478 return make_span(result_).subspan<pageIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 479 }
IanBenzMaxim 7:9cd16581b578 480
IanBenzMaxim 7:9cd16581b578 481 /// Get immutable page.
IanBenzMaxim 7:9cd16581b578 482 Page::const_span page() const {
IanBenzMaxim 7:9cd16581b578 483 return const_cast<PageAuthenticationData &>(*this).page();
IanBenzMaxim 7:9cd16581b578 484 }
IanBenzMaxim 7:9cd16581b578 485
IanBenzMaxim 7:9cd16581b578 486 /// Set page.
IanBenzMaxim 7:9cd16581b578 487 PageAuthenticationData & setPage(Page::const_span page) {
IanBenzMaxim 7:9cd16581b578 488 copy(page, this->page());
IanBenzMaxim 7:9cd16581b578 489 return *this;
IanBenzMaxim 7:9cd16581b578 490 }
IanBenzMaxim 7:9cd16581b578 491
IanBenzMaxim 7:9cd16581b578 492 /// @}
IanBenzMaxim 7:9cd16581b578 493
IanBenzMaxim 7:9cd16581b578 494 /// @name Challenge
IanBenzMaxim 7:9cd16581b578 495 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 496 /// @{
IanBenzMaxim 7:9cd16581b578 497
IanBenzMaxim 7:9cd16581b578 498 /// Get mutable Challenge.
IanBenzMaxim 7:9cd16581b578 499 Page::span challenge() {
IanBenzMaxim 7:9cd16581b578 500 return make_span(result_).subspan<challengeIdx, Page::size>();
IanBenzMaxim 7:9cd16581b578 501 }
IanBenzMaxim 7:9cd16581b578 502
IanBenzMaxim 7:9cd16581b578 503 /// Get immutable Challenge.
IanBenzMaxim 7:9cd16581b578 504 Page::const_span challenge() const {
IanBenzMaxim 7:9cd16581b578 505 return const_cast<PageAuthenticationData &>(*this).challenge();
IanBenzMaxim 7:9cd16581b578 506 }
IanBenzMaxim 7:9cd16581b578 507
IanBenzMaxim 7:9cd16581b578 508 /// Set Challenge.
IanBenzMaxim 7:9cd16581b578 509 PageAuthenticationData & setChallenge(Page::const_span challenge) {
IanBenzMaxim 7:9cd16581b578 510 copy(challenge, this->challenge());
IanBenzMaxim 7:9cd16581b578 511 return *this;
IanBenzMaxim 7:9cd16581b578 512 }
IanBenzMaxim 7:9cd16581b578 513
IanBenzMaxim 7:9cd16581b578 514 /// @}
IanBenzMaxim 7:9cd16581b578 515
IanBenzMaxim 7:9cd16581b578 516 /// @name Page number
IanBenzMaxim 7:9cd16581b578 517 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 518 /// @{
IanBenzMaxim 7:9cd16581b578 519
IanBenzMaxim 7:9cd16581b578 520 /// Get page number.
IanBenzMaxim 7:9cd16581b578 521 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 522
IanBenzMaxim 7:9cd16581b578 523 /// Set page number.
IanBenzMaxim 7:9cd16581b578 524 PageAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 525 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 526 return *this;
IanBenzMaxim 7:9cd16581b578 527 }
IanBenzMaxim 7:9cd16581b578 528
IanBenzMaxim 7:9cd16581b578 529 /// @}
IanBenzMaxim 7:9cd16581b578 530
IanBenzMaxim 7:9cd16581b578 531 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 532 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 533 /// @{
IanBenzMaxim 7:9cd16581b578 534
IanBenzMaxim 7:9cd16581b578 535 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 536 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 537 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 538 }
IanBenzMaxim 7:9cd16581b578 539
IanBenzMaxim 7:9cd16581b578 540 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 541 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 542 return const_cast<PageAuthenticationData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 543 }
IanBenzMaxim 7:9cd16581b578 544
IanBenzMaxim 7:9cd16581b578 545 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 546 PageAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 547 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 548 return *this;
IanBenzMaxim 7:9cd16581b578 549 }
IanBenzMaxim 7:9cd16581b578 550
IanBenzMaxim 7:9cd16581b578 551 /// @}
IanBenzMaxim 7:9cd16581b578 552
IanBenzMaxim 7:9cd16581b578 553 private:
IanBenzMaxim 8:5ea891c7d1a1 554 static const size_t romIdIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 555 static const size_t pageIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 556 static const size_t challengeIdx = pageIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 557 static const size_t pageNumIdx = challengeIdx + Page::size;
IanBenzMaxim 8:5ea891c7d1a1 558 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 559
IanBenzMaxim 7:9cd16581b578 560 Result::array result_;
IanBenzMaxim 7:9cd16581b578 561 };
IanBenzMaxim 7:9cd16581b578 562
IanBenzMaxim 7:9cd16581b578 563 /// Format authenticated write input data.
IanBenzMaxim 7:9cd16581b578 564 class DS28E83_DS28E84::WriteAuthenticationData {
IanBenzMaxim 7:9cd16581b578 565 public:
IanBenzMaxim 7:9cd16581b578 566 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 567
IanBenzMaxim 7:9cd16581b578 568 WriteAuthenticationData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 569
IanBenzMaxim 7:9cd16581b578 570 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 571 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 572
IanBenzMaxim 7:9cd16581b578 573 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 574 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 575 /// @{
IanBenzMaxim 7:9cd16581b578 576
IanBenzMaxim 7:9cd16581b578 577 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 578 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 579
IanBenzMaxim 7:9cd16581b578 580 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 581 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 582
IanBenzMaxim 7:9cd16581b578 583 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 584 WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 585 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 586 return *this;
IanBenzMaxim 7:9cd16581b578 587 }
IanBenzMaxim 7:9cd16581b578 588
IanBenzMaxim 7:9cd16581b578 589 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 590 WriteAuthenticationData & setAnonymousRomId() {
IanBenzMaxim 7:9cd16581b578 591 data.setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 592 return *this;
IanBenzMaxim 7:9cd16581b578 593 }
IanBenzMaxim 7:9cd16581b578 594
IanBenzMaxim 7:9cd16581b578 595 /// @}
IanBenzMaxim 7:9cd16581b578 596
IanBenzMaxim 7:9cd16581b578 597 /// @name Old page
IanBenzMaxim 7:9cd16581b578 598 /// @brief Existing data contained in the page.
IanBenzMaxim 7:9cd16581b578 599 /// @{
IanBenzMaxim 7:9cd16581b578 600
IanBenzMaxim 7:9cd16581b578 601 /// Get mutable old page.
IanBenzMaxim 7:9cd16581b578 602 Page::span oldPage() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 603
IanBenzMaxim 7:9cd16581b578 604 /// Get immutable old page.
IanBenzMaxim 7:9cd16581b578 605 Page::const_span oldPage() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 606
IanBenzMaxim 7:9cd16581b578 607 /// Set old page.
IanBenzMaxim 7:9cd16581b578 608 WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
IanBenzMaxim 7:9cd16581b578 609 data.setPage(oldPage);
IanBenzMaxim 7:9cd16581b578 610 return *this;
IanBenzMaxim 7:9cd16581b578 611 }
IanBenzMaxim 7:9cd16581b578 612
IanBenzMaxim 7:9cd16581b578 613 /// @}
IanBenzMaxim 7:9cd16581b578 614
IanBenzMaxim 7:9cd16581b578 615 /// @name New page
IanBenzMaxim 7:9cd16581b578 616 /// @brief New data to write to the page.
IanBenzMaxim 7:9cd16581b578 617 /// @{
IanBenzMaxim 7:9cd16581b578 618
IanBenzMaxim 7:9cd16581b578 619 /// Get mutable new page.
IanBenzMaxim 7:9cd16581b578 620 Page::span newPage() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 621
IanBenzMaxim 7:9cd16581b578 622 /// Get immutable new page.
IanBenzMaxim 7:9cd16581b578 623 Page::const_span newPage() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 624
IanBenzMaxim 7:9cd16581b578 625 /// Set new page.
IanBenzMaxim 7:9cd16581b578 626 WriteAuthenticationData & setNewPage(Page::const_span newPage) {
IanBenzMaxim 7:9cd16581b578 627 data.setChallenge(newPage);
IanBenzMaxim 7:9cd16581b578 628 return *this;
IanBenzMaxim 7:9cd16581b578 629 }
IanBenzMaxim 7:9cd16581b578 630
IanBenzMaxim 7:9cd16581b578 631 /// @}
IanBenzMaxim 7:9cd16581b578 632
IanBenzMaxim 7:9cd16581b578 633 /// @name Page number
IanBenzMaxim 7:9cd16581b578 634 /// @brief Page number for write operation.
IanBenzMaxim 7:9cd16581b578 635 /// @{
IanBenzMaxim 7:9cd16581b578 636
IanBenzMaxim 7:9cd16581b578 637 /// Get page number.
IanBenzMaxim 7:9cd16581b578 638 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 639
IanBenzMaxim 7:9cd16581b578 640 /// Set page number.
IanBenzMaxim 7:9cd16581b578 641 WriteAuthenticationData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 642 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 643 return *this;
IanBenzMaxim 7:9cd16581b578 644 }
IanBenzMaxim 7:9cd16581b578 645
IanBenzMaxim 7:9cd16581b578 646 /// @}
IanBenzMaxim 7:9cd16581b578 647
IanBenzMaxim 7:9cd16581b578 648 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 649 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 650 /// @{
IanBenzMaxim 7:9cd16581b578 651
IanBenzMaxim 7:9cd16581b578 652 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 653 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 654
IanBenzMaxim 7:9cd16581b578 655 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 656 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 657
IanBenzMaxim 7:9cd16581b578 658 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 659 WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 660 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 661 return *this;
IanBenzMaxim 7:9cd16581b578 662 }
IanBenzMaxim 7:9cd16581b578 663
IanBenzMaxim 7:9cd16581b578 664 /// @}
IanBenzMaxim 7:9cd16581b578 665
IanBenzMaxim 7:9cd16581b578 666 private:
IanBenzMaxim 7:9cd16581b578 667 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 668 };
IanBenzMaxim 7:9cd16581b578 669
IanBenzMaxim 7:9cd16581b578 670 /// Format compute secret input data.
IanBenzMaxim 7:9cd16581b578 671 class DS28E83_DS28E84::ComputeSecretData {
IanBenzMaxim 7:9cd16581b578 672 public:
IanBenzMaxim 7:9cd16581b578 673 typedef PageAuthenticationData::Result Result;
IanBenzMaxim 7:9cd16581b578 674
IanBenzMaxim 7:9cd16581b578 675 MaximInterfaceDevices_EXPORT ComputeSecretData();
IanBenzMaxim 7:9cd16581b578 676
IanBenzMaxim 7:9cd16581b578 677 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 678 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 679
IanBenzMaxim 7:9cd16581b578 680 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 681 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 682 /// @{
IanBenzMaxim 7:9cd16581b578 683
IanBenzMaxim 7:9cd16581b578 684 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 685 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 686
IanBenzMaxim 7:9cd16581b578 687 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 688 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 689
IanBenzMaxim 7:9cd16581b578 690 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 691 ComputeSecretData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 692 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 693 return *this;
IanBenzMaxim 7:9cd16581b578 694 }
IanBenzMaxim 7:9cd16581b578 695
IanBenzMaxim 7:9cd16581b578 696 /// @}
IanBenzMaxim 7:9cd16581b578 697
IanBenzMaxim 7:9cd16581b578 698 /// @name Binding Data
IanBenzMaxim 7:9cd16581b578 699 /// @brief Binding Data contained in the selected page.
IanBenzMaxim 7:9cd16581b578 700 /// @{
IanBenzMaxim 7:9cd16581b578 701
IanBenzMaxim 7:9cd16581b578 702 /// Get mutable Binding Data.
IanBenzMaxim 7:9cd16581b578 703 Page::span bindingData() { return data.page(); }
IanBenzMaxim 7:9cd16581b578 704
IanBenzMaxim 7:9cd16581b578 705 /// Get immutable Binding Data.
IanBenzMaxim 7:9cd16581b578 706 Page::const_span bindingData() const { return data.page(); }
IanBenzMaxim 7:9cd16581b578 707
IanBenzMaxim 7:9cd16581b578 708 /// Set Binding Data.
IanBenzMaxim 7:9cd16581b578 709 ComputeSecretData & setBindingData(Page::const_span bindingData) {
IanBenzMaxim 7:9cd16581b578 710 data.setPage(bindingData);
IanBenzMaxim 7:9cd16581b578 711 return *this;
IanBenzMaxim 7:9cd16581b578 712 }
IanBenzMaxim 7:9cd16581b578 713
IanBenzMaxim 7:9cd16581b578 714 /// @}
IanBenzMaxim 7:9cd16581b578 715
IanBenzMaxim 7:9cd16581b578 716 /// @name Partial Secret
IanBenzMaxim 7:9cd16581b578 717 /// @brief Partial Secret used for customization.
IanBenzMaxim 7:9cd16581b578 718 /// @{
IanBenzMaxim 7:9cd16581b578 719
IanBenzMaxim 7:9cd16581b578 720 /// Get mutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 721 Page::span partialSecret() { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 722
IanBenzMaxim 7:9cd16581b578 723 /// Get immutable Partial Secret.
IanBenzMaxim 7:9cd16581b578 724 Page::const_span partialSecret() const { return data.challenge(); }
IanBenzMaxim 7:9cd16581b578 725
IanBenzMaxim 7:9cd16581b578 726 /// Set Partial Secret.
IanBenzMaxim 7:9cd16581b578 727 ComputeSecretData & setPartialSecret(Page::const_span partialSecret) {
IanBenzMaxim 7:9cd16581b578 728 data.setChallenge(partialSecret);
IanBenzMaxim 7:9cd16581b578 729 return *this;
IanBenzMaxim 7:9cd16581b578 730 }
IanBenzMaxim 7:9cd16581b578 731
IanBenzMaxim 7:9cd16581b578 732 /// @}
IanBenzMaxim 7:9cd16581b578 733
IanBenzMaxim 7:9cd16581b578 734 /// @name Page number
IanBenzMaxim 7:9cd16581b578 735 /// @brief Page number for Binding Data.
IanBenzMaxim 7:9cd16581b578 736 /// @{
IanBenzMaxim 7:9cd16581b578 737
IanBenzMaxim 7:9cd16581b578 738 /// Get page number.
IanBenzMaxim 7:9cd16581b578 739 int pageNum() const { return data.pageNum() & 0x3F; }
IanBenzMaxim 7:9cd16581b578 740
IanBenzMaxim 7:9cd16581b578 741 /// Set page number.
IanBenzMaxim 7:9cd16581b578 742 ComputeSecretData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 743 data.setPageNum(pageNum | 0xC0);
IanBenzMaxim 7:9cd16581b578 744 return *this;
IanBenzMaxim 7:9cd16581b578 745 }
IanBenzMaxim 7:9cd16581b578 746
IanBenzMaxim 7:9cd16581b578 747 /// @}
IanBenzMaxim 7:9cd16581b578 748
IanBenzMaxim 7:9cd16581b578 749 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 750 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 751 /// @{
IanBenzMaxim 7:9cd16581b578 752
IanBenzMaxim 7:9cd16581b578 753 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 754 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 755
IanBenzMaxim 7:9cd16581b578 756 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 757 MaximInterfaceDevices_EXPORT ComputeSecretData &
IanBenzMaxim 7:9cd16581b578 758 setManId(Core::ManId::const_span manId);
IanBenzMaxim 7:9cd16581b578 759
IanBenzMaxim 7:9cd16581b578 760 /// @}
IanBenzMaxim 7:9cd16581b578 761
IanBenzMaxim 7:9cd16581b578 762 private:
IanBenzMaxim 7:9cd16581b578 763 PageAuthenticationData data;
IanBenzMaxim 7:9cd16581b578 764 };
IanBenzMaxim 7:9cd16581b578 765
IanBenzMaxim 7:9cd16581b578 766 /// Format decryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 767 class DS28E83_DS28E84::DecryptionHmacData {
IanBenzMaxim 7:9cd16581b578 768 public:
IanBenzMaxim 7:9cd16581b578 769 typedef Core::array_span<uint_least8_t, EncryptionChallenge::size +
IanBenzMaxim 7:9cd16581b578 770 Core::RomId::size + 1 +
IanBenzMaxim 7:9cd16581b578 771 Core::ManId::size>
IanBenzMaxim 7:9cd16581b578 772 Result;
IanBenzMaxim 7:9cd16581b578 773
IanBenzMaxim 7:9cd16581b578 774 DecryptionHmacData() : result_() {}
IanBenzMaxim 7:9cd16581b578 775
IanBenzMaxim 7:9cd16581b578 776 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 777 Result::const_span result() const { return result_; }
IanBenzMaxim 7:9cd16581b578 778
IanBenzMaxim 7:9cd16581b578 779 /// @name Encryption Challenge
IanBenzMaxim 7:9cd16581b578 780 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 781 /// @{
IanBenzMaxim 7:9cd16581b578 782
IanBenzMaxim 7:9cd16581b578 783 /// Get mutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 784 EncryptionChallenge::span encryptionChallenge() {
IanBenzMaxim 7:9cd16581b578 785 return make_span(result_)
IanBenzMaxim 7:9cd16581b578 786 .subspan<encryptionChallengeIdx, EncryptionChallenge::size>();
IanBenzMaxim 7:9cd16581b578 787 }
IanBenzMaxim 7:9cd16581b578 788
IanBenzMaxim 7:9cd16581b578 789 /// Get immutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 790 EncryptionChallenge::const_span encryptionChallenge() const {
IanBenzMaxim 7:9cd16581b578 791 return const_cast<DecryptionHmacData &>(*this).encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 792 }
IanBenzMaxim 7:9cd16581b578 793
IanBenzMaxim 7:9cd16581b578 794 /// Set Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 795 DecryptionHmacData &
IanBenzMaxim 7:9cd16581b578 796 setEncryptionChallenge(EncryptionChallenge::const_span encryptionChallenge) {
IanBenzMaxim 7:9cd16581b578 797 copy(encryptionChallenge, this->encryptionChallenge());
IanBenzMaxim 7:9cd16581b578 798 return *this;
IanBenzMaxim 7:9cd16581b578 799 }
IanBenzMaxim 7:9cd16581b578 800
IanBenzMaxim 7:9cd16581b578 801 /// @}
IanBenzMaxim 7:9cd16581b578 802
IanBenzMaxim 7:9cd16581b578 803 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 804 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 805 /// @{
IanBenzMaxim 7:9cd16581b578 806
IanBenzMaxim 7:9cd16581b578 807 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 808 Core::RomId::span romId() {
IanBenzMaxim 7:9cd16581b578 809 return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 810 }
IanBenzMaxim 7:9cd16581b578 811
IanBenzMaxim 7:9cd16581b578 812 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 813 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 814 return const_cast<DecryptionHmacData &>(*this).romId();
IanBenzMaxim 7:9cd16581b578 815 }
IanBenzMaxim 7:9cd16581b578 816
IanBenzMaxim 7:9cd16581b578 817 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 818 DecryptionHmacData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 819 copy(romId, this->romId());
IanBenzMaxim 7:9cd16581b578 820 return *this;
IanBenzMaxim 7:9cd16581b578 821 }
IanBenzMaxim 7:9cd16581b578 822
IanBenzMaxim 7:9cd16581b578 823 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 824 MaximInterfaceDevices_EXPORT DecryptionHmacData & setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 825
IanBenzMaxim 7:9cd16581b578 826 /// @}
IanBenzMaxim 7:9cd16581b578 827
IanBenzMaxim 7:9cd16581b578 828 /// @name Page number
IanBenzMaxim 7:9cd16581b578 829 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 830 /// @{
IanBenzMaxim 7:9cd16581b578 831
IanBenzMaxim 7:9cd16581b578 832 /// Get page number.
IanBenzMaxim 7:9cd16581b578 833 int pageNum() const { return result_[pageNumIdx]; }
IanBenzMaxim 7:9cd16581b578 834
IanBenzMaxim 7:9cd16581b578 835 /// Set page number.
IanBenzMaxim 7:9cd16581b578 836 DecryptionHmacData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 837 result_[pageNumIdx] = pageNum;
IanBenzMaxim 7:9cd16581b578 838 return *this;
IanBenzMaxim 7:9cd16581b578 839 }
IanBenzMaxim 7:9cd16581b578 840
IanBenzMaxim 7:9cd16581b578 841 /// @}
IanBenzMaxim 7:9cd16581b578 842
IanBenzMaxim 7:9cd16581b578 843 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 844 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 845 /// @{
IanBenzMaxim 7:9cd16581b578 846
IanBenzMaxim 7:9cd16581b578 847 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 848 Core::ManId::span manId() {
IanBenzMaxim 7:9cd16581b578 849 return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 850 }
IanBenzMaxim 7:9cd16581b578 851
IanBenzMaxim 7:9cd16581b578 852 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 853 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 854 return const_cast<DecryptionHmacData &>(*this).manId();
IanBenzMaxim 7:9cd16581b578 855 }
IanBenzMaxim 7:9cd16581b578 856
IanBenzMaxim 7:9cd16581b578 857 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 858 DecryptionHmacData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 859 copy(manId, this->manId());
IanBenzMaxim 7:9cd16581b578 860 return *this;
IanBenzMaxim 7:9cd16581b578 861 }
IanBenzMaxim 7:9cd16581b578 862
IanBenzMaxim 7:9cd16581b578 863 /// @}
IanBenzMaxim 7:9cd16581b578 864
IanBenzMaxim 7:9cd16581b578 865 private:
IanBenzMaxim 8:5ea891c7d1a1 866 static const size_t encryptionChallengeIdx = 0;
IanBenzMaxim 8:5ea891c7d1a1 867 static const size_t romIdIdx =
IanBenzMaxim 7:9cd16581b578 868 encryptionChallengeIdx + EncryptionChallenge::size;
IanBenzMaxim 8:5ea891c7d1a1 869 static const size_t pageNumIdx = romIdIdx + Core::RomId::size;
IanBenzMaxim 8:5ea891c7d1a1 870 static const size_t manIdIdx = pageNumIdx + 1;
IanBenzMaxim 7:9cd16581b578 871
IanBenzMaxim 7:9cd16581b578 872 Result::array result_;
IanBenzMaxim 7:9cd16581b578 873 };
IanBenzMaxim 7:9cd16581b578 874
IanBenzMaxim 7:9cd16581b578 875 /// Format encryption HMAC input data.
IanBenzMaxim 7:9cd16581b578 876 class DS28E83_DS28E84::EncryptionHmacData {
IanBenzMaxim 7:9cd16581b578 877 public:
IanBenzMaxim 7:9cd16581b578 878 typedef DecryptionHmacData::Result Result;
IanBenzMaxim 7:9cd16581b578 879
IanBenzMaxim 7:9cd16581b578 880 EncryptionHmacData() : data() { setPageNum(0); }
IanBenzMaxim 7:9cd16581b578 881
IanBenzMaxim 7:9cd16581b578 882 /// Formatted data result.
IanBenzMaxim 7:9cd16581b578 883 Result::const_span result() const { return data.result(); }
IanBenzMaxim 7:9cd16581b578 884
IanBenzMaxim 7:9cd16581b578 885 /// @name Encryption Challenge
IanBenzMaxim 7:9cd16581b578 886 /// @brief Random challenge used to prevent replay attacks.
IanBenzMaxim 7:9cd16581b578 887 /// @{
IanBenzMaxim 7:9cd16581b578 888
IanBenzMaxim 7:9cd16581b578 889 /// Get mutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 890 EncryptionChallenge::span encryptionChallenge() {
IanBenzMaxim 7:9cd16581b578 891 return data.encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 892 }
IanBenzMaxim 7:9cd16581b578 893
IanBenzMaxim 7:9cd16581b578 894 /// Get immutable Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 895 EncryptionChallenge::const_span encryptionChallenge() const {
IanBenzMaxim 7:9cd16581b578 896 return data.encryptionChallenge();
IanBenzMaxim 7:9cd16581b578 897 }
IanBenzMaxim 7:9cd16581b578 898
IanBenzMaxim 7:9cd16581b578 899 /// Set Encryption Challenge.
IanBenzMaxim 7:9cd16581b578 900 EncryptionHmacData &
IanBenzMaxim 7:9cd16581b578 901 setEncryptionChallenge(EncryptionChallenge::const_span encryptionChallenge) {
IanBenzMaxim 7:9cd16581b578 902 data.setEncryptionChallenge(encryptionChallenge);
IanBenzMaxim 7:9cd16581b578 903 return *this;
IanBenzMaxim 7:9cd16581b578 904 }
IanBenzMaxim 7:9cd16581b578 905
IanBenzMaxim 7:9cd16581b578 906 /// @}
IanBenzMaxim 7:9cd16581b578 907
IanBenzMaxim 7:9cd16581b578 908 /// @name ROM ID
IanBenzMaxim 7:9cd16581b578 909 /// @brief 1-Wire ROM ID of the device.
IanBenzMaxim 7:9cd16581b578 910 /// @{
IanBenzMaxim 7:9cd16581b578 911
IanBenzMaxim 7:9cd16581b578 912 /// Get mutable ROM ID.
IanBenzMaxim 7:9cd16581b578 913 Core::RomId::span romId() { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 914
IanBenzMaxim 7:9cd16581b578 915 /// Get immutable ROM ID.
IanBenzMaxim 7:9cd16581b578 916 Core::RomId::const_span romId() const { return data.romId(); }
IanBenzMaxim 7:9cd16581b578 917
IanBenzMaxim 7:9cd16581b578 918 /// Set ROM ID.
IanBenzMaxim 7:9cd16581b578 919 EncryptionHmacData & setRomId(Core::RomId::const_span romId) {
IanBenzMaxim 7:9cd16581b578 920 data.setRomId(romId);
IanBenzMaxim 7:9cd16581b578 921 return *this;
IanBenzMaxim 7:9cd16581b578 922 }
IanBenzMaxim 7:9cd16581b578 923
IanBenzMaxim 7:9cd16581b578 924 /// Set ROM ID for use in anonymous mode.
IanBenzMaxim 7:9cd16581b578 925 EncryptionHmacData & setAnonymousRomId() {
IanBenzMaxim 7:9cd16581b578 926 data.setAnonymousRomId();
IanBenzMaxim 7:9cd16581b578 927 return *this;
IanBenzMaxim 7:9cd16581b578 928 }
IanBenzMaxim 7:9cd16581b578 929
IanBenzMaxim 7:9cd16581b578 930 /// @}
IanBenzMaxim 7:9cd16581b578 931
IanBenzMaxim 7:9cd16581b578 932 /// @name Page number
IanBenzMaxim 7:9cd16581b578 933 /// @brief Number of the page to use data from.
IanBenzMaxim 7:9cd16581b578 934 /// @{
IanBenzMaxim 7:9cd16581b578 935
IanBenzMaxim 7:9cd16581b578 936 /// Get page number.
IanBenzMaxim 7:9cd16581b578 937 int pageNum() const { return data.pageNum() & 0x7F; }
IanBenzMaxim 7:9cd16581b578 938
IanBenzMaxim 7:9cd16581b578 939 /// Set page number.
IanBenzMaxim 7:9cd16581b578 940 EncryptionHmacData & setPageNum(int pageNum) {
IanBenzMaxim 7:9cd16581b578 941 data.setPageNum(pageNum | 0x80);
IanBenzMaxim 7:9cd16581b578 942 return *this;
IanBenzMaxim 7:9cd16581b578 943 }
IanBenzMaxim 7:9cd16581b578 944
IanBenzMaxim 7:9cd16581b578 945 /// @}
IanBenzMaxim 7:9cd16581b578 946
IanBenzMaxim 7:9cd16581b578 947 /// @name MAN ID
IanBenzMaxim 7:9cd16581b578 948 /// @brief Manufacturer ID of the device.
IanBenzMaxim 7:9cd16581b578 949 /// @{
IanBenzMaxim 7:9cd16581b578 950
IanBenzMaxim 7:9cd16581b578 951 /// Get mutable MAN ID.
IanBenzMaxim 7:9cd16581b578 952 Core::ManId::span manId() { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 953
IanBenzMaxim 7:9cd16581b578 954 /// Get immutable MAN ID.
IanBenzMaxim 7:9cd16581b578 955 Core::ManId::const_span manId() const { return data.manId(); }
IanBenzMaxim 7:9cd16581b578 956
IanBenzMaxim 7:9cd16581b578 957 /// Set MAN ID.
IanBenzMaxim 7:9cd16581b578 958 EncryptionHmacData & setManId(Core::ManId::const_span manId) {
IanBenzMaxim 7:9cd16581b578 959 data.setManId(manId);
IanBenzMaxim 7:9cd16581b578 960 return *this;
IanBenzMaxim 7:9cd16581b578 961 }
IanBenzMaxim 7:9cd16581b578 962
IanBenzMaxim 7:9cd16581b578 963 /// @}
IanBenzMaxim 7:9cd16581b578 964
IanBenzMaxim 7:9cd16581b578 965 private:
IanBenzMaxim 7:9cd16581b578 966 DecryptionHmacData data;
IanBenzMaxim 7:9cd16581b578 967 };
IanBenzMaxim 7:9cd16581b578 968
IanBenzMaxim 7:9cd16581b578 969 /// Access fields in the ROM Options page.
IanBenzMaxim 7:9cd16581b578 970 class DS28E83_DS28E84::RomOptions {
IanBenzMaxim 7:9cd16581b578 971 public:
IanBenzMaxim 7:9cd16581b578 972 explicit RomOptions(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 973
IanBenzMaxim 7:9cd16581b578 974 bool anonymous() const { return page[anonymousIdx] == anonymousValue; }
IanBenzMaxim 7:9cd16581b578 975
IanBenzMaxim 7:9cd16581b578 976 void setAnonymous(bool anonymous) {
IanBenzMaxim 7:9cd16581b578 977 page[anonymousIdx] = (anonymous ? anonymousValue : 0);
IanBenzMaxim 7:9cd16581b578 978 }
IanBenzMaxim 7:9cd16581b578 979
IanBenzMaxim 7:9cd16581b578 980 Core::ManId::const_span manId() const {
IanBenzMaxim 7:9cd16581b578 981 return page.subspan<22, Core::ManId::size>();
IanBenzMaxim 7:9cd16581b578 982 }
IanBenzMaxim 7:9cd16581b578 983
IanBenzMaxim 7:9cd16581b578 984 Core::RomId::const_span romId() const {
IanBenzMaxim 7:9cd16581b578 985 return page.subspan<24, Core::RomId::size>();
IanBenzMaxim 7:9cd16581b578 986 }
IanBenzMaxim 7:9cd16581b578 987
IanBenzMaxim 7:9cd16581b578 988 private:
IanBenzMaxim 7:9cd16581b578 989 static const Page::span::index_type anonymousIdx = 1;
IanBenzMaxim 7:9cd16581b578 990 static const Page::span::value_type anonymousValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 991
IanBenzMaxim 7:9cd16581b578 992 Page::span page;
IanBenzMaxim 7:9cd16581b578 993 };
IanBenzMaxim 7:9cd16581b578 994
IanBenzMaxim 7:9cd16581b578 995 /// Access fields in the GPIO Control page.
IanBenzMaxim 7:9cd16581b578 996 class DS28E83_DS28E84::GpioControl {
IanBenzMaxim 7:9cd16581b578 997 public:
IanBenzMaxim 7:9cd16581b578 998 explicit GpioControl(Page::span page) : page(page) {}
IanBenzMaxim 7:9cd16581b578 999
IanBenzMaxim 7:9cd16581b578 1000 bool conducting() const { return page[conductingIdx] == conductingValue; }
IanBenzMaxim 7:9cd16581b578 1001
IanBenzMaxim 7:9cd16581b578 1002 void setConducting(bool conducting) {
IanBenzMaxim 7:9cd16581b578 1003 page[conductingIdx] = (conducting ? conductingValue : 0x55);
IanBenzMaxim 7:9cd16581b578 1004 }
IanBenzMaxim 7:9cd16581b578 1005
IanBenzMaxim 7:9cd16581b578 1006 bool level() const { return page[2] == 0x55; }
IanBenzMaxim 7:9cd16581b578 1007
IanBenzMaxim 7:9cd16581b578 1008 private:
IanBenzMaxim 7:9cd16581b578 1009 static const Page::span::index_type conductingIdx = 0;
IanBenzMaxim 7:9cd16581b578 1010 static const Page::span::value_type conductingValue = 0xAA;
IanBenzMaxim 7:9cd16581b578 1011
IanBenzMaxim 7:9cd16581b578 1012 Page::span page;
IanBenzMaxim 7:9cd16581b578 1013 };
IanBenzMaxim 7:9cd16581b578 1014
IanBenzMaxim 7:9cd16581b578 1015 } // namespace MaximInterfaceDevices
IanBenzMaxim 7:9cd16581b578 1016
IanBenzMaxim 7:9cd16581b578 1017 #endif