SoftHSMv2/src/lib/crypto/OSSLEDPrivateKey.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  OSSLEDPrivateKey.h
  29
  30  OpenSSL EDDSA private key class
  31  *****************************************************************************/
  32
  33 #ifndef _SOFTHSM_V2_OSSLEDPRIVATEKEY_H
  34 #define _SOFTHSM_V2_OSSLEDPRIVATEKEY_H
  35
  36 #include "config.h"
  37 #include "EDPrivateKey.h"
  38 #include <openssl/bn.h>
  39 #include <openssl/evp.h>
  40
  41 class OSSLEDPrivateKey : public EDPrivateKey
  42 {
  43 public:
  44         // Constructors
  45         OSSLEDPrivateKey();
  46
  47         OSSLEDPrivateKey(const EVP_PKEY* inPKEY);
  48
  49         // Destructor
  50         virtual ~OSSLEDPrivateKey();
  51
  52         // The type
  53         static const char* type;
  54
  55         // Check if the key is of the given type
  56         virtual bool isOfType(const char* inType);
  57
  58         // Get the base point order length
  59         virtual unsigned long getOrderLength() const;
  60
  61         // Setters for the EDDSA private key components
  62         virtual void setK(const ByteString& inK);
  63
  64         // Setters for the EDDSA public key components
  65         virtual void setEC(const ByteString& inEC);
  66
  67         // Encode into PKCS#8 DER
  68         virtual ByteString PKCS8Encode();
  69
  70         // Decode from PKCS#8 BER
  71         virtual bool PKCS8Decode(const ByteString& ber);
  72
  73         // Set from OpenSSL representation
  74         virtual void setFromOSSL(const EVP_PKEY* inPKEY);
  75
  76         // Retrieve the OpenSSL representation of the key
  77         EVP_PKEY* getOSSLKey();
  78
  79 private:
  80         // The internal OpenSSL representation
  81         int nid;
  82         EVP_PKEY* pkey;
  83
  84         // Create the OpenSSL representation of the key
  85         void createOSSLKey();
  86 };
  87
  88 #endif // !_SOFTHSM_V2_OSSLEDPRIVATEKEY_H
  89