base class for SFTPClient and SSH2Client More...

Inheritance diagram for Qore::SSH2::SSH2Base:

Public Member Functions
nothing	connect (timeout timeout=1m)
	connect to remote system More...

bool	connected ()
	returns True if the session is connected, False if not More...

	constructor ()
	Throws an exception; the constructor cannot be called manually. More...

nothing	disconnect (timeout timeout=1m)
	Disconnects from the remote system; throws an exception if the object is not currently connected. More...

nothing	setKeys (string priv_key, *string pub_key)
	Sets path to the private key and optionally the public key to use for the next connection; can only be called when a connection is not established, otherwise an exception is thrown. More...

nothing	setPassword (string pass)
	Sets the password for the next connection; can only be called when a connection is not established, otherwise an exception is thrown. More...

nothing	setUser (string user)
	Sets the user name for the next connection; can only be called when a connection is not established, otherwise an exception is thrown. More...

Detailed Description

base class for SFTPClient and SSH2Client

Restrictions:: Qore::PO_NO_NETWORK

The SSH2Base class provides common methods to the SSH2Client and SFTPClient classes

Member Function Documentation

nothing Qore::SSH2::SSH2Base::connect ( timeout timeout = 1m )

connect to remote system

Connects to the remote system; if a connection is already established, then it is disconnected first

Parameters

timeout an integer giving a timeout in milliseconds or a relative date/time value (ex: 15s for 15 seconds)

Exceptions

SOCKET-CONNECT-ERROR	error establishing socket connection (no listener, port blocked, etc); timeout establishing socket connection
SSH2CLIENT-CONNECT-ERROR	no user name set; ssh2 or libssh2 error
SSH2-ERROR	error initializing or establishing ssh2 session
SSH2CLIENT-AUTH-ERROR	no proper authentication method found
SFTPCLIENT-CONNECT-ERROR	error initializing sftp session or getting remote path (exception only possible when called from an SFTPClient object)

Example:: $sftpclient.connect(30s);

bool Qore::SSH2::SSH2Base::connected ( )

returns True if the session is connected, False if not

Returns: True if the session is connected, False if not

Code Flags:: CONSTANT

Example:: my bool $b = $sftpclient.connected();

Since: ssh2 0.9.8.1

Qore::SSH2::SSH2Base::constructor ( )

Throws an exception; the constructor cannot be called manually.

Throws an exception if called directly; this class cannot be instantiated directly

Exceptions

SSH2BASE-CONSTRUCTOR-ERROR this class is an abstract class and cannot be instantiated directly or directly inherited by a user-defined class

nothing Qore::SSH2::SSH2Base::disconnect ( timeout timeout = 1m )

Disconnects from the remote system; throws an exception if the object is not currently connected.

Exceptions

SSH2CLIENT-NOT-CONNECTED the client is not connected

Parameters

timeout an integer giving a timeout in milliseconds or a relative date/time value (ex: 15s for 15 seconds)

Example:: $sftpclient.disconnect();

nothing Qore::SSH2::SSH2Base::setKeys	(	string	priv_key,
		*string	pub_key
	)

Sets path to the private key and optionally the public key to use for the next connection; can only be called when a connection is not established, otherwise an exception is thrown.

Restrictions:: Qore::PO_NO_FILESYSTEM

Parameters

priv_key	the path to the private key file to use for the next connection
pub_key	optional: the path to the public key file to use for the next connection; note that if this argument is not passed, then the public key file's name will be automaticaly generated by appending `".pub"` to the private key file's name

Exceptions

SSH2-CONNECTED	this method cannot be called when a connection is established
SSH2-SETKEYS-ERROR	the given keys are not available or readable

Note

both keys must be present (private and public) and readable in order for key-based authentication to work
if the keys are not valid no exception is thrown here, however key-based authentication will fail with am error like: "SSH2CLIENT-AUTH-ERROR: No proper authentication method found" (the same or similar error can be raised when the server does not accept otherwise valid keys)

Example:: $sftpclient.setKeys($ENV.HOME + "/.ssh/id_rsa", $ENV.HOME + "/.ssh/id_rsa.pub");

nothing Qore::SSH2::SSH2Base::setPassword ( string pass )

Sets the password for the next connection; can only be called when a connection is not established, otherwise an exception is thrown.

Parameters

pass	the password to use for the next connection

Exceptions

SSH2-CONNECTED this method cannot be called when a connection is established

Example:: $sftpclient.setPassword("pass");

nothing Qore::SSH2::SSH2Base::setUser ( string user )

Sets the user name for the next connection; can only be called when a connection is not established, otherwise an exception is thrown.

Parameters

user	the user name to set for the next connection

Exceptions

SSH2-CONNECTED this method cannot be called when a connection is established

Example:: $sftpclient.setUser("username");

The documentation for this class was generated from the following file:

/Users/david/src/qore/svn/module-ssh2/trunk/src/QC_SSH2Base.dox.h

Public Member Functions

Detailed Description

Member Function Documentation