/usr/share/perl5/Net/TFTP.pm is in libnet-tftp-perl 0.19-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 | # Net::TFTP.pm
#
# Copyright (c) 1998,2007 Graham Barr <gbarr@pobox.com>. All rights reserved.
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
package Net::TFTP;
use strict;
use vars qw($VERSION);
use IO::File;
$VERSION = "0.19";
sub RRQ () { 01 } # read request
sub WRQ () { 02 } # write request
sub DATA () { 03 } # data packet
sub ACK () { 04 } # acknowledgement
sub ERROR () { 05 } # error code
sub OACK () { 06 } # option acknowledgement
my @NAME = qw(. RRQ WRQ DATA ACK ERR OACK);
sub new {
my $pkg = shift;
my $host = shift;
bless {
Debug => 0, # Debug off
Timeout => 5, # resend after 5 seconds
Retries => 5, # resend max 5 times
Port => 69, # tftp port number
BlockSize => 0, # use default blocksize (512)
IpMode => 'v4', # Operate in IPv6 mode, off by default
Mode => 'netascii', # transfer in netascii
@_, # user overrides
Host => $host, # the hostname
}, $pkg;
}
sub timeout {
my $self = shift;
my $v = $self->{'Timeout'};
$self->{'Timeout'} = 0 + shift if @_;
$v
}
sub debug {
my $self = shift;
my $v = $self->{'Debug'};
$self->{'Debug'} = 0 + shift if @_;
$v
}
sub port {
my $self = shift;
my $v = $self->{'Port'};
$self->{'Port'} = 0 + shift if @_;
$v
}
sub retries {
my $self = shift;
my $v = $self->{'Retries'};
$self->{'Retries'} = 0 + shift if @_;
$v
}
sub block_size {
my $self = shift;
my $v = $self->{'BlockSize'};
$self->{'BlockSize'} = 0 + shift if @_;
$v
}
sub host {
my $self = shift;
my $v = $self->{'Host'};
$self->{'Host'} = shift if @_;
$v
}
sub ip_mode {
my $self = shift;
my $v = $self->{'IpMode'};
$self->{'IpMode'} = shift if @_;
$v
}
sub ascii {
$_[0]->mode('netascii');
}
sub binary {
$_[0]->mode('octet');
}
BEGIN {
*netascii = \&ascii;
*octet = \&binary;
}
sub mode {
my $self = shift;
my $v = $self->{'Mode'};
$self->{'Mode'} = lc($_[0]) eq "netascii" ? "netascii" : "octet"
if @_;
$v
}
sub error {
my $self = shift;
exists $self->{'error'}
? $self->{'error'}
: undef;
}
sub get {
my($self,$remote) = splice(@_,0,2);
my $local = shift if @_ % 2;
my %arg = ( %$self, @_ );
delete $self->{'error'};
my $io = Net::TFTP::IO->new($self,\%arg,RRQ,$remote);
return $io
unless defined($local) && defined($io);
my $file = $local;
unless(ref($local)) {
$local = IO::File->new($file,O_WRONLY|O_TRUNC|O_CREAT);
unless ($local) {
$self->{'error'} = "Can not open $file: $!";
return undef;
}
}
binmode $local if $self->{'Mode'} eq 'octet';
my($len,$pkt);
while($len = sysread($io,$pkt,10240)) {
if($len < 0) {
$self->{'error'} = $io->error;
last;
}
elsif(syswrite($local,$pkt,length($pkt)) < 0) {
$self->{'error'} = "$!";
last;
}
}
close($local)
unless ref($file);
$self->{'error'} = $io->error
unless(close($io));
exists $self->{'error'} ? undef : 1;
}
sub put {
my($self,$remote) = splice(@_,0,2);
my $local;
($local,$remote) = ($remote,shift) if @_ %2;
my %arg = (%$self,@_);
delete $self->{'error'};
my $file;
if (defined $local) {
$file = $local;
unless(ref($local)) {
unless ($local = IO::File->new($file,O_RDONLY)) {
$self->{'error'} = "$file: $!";
return undef;
}
}
}
my $io = Net::TFTP::IO->new($self,\%arg,WRQ,$remote);
return $io
unless defined($local) && defined($io);
binmode $local if $self->{'Mode'} eq 'octet';
my($len,$pkt);
while($len = sysread($local,$pkt,10240)) {
if($len < 0) {
$self->{'error'} = "$!";
last;
}
elsif(($len=syswrite($io,$pkt,length($pkt))) < 0) {
$self->{'error'} = $io->error;
last;
}
}
close($local)
unless ref($file);
$self->{'error'} = $io->error
unless(close($io));
exists $self->{'error'} ? undef : 1;
}
package Net::TFTP::IO;
use vars qw(@ISA);
use IO::Socket;
use IO::Select;
@ISA = qw(IO::Handle);
sub new {
my($pkg,$tftp,$opts,$op,$remote) = @_;
my $io = $pkg->SUPER::new;
$opts->{'Mode'} = lc($opts->{'Mode'});
$opts->{'IpMode'} = lc($opts->{'IpMode'});
$opts->{'Mode'} = "netascii"
unless $opts->{'Mode'} eq "octet";
$opts->{'ascii'} = lc($opts->{'Mode'}) eq "netascii";
my $host = $opts->{'Host'};
do {
$tftp->{'error'} = "No hostname given";
return undef;
} unless defined($host);
## jjmb - had to make an adjustment here the logic used originally does not work well
## with IPv6.
my $port = undef;
if($opts->{'IpMode'} eq "v6") {
require Socket6;
require IO::Socket::INET6;
$port = $opts->{'Port'};
} else {
$port = $host =~ s/:(\d+)$// ? $1 : $opts->{'Port'};
}
my $addr = inet_aton($host);
## jjmb - added some logic here for the time being to prevent some errors from showing
if($opts->{'IpMode'} eq "v6") {
# Skipping validation
} else {
unless($addr) {
$tftp->{'error'} = "Bad hostname '$host'";
return undef;
}
}
## jjmb - need to construct different objects depending on the IP version used
my $sock = undef;
if($opts->{'IpMode'} eq "v6") {
$sock = IO::Socket::INET6->new(PeerAddr => $opts->{'Host'}, Port => $opts->{'Port'}, Proto => 'udp');
} else {
$sock = IO::Socket::INET->new(Proto => 'udp');
}
my $mode = $opts->{'Mode'};
my $pkt = pack("n a* c a* c", $op, $remote, 0, $mode, 0);
if($opts->{'BlockSize'} > 0) {
$pkt .= sprintf("blksize\0%d\0",$opts->{'BlockSize'});
}
my $read = $op == Net::TFTP::RRQ;
my $sel = IO::Select->new($sock);
@{$opts}{'read','sock','sel','pkt','blksize'}
= ($read,$sock,$sel,$pkt,512);
if($read) { # read
@{$opts}{'ibuf','icr','blk'} = ('',0,1);
}
else { # write
@{$opts}{'obuf','blk','ack'} = ('',0,-1);
}
if($tftp->{'IpMode'} eq "v6") {
send($sock,$pkt,0,Socket6::sockaddr_in6($port,Socket6::inet_pton(AF_INET6,$host)));
} else {
send($sock,$pkt,0,pack_sockaddr_in($port,inet_aton($host)));
}
_dumppkt($sock,1,$pkt) if $opts->{'Debug'};
tie *$io, "Net::TFTP::IO",$opts;
$io;
}
sub error {
my $self = shift;
my $tied = UNIVERSAL::isa($self,'GLOB') && tied(*$self) || $self;
exists $tied->{'error'} ? $tied->{'error'} : undef;
}
sub TIEHANDLE {
my $pkg = shift;
bless shift , $pkg;
}
sub PRINT {
my $self = shift;
# Simulate print
my $buf = join(defined($,) ? $, : "",@_) . defined($\) ? $\ : "";
# and with the proposed ?? syntax that would be
# $buf = join($, ?? "", @_) . $\ ?? "";
$self->WRITE($buf,length($buf));
}
sub WRITE {
# $self, $buf, $len, $offset
my $self = shift;
my $buf = substr($_[0],$_[2] || 0,$_[1]);
my $offset = 0;
$buf =~ s/([\n\r])/$1 eq "\n" ? "\015\012" : "\015\0"/soge
if ($self->{'ascii'});
$self->{'obuf'} .= substr($buf,$offset);
while(length($self->{'obuf'}) >= $self->{'blksize'}) {
return -1 if _write($self,1) < 0;
}
$_[1];
}
sub READLINE {
my $self = shift;
# return undef (ie eof) unless we have an input buffer
return undef
if exists $self->{'error'} || !exists $self->{'ibuf'};
_read($self,0);
while(1) {
my $sep;
# if $/ is undef then we slurp the whole file
if(defined($sep = $/)) {
# if $/ eq "" then we need to do paragraph mode
unless(length($sep)) {
# when doing paragraph mode remove all leading \n's
$self->{'ibuf'} =~ s/^\n+//s;
$sep = "\n\n";
}
my $offset = index($self->{'ibuf'},$sep);
if($offset >= 0) {
my $len = $offset+length($sep);
# With 5.005 I could use the 4-arg substr
my $ret = substr($self->{'ibuf'},0,$len);
substr($self->{'ibuf'},0,$len) = "";
return $ret;
}
}
my $res = _read($self,1);
next if $res > 0; # We have some more, but do we have enough ?
if ($res < 0) {
# We have encountered an error, so
# force subsequent reads to return eof
delete $self->{'ibuf'};
# And return undef (ie eof)
return undef;
}
# $res == 0 so there is no more data to read, just return
# the buffer contents
return delete $self->{'ibuf'};
}
# NOT REACHED
return;
}
sub READ {
# $self, $buf, $len, $offset
my $self = shift;
return undef
if exists $self->{'error'};
return 0
unless exists $self->{'ibuf'};
my $ret = length($self->{'ibuf'});
unless ($self->{'eof'}) {
# If there is any data waiting, read it and ask for more
_read($self,0);
# read until we have enough
while(($ret = length($self->{'ibuf'})) < $_[1]) {
last unless _read($self,1) > 0;
}
}
# Did we encounter an error
return undef
if exists $self->{'error'};
# we may have too much
$ret = $_[1]
if $_[1] < $ret;
# We are simulating read() so we may have to insert into $_[0]
if($ret) {
if($_[2]) {
substr($_[0],$_[2]) = substr($self->{'ibuf'},0,$ret);
}
else {
$_[0] = substr($self->{'ibuf'},0,$ret);
}
# remove what we placed into $_[0]
substr($self->{'ibuf'},0,$ret) = "";
}
# If we are returning less than what was asked for
# then the next call must return eof
delete $self->{'ibuf'}
if $self->{'eof'} && length($self->{'ibuf'}) == 0 ;
$ret;
}
sub CLOSE {
my $self = shift;
if (exists $self->{'sock'} && !exists $self->{'closing'}) {
$self->{'closing'} = 1;
if ($self->{'read'} ) {
unless ($self->{'eof'}) {
my $pkt = pack("nna*c",Net::TFTP::ERROR,0,"Premature close",0);
_dumppkt($self->{'sock'},1,$pkt) if $self->{'Debug'};
send($self->{'sock'},$pkt,0,$self->{'peer'})
if $self->{'peer'};
}
}
else {
# Clear the buffer
unless(exists $self->{'error'}) {
while(length($self->{'obuf'}) >= $self->{'blksize'}) {
last if _write($self) < 0;
}
# Send the last block
$self->{'blksize'} = length($self->{'obuf'});
_write($self) unless(exists $self->{'error'});
# buffer is empty so blksize=1 will ensure I do not send
# another packet, but just wait for the ACK
$self->{'blksize'} = 1;
_write($self) unless(exists $self->{'error'});
}
}
close(delete $self->{'sock'});
}
exists $self->{'error'} ? 0 : 1;
}
# _natoha($data,$cr) - Convert netascii -> host text
# updates both input args
sub _natoha {
use vars qw($buf $cr);
local *buf = \$_[0];
local *cr = \$_[1];
my $last = substr($buf,-1);
if($cr) {
my $ch = ord(substr($buf,0,1));
if($ch == 012) { # CR.LF => \n
substr($buf,0,1) = "\n";
}
elsif($ch == 0) { # CR.NUL => \r
substr($buf,0,1) = "\r";
}
else {
# Hm, badly formed netascii
substr($buf,0,0) = "\015";
}
}
if(ord($last) eq 015) {
substr($buf,-1) = "";
$cr = 1;
}
else {
$cr = 0;
}
$buf =~ s/\015\0/\r/sg;
$buf =~ s/\015\012/\n/sg;
1;
}
sub _abort {
my $self = shift;
$self->{'error'} ||= 'Protocol error';
$self->{'eof'} = 1;
my $pkt = pack("nna*c",Net::TFTP::ERROR,0,$self->{'error'},0);
send($self->{'sock'},$pkt,0,$self->{'peer'})
if exists $self->{'peer'};
CLOSE($self);
-1;
}
# _read: The guts of the reading
#
# returns
# >0 size of data read
# 0 eof
# <0 error
sub _read {
my($self,$wait) = @_;
return -1 if exists $self->{'error'};
return 0 if $self->{'eof'};
my $sock = $self->{'sock'} || return -1;
my $select = $self->{'sel'};
my $timeout = $wait ? $self->{'Timeout'} : 0;
my $retry = 0;
while(1) {
if($select->can_read($timeout)) {
my $ipkt = ''; # will be filled by _recv
my($peer,$code,$blk) = _recv($self,$ipkt)
or return _abort($self);
redo unless defined($peer); # do not send ACK to real peer
if($code == Net::TFTP::DATA) {
# If we receive a packet we are not expecting
# then ACK the last packet again
if($blk == $self->{'blk'}) {
$self->{'blk'} = $blk+1;
my $data = substr($ipkt,4);
_natoha($data,$self->{'icr'})
if($self->{'ascii'});
$self->{'ibuf'} .= $data;
my $opkt = $self->{'pkt'} = pack("nn", Net::TFTP::ACK,$blk);
send($sock,$opkt,0,$peer);
_dumppkt($sock,1,$opkt)
if $self->{'Debug'};
$self->{'eof'} = 1
if ( length($ipkt) < ($self->{'blksize'} + 4) );
return length($data);
}
elsif($blk < $self->{'blk'}) {
redo; # already got this data
}
}
elsif($code == Net::TFTP::OACK) {
my $opkt = $self->{'pkt'} = pack("nn", Net::TFTP::ACK,0);
send($sock,$opkt,0,$peer);
_dumppkt($sock,1,$opkt)
if $self->{'Debug'};
return _read($self,$wait);
}
elsif($code == Net::TFTP::ERROR) {
$self->{'error'} = substr($ipkt,4);
$self->{'eof'} = 1;
CLOSE($self);
return -1;
}
return _abort($self);
}
last unless $wait;
# Resend last packet, this will re ACK the last data packet
if($retry++ >= $self->{'Retries'}) {
$self->{'error'} = "Transfer Timeout";
return _abort($self);
}
send($sock,$self->{'pkt'},0,$self->{'peer'})
if $self->{'peer'};
if ($self->{'Debug'}) {
print STDERR "${sock} << ---- retry=${retry}\n";
_dumppkt($sock,1,$self->{'pkt'});
}
}
# NOT REACHED
}
sub _recv {
my $self = shift;
my $sock = $self->{'sock'};
my $bsize = $self->{'blksize'}+4;
$bsize = 516 if $bsize < 516;
my $peer = recv($sock,$_[0],$bsize,0);
# There is something on the socket, but not a udp packet. Prob. an icmp.
return unless ($peer);
_dumppkt($sock,0,$_[0]) if $self->{'Debug'};
# The struct in $peer can be bigger than needed for AF_INET
# so could contain garbage at the end. unpacking and re-packing
# will ensure it is zero filled (Thanks TomC)
if($self->{'IpMode'} eq "v6") {
$peer = Socket6::pack_sockaddr_in6(Socket6::unpack_sockaddr_in6($peer));
} else {
$peer = pack_sockaddr_in(unpack_sockaddr_in($peer));
}
$self->{'peer'} ||= $peer; # Remember first peer
my($code,$blk) = unpack("nn",$_[0]);
if($code == Net::TFTP::OACK) {
my %o = split("\0",substr($_[0],2));
%$self = (%$self,%o);
}
if ($self->{'peer'} ne $peer) {
# All packets must be from same peer
# packet from someone else, send them an ERR packet
my $err = pack("nna*c",Net::TFTP::ERROR, 5, "Unknown transfer ID",0);
_dumppkt($sock,1,$err)
if $self->{'Debug'};
send($sock,$err,0,$peer);
$peer = undef;
}
($peer,$code,$blk);
}
sub _send_data {
my $self = shift;
if(length($self->{'obuf'}) >= $self->{'blksize'}) {
my $blk = ++$self->{'blk'};
my $opkt = $self->{'pkt'} = pack("nn", Net::TFTP::DATA,$blk)
. substr($self->{'obuf'},0,$self->{'blksize'});
substr($self->{'obuf'},0,$self->{'blksize'}) = '';
my $sock = $self->{'sock'};
send($sock,$opkt,0,$self->{'peer'});
_dumppkt($sock,1,$opkt)
if $self->{'Debug'};
}
elsif (length($self->{'obuf'}) == 0 and $self->{'blksize'} == 1) {
# ignore
}
elsif($^W) {
require Carp;
Carp::carp("Net::TFTP: Buffer underflow");
}
1;
}
sub _write {
my($self) = @_;
return -1 if exists $self->{'error'};
my $sock = $self->{'sock'} || return -1;
my $select = $self->{'sel'};
my $timeout = $self->{'Timeout'};
my $retry = 0;
return _send_data($self)
if $self->{'ack'} == $self->{'blk'};
while(1) {
if($select->can_read($timeout)) {
my $ipkt=''; # will be filled by _recv
my($peer,$code,$blk) = _recv($self,$ipkt)
or return _abort($self);
redo unless defined($peer); # do not send ACK to real peer
if($code == Net::TFTP::OACK) {
$code = Net::TFTP::ACK;
$blk = 0;
}
if($code == Net::TFTP::ACK) {
if ($self->{'blk'} == $blk) {
$self->{'ack'} = $blk;
return _send_data($self);
}
elsif ($self->{'blk'} > $blk) {
redo; # duplicate ACK
}
}
if($code == Net::TFTP::ERROR) {
$self->{'error'} = substr($ipkt,4);
CLOSE($self);
return -1;
}
return _abort($self);
}
# Resend last packet, this will resend the last DATA packet
if($retry++ >= $self->{'Retries'}) {
$self->{'error'} = "Transfer Timeout";
return _abort($self);
}
send($sock,$self->{'pkt'},0,$self->{'peer'});
if ($self->{'Debug'}) {
print STDERR "${sock} << ---- retry=${retry}\n";
_dumppkt($sock,1,$self->{'pkt'});
}
}
# NOT REACHED
}
sub _dumppkt {
my($sock,$send) = @_;
my($code,$blk) = unpack("nn",$_[2]);
$send = $send ? "$sock <<" : "$sock >>";
my $str = sprintf "%s %-4s",$send,$NAME[$code];
$str .= sprintf " %s=%d",$code == Net::TFTP::ERROR ? "code" : "blk",$blk
if $code == Net::TFTP::DATA
|| $code == Net::TFTP::ACK
|| $code == Net::TFTP::ERROR;
printf STDERR "%s length=%d\n",$str,length($_[2]);
if($code == Net::TFTP::RRQ || $code == Net::TFTP::WRQ || $code == Net::TFTP::OACK) {
my @a = split("\0",substr($_[2],2));
printf STDERR "%s filename=%s mode=%s\n",$send,splice(@a,0,2)
unless $code == Net::TFTP::OACK;
my %a = @a;
my($k,$v);
while(($k,$v) = each %a) {
printf STDERR "%s %s=%s\n",$send,$k,$v;
}
}
printf STDERR "%s %s\n",$send,substr($_[2],4)
if $code == Net::TFTP::ERROR;
}
1;
__END__
=head1 NAME
Net::TFTP - TFTP Client class
=head1 SYNOPSIS
use Net::TFTP;
$tftp = Net::TFTP->new("some.host.name", BlockSize => 1024);
$tftp->ascii;
$tftp->get("remotefile", "localfile");
$tftp->get("remotefile", \*STDOUT);
$fh = $tftp->get("remotefile");
$tftp->binary;
$tftp->put("localfile", "remotefile");
$tftp->put(\*STDOUT, "remotefile");
$fh = $tftp->put("remotefile");
$err = $tftp->error
=head1 DESCRIPTION
C<Net::TFTP> is a class implementing a simple I<Trivial File Transfer Protocol>
client in Perl as described in RFC1350. C<Net::TFTP> also supports the
TFTP Option Extension (as described in RFC2347), with the following options
RFC2348 Blocksize Option
=head1 CONSTRUCTOR
=over 4
=item new ( [ HOST ] [, OPTIONS ])
Create a new Net::TFTP object where HOST is the default host to connect
to and OPTIONS are the default transfer options. Valid options are
Option Description Default
------ ----------- -------
Timeout Timeout in seconds before retry 5
Retries Maximum number of retries 5
Port Port to send data to 69
Mode Mode to transfer data in, "octet" or "netascii" "netascii"
BlockSize Negotiate size of blocks to use in the transfer 512
IpMode Indicates whether to operate in IPv6 mode "v4"
=back
=head1 METHODS
=over 4
=item get ( REMOTE_FILE [, LOCAL ] [, OPTIONS ])
Get REMOTE_FILE from the server. OPTIONS can be any that are accepted by
C<new> plus the following
Host Override default host
If the LOCAL option is missing the get will return a filehandle. This
filehandle must be read ASAP as the server will otherwise timeout.
If the LOCAL option is given then it can be a file name or a reference.
If it is a reference it is assumed to be a reference that is valid as a
filehandle. C<get> will return I<true> if the transfer is successful and
I<undef> otherwise.
Valid filehandles are
=over 4
=item *
A sub-class of IO::Handle
=item *
A tied filehandle
=item *
A GLOB reference (eg C<\*STDOUT>)
=back
=item put ( [ LOCAL, ] REMOTE_FILE [, OPTIONS])
Put a file to the server as REMOTE_FILE. OPTIONS can be any that are
accepted by C<new> plus the following
Host Override default host
If the LOCAL option is missing the put will return a filehandle. This
filehandle must be written to ASAP as the server will otherwise timeout.
If the LOCAL option is given then it can be a file name or a reference.
If it is a reference it is assumed to be a valid filehandle as described above.
C<put> will return I<true> if the transfer is successful and I<undef> otherwise.
=item error
If there was an error then this method will return an error string.
=item host ( [ HOST ] )
=item timeout ( [ TIMEOUT ] )
=item port ( [ PORT ] )
=item mode ( [ MODE ] )
=item retries ( [ VALUE ] )
=item block_size ( [ VALUE ] )
=item debug ( [ VALUE ] )
Set or get the values for the various options. If an argument is passed
then a new value is set for that option and the previous value returned.
If no value is passed then the current value is returned.
=item ip_mode ( [ VALUE ] )
Set or get which verion of IP to use ("v4" or "v6")
=item ascii
=item netascii
Set the transfer mode to C<"netascii">
=item binary
=item octet
Set the transfer mode to C<"octet">
=back
=head1 AUTHOR
Graham Barr <gbarr@pobox.com>
=head1 COPYRIGHT
Copyright (c) 1998,2007 Graham Barr. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|