TElX509CertificateEx.BeginGenerate method

TElX509CertificateEx.BeginGenerate

Starts asynchronous operation of generation of new certificate with defined algorithm and key length.

Declaration

[C#]
void BeginGenerate(int Algorithm, int DWordsInEncryptKey);
void BeginGenerate(TElX509Certificate Parent, int Algorithm, int DWordsInEncryptKey);

[VB.NET]
Sub BeginGenerate(ByVal Algorithm As Integer, ByVal DWordsInEncryptKey As Integer)
Sub BeginGenerate(ByVal Parent As TElX509Certificate, ByVal Algorithm As Integer, ByVal DWordsInEncryptKey As Integer)

[Pascal]
procedure BeginGenerate(Algorithm : integer; DwordsInEncryptKey : integer);
procedure BeginGenerate(Parent : TElX509Certificate; Algorithm: integer; DwordsInEncryptKey: integer);

[C++]
    void BeginGenerate(int32_t Algorithm, int32_t DWordsInEncryptKey);
    void BeginGenerate(TElX509Certificate &Parent, int32_t Algorithm, int32_t DWordsInEncryptKey);
    void BeginGenerate(TElX509Certificate *Parent, int32_t Algorithm, int32_t DWordsInEncryptKey);

[PHP]
void BeginGenerate(integer $Algorithm, integer $DWordsInEncryptKey)
void BeginGenerate(TElX509Certificate $Parent, integer $Algorithm, integer $DWordsInEncryptKey)

[Java]
void beginGenerate(TElX509Certificate Parent, int Algorithm, int DWordsInEncryptKey);
void beginGenerate(int Algorithm, int DWordsInEncryptKey);

Parameters

Algorithm - specifies the type of the key to be generated. Possible values are listed below.
When you generate a self-signed certificate, choose one of Signature Algorithms below, otherwise choose one of Public Key Algorithms below.
DWordsInEncryptKey - The number of 32-bit words in resulting key. The length of the key in bits is calculated as 32 * DWordsInEncryptKey
Parent - certificate to sign newly created one

Values:

The following algorithms may be used as public key algorithms:

Definition	Value	Description
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	0 (0x00)	RSA
SB_CERT_ALGORITHM_ID_DSA	4 (0x04)	DSA
SB_CERT_ALGORITHM_DH_PUBLIC	6 (0x06)	Diffie-Hellman
SB_CERT_ALGORITHM_ID_RSAPSS	11 (0x0B)	RSA key, which can be used only in RSA-PSS signature scheme
SB_CERT_ALGORITHM_ID_RSAOAEP	12 (0x0C)	RSA key, which can be used only for RSA-OAEP encryption
SB_CERT_ALGORITHM_UNKNOWN	65535 (0xFFFF)	the algorithm is unknown

The following algorithms may be used as signature algorithms:

Definition	Value	Description
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	1 (0x01)	RSA digital signature with MD2 digest
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	2 (0x02)	RSA digital signature with MD5 digest
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	3 (0x03)	RSA digital signature with SHA1 digest
SB_CERT_ALGORITHM_ID_DSA_SHA1	5 (0x05)	DSA digital signature with SHA1 digest
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	7 (0x07)	RSA digital signature with SHA-224 digest
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	8 (0x08)	RSA digital signature with SHA-256 digest
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	9 (0x09)	RSA digital signature with SHA-384 digest
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	10 (0x0A)	RSA digital signature with SHA-512 digest
SB_CERT_ALGORITHM_ID_RSAPSS	11 (0x0B)	DSA digital signature with SHA1 digest
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	13 (0x0D)	RSA-PSS digital signature
SB_CERT_ALGORITHM_UNKNOWN	65535 (0xFFFF)	the algorithm is unknown

Description

    This method causes TElX509CertificateEx object to start asynchronous operation of generation of a new certificate based on specified security algorithm. Specify the length of the resulting key(s) using WordsInEncryptKey parameter. All data of the generated certificate will be accessible via object properties and methods.
    Before calling BeginGenerate you need to set ValidFrom and ValidTo properties.
    BeginGenerate method can be used to generate self-signed certificates or certificates signed by Certificate Authority.
    If you generate certificate signed by Certificate Authority, you need to call SetCACertificate and SetCAPrivateKey methods to specify certificate and private key of the issuer (CA).
    Note, that for self-signed certififcates an instance of TElX509CertificateEx class, whose BeginGenerate method is called, should have a Private Key. If the private key is absent, TElCertificateException is raised.

Discuss this help topic in SecureBlackbox Forum