1Net::SSH::Perl::ConstanUtsse(r3)Contributed Perl DocumenNteatt:i:oSnSH::Perl::Constants(3)
2
3
4

NAME

6       Net::SSH::Perl::Constants - Exportable constants
7

SYNOPSIS

9           use Net::SSH::Perl::Constants qw( constants );
10

DESCRIPTION

12       Net::SSH::Perl::Constants provides a list of common and useful con‐
13       stants for use in communicating with an sshd server, etc.
14
15       None of the constants are exported by default; you have to explicitly
16       ask for them. Some of the constants are grouped into bundles that you
17       can grab all at once, or you can just take the individual constants,
18       one by one.
19
20       If you wish to import a group, your use statement should look something
21       like this:
22
23           use Net::SSH::Perl::Constants qw( :group );
24
25       Here are the groups:
26
27       * msg
28           All of the MSG constants. In the SSH packet layer protocol, each
29           packet is identified by its type; for example, you have a packet
30           type for starting RSA authentication, a different type for sending
31           a command, etc. The MSG constants are used when creating a new
32           packet, then:
33
34               my $packet = $ssh->packet_start( I<msg_constant> );
35
36           See the Net::SSH::Perl::Packet and Net::SSH::Perl docs for details.
37
38           Net::SSH::Perl doesn't support all of the features of the ssh
39           client, so it doesn't need all of its MSG constants. For a full
40           list of such constants, and an explanation of each, see the SSH
41           RFC.
42
43           Here's the list of MSG constants supported by Net::SSH::Perl:
44           SSH_MSG_NONE, SSH_MSG_DISCONNECT, SSH_SMSG_PUBLIC_KEY,
45           SSH_CMSG_SESSION_KEY, SSH_CMSG_USER, SSH_CMSG_AUTH_RHOSTS,
46           SSH_CMSG_AUTH_RSA, SSH_SMSG_AUTH_RSA_CHALLENGE,
47           SSH_CMSG_AUTH_RSA_RESPONSE, SSH_CMSG_AUTH_PASSWORD,
48           SSH_CMSG_EXEC_SHELL, SSH_CMSG_EXEC_CMD, SSH_SMSG_SUCCESS,
49           SSH_SMSG_FAILURE, SSH_CMSG_STDIN_DATA, SSH_SMSG_STDOUT_DATA,
50           SSH_SMSG_STDERR_DATA, SSH_CMSG_EOF, SSH_SMSG_EXITSTATUS,
51           SSH_MSG_IGNORE, SSH_CMSG_EXIT_CONFIRMATION,
52           SSH_CMSG_AUTH_RHOSTS_RSA, SSH_MSG_DEBUG, SSH_CMSG_REQUEST_COMPRES‐
53           SION.
54
55       * hosts
56           The HOST constants: HOST_OK, HOST_NEW, and HOST_CHANGED.  These are
57           returned from the "_check_host_in_hostfile" routine in
58           Net::SSH::Perl::Util. See those docs for that routine for an expla‐
59           nation of the meaning of these constants.
60
61       * agent
62           The AGENT constants, used when talking to an authentication agent:
63           SSH_AGENTC_REQUEST_RSA_IDENTITIES, SSH_AGENT_RSA_IDENTITIES_ANSWER,
64           SSH_AGENTC_RSA_CHALLENGE, SSH_AGENT_RSA_RESPONSE, SSH_AGENT_FAIL‐
65           URE, SSH_AGENT_SUCCESS, SSH2_AGENTC_REQUEST_IDENTITIES,
66           SSH2_AGENT_IDENTITIES_ANSWER, SSH2_AGENTC_SIGN_REQUEST,
67           SSH2_AGENT_SIGN_RESPONSE.
68
69       Other exportable constants, not belonging to a group, are:
70
71       * PROTOCOL_MAJOR
72       * PROTOCOL_MINOR
73           These two constants describe the version of the protocol supported
74           by this SSH client (ie., Net::SSH::Perl).  They're used when iden‐
75           tifying the client to the server and vice versa.
76
77       * PRIVATE_KEY_ID_STRING
78           A special ID string written to private key files; if the ID string
79           in the file doesn't match this, we stop reading the private key
80           file.
81
82       * MAX_PACKET_SIZE
83           The maximum size of a packet in the packet layer.
84

AUTHOR & COPYRIGHTS

86       Please see the Net::SSH::Perl manpage for author, copyright, and
87       license information.
88
89
90
91perl v5.8.8                       2003-12-03      Net::SSH::Perl::Constants(3)
Impressum