secureclient 5.6 usersguide all enu

U S E R S G U I D E

SecureClientVersion 5.6

August 2010

DUG0000SC560

Copyright Axway Software, 2010.

All rights reserved.

This documentation describes the following Axway software: SecureClient.

No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway Software.

This documentation, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this documentation may not necessarily accurately represent or reflect the current or planned functionalities of this product. Axway Soft-ware may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this documen-tation. Axway Software does not warrant that this documentation is error free.

Axway Software recognizes the rights of the holders of all trademarks used in its publications.

iii v

Chapter 1 - Axway SecureClient overview 1Axway SecureClient Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Authentication, Certificates, and Fingerprints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Connections and Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Supported FTP Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Supported HTTP Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Supported SFTP Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Supported SSL/TLS Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2 - Scheduler 7Using the Rescuer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter 3 - Jobs 9Job States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Periodic Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 4 - Transferring Files 11Scheduling a Transfer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Transferring Files from the Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 5 - Main Window 15Local and Remote View Window Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Local View pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Remote View pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Monitoring pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Log Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Schedule Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 6 - Site Manager 19Site Details Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Site Manager General Parameters Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Protocol-specific parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21FTP-specific Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21HTTP-specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25SFTP-specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Gateway parameters tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Security Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

SecureTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Outgoing local ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27X.509 and SSL parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28SSH Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Notification parameters tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Enable Email notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Sender/Receiver Recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Notification Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

SECURE CLIENT 5.6 USERS GUIDE

vi SecureClient

Charset Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Server charset encoding for filenames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Pre/Post Actions Parameter Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Transfer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Post Transfer Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 7 - Security Manager Window 33Viewing Certificate or Key Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Importing a Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Importing a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Deleting a Certificate or Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Generating a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Exporting a Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapter 8 - Setting Axway SecureClient Preferences 39Anonymous Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Email Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Editing Text File Pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Transfer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Graphical Interface Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Date Format Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Security Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Working with Proxy Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Proxy Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Editing a Proxy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Adding a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Duplicating a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Deleting a Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Log Maintenance Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Scheduler Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50SecureTransport Compatibility Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Chapter 9 - Exiting SecureClient 53

Chapter 10 - Batch Mode 55Script File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Script File Example 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Script File Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Chapter 11 - Command List 57cdup Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

chdir command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

iii vii

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60close Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

delete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

echo Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

get Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

jobsubmit Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

lcdup Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

lchdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

ldelete Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

list Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

llist Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

lmkdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70


viii SecureClient

Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71lpwd Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

lrename Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

lrmdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

mget Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

mkdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

mput Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

newjob Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

open Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Important security note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

output Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

put Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

pwd Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

quote Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

iii ix

Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

rename Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

rmdir Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

script Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

setdateformat Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Chapter 12 - SecureTransport Client Legacy Mode 87Command-line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Reserved Characters for URLs or Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Examples of Command-line commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93ST Client batch file samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Sample batch file to verify file transfer status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Sample batch file to perform multiple file transfers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Chapter 13 - Exit Codes 97

Chapter 14 - Authentication 99X.509 Certificate Authenthication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99SSH Key-based Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100

Chapter 15 - Exit Classes 101SSLSessionListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101SSLPeerAuthListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101SSLUserAuthListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102

Chapter 16 - Administration using the command line 103Exit codes and error management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103Additional command line options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104Site Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Short Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Add new site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106List sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Display site info. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107


x SecureClient

Delete a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Change password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107

Full Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Add new site(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107Update a site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108

Site File Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Certificate Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111

Add new certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111List certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Display certificate info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Delete a certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Job Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112List jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Display job information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Cancel a job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Purge jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Log Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113Archive logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

General Administration Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114Manage license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Manage scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Force status to stopped state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

1

1 Axway SecureClientoverviewAxway SecureClient is a secured FTP, HTTP, and SFTP client designed to operate with Synchrony Gateway, SecureTransport, or any standard FTP server. Axway SecureClient runs as a stand-alone application or as a background task. Axway SecureClient works with SecureTransport to guarantee data delivery and data integrity while protecting corporate bandwidth. The Auto Restart feature automatically re-establishes broken connections and resumes transfers from the point where the transfer stopped.

Synchrony Gateway and SecureTransport offer many additional features compared to standard FTP servers. Using special FTP commands or HTTP header parameters, you can:

Route file transfers

Modify the file structure dynamically

Associate a message with the file

Signal that the final application has received and processed the file.

Synchrony Gateway can configure the Axway SecureClient client to define the information to be sent by the FTP LIST command. Furthermore, Synchrony Gateway enables you to filter files by name, date, and state.

The Scheduler is a component that runs as a Java program and functions as a background task. It enables you to manage transfers synchronously or asyn-chronously. You can program the transfer start time and date as required. You can use the GUI or the batch mode, either to make synchronous transfers (inter-active mode) or to submit a job to the Scheduler.

You can use Axway SecureClient interactively using the GUI (Graphic User Interface) or in batch mode to automate file transfers and directory manage-ment. Similarly, you can perform product administration tasks using either the GUI or command line.

Axway SecureClient manages its own X.509 certificate database. However, it is possible to use certificates from an external system.

Axway SecureClient runs as a Java application using Java SE 6 that uses the Cryptix cryptographic provider, which is part of the installation package (refer to the Cryptix General License). However, Axway SecureClient is compliant

../../../Content/untranslated/licencecryptix.html

AXWAY SECURECLIENT OVERVIEWAXWAY SECURECLIENT CONCEPTS

2

with JCE1.5.0, so any other cryptographic provider can be added, and it will be chosen dynamically.

Additional Axway SecureClient features include:

Support for email notificationsAxway SecureClient sends emails when a file transfer has completed and notifies you of the success or failure of the transfer.

Support for Tunnel Modeprovides a firewall-friendly mode that allows you to connect securely through a firewall or proxy server

Support for MD5 checksums that guarantee a secure delivery

Support for pausing and resuming file transfers

Support for post transfer actions using external programs for file down-loads

Axway SecureClient Concepts

This section describes some of the terms and concepts necessary to understand Axway SecureClient.

Authentication, Certificates, and Fingerprints

Both FTP and HTTP protocols define a simple authentication method , where you give a user name and a password to the server. However, Axway Secure-Client supports SSH key-based authentication for SFTP protocol, and X.509 certificate authentication for FTP and HTTP protocols. Anonymous authenti-cation is supported by all protocols (HTTP, FTP, and SFTP) Additionally, CGI authentication is available for HTTP protocol on a Gateway server.

An X.509 certificate identifies an entity and employs mechanisms, including public keys and fingerprints, that guarantee that data signed by an entity really comes from that entity. A fingerprint is a short sequence of bytes used to authenticate a public key. Because fingerprints are generally shorter than public keys, they are helpful when managing public keys.

SSH key-based authentication identifies an entity based on a pair of matching keys: a public key stored on the remote server and a private key stored on the users machine. During authentication, the remote server compares private and public keys, and if the keys match, the user is authenticated.

AXWAY SECURECLIENT OVERVIEWAXWAY SECURECLIENT CONCEPTS

3

The SSH File Transfer Protocol (SFTP) provides encrypted file transfer and some file-system operations. SFTP uses either password or SSH key-based authentication.

Two types of authentication are possible in standard SSL: simple authentication, where only the client/user gets authenticated, and reciprocal authentication, where both sides are authenticated. Axway adds dual authentication, which requires username, password, and certificate. Dual authentication is supported only for SSL. It is not available for SSH.

NOTE: If the server does not require user authentication, it is possible to accept the connection regardless of the identity of the server. For more information, see the Supported SSL/TLS features section.

Connections and Sessions

FTP and HTTP can be secured with SSL or TLS (see the Security section). SFTP relies on SSH and is thus always secured. A session, or a connection, can be any of the following:

FTP

HTTP

FTP over SSL (or FTPS)

HTTP over SSL (or HTTPS)

FTP-TLS

HTTP-TLS

SFTP

Axway SecureClient supports multiple sessions with one or more servers at a time. Managing several sessions with one server allows you to transfer several files at the same time. While the files are being transferred, you can continue to send requests.

Security

Security, with SSL or TLS, has several mechanisms: authentication, ciphering, and sealing. When establishing a new SSL connection, a negotiation phase, called a handshake, is launched. The authentication is performed during this step. This is also the moment that security parameters are set, and secret random data is exchanged. These pieces of information guarantee that the entity

AXWAY SECURECLIENT OVERVIEWFEATURES

4

that has been authenticated during the handshake is the only one able to exchange information with Axway SecureClient during the session.

At the end of the handshake, the session is secured: information is ciphered (if it was so negotiated) and sealed. Sealing is a mechanism that ensures the integ-rity of received data: the data received is identical to the data that was sent, and it arrives in the same order.

An FTP or HTTP session is said to be secured when it relies on an underlying SSL or TLS layer, authenticating both peers, and ciphering and sealing data. For further technical details on supported mechanisms, see the Features section.

NOTE: You cannot consider the fact that the line is secured as a true/false state-ment. An SSL session can authenticate or not, cipher or not. If ciphering is performed, an SSL session can use 40, 64, 128, or 254 bits of entropy to generate a secret key. As the TLS specification states: "The TLS protocol is secured, in that any cipher suite offers its promised level of security: if you negotiate 3DES with a 1024 bit RSA key exchange with a host whose certificate has been verified, you can expect to be that secured. However, you should never send data over a link with 40 bit security unless you feel that data is worth no more than the effort required to break that encryption".

Site

A Site is an object that groups the server connection parameters. Note that a Site is not necessarily a machine: one machine can have several servers, and even one server can have several configurations on several ports, according to the identity of the client user. Thus, you can decide to set several Sites for one server, and even for one remote port, so that several FTP, HTTP, SFTP, or SSL identities can be managed.

Features

Axway SecureClient allows file transfers in standard FTP, HTTP, and SFTP, or over SSL V3.0 and TLS V1.0 with SecureTransport, Synchrony Gateway, and standard FTP servers.


5

Supported FTP Features

Axway SecureClient supports the following FTP features:

Active and passive data connection modes. Secured active mode is imple-mented as defined in RFC 2228.

Implicit and explicit securing mode. Explicit securing mode is performed using the FTP command AUTH TLS-P or the commands AUTH TLS + PROT P, as defined in RFC 2228 and RFC 4217.

Transfer resumes when the server supports this feature.

A special option is added to support non-RFC-compliant PASV and PORT commands: the SSL negotiation of the data connection begins after RETR, STOR, STOU, or LIST, and not after the PASV or PORT command.

MD5 file integrity validation when the server also supports this feature (SecureTransport)

Supported HTTP Features

Axway SecureClient supports the following HTTP features:

File download (GET method)

File upload (PUT method)

Transfer resumes when the server supports this feature

Secured with SSL/TLS

Directory browsing when using any of the following servers:

Synchrony Gateway

SecureTransport

Apache version 1.3 or later

Microsoft IIS

MD5 file integrity validation when the server also supports this feature (SecureTransport)

Text mode

NOTE: To enable Axway SecureClient to function with Synchrony Gateway using HTTP, you must configure Synchrony Gateway to use the correct template file for


6

Directory Listing. You can find the template file in /extras/HttpListTemplate.txt.

Supported SFTP Features

File download (GET method)

File upload (PUT method)

Directory browsing

Supported SSL/TLS Features

Axway SecureClient supports SSL version 3.0 and TLS version 1.0. In particular, the following features of SSL and TLS are supported:

RSA cipher suites. XFB-specific anonymous RSA cipher suites are included. In this mode, no authentication is performed, so no X.509 certif-icate is required.

Simple and reciprocal authentication

Session cache

Empty certificate_lists in certificate_request messages. If such a message is received, it means that the server accepts any root authority.

7

2 SchedulerThe Axway SecureClient Scheduler enables you to manage transfers asynchro-nously. You can program the transfer start time and date as required. You can use the GUI or the batch mode, either to make synchronous transfers (interac-tive mode) or to submit a job to the Scheduler. Additionally, you can use the Scheduler to program Periodic jobs.

Both the GUI and the batch mode communicate with the Scheduler using Java RMI (Remote Method Invocation). If the RMI Registry process does not exist, it is created automatically. The Scheduler is only available through the loopback address (127.0.0.1). No modification or configuration of the JRE environment is needed.

Using the Rescuer

If the Scheduler fails to start within 30 seconds, the Rescuer will pop up, showing a failure message and providing you with three choices:

Change the portChanges the port where the Scheduler is listening.

Reset scheduler statusResets the state of the Scheduler and nothing more. This will not stop a running process.

AbortAborts the the start-up procedure.

If you select either of the first two choices, the corresponding action will be trig-gered and SecureClient will try to start the Scheduler again.

SCHEDULERUSING THE RESCUER

8

9

3 JobsA job is a sequence of commands that are executed on one, and only one, server. Commands within a job cannot run on more than one server. You can use the following commands in a job:

Send a file (upload)

Receive a file (download)

Multiple file send (upload)

Multiple receive (download)

The commands in a job are ordered and the number of commands is not limited. This means that you can use a job to transfer a whole tree structure.

Job States

A job has the following possible states:

To BeginThe job is waiting, either because its start date is in the future, or because there are already too many jobs in progress for the same site.

Transferring The job is in process. If a network or other failure occurs, the state will change to Interrupted until further attempts at connection and transfer are made.

InterruptedThe job has stopped for a temporary reason. Axway SecureClient will try to finish the job.

Finished The job was completely executed.

JOBSPERIODIC JOBS

10

CanceledThe job was canceled manually.

AbortedThe job was canceled automatically, for example if an error appears to be permanent (maximum number of connection or transfer retries has been reached, authentication failure, and so on). Jobs in this state can be resub-mitted, at which point a new job with the same parameters is created.

Paused A job paused can be resumed if it was running on a server that supports resuming transfers. Otherwise, a paused job will start from the beginning on Resume.

Explore File (xx.x%)Intermediate state appears when computation of the MD5 checksum of the local or the received file is in progress.

Requesting MD5Intermediate state appears when checking md5 on the server or when comparing md5 for the local and remote site (SecureTransport only).

Waiting Server ACKIntermediate state indicates that check for correctness of the uploaded file segment is in progress (SecureTransport HTTP only).

Periodic Jobs

You can use the periodic job function of the Scheduler to trigger a job at regular, predefined times. For example, you can schedule to transfer a file each Friday at 6:00 p.m., at midnight every weekday, or on the first day of each month. The minimum interval between jobs is 1 minute.

The required period and frequency are defined using the UNIX crontab syntax.

A job is executed when the time and date specification fields match the current time and date.

Use either the GUI or batch mode to define timing information for periodic jobs.

11

4 Transferring FilesYou can transfer files by using the Transfer Windows or by scheduling a transfer.

Scheduling a Transfer

You can schedule a transfer to occur immediately or at some time in the future. In addition, you can specify that the transfer recur at regular intervals.

TASK

1. From the Axway SecureClient Main Window, select Tools - Schedule Transfer. STEP RESULT: The New Schedule window appears.

2. (Optional) Specify a Name and Description for your transfer.

3. In the Type area, select the appropriate radio button to Send files or Get files with this transfer.

4. In the What area, specify the files you want to transfer. Use the first row in the table to enter information about files to be transferred.a If you specify that this transfer is a GET operation, select a remote server

from the Get files from drop down list.b In the Files or folders column, specify the path and filename of the file

you want to transfer or click Browse to navigate to the file to be trans-ferred.

c Select a file format for the transfer. Choose from Auto, Text, or Binary. If you choose Auto, Axway SecureClient will use text mode if it recog-nizes a text file, which depends on file name extensions configured in

TRANSFERRING FILESSCHEDULING A TRANSFER

12

Axway SecureClient preferences. If Axway SecureClient does not recog-nize the file format, it uses binary mode.

d (Optional) If you selected a folder to be transferred, you can select a Folder filter. Selecting a folder filter will allow only files in the selected folder that meet the filter criteria to be transferred.

e Select Copy or Move from the Transfer type drop down menu.f When you finish specifying your files, click Add to add your file specifi-

cation to the transfer.

RESULT: Your file specification appears in the next available row in the table. You can add multiple file specifications in the Schedule Transfer table.

5. In the Folder field of the Where area, enter or browse for the path where you want files transferred.a If you have specified that this transfer is a SEND operation, select a site

from the Send files to drop down list.

6. In the When area, specify when the transfer should occur and whether the transfer should recur. Select one of the following: Now Starts the transfer immediately when you finish specifying

transfer information and click OK. Start Date Enables the Date and Start Time fields. Use these fields to

specify the date and time the transfer should start.

7. In the When area, specify whether the transfer should be recurring and on what basis. Select the Repeat Schedule check box, and then select a value from the drop down list. The value you select determines the set

TRANSFERRING FILESTRANSFERRING FILES FROM THE MAIN WINDOW

13

of parameters you work with to specify recurrence characteristics. Choose from the following: Minutes Specify the number of minutes between transfers. In addi-

tion, you can specify on which days of the week and how many times a day the transfer should occur.

Hourly Specify the number of minutes between transfers. In addition, you can specify on which days of the week the transfer should occur and its beginning and ending times.

Daily Specify the number of days between transfers or whether transfer should occur only on weekdays.

Weekly Specify one or more days of the week on which the transfer should occur.

Monthly Specify a day of the month and how many months between transfers.

Yearly Specify the number of years between transfers.

End dateSpecify never ends or ends at a certain date chosen from the calendar. This property is only available for Repeat Schedule.

8. Click OK.STEP RESULT: Your schedule is submitted and the New schedule window is dismissed.

Transferring Files from the Main Window

In the Main Window, you use the Local and Remote View windows to select files to transfer and to start or schedule transfers.

TASK

1. In the Local View and Remote View windows, specify or browse to the directories you want to be the origin and destination of the transfer

2. In the window displaying the origin directory, right-click a file (or folder) to transfer, and then select one of the following: Transfer selected file(s)The selected file is transferred immediately.

If you are uploading files, it uses the currently opened Remote View.

TRANSFERRING FILESTRANSFERRING FILES FROM THE MAIN WINDOW

14

Transfer parameters are based on the files and folders displayed in the Local and Remote View Windows as well as from the Sites preferences.

Schedule transfer of selected file(s)The New Schedule window appears with fields filled based on the files you selected in the File Transfer window and the time for the transfer set to Now.

You can edit the values in the New Schedule window before you submit the job.

Transfer pattern matching file(s) of current directoryA dialog box appears in which you specify a filter to be used for selecting files to transfer. Specify a pattern and then click OK.

The New Schedule window appears with fields filled based on the files selected by the filter and the time for the transfer set to Now.You can edit the values in the New Schedule window before you submit the job. This is equivalent to the mput and mget batch commands.

Select and TransferSelect the file to be transferred from the origin directory and click on the arrow to transfer it to the destination direc-tory. You can use either the arrows located between the local and remote views or the Transfer button at the bottom of the Main Window.

Drag and DropSelect the file or folder to be transferred from the origin directory and drop it into the destination directory..

ADDITIONAL INFORMATION: When transferring files, you can set the Synchrony Gateway specific parameters Originator,Destination, Application, and Message. On SecureClient, you can set these options for a site from the Gateway tab. For more information, refer to the Synchrony Gateway docu-mentation. If these parameters are set in the site configuration, the set values will be used, but might be overridden here.

15

5 Main WindowYou use the Main Window to access connections, logs, and certificates, and transfer files. This window is made up of the following components:

Connection management area where you can select the remote server that you want to connect to, or you can specify a URL for the remote server that you want to connect to.

Local View and Remote View panes. Each View pane contains a box with the path and file name of the directory, directory navigation buttons, and a listing of the contents of the directory you are browsing. Between the two View panes are the Transfer buttons or arrows.

Monitor pane with two tabs: The Schedule tab where you can view and manipulate scheduled transfers, and the Log tab where you can view log files.

Local and Remote View Window Tools

The toolbars at the top of the Local View and Remote View Windows enable you to navigate through and work in your local and remote directory structures, respectively.

The following buttons are provided:

Parent directory Navigates to the parent directory of the current directory.

Working directoryNavigates back to the directory from which Axway SecureClient was started.

Create directoryCreates a new directory in the current directory.

MAIN WINDOWLOCAL VIEW PANE

16

RefreshUpdates all information in the window.

Local View pane

You use the Local View pane to navigate through the local files to select either the destination directory of an incoming transfer, or the source file or directory of an outgoing transfer. You can browse to a folder on your system and then select the files you want to transfer, or you can select files using the criteria you specify.

Remote View pane

You use the Remote View pane to select either file(s) to download or a destina-tion directory where you intend to upload local file(s).

If the remote server is a Synchrony Gateway, this pane provides a view of trans-fers (available, sent, ended successfully, and so on.). For non-Gateway servers, this window shows the files and folders on the server.

For Synchrony Gateway FTP servers, tools for filtering the remote files are also provided. The lower fields enable you to filter files by name, Local or Transfer ID, or date, as they are seen by the server. Enter a name as a regular expression, a Local or Transfer ID, or date condition between the files proposed, and press Enter. The view will be updated. There is also a General tab in addition to the View and Filter tabs. The General tab represents site common details and infor-mation about the Gateway profile.

With standard FTP servers, you can only enter arguments of the standard FTP LIST command in the File name field.

Finally, you can enter FTP protocol commands through the Send a raw command menu.. The only operation Axway SecureClient performs on this command is to add the CR/LF characters at its end. The server response to this command is displayed in the Log window.

NOTE: You cannot transfer files between two remote views.

MAIN WINDOWMONITORING PANE

17

Monitoring pane

The monitoring pane in the lower part of the main window shows log messages or a list of transfers, depending on the selected tab.

Log Tab

Click the Log tab to view the Log window. The log messages in this window indicate what has been done by Axway SecureClient, the result of each action performed (success or failure), and the cause of possible errors. The three buttons at the left allow you to:

Archive LogArchives the log. The archiving action also cleans the log view. For more information, see the "Log Maintenance Settings" section.

Refresh Scheduler LogRefreshes the currently displayed log.

AutoscrollToggles log message scrolling on and off.

Schedule Tab

Click the Schedule tab to view the Schedule window. Use the drop down menu to control the state of the schedule tab. Choose from the following:

All TransfersView all transfers.

Waiting TransfersView scheduled transfers waiting to be processed.

Running TransfersView transfers currently being processed. You can cancel transfers displayed in this view.

MAIN WINDOWSCHEDULE TAB

18

Finished TransfersView scheduled transfers that have ended. You can purge transfers from this view.

Control PanelAdjacent to the Schedule and Log tabs is a control panel that consists of six buttons:

Except for Resubmit Job, these same options are available when you right click on a job.

Show job detailOpens job details view for the currently selected job.

Cancel Job - Cancels one or more jobs, depending on the selection.

Pause JobPauses one or more jobs, depending on the selection.

Resume JobResumes one or more jobs, depending on the selection.

Resubmit JobResubmits one or more jobs, depending on the selection.

Delete jobDeletes one or more jobs, depending on the selection.

19

6 Site ManagerThe Site Manager window displays a summary view of the Sites contained in the database. To edit, copy, or remove a Site object, select the corresponding row in the Site list, then either right-click or click an action button. Choose from the following options:

NewCreate a new empty Site object with default values.

EditEdit/display detailed parameters for the selected Site. You cannot change the name of the Site in Edit mode. Instead, use the Rename button.

RenameDisplays a dialog box you can use to rename the Site selected.

CopyCreate a new Site object with parameters copied from the selected Site. You must provied a new alias for the Site.

DeleteDelete the selected Site.

HelpDisplays online help for the Site Manager screen.

SITE MANAGERSITE DETAILS WINDOW

20

Site Details Window

You use the Site Details window to manage your individual sites. Each site object defines all the parameters needed to connect to remote servers. These parameters are divided into six categories:

General parameters

Gateway parameters

Security parameters

Notification parameters

Charset parameters

Pre/Post Actions

Site Manager General Parameters Tab

Use the General tab to manage general parameters for the Site. This is where you enter protocol-specific parameters for FTP, HTTP or SFTP.

AliasEnter an alias for this Site. It must be unique, so that when used on the command line as the first parameter, Axway SecureClient will start and connect immediately to the corresponding server without further action.

ProtocolSpecify the protocol to be used with this site. Select FTP, HTTP, or SFTP.

HostEnter the DNS name or the IP address of the remote server to connect to.

PortEnter the IP port number of the server to connect to.Default values:

21 (FTP)

22 (SFTP)

80 (HTTP)

UserEnter the user name to use during login phase with the server.Default value: anonymous.


21

PasswordEnter the password to use during the login phase with the server.

Local directorySpecify a starting directory for the Local view window of the Main window when connecting to this Site. You can click the folder icon to browse.

Remote directorySpecify a starting folder for the Remote view window. This folder will be the home directory on the remote server.

Protocol-specific parameters

See the topics on FTP-, HTTP-, and SFTP-specific parameters for more infor-mation.

FTP-specific Parameters

AccountEnter the name of the account, or the group, to accept login (required by some servers).

Connection modeSpecifies how to establish FTP data connections:

Active: in this mode, the FTP server connects to the client (Axway Secure-Client).

Passive: in this mode, this is the client (Axway SecureClient) that connects to the FTP server. This is the default mode.


22

Server typeSelect the type of server:

Server Type Description Processing Rules

AXWAY (for Synchrony Gateway)

List columns are defined using a specific command. Columns are configured on the server side.

SecureTransport List columns must be compliant with the following rules: Column 1: permissions

string followed by at least one space character.

Column 2: link string followed by at least one space character.

Column 3: owner string followed by at least one space character (also configurable from ST).

Column 4: group string followed by at least one space character (also configurable from ST).

Column 5: size string followed by at least one space character.

Column 6: date string (depends on the format chosen in Preferences -> Date format detection) followed by at least one space character.

Column 7: filename string up to end of line. Symbolic links are analyzed to guess if the linked file is a directory or a true file.


23

UNIX standard List columns must be compliant with the following rules: Column 1: permissions

string followed by at least one space character.

Column 2: link string followed by at least one space character.

Column 3: owner string followed by at least one space character.

Column 4: group string followed by at least one space character

Column 5: size string followed by at least one space character.

Column 6: date string (12 characters) followed by at least one space character.

Column 7: filename string up to end of line. Symbolic links are analyzed to guess if the linked file is a directory or a true file (by using SIZE FTP command).

Microsoft FTP Columns must be compliant with the following rules: Column 1: date string (23

characters) followed by at least one space character.

Column 2: type string (5 characters) followed by at least one space character.

Column 3: size string (8 characters) followed by at least one space character.

Column 4: filename string up to end of line.

IBM MVS

Unisys



24

Secured modeSelect the mode:

Implicit mode (the session starts in secured mode directly)

Explicit mode: The AUTH TLS-P session is a pure FTP session until the AUTH TLS-P command is sent to the server, which starts the underlying SSL layer. The AUTH TLS+PROT P session is a pure FTP session, until

UNIX without group column

This type mainly defines the way to handle server responses to FTP list commands. In the case of Synchrony Gateway, it also changes the FTP protocol slightly to take advantage of the extra functionalities this server offers.

This is the same as "UNIX standard" except that the group column is missing.

Guess In most cases, Axway SecureClient is able to recognize the type of server it is connecting to. The type of server can be inferred from its welcome message, or from the response to an extra SYST command. This last command can be avoided if you enter this parameter yourself. If no type can be inferred from the initial FTP dialog, the default value (UNIX standard) is used.

Java This server type requires the following data: Unix Permissions UnixLink UnixOwner UnixGroup Size Month Day Year/Hour Filename



25

the AUTH TLS command is sent to the server, which starts the underlying SSL layer, After that protection P level is set.

PASV is compliant with RFCSome servers do not expect data connections in a totally compliant way. They expect that the SSL negotiation, on data sessions, begins after the command RETR, STOR, STOU, or LIST (the command that requires the data connection), instead of after the command PASV, or PORT (the one that is responsible for opening the data connection). For these servers, deactivate this option. In particular, if the session starts normally, but freezes each time a list, put or get command is sent, try deactivating this option.

Firewall FriendlyAxway SecureClient includes a setting for the FTP subcommand, Clear Control Connection (CCC). When this setting is enabled, it makes a secured control/command channel revert back to plaintext (un-secured). If Firewall Friendly setting is enabled, the client connects to the server, negotiates a secure connection, authenticates (sends username and pass-word) then reverts back to plaintext.

Use FTP if FTPS is not supported by serverIf server does not support FTPS and this option is selected, the connection will fall back to FTP. Otherwise, the connection is broken.

HTTP-specific Parameters

Server typeSelect the type of server:

AXWAY (Synchrony Gateway)

NOTE: You must also configure Synchrony Gateway for Axway SecureClient using the HttpListTemplate.txt template located in the extras subdir of the place where the install directory of SecureClient is located.

SecureTransport

Apache version 2.2, 2.0, or 1.3

Microsoft IIS

LightHttpd

Auto

VersionSelect the HTTP protocol version:


26

HTTP 1.0

HTTP 1.1

Identification methodSelect the identification method used to identify the client (user and pass-word):

Anonymousno user or password provided

Basicuser and password are provided in the HTTP header

CGISynchrony Gateway-only authentication protocoluser and pass-word are provided as parameters in an HTTP command

SFTP-specific Parameters

Server typeSelect the type of server: Windows or UNIX.

Gateway parameters tab

Use the Gateway tab to manage parameters for this Site that are specific to Synchrony Gateway.

If these parameters are supplied, they are used by the Synchrony Gateway server when receiving files from Axway SecureClient.

When you begin to send a file, the default values of these parameters are proposed in the File transfer window, as set in the Site Gateway parameters tab. Click on the field you want to change, then click OK to send these parameters and start file transfer.

Originator and DestinationSynchrony Gateway uses these two strings to route the file.

ApplicationThe Application is a Synchrony Gateway object used to change the file format or the character encoding on reception.

MessageThis is a list of messages that appear as one message per line. Before sending a file, you can select one of these messages. The selected message will be sent to Synchrony Gateway before file transfer and will be associ-ated with the transfer. This field is for the customer's application usage.


27

Refer to the Synchrony Gateway documentation for more information on these parameters.

Security Parameter Tab

Use the Security tab to manage security parameters for the Site.

SecureTransport

Guarantee delivery using MD5 hashCheck this box to perform an MD5 checksum at the end of the transfer to ensure file integrity.

NOTE: Guaranteed delivery is ST specific functionality and is supported for all protocols except SFTP.

Outgoing local ports

Local portsThis list of local ports is useful if you connect to the server through a fire-wall that checks calling ports. If none is supplied, Axway SecureClient lets the operating system choose a free local port. If local ports are supplied, Axway SecureClient tries each provided value until it finds a free port number. If none is available, the connection will fail.

Two local ports are needed for one session. So you need to supply 2 + 2 * (number of parallel sessions) local TCP ports.

Proxy

ServerSelect the proxy server to be used by this site. You define proxy servers using the Proxy tab in the Preferences dialog box.

Proxies General Preferences buttonSelect the button next to the Server field to display the Proxies General Preferences dialog box. Use this dialog box to open the main proxy setup menu. For more information, see "Working with Proxy Preferences" section.


28

X.509 and SSL parameters

If you specified FTP or HTTP as the protocol for this site, you can specify the following X.509 and SSL parameters.

Activate SSL securityCheck this box to activate SSL/TLS and authenticate for this site.

Client certificateChoose a personal certificate from the certificate database to use as yours. If the server requests one during negotiation (and only if it requests one) send this certificate to validate your identity and thus be granted access to the server content.

Certificate passwordThis parameter enables Axway SecureClient to remember the client certif-icate password and therefore authenticate without requesting the pass-word for each connection to this Site. This parameter is optional.

Server certificateThis parameter checks the server certificate when using SSL or TLS. If you choose one certificate from the certificate database, Axway SecureClient will request the presence of this certificate in the server's certification chain to accept its authentication. If no certificate is provided here, any valid certification chain leading to a trusted root authority will be accepted. In case the provided certificate is not among the trusted ones, the behavior is defined by If server has an unknown root certificate option (see below).

Check that server certificate common name matches host nameCheck this box if you want Axway SecureClient to check that the common name in the server certificate matches the name entered in the Host field in the General tab.

SSL/TLS Cipher SuiteThis parameter specifies the authorized cipher suites when using SSL or TLS. A cipher suite defines the security parameters to use during a session. During negotiation Axway SecureClient proposes the given list to the remote site. It is then up to the server to pick one of them, or to refuse the session if none of them fits its policy.

NOTE: If no cipher suite is selected some default cipher suites are set automati-cally:

TLS_RSA_WITH_AES_128_CBC_SHA

SSL_RSA_WITH_RC4_128_SHA


29

SSL_RSA_WITH_RC4_128_MD5,

SSL_RSA_WITH_3DES_EDE_CBC_SHA

SSL_RSA_WITH_DES_CBC_SHA

TLS_RSA_WITH_AES_256_CBC_SHA - only available if JCE Strong encryption is installed on the machine

SSL_RSA_EXPORT_WITH_DES40_CBC_SHA

SSL_RSA_EXPORT_WITH_RC4_40_MD5

SSL_RSA_WITH_NULL_SHA

SSL_RSA_WITH_NULL_MD5

Use SSL cacheCheck this box to activate SSL cache.

SSL allows both sides to save security parameters of previous sessions. When negotiating a new session, the client can propose some parameters that have been negotiated during a previous session with the server. It can accept them or not. So both sides avoid doing some heavy cryptographic computations on every connection.

Clear this check box to disable the option.

If server has an unknown root certificateSelect an option to either accept an unknown root certificate, prompt you when an unknown certificate is encountered, or reject an unknown root certificate.

SSH Parameters

Server key status Displays the status of the key for this site.

TO IMPORT there is no key associated with this site.

NOT TRUSTED a key is associated with this site, but it is not trusted

TRUSTED a key is associated with the site, and it is trusted.

Authentication methodSpecify whether to use a password or a key for authenticating at transfer time.

User key aliasWhen authenticating the client using a key, this alias refers to the User Keys table from the Security Manager.


30

Notification parameters tab

Use the parameters on this page to control email notification about transfer success and failure for this site.

Enable Email notification

To use this option, you must define mail server in the preferences. You use these check boxes to enable email notification at the site level.

Success Enables email notification for successful file transfer to or from this site.

ErrorEnables email notification for file transfers that generate errors.

Sender/Receiver Recipient

You use the following fields to specify email address for senders and recipients of email notification for this site.

FromSpecify a value to be used in the From field for notification email.

ToCcBcc

Specify one or more recipients of notifications. Use commas to separate multiple recipients.

Notification Templates

You use these fields to specify templates to be used for email notification. You specify one each for success notifications and error notifications. Default templates are available in the notify folder of the SecureClient installation direc-tory.

SuccessSpecify the email template to use for notification of successful transfer.

ErrorSpecify the email template to use for notification when transfers generate errors.


31

Charset Parameter Tab

Axway SecureClient support for remote server system encoding allows exchanging files regardless of the remote server system encoding.

You use the Charset tab to specify character set encoding per Site. That is, all character output from the Site is decoded in the character set you specify on this tab and corresponding requests to this Site are encoded using the same char-acter set.

Server charset encoding for filenames

Choose one of the following

Force UTF-8Choose this radio button to force Axway SecureClient to use UTF-8. This is the default value.

Use custom charsetChoose this radio button to enable the Encoding drop-down menu. You choose the encoding you want Axway SecureClient to use.

NOTE: Using the wrong charset can result in filenames not displaying correctly.

Pre/Post Actions Parameter Tab

Transfer Mode

AutoAxway SecureClient compares filename patterns you specify in the Pref-erences dialog box with the names of the files to be transferred. If there is a match and the server does not support ASCII mode, Axway SecureClient converts the end-of-file markers as appropriate for the users native plat-form and transfers the file.

BinaryTreats transferred files as binary files.

TextTreats transferred files as text files.


32

Post Transfer Actions

Post transfer actions are executed after the file in question is downloaded.

External ProgramSpecify an external program or action to run as a post transfer action. You can specify %f as an argument, which is replaced with the files name before execution.

33

7 Security Manager WindowYou use the Certificates Manager to manage your certificates and keys. You can import certificate and keys, view their contents, delete them, and generate user keys.

Certificate databaseThis panel displays information about the certificates and keys stored on your system. They are divided into the following categories:

TrustedCertificates issued by a trusted certificate authority that Axway SecureClient uses to validate the identity of the remote site.

IntermediateCertificates based on an existing trusted certificate that Axway SecureClient uses to complete the chain to the trusted certificate.

PersonalCertificates used for authenticating local parties against remote sites.

User keysSSH keys used for authenticating local parties to remote sites.

ImportStarts an import procedure.

DeleteDeletes the selected certificate or key.

DetailsDisplays details about the currently selected certificate or key.

Generate keyGenerates a user SSH key pair.

Export a public keyExports an SSH public key .

SECURITY MANAGER WINDOWVIEWING CERTIFICATE OR KEY DETAILS

34

Viewing Certificate or Key Details

You use the Security Manager window to view details about certificates and keys stored in the Axway SecureClient certificate database.

TASK

1. From the Axway SecureClient Main Window, select Tools - Security Manager.STEP RESULT: The Security Manager window is displayed.

2. Click the tab appropriate to the type of item about which you want to view detail information.

3. Select an item, and then click Details. Alternatively, you can select and then right-click an item.STEP RESULT: A new dialog box containing detailed information about the selected item appears.

4. Click OK to dismiss the dialog box.

Importing a Certificate

You use the Import Certificate Wizard to import a certificate.

TASK

1. From the Axway SecureClient Main Window, select Tools - Security Manager.STEP RESULT: The Certificates manager window is displayed.

2. Click Import.STEP RESULT: The Import Certificate Wizard welcome window is displayed.

3. Choose a source file. The extension indicates the type of file you are choosing. Supported formats are DER and Base64 certificates (*.cer, *.der, *.crt), PKCS#7 certificate chains (*.p7b, *.p7s, *.p7m), and PKCS#12 containers (*.p12, *.pfx). Click the browse button to navigate through your local files.

SECURITY MANAGER WINDOWIMPORTING A KEY

35

4. For each certificate in the file, you must set up three parameters.ADDITIONAL INFORMATION: A DER file contains one certificate, but a PKCS#7 or PKCS#12 file can contain several certificates.

The alias of a certificate is a friendly name that uniquely identifies it in the database. An alias is automatically generated, and it cannot be changed.

5. To determine whether you c

secureclient 5.6 usersguide all enu

Documents