cipherFileEncrypt

CryptoSys PKI Pro Manual

cipherFileEncrypt

Encrypt a file.

Syntax

[VBA]

Public Function cipherFileEncrypt ( _
    szFileOut As String, _
    szFileIn As String, _
    lpKey() As Byte, _
    lpIV() As Byte, _
    szAlgModePad As String, _
    Optional nOptions As Long = 0 _
) As Long

Parameters

szFileOut

Name of output file to be created or overwritten.

szFileIn

Name of input file.

lpKey

Key of exact length for block cipher algorithm.

lpIV

Initialization Vector (IV) of exactly the block size, empty array for ECB mode, or 12 bytes for AES-GCM.

szAlgModePad

String with block cipher algorithm, mode and padding, e.g. "aes128/cbc/pkcs5"

Alg:  aes128|aes192|aes256|tdea|3des|desede3
Mode: ecb|cbc|ofb|cfb|ctr|gcm
Pad:  pkcs5|nopad|oneandzeroes|ansix923|w3c

nOptions

Add PKI_IV_PREFIX to prepend the IV before the ciphertext in the output (ignored for ECB mode).

Return Value

Long: Zero on success or nonzero error code.

Remarks

fileOut and fileIn must not be the same. GCM mode is only available with AES. The IV must be exactly 12 bytes long for GCM.

[PREV: cipherFileDecrypt...] [Contents] [Index]

[NEXT: cipherKeyUnwrap...]