5 @ISA @EXPORT_OK $cgi $dbh $freeside_uid $user
6 $conf_dir $secrets $datasrc $db_user $db_pass %callback $driver_name
10 getsecrets cgisetotaker
13 use Carp qw(carp croak cluck);
18 @EXPORT_OK = qw(checkeuid checkruid cgisuidsetup adminsuidsetup forksuidsetup
19 getotaker dbh datasrc getsecrets driver_name );
21 $freeside_uid = scalar(getpwnam('freeside'));
23 $conf_dir = "/usr/local/etc/freeside/";
25 $AutoCommit = 1; #ours, not DBI
29 FS::UID - Subroutines for database login and assorted other stuff
33 use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker
39 $dbh = cgisuidsetup($cgi);
45 $driver_name = driver_name;
49 Provides a hodgepodge of subroutines.
55 =item adminsuidsetup USER
57 Sets the user to USER (see config.html from the base documentation).
58 Cleans the environment.
59 Make sure the script is running as freeside, or setuid freeside.
60 Opens a connection to the database.
61 Swaps real and effective UIDs.
62 Runs any defined callbacks (see below).
63 Returns the DBI database handle (usually you don't need this).
68 $dbh->disconnect if $dbh;
74 croak "fatal: adminsuidsetup called without arguements" unless $user;
76 $user =~ /^([\w\-\.]+)$/ or croak "fatal: illegal user $user";
79 $ENV{'PATH'} ='/usr/local/bin:/usr/bin:/usr/ucb:/bin';
80 $ENV{'SHELL'} = '/bin/sh';
81 $ENV{'IFS'} = " \t\n";
84 $ENV{'BASH_ENV'} = '';
86 croak "Not running uid freeside!" unless checkeuid();
88 $dbh = DBI->connect($datasrc,$db_user,$db_pass, {
91 } ) or die "DBI->connect error: $DBI::errstr\n";
93 foreach ( keys %callback ) {
95 # breaks multi-database installs # delete $callback{$_}; #run once
101 =item cgisuidsetup CGI_object
103 Takes a single argument, which is a CGI (see L<CGI>) or Apache (see L<Apache>)
104 object (CGI::Base is depriciated). Runs cgisetotaker and then adminsuidsetup.
110 if ( $cgi->isa('CGI::Base') ) {
111 carp "Use of CGI::Base is depriciated";
112 } elsif ( $cgi->isa('Apache') ) {
114 } elsif ( ! $cgi->isa('CGI') ) {
115 croak "fatal: unrecognized object $cgi";
118 adminsuidsetup($user);
123 Returns the CGI (see L<CGI>) object.
128 carp "warning: \$FS::UID::cgi isa Apache" if $cgi->isa('Apache');
134 Returns the DBI database handle.
144 Returns the DBI data source.
154 Returns just the driver name portion of the DBI data source.
159 return $driver_name if defined $driver_name;
160 $driver_name = ( split(':', $datasrc) )[1];
164 croak "suidsetup depriciated";
169 Returns the current Freeside user.
179 Sets and returns the CGI REMOTE_USER. $cgi should be defined as a CGI.pm
180 object (see L<CGI>) or an Apache object (see L<Apache>). Support for CGI::Base
181 and derived classes is depriciated.
186 if ( $cgi && $cgi->isa('CGI::Base') && defined $cgi->var('REMOTE_USER')) {
187 carp "Use of CGI::Base is depriciated";
188 $user = lc ( $cgi->var('REMOTE_USER') );
189 } elsif ( $cgi && $cgi->isa('CGI') && defined $cgi->remote_user ) {
190 $user = lc ( $cgi->remote_user );
191 } elsif ( $cgi && $cgi->isa('Apache') ) {
192 $user = lc ( $cgi->connection->user );
194 die "fatal: Can't get REMOTE_USER! for cgi $cgi - you need to setup ".
195 "Apache user authentication as documented in httemplate/docs/install.html";
202 Returns true if effective UID is that of the freeside user.
207 ( $> == $freeside_uid );
212 Returns true if the real UID is that of the freeside user.
217 ( $< == $freeside_uid );
220 =item getsecrets [ USER ]
222 Sets the user to USER, if supplied.
223 Sets and returns the DBI datasource, username and password for this user from
224 the `/usr/local/etc/freeside/mapsecrets' file.
229 my($setuser) = shift;
230 $user = $setuser if $setuser;
231 die "No user!" unless $user;
232 my($conf) = new FS::Conf $conf_dir;
233 my($line) = grep /^\s*$user\s/, $conf->config('mapsecrets');
234 die "User $user not found in mapsecrets!" unless $line;
235 $line =~ /^\s*$user\s+(.*)$/;
237 die "Illegal mapsecrets line for user?!" unless $secrets;
238 ($datasrc, $db_user, $db_pass) = $conf->config($secrets)
239 or die "Can't get secrets: $!";
240 $FS::Conf::default_dir = $conf_dir. "/conf.$datasrc";
242 ($datasrc, $db_user, $db_pass);
249 Warning: this interface is likely to change in future releases.
251 A package can install a callback to be run in adminsuidsetup by putting a
252 coderef into the hash %FS::UID::callback :
254 $coderef = sub { warn "Hi, I'm returning your call!" };
255 $FS::UID::callback{'Package::Name'};
259 $Id: UID.pm,v 1.21 2002-09-27 12:14:12 ivan Exp $
263 Too many package-global variables.
267 No capabilities yet. When mod_perl and Authen::DBI are implemented,
268 cgisuidsetup will go away as well.
270 Goes through contortions to support non-OO syntax with multiple datasrc's.
272 Callbacks are inelegant.
276 L<FS::Record>, L<CGI>, L<DBI>, config.html from the base documentation.