Data.DBXOpenSSL.TRSACypher.LoadSSLAndCreateKey

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

class function LoadSSLAndCreateKey(keyLength: Integer = RSA_KEY_LENGTH; Exponent: int64 = RSA_KEY_EXPONENT): Boolean; overload;

C++

__classmethod bool __fastcall LoadSSLAndCreateKey(int keyLength = 0x400, __int64 Exponent = 3LL)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.DBXOpenSSL.pas
Data.DBXOpenSSL.hpp
Data.DBXOpenSSL TRSACypher

Description

Helper method that loads the OpenSSL library, generates a global RSA key pair and returns True on success; it returns False if loading the OpenSSL library fails.

LoadSSLAndCreateKey accepts the following parameters:

  • keyLength is the length of the generated key. The default value is the value of the RSA_KEY_LENGTH constant.
  • Exponent is the exponent of the generated key. It must be a prime number. The default value is the value of the RSA_KEY_EXPONENT constant.

Exceptions

LoadSSLAndCreateKey may raise any of the following exceptions:

Class Message Description

TDBXError

<SSL error message>

An exception may be raised if an error occurs within the underlying HTTPS framework. The error message comes from the framework itself.

See Also