PureBasic

Using WS_FTP Self-signed Certificate file (.crt) and Private Key File. (.key)

See more FTP Examples

Demonstrates how to use a self-signed certificate created by WS_FTP with Chilkat FTP2.

Note: It is usually not necessary for the FTP client to use a client-side certificate. Most FTP servers using SSL and TLS connections (explicit or implicit) do not require client-side certs. In addition, some high-security FTP servers require "real" certificates -- meaning certificates issued by a real certificate authority with a chain of authentication that leads to a trusted root certificate. The certificates created by WS_FTP are self-signed and untrusted.

PureBasic

IncludeFile "CkCertStore.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkFtp2.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; Important:  Before running this program, convert your
    ; .crt and .key files to a .p12 using OpenSSL:
    ; The command is this:
    ; openssl pkcs12 -export -in test.crt -inkey test.key -out test.p12
    ; 

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

    CkFtp2::setCkHostname(ftp, "ftp.example.com")
    CkFtp2::setCkPort(ftp, 21)
    CkFtp2::setCkUsername(ftp, "testLogin")
    CkFtp2::setCkPassword(ftp, "testPassword")

    ; This example will use explict TLS/SSL.
    ; Establish an explicit secure channel after connection
    ; on the standard FTP port 21.
    CkFtp2::setCkAuthTls(ftp, 1)

    ; The Ssl property is for establishing an implicit SSL connection
    ; on port 990.  Because this example uses explicit SSL, it 
    ; should remain 0.
    CkFtp2::setCkSsl(ftp, 0)

    ; Create an instance of a certificate store object, load a .p12 file,
    ; locate the certificate we need, and use it for signing.
    ; (a P12/PFX file may contain more than one certificate.)
    certStore.i = CkCertStore::ckCreate()
    If certStore.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The 1st argument is the filename, the 2nd arg is the 
    ; .p12 file's password.  (OpenSSL will prompty you to set a password
    ; when converting the .crt and .key into a .p12).
    success = CkCertStore::ckLoadPfxFile(certStore,"test.p12","secret")
    If success <> 1
        Debug CkCertStore::ckLastErrorText(certStore)
        CkFtp2::ckDispose(ftp)
        CkCertStore::ckDispose(certStore)
        ProcedureReturn
    EndIf

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

    CkJsonObject::ckUpdateString(jsonCN,"CN","cert common name")

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

    success = CkCertStore::ckFindCert(certStore,jsonCN,cert)
    If success = 0
        Debug CkCertStore::ckLastErrorText(certStore)
        CkFtp2::ckDispose(ftp)
        CkCertStore::ckDispose(certStore)
        CkJsonObject::ckDispose(jsonCN)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    success = CkFtp2::ckSetSslClientCert(ftp,cert)

    ; Connect and login to the FTP server.
    success = CkFtp2::ckConnect(ftp)
    If success <> 1
        Debug CkFtp2::ckLastErrorText(ftp)
        CkFtp2::ckDispose(ftp)
        CkCertStore::ckDispose(certStore)
        CkJsonObject::ckDispose(jsonCN)
        CkCert::ckDispose(cert)
        ProcedureReturn
    Else
        ; LastErrorText contains information even when
        ; successful. This allows you to visually verify
        ; that the secure connection actually occurred.
        Debug CkFtp2::ckLastErrorText(ftp)
    EndIf

    Debug "Secure FTP Channel Established!"
    Debug CkFtp2::ckLastErrorText(ftp)

    ; Do whatever you're doing to do ...
    ; upload files, download files, etc...

    ; ...
    ; ...

    success = CkFtp2::ckDisconnect(ftp)


    CkFtp2::ckDispose(ftp)
    CkCertStore::ckDispose(certStore)
    CkJsonObject::ckDispose(jsonCN)
    CkCert::ckDispose(cert)


    ProcedureReturn
EndProcedure