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