3 # Copyright (c) 1995-1998 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
12 use vars qw($VERSION);
14 $VERSION = "2.12"; # $Id: //depot/libnet/Net/Netrc.pm#13 $
24 $home = $ENV{HOME} || `pwd`;
26 $file = ($home =~ /:$/ ? $home . "netrc" : $home . ":netrc");
28 # Some OS's don't have `getpwuid', so we default to $ENV{HOME}
29 $home = eval { (getpwuid($>))[7] } || $ENV{HOME};
30 $home ||= $ENV{HOMEDRIVE} . ($ENV{HOMEPATH}||'') if defined $ENV{HOMEDRIVE};
31 $file = $home . "/.netrc";
34 my($login,$pass,$acct) = (undef,undef,undef);
38 $netrc{default} = undef;
40 # OS/2 and Win32 do not handle stat in a way compatable with this check :-(
46 my @stat = stat($file);
52 carp "Bad permissions: $file";
57 carp "Not owner: $file";
63 if($fh = FileHandle->new($file,"r"))
65 my($mach,$macdef,$tok,@tok) = (0,0);
69 undef $macdef if /\A\n\Z/;
80 while(length && s/^("((?:[^"]+|\\.)*)"|((?:[^\\\s]+|\\.)*))\s*//) {
81 (my $tok = $+) =~ s/\\(.)/$1/g;
88 if($tok[0] eq "default")
92 $netrc{default} = [$mach];
102 if($tok eq "machine")
104 my $host = shift @tok;
105 $mach = bless {machine => $host};
108 unless exists($netrc{$host});
109 push(@{$netrc{$host}}, $mach);
111 elsif($tok =~ /^(login|password|account)$/)
113 next TOKEN unless $mach;
114 my $value = shift @tok;
115 # Following line added by rmerrell to remove '/' escape char in .netrc
116 $value =~ s/\/\\/\\/g;
117 $mach->{$1} = $value;
119 elsif($tok eq "macdef")
121 next TOKEN unless $mach;
122 my $value = shift @tok;
124 unless exists $mach->{macdef};
125 $macdef = $mach->{machdef}{$value} = [];
135 my($pkg,$mach,$login) = @_;
138 unless exists $netrc{default};
142 if $mach eq 'default';
144 if(exists $netrc{$mach})
149 foreach $m (@{$netrc{$mach}})
152 if(exists $m->{login} && $m->{login} eq $login);
156 return $netrc{$mach}->[0]
159 return $netrc{default}->[0]
160 if defined $netrc{default};
178 exists $me->{account}
187 exists $me->{password}
195 ($me->login, $me->password, $me->account);
204 Net::Netrc - OO interface to users netrc file
210 $mach = Net::Netrc->lookup('some.machine');
211 $login = $mach->login;
212 ($login, $password, $account) = $mach->lpa;
216 C<Net::Netrc> is a class implementing a simple interface to the .netrc file
217 used as by the ftp program.
219 C<Net::Netrc> also implements security checks just like the ftp program,
220 these checks are, first that the .netrc file must be owned by the user and
221 second the ownership permissions should be such that only the owner has
222 read and write access. If these conditions are not met then a warning is
223 output and the .netrc file is not read.
225 =head1 THE .netrc FILE
227 The .netrc file contains login and initialization information used by the
228 auto-login process. It resides in the user's home directory. The following
229 tokens are recognized; they may be separated by spaces, tabs, or new-lines:
235 Identify a remote machine name. The auto-login process searches
236 the .netrc file for a machine token that matches the remote machine
237 specified. Once a match is made, the subsequent .netrc tokens
238 are processed, stopping when the end of file is reached or an-
239 other machine or a default token is encountered.
243 This is the same as machine name except that default matches
244 any name. There can be only one default token, and it must be
245 after all machine tokens. This is normally used as:
247 default login anonymous password user@site
249 thereby giving the user automatic anonymous login to machines
250 not specified in .netrc.
254 Identify a user on the remote machine. If this token is present,
255 the auto-login process will initiate a login using the
258 =item password string
260 Supply a password. If this token is present, the auto-login
261 process will supply the specified string if the remote server
262 requires a password as part of the login process.
266 Supply an additional account password. If this token is present,
267 the auto-login process will supply the specified string
268 if the remote server requires an additional account password.
272 Define a macro. C<Net::Netrc> only parses this field to be compatible
279 The constructor for a C<Net::Netrc> object is not called new as it does not
280 really create a new object. But instead is called C<lookup> as this is
281 essentially what it does.
285 =item lookup ( MACHINE [, LOGIN ])
287 Lookup and return a reference to the entry for C<MACHINE>. If C<LOGIN> is given
288 then the entry returned will have the given login. If C<LOGIN> is not given then
289 the first entry in the .netrc file for C<MACHINE> will be returned.
291 If a matching entry cannot be found, and a default entry exists, then a
292 reference to the default entry is returned.
294 If there is no matching entry found and there is no default defined, or
295 no .netrc file is found, then C<undef> is returned.
305 Return the login id for the netrc entry
309 Return the password for the netrc entry
313 Return the account information for the netrc entry
317 Return a list of login, password and account information fir the netrc entry
323 Graham Barr <gbarr@pobox.com>
332 Copyright (c) 1995-1998 Graham Barr. All rights reserved.
333 This program is free software; you can redistribute it and/or modify
334 it under the same terms as Perl itself.
338 $Id: //depot/libnet/Net/Netrc.pm#13 $