4 use vars qw($VERSION @ISA @EXPORT_OK $scp);
8 use String::ShellQuote;
10 use Net::SSH qw(sshopen3);
14 @EXPORT_OK = qw( scp iscp );
21 Net::SCP - Perl extension for secure copy protocol
26 use Net::SCP qw(scp iscp);
27 scp($source, $destination);
28 iscp($source, $destination); #shows command, asks for confirmation, and
29 #allows user to type a password on tty
32 $scp = Net::SCP->new( "hostname", "username" );
34 $scp = Net::SCP->new( { "host"=>$hostname, "user"=>$username } );
35 $scp->get("filename") or die $scp->{errstr};
36 $scp->put("filename") or die $scp->{errstr};
39 $scp->scp($source, $destination);
42 $scp = Net::SCP->new("hostname");
51 Simple wrappers around ssh and scp commands.
57 =item scp SOURCE, DESTINATION
59 Can be called either as a subroutine or a method; however, the subroutine
60 interface is depriciated.
62 Calls scp in batch mode, with the B<-B> B<-p> B<-q> and B<-r> options.
63 Returns false upon error, with a text error message accessable in
66 Returns false and sets the B<errstr> attribute if there is an error.
71 my $self = ref($_[0]) ? shift : {};
72 my($src, $dest, $interact) = @_;
74 $flags .= 'r' unless &_islocal($src) && ! -d $src;
76 if ( ( defined($interact) && $interact )
77 || ( defined($self->{interact}) && $self->{interact} ) ) {
78 @cmd = ( $scp, $flags, $src, $dest );
79 print join(' ', @cmd), "\n";
81 $self->{errstr} = "User declined";
86 @cmd = ( $scp, $flags, $src, $dest );
88 my($reader, $writer, $error ) =
89 ( new IO::Handle, new IO::Handle, new IO::Handle );
90 $writer->autoflush(1);# $error->autoflush(1);
91 my $pid = open3($writer, $reader, $error, @cmd );
94 my $errstr = join('', <$error>);
95 #chomp(my $errstr = <$error>);
96 $self->{errstr} = $errstr;
103 =item iscp SOURCE, DESTINATION
105 Can be called either as a subroutine or a method; however, the subroutine
106 interface is depriciated.
108 Prints the scp command to be execute, waits for the user to confirm, and
109 (optionally) executes scp, with the B<-p> and B<-r> flags.
111 Returns false and sets the B<errstr> attribute if there is an error.
118 $self->{'interact'} = 1;
126 print "Proceed [y/N]:";
127 my $x = scalar(<STDIN>);
141 =item new HOSTNAME [ USER ] | HASHREF
143 This is the constructor for a new Net::SCP object. You must specify a
144 hostname, and may optionally provide a user. Alternatively, you may pass a
145 hashref of named params, with the following keys:
150 cwd - current working directory on remote server
156 my $class = ref($proto) || $proto;
163 'user' => ( scalar(@_) ? shift : '' ),
168 bless($self, $class);
173 Compatibility method. Optionally sets the user.
178 my($self, $user) = @_;
179 $self->{'user'} = $user if $user;
184 Sets the cwd (used for a subsequent get or put request without a full pathname).
189 my($self, $cwd) = @_;
190 $self->{'cwd'} = $cwd || '/';
193 =item get REMOTE_FILE [, LOCAL_FILE]
195 Uses scp to transfer REMOTE_FILE from the remote host. If a local filename is
196 omitted, uses the basename of the remote file.
201 my($self, $remote, $local) = @_;
202 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
203 $local ||= basename($remote);
204 my $source = $self->{'host'}. ":$remote";
205 $source = $self->{'user'}. '@'. $source if $self->{'user'};
209 =item mkdir DIRECTORY
211 Makes a directory on the remote server. Returns false and sets the B<errstr>
214 (Implementation note: An ssh connection is established to the remote machine
215 and '/bin/mkdir B<-p>' is used to create the directory.)
220 my($self, $directory) = @_;
221 $directory = $self->{'cwd'}. "/$directory"
222 if $self->{'cwd'} && $directory !~ /^\//;
223 my $host = $self->{'host'};
224 $host = $self->{'user'}. '@'. $host if $self->{'user'};
225 my($reader, $writer, $error ) =
226 ( new IO::Handle, new IO::Handle, new IO::Handle );
227 $writer->autoflush(1);
228 my $pid = sshopen3( $host, $writer, $reader, $error,
229 '/bin/mkdir', '-p ', shell_quote($directory) );
232 chomp(my $errstr = <$error>);
233 $self->{errstr} = $errstr || "mkdir exited with status ". $?>>8;
241 Returns the size in bytes for the given file as stored on the remote server.
242 Returns 0 on error, and sets the B<errstr> attribute. In the case of an actual
243 zero-length file on the remote server, the special value '0e0' is returned,
244 which evaluates to zero when used as a number, but is true.
246 (Implementation note: An ssh connection is established to the remote machine
247 and wc is used to determine the file size.)
252 my($self, $file) = @_;
253 $file = $self->{'cwd'}. "/$file" if $self->{'cwd'} && $file !~ /^\//;
254 my $host = $self->{'host'};
255 $host = $self->{'user'}. '@'. $host if $self->{'user'};
256 my($reader, $writer, $error ) =
257 ( new IO::Handle, new IO::Handle, new IO::Handle );
258 $writer->autoflush(1);
259 #sshopen2($host, $reader, $writer, 'wc', '-c ', shell_quote($file) );
261 sshopen3($host, $writer, $reader, $error, 'wc', '-c ', shell_quote($file) );
264 chomp(my $errstr = <$error>);
265 $self->{errstr} = $errstr || "wc exited with status ". $?>>8;
268 chomp( my $size = <$reader> || 0 );
269 if ( $size =~ /^\s*(\d+)/ ) {
272 $self->{errstr} = "unparsable output from remote wc: $size";
278 =item put LOCAL_FILE [, REMOTE_FILE]
280 Uses scp to trasnfer LOCAL_FILE to the remote host. If a remote filename is
281 omitted, uses the basename of the local file.
286 my($self, $local, $remote) = @_;
287 $remote ||= basename($local);
288 $remote = $self->{'cwd'}. "/$remote" if $self->{'cwd'} && $remote !~ /^\//;
289 my $dest = $self->{'host'}. ":$remote";
290 $dest = $self->{'user'}. '@'. $dest if $self->{'user'};
291 warn "scp $local $dest\n";
297 Compatibility method: does nothing; returns true.
305 =head1 FREQUENTLY ASKED QUESTIONS
307 Q: How do you supply a password to connect with ssh within a perl script
308 using the Net::SSH module?
310 A: You don't. Use RSA or DSA keys. See the ssh-keygen(1) manpage.
312 Q: My script is "leaking" ssh processes.
314 A: See L<perlfaq8/"How do I avoid zombies on a Unix system">, L<IPC::Open2>,
315 L<IPC::Open3> and L<perlfunc/waitpid>.
319 Ivan Kohler <ivan-netscp_pod@420.am>
321 Major updates Anthony Deaver <bishop@projectmagnus.org>
323 Thanks to Jon Gunnip <jon@soundbite.com> for fixing a bug with size().
325 Patch for the mkdir method by Anthony Awtrey <tony@awtrey.com>
329 Copyright (c) 2000 Ivan Kohler.
330 Copyright (c) 2000 Silicon Interactive Software Design.
331 Copyright (c) 2000 Freeside Internet Services, LLC
333 This program is free software; you can redistribute it and/or modify it under
334 the same terms as Perl itself.
338 Still has no-OO cruft.
340 In order to work around some problems with commercial SSH2, if the source file
341 is on the local system, and is not a directory, the B<-r> flag is omitted.
343 It's probably better just to use SSH1 or OpenSSH <http://www.openssh.com/>
345 The Net::FTP-style OO stuff is kinda lame. And incomplete.