Ssl::KeyCertPair Class Reference

Class to manage an SSL key certificate with optional password. More...

#include <KeyCertPair.h>

Public Member Functions
bool	isValid () const
bool	assign (const KeyCertPair &keyCert)
	Assign another certificate to this structure. More...
void	free ()
const uint8_t *	getKey () const
unsigned	getKeyLength () const
const char *	getKeyPassword () const
const uint8_t *	getCertificate () const
unsigned	getCertificateLength () const
bool	assign (const uint8_t *newKey, unsigned newKeyLength, const uint8_t *newCertificate, unsigned newCertificateLength, const char *newKeyPassword=nullptr)
	Create certificate using provided values. More...
bool	assign (String newKey, String newCertificate, const char *newKeyPassword=nullptr)

Detailed Description

Class to manage an SSL key certificate with optional password.

Member Function Documentation

assign() [1/3]

bool Ssl::KeyCertPair::assign ( const KeyCertPair &  keyCert )

inline

Assign another certificate to this structure.

Parameters

keyCert

Return values

bool	false on memory allocation failure

Note

We take a new copy of the certificate

assign() [2/3]

bool Ssl::KeyCertPair::assign	(	const uint8_t *	newKey,
		unsigned	newKeyLength,
		const uint8_t *	newCertificate,
		unsigned	newCertificateLength,
		const char *	newKeyPassword = nullptr
	)

Create certificate using provided values.

Parameters

newKey
newKeyLength
newCertificate
newCertificateLength
newKeyPassword

Return values

bool	false on memory allocation failure

Note

We take a new copy of the certificate

assign() [3/3]

bool Ssl::KeyCertPair::assign ( String  newKey, String  newCertificate, const char *  newKeyPassword = nullptr  )

inline

free()

void Ssl::KeyCertPair::free ( )

inline

getCertificate()

const uint8_t* Ssl::KeyCertPair::getCertificate ( ) const

inline

getCertificateLength()

unsigned Ssl::KeyCertPair::getCertificateLength ( ) const

inline

getKey()

const uint8_t* Ssl::KeyCertPair::getKey ( ) const

inline

getKeyLength()

unsigned Ssl::KeyCertPair::getKeyLength ( ) const

inline

getKeyPassword()

const char* Ssl::KeyCertPair::getKeyPassword ( ) const

inline

isValid()

bool Ssl::KeyCertPair::isValid ( ) const

inline

---

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

• KeyCertPair.h