include/krb5/locate_plugin.h

0001 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
0002 /*
0003  * Copyright 2006 Massachusetts Institute of Technology.
0004  * All Rights Reserved.
0005  *
0006  * Export of this software from the United States of America may
0007  *   require a specific license from the United States Government.
0008  *   It is the responsibility of any person or organization contemplating
0009  *   export to obtain such a license before exporting.
0010  *
0011  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
0012  * distribute this software and its documentation for any purpose and
0013  * without fee is hereby granted, provided that the above copyright
0014  * notice appear in all copies and that both that copyright notice and
0015  * this permission notice appear in supporting documentation, and that
0016  * the name of M.I.T. not be used in advertising or publicity pertaining
0017  * to distribution of the software without specific, written prior
0018  * permission.  Furthermore if you modify this software you must label
0019  * your software as modified software and not distribute it in such a
0020  * fashion that it might be confused with the original M.I.T. software.
0021  * M.I.T. makes no representations about the suitability of
0022  * this software for any purpose.  It is provided "as is" without express
0023  * or implied warranty.
0024  */
0025
0026 /*
0027  *
0028  * Service location plugin definitions for Kerberos 5.
0029  */
0030
0031 #ifndef KRB5_LOCATE_PLUGIN_H_INCLUDED
0032 #define KRB5_LOCATE_PLUGIN_H_INCLUDED
0033 #include <krb5/krb5.h>
0034
0035 enum locate_service_type {
0036     locate_service_kdc = 1,
0037     locate_service_primary_kdc,
0038     locate_service_kadmin,
0039     locate_service_krb524,
0040     locate_service_kpasswd
0041 };
0042 #define locate_service_master_kdc locate_service_primary_kdc
0043
0044 typedef struct krb5plugin_service_locate_ftable {
0045     int minor_version;          /* currently 0 */
0046     /* Per-context setup and teardown.  Returned void* blob is
0047        private to the plugin.  */
0048     krb5_error_code (*init)(krb5_context, void **);
0049     void (*fini)(void *);
0050     /* Callback function returns non-zero if the plugin function
0051        should quit and return; this may be because of an error, or may
0052        indicate we've already contacted the service, whatever.  The
0053        lookup function should only return an error if it detects a
0054        problem, not if the callback function tells it to quit.  */
0055     krb5_error_code (*lookup)(void *,
0056                               enum locate_service_type svc, const char *realm,
0057                               int socktype, int family,
0058                               int (*cbfunc)(void *,int,struct sockaddr *),
0059                               void *cbdata);
0060 } krb5plugin_service_locate_ftable;
0061 /* extern krb5plugin_service_locate_ftable service_locator; */
0062 #endif