DwmCredenceEd25519KeyPair.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2022
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMCREDENCEED25519KEYPAIR_HH_
#define _DWMCREDENCEED25519KEYPAIR_HH_
 
#include "DwmCredenceShortString.hh"
 
namespace Dwm {
 
  namespace Credence {
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    class Ed25519KeyPair
    {
    public:
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      Ed25519KeyPair(const std::string & id = "");
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      Ed25519KeyPair(const Ed25519KeyPair &) = default;
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      ~Ed25519KeyPair();
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const ShortString & Id() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const ShortString & Id(const ShortString & id);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & PublicKey() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & PublicKey(const std::string & publicKey);
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & SecretKey() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      const std::string & SecretKey(const std::string & secretKey);
 
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      bool IsValid() const;
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      void Clear();
      
      //----------------------------------------------------------------------
      //----------------------------------------------------------------------
      bool operator == (const Ed25519KeyPair & keyPair) const;
      
    private:
      ShortString  _id;
      std::string  _publicKey;
      std::string  _secretKey;
    };
    
  }  // namespace Credence
 
}  // namespace Dwm
 
#endif  // _DWMCREDENCEED25519KEYPAIR_HH_