oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

Move some infra bits of lib/krb5/ to lib/base/ (2)

Browse Source 
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/
This commit is contained in:
Nicolas Williams
2020-02-24 18:50:01 -06:00
parent b2823cbd74
commit ea90ca8666
51 changed files with 3886 additions and 1962 deletions
Download Patch File Download Diff File Expand all files Collapse all files

244
lib/base/warn.c
View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 1997 - 2001 Kungliga Tekniska Högskolan
* Copyright (c) 1997 - 2020 Kungliga Tekniska Högskolan
* (Royal Institute of Technology, Stockholm, Sweden).
* All rights reserved.
*
@@ -36,22 +36,22 @@
# pragma warning(disable: 4716)
#endif
#include "krb5_locl.h"
#include "baselocl.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)
static heim_error_code _warnerr(heim_context context, int do_errtext,
heim_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)
static heim_error_code
_warnerr(heim_context context, int do_errtext,
heim_error_code code, int level, const char *fmt, va_list ap)
{
char xfmt[7] = "";
const char *args[2], **arg;
char *msg = NULL;
const char *err_str = NULL;
krb5_error_code ret;
heim_error_code ret;
args[0] = args[1] = NULL;
arg = args;
@@ -64,10 +64,10 @@ _warnerr(krb5_context context, int do_errtext,
return ENOMEM;
*arg++ = msg;
}
if(context && do_errtext){
if (context && do_errtext) {
strlcat(xfmt, "%s", sizeof(xfmt));
err_str = krb5_get_error_message(context, code);
err_str = heim_get_error_message(context, code);
if (err_str != NULL) {
*arg = err_str;
} else {
@@ -75,28 +75,23 @@ _warnerr(krb5_context context, int do_errtext,
}
}
if(context && context->warn_dest)
krb5_log(context, context->warn_dest, level, xfmt, args[0], args[1]);
if (context && heim_get_warn_dest(context))
heim_log(context, heim_get_warn_dest(context), level, xfmt, args[0],
args[1]);
else
warnx(xfmt, args[0], args[1]);
free(msg);
krb5_free_error_message(context, err_str);
heim_free_error_message(context, err_str);
return 0;
}
#define FUNC(ETEXT, CODE, LEVEL) \
krb5_error_code ret; \
heim_error_code ret; \
va_list ap; \
va_start(ap, fmt); \
ret = _warnerr(context, ETEXT, CODE, LEVEL, fmt, ap); \
va_end(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)
@@ -109,11 +104,11 @@ _warnerr(krb5_context context, int do_errtext,
* @param fmt message to print
* @param ap arguments
*
* @ingroup krb5_error
* @ingroup heim_error
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_vwarn(krb5_context context, krb5_error_code code,
heim_error_code
heim_vwarn(heim_context context, heim_error_code code,
const char *fmt, va_list ap)
__attribute__ ((__format__ (__printf__, 3, 0)))
{
@@ -128,11 +123,11 @@ krb5_vwarn(krb5_context context, krb5_error_code code,
* @param code error code of the last error
* @param fmt message to print
*
* @ingroup krb5_error
* @ingroup heim_error
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_warn(krb5_context context, krb5_error_code code, const char *fmt, ...)
heim_error_code
heim_warn(heim_context context, heim_error_code code, const char *fmt, ...)
__attribute__ ((__format__ (__printf__, 3, 4)))
{
FUNC(1, code, 1);
@@ -146,11 +141,11 @@ krb5_warn(krb5_context context, krb5_error_code code, const char *fmt, ...)
* @param fmt message to print
* @param ap arguments
*
* @ingroup krb5_error
* @ingroup heim_error
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_vwarnx(krb5_context context, const char *fmt, va_list ap)
heim_error_code
heim_vwarnx(heim_context context, const char *fmt, va_list ap)
__attribute__ ((__format__ (__printf__, 2, 0)))
{
return _warnerr(context, 0, 0, 1, fmt, ap);
@@ -162,198 +157,13 @@ krb5_vwarnx(krb5_context context, const char *fmt, va_list ap)
* @param context A Kerberos 5 context.
* @param fmt message to print
*
* @ingroup krb5_error
* @ingroup heim_error
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_warnx(krb5_context context, const char *fmt, ...)
heim_error_code
heim_warnx(heim_context context, const char *fmt, ...)
__attribute__ ((__format__ (__printf__, 2, 3)))
{
FUNC(0, 0, 1);
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)
{
context->warn_dest = fac;
return 0;
}
/**
* 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 context->warn_dest;
}