Superseded by MaximInterface.

Diff: Authenticators/ISha256MacCoproc.h

Revision:

73:2cecc1372acc

Parent:

49:36954b62f503

Child:

74:23be10c32fa3

diff -r 6892702709ee -r 2cecc1372acc Authenticators/ISha256MacCoproc.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Authenticators/ISha256MacCoproc.h	Thu May 12 14:38:16 2016 -0500
@@ -0,0 +1,72 @@
+#ifndef OneWire_Authenticators_ISha256MacCoproc
+#define OneWire_Authenticators_ISha256MacCoproc
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "array.h"
+
+namespace OneWire
+{
+  namespace Authenticators
+  {
+    /// Interface for SHA-256 coprocessors compatible with the DS28E15/22/25 family and similar.
+    class ISha256MacCoproc
+    {
+    public:
+      enum CmdResult
+      {
+        Success,
+        OperationFailure
+      };
+
+      /// Holds the contents of a device memory page.
+      typedef array<uint8_t, 32> DevicePage;
+      
+      /// Holds the contents of a device scratchpad.
+      typedef array<uint8_t, 32> DeviceScratchpad;
+      
+      /// Holds the contents of a device secret.
+      typedef array<uint8_t, 32> Secret;
+      
+      /// Container for a SHA-256 MAC.
+      typedef array<uint8_t, 32> Mac;
+      
+      /// Additional data fields for Compute Write MAC operation.
+      typedef array<uint8_t, 20> WriteMacData;
+      
+      /// Additional data fields for the Compute Auth. MAC operation.
+      typedef array<uint8_t, 12> AuthMacData;
+      
+      /// Additional data field for the Compute Slave Secret operation.
+      typedef array<uint8_t, 12> SlaveSecretData;
+      
+      /// Set Master Secret in coprocessor.
+      /// @param[in] masterSecret New master secret to set.
+      virtual CmdResult setMasterSecret(const Secret & masterSecret) = 0;
+      
+      /// Compute Slave Secret in the coprocessor.
+      /// @note Uses the previously set Master Secret in computation.
+      /// @param[in] devicePage Page data stored on device.
+      /// @param[in] deviceScratchpad Scratchpad data stored on device.
+      /// @param[in] slaveSecretData Additional data fields as specified by device.
+      virtual CmdResult computeSlaveSecret(const DevicePage & devicePage, const DeviceScratchpad & deviceScratchpad, const SlaveSecretData & slaveSecretData) = 0;
+      
+      /// Compute Write MAC
+      /// @note Uses the previously computed Slave Secret in computation.
+      /// @param[in] writeMacData Additional data fields as specified by device.
+      /// @param[out] mac The computed MAC.
+      virtual CmdResult computeWriteMac(const WriteMacData & writeMacData, Mac & mac) const = 0;
+      
+      /// Compute Authentication MAC
+      /// @note Uses the previously computed Slave Secret in computation.
+      /// @param[in] devicePage Page data stored on device.
+      /// @param[in] challege Random challenge for device.
+      /// @param[in] authMacData Additional data fields as specified by device.
+      /// @param[out] mac The computed MAC.
+      virtual CmdResult computeAuthMac(const DevicePage & devicePage, const DeviceScratchpad & challenge, const AuthMacData & authMacData, Mac & mac) const = 0;
+    };
+  }
+}
+
+#endif