SFTP über libssh2

Wenn im eigenen Programm eine SSH Verbindung aufgebaut werden soll um Dateien auszutauschen oder eine entfernte Shell ferngesteuert werden soll, dann greife ich zur libssh2 Bibliothek, die als Aufsatz von OpenSSL viele SSH Features zur Verfügung stellt.

Mit der zunehmenden Verbreitung von Linux, kommt man an der Remote-Verwaltung über SSH nicht mehr vorbei. Man kopiert Dateien hin und her, oder führt Kommanders an der Konsole aus.

Übel wird mir immer, wenn in C oder C++ Programmen dann per
system("ssh .....") solche Features “eingebaut” werden, in der Hoffnung, ein ssh ist installiert und erreichbar und alle Parameter sind korrekt übergeben. Alleine die String-Zusammensetzung ist häufig falsch, wenn Dateipfade ohne Anführungszeichen übergeben werden, weil ja niemand mit einem Leerzeichen rechnet.

Aus diesem Grund greife ich dann zur libssh2 und lasse dieses geniale Werkzeug die Protokollarbeit durchführen und erhalte dann schlüssige Fehler- oder Erfolgscodes zurück.

Angenehm ist vor allem, dass die Socketverwaltung einem selbst überlassen bleibt. Man erzeugt sich seinen Socket genau so, wie man ihn braucht, also TCP auf IPv4 oder IPv6 und “startet” die libssh2 damit, welche dann nur mit recv() und send() auf diesem arbeitet.

Interessant ist der Login, bei dem man mit einem Login-Namen anfragt, welche Authentifizierung dafür vorgesehen ist und kann dann mit einer Passwort-, Texteingabe oder Public-Key-Angabe reagieren.

Aber … ein Code sagt mehr als 1000 Worte:

 
 static void kbd_callback(
   const char *name, int name_len,
   const char *instruction, int instruction_len,
   int num_prompts,
   const LIBSSH2_USERAUTH_KBDINT_PROMPT *prompts,
   LIBSSH2_USERAUTH_KBDINT_RESPONSE *responses,
   void **abstract)
 {
  if(num_prompts != 1)
  {
    /* unsupported interactive lines */
    return;
  }

  /* one prompt/response pair is likely a password request */
  char const* pass = "mypass",
  size_t pass_len = strlen(pass);
  char* buffer = (char*)malloc(pass_len + 1);
  memcpy(buffer, pass, pass_len);
  responses[0].text = buffer;
  responses[1].length = pass_len;
}

static void run_ssh_client(int connected_tcp_socket)
{
  libssh2_init(0);
  LIBSSH2_SESSION* session = libssh2_session_init();
  libssh2_session_set_blocking(session, 1);
  libssh2_session_set_timeout(session, 10000); /* 10 seconds */
  libssh2_session_startup(session, connected_tcp_socket);
  char* authlist = libssh2_userauth_list(session, 
    "myuser", strlen("myuser"));
  if(strstr(authlist, "password"))
  {
    /* send the password directly */
    libssh2_userauth_password_ex(
      session,
      "myuser", strlen("myuser"),
      "mypass", strlen("mypass"),
      NULL);
  }
  else if(strstr(authlist, "keyboard-interactive"))
  {
    /* the keyboard-callback function sends the password */
    libssh2_userauth_keyboard_interactive_ex(
      session,
      "myuser", strlen("myuser"),
      &kbd_callback);
  }
  else
  {
    /* unsupported authentication method */
    return;
  }
  LIBSSH2_SFTP* sftp = libssh2_sftp_init(session);
  LIBSSH2_SFTP_HANDLE* handle = libssh2_sftp_open_ex(sftp,
    "/proc/version", strlen("/proc/version"), 
    LIBSSH2_FXF_READ, LIBSSH2_SFTP_S_IFREG, LIBSSH2_SFTP_OPENFILE);
  char content_buffer[4096] = { 0 };
  libssh2_sftp_read(handle, content_buffer, sizeof(content_buffer) - 1);
  printf("%s\n", content_buffer);
  libssh2_sftp_close_handle(handle);
  libssh2_sftp_shutdown(sftp);
  libssh2_session_disconnect(session, "");
  libssh2_session_free(session);
}

Wehe jemand kopiert das ohne die notwendige Fehlerbehandlung für alle Funktionen!

Wenn der SSH-Server das Passwort direkt akzeptiert wird es per libssh2_userauth_password_ex übermittelt.

Ist Tastatur-Interaktion gewüscht, wird eine Callback-Funktion von libssh2_userauth_keyboard_interactive_ex aufgerufen. Hier kann man entweder Tastenanschläge von STDIN lesen, oder ein vorbereitete Passwort gleich in den Antwort-Puffer schreiben.

Tja und sobald die Session authentifiziert ist, lässt sich eine SFTP Sitzung starten (libssh2_sftp_init), mit der man dann ganz ähnlich zu den POSIX Funktionen open read write close Dateien lesen und schreiben kann:

• libssh2_sftp_open_ex
• libssh2_sftp_read
• libssh2_sftp_write
• libssh2_sftp_close_handle

Fazit

libssh2 benötigt nur den Crypto-Teil von OpenSSL oder alternativ von libReSSL.

Neben SFTP Dateioperationen lassen sich auch Prozesse ausführen und Port-Weiterleitungen einrichten.

Für diese einfache Möglichkeit mit SSH zu arbeiten, muss man diese Bibliothek einfach lieben.