Module: LibSSH

Defined in:

lib/libssh/key.rb,
lib/libssh/version.rb,
ext/libssh_ruby/libssh_ruby.c

Defined Under Namespace

Classes: Channel, Error, Key, Scp, Session

Constant Summary

VERSION =

The version of libssh gem.

'0.3.1'.freeze

SERVER_KNOWN_OK =

See Also:

• LibSSH::Session#server_known

INT2FIX(SSH_SERVER_KNOWN_OK)

SERVER_KNOWN_CHANGED =

See Also:

• LibSSH::Session#server_known

INT2FIX(SSH_SERVER_KNOWN_CHANGED)

SERVER_FOUND_OTHER =

See Also:

• LibSSH::Session#server_known

INT2FIX(SSH_SERVER_FOUND_OTHER)

SERVER_NOT_KNOWN =

See Also:

• LibSSH::Session#server_known

INT2FIX(SSH_SERVER_NOT_KNOWN)

SERVER_FILE_NOT_FOUND =

See Also:

• LibSSH::Session#server_known

INT2FIX(SSH_SERVER_FILE_NOT_FOUND)

AUTH_DENIED =

Return value that indicates an authentication failure.

INT2FIX(SSH_AUTH_DENIED)

AUTH_PARTIAL =

Return value that indicates a partially authenticated.

INT2FIX(SSH_AUTH_PARTIAL)

AUTH_SUCCESS =

Return value that indicates a successful authentication.

INT2FIX(SSH_AUTH_SUCCESS)

AUTH_AGAIN =

Return value that indicates EAGAIN in nonblocking mode.

INT2FIX(SSH_AUTH_AGAIN)

LIBSSH_VERSION_MAJOR =

Major version defined in header.

INT2FIX(LIBSSH_VERSION_MAJOR)

LIBSSH_VERSION_MINOR =

Minor version defined in header.

INT2FIX(LIBSSH_VERSION_MINOR)

LIBSSH_VERSION_MICRO =

Micro version defined in header.

INT2FIX(LIBSSH_VERSION_MICRO)

LIBSSH_VERSION_INT =

Major version defined in header.

INT2FIX(LIBSSH_VERSION_INT)

LIBSSH_VERSION =

String version defined in header.

rb_str_new_cstr(SSH_STRINGIFY(LIBSSH_VERSION))

Class Method Summary

• .version(req_version = 0) ⇒ String^?

  When req_version is given, check if libssh is the required version.

Class Method Details

.version(req_version = 0) ⇒ String^?

When req_version is given, check if libssh is the required version. When req_version isn’t given, return the libssh version string.

Parameters:

• req_version (Fixnum) (defaults to: 0) —

  The version required.

Returns:

• (String, nil) —

  The libssh version string if it’s newer than req_version .

See Also:

• http://api.libssh.org/stable/group__libssh__misc.html

Since:

• 0.2.0

# File 'ext/libssh_ruby/libssh_ruby.c', line 17

static VALUE m_version(int argc, VALUE *argv, RB_UNUSED_VAR(VALUE self)) {
  VALUE req_version;
  int c_req_version = 0;

  rb_scan_args(argc, argv, "01", &req_version);
  if (!NIL_P(req_version)) {
    Check_Type(req_version, T_FIXNUM);
    c_req_version = FIX2INT(req_version);
  }
  return rb_str_new_cstr(ssh_version(c_req_version));
}