Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/krb5/localauth_plugin.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
jpayne@69 2 /*
jpayne@69 3 * Copyright (C) 2013 by the Massachusetts Institute of Technology.
jpayne@69 4 * All rights reserved.
jpayne@69 5 *
jpayne@69 6 * Redistribution and use in source and binary forms, with or without
jpayne@69 7 * modification, are permitted provided that the following conditions
jpayne@69 8 * are met:
jpayne@69 9 *
jpayne@69 10 * * Redistributions of source code must retain the above copyright
jpayne@69 11 * notice, this list of conditions and the following disclaimer.
jpayne@69 12 *
jpayne@69 13 * * Redistributions in binary form must reproduce the above copyright
jpayne@69 14 * notice, this list of conditions and the following disclaimer in
jpayne@69 15 * the documentation and/or other materials provided with the
jpayne@69 16 * distribution.
jpayne@69 17 *
jpayne@69 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
jpayne@69 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
jpayne@69 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
jpayne@69 21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
jpayne@69 22 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
jpayne@69 23 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jpayne@69 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
jpayne@69 25 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
jpayne@69 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
jpayne@69 27 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
jpayne@69 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
jpayne@69 29 * OF THE POSSIBILITY OF SUCH DAMAGE.
jpayne@69 30 */
jpayne@69 31
jpayne@69 32 /*
jpayne@69 33 * Declarations for localauth plugin module implementors.
jpayne@69 34 *
jpayne@69 35 * The localauth pluggable interface currently has only one supported major
jpayne@69 36 * version, which is 1. Major version 1 has a current minor version number of
jpayne@69 37 * 1.
jpayne@69 38 *
jpayne@69 39 * Localauth plugin modules should define a function named
jpayne@69 40 * localauth_<modulename>_initvt, matching the signature:
jpayne@69 41 *
jpayne@69 42 * krb5_error_code
jpayne@69 43 * localauth_modname_initvt(krb5_context context, int maj_ver, int min_ver,
jpayne@69 44 * krb5_plugin_vtable vtable);
jpayne@69 45 *
jpayne@69 46 * The initvt function should:
jpayne@69 47 *
jpayne@69 48 * - Check that the supplied maj_ver number is supported by the module, or
jpayne@69 49 * return KRB5_PLUGIN_VER_NOTSUPP if it is not.
jpayne@69 50 *
jpayne@69 51 * - Cast the vtable pointer as appropriate for maj_ver:
jpayne@69 52 * maj_ver == 1: Cast to krb5_localauth_vtable
jpayne@69 53 *
jpayne@69 54 * - Initialize the methods of the vtable, stopping as appropriate for the
jpayne@69 55 * supplied min_ver. Optional methods may be left uninitialized.
jpayne@69 56 *
jpayne@69 57 * Memory for the vtable is allocated by the caller, not by the module.
jpayne@69 58 */
jpayne@69 59
jpayne@69 60 #ifndef KRB5_LOCALAUTH_PLUGIN_H
jpayne@69 61 #define KRB5_LOCALAUTH_PLUGIN_H
jpayne@69 62
jpayne@69 63 #include <krb5/krb5.h>
jpayne@69 64 #include <krb5/plugin.h>
jpayne@69 65
jpayne@69 66 /* An abstract type for localauth module data. */
jpayne@69 67 typedef struct krb5_localauth_moddata_st *krb5_localauth_moddata;
jpayne@69 68
jpayne@69 69 /*** Method type declarations ***/
jpayne@69 70
jpayne@69 71 /* Optional: Initialize module data. */
jpayne@69 72 typedef krb5_error_code
jpayne@69 73 (*krb5_localauth_init_fn)(krb5_context context,
jpayne@69 74 krb5_localauth_moddata *data);
jpayne@69 75
jpayne@69 76 /* Optional: Release resources used by module data. */
jpayne@69 77 typedef void
jpayne@69 78 (*krb5_localauth_fini_fn)(krb5_context context, krb5_localauth_moddata data);
jpayne@69 79
jpayne@69 80 /*
jpayne@69 81 * Optional: Determine whether aname is authorized to log in as the local
jpayne@69 82 * account lname. Return 0 if aname is authorized, EPERM if aname is
jpayne@69 83 * authoritatively not authorized, KRB5_PLUGIN_NO_HANDLE if the module cannot
jpayne@69 84 * determine whether aname is authorized, and any other error code for a
jpayne@69 85 * serious failure to process the request. aname will be considered authorized
jpayne@69 86 * if at least one module returns 0 and all other modules return
jpayne@69 87 * KRB5_PLUGIN_NO_HANDLE.
jpayne@69 88 */
jpayne@69 89 typedef krb5_error_code
jpayne@69 90 (*krb5_localauth_userok_fn)(krb5_context context, krb5_localauth_moddata data,
jpayne@69 91 krb5_const_principal aname, const char *lname);
jpayne@69 92
jpayne@69 93 /*
jpayne@69 94 * Optional (mandatory if an2ln_types is set): Determine the local account name
jpayne@69 95 * corresponding to aname. Return 0 and set *lname_out if a mapping can be
jpayne@69 96 * determined; the contents of *lname_out will later be released with a call to
jpayne@69 97 * the module's free_string method. Return KRB5_LNAME_NOTRANS if no mapping
jpayne@69 98 * can be determined. Return any other error code for a serious failure to
jpayne@69 99 * process the request; this will halt the krb5_aname_to_localname operation.
jpayne@69 100 *
jpayne@69 101 * If the module's an2ln_types field is set, this method will only be invoked
jpayne@69 102 * when a profile "auth_to_local" value references one of the module's types.
jpayne@69 103 * type and residual will be set to the type and residual of the auth_to_local
jpayne@69 104 * value.
jpayne@69 105 *
jpayne@69 106 * If the module's an2ln_types field is not set but the an2ln method is
jpayne@69 107 * implemented, this method will be invoked independently of the profile's
jpayne@69 108 * auth_to_local settings, with type and residual set to NULL. If multiple
jpayne@69 109 * modules are registered with an2ln methods but no an2ln_types field, the
jpayne@69 110 * order of invocation is not defined, but all such modules will be consulted
jpayne@69 111 * before the built-in mechanisms are tried.
jpayne@69 112 */
jpayne@69 113 typedef krb5_error_code
jpayne@69 114 (*krb5_localauth_an2ln_fn)(krb5_context context, krb5_localauth_moddata data,
jpayne@69 115 const char *type, const char *residual,
jpayne@69 116 krb5_const_principal aname, char **lname_out);
jpayne@69 117
jpayne@69 118 /*
jpayne@69 119 * Optional (mandatory if an2ln is implemented): Release the memory returned by
jpayne@69 120 * an invocation of an2ln.
jpayne@69 121 */
jpayne@69 122 typedef void
jpayne@69 123 (*krb5_localauth_free_string_fn)(krb5_context context,
jpayne@69 124 krb5_localauth_moddata data, char *str);
jpayne@69 125
jpayne@69 126 /* localauth vtable for major version 1. */
jpayne@69 127 typedef struct krb5_localauth_vtable_st {
jpayne@69 128 const char *name; /* Mandatory: name of module. */
jpayne@69 129 const char **an2ln_types; /* Optional: uppercase auth_to_local types */
jpayne@69 130 krb5_localauth_init_fn init;
jpayne@69 131 krb5_localauth_fini_fn fini;
jpayne@69 132 krb5_localauth_userok_fn userok;
jpayne@69 133 krb5_localauth_an2ln_fn an2ln;
jpayne@69 134 krb5_localauth_free_string_fn free_string;
jpayne@69 135 /* Minor version 1 ends here. */
jpayne@69 136 } *krb5_localauth_vtable;
jpayne@69 137
jpayne@69 138 #endif /* KRB5_LOCALAUTH_PLUGIN_H */