PureBasic

Set a TLS Client Certificate for IMAP

Demonstrates the Chilkat Imap.SetSslClientCert method, which supplies a client certificate for TLS client-certificate authentication. The only argument is a Cert object that must provide access to its private key. Call it before connecting. This example loads the certificate from a PFX file.

Note: The certificate path is relative to the application's current working directory. Supply the path to your own certificate file.

Background: Most IMAP servers authenticate with a username and password only. A few high-security deployments additionally require mutual TLS, where the client presents its own certificate during the handshake. Because that happens as part of connecting, the certificate must be set before Connect — setting it afterward has no effect on the already-established connection.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkImap.pb"
IncludeFile "CkCert.pb"

Procedure ChilkatExample()

    success.i = 0

    ;  Demonstrates the Imap.SetSslClientCert method, which supplies a client certificate for TLS
    ;  client-certificate authentication.  The only argument is a Cert object.  It must be called
    ;  before connecting.

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

    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)

    ;  The PFX password is not hard-coded in source.  Insert code here to obtain it from an
    ;  interactive prompt, environment variable, or a secrets vault.
    pfxPassword.s

    ;  Load the client certificate (and its private key) from a PFX file.
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"qa_data/client.pfx",pfxPassword)
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkImap::ckDispose(imap)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ;  Provide the client certificate BEFORE connecting.
    success = CkImap::ckSetSslClientCert(imap,cert)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkImap::ckConnect(imap,"imap.example.com")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkImap::ckLogin(imap,"user@example.com","myPassword")
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkImap::ckDisconnect(imap)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf



    CkImap::ckDispose(imap)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure