SoftHSMv2/src/lib/crypto/EDPrivateKey.h

   1 /*
   2  * Copyright (c) 2010 SURFnet bv
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  20  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  22  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
  24  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 /*****************************************************************************
  28  EDPrivateKey.h
  29
  30  EDDSA private key class
  31  *****************************************************************************/
  32
  33 #ifndef _SOFTHSM_V2_EDPRIVATEKEY_H
  34 #define _SOFTHSM_V2_EDPRIVATEKEY_H
  35
  36 #include "config.h"
  37 #include "PrivateKey.h"
  38
  39 class EDPrivateKey : public PrivateKey
  40 {
  41 public:
  42         // The type
  43         static const char* type;
  44
  45         // Check if the key is of the given type
  46         virtual bool isOfType(const char* inType);
  47
  48         // Get the bit length
  49         virtual unsigned long getBitLength() const;
  50
  51         // Get the output length
  52         virtual unsigned long getOutputLength() const;
  53
  54         // Get the base point order length
  55         virtual unsigned long getOrderLength() const = 0;
  56
  57         // Setters for the EDDSA private key components
  58         virtual void setK(const ByteString& inK);
  59
  60         // Setters for the EDDSA public key components
  61         virtual void setEC(const ByteString& inEC);
  62
  63         // Getters for the EDDSA private key components
  64         virtual const ByteString& getK() const;
  65
  66         // Getters for the EDDSA public key components
  67         virtual const ByteString& getEC() const;
  68
  69         // Serialisation
  70         virtual ByteString serialise() const;
  71         virtual bool deserialise(ByteString& serialised);
  72
  73 protected:
  74         // Private components
  75         ByteString k;
  76
  77         // Public components
  78         ByteString ec;
  79 };
  80
  81 #endif // !_SOFTHSM_V2_EDPRIVATEKEY_H
  82