Diff: Authenticators/ISha256MacCoproc.h

Revision:

76:84e6c4994e29

Parent:

75:8b627804927c

diff -r 8b627804927c -r 84e6c4994e29 Authenticators/ISha256MacCoproc.h
--- a/Authenticators/ISha256MacCoproc.h	Fri May 13 14:52:50 2016 -0500
+++ b/Authenticators/ISha256MacCoproc.h	Sat May 14 14:27:56 2016 -0500
@@ -39,65 +39,62 @@
 
 namespace OneWire
 {
-    namespace Authenticators
+    /// Interface for SHA-256 coprocessors compatible with the DS28E15/22/25 family and similar.
+    class ISha256MacCoproc
     {
-        /// Interface for SHA-256 coprocessors compatible with the DS28E15/22/25 family and similar.
-        class ISha256MacCoproc
+    public:
+        enum CmdResult
         {
-        public:
-            enum CmdResult
-            {
-                Success,
-                OperationFailure
-            };
+            Success,
+            OperationFailure
+        };
 
-            /// Holds the contents of a device memory page.
-            typedef array<uint8_t, 32> DevicePage;
+        /// 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 scratchpad.
+        typedef array<uint8_t, 32> DeviceScratchpad;
 
-            /// Holds the contents of a device secret.
-            typedef array<uint8_t, 32> Secret;
+        /// 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;
+        /// 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 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 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;
+        /// 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;
+        /// 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 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 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;
-        };
-    }
+        /// 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