PureBasic

Add a Detached Signature (Header Placement Control)

Demonstrates the Chilkat Mime.AddDetachedSignature2 method, which creates the same multipart/signed structure as AddDetachedSignature, with a second argument controlling whether the existing message header fields are transferred to the new outer entity.

Note: The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background: Signing wraps the content in a new outer multipart/signed, which raises the question of where the message-level headers (Subject, From, To) should live. This variant lets you choose: transfer them up to the outer entity so the signed message looks like a normal email, or leave them on the inner part. Transferring is typical for email; the finer control matters when the signed entity is embedded in a larger structure.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkCert.pb"
IncludeFile "CkMime.pb"

Procedure ChilkatExample()

    success.i = 0

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

    success = CkMime::ckSetBodyFromPlainText(mime,"This message will be signed.")
    If success = 0
        Debug CkMime::ckLastErrorText(mime)
        CkMime::ckDispose(mime)
        ProcedureReturn
    EndIf

    ;  Load the signing certificate (which must have access to its private key) from a PFX file.
    ;  The PFX password should come from a secure source rather than being hard-coded.
    pfxPassword.s = "myPfxPassword"
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"qa_data/signer.pfx",pfxPassword)
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkMime::ckDispose(mime)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ;  AddDetachedSignature2 is the same as AddDetachedSignature, but the 2nd argument controls whether
    ;  the existing message header fields are transferred to the new outer multipart/signed entity.
    transferHeaderFields.i = 1
    success = CkMime::ckAddDetachedSignature2(mime,cert,transferHeaderFields)
    If success = 0
        Debug CkMime::ckLastErrorText(mime)
        CkMime::ckDispose(mime)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkMime::ckSaveMime(mime,"qa_output/signed.eml")
    If success = 0
        Debug CkMime::ckLastErrorText(mime)
        CkMime::ckDispose(mime)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    Debug "Detached signature added (headers transferred)."


    CkMime::ckDispose(mime)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure