Implementation of 1-Wire with added Alarm Search Functionality

Dependents:   Max32630_One_Wire_Interface

Authenticators/ISha256MacCoproc.h

Committer:
IanBenzMaxim
Date:
2016-05-13
Revision:
74:23be10c32fa3
Parent:
73:2cecc1372acc
Child:
75:8b627804927c

File content as of revision 74:23be10c32fa3:

#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