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.

OneWire_Masters/ISha256MacCoprocessor.hpp

Committer:
IanBenzMaxim
Date:
2016-04-07
Revision:
48:6f9208ae280e
Parent:
33:a4c015046956
Child:
49:36954b62f503

File content as of revision 48:6f9208ae280e:

#ifndef ISHA256MACCOPROCESSOR_H
#define ISHA256MACCOPROCESSOR_H

#include <cstddef>
#include <cstdint>

#include "array.hpp"

/// Interface for SHA-256 coprocessors compatible with the DS28E15/22/25 family.
class ISha256MacCoprocessor
{
public:
  enum CmdResult
  {
    Success,
    OperationFailure
  };

  typedef array<std::uint8_t, 32> DevicePage;
  typedef array<std::uint8_t, 32> DeviceScratchpad;
  typedef array<std::uint8_t, 32> Secret;
  typedef array<std::uint8_t, 32> Mac;
  typedef array<std::uint8_t, 20> WriteMacData;
  typedef array<std::uint8_t, 12> AuthMacData;
  typedef array<std::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 Variable data field used in calculation.
  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 Variable data fields used in calculation.
  /// @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 Variable data fields used in calculation.
  /// @param[out] mac The computed MAC.
  virtual CmdResult computeAuthMac(const DevicePage & devicePage, const DeviceScratchpad & challenge, const AuthMacData & authMacData, Mac & mac) const = 0;
};

#endif