SCP Bean

Properties Methods Events Configuration Settings Errors

The SCP component can be used to transfer files to and from SSH servers using the Secure Copy Protocol (SCP).

Syntax

IPWorksSSH.Scp

Remarks

The SCP bean is the SSH-enabled equivalent of the IP*Works! RCP bean. The main difference is the introduction of a set of new properties and events that deal with SSH security. The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SCP bean implements a standard SCP File Transfer client.

The first step in using the bean is specifying the SSHHost, SSHUser and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, otherwise the data is received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

Property List

The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.


Connected	Triggers a connection or disconnection.
FilePermissions	The file permissions for the RemoteFile .
Firewall	A set of properties related to firewall access.
LocalFile	The path to a local file for download/upload. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where IPPort binds.
Overwrite	Whether or not the component should overwrite files during transfer.
RemoteFile	The name of the remote file for uploading, downloading, etc.
RemotePath	The remote path on the server.
SSHAcceptServerHostKey	Instructs the component to accept the server host key that matches the supplied key.
SSHAuthMode	The authentication method to be used the component when calling SSHLogon .
SSHCert	A certificate to be used for authenticating the SSHUser .
SSHCompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHHost	The address of the SSH host.
SSHPassword	The password for SSH password-based authentication.
SSHPort	The port on the SSH server where the SSH service is running; by default, 22.
SSHUser	The username for SSH authentication.
Timeout	A timeout for the component.

Method List

The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting .
decodePacket	Decodes a hex-encoded SSH packet.
doEvents	Processes events from the internal message queue.
download	Download a RemoteFile from an SCP server.
encodePacket	Hex encodes an SSH packet.
getSSHParam	Used to read a field from an SSH packet's payload.
getSSHParamBytes	Used to read a field from an SSH packet's payload.
interrupt	Interrupt the current method.
setDownloadStream	Sets the stream to which the downloaded data from the server will be written.
setSSHParam	Used to write a field to the end of a payload.
setUploadStream	Sets the stream from which the component will read data to upload to the server.
SSHLogoff	Logoff from the SSH server.
SSHLogon	Logon to the SSHHost using the current SSHUser and SSHPassword .
upload	Upload a file specified by LocalFile to an SCP server.

Event List

The following is the full list of the events fired by the bean with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a file completes downloading/uploading.
Error	Information about errors during data delivery.
SSHCustomAuth	Fired when the component is doing custom authentication.
SSHKeyboardInteractive	Fired when the component receives a request for user input from the server.
SSHServerAuthentication	Fired after the server presents its public key to the client.
SSHStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a file starts downloading/uploading.
Transfer	Fired during file download/upload.

Configuration Settings

The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.


RecursiveMode	If set to true the component will recursively upload or download files.
DirectoryPermissions	The permissions of folders created on the remote host.
PreserveFileTime	Preserves the file's modified time during transfer.
LastAccessedTime	The last accessed time of the remote file.
LastModifiedTime	The last modified time of the remote file.
ServerResponseWindow	The time to wait for a server response in milliseconds.
ClientSSHVersionString	The SSH version string used by the component.
SignedSSHCert	The CA signed client public key used when authenticating.
SSHAcceptServerCAKey	The CA public key that signed the server's host key.
SSHAcceptAnyServerHostKey	If set the component will accept any key presented by the server.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept.
SSHKeyExchangeAlgorithms	Specifies the supported key exchange algorithms.
SSHMacAlgorithms	Specifies the supported Mac algorithms.
SSHKeyRenegotiate	Causes the component to renegotiate the SSH keys.
KeyRenegotiationThreshold	Sets the threshold for the SSH Key Renegotiation.
KerberosRealm	The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.
KerberosDelegation	If true, asks for credentials with delegation enabled during authentication.
KerberosSPN	The Kerberos Service Principal Name of the SSH host.
LogSSHPackets	If true, detailed SSH packet logging is performed.
MaxPacketSize	The maximum packet size of the channel, in bytes.
MaxWindowSize	The maximum window size allowed for the channel, in bytes.
PreferredDHGroupBits	The size (in bits) of the preferred modulus (p) to request from the server.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.