Client SFTP del componente sgcIndy per Delphi

· Componenti

Il trasferimento file sicuro rimane uno dei pilastri dell'integrazione enterprise. Che tu stia scambiando dati con partner bancari, sincronizzando file con server remoti o automatizzando pipeline di deployment, SFTP (SSH File Transfer Protocol) è lo standard del settore per spostare file in modo sicuro su reti non fidate.

Il pacchetto sgcIndy include TIdSFTPClient: un componente client SFTP Delphi nativo che funziona su SSH senza richiedere strumenti da riga di comando esterni o eseguibili di terze parti. Supporta upload e download di file, gestione directory, symbolic link, attributi dei file, tracciamento dell'avanzamento e algoritmi crittografici moderni, il tutto tramite un'API pulita ed event-driven.

Questo articolo copre l'intero set di funzionalità e fornisce codice Delphi pronto all'uso per le operazioni SFTP più comuni.

Caratteristiche principali

Trasferimento file
Carica e scarica file con buffer di dimensione configurabile ed eventi di progresso in tempo reale. Trasferisci da percorsi di file o direttamente da oggetti TStream.
Operazioni su directory
Elenca le directory con i metadati completi, crea e rimuovi directory e risolvi i percorsi inclusi i symbolic link.
Crittografia moderna
Curve25519, ECDH, AES-GCM, chiavi Ed25519 e HMAC-SHA2. Negoziazione degli algoritmi configurabile per soddisfare i requisiti di compliance.
Metodi di autenticazione multipli
Autenticazione con password, chiave pubblica (RSA, ECDSA, Ed25519) e keyboard-interactive. Verifica della host key con callback sul fingerprint.
Attributi e permessi dei file
Leggi e modifica permessi, proprietario, timestamp e dimensioni dei file. Pieno supporto per i mode bit in stile Unix e per i symbolic link.
Progresso ed eventi
Monitora l'avanzamento del trasferimento con byte trasferiti e dimensione totale. Trasferimenti annullabili. Eventi di errore, connessione e disconnessione.

Quick start — connessione e download di un file

Un esempio minimale che si connette a un server remoto, scarica un file e si disconnette.

var
  oSFTP: TIdSFTPClient;
begin
  oSFTP := TIdSFTPClient.Create(nil);
  Try
    oSFTP.Host := 'sftp.example.com';
    oSFTP.Port := 22;
    oSFTP.Authentication.Username := 'deploy';
    oSFTP.Authentication.Password := 'secret';
    oSFTP.Connect;
    // Download a file
    oSFTP.Get('/data/report.csv', 'C:\local\report.csv');
    oSFTP.Disconnect;
  Finally
    oSFTP.Free;
  End;
end;

Autenticazione

Il componente supporta tre metodi di autenticazione. Tutti e tre sono abilitati per impostazione predefinita: client e server negoziano automaticamente il metodo più appropriato.

Autenticazione con password

oSFTP.Authentication.Username := 'admin';
oSFTP.Authentication.Password := 'secret';

Autenticazione con chiave pubblica

oSFTP.Authentication.Username := 'deploy';
oSFTP.Authentication.PrivateKeyFile := 'C:\keys\id_rsa';
oSFTP.Authentication.PublicKeyFile := 'C:\keys\id_rsa.pub';
oSFTP.Authentication.Passphrase := 'keypassphrase';

Verifica della host key

Verifica l'identità del server ispezionando il fingerprint della host key nell'evento OnSSHHostKey.

oSFTP.OnSSHHostKey := OnHostKey;
procedure TForm1.OnHostKey(Sender: TObject;
  const aHostKeyType, aFingerprint: string;
  var aAction: TIdSSHHostKeyVerification);
begin
  // Verify fingerprint against known hosts
  if aFingerprint = 'SHA256:xyzABC123...' then
    aAction := sshHostKeyAccept
  else
    aAction := sshHostKeyReject;
end;

Operazioni sui file

Upload e download

// Upload a file
oSFTP.Put('C:\local\data.zip', '/uploads/data.zip');
// Download a file
oSFTP.Get('/reports/monthly.pdf', 'C:\local\monthly.pdf');
// Upload from a stream
oSFTP.Put(oMemoryStream, '/uploads/stream-data.bin');
// Download to a stream
oSFTP.Get('/data/export.csv', oFileStream);

Metodi di convenienza basati su stringhe

// Read a remote file into a string
vContent := oSFTP.GetFileAsString('/config/settings.json');
// Write a string to a remote file
oSFTP.PutFileFromString('{"key":"value"}', '/config/settings.json');
// Delete a remote file
oSFTP.Delete('/tmp/old-file.log');
// Rename / move a file
oSFTP.Rename('/data/temp.csv', '/data/final.csv');
// Create a symbolic link
oSFTP.Symlink('/data/final.csv', '/data/latest.csv');

Operazioni su directory

// List directory contents with full metadata
var
  oItems: TIdSFTPDirectoryItems;
  i: Integer;
begin
  oItems := oSFTP.ListDirectory('/data');
  for i := 0 to Length(oItems) - 1 do
    WriteLn(oItems[i].Filename + ' - ' +
      IntToStr(oItems[i].Attrs.Size) + ' bytes');
end;
// Create and remove directories
oSFTP.MakeDirectory('/data/archive/2026');
oSFTP.RemoveDirectory('/data/temp');
// Get current working directory
vPath := oSFTP.GetCurrentDirectory;
// Resolve a path (follows symlinks, resolves . and ..)
vRealPath := oSFTP.RealPath('../data/../data/./file.txt');

Attributi e informazioni sui file

// Check existence
if oSFTP.FileExists('/data/report.csv') then
  WriteLn('File found');
if oSFTP.DirectoryExists('/data/archive') then
  WriteLn('Directory exists');
// Get file size
vSize := oSFTP.FileSize('/data/report.csv');
// Get full attributes (size, permissions, timestamps, UID/GID)
var
  oAttrs: TIdSFTPFileAttributes;
begin
  oAttrs := oSFTP.Stat('/data/report.csv');
  WriteLn('Size: ' + IntToStr(oAttrs.Size));
  WriteLn('Permissions: ' + IntToStr(oAttrs.Permissions));
end;

Progresso e annullamento dei trasferimenti

L'evento OnSFTPProgress viene attivato durante ogni trasferimento di file, fornendo un tracciamento in tempo reale e la possibilità di annullare a metà del trasferimento.

oSFTP.OnSFTPProgress := OnProgress;
procedure TForm1.OnProgress(Sender: TObject;
  const aFilename: string;
  aTransferred, aTotal: Int64;
  var Cancel: Boolean);
begin
  ProgressBar1.Max := aTotal;
  ProgressBar1.Position := aTransferred;
  Label1.Caption := Format('%s: %d / %d bytes',
    [aFilename, aTransferred, aTotal]);
  // Set Cancel := True to abort the transfer
  Cancel := FUserCancelled;
end;

Configurazione degli algoritmi crittografici

Il componente supporta standard crittografici moderni. I default sono sicuri, ma puoi personalizzare la negoziazione degli algoritmi per requisiti di compliance o di interoperabilità.

Categoria Algoritmi supportati
Scambio chiavi Curve25519, ECDH (P-256, P-384, P-521), DH Group14/16
Host key Ed25519, ECDSA (P-256, P-384, P-521), RSA (SHA2-256, SHA2-512)
Cifrari AES-256/192/128-CTR, AES-256/128-GCM
MAC HMAC-SHA2-256, HMAC-SHA2-512, HMAC-SHA1
// Restrict to only the strongest algorithms
oSFTP.Algorithms.Ciphers := 'aes256-gcm@openssh.com'
		,aes256-ctr';
oSFTP.Algorithms.KexAlgorithms := 'curve25519-sha256';
oSFTP.Algorithms.MACs := 'hmac-sha2-256,hmac-sha2-512';

Esempio completo

Un esempio pronto per la produzione che si connette con autenticazione a chiave pubblica, elenca una directory, scarica un file con tracciamento del progresso e gestisce gli errori.

uses
  IdSFTPClient, IdSSHClasses;
var
  oSFTP: TIdSFTPClient;
  oItems: TIdSFTPDirectoryItems;
  i: Integer;
begin
  oSFTP := TIdSFTPClient.Create(nil);
  Try
    // Connection
    oSFTP.Host := 'sftp.example.com';
    oSFTP.Port := 22;
    // Public key authentication
    oSFTP.Authentication.Username := 'deploy';
    oSFTP.Authentication.PrivateKeyFile := 'C:\keys\id_ed25519';
    // Events
    oSFTP.OnSFTPProgress := OnProgress;
    oSFTP.OnSFTPError := OnError;
    oSFTP.OnSSHHostKey := OnHostKey;
    // Connect
    oSFTP.Connect;
    // List remote directory
    oItems := oSFTP.ListDirectory('/data');
    for i := 0 to Length(oItems) - 1 do
      WriteLn(oItems[i].Filename);
    // Download file with progress
    oSFTP.Get('/data/backup.tar.gz', 'C:\backups\backup.tar.gz');
    // Disconnect
    oSFTP.Disconnect;
  Finally
    oSFTP.Free;
  End;
end;

Riferimento dei metodi

Metodo Descrizione
GetScarica un file in un percorso locale o in un TStream
PutCarica un file da un percorso locale o da un TStream
DeleteElimina un file remoto
RenameRinomina o sposta un file remoto
ListDirectoryElenca i contenuti di una directory con i metadati
MakeDirectoryCrea una directory remota
Stat / LStatOttiene gli attributi del file (con/senza risoluzione dei symlink)
FileExists / DirectoryExistsVerifica se un file o una directory esistono
Symlink / ReadLinkCrea o legge symbolic link
GetFileAsString / PutFileFromStringMetodi di convenienza basati su stringhe