Maxim Integrated / OneWire

1-Wire® library for mbed. Complete 1-Wire library that supports our silicon masters along with a bit-bang master on the MAX32600MBED platform with one common interface for mbed. Slave support has also been included and more slaves will be added as time permits.

Dependents:   MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more

Superseded by MaximInterface.

Authenticators/ISha256MacCoproc.h

Committer:
IanBenzMaxim
Date:
2016-05-12
Revision:
73:2cecc1372acc
Parent:
OneWire_Masters/ISha256MacCoprocessor.hpp@ 49:36954b62f503
Child:
74:23be10c32fa3

File content as of revision 73:2cecc1372acc:

#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