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/
331 lines
9.1 KiB
C
331 lines
9.1 KiB
C
/*
|
|
* Copyright (c) 1997 - 2001 Kungliga Tekniska Högskolan
|
|
* (Royal Institute of Technology, Stockholm, Sweden).
|
|
* All rights reserved.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#if defined(_MSC_VER)
|
|
# pragma warning(disable: 4646)
|
|
# pragma warning(disable: 4716)
|
|
#endif
|
|
|
|
#include "krb5_locl.h"
|
|
#include <err.h>
|
|
|
|
static krb5_error_code _warnerr(krb5_context context, int do_errtext,
|
|
krb5_error_code code, int level, const char *fmt, va_list ap)
|
|
__attribute__ ((__format__ (__printf__, 5, 0)));
|
|
|
|
static krb5_error_code
|
|
_warnerr(krb5_context context, int do_errtext,
|
|
krb5_error_code code, int level, const char *fmt, va_list ap)
|
|
{
|
|
if (do_errtext)
|
|
return heim_vwarn(context ? context->hcontext : NULL, code, fmt, ap);
|
|
else
|
|
return heim_vwarnx(context ? context->hcontext : NULL, fmt, ap);
|
|
}
|
|
|
|
#define FUNC_NORET(ETEXT, CODE, LEVEL) \
|
|
va_list ap; \
|
|
va_start(ap, fmt); \
|
|
(void) _warnerr(context, ETEXT, CODE, LEVEL, fmt, ap); \
|
|
va_end(ap);
|
|
|
|
#undef __attribute__
|
|
#define __attribute__(X)
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include the error from
|
|
* the last failure.
|
|
*
|
|
* @param context A Kerberos 5 context.
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
* @param ap arguments
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_vwarn(krb5_context context, krb5_error_code code,
|
|
const char *fmt, va_list ap)
|
|
__attribute__ ((__format__ (__printf__, 3, 0)))
|
|
{
|
|
return heim_vwarn(context ? context->hcontext : NULL, code, fmt, ap);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include the error from
|
|
* the last failure.
|
|
*
|
|
* @param context A Kerberos 5 context.
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_warn(krb5_context context, krb5_error_code code, const char *fmt, ...)
|
|
__attribute__ ((__format__ (__printf__, 3, 4)))
|
|
{
|
|
krb5_error_code ret;
|
|
va_list ap;
|
|
|
|
va_start(ap, fmt);
|
|
ret = krb5_vwarn(context, code, fmt, ap);
|
|
va_end(ap);
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr.
|
|
*
|
|
* @param context A Kerberos 5 context.
|
|
* @param fmt message to print
|
|
* @param ap arguments
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_vwarnx(krb5_context context, const char *fmt, va_list ap)
|
|
__attribute__ ((__format__ (__printf__, 2, 0)))
|
|
{
|
|
return heim_vwarnx(context ? context->hcontext : NULL, fmt, ap);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr.
|
|
*
|
|
* @param context A Kerberos 5 context.
|
|
* @param fmt message to print
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_warnx(krb5_context context, const char *fmt, ...)
|
|
__attribute__ ((__format__ (__printf__, 2, 3)))
|
|
{
|
|
krb5_error_code ret;
|
|
va_list ap;
|
|
|
|
va_start(ap, fmt);
|
|
ret = krb5_vwarnx(context, fmt, ap);
|
|
va_end(ap);
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include bthe error from
|
|
* the last failure and then exit.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param eval the exit code to exit with
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
* @param ap arguments
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_verr(krb5_context context, int eval, krb5_error_code code,
|
|
const char *fmt, va_list ap)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 4, 0)))
|
|
{
|
|
_warnerr(context, 1, code, 0, fmt, ap);
|
|
exit(eval);
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include bthe error from
|
|
* the last failure and then exit.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param eval the exit code to exit with
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_err(krb5_context context, int eval, krb5_error_code code,
|
|
const char *fmt, ...)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 4, 5)))
|
|
{
|
|
FUNC_NORET(1, code, 0);
|
|
exit(eval);
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, and then exit.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param eval the exit code to exit with
|
|
* @param fmt message to print
|
|
* @param ap arguments
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_verrx(krb5_context context, int eval, const char *fmt, va_list ap)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 3, 0)))
|
|
{
|
|
_warnerr(context, 0, 0, 0, fmt, ap);
|
|
exit(eval);
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, and then exit.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param eval the exit code to exit with
|
|
* @param fmt message to print
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_errx(krb5_context context, int eval, const char *fmt, ...)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 3, 4)))
|
|
{
|
|
FUNC_NORET(0, 0, 0);
|
|
exit(eval);
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include bthe error from
|
|
* the last failure and then abort.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
* @param ap arguments
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_vabort(krb5_context context, krb5_error_code code,
|
|
const char *fmt, va_list ap)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 3, 0)))
|
|
{
|
|
_warnerr(context, 1, code, 0, fmt, ap);
|
|
abort();
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, include the error from
|
|
* the last failure and then abort.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param code error code of the last error
|
|
* @param fmt message to print
|
|
* @param ... arguments for format string
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_abort(krb5_context context, krb5_error_code code, const char *fmt, ...)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 3, 4)))
|
|
{
|
|
FUNC_NORET(1, code, 0);
|
|
abort();
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_vabortx(krb5_context context, const char *fmt, va_list ap)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 2, 0)))
|
|
{
|
|
_warnerr(context, 0, 0, 0, fmt, ap);
|
|
abort();
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Log a warning to the log, default stderr, and then abort.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param fmt printf format string of message to print
|
|
* @param ... arguments for format string
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_NORETURN_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_abortx(krb5_context context, const char *fmt, ...)
|
|
__attribute__ ((__noreturn__, __format__ (__printf__, 2, 3)))
|
|
{
|
|
FUNC_NORET(0, 0, 0);
|
|
abort();
|
|
UNREACHABLE(return 0);
|
|
}
|
|
|
|
/**
|
|
* Set the default logging facility.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
* @param fac Facility to use for logging.
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
|
|
krb5_set_warn_dest(krb5_context context, krb5_log_facility *fac)
|
|
{
|
|
return heim_set_warn_dest(context->hcontext, fac);
|
|
}
|
|
|
|
/**
|
|
* Get the default logging facility.
|
|
*
|
|
* @param context A Kerberos 5 context
|
|
*
|
|
* @ingroup krb5_error
|
|
*/
|
|
|
|
KRB5_LIB_FUNCTION krb5_log_facility * KRB5_LIB_CALL
|
|
krb5_get_warn_dest(krb5_context context)
|
|
{
|
|
return heim_get_warn_dest(context->hcontext);
|
|
}
|