jpayne@69: /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */ jpayne@69: /* jpayne@69: * Copyright (C) 2013 by the Massachusetts Institute of Technology. jpayne@69: * All rights reserved. jpayne@69: * jpayne@69: * Redistribution and use in source and binary forms, with or without jpayne@69: * modification, are permitted provided that the following conditions jpayne@69: * are met: jpayne@69: * jpayne@69: * * Redistributions of source code must retain the above copyright jpayne@69: * notice, this list of conditions and the following disclaimer. jpayne@69: * jpayne@69: * * Redistributions in binary form must reproduce the above copyright jpayne@69: * notice, this list of conditions and the following disclaimer in jpayne@69: * the documentation and/or other materials provided with the jpayne@69: * distribution. jpayne@69: * jpayne@69: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS jpayne@69: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT jpayne@69: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS jpayne@69: * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE jpayne@69: * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, jpayne@69: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES jpayne@69: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR jpayne@69: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) jpayne@69: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, jpayne@69: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) jpayne@69: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED jpayne@69: * OF THE POSSIBILITY OF SUCH DAMAGE. jpayne@69: */ jpayne@69: jpayne@69: /* jpayne@69: * Declarations for hostrealm plugin module implementors. jpayne@69: * jpayne@69: * The hostrealm pluggable interface currently has only one supported major jpayne@69: * version, which is 1. Major version 1 has a current minor version number of jpayne@69: * 1. jpayne@69: * jpayne@69: * Hostrealm plugin modules should define a function named jpayne@69: * hostrealm__initvt, matching the signature: jpayne@69: * jpayne@69: * krb5_error_code jpayne@69: * hostrealm_modname_initvt(krb5_context context, int maj_ver, int min_ver, jpayne@69: * krb5_plugin_vtable vtable); jpayne@69: * jpayne@69: * The initvt function should: jpayne@69: * jpayne@69: * - Check that the supplied maj_ver number is supported by the module, or jpayne@69: * return KRB5_PLUGIN_VER_NOTSUPP if it is not. jpayne@69: * jpayne@69: * - Cast the vtable pointer as appropriate for maj_ver: jpayne@69: * maj_ver == 1: Cast to krb5_hostrealm_vtable jpayne@69: * jpayne@69: * - Initialize the methods of the vtable, stopping as appropriate for the jpayne@69: * supplied min_ver. Optional methods may be left uninitialized. jpayne@69: * jpayne@69: * Memory for the vtable is allocated by the caller, not by the module. jpayne@69: */ jpayne@69: jpayne@69: #ifndef KRB5_HOSTREALM_PLUGIN_H jpayne@69: #define KRB5_HOSTREALM_PLUGIN_H jpayne@69: jpayne@69: #include jpayne@69: #include jpayne@69: jpayne@69: /* An abstract type for hostrealm module data. */ jpayne@69: typedef struct krb5_hostrealm_moddata_st *krb5_hostrealm_moddata; jpayne@69: jpayne@69: /*** Method type declarations ***/ jpayne@69: jpayne@69: /* Optional: Initialize module data. */ jpayne@69: typedef krb5_error_code jpayne@69: (*krb5_hostrealm_init_fn)(krb5_context context, jpayne@69: krb5_hostrealm_moddata *data); jpayne@69: jpayne@69: /* jpayne@69: * Optional: Determine the possible realms of a hostname, using only secure, jpayne@69: * authoritative mechanisms (ones which should be used prior to trying jpayne@69: * referrals when getting a service ticket). Return success with a jpayne@69: * null-terminated list of realms in *realms_out, KRB5_PLUGIN_NO_HANDLE to jpayne@69: * defer to later modules, or another error to terminate processing. jpayne@69: */ jpayne@69: typedef krb5_error_code jpayne@69: (*krb5_hostrealm_host_realm_fn)(krb5_context context, jpayne@69: krb5_hostrealm_moddata data, jpayne@69: const char *host, char ***realms_out); jpayne@69: jpayne@69: /* jpayne@69: * Optional: Determine the possible realms of a hostname, using heuristic or jpayne@69: * less secure mechanisms (ones which should be used after trying referrals jpayne@69: * when getting a service ticket). Return success with a null-terminated list jpayne@69: * of realms in *realms_out, KRB5_PLUGIN_NO_HANDLE to defer to later modules, jpayne@69: * or another error to terminate processing. jpayne@69: */ jpayne@69: typedef krb5_error_code jpayne@69: (*krb5_hostrealm_fallback_realm_fn)(krb5_context context, jpayne@69: krb5_hostrealm_moddata data, jpayne@69: const char *host, char ***realms_out); jpayne@69: jpayne@69: /* jpayne@69: * Optional: Determine the possible default realms of the local host. Return jpayne@69: * success with a null-terminated list of realms in *realms_out, jpayne@69: * KRB5_PLUGIN_NO_HANDLE to defer to later modules, or another error to jpayne@69: * terminate processing. jpayne@69: */ jpayne@69: typedef krb5_error_code jpayne@69: (*krb5_hostrealm_default_realm_fn)(krb5_context context, jpayne@69: krb5_hostrealm_moddata data, jpayne@69: char ***realms_out); jpayne@69: jpayne@69: /* jpayne@69: * Mandatory (if any of the query methods are implemented): Release the memory jpayne@69: * returned by one of the interface methods. jpayne@69: */ jpayne@69: typedef void jpayne@69: (*krb5_hostrealm_free_list_fn)(krb5_context context, jpayne@69: krb5_hostrealm_moddata data, char **list); jpayne@69: jpayne@69: /* Optional: Release resources used by module data. */ jpayne@69: typedef void jpayne@69: (*krb5_hostrealm_fini_fn)(krb5_context context, krb5_hostrealm_moddata data); jpayne@69: jpayne@69: /* hostrealm vtable for major version 1. */ jpayne@69: typedef struct krb5_hostrealm_vtable_st { jpayne@69: const char *name; /* Mandatory: name of module. */ jpayne@69: krb5_hostrealm_init_fn init; jpayne@69: krb5_hostrealm_fini_fn fini; jpayne@69: krb5_hostrealm_host_realm_fn host_realm; jpayne@69: krb5_hostrealm_fallback_realm_fn fallback_realm; jpayne@69: krb5_hostrealm_default_realm_fn default_realm; jpayne@69: krb5_hostrealm_free_list_fn free_list; jpayne@69: /* Minor version 1 ends here. */ jpayne@69: } *krb5_hostrealm_vtable; jpayne@69: jpayne@69: #endif /* KRB5_HOSTREALM_PLUGIN_H */