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
13       constants 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
29           All of the MSG constants. In the SSH packet layer protocol, each
30           packet is identified by its type; for example, you have a packet
31           type for starting RSA authentication, a different type for sending
32           a command, etc. The MSG constants are used when creating a new
33           packet, then:
34
35               my $packet = $ssh->packet_start( I<msg_constant> );
36
37           See the Net::SSH::Perl::Packet and Net::SSH::Perl docs for details.
38
39           Net::SSH::Perl doesn't support all of the features of the ssh
40           client, so it doesn't need all of its MSG constants. For a full
41           list of such constants, and an explanation of each, see the SSH
42           RFC.
43
44           Here's the list of MSG constants supported by Net::SSH::Perl:
45           SSH_MSG_NONE, SSH_MSG_DISCONNECT, SSH_SMSG_PUBLIC_KEY,
46           SSH_CMSG_SESSION_KEY, SSH_CMSG_USER, SSH_CMSG_AUTH_RHOSTS,
47           SSH_CMSG_AUTH_RSA, SSH_SMSG_AUTH_RSA_CHALLENGE,
48           SSH_CMSG_AUTH_RSA_RESPONSE, SSH_CMSG_AUTH_PASSWORD,
49           SSH_CMSG_EXEC_SHELL, SSH_CMSG_EXEC_CMD, SSH_SMSG_SUCCESS,
50           SSH_SMSG_FAILURE, SSH_CMSG_STDIN_DATA, SSH_SMSG_STDOUT_DATA,
51           SSH_SMSG_STDERR_DATA, SSH_CMSG_EOF, SSH_SMSG_EXITSTATUS,
52           SSH_MSG_IGNORE, SSH_CMSG_EXIT_CONFIRMATION,
53           SSH_CMSG_AUTH_RHOSTS_RSA, SSH_MSG_DEBUG,
54           SSH_CMSG_REQUEST_COMPRESSION.
55
56       •   hosts
57
58           The HOST constants: HOST_OK, HOST_NEW, and HOST_CHANGED.  These are
59           returned from the "_check_host_in_hostfile" routine in
60           Net::SSH::Perl::Util. See those docs for that routine for an
61           explanation of the meaning of these constants.
62
63       •   agent
64
65           The AGENT constants, used when talking to an authentication agent:
66           SSH_AGENTC_REQUEST_RSA_IDENTITIES, SSH_AGENT_RSA_IDENTITIES_ANSWER,
67           SSH_AGENTC_RSA_CHALLENGE, SSH_AGENT_RSA_RESPONSE,
68           SSH_AGENT_FAILURE, SSH_AGENT_SUCCESS,
69           SSH2_AGENTC_REQUEST_IDENTITIES, SSH2_AGENT_IDENTITIES_ANSWER,
70           SSH2_AGENTC_SIGN_REQUEST, SSH2_AGENT_SIGN_RESPONSE.
71
72       Other exportable constants, not belonging to a group, are:
73
74       •   PROTOCOL_MAJOR
75
76       •   PROTOCOL_MINOR
77
78           These two constants describe the version of the protocol supported
79           by this SSH client (ie., Net::SSH::Perl).  They're used when
80           identifying the client to the server and vice versa.
81
82       •   PRIVATE_KEY_ID_STRING
83
84           A special ID string written to private key files; if the ID string
85           in the file doesn't match this, we stop reading the private key
86           file.
87
88       •   MAX_PACKET_SIZE
89
90           The maximum size of a packet in the packet layer.
91

AUTHOR & COPYRIGHTS

93       Please see the Net::SSH::Perl manpage for author, copyright, and
94       license information.
95
96
97
98perl v5.36.0                      2023-01-20      Net::SSH::Perl::Constants(3)
Impressum