Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/krb5/certauth_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 /* include/krb5/certauth_plugin.h - certauth plugin header. */
jpayne@69 3 /*
jpayne@69 4 * Copyright (C) 2017 by Red Hat, Inc.
jpayne@69 5 * All rights reserved.
jpayne@69 6 *
jpayne@69 7 * Redistribution and use in source and binary forms, with or without
jpayne@69 8 * modification, are permitted provided that the following conditions
jpayne@69 9 * are met:
jpayne@69 10 *
jpayne@69 11 * * Redistributions of source code must retain the above copyright
jpayne@69 12 * notice, this list of conditions and the following disclaimer.
jpayne@69 13 *
jpayne@69 14 * * Redistributions in binary form must reproduce the above copyright
jpayne@69 15 * notice, this list of conditions and the following disclaimer in
jpayne@69 16 * the documentation and/or other materials provided with the
jpayne@69 17 * distribution.
jpayne@69 18 *
jpayne@69 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
jpayne@69 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
jpayne@69 21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
jpayne@69 22 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
jpayne@69 23 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
jpayne@69 24 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jpayne@69 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
jpayne@69 26 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
jpayne@69 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
jpayne@69 28 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
jpayne@69 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
jpayne@69 30 * OF THE POSSIBILITY OF SUCH DAMAGE.
jpayne@69 31 */
jpayne@69 32
jpayne@69 33 /*
jpayne@69 34 * Declarations for certauth plugin module implementors.
jpayne@69 35 *
jpayne@69 36 * The certauth pluggable interface currently has only one supported major
jpayne@69 37 * version, which is 1. Major version 1 has a current minor version number of
jpayne@69 38 * 1.
jpayne@69 39 *
jpayne@69 40 * certauth plugin modules should define a function named
jpayne@69 41 * certauth_<modulename>_initvt, matching the signature:
jpayne@69 42 *
jpayne@69 43 * krb5_error_code
jpayne@69 44 * certauth_modname_initvt(krb5_context context, int maj_ver, int min_ver,
jpayne@69 45 * krb5_plugin_vtable vtable);
jpayne@69 46 *
jpayne@69 47 * The initvt function should:
jpayne@69 48 *
jpayne@69 49 * - Check that the supplied maj_ver number is supported by the module, or
jpayne@69 50 * return KRB5_PLUGIN_VER_NOTSUPP if it is not.
jpayne@69 51 *
jpayne@69 52 * - Cast the vtable pointer as appropriate for maj_ver:
jpayne@69 53 * maj_ver == 1: Cast to krb5_certauth_vtable
jpayne@69 54 *
jpayne@69 55 * - Initialize the methods of the vtable, stopping as appropriate for the
jpayne@69 56 * supplied min_ver. Optional methods may be left uninitialized.
jpayne@69 57 *
jpayne@69 58 * Memory for the vtable is allocated by the caller, not by the module.
jpayne@69 59 */
jpayne@69 60
jpayne@69 61 #ifndef KRB5_CERTAUTH_PLUGIN_H
jpayne@69 62 #define KRB5_CERTAUTH_PLUGIN_H
jpayne@69 63
jpayne@69 64 #include <krb5/krb5.h>
jpayne@69 65 #include <krb5/plugin.h>
jpayne@69 66
jpayne@69 67 /* Abstract module data type. */
jpayne@69 68 typedef struct krb5_certauth_moddata_st *krb5_certauth_moddata;
jpayne@69 69
jpayne@69 70 /* A module can optionally include <kdb.h> to inspect the client principal
jpayne@69 71 * entry when authorizing a request. */
jpayne@69 72 struct _krb5_db_entry_new;
jpayne@69 73
jpayne@69 74 /*
jpayne@69 75 * Optional: Initialize module data.
jpayne@69 76 */
jpayne@69 77 typedef krb5_error_code
jpayne@69 78 (*krb5_certauth_init_fn)(krb5_context context,
jpayne@69 79 krb5_certauth_moddata *moddata_out);
jpayne@69 80
jpayne@69 81 /*
jpayne@69 82 * Optional: Clean up the module data.
jpayne@69 83 */
jpayne@69 84 typedef void
jpayne@69 85 (*krb5_certauth_fini_fn)(krb5_context context, krb5_certauth_moddata moddata);
jpayne@69 86
jpayne@69 87 /*
jpayne@69 88 * Mandatory: decode cert as an X.509 certificate and determine whether it is
jpayne@69 89 * authorized to authenticate as the requested client principal princ using
jpayne@69 90 * PKINIT. Return 0 or KRB5_CERTAUTH_HWAUTH if the certificate is authorized.
jpayne@69 91 * Otherwise return one of the following error codes:
jpayne@69 92 *
jpayne@69 93 * - KRB5KDC_ERR_CLIENT_NAME_MISMATCH - incorrect SAN value
jpayne@69 94 * - KRB5KDC_ERR_INCONSISTENT_KEY_PURPOSE - incorrect EKU
jpayne@69 95 * - KRB5KDC_ERR_CERTIFICATE_MISMATCH - other extension error
jpayne@69 96 * - KRB5_PLUGIN_NO_HANDLE or KRB5_CERTAUTH_HWAUTH_PASS - the module has no
jpayne@69 97 * opinion about whether cert is authorized
jpayne@69 98 *
jpayne@69 99 * Returning KRB5_CERTAUTH_HWAUTH will authorize the PKINIT authentication and
jpayne@69 100 * cause the hw-authent flag to be set in the issued ticket (new in release
jpayne@69 101 * 1.19). Returning KRB5_CERTAUTH_HWAUTH_PASS does not authorize the PKINIT
jpayne@69 102 * authentication, but causes the hw-authent flag to be set if another module
jpayne@69 103 * authorizes it (new in release 1.20)
jpayne@69 104 *
jpayne@69 105 * - opts is used by built-in modules to receive internal data, and must be
jpayne@69 106 * ignored by other modules.
jpayne@69 107 * - db_entry receives the client principal database entry, and can be ignored
jpayne@69 108 * by modules that do not link with libkdb5.
jpayne@69 109 * - *authinds_out optionally returns a null-terminated list of authentication
jpayne@69 110 * indicator strings upon KRB5_PLUGIN_NO_HANDLE or accepted authorization.
jpayne@69 111 */
jpayne@69 112 typedef krb5_error_code
jpayne@69 113 (*krb5_certauth_authorize_fn)(krb5_context context,
jpayne@69 114 krb5_certauth_moddata moddata,
jpayne@69 115 const uint8_t *cert, size_t cert_len,
jpayne@69 116 krb5_const_principal princ, const void *opts,
jpayne@69 117 const struct _krb5_db_entry_new *db_entry,
jpayne@69 118 char ***authinds_out);
jpayne@69 119
jpayne@69 120 /*
jpayne@69 121 * Free indicators allocated by a module. Mandatory if authorize returns
jpayne@69 122 * authentication indicators.
jpayne@69 123 */
jpayne@69 124 typedef void
jpayne@69 125 (*krb5_certauth_free_indicator_fn)(krb5_context context,
jpayne@69 126 krb5_certauth_moddata moddata,
jpayne@69 127 char **authinds);
jpayne@69 128
jpayne@69 129 typedef struct krb5_certauth_vtable_st {
jpayne@69 130 const char *name;
jpayne@69 131 krb5_certauth_init_fn init;
jpayne@69 132 krb5_certauth_fini_fn fini;
jpayne@69 133 krb5_certauth_authorize_fn authorize;
jpayne@69 134 krb5_certauth_free_indicator_fn free_ind;
jpayne@69 135 } *krb5_certauth_vtable;
jpayne@69 136
jpayne@69 137 #endif /* KRB5_CERTAUTH_PLUGIN_H */