Open Source File Transfer
SOSFTP
Table of Contents
n
Introduction to Managed File Transfer
n
Gaps
n
Solutions
Architecture and Components
n
Architecture and Components
n
SOSFTP Client
n
SOSFTP Server
n
Transfer History
n
Web GUI
n
Reporting Component
Gaps and Solutions
Gaps of individual scripts
n The implementation with individual file transfer shell scripts is quite often platform-dependent and error-prone, this means most of the time there is no sufficient proof that a file transfer has definitely been successful.
Solutions provided by SOSFTP
n Using a standard implementation (Java) for all server platforms with no additional requirements for the installation.
n Error recognition and error handling.
Gaps of individual Scripts and Solutions (1/2)
n In most cases there is no error handling, e.g. no repeating of the file transfer in case of failure. n Implementing with individual shell scripts means
that it is required for the configuration to be organized individually. The change of a protocol, e.g. from FTP to SFTP requires a new
implementation each time.
n No data integrity checking after successful file transfer.
n No support for advanced regular expressions
n Support jump transfers, this means using servers as intermediary in the DMZ.
n Support of protocols FTP, FTP/S, SFTP (public / private key).
n Batch processing via command line and configuration file.
Gaps and Solutions
Gaps of individual scripts
n Hard to maintain host/source credentials or other parameters required for file transfer.
n No implicit mechanism to ensure successful transfer of a group of files.
Solutions provided by SOSFTP
n All the settings required for file transfer i.e. host name/username etc. can be grouped in one profile and stored in SOSFTP client’s configuration file. n One profile can be used for send/receive by multiple
file transfer operations.
Gaps of individual Scripts and Solutions (2/2)
Software- und Organisations-Service GmbH www.sos-berlin.com
n No implicit mechanism to specify secondary
host/login credentials should an FTP server not be accessible or in case of any other FTP login
related errors.
n Development/Testing/Debugging of new/changed FTP script takes a lot of time, no way to ensure everything will work in production other then actually transferring files.
file transfer operations.
n Ensure atomic transfer i.e. the transfer will only be considered successful if all the files in a group are successfully transferred, in the event of failure in transfer of any one of the files from a group the whole transfer will be “rolled back” and will be considered as unsuccessful.
Gaps and Solutions
Logging Gaps and Solutions
Logging Gaps
n Protocols are not standardized.
n Protocol files are not intuitively understood. n Protocols of shell scripts do not show an error
state explicitly.
Solutions provided by SOSFTP
n Protocols are standardized with a structured and configurable format.
n A file transfer history for all transfers is created and optionally stored in a central file transfer history in text files or databases.
state explicitly.
n Conventional FTP batch script’s error messages don’t point at the exact cause of the error and often some error message doesn’t break the flow of the batch script, resulting in undetected
unsuccessful file transfers.
n Hard to comprehend/debug logs generated by FTP scripts, often FTP log messages are written
together with batch job’s log.
in text files or databases.
n Automatic alerting in case of errors.
Gaps and Solutions
Reporting Gaps and Solutions
Reporting Gaps
n No information about received or sent files is centrally available.
n No analysis is possible concerning the error
occurrence of transfers that have been undertaken with shell scripts.
Solutions provided by SOSFTP
n A centrally available GUI is used in order to monitor and to analyse the file transfers. The Web GUI allows to search the complete file transfer history. n Automatic generation and mailing of file transfer
history reports, configurable KPI reports.
Software- und Organisations-Service GmbH www.sos-berlin.com
with shell scripts.
n No compliance reporting is available, e.g. a daily or weekly reports that show frequency and date of the transferred files.
history reports, configurable KPI reports.
n Individual reports can be created with a standard report generator by querying the transfer history database.
n Highly customizable reporting capability (using other open source tools) provides enhanced IT auditing and service level compliance auditing.
n Greater vigilance on critical enterprise data exchange through file transfer operations.
Gaps and Solutions
Automation Gaps and Solutions
Automation Gaps
n Conventional FTP scripts can be automated with cron tab/OS’s scheduler/third party job schedulers. n Only time based execution of FTP scripts is
possible with cron tab/OS’s native job scheduler.
Solutions provided by SOSFTP
n Seamless integration of SOSFTP with Open Source Job Scheduler provides End-to-End automation of file transfer operation and file processing. (SOSFTP and Open Source Job Scheduler are provided by the same software vendor).
n Conventional FTP scripts lack in event based and more advanced file handling operation i.e. start of FTP operation on arrival of specific files in a target directory.
n Hard to program event based /conditional file transfer operation in shell scripts.
n Event /time based pre/post file transfer processing. n Event/time driven file transfer operation.
n Event/time based polling of FTP server/directories for specific files (parameterised polling time and interval) n Directory monitoring for files matching with regular
expressions.
Icons used on these pages
Works with all supported platforms Works with all supported platforms and Java
supported platforms supported platforms Managed Job DB Jobs
Managed Jobs are stored in a database
Job
Any platform of your choice applicable any platform supported database any database
Works with all supported databases Any database of your choice applicable
Javascript is required for Ajax GUI
Overview: Architecture and Components
n
Supported Platforms
n
Components
Supported Platforms
Supported Operating Systems
n
Windows 2000, 2003, XP, Vista, 7
n
Linux starting with kernel 2.4
n
Solaris 8, 9, 10 (Sparc, x86)
Supported Databases
n
DB2 8.x, 9.x
n
Oracle 8.1.7, 9.x, 10.x, 11.x
n
SQL Server 2000, 2005, 2008
n
Solaris 8, 9, 10 (Sparc, x86)
n
HP-UX 11 (PA-RISC, IA-64)
n
IBM AIX 5.3
n
Potentially all platforms with Java
n
SQL Server 2000, 2005, 2008
n
Sybase ASE 15
n
MySQL 4.1, 5.x
n
PostgreSQL 8.x
Components
n
SOSFTP Client
- manages file transfers
- can be used standalone and in combination with the SOSFTP Server components
n
SOSFTP Server
- imports transfer history data of the SOSFTP Clients into a central database
- provides alerting in case of file transfer errors
n
SOSFTP Server Web GUI
- enables monitoring of file transfers
- allows to search the file transfer history
n
SOSFTP Server Reporting
Architecture
SOSFTP Web GUI
File Transfer History Database
SOSFTP Server
n Web interface to access the filer transfer history
n Import n Alerting n Reporting Alerting via network monitor supported database any platform any platform supported platforms Browser
the filer transfer history n Access file transfer logs
n Reporting
Import of file transfer history from the SOSFTP Client into the file transfer database
Send reports to clients and operations centre supported platforms supported platforms supported platforms
operated for any server SOSFTP Client
operated for any server operated for any server
SOSFTP Client
operated for any server operated for any server
Overview: SOSFTP Client Component
n
Command Line Interface
n
Prerequisites and Standard Features
n
Advanced Features
n
Standard File Transfer
n
File Transfer with a Jump Host
SOSFTP Client for File Transfer
Client Command Line Interface
Client command script
create log output (mandatory)
SOSFTP Client
Transfer Log Usage sample of the SOSFTP Client command line interface:
sosftp.sh -settings=ftp_settings.ini -profile=to_customer -operation=send
Software- und Organisations-Service GmbH www.sos-berlin.com
Client command script Unix: sosftp.sh Windows:sosftp.cmd Java command java –classpath … sos.net.SOSFTPCommand -settings=ftp_settings.ini -profile=to_customer -operation=send
Configuration file with permanent settings: ftp_settings.ini
This file contains the transfer parameters and is structured into separate profiles.
example profile: [to_customer] protocol = ftp host = hostname user = sos password = sos transfer_mode = binary file_spec = ^.*$ local_dir = /home/sos/sosftp remote_dir = /remote/sosftp
Provided Java Archive Files
create transfer history (optionally)
send message with transfer history data (optionally)
SOSFTP Client Features for File Transfer
Prerequisites
System Requirements
n The only installation prerequisite is a Java Runtime Environment starting from version 1.4. n The client can be used standalone without any server component.
SOSFTP Client Features for File Transfer
Standard Features
n Send and receive files by FTP to/from some target host. n Send and receive files by SFTP to/from some target host. n Execute commands by SSH on some host.
n Send files by FTP or SFTP to a jump host and forward them by FTP or SFTP to a target host.
Different transfer protocols can be used between local host and jump host and between jump host and target host.
Common Features
Different transfer protocols can be used between local host and jump host and between jump host and target host. n Receive files from a remote host by FTP or SFTP to a jump host and forward them by FTP or SFTP to the
local host. Different protocols can be used for transfer between the hosts. n Both password and public key authentication are supported for SFTP.
n The parameterization is effected by command line parameters and by configuration files.
n All parameters are specified on the local host exclusively, this applies in the same way when using a jump host as local parameters are dynamically forwarded to the jump host.
n Logging and error handling are provided, errors are detected on a per file basis.
SOSFTP Client Features for File Transfer
Advanced Features
n Transfer of partially matched files n Recursive transfer of files in directories n Atomic Transfer
n Transactional Behavior
n Check transferred files for completeness (data integrity checking )
More Featues
n Check transferred files for completeness (data integrity checking ) n Handling of empty files
n Renaming of files
n Use of alternative access data and credentials n Support for UNC paths in target directories n Track record of file transfers
SOSFTP Client for File Transfer
Standard File Transfer: send and receive
Local Host
TCP/IP network
Remote Host Send files to the FTP / SFTP server at the remote host
Software- und Organisations-Service GmbH www.sos-berlin.com
SOSFTP Client
FTP / SFTP Server
SOSFTP Client with Jump Hosts
File Transfer with a Jump Host: send
Demilitarized Zone (DMZ) Customer Host Local Host SOSFTP Client Intranet Internet DMZ Server Jump Host FTP / SFTP Firewall Firewall SOSFTP Client FTP / SFTP Server files The SOSFTP client at the
jump host does not contain any configuration items. It gains its configuration from the first step
The configuration parameters for step 2 are being sent additionally files Step 1:
copy files from local host to jump host
Step 2:
SOSFTP Client with Jump Hosts
File Transfer with a Jump Host: receive
Step 3:
The SOSFTP client at the jump host forwards the files to the originating local host. Demilitarized Zone (DMZ) Customer Host Intranet Internet FTP / SFTP Firewall Firewall Jump Host files Local Host SOSFTP Client
Software- und Organisations-Service GmbH www.sos-berlin.com
FTP / SFTP Server
files The configuration
parameters for step 2 are being sent additionally
SOSFTP Client
The SOSFTP client at the jump host does not contain any configuration items. It gains its configuration from the first step.
Step 1:
send the command to receive files to the SOSFTP client at the jump host
Step 2:
SOSFTP Client Features with Jump Hosts
Advanced Features with a Jump Host
Why use a Jump Host?
n A jump host is located in the DMZ, therefore it can access servers at customer sites via the internet. Local servers quite often are excluded from internet access for security concerns.
n Jump hosts are used in order to store files temporarily and to forward them to the final destination which is either a local server or a server at the customer site depending on the transfer direction.
Security Considerations
.n When operating SOSFTP for a jump host then no configuration data will be stored on that host. Instead, the SOSFTP client hands over its parameterization to the jump host on-the-fly where it is used by an additional SOSFTP client instance.
Overview: SOSFTP Server Components
n
Architecture and Components
n
File Transfer History
n
Web GUI
Software- und Organisations-Service GmbH www.sos-berlin.com
SOSFTP Server Components
Architecture and Components
Intranet
SOSFTP Web GUI
File Transfer SOSFTP Server supported database any any platform supported platforms File Transfer History Database
n Web interface to access the filer transfer history n Access file transfer logs
n Import n Alerting n Reporting
Import of file transfer history from the SOSFTP Clients into the file transfer database
Alerting via network monitor
Send reports to clients and operations centre any
platform
platforms
Overview: SOSFTP Server – File Transfer
History
n
Architecture and Components
n
Prerequisites
n
Features
SOSFTP Server – File Transfer History
Architecture and Components
Intranet File Transfer SOSFTP Server supported database any platform supported platforms File Transfer History Database n Import n Alerting
Import of file transfer history from the SOSFTP Clients into the file transfer database
SOSFTP Server: File Transfer History
Prerequisites
Connectivity
n SOSFTP Clients are configured to use a UDP port for communication with the SOSFTP Server n SOSFTP Server can access SOSFTP Client hosts by SFTP, SCP or FTP
Automation
n Open Source Job Scheduler (http://jobscheduler.sourceforge.net) for process automation
Software- und Organisations-Service GmbH www.sos-berlin.com
n Open Source Job Scheduler (http://jobscheduler.sourceforge.net) for process automation n Java Runtime Environment starting from version 1.4
SOSFTP Server: File Transfer History
Features
Import
n Import of the file transfer history that is created by SOSFTP Clients into a central database. n Immediate import is effected by online signalling of SOSFTP Clients.
n Fail-safe import by repeated execution in case of connectivity issues between clients and server. n Compliant transfer history of all incoming and outgoing file transfers.
n Integration with the Open Source Job Scheduler (http://jobscheduler.sourceforge.net) n Integration with the Open Source Job Scheduler (http://jobscheduler.sourceforge.net)
for process automation created by the same software vendor.
Alerting
n Notifications on errors and warnings in any file transfers are sent by mail. n A solution stack with Nagios is available.
Overview: SOSFTP Server - Web GUI
n
Architecture and Components
n
Prerequisites and Features
n
Sample Screenshot
SOSFTP Server - Web GUI
Architecture and Components
Intranet Web Server
SOSFTP Web GUI
File Transfer History Database
n Web interface to access the File Transfer History n Access file transfer logs
SOSFTP Server - Web GUI
Prerequisites
n Web server (Apache, IIS etc.) with PHP starting from version 5.x. n PHP database extension for file transfer history database.
n SOSFTP Server component that feeds the file transfer history database.
Prerequisites and Features
Features
n Centralized view of each and every file transfer operation in the system. n Monitoring of incoming and outgoing transfers.
n A traffic light signals errors and warnings of current transfers.
n Detailed information on each transfer as hosts, direction, files and error messages. n Search options for the file transfer history.
n Grouping of file transfers per date, host, file, result etc.
SOSFTP Server - Web GUI
Overview: SOSFTP Server - Reporting
n
Generating and Mailing Reports
n
Reporting Features
n
Solution Stacks
Software- und Organisations-Service GmbH www.sos-berlin.com
SOSFTP Server - Reporting
Reporting Features
Report Design
n Reports can be designed for multiple formats such as HTML, PDF, XLS etc.
n Reports can be customized at your convenience. This includes the layout, the level of detail and the period that is covered by the report.
n Reports are based on three components: a database query, a report layout and a report job. n All report handling is automated by Job Scheduler.
n All report handling is automated by Job Scheduler.
n Default reports are provided for a daily and monthly overview of file transfers.
Report Handling
SOSFTP Server - Reporting
Generating and Mailing Reports
Server Components supported database any platform Transfer Job: Import of Transfer History
Software- und Organisations-Service GmbH www.sos-berlin.com
Generate report Mail reports
to recipients Access transfer history
n Reports are created from the transfer history database
n Report generation is implemented as job in the Job Scheduler
supported platforms
n Run time components for report generation are provided as Java classes
n The Design time component for reports is provided as Java desktop application
Transfer History Database
SOSFTP Server - Reporting
Solution Stacks
Report Generation
n For report generation a solution stack is available that includes Open Source components with compatible licenses.
n Reports are implemented with the Open Source software JasperReports
(http://www.jasperforge.org) that provides the runtime environment and the design component.
Report Automation
n Processing of reports is automated by the Open Source Job Scheduler (http://jobscheduler.sourceforge.net)
