Cloud Keys 2020 Node.js Edition

Questions / Feedback?

Encrypt Method

Encrypts data using a key.


azurekeys.encrypt(keyName, algorithm, [callback])


The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:



This method encrypts data using the key specified by KeyName and the given Algorithm. The VersionId configuration setting can be used to target a specific key version.

The data to encrypt is taken from the the specified InputFile or the InputData property. The encrypted data is output to the the specified OutputFile or the OutputData property.

The key specified by KeyName must be an RSA key; EC keys cannot be used for encryption/decryption.

The Algorithm parameter specifies which algorithm to use to encrypt the data. The type of key and the selected algorithm together dictate the maximum size of the input data. Refer to the following table for possible values and maximum data sizes:

Algorithm Description RSA_2048 RSA_3072 RSA_4096
RSA1_5 RSAES-PKCS1-v1_5 245 373 509
RSA-OAEP RSAES OAEP using SHA-1 and MGF1 with SHA-1 214 342 470
RSA-OAEP-256 RSAES OAEP using SHA-256 and MGF1 with SHA-256 190 318 446

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 8157]