X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=SSH.pm;h=35d20b38f515d4ceab8aa081b61ed3b6d15b91c9;hb=c7122c867aaed06f5493e3e11422fee91365d3e7;hp=715eec1498477cce6b4b96a99a6776a9a0e61732;hpb=66402dd8dfab605172dc71eb58df77535d7fbc29;p=Net-SSH.git

diff --git a/SSH.pm b/SSH.pm
index 715eec1..35d20b3 100644
--- a/SSH.pm
+++ b/SSH.pm
@@ -1,14 +1,17 @@
 package Net::SSH;
 
 use strict;
-use vars qw($VERSION @ISA @EXPORT_OK $ssh);
+use vars qw($VERSION @ISA @EXPORT_OK $ssh $equalspace $DEBUG);
 use Exporter;
+use IO::File;
 use IPC::Open2;
 use IPC::Open3;
 
 @ISA = qw(Exporter);
-@EXPORT_OK = qw( ssh issh sshopen2 sshopen3 );
-$VERSION = '0.02';
+@EXPORT_OK = qw( ssh issh ssh_cmd sshopen2 sshopen3 );
+$VERSION = '0.06';
+
+$DEBUG = 0;
 
 $ssh = "ssh";
 
@@ -24,14 +27,26 @@ Net::SSH - Perl extension for secure shell
 
   issh('user@hostname', $command);
 
+  ssh_cmd('user@hostname', $command);
+  ssh_cmd( {
+    user => 'user',
+    host => 'host.name',
+    command => 'command',
+    args => [ '-arg1', '-arg2' ],
+    stdin_string => "string\n",
+  } );
+
   sshopen2('user@hostname', $reader, $writer, $command);
 
-  sshopen3('user@hostname', $reader, $writer, $error, $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 B<ssh> command,
+see L<Net::SSH::Perl> instead.
+
 =head1 SUBROUTINES
 
 =over 4
@@ -44,7 +59,10 @@ Calls ssh in batch mode.
 
 sub ssh {
   my($host, @command) = @_;
-  my @cmd = ($ssh, '-o', 'BatchMode yes', $host, @command);
+  &_check_ssh_version unless defined $equalspace;
+  my @cmd = ($ssh, '-o', 'BatchMode'.$equalspace.'yes', $host, @command);
+  warn "[Net::SSH::ssh] executing ". join(' ', @cmd). "\n"
+    if $DEBUG;
   system(@cmd);
 }
 
@@ -64,6 +82,58 @@ sub issh {
   }
 }
 
+=item ssh_cmd [USER@]HOST, COMMAND [, ARGS ... ]
+
+=item ssh_cmd OPTIONS_HASHREF
+
+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.
+
+If using the hashref-style of passing arguments, possible keys are:
+
+  user (optional)
+  host (requried)
+  command (required)
+  args (optional, arrayref)
+  stdin_string (optional) - written to the command's STDIN
+
+=cut
+
+sub ssh_cmd {
+  my($host, $stdin_string, @command);
+  if ( ref($_[0]) ) {
+    my $opt = shift;
+    $host = $opt->{host};
+    $host = $opt->{user}. '@'. $host if exists $opt->{user};
+    @command = ( $opt->{command} );
+    push @command, @{ $opt->{args} } if exists $opt->{args};
+    $stdin_string = $opt->{stdin_string};
+  } else {
+    ($host, @command) = @_;
+    undef $stdin_string;
+  }
+
+  my $reader = IO::File->new();
+  my $writer = IO::File->new();
+  my $error  = IO::File->new();
+
+  sshopen3( $host, $writer, $reader, $error, @command ) or die $!;
+
+  print $writer $stdin_string if defined $stdin_string;
+  close $writer;
+
+  local $/ = undef;
+  my $output_stream = <$reader>;
+  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).
@@ -72,7 +142,8 @@ Connects the supplied filehandles to the ssh process (in batch mode).
 
 sub sshopen2 {
   my($host, $reader, $writer, @command) = @_;
-  open2($reader, $writer, $ssh, '-o', 'Batchmode yes', $host, @command);
+  &_check_ssh_version unless defined $equalspace;
+  open2($reader, $writer, $ssh, '-o', 'BatchMode'.$equalspace.'yes', $host, @command);
 }
 
 =item sshopen3 HOST, WRITER, READER, ERROR, COMMAND [, ARGS ... ]
@@ -83,7 +154,8 @@ Connects the supplied filehandles to the ssh process (in batch mode).
 
 sub sshopen3 {
   my($host, $writer, $reader, $error, @command) = @_;
-  open3($writer, $reader, $error, $ssh, '-o', 'Batchmode yes', $host, @command);
+  &_check_ssh_version unless defined $equalspace;
+  open3($writer, $reader, $error, $ssh, '-o', 'BatchMode'.$equalspace.'yes', $host, @command);
 }
 
 sub _yesno {
@@ -92,6 +164,20 @@ sub _yesno {
   $x =~ /^y/i;
 }
 
+sub _check_ssh_version {
+  my $reader = IO::File->new();
+  my $writer = IO::File->new();
+  my $error  = IO::File->new();
+  open3($writer, $reader, $error, $ssh, '-V');
+  my $ssh_version = <$error>;
+  chomp($ssh_version);
+  if ( $ssh_version =~ /.*OpenSSH[-|_](\w+)\./ && $1 == 1 ) {
+    $equalspace = " ";
+  } else {
+    $equalspace = "=";
+  }
+}
+
 =back
 
 =head1 EXAMPLE
@@ -113,13 +199,37 @@ sub _yesno {
   close(READER);
   close(WRITER);
 
-=head1 AUTHOR
+=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>
 
-=head1 CREDITS
+John Harrison <japh@in-ta.net> contributed an example for the documentation.
 
- 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 Finucane <jeff@cmh.net> updated it and took care of the 0.04 release.
+
+Anthony Awtrey <tony@awtrey.com> contributed a fix for those still using
+OpenSSH v1.
+
+=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
 
@@ -129,7 +239,10 @@ Look at IPC::Session (also fsh)
 
 =head1 SEE ALSO
 
-ssh(1), L<IPC::Open2>, L<IPC::Open3>
+For an all-perl implementation that does not require the system B<ssh> command,
+see L<Net::SSH::Perl> instead.
+
+ssh-keygen(1), ssh(1), L<IO::File>, L<IPC::Open2>, L<IPC::Open3>
 
 =cut