Objective-C

Authenticate an IMAP SSH Tunnel with a Password

Demonstrates the Chilkat Imap.SshAuthenticatePw method, which authenticates the SSH tunnel using a username and password. The first argument is the SSH login name and the second is the SSH password. Call SshOpenTunnel first; after SSH authentication succeeds, connect and log in to IMAP.

Background: This is SSH authentication, which is entirely separate from the IMAP login that follows — the SSH credentials belong to the tunnel/jump host, while the IMAP credentials belong to the mail account. Password authentication is the simplest option; use SshAuthenticatePk for key-based authentication, which is generally preferred for automated jobs.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoImap.h>
#import <NSString.h>

BOOL success = NO;

//  Demonstrates the Imap.SshAuthenticatePw method, which authenticates the SSH tunnel with a
//  username and password.  The 1st argument is the SSH login name and the 2nd is the SSH
//  password.  Call SshOpenTunnel first.

CkoImap *imap = [[CkoImap alloc] init];

//  Open the SSH tunnel first.
int sshPort = 22;
success = [imap SshOpenTunnel: @"ssh.example.com" sshPort: [NSNumber numberWithInt: sshPort]];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

//  The SSH password is not hard-coded in source.  Insert code here to obtain it from an
//  interactive prompt, environment variable, or a secrets vault.
NSString *sshPassword = 0;

//  Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
success = [imap SshAuthenticatePw: @"sshUser" sshPassword: sshPassword];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

//  With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
//  traffic flows through the tunnel automatically.
imap.Ssl = YES;
imap.Port = [NSNumber numberWithInt:993];
success = [imap Connect: @"imap.example.com"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Login: @"user@example.com" password: @"myPassword"];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap Disconnect];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}

success = [imap SshCloseTunnel];
if (success == NO) {
    NSLog(@"%@",imap.LastErrorText);
    return;
}