ea90ca8666
This is the second of two commits in a series that must be picked together.
This series of two commits moves parts of lib/krb5/ infrastructure
functionality to lib/base/, leaving behind wrappers.
Some parts of libkrb5 are entirely generic or easily made so, and could
be useful in various parts of Heimdal that are not specific to the krb5
API, such as:
- lib/gssapi/ (especially since the integration of NegoEx)
- lib/hx509/
- bx509d (which should really move out of kdc/)
For the above we need to move these bits of lib/krb5/:
- lib/krb5/config_file.c (all of it, leaving forwardings behind)
- lib/krb5/config_reg.c (all of it)
- lib/krb5/plugin.c (all of it, leaving forwardings behind)
- lib/krb5/log.c (all of it, ditto)
- lib/krb5/heim_err.et (all of it)
And because of those two, these too must also move:
- lib/krb5/expand_path.c (all of it, leaving forwardings behind)
- lib/krb5/warn.c (just the warning functions, ditto)
The changes to the moved files are mostly quite straightforward and are
best reviewed with --word-diff=color.
We're also creating a heim_context and a heim API to go with it. But
it's as thin as possible, with as little state as necessary to enable
this move. Functions for dealing with error messages use callbacks.
Moving plugin.c does have one knock-on effect on all users of the old
krb5 plugin API (which remains), which is that a global search and
replace of struct krb5_plugin_data to struct heim_plugin_data was
needed, though the layout and size of that structure doesn't change, so
the ABI doesn't either.
As well, we now build lib/vers/ and lib/com_err/ before lib/base/ so as
to be able to move lib/krb5/heim_err.et to lib/base/ so that we can make
use of HEIM_ERR_* in lib/base/, specifically in the files that moved.
Once this is all done we'll be able to use config files and plugins in
lib/hx509/, we'll be able to move bx509d out of kdc/, and so on.
Most if not all of the new functions in lib/base/ are Heimdal-private,
thus calling conventions for them are not declared.
Status:
- builds and passes CIs (Travis, Appveyor)
- ran make check-valgrind and no new leaks or other memory errors
- ready for review
HOW TO REVIEW:
$ # Review file moves:
$ git log --stat -n1 HEAD^
$
$ # Review changes to moved files using --word-diff=color
$ git log -p -b -w --word-diff=color HEAD^..HEAD \
lib/base/config_file.c \
lib/base/config_reg.c \
lib/base/expand_path.c \
lib/base/warn.c \
lib/krb5/config_file.c \
lib/krb5/config_reg.c \
lib/krb5/expand_path.c \
lib/krb5/warn.c
$
$ # Review the whole thing, possibly adding -b and/or -w, and
$ # maybe --word-diff=color:
$ git log -p origin/master..HEAD
$ git log -p -b -w origin/master..HEAD
$ git log -p -b -w --word-diff=color origin/master..HEAD
TBD (future commits):
- make lib/gssapi use the new heimbase functions
- move kx509/bx509d common code to lib/hx509/ or other approp. location
- move bx509d out of kdc/
96 lines
3.5 KiB
C
96 lines
3.5 KiB
C
/*
|
|
* Copyright (c) 2006 - 2020 Kungliga Tekniska Högskolan
|
|
* (Royal Institute of Technology, Stockholm, Sweden).
|
|
* All rights reserved.
|
|
*
|
|
* Portions Copyright (c) 2018 AuriStor, Inc.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of the Institute nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef HEIMDAL_BASE_COMMON_PLUGIN_H
|
|
#define HEIMDAL_BASE_COMMON_PLUGIN_H
|
|
|
|
#ifdef _WIN32
|
|
#ifndef HEIM_CALLCONV
|
|
#define HEIM_CALLCONV __stdcall
|
|
#endif
|
|
#ifndef HEIM_LIB_CALL
|
|
#define HEIM_LIB_CALL __stdcall
|
|
#endif
|
|
#else
|
|
#ifndef HEIM_CALLCONV
|
|
#define HEIM_CALLCONV
|
|
#endif
|
|
#ifndef HEIM_LIB_CALL
|
|
#define HEIM_LIB_CALL
|
|
#endif
|
|
#endif
|
|
|
|
/* For krb5 plugins, this is a krb5_context */
|
|
typedef struct heim_pcontext_s *heim_pcontext;
|
|
|
|
/*
|
|
* All plugin function tables extend the following structure.
|
|
*/
|
|
struct heim_plugin_common_ftable_desc {
|
|
int version;
|
|
int (HEIM_LIB_CALL *init)(heim_pcontext, void **);
|
|
void (HEIM_LIB_CALL *fini)(void *);
|
|
};
|
|
typedef struct heim_plugin_common_ftable_desc heim_plugin_common_ftable;
|
|
typedef struct heim_plugin_common_ftable_desc *heim_plugin_common_ftable_p;
|
|
typedef struct heim_plugin_common_ftable_desc * const heim_plugin_common_ftable_cp;
|
|
|
|
typedef int
|
|
(HEIM_CALLCONV heim_plugin_load_ft)(heim_pcontext context,
|
|
heim_get_instance_func_t *func,
|
|
size_t *n_ftables,
|
|
heim_plugin_common_ftable_cp **ftables);
|
|
|
|
typedef heim_plugin_load_ft *heim_plugin_load_t;
|
|
|
|
/* For source backwards-compatibility */
|
|
typedef struct heim_plugin_common_ftable_desc krb5_plugin_common_ftable;
|
|
typedef struct heim_plugin_common_ftable_desc *krb5_plugin_common_ftable_p;
|
|
typedef struct heim_plugin_common_ftable_desc * const krb5_plugin_common_ftable_cp;
|
|
typedef heim_plugin_load_ft krb5_plugin_load_ft;
|
|
typedef heim_plugin_load_ft *krb5_plugin_load_t;
|
|
|
|
/*
|
|
* All plugins must export a function named "<type>_plugin_load" with
|
|
* a signature of:
|
|
*
|
|
* int HEIM_CALLCONV
|
|
* <type>_plugin_load(heim_pcontext context,
|
|
* heim_get_instance_func_t *func,
|
|
* size_t *n_ftables,
|
|
* const heim_plugin_common_ftable *const **ftables);
|
|
*/
|
|
#endif /* HEIMDAL_BASE_COMMON_PLUGIN_H */
|