Qore Programming Language  0.8.3
Public Member Functions
QoreSSLPrivateKey Class Reference

provides access to a private key data structure for SSL connections More...

#include <QoreSSLPrivateKey.h>

Inheritance diagram for QoreSSLPrivateKey:
AbstractPrivateData QoreReferenceCounter

List of all members.

Public Member Functions

DLLEXPORT QoreSSLPrivateKey (const char *fn, const char *pp, ExceptionSink *xsink)
 creates the object from a file name by reading in the file in PEM format
DLLEXPORT QoreSSLPrivateKey (const BinaryNode *bin, ExceptionSink *xsink)
 creates the object from a pointer to a BinaryNode object (key data in DER format)
DLLEXPORT QoreSSLPrivateKey (const QoreString *str, const char *pp, ExceptionSink *xsink)
 create the object from a pointer to a QoreString representing the private key data in PEM format
DLLEXPORT QoreStringNodegetPEM (ExceptionSink *xsink) const
 returns a string in PEM format representing the private key, caller owns the QoreString reference count returned
DLLEXPORT int64 getVersion () const
 returns a constant '1': do not use; only included for backwards-compatibility
DLLEXPORT int64 getBitLength () const
 returns the length in bits
DLLEXPORT QoreHashNodegetInfo () const
 caller owns the QoreHashNode reference count returned
DLLLOCAL QoreSSLPrivateKey (EVP_PKEY *p)
 private constructor; not exported

Detailed Description

provides access to a private key data structure for SSL connections


Constructor & Destructor Documentation

DLLEXPORT QoreSSLPrivateKey::QoreSSLPrivateKey ( const char *  fn,
const char *  pp,
ExceptionSink xsink 
)

creates the object from a file name by reading in the file in PEM format

Parameters:
fnthe filename of the private key file to open (must be in PEM format)
ppthe pass phase for the key (if any; may be NULL)
xsinkQore-language exceptions are raised here in case of errors
DLLEXPORT QoreSSLPrivateKey::QoreSSLPrivateKey ( const BinaryNode bin,
ExceptionSink xsink 
)

creates the object from a pointer to a BinaryNode object (key data in DER format)

Parameters:
bina pointer to a BinaryNode object with the raw binary private key information
xsinkQore-language exceptions are raised here in case of errors
DLLEXPORT QoreSSLPrivateKey::QoreSSLPrivateKey ( const QoreString str,
const char *  pp,
ExceptionSink xsink 
)

create the object from a pointer to a QoreString representing the private key data in PEM format

Parameters:
stra pointer to a QoreString with the private key data in PEM format
ppthe pass phase for the key (if any; may be NULL)
xsinkQore-language exceptions are raised here in case of errors

Member Function Documentation

DLLEXPORT QoreStringNode* QoreSSLPrivateKey::getPEM ( ExceptionSink xsink) const

returns a string in PEM format representing the private key, caller owns the QoreString reference count returned

Returns:
a string in PEM format representing the private key, caller owns the QoreString reference count returned

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines