JavaScript

Set a PFX Safe-Bag Attribute

Demonstrates Pfx.SetSafeBagAttr, which sets a safe-bag attribute on a private key or certificate inside the PFX.

The file path is relative to the application's current working directory. An absolute path may also be used. Supply the path appropriate to your own environment.

Background. A safe-bag attribute is metadata attached to an item inside a PKCS#12/PFX container; it does not change the certificate or private-key material. Recognized attributes include friendlyName, keyContainerName, keyName, and localKeyId. The encoding argument names the value's binary representation for binary attributes and is ignored for text-valued attributes such as friendlyName.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var pfx = new CkPfx();

//  The file path is relative to the application's current working directory.  An absolute path
//  may also be used.  Supply the path appropriate to your own environment.
//  The PFX password should come from a secure source rather than being hard-coded.
var password = "myPfxPassword";
success = pfx.LoadPfxFile("qa_data/identity.pfx",password);
if (success == false) {
    console.log(pfx.LastErrorText);
    return;
}

//  Set a safe-bag attribute on an item inside the PFX.  Safe-bag attributes are metadata attached to
//  an item in the container; they do not change the certificate or key material itself.  The 1st
//  argument is true for a private key or false for a certificate, and the 2nd is the zero-based
//  index within that collection.
var bForPrivateKey = true;

//  friendlyName is a text-valued attribute, so the encoding argument is ignored (pass an empty
//  string).  For binary attributes such as localKeyId, the encoding names the value's representation.
success = pfx.SetSafeBagAttr(bForPrivateKey,0,"friendlyName","My Identity","");
if (success == false) {
    console.log(pfx.LastErrorText);
    return;
}

console.log("Safe-bag attribute set.");