Config.hpp

This File On Github
Ask A Question

API: latest
module: oatpp-mbedtls
#include "oatpp-mbedtls/Config.hpp"

Config

Wrapper over mbedtls_ssl_config.

namespace oatpp { namespace mbedtls { 
  class Config {}
}}

Methods

Return Type Name Summary
[none] Config Constructor.
[none] ~Config Non-virtual destructor.
std::shared_ptr<Config> createShared Create shared Config.
std::shared_ptr<Config> createDefaultServerConfigShared Create default server config.
std::shared_ptr<Config> createDefaultClientConfigShared Create default client config.
mbedtls_ssl_config* getTLSConfig Get underlying mbedtls_ssl_config.
mbedtls_entropy_context* getEntropy Get entropy.
mbedtls_ctr_drbg_context* getCTR_DRBG Get CTR_DRBG.
mbedtls_x509_crt* getServerCertificate Get server certificate.
mbedtls_x509_crt* getCAChain Get CA Chain.
mbedtls_pk_context* getPrivateKey Get private key.

Config::Config

Constructor.

Config()

Config::~Config

Non-virtual destructor.

~Config()

Config::createShared

Create shared Config.

  • @return - std::shared_ptr to Config.

static std::shared_ptr<Config> createShared()

Config::createDefaultServerConfigShared

Create default server config.

  • @param serverCertFile - server certificate.
  • @param privateKeyFile - private key.
  • @param pkPassword - optional private key password.
  • @return - std::shared_ptr to Config.

static std::shared_ptr<Config> createDefaultServerConfigShared(const char* serverCertFile, const char* privateKeyFile, const char* pkPassword = nullptr)

Config::createDefaultClientConfigShared

Create default client config.

  • @return - std::shared_ptr to Config.

static std::shared_ptr<Config> createDefaultClientConfigShared()

Config::getTLSConfig

Get underlying mbedtls_ssl_config.

  • @return - mbedtls_ssl_config*.

mbedtls_ssl_config* getTLSConfig()

Config::getEntropy

Get entropy.

  • @return - mbedtls_entropy_context*

mbedtls_entropy_context* getEntropy()

Config::getCTR_DRBG

Get CTR_DRBG.

  • @return - mbedtls_ctr_drbg_context*

mbedtls_ctr_drbg_context* getCTR_DRBG()

Config::getServerCertificate

Get server certificate.

  • @return - mbedtls_x509_crt*

mbedtls_x509_crt* getServerCertificate()

Config::getCAChain

Get CA Chain.

  • @return - mbedtls_x509_crt*

mbedtls_x509_crt* getCAChain()

Config::getPrivateKey

Get private key.

  • @return - mbedtls_pk_context*

mbedtls_pk_context* getPrivateKey()