Diff: MaximInterfaceDevices/DS28C39.hpp

Revision:

7:9cd16581b578

Child:

8:5ea891c7d1a1

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MaximInterfaceDevices/DS28C39.hpp	Mon Jul 22 11:44:07 2019 -0500
@@ -0,0 +1,444 @@
+/*******************************************************************************
+* Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+*******************************************************************************/
+
+#ifndef MaximInterfaceDevices_DS28C39
+#define MaximInterfaceDevices_DS28C39
+
+#include <stdint.h>
+#include <MaximInterfaceCore/Algorithm.hpp>
+#include <MaximInterfaceCore/array_span.hpp>
+#include <MaximInterfaceCore/Ecc256.hpp>
+#include <MaximInterfaceCore/FlagSet.hpp>
+#include <MaximInterfaceCore/ManId.hpp>
+#include <MaximInterfaceCore/RomId.hpp>
+#include <MaximInterfaceCore/RunCommand.hpp>
+#include <MaximInterfaceCore/system_error.hpp>
+#include "Config.hpp"
+
+namespace MaximInterfaceDevices {
+
+class DS28C39 {
+public:
+  /// Device command results.
+  enum ErrorValue {
+    InvalidOperationError = 0x55,
+    InvalidParameterError = 0x77,
+    InvalidSequenceError = 0x33,
+    InternalError = 0x22,
+    DeviceDisabledError = 0x88,
+    AuthenticationError = 0x100,
+    InvalidResponseError ///< Command response does not match expected format.
+  };
+
+  /// @name Device memory pages
+  /// @{
+
+  static const int authorityPublicKeyXPage = 5;
+  static const int authorityPublicKeyYPage = 6;
+  static const int writePublicKeyXPage = 7;
+  static const int writePublicKeyYPage = 8;
+
+  /// @}
+
+  static const int memoryPages = 9;
+
+  /// Holds a device memory page.
+  typedef Core::array_span<uint_least8_t, 32> Page;
+
+  // Format page authentication input data.
+  class PageAuthenticationData;
+
+  // Format authenticated write input data.
+  class WriteAuthenticationData;
+
+  /// Page protection types.
+  enum PageProtectionType {
+    RP = 0x01, ///< Read protection.
+    WP = 0x02, ///< Write protection.
+    EM = 0x04, ///< EPROM emulation mode.
+    ECW = 0x10 ///< Authenticated write.
+  };
+  typedef Core::FlagSet<PageProtectionType, 5> PageProtection;
+
+  struct Status {
+    enum EntropyHealthTestStatus {
+      TestNotPerformed = 0xFF,
+      EntropyHealthy = 0xAA,
+      EntropyNotHealthy = 0xDD
+    };
+
+    typedef Core::array<PageProtection, memoryPages - 2> PageProtectionList;
+    typedef Core::array<uint_least8_t, 2> RomVersion;
+
+    PageProtectionList pageProtection;
+    Core::RomId::array romId;
+    Core::ManId::array manId;
+    RomVersion romVersion;
+    EntropyHealthTestStatus entropyHealthTestStatus;
+  };
+
+  explicit DS28C39(const Core::RunCommand & runCommand)
+      : doRunCommand(runCommand) {}
+
+  void setRunCommand(const Core::RunCommand & runCommand) {
+    doRunCommand = runCommand;
+  }
+
+  /// @brief Write memory with no protection.
+  /// @param pageNum Number of page to write.
+  /// @param page Data to write.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  writeMemory(int pageNum, Page::const_span page);
+
+  /// @brief Read memory with no protection.
+  /// @param pageNum Number of page to read.
+  /// @param[out] page Data that was read.
+  MaximInterfaceDevices_EXPORT Core::error_code readMemory(int pageNum,
+                                                           Page::span page);
+
+  /// @brief
+  /// Reads the current status of the device and optionally performs an
+  /// entropy health test.
+  /// @param entropyHealthTest True to perform an entropy health test.
+  /// @param[out] status Status that was read.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  readStatus(bool entropyHealthTest, Status & status);
+
+  /// @brief Set the protection settings of a page.
+  /// @param pageNum Number of page to write.
+  /// @param protection Protection to write.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  setPageProtection(int pageNum, const PageProtection & protection);
+
+  /// @brief Compute and read page authentication with ECDSA.
+  /// @param pageNum Number of page to authenticate.
+  /// @param anonymous True to disable use of ROM ID in computation.
+  /// @param challenge Random challenge used to prevent replay attacks.
+  /// @param[out] signature Computed page signature.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  computeAndReadPageAuthentication(int pageNum, bool anonymous,
+                                   Page::const_span challenge,
+                                   Core::Ecc256::Signature::span signature);
+
+  /// Permanently disable the device.
+  MaximInterfaceDevices_EXPORT Core::error_code disableDevice();
+
+  /// @brief Generate the device's ECDSA public key from the PUF private key.
+  /// @param[out] devicePublicKey Device Public Key
+  MaximInterfaceDevices_EXPORT Core::error_code
+  readDevicePublicKey(Core::Ecc256::PublicKey::span devicePublicKey);
+
+  /// @brief Read a block of random data from the RNG.
+  /// @param[out] data Random data from RNG with length from 1 to 64.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  readRng(Core::span<uint_least8_t> data);
+
+  /// @brief
+  /// Authenticate a public key for authenticated writes using the
+  /// Authority Public Key.
+  /// @param certificate
+  /// Certificate to use for authentication of the Write Public Key.
+  /// @param customization
+  /// Certificate customization with length from 1 to 32.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  authenticatePublicKey(Core::Ecc256::Signature::const_span certificate,
+                        Core::span<const uint_least8_t> customization);
+
+  /// @brief Write with ECDSA authentication using the Write Public Key.
+  /// @param pageNum Number of page to write.
+  /// @param page Data to write.
+  /// @param signature Signature to use for authentication of page data.
+  MaximInterfaceDevices_EXPORT Core::error_code
+  authenticatedWriteMemory(int pageNum, Page::const_span page,
+                           Core::Ecc256::Signature::const_span signature);
+
+  MaximInterfaceDevices_EXPORT static const Core::error_category &
+  errorCategory();
+
+protected:
+  MaximInterfaceDevices_EXPORT Core::error_code
+  runCommand(Core::span<const uint_least8_t> request, int delayTime,
+             Core::span<uint_least8_t> & response);
+
+  MaximInterfaceDevices_EXPORT Core::error_code
+  runCommand(Core::span<const uint_least8_t> request, int delayTime);
+
+private:
+  Core::RunCommand doRunCommand;
+};
+
+inline Core::error_code make_error_code(DS28C39::ErrorValue e) {
+  return Core::error_code(e, DS28C39::errorCategory());
+}
+
+/// @brief Read the device ROM ID and MAN ID using the Read Status command.
+/// @param ds28c39 Device to read.
+/// @param[out] romId Read ROM ID valid when operation is successful.
+/// @param[out] manId Read MAN ID valid when operation is successful.
+MaximInterfaceDevices_EXPORT Core::error_code
+readRomIdAndManId(DS28C39 & ds28c39, Core::RomId::span romId,
+                  Core::ManId::span manId);
+
+/// Format page authentication input data.
+class DS28C39::PageAuthenticationData {
+public:
+  typedef Core::array_span<uint_least8_t, Core::RomId::size + 2 * Page::size +
+                                              1 + Core::ManId::size>
+      Result;
+
+  PageAuthenticationData() : result_() {}
+
+  /// Formatted data result.
+  Result::const_span result() const { return result_; }
+
+  /// @name ROM ID
+  /// @brief 1-Wire ROM ID of the device.
+  /// @{
+
+  /// Get mutable ROM ID.
+  Core::RomId::span romId() {
+    return make_span(result_).subspan<romIdIdx, Core::RomId::size>();
+  }
+
+  /// Get immutable ROM ID.
+  Core::RomId::const_span romId() const {
+    return const_cast<PageAuthenticationData &>(*this).romId();
+  }
+
+  /// Set ROM ID.
+  PageAuthenticationData & setRomId(Core::RomId::const_span romId) {
+    copy(romId, this->romId());
+    return *this;
+  }
+
+  /// Set ROM ID for use in anonymous mode.
+  MaximInterfaceDevices_EXPORT PageAuthenticationData & setAnonymousRomId();
+
+  /// @}
+
+  /// @name Page
+  /// @brief Data from a device memory page.
+  /// @{
+
+  /// Get mutable page.
+  Page::span page() {
+    return make_span(result_).subspan<pageIdx, Page::size>();
+  }
+
+  /// Get immutable page.
+  Page::const_span page() const {
+    return const_cast<PageAuthenticationData &>(*this).page();
+  }
+
+  /// Set page.
+  PageAuthenticationData & setPage(Page::const_span page) {
+    copy(page, this->page());
+    return *this;
+  }
+
+  /// @}
+
+  /// @name Challenge
+  /// @brief Random challenge used to prevent replay attacks.
+  /// @{
+
+  /// Get mutable Challenge.
+  Page::span challenge() {
+    return make_span(result_).subspan<challengeIdx, Page::size>();
+  }
+
+  /// Get immutable Challenge.
+  Page::const_span challenge() const {
+    return const_cast<PageAuthenticationData &>(*this).challenge();
+  }
+
+  /// Set Challenge.
+  PageAuthenticationData & setChallenge(Page::const_span challenge) {
+    copy(challenge, this->challenge());
+    return *this;
+  }
+
+  /// @}
+
+  /// @name Page number
+  /// @brief Number of the page to use data from.
+  /// @{
+
+  /// Get page number.
+  int pageNum() const { return result_[pageNumIdx]; }
+
+  /// Set page number.
+  PageAuthenticationData & setPageNum(int pageNum) {
+    result_[pageNumIdx] = pageNum;
+    return *this;
+  }
+
+  /// @}
+
+  /// @name MAN ID
+  /// @brief Manufacturer ID of the device.
+  /// @{
+
+  /// Get mutable MAN ID.
+  Core::ManId::span manId() {
+    return make_span(result_).subspan<manIdIdx, Core::ManId::size>();
+  }
+
+  /// Get immutable MAN ID.
+  Core::ManId::const_span manId() const {
+    return const_cast<PageAuthenticationData &>(*this).manId();
+  }
+
+  /// Set MAN ID.
+  PageAuthenticationData & setManId(Core::ManId::const_span manId) {
+    copy(manId, this->manId());
+    return *this;
+  }
+
+  /// @}
+
+private:
+  typedef Result::span::index_type index;
+
+  static const index romIdIdx = 0;
+  static const index pageIdx = romIdIdx + Core::RomId::size;
+  static const index challengeIdx = pageIdx + Page::size;
+  static const index pageNumIdx = challengeIdx + Page::size;
+  static const index manIdIdx = pageNumIdx + 1;
+
+  Result::array result_;
+};
+
+/// Format authenticated write input data.
+class DS28C39::WriteAuthenticationData {
+public:
+  typedef PageAuthenticationData::Result Result;
+
+  WriteAuthenticationData() : data() { setPageNum(0); }
+
+  /// Formatted data result.
+  Result::const_span result() const { return data.result(); }
+
+  /// @name ROM ID
+  /// @brief 1-Wire ROM ID of the device.
+  /// @{
+
+  /// Get mutable ROM ID.
+  Core::RomId::span romId() { return data.romId(); }
+
+  /// Get immutable ROM ID.
+  Core::RomId::const_span romId() const { return data.romId(); }
+
+  /// Set ROM ID.
+  WriteAuthenticationData & setRomId(Core::RomId::const_span romId) {
+    data.setRomId(romId);
+    return *this;
+  }
+
+  /// @}
+
+  /// @name Old page
+  /// @brief Existing data contained in the page.
+  /// @{
+
+  /// Get mutable old page.
+  Page::span oldPage() { return data.page(); }
+
+  /// Get immutable old page.
+  Page::const_span oldPage() const { return data.page(); }
+
+  /// Set old page.
+  WriteAuthenticationData & setOldPage(Page::const_span oldPage) {
+    data.setPage(oldPage);
+    return *this;
+  }
+
+  /// @}
+
+  /// @name New page
+  /// @brief New data to write to the page.
+  /// @{
+
+  /// Get mutable new page.
+  Page::span newPage() { return data.challenge(); }
+
+  /// Get immutable new page.
+  Page::const_span newPage() const { return data.challenge(); }
+
+  /// Set new page.
+  WriteAuthenticationData & setNewPage(Page::const_span newPage) {
+    data.setChallenge(newPage);
+    return *this;
+  }
+
+  /// @}
+
+  /// @name Page number
+  /// @brief Page number for write operation.
+  /// @{
+
+  /// Get page number.
+  int pageNum() const { return data.pageNum() & 0x7F; }
+
+  /// Set page number.
+  WriteAuthenticationData & setPageNum(int pageNum) {
+    data.setPageNum(pageNum | 0x80);
+    return *this;
+  }
+
+  /// @}
+
+  /// @name MAN ID
+  /// @brief Manufacturer ID of the device.
+  /// @{
+
+  /// Get mutable MAN ID.
+  Core::ManId::span manId() { return data.manId(); }
+
+  /// Get immutable MAN ID.
+  Core::ManId::const_span manId() const { return data.manId(); }
+
+  /// Set MAN ID.
+  WriteAuthenticationData & setManId(Core::ManId::const_span manId) {
+    data.setManId(manId);
+    return *this;
+  }
+
+  /// @}
+
+private:
+  PageAuthenticationData data;
+};
+
+} // namespace MaximInterfaceDevices
+
+#endif