diff options
author | Russ Allbery <rra@stanford.edu> | 2010-02-18 14:18:22 -0800 |
---|---|---|
committer | Russ Allbery <rra@stanford.edu> | 2010-02-18 14:18:22 -0800 |
commit | 9336216818041c1a891a734f3dd431e7fbc50bcf (patch) | |
tree | 639d21003975ae135e3cd5c16d5d09e9b80c5317 /perl/Wallet | |
parent | 690493358caeba1c61e2a1edb4db9bd27faae0f6 (diff) |
Move stub fork_callback() into parent class
Move the stub fork_callback method into Wallet::Kadmin and make both
Wallet::Kadmin::Heimdal and Wallet::Kadmin::MIT inherit from
Wallet::Kadmin. Add POD documentation for fork_callback.
Diffstat (limited to 'perl/Wallet')
-rw-r--r-- | perl/Wallet/Kadmin.pm | 27 | ||||
-rw-r--r-- | perl/Wallet/Kadmin/Heimdal.pm | 10 | ||||
-rw-r--r-- | perl/Wallet/Kadmin/MIT.pm | 5 |
3 files changed, 30 insertions, 12 deletions
diff --git a/perl/Wallet/Kadmin.pm b/perl/Wallet/Kadmin.pm index b653f87..65adc83 100644 --- a/perl/Wallet/Kadmin.pm +++ b/perl/Wallet/Kadmin.pm @@ -26,6 +26,11 @@ $VERSION = '0.03'; # Public methods ############################################################################## +# Set a callback to be called for forked kadmin processes. This does nothing +# by default but may be overridden by subclasses that need special behavior +# (such as the current Wallet::Kadmin::MIT module). +sub fork_callback { } + # Create a new kadmin object, by finding the type requested in the wallet # config and passing off to the proper module. Returns the object directly # from the specific Wallet::Kadmin::* module. @@ -78,9 +83,8 @@ specific type of Kerberos implementation, such as MIT Kerberos or Heimdal, and provide a standard set of API calls used to interact with that implementation's kadmin interface. -The class simply uses Wallet::Config to find which type of kadmind we have -requested to use, and then returns an object to use for interacting with -that kadmind. +The class uses Wallet::Config to find which type of kadmin interface is in +use and then returns an object to use for interacting with that interface. A keytab is an on-disk store for the key or keys for a Kerberos principal. Keytabs are used by services to verify incoming authentication from @@ -92,18 +96,31 @@ To use this object, several configuration parameters must be set. See Wallet::Config(3) for details on those configuration parameters and information about how to set wallet configuration. -=head1 METHODS +=head1 CLASS METHODS =over 4 =item new() Finds the proper Kerberos implementation and calls the new() constructor -for that implementation's module, returning the result. If the +for that implementation's module, returning the resulting object. If the implementation is not recognized or set, die with an error message. =back +=head1 INSTANCE METHODS + +=over 4 + +=item fork_callback(CALLBACK) + +If the module has to fork an external process for some reason, such as a +kadmin command-line client, the sub CALLBACK will be called in the child +process before running the program. This can be used to, for example, +properly clean up shared database handles. + +=back + =head1 SEE ALSO kadmin(8), Wallet::Config(3), Wallet::Object::Keytab(3), wallet-backend(8) diff --git a/perl/Wallet/Kadmin/Heimdal.pm b/perl/Wallet/Kadmin/Heimdal.pm index 2ad35e3..30b1e52 100644 --- a/perl/Wallet/Kadmin/Heimdal.pm +++ b/perl/Wallet/Kadmin/Heimdal.pm @@ -13,10 +13,13 @@ package Wallet::Kadmin::Heimdal; require 5.006; use strict; -use vars qw($VERSION); +use vars qw(@ISA $VERSION); use Heimdal::Kadm5 qw(KRB5_KDB_DISALLOW_ALL_TIX); use Wallet::Config (); +use Wallet::Kadmin (); + +@ISA = qw(Wallet::Kadmin); # This version should be increased on any code change to this module. Always # use two digits for the minor version with a leading zero if necessary so @@ -48,11 +51,6 @@ sub canonicalize_principal { return $principal; } -# Set a callback to be called for forked kadmin processes. This does nothing -# for Heimdal, as we're not forking anything, but remains for compatibility -# with the MIT kadmin module. -sub fork_callback { } - ############################################################################## # kadmin Interaction ############################################################################## diff --git a/perl/Wallet/Kadmin/MIT.pm b/perl/Wallet/Kadmin/MIT.pm index 8449868..f181739 100644 --- a/perl/Wallet/Kadmin/MIT.pm +++ b/perl/Wallet/Kadmin/MIT.pm @@ -15,9 +15,12 @@ package Wallet::Kadmin::MIT; require 5.006; use strict; -use vars qw($VERSION); +use vars qw(@ISA $VERSION); use Wallet::Config (); +use Wallet::Kadmin (); + +@ISA = qw(Wallet::Kadmin); # This version should be increased on any code change to this module. Always # use two digits for the minor version with a leading zero if necessary so |