Set a PFX Safe-Bag Attribute

See more PFX/P12 Examples

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.

IncludeFile "CkPfx.pb"

Procedure ChilkatExample()

    success.i = 0

    pfx.i = CkPfx::ckCreate()
    If pfx.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  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.
    password.s = "myPfxPassword"
    success = CkPfx::ckLoadPfxFile(pfx,"qa_data/identity.pfx",password)
    If success = 0
        Debug CkPfx::ckLastErrorText(pfx)
        CkPfx::ckDispose(pfx)
        ProcedureReturn
    EndIf

    ;  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 1 for a private key or 0 for a certificate, and the 2nd is the zero-based
    ;  index within that collection.
    bForPrivateKey.i = 1

    ;  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 = CkPfx::ckSetSafeBagAttr(pfx,bForPrivateKey,0,"friendlyName","My Identity","")
    If success = 0
        Debug CkPfx::ckLastErrorText(pfx)
        CkPfx::ckDispose(pfx)
        ProcedureReturn
    EndIf

    Debug "Safe-bag attribute set."


    CkPfx::ckDispose(pfx)


    ProcedureReturn
EndProcedure