Lua

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 Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- 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.

local imap = chilkat.Imap.new()

imap.ssl = true
imap.port = 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.
local pfxPassword = ""

-- Load the client certificate (and its private key) from a PFX file.
local cert = chilkat.Cert.new()
local success = cert:load_pfx_file("qa_data/client.pfx", pfxPassword)
if not success then
    print(cert.last_error_text)
    return
end

-- Provide the client certificate BEFORE connecting.
success = imap:set_ssl_client_cert(cert)
if not success then
    print(imap.last_error_text)
    return
end

success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:login("user@example.com", "myPassword")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:disconnect()
if not success then
    print(imap.last_error_text)
    return
end