6.4 Get Locking Key

Most developers do not need to use this function, and should instead rely on appropriate lock/unlock methods for encrypting and decrypting all data. This is meant only for highly advanced use-cases where the developer needs to use some custom encryption algorithm and/or explicitly add/validate signatures on some special piece of data or stream which can’t be easily passed to standard lock/unlock methods. In this case, the keys returned by this function should be used very carefully for a single object or stream, and then destroyed immediately after encryption/decryption or signature generation/verification is done.

The getLockingKey function returns locking key along with the keys for signature generation and signature verification for an encryption policy, key generation policy.

The function takes the following parameters :

• sessionId : Unique SessionId which is received in the login/registration function response.

• encryptionPolicy : BayunEncryptionPolicy determines the key to be used to generate the lockingKey.

• keyGenerationPolicy : BayunKeyGenerationPolicy determines the policy to generate the lockingKey.

• groupId: GroupId is required if encryptionPolicy is GROUP.

If encryptionPolicy is other than GROUP,groupId should be an empty string.

JavaScript

bayunCore.getLockingKey(
    "<sessionId>",
    BayunCore.EncryptionPolicy.GROUP,
    BayunCore.KeyGenerationPolicy.STATIC,
    "<groupId>"
  )
  .then(result => {
    console.log("Response received for getLockingKey.");
    console.log(result);
  })
  .catch(error => {
    console.log("Error caught");
    console.log(error);
  });

The getLockingKey function returns an object where the keys are CryptoKey objects.

JavaScript

{
    key,  //Locking Key
    signatureKey, //Private Key to be used for signature generation
    signatureVerificationKey, //Public Key to be used for signature verification
};

To get the same keys as strings in PEM format, use the methodgetLockingKeyForEncryptionPolicyAsString.