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 $ENV{'PATH'} ='/usr/local/bin:/usr/bin:/usr/ucb:/bin';
77 $ENV{'SHELL'} = '/bin/sh';
78 $ENV{'IFS'} = " \t\n";
81 $ENV{'BASH_ENV'} = '';
83 croak "Not running uid freeside!" unless checkeuid();
85 $dbh = DBI->connect($datasrc,$db_user,$db_pass, {
88 } ) or die "DBI->connect error: $DBI::errstr\n";
90 foreach ( keys %callback ) {
97 =item cgisuidsetup CGI_object
99 Takes a single argument, which is a CGI (see L<CGI>) or Apache (see L<Apache>)
100 object (CGI::Base is depriciated). Runs cgisetotaker and then adminsuidsetup.
106 if ( $cgi->isa('CGI::Base') ) {
107 carp "Use of CGI::Base is depriciated";
108 } elsif ( $cgi->isa('Apache') ) {
110 } elsif ( ! $cgi->isa('CGI') ) {
111 croak "fatal: unrecognized object $cgi";
114 adminsuidsetup($user);
119 Returns the CGI (see L<CGI>) object.
124 carp "warning: \$FS::UID::cgi isa Apache" if $cgi->isa('Apache');
130 Returns the DBI database handle.
140 Returns the DBI data source.
150 Returns just the driver name portion of the DBI data source.
155 return $driver_name if defined $driver_name;
156 $driver_name = ( split(':', $datasrc) )[1];
160 croak "suidsetup depriciated";
165 Returns the current Freeside user.
175 Sets and returns the CGI REMOTE_USER. $cgi should be defined as a CGI.pm
176 object (see L<CGI>) or an Apache object (see L<Apache>). Support for CGI::Base
177 and derived classes is depriciated.
182 if ( $cgi && $cgi->isa('CGI::Base') && defined $cgi->var('REMOTE_USER')) {
183 carp "Use of CGI::Base is depriciated";
184 $user = lc ( $cgi->var('REMOTE_USER') );
185 } elsif ( $cgi && $cgi->isa('CGI') && defined $cgi->remote_user ) {
186 $user = lc ( $cgi->remote_user );
187 } elsif ( $cgi && $cgi->isa('Apache') ) {
188 $user = lc ( $cgi->connection->user );
190 die "fatal: Can't get REMOTE_USER! for cgi $cgi - you need to setup ".
191 "Apache user authentication as documented in htdocs/docs/config.html";
198 Returns true if effective UID is that of the freeside user.
203 ( $> == $freeside_uid );
208 Returns true if the real UID is that of the freeside user.
213 ( $< == $freeside_uid );
216 =item getsecrets [ USER ]
218 Sets the user to USER, if supplied.
219 Sets and returns the DBI datasource, username and password for this user from
220 the `/usr/local/etc/freeside/mapsecrets' file.
225 my($setuser) = shift;
226 $user = $setuser if $setuser;
227 die "No user!" unless $user;
228 my($conf) = new FS::Conf $conf_dir;
229 my($line) = grep /^\s*$user\s/, $conf->config('mapsecrets');
230 die "User not found in mapsecrets!" unless $line;
231 $line =~ /^\s*$user\s+(.*)$/;
233 die "Illegal mapsecrets line for user?!" unless $secrets;
234 ($datasrc, $db_user, $db_pass) = $conf->config($secrets)
235 or die "Can't get secrets: $!";
236 $FS::Conf::default_dir = $conf_dir. "/conf.$datasrc";
238 ($datasrc, $db_user, $db_pass);
245 Warning: this interface is likely to change in future releases.
247 A package can install a callback to be run in adminsuidsetup by putting a
248 coderef into the hash %FS::UID::callback :
250 $coderef = sub { warn "Hi, I'm returning your call!" };
251 $FS::UID::callback{'Package::Name'};
255 $Id: UID.pm,v 1.10 2001-09-24 03:23:34 ivan Exp $
259 Too many package-global variables.
263 No capabilities yet. When mod_perl and Authen::DBI are implemented,
264 cgisuidsetup will go away as well.
266 Goes through contortions to support non-OO syntax with multiple datasrc's.
268 Callbacks are inelegant.
272 L<FS::Record>, L<CGI>, L<DBI>, config.html from the base documentation.