OpenDDS::Security::SSL::PrivateKey Class Reference

#include <PrivateKey.h>

Public Types
typedef DCPS::unique_ptr< PrivateKey >	unique_ptr

Public Member Functions
	PrivateKey (const std::string &uri, const std::string &password="")
	PrivateKey ()
virtual	~PrivateKey ()
void	load (const std::string &uri, const std::string &password="")
int	sign (const std::vector< const DDS::OctetSeq *> &src, DDS::OctetSeq &dst) const

Private Member Functions
	PrivateKey (const PrivateKey &)
PrivateKey &	operator= (const PrivateKey &)

Static Private Member Functions
static EVP_PKEY *	EVP_PKEY_from_pem (const std::string &path, const std::string &password="")
static EVP_PKEY *	EVP_PKEY_from_pem_data (const std::string &data, const std::string &password)

Private Attributes
EVP_PKEY *	k_

Friends
OpenDDS_Security_Export bool	operator== (const PrivateKey &lhs, const PrivateKey &rhs)

Detailed Description

Definition at line 25 of file PrivateKey.h.

Member Typedef Documentation

unique_ptr

typedef DCPS::unique_ptr<PrivateKey> OpenDDS::Security::SSL::PrivateKey::unique_ptr

Definition at line 28 of file PrivateKey.h.

Constructor & Destructor Documentation

PrivateKey() [1/3]

OpenDDS::Security::SSL::PrivateKey::PrivateKey ( const std::string &  uri, const std::string &  password = ""  )

explicit

Definition at line 22 of file PrivateKey.cpp.

References load().

  : k_(0)
{
  load(uri, password);
}

PrivateKey() [2/3]

OpenDDS::Security::SSL::PrivateKey::PrivateKey

(

)

Definition at line 28 of file PrivateKey.cpp.

  : k_(0)
{
}

~PrivateKey()

OpenDDS::Security::SSL::PrivateKey::~PrivateKey ( )

virtual

Definition at line 33 of file PrivateKey.cpp.

References k_.

{
  if (k_) {
    EVP_PKEY_free(k_);
  }
}

PrivateKey() [3/3]

OpenDDS::Security::SSL::PrivateKey::PrivateKey ( const PrivateKey &  )

private

Member Function Documentation

EVP_PKEY_from_pem()

EVP_PKEY * OpenDDS::Security::SSL::PrivateKey::EVP_PKEY_from_pem ( const std::string &  path, const std::string &  password = ""  )

staticprivate

Definition at line 164 of file PrivateKey.cpp.

References OPENDDS_SSL_LOG_ERR.

Referenced by load().

{
  EVP_PKEY* result = 0;

  BIO* filebuf = BIO_new_file(path.c_str(), "r");
  if (filebuf) {
    result = PEM_read_bio_PrivateKey(filebuf, 0, 0,
                                     password.empty() ? 0 : (void*)password.c_str());
    if (!result) {
      OPENDDS_SSL_LOG_ERR("PEM_read_bio_PrivateKey failed");
    }

    BIO_free(filebuf);

  } else {
    std::stringstream errmsg;
    errmsg << "failed to read file '" << path << "' using BIO_new_file";
    OPENDDS_SSL_LOG_ERR(errmsg.str().c_str());
  }

  return result;
}

EVP_PKEY_from_pem_data()

EVP_PKEY * OpenDDS::Security::SSL::PrivateKey::EVP_PKEY_from_pem_data ( const std::string &  data, const std::string &  password  )

staticprivate

Definition at line 188 of file PrivateKey.cpp.

References OPENDDS_SSL_LOG_ERR.

Referenced by load().

{
  DDS::OctetSeq original_bytes;

  // The minus 1 is because path contains a comma in element 0 and that
  // comma is not included in the cert string
  original_bytes.length(static_cast<unsigned int>(data.size() - 1));
  std::memcpy(original_bytes.get_buffer(), &data[1],
              original_bytes.length());

  // To appease the other DDS security implementations which
  // append a null byte at the end of the cert.
  original_bytes.length(original_bytes.length() + 1);
  original_bytes[original_bytes.length() - 1] = 0;

  EVP_PKEY* result = 0;
  BIO* filebuf = BIO_new(BIO_s_mem());

  if (filebuf) {
    if (0 >= BIO_write(filebuf, original_bytes.get_buffer(),
                       original_bytes.length())) {
      OPENDDS_SSL_LOG_ERR("BIO_write failed");
    }

    result = PEM_read_bio_PrivateKey(filebuf, 0, 0,
                                     password.empty() ? 0 : (void*)password.c_str());

    if (!result) {
      OPENDDS_SSL_LOG_ERR("PEM_read_bio_PrivateKey failed");
    }

    BIO_free(filebuf);

  } else {
    std::stringstream errmsg;
    errmsg << "failed to create data '" << data << "' using BIO_new";
    OPENDDS_SSL_LOG_ERR(errmsg.str().c_str());
  }

  return result;
}

load()

void OpenDDS::Security::SSL::PrivateKey::load	(	const std::string &	uri,
		const std::string &	password = ""
	)

Definition at line 40 of file PrivateKey.cpp.

References ACE_ERROR, ACE_TEXT(), OpenDDS::Security::CommonUtilities::URI::everything_else, EVP_PKEY_from_pem(), EVP_PKEY_from_pem_data(), k_, LM_WARNING, OpenDDS::Security::CommonUtilities::URI::scheme, OpenDDS::Security::CommonUtilities::URI::URI_DATA, OpenDDS::Security::CommonUtilities::URI::URI_FILE, OpenDDS::Security::CommonUtilities::URI::URI_PKCS11, and OpenDDS::Security::CommonUtilities::URI::URI_UNKNOWN.

Referenced by PrivateKey().

{
  using namespace CommonUtilities;

  if (k_) return;

  URI uri_info(uri);

  switch (uri_info.scheme) {
  case URI::URI_FILE:
    k_ = EVP_PKEY_from_pem(uri_info.everything_else, password);
    break;

  case URI::URI_DATA:
    k_ = EVP_PKEY_from_pem_data(uri_info.everything_else, password);
    break;

  case URI::URI_PKCS11:
  case URI::URI_UNKNOWN:
  default:
    ACE_ERROR((LM_WARNING,
               ACE_TEXT("(%P|%t) SSL::PrivateKey::load: WARNING: Unsupported URI scheme in cert path '%C'\n"),
               uri.c_str()));
    break;
  }
}

operator=()

PrivateKey& OpenDDS::Security::SSL::PrivateKey::operator= ( const PrivateKey &  )

private

sign()

int OpenDDS::Security::SSL::PrivateKey::sign	(	const std::vector< const DDS::OctetSeq *> &	src,
		DDS::OctetSeq &	dst
	)		const

Definition at line 157 of file PrivateKey.cpp.

References k_.

Referenced by OpenDDS::Security::SSL::sign_serialized().

{
  sign_implementation sign(k_);
  return sign(src, dst);
}

Friends And Related Function Documentation

operator==

OpenDDS_Security_Export bool operator== ( const PrivateKey &  lhs, const PrivateKey &  rhs  )

friend

Definition at line 231 of file PrivateKey.cpp.

{
  if (lhs.k_ && rhs.k_) {
#ifdef OPENSSL_V_3_0
    return 1 == EVP_PKEY_eq(lhs.k_, rhs.k_);
#else
    return 1 == EVP_PKEY_cmp(lhs.k_, rhs.k_);
#endif
  }
  return lhs.k_ == rhs.k_;
}

Member Data Documentation

k_

EVP_PKEY* OpenDDS::Security::SSL::PrivateKey::k_

private

Definition at line 54 of file PrivateKey.h.

Referenced by load(), OpenDDS::Security::SSL::operator==(), sign(), and ~PrivateKey().

---

The documentation for this class was generated from the following files:

• PrivateKey.h
• PrivateKey.cpp