diff options
author | Sam Hartman <hartmans@mit.edu> | 2010-10-05 13:57:23 +0000 |
---|---|---|
committer | Sam Hartman <hartmans@mit.edu> | 2010-10-05 13:57:23 +0000 |
commit | 6b2ecc35be9774019d6abb3b76e71a3f3de93562 (patch) | |
tree | 0b9898ba2d350d7fc66f22c0ba5f728124faeffa /src | |
parent | cf38783a30f793857f179cca9186996f3bad2b71 (diff) | |
download | krb5-6b2ecc35be9774019d6abb3b76e71a3f3de93562.tar.gz krb5-6b2ecc35be9774019d6abb3b76e71a3f3de93562.tar.xz krb5-6b2ecc35be9774019d6abb3b76e71a3f3de93562.zip |
Document kadm5_hook interface
* krb5.conf
* admin.texinfo
* kadm5_hook_plugin.h: document initvt requirement
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24422 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'src')
-rw-r--r-- | src/config-files/krb5.conf.M | 8 | ||||
-rw-r--r-- | src/include/krb5/kadm5_hook_plugin.h | 20 |
2 files changed, 28 insertions, 0 deletions
diff --git a/src/config-files/krb5.conf.M b/src/config-files/krb5.conf.M index e658e8997f..d03a1f468b 100644 --- a/src/config-files/krb5.conf.M +++ b/src/config-files/krb5.conf.M @@ -752,6 +752,14 @@ built with Hesiod support) .IP princ Checks against components of the principal name +.SS kadm5_hook interface + +The kadm5_hook interface provides plugins with information on +principal creation, modification, password changes and deletion. This +interface can be used to write a plugin to synchronize MIT Kerberos +with another database such as Active Directory. No plugins are built +in for this interface. + .SH FILES /etc/krb5.conf .SH SEE ALSO diff --git a/src/include/krb5/kadm5_hook_plugin.h b/src/include/krb5/kadm5_hook_plugin.h index 9e81222836..fda72464b3 100644 --- a/src/include/krb5/kadm5_hook_plugin.h +++ b/src/include/krb5/kadm5_hook_plugin.h @@ -48,6 +48,26 @@ * * This interface depends on kadm5/admin.h. As such, the interface * does not provide strong guarantees of ABI stability. + * + * kadm5_hook plugins should: + * kadm5_hook_<modulename>_initvt, matching the signature: + * + * krb5_error_code + * kadm5_hook_modname_initvt(krb5_context context, int maj_ver, int min_ver, + * krb5_plugin_vtable vtable); + * + * The initvt function should: + * + * - Check that the supplied maj_ver number is supported by the module, or + * return KRB5_PLUGIN_VER_NOTSUPP if it is not. + * + * - Cast the vtable pointer as appropriate for maj_ver: + * maj_ver == 1: Cast to kadm5_hook_vftable_1 + * + * - Initialize the methods of the vtable, stopping as appropriate for the + * supplied min_ver. Optional methods may be left uninitialized. + * + * Memory for the vtable is allocated by the caller, not by the module. */ #include <krb5/krb5.h> |