1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
package Net::SSH;
use strict;
use vars qw($VERSION @ISA @EXPORT_OK $ssh $DEBUG);
use Exporter;
use IO::File;
use IPC::Open2;
use IPC::Open3;
@ISA = qw(Exporter);
@EXPORT_OK = qw( ssh issh ssh_cmd sshopen2 sshopen3 );
$VERSION = '0.04';
$DEBUG = 0;
$ssh = "ssh";
=head1 NAME
Net::SSH - Perl extension for secure shell
=head1 SYNOPSIS
use Net::SSH qw(ssh issh sshopen2 sshopen3);
ssh('user@hostname', $command);
issh('user@hostname', $command);
ssh_cmd('user@hostname', $command);
sshopen2('user@hostname', $reader, $writer, $command);
sshopen3('user@hostname', $writer, $reader, $error, $command);
=head1 DESCRIPTION
Simple wrappers around ssh commands. For an all-perl implementation that does
not require
the system `ssh' command, see Net::SSH::Perl.
=head1 SUBROUTINES
=over 4
=item ssh [USER@]HOST, COMMAND [, ARGS ... ]
Calls ssh in batch mode.
=cut
sub ssh {
my($host, @command) = @_;
my @cmd = ($ssh, '-o', 'BatchMode=yes', $host, @command);
warn "[Net::SSH::ssh] executing ". join(' ', @cmd). "\n"
if $DEBUG;
system(@cmd);
}
=item issh [USER@]HOST, COMMAND [, ARGS ... ]
Prints the ssh command to be executed, waits for the user to confirm, and
(optionally) executes the command.
=cut
sub issh {
my($host, @command) = @_;
my @cmd = ($ssh, $host, @command);
print join(' ', @cmd), "\n";
if ( &_yesno ) {
system(@cmd);
}
}
=item ssh_cmd [USER@]HOST, COMMAND [, ARGS ... ]
Calls ssh in batch mode. Throws a fatal error if data occurs on the command's
STDERR. Returns any data from the command's STDOUT.
=cut
sub ssh_cmd {
my($host, @command) = @_;
my $reader = IO::File->new();
my $writer = IO::File->new();
my $error = IO::File->new();
sshopen3( $host, $reader, $writer, $error, @command ) or die $!;
local $/ = undef;
my $output_stream = <$writer>;
my $error_stream = <$error>;
if ( length $error_stream ) {
die "[Net:SSH::ssh_cmd] STDERR $error_stream";
}
return $output_stream;
}
=item sshopen2 [USER@]HOST, READER, WRITER, COMMAND [, ARGS ... ]
Connects the supplied filehandles to the ssh process (in batch mode).
=cut
sub sshopen2 {
my($host, $reader, $writer, @command) = @_;
open2($reader, $writer, $ssh, '-o', 'BatchMode=yes', $host, @command);
}
=item sshopen3 HOST, WRITER, READER, ERROR, COMMAND [, ARGS ... ]
Connects the supplied filehandles to the ssh process (in batch mode).
=cut
sub sshopen3 {
my($host, $writer, $reader, $error, @command) = @_;
open3($writer, $reader, $error, $ssh, '-o', 'BatchMode=yes', $host, @command);
}
sub _yesno {
print "Proceed [y/N]:";
my $x = scalar(<STDIN>);
$x =~ /^y/i;
}
=back
=head1 EXAMPLE
use Net::SSH qw(sshopen2);
use strict;
my $user = "username";
my $host = "hostname";
my $cmd = "command";
sshopen2("$user\@$host", *READER, *WRITER, "$cmd") || die "ssh: $!";
while (<READER>) {
chomp();
print "$_\n";
}
close(READER);
close(WRITER);
=head1 FREQUENTLY ASKED QUESTIONS
Q: How do you supply a password to connect with ssh within a perl script
using the Net::SSH module?
A: You don't. Use RSA or DSA keys. See the ssh-keygen(1) manpage.
Q: My script is "leaking" ssh processes.
A: See L<perlfaq8/"How do I avoid zombies on a Unix system">, L<IPC::Open2>,
L<IPC::Open3> and L<perlfunc/waitpid>.
=head1 AUTHORS
Ivan Kohler <ivan-netssh_pod@420.am>
John Harrison <japh@in-ta.net> contributed an example for the documentation.
Martin Langhoff <martin@cwa.co.nz> contributed the ssh_cmd command, and
Jeff Raffo <jraffo@fix.net> updated it and took care of the 0.04 release.
=head1 COPYRIGHT
Copyright (c) 2002 Ivan Kohler.
Copyright (c) 2002 Freeside Internet Services, LLC
All rights reserved.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=head1 BUGS
Not OO.
Look at IPC::Session (also fsh)
=head1 SEE ALSO
For an all-perl implementation that does not require the system B<ssh> command,
see L<Net::SSH::Perl>.
ssh-keygen(1), ssh(1), L<IO::File>, L<IPC::Open2>, L<IPC::Open3>
=cut
1;
|
