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.11"; # $Id: //depot/libnet/Net/Netrc.pm#10 $
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 $file = $home . "/.netrc";
33 my($login,$pass,$acct) = (undef,undef,undef);
37 $netrc{default} = undef;
39 # OS/2 and Win32 do not handle stat in a way compatable with this check :-(
45 my @stat = stat($file);
51 carp "Bad permissions: $file";
56 carp "Not owner: $file";
62 if($fh = FileHandle->new($file,"r"))
64 my($mach,$macdef,$tok,@tok) = (0,0);
68 undef $macdef if /\A\n\Z/;
79 while(length && s/^("([^"]*)"|(\S+))\s*//);
84 if($tok[0] eq "default")
88 $netrc{default} = [$mach];
100 my $host = shift @tok;
101 $mach = bless {machine => $host};
104 unless exists($netrc{$host});
105 push(@{$netrc{$host}}, $mach);
107 elsif($tok =~ /^(login|password|account)$/)
109 next TOKEN unless $mach;
110 my $value = shift @tok;
111 # Following line added by rmerrell to remove '/' escape char in .netrc
112 $value =~ s/\/\\/\\/g;
113 $mach->{$1} = $value;
115 elsif($tok eq "macdef")
117 next TOKEN unless $mach;
118 my $value = shift @tok;
120 unless exists $mach->{macdef};
121 $macdef = $mach->{machdef}{$value} = [];
131 my($pkg,$mach,$login) = @_;
134 unless exists $netrc{default};
138 if $mach eq 'default';
140 if(exists $netrc{$mach})
145 foreach $m (@{$netrc{$mach}})
148 if(exists $m->{login} && $m->{login} eq $login);
152 return $netrc{$mach}->[0]
155 return $netrc{default}->[0]
156 if defined $netrc{default};
174 exists $me->{account}
183 exists $me->{password}
191 ($me->login, $me->password, $me->account);
200 Net::Netrc - OO interface to users netrc file
206 $mach = Net::Netrc->lookup('some.machine');
207 $login = $mach->login;
208 ($login, $password, $account) = $mach->lpa;
212 C<Net::Netrc> is a class implementing a simple interface to the .netrc file
213 used as by the ftp program.
215 C<Net::Netrc> also implements security checks just like the ftp program,
216 these checks are, first that the .netrc file must be owned by the user and
217 second the ownership permissions should be such that only the owner has
218 read and write access. If these conditions are not met then a warning is
219 output and the .netrc file is not read.
221 =head1 THE .netrc FILE
223 The .netrc file contains login and initialization information used by the
224 auto-login process. It resides in the user's home directory. The following
225 tokens are recognized; they may be separated by spaces, tabs, or new-lines:
231 Identify a remote machine name. The auto-login process searches
232 the .netrc file for a machine token that matches the remote machine
233 specified. Once a match is made, the subsequent .netrc tokens
234 are processed, stopping when the end of file is reached or an-
235 other machine or a default token is encountered.
239 This is the same as machine name except that default matches
240 any name. There can be only one default token, and it must be
241 after all machine tokens. This is normally used as:
243 default login anonymous password user@site
245 thereby giving the user automatic anonymous login to machines
246 not specified in .netrc.
250 Identify a user on the remote machine. If this token is present,
251 the auto-login process will initiate a login using the
254 =item password string
256 Supply a password. If this token is present, the auto-login
257 process will supply the specified string if the remote server
258 requires a password as part of the login process.
262 Supply an additional account password. If this token is present,
263 the auto-login process will supply the specified string
264 if the remote server requires an additional account password.
268 Define a macro. C<Net::Netrc> only parses this field to be compatible
275 The constructor for a C<Net::Netrc> object is not called new as it does not
276 really create a new object. But instead is called C<lookup> as this is
277 essentially what it does.
281 =item lookup ( MACHINE [, LOGIN ])
283 Lookup and return a reference to the entry for C<MACHINE>. If C<LOGIN> is given
284 then the entry returned will have the given login. If C<LOGIN> is not given then
285 the first entry in the .netrc file for C<MACHINE> will be returned.
287 If a matching entry cannot be found, and a default entry exists, then a
288 reference to the default entry is returned.
298 Return the login id for the netrc entry
302 Return the password for the netrc entry
306 Return the account information for the netrc entry
310 Return a list of login, password and account information fir the netrc entry
316 Graham Barr <gbarr@pobox.com>
325 Copyright (c) 1995-1998 Graham Barr. All rights reserved.
326 This program is free software; you can redistribute it and/or modify
327 it under the same terms as Perl itself.
331 $Id: //depot/libnet/Net/Netrc.pm#10 $