SFTP Authenticate with a SecureString Password

See more SFTP Examples

Demonstrates the Chilkat SFtp.AuthenticateSecPw method, which authenticates using SecureString login and password objects. The first argument is the login and the second is the password.

Background: A SecureString keeps the credential encrypted in memory, reducing the chance of a plaintext password lingering in the process. The behavior otherwise matches AuthenticatePw; only the credential handling is more protective. Populate the SecureString from a value obtained at runtime, not a hard-coded literal.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkSFtp.h>
#include <C_CkSecureString.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSFtp sftp;
    int port;
    const char *password;
    HCkSecureString secureLogin;
    HCkSecureString securePassword;

    success = FALSE;

    //  Demonstrates the SFtp.AuthenticateSecPw method, which authenticates using SecureString login
    //  and password objects.  The 1st argument is the login and the 2nd is the password.

    sftp = CkSFtp_Create();

    //  Step 1: Connect the SSH transport.  Port 22 is the usual port.
    port = 22;
    success = CkSFtp_Connect(sftp,"sftp.example.com",port);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    password = "mySshPassword";

    //  Place the login and password into SecureString objects.
    secureLogin = CkSecureString_Create();
    CkSecureString_Append(secureLogin,"mySshLogin");
    securePassword = CkSecureString_Create();
    CkSecureString_Append(securePassword,password);

    success = CkSFtp_AuthenticateSecPw(sftp,secureLogin,securePassword);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        CkSecureString_Dispose(secureLogin);
        CkSecureString_Dispose(securePassword);
        return;
    }

    //  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
    //  file or directory operations.
    success = CkSFtp_InitializeSftp(sftp);
    if (success == FALSE) {
        printf("%s\n",CkSFtp_lastErrorText(sftp));
        CkSFtp_Dispose(sftp);
        CkSecureString_Dispose(secureLogin);
        CkSecureString_Dispose(securePassword);
        return;
    }

    printf("Authenticated with secure strings.\n");

    CkSFtp_Disconnect(sftp);


    CkSFtp_Dispose(sftp);
    CkSecureString_Dispose(secureLogin);
    CkSecureString_Dispose(securePassword);

    }