Übersicht
Mit dem SFTPSenderService können verarbeitete Nachrichten auf einem SFTP Server abgelegt werden. Dieser Service ist ausschließlich für eine gesicherte SFTP-Verbindung vorgesehen. Im Folgendem wird die Konfiguration dieses Services beschrieben. Hier werden nur die Inhalte genannt, die im Standard Customizing vorhanden sind. Bei speziellen Customizings können die Bezeichnungen variieren und vom Standard abweichen. Für eine Ausgabe auf einem FTP-Server kann dieser Service genutzt werden.
Technische Beschreibung
Klassenpfad org.b2bbp.services.outbound.sftp.SFTPSenderService
Einrichtung
In der Administration wird der SFTPService, wie in dem folgenden Screenshot einzusehen, als passiver Dienst angelegt.
Einstellungsmöglichkeiten
Pflichtwerte
| Eigenschaft | Beispielwert | Erklärung |
|---|---|---|
| SFTP_SERVER | 127.0.0.1 | Name oder IP-Adresse des SFTP-Servers |
| SFTP_USER | Testuser | Name des anzumeldenden Benutzers |
Authentifizierung
Es wird entweder die Konfiguration für Passwort oder per Zertifikaten vorausgesetzt.
| Eigenschaft | Beispielwert | Erklärung |
|---|---|---|
| SFTP_PASSWORD | pVX5VxHrAKLLoqXMMuslrg== | B2B-Base64-kodiertes Passwort |
| oder | ||
| SFTP_PRIVATE_KEY | Testprivatkey | Name der Extension, die den privaten Schlüssel beinhaltet |
| SFTP_PUBLIC_KEY | Testpublickey | Name der Extension, die den öffentlichen Schlüssel beinhaltet |
| SFTP_PASSWORD | pVX5VxHrAKLLoqXMMuslrg== | B2B-Base64-kodiertes Passwort für den privaten Schlüssel, falls der private Schlüssel mit einem Passwort verschlüsselt wurde. |
Als Alternative zum Passwort kann die SFTP-Verbindung anhand eines Schlüsselabgleiches stattfinden. Dafür muss der Privatkey als Extension hochgeladen werden und anschließend dessen Namen/Typ in der Serviceeigenschaft „SFTP_PRIVATE_KEY“ hinterlegt werden. Der dazu passende öffentliche Schlüssel wird zum Abschluss ebenfalls als Extension angelegt und bei der Eigenschaft „SFTP_PUBLIC_KEY“ hinterlegt. Falls der private Schlüssel mit einem Passwort verschlüsselt wurde, kann das Passwort in der Eigenschaft SFTP_PASSWORD hinterlegt werden.
Der private Schlüssel soll im alten OpenSSH Stil (PEM-kodiert) in der Extension hochgeladen werden. Der Schlüssel fängt mit “-----BEGIN RSA PRIVATE KEY----” an.
Der öffentliche Schlüssel kann im OpenSSH-Format (der Inhalt fängt an mit “ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQ...”) oder SSH2 PEM-kodiert (“---- BEGIN SSH2 PUBLIC KEY ----”) hochgeladen werden.
Optionale Werte
| Eigenschaft | Beispielwert | Erklärung |
|---|---|---|
| SFTP_FOLDER | Outbound | anzusteuernder Exportordner |
| B3P_ENCODING | ISO-8859-1 | gewünschtes Encoding-Format |
| B3P_RETRY_COUNT | 10 | Anzahl der Versuche eine Verbindung zum SFTP-Server aufzubauen |
| B3P_DELAY_SECONDS | 10 | Zeit zwischen den einzelnen Verbindungsversuchen in Sekunden |
| SFTP_PORT | 22 | der Port, auf dem der SFTP Server läuft (22 ist hier der default) |
| SFTP_TIMEOUT | 60000 | Session Timeout (Zeit in Millisekunden) |
| SFTP_AUTH_METHODS | publickey,password | Mit dieser Eigenschaft kann konfiguriert werden, in welcher Reihenfolge der SFTPSenderService die Authentifizierungsmethoden anwendet. Die Methoden sind als Komma-separierte Liste ohne Leerzeichen anzugeben. Beispiel: “publickey,password”. Der Service versucht die Verbindung unter Zuhilfenahme der ersten Authentifizierungsmethode aufzubauen. Falls diese Methode nicht unterstützt wird, wird die nächste Methode in der Liste angewendet. Aktuell ist es allerdings nicht möglich, am Service Credentials für beide Methoden gleichzeitig zu konfigurieren |
Optionale Proxy Konfiguration
In bestimmten Systemkonstellationen muss ein Proxy für den Zugang zum Zielhost eingetragen werden. Für die Entkoppelung der einzelnen Service wird der Global Propertie Eintrag B3P_PROXY_SERVER nicht verwendet. Die Proxy Konfiguration erfolgt direkt am SFTPSenderService.
| Eigenschaft | Beispielwert | Erklärung |
|---|---|---|
| PROXY_TYPE | HTTP|SOCKS4|SOCKS5 | Typ des eingesetzen Proxy |
| PROXY_HOST | proxy.intern | 172.0.0.0 | Hostname oder IP des Proxy |
| PROXY_PORT | 9000 | Port des Proxy |
| PROXY_USER | user | Optional Proxy User |
| PROXY_PASSWORD | password== | Optional B2B-Base64-kodiertes Passwort |
Weitere Einrichtung
Für den passiven Dienst muss ebenfalls eine Action angelegt werden.
Einstellungen
| Eigenschaft | Nachrichten Kontext | Erklärung |
| B3P_FILE_NAME | Zur Laufzeit überschreiben | auszugebener Dateiname |
| B3P_USED_SERVICE_ID | Zur Laufzeit überschreiben | Verweis auf die Service-ID |
Die angelegte Action muss noch dem relevanten Channel zugewiesen werden („Execute Action“ muss aktiviert werden).
Schlüsselpaar umwandeln
Wenn Sie ein PuTTY-Schlüsselpaar im Dateiformat .ppk haben, können Sie es in das OpenSSH-Format umwandeln. Dafür benötigen Sie das Tool puttygen.exe, das zusammen mit PuTTY installiert wird.
- PuTTYgen starten.
- File → load private key → privatekey.ppk wählen. Password eingeben
- Conversions → Export OpenSSH key → speichern unter privkey_rsa.pem
- Save public key → speichern unter pubkey_rsa.pub
