File content as of revision 24:434330962308:

/*******************************************************************************
* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* Except as contained in this notice, the name of Maxim Integrated
* Products, Inc. shall not be used except as stated in the Maxim Integrated
* Products, Inc. Branding Policy.
*
* The mere transfer of this software does not imply any licenses
* of trade secrets, proprietary technology, copyrights, patents,
* trademarks, maskwork rights, or any other form of intellectual
* property whatsoever. Maxim Integrated Products, Inc. retains all
* ownership rights.
*******************************************************************************
*/

#ifndef FACTORY_HPP
#define FACTORY_HPP

#include <stdint.h>

namespace OneWire { class DS2465; }
class SensorNode;

/// Represents the secure factory that will perform the initial provisioning of
/// Controllers (DS2465) and Sensor Nodes (DS28E15) for later authentication.
class Factory
{
public:
  /// Provision the DS2465 on a Controller.
  /// @returns True on success.
  bool provision(OneWire::DS2465 & ds2465);
  
  /// Provision the DS28E15 on a Sensor Node.
  /// @param validSecret True to provision using the valid system secret or false to imitate an invalid Controller.
  /// @returns True on success.
  bool provision(SensorNode & sensorNode, bool validSecret);
  
private:
  static const uint8_t masterSecret[]; ///< The valid master secret for the system.
  static const uint8_t invalidMasterSecret[]; ///< An invalid master secret for example purposes.
};

#endif