CryptoSys PKI Pro Manual

rsaSaveEncKey

Save an internal RSA key string to an encrypted key file.

Syntax

[VBA]
Public Function rsaSaveEncKey ( _
    szOutputFile As String, _
    szKeyStr As String, _
    szPassword As String, _
    Optional szParams As String = "", _
    Optional nOptions As Long = 0 _
) As Long

Parameters

szOutputFile
Name of output file to be created.
szKeyStr
The private RSA key as an internal key string.
szPassword
Password for encrypted private key (required).
szParams
Optional parameters. A set of attribute name=value pairs separated by a semicolon ";" (see remarks).
nOptions
Use 0 for defaults.
A flag to indicate the password-based encryption scheme to be used to encrypt the private key file. Select from:
PKI_PBE_SHA_3DES (0) for "pbeWithSHAAnd3-KeyTripleDES-CBC" from PKCS12 (default)
PKI_PBE_PBKDF2_DESEDE3 for PBKDF2 using des-EDE3-CBC
PKI_PBE_PBKDF2_AES128 for PBKDF2 using aes128-CBC
PKI_PBE_PBKDF2_AES192 for PBKDF2 using aes192-CBC
PKI_PBE_PBKDF2_AES256 for PBKDF2 using aes256-CBC
plus optionally one of the following to output in textual PEM format [default format=DER binary]
PKI_KEY_FORMAT_PEM
PKI_KEY_FORMAT_SSL

Return Value

Long: Zero on success else a nonzero error code.

Remarks

Valid name-value pair parameters for szParams are:
count=integer : To set the iteration count used in the PBKDF2 method, e.g. "count=5000;" [default=2048].
prf=hmac-name : To change the HMAC algorithm used in the PBKDF2 method, e.g. "prf=hmacWithSHA256;" [default=hmacWithSHA1].
Valid values for hmac-name are {hmacWithSHA1|hmacWithSHA224|hmacWithSHA256|hmacWithSHA384|hmacWithSHA512}.
[PREV: rsaReadPublicKey...]   [Contents]   [Index]   
   [NEXT: rsaSaveKey...]

Copyright © 2004-24 D.I. Management Services Pty Ltd. All rights reserved. Generated 2024-09-23T07:52:09Z.