oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity
Files
afc9ebe08b84b9b8ea9077b678d3cd5e99c3d1f7
heimdal/lib/krb5/config_file.c
Nicolas Williams ea90ca8666 Move some infra bits of lib/krb5/ to lib/base/ (2) 
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/
2020-03-02 10:56:13 -06:00

692 lines
20 KiB
C
Raw Blame History

/*
* Copyright (c) 1997 - 2004 Kungliga Tekniska Högskolan
* (Royal Institute of Technology, Stockholm, Sweden).
* All rights reserved.
*
* Portions Copyright (c) 2009 Apple Inc. 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.
*/
#include "krb5_locl.h"
#if defined(HAVE_FRAMEWORK_COREFOUNDATION)
#include <CoreFoundation/CoreFoundation.h>
#endif
/**
* Parse configuration files in the given directory and add the result
* into res. Only files whose names consist only of alphanumeric
* characters, hyphen, and underscore, will be parsed, though files
* ending in ".conf" will also be parsed.
*
* This interface can be used to parse several configuration directories
* into one resulting krb5_config_section by calling it repeatably.
*
* @param context a Kerberos 5 context.
* @param dname a directory name to a Kerberos configuration file
* @param res the returned result, must be free with krb5_free_config_files().
* @return Return an error code or 0, see krb5_get_error_message().
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_config_parse_dir_multi(krb5_context context,
const char *dname,
krb5_config_section **res)
{
krb5_error_code ret;
if ((ret = heim_config_parse_dir_multi(context->hcontext, dname,
res)) == HEIM_ERR_CONFIG_BADFORMAT)
return KRB5_CONFIG_BADFORMAT;
return ret;
}
/**
* Parse a configuration file and add the result into res. This
* interface can be used to parse several configuration files into one
* resulting krb5_config_section by calling it repeatably.
*
* @param context a Kerberos 5 context.
* @param fname a file name to a Kerberos configuration file
* @param res the returned result, must be free with krb5_free_config_files().
* @return Return an error code or 0, see krb5_get_error_message().
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_config_parse_file_multi(krb5_context context,
const char *fname,
krb5_config_section **res)
{
krb5_error_code ret;
if ((ret = heim_config_parse_file_multi(context->hcontext, fname,
res)) == HEIM_ERR_CONFIG_BADFORMAT)
return KRB5_CONFIG_BADFORMAT;
return ret;
}
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_config_parse_file(krb5_context context,
const char *fname,
krb5_config_section **res)
{
*res = NULL;
return krb5_config_parse_file_multi(context, fname, res);
}
/**
* Free configuration file section, the result of
* krb5_config_parse_file() and krb5_config_parse_file_multi().
*
* @param context A Kerberos 5 context
* @param s the configuration section to free
*
* @return returns 0 on successes, otherwise an error code, see
* krb5_get_error_message()
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_config_file_free(krb5_context context, krb5_config_section *s)
{
return heim_config_file_free(context->hcontext, s);
}
#ifndef HEIMDAL_SMALLER
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
_krb5_config_copy(krb5_context context,
krb5_config_section *c,
krb5_config_section **head)
{
return heim_config_copy(context->hcontext, c, head);
}
#endif /* HEIMDAL_SMALLER */
KRB5_LIB_FUNCTION const void * KRB5_LIB_CALL
_krb5_config_get_next(krb5_context context,
const krb5_config_section *c,
const krb5_config_binding **pointer,
int type,
...)
{
const char *ret;
va_list args;
va_start(args, type);
ret = heim_config_vget_next(context->hcontext, c ? c : context->cf,
pointer, type, args);
va_end(args);
return ret;
}
KRB5_LIB_FUNCTION const void * KRB5_LIB_CALL
_krb5_config_vget_next(krb5_context context,
const krb5_config_section *c,
const krb5_config_binding **pointer,
int type,
va_list args)
{
return heim_config_vget_next(context->hcontext, c ? c : context->cf,
pointer, type, args);
}
KRB5_LIB_FUNCTION const void * KRB5_LIB_CALL
_krb5_config_get(krb5_context context,
const krb5_config_section *c,
int type,
...)
{
const void *ret;
va_list args;
va_start(args, type);
ret = heim_config_vget(context->hcontext, c ? c : context->cf, type, args);
va_end(args);
return ret;
}
KRB5_LIB_FUNCTION const void * KRB5_LIB_CALL
_krb5_config_vget(krb5_context context,
const krb5_config_section *c,
int type,
va_list args)
{
return heim_config_vget(context->hcontext, c ? c : context->cf, type, args);
}
/**
* Get a list of configuration binding list for more processing
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param ... a list of names, terminated with NULL.
*
* @return NULL if configuration list is not found, a list otherwise
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const krb5_config_binding * KRB5_LIB_CALL
krb5_config_get_list(krb5_context context,
const krb5_config_section *c,
...)
{
const krb5_config_binding *ret;
va_list args;
va_start(args, c);
ret = heim_config_vget_list(context->hcontext, c ? c : context->cf, args);
va_end(args);
return ret;
}
/**
* Get a list of configuration binding list for more processing
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param args a va_list of arguments
*
* @return NULL if configuration list is not found, a list otherwise
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const krb5_config_binding * KRB5_LIB_CALL
krb5_config_vget_list(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_list(context->hcontext, c ? c : context->cf, args);
}
/**
* Returns a "const char *" to a string in the configuration database.
* The string may not be valid after a reload of the configuration
* database so a caller should make a local copy if it needs to keep
* the string.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param ... a list of names, terminated with NULL.
*
* @return NULL if configuration string not found, a string otherwise
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_config_get_string(krb5_context context,
const krb5_config_section *c,
...)
{
const char *ret;
va_list args;
va_start(args, c);
ret = heim_config_vget_string(context->hcontext, c ? c : context->cf,
args);
va_end(args);
return ret;
}
/**
* Like krb5_config_get_string(), but uses a va_list instead of ...
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param args a va_list of arguments
*
* @return NULL if configuration string not found, a string otherwise
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_config_vget_string(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_string(context->hcontext, c ? c : context->cf,
args);
}
/**
* Like krb5_config_vget_string(), but instead of returning NULL,
* instead return a default value.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param args a va_list of arguments
*
* @return a configuration string
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_config_vget_string_default(krb5_context context,
const krb5_config_section *c,
const char *def_value,
va_list args)
{
return heim_config_vget_string_default(context->hcontext,
c ? c : context->cf, def_value,
args);
}
/**
* Like krb5_config_get_string(), but instead of returning NULL,
* instead return a default value.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param ... a list of names, terminated with NULL.
*
* @return a configuration string
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL
krb5_config_get_string_default(krb5_context context,
const krb5_config_section *c,
const char *def_value,
...)
{
const char *ret;
va_list args;
va_start(args, def_value);
ret = heim_config_vget_string_default(context->hcontext,
c ? c : context->cf, def_value,
args);
va_end(args);
return ret;
}
/**
* Get a list of configuration strings, free the result with
* krb5_config_free_strings().
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param args a va_list of arguments
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION char ** KRB5_LIB_CALL
krb5_config_vget_strings(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_strings(context->hcontext,
c ? c : context->cf, args);
}
/**
* Get a list of configuration strings, free the result with
* krb5_config_free_strings().
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param ... a list of names, terminated with NULL.
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION char** KRB5_LIB_CALL
krb5_config_get_strings(krb5_context context,
const krb5_config_section *c,
...)
{
va_list ap;
char **ret;
va_start(ap, c);
ret = heim_config_vget_strings(context->hcontext, c ? c : context->cf, ap);
va_end(ap);
return ret;
}
/**
* Free the resulting strings from krb5_config-get_strings() and
* krb5_config_vget_strings().
*
* @param strings strings to free
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION void KRB5_LIB_CALL
krb5_config_free_strings(char **strings)
{
heim_config_free_strings(strings);
}
/**
* Like krb5_config_get_bool_default() but with a va_list list of
* configuration selection.
*
* Configuration value to a boolean value, where yes/true and any
* non-zero number means TRUE and other value is FALSE.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param args a va_list of arguments
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_config_vget_bool_default(krb5_context context,
const krb5_config_section *c,
krb5_boolean def_value,
va_list args)
{
return heim_config_vget_bool_default(context->hcontext,
c ? c : context->cf, def_value, args);
}
/**
* krb5_config_get_bool() will convert the configuration
* option value to a boolean value, where yes/true and any non-zero
* number means TRUE and other value is FALSE.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param args a va_list of arguments
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_config_vget_bool(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_bool_default(context->hcontext, c ? c :
context->cf, FALSE, args);
}
/**
* krb5_config_get_bool_default() will convert the configuration
* option value to a boolean value, where yes/true and any non-zero
* number means TRUE and other value is FALSE.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param ... a list of names, terminated with NULL.
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_config_get_bool_default(krb5_context context,
const krb5_config_section *c,
krb5_boolean def_value,
...)
{
va_list ap;
krb5_boolean ret;
va_start(ap, def_value);
ret = heim_config_vget_bool_default(context->hcontext, c ? c : context->cf,
def_value, ap);
va_end(ap);
return ret;
}
/**
* Like krb5_config_get_bool() but with a va_list list of
* configuration selection.
*
* Configuration value to a boolean value, where yes/true and any
* non-zero number means TRUE and other value is FALSE.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param ... a list of names, terminated with NULL.
*
* @return TRUE or FALSE
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
krb5_config_get_bool (krb5_context context,
const krb5_config_section *c,
...)
{
va_list ap;
krb5_boolean ret;
va_start(ap, c);
ret = krb5_config_vget_bool (context, c, ap);
va_end(ap);
return ret;
}
/**
* Get the time from the configuration file using a relative time.
*
* Like krb5_config_get_time_default() but with a va_list list of
* configuration selection.
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param args a va_list of arguments
*
* @return parsed the time (or def_value on parse error)
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_vget_time_default(krb5_context context,
const krb5_config_section *c,
int def_value,
va_list args)
{
return heim_config_vget_time_default(context->hcontext, c ? c :
context->cf, def_value, args);
}
/**
* Get the time from the configuration file using a relative time, for example: 1h30s
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param args a va_list of arguments
*
* @return parsed the time or -1 on error
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_vget_time(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_time_default(context->hcontext,
c ? c : context->cf, -1, args);
}
/**
* Get the time from the configuration file using a relative time, for example: 1h30s
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param def_value the default value to return if no configuration
* found in the database.
* @param ... a list of names, terminated with NULL.
*
* @return parsed the time (or def_value on parse error)
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_get_time_default(krb5_context context,
const krb5_config_section *c,
int def_value,
...)
{
va_list ap;
int ret;
va_start(ap, def_value);
ret = heim_config_vget_time_default(context->hcontext, c ? c : context->cf,
def_value, ap);
va_end(ap);
return ret;
}
/**
* Get the time from the configuration file using a relative time, for example: 1h30s
*
* @param context A Kerberos 5 context.
* @param c a configuration section, or NULL to use the section from context
* @param ... a list of names, terminated with NULL.
*
* @return parsed the time or -1 on error
*
* @ingroup krb5_support
*/
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_get_time(krb5_context context,
const krb5_config_section *c,
...)
{
va_list ap;
int ret;
va_start(ap, c);
ret = heim_config_vget_time(context->hcontext, c ? c : context->cf, ap);
va_end(ap);
return ret;
}
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_vget_int_default(krb5_context context,
const krb5_config_section *c,
int def_value,
va_list args)
{
return heim_config_vget_int_default(context->hcontext, c ? c : context->cf,
def_value, args);
}
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_vget_int(krb5_context context,
const krb5_config_section *c,
va_list args)
{
return heim_config_vget_int_default(context->hcontext, c ? c : context->cf,
-1, args);
}
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_get_int_default(krb5_context context,
const krb5_config_section *c,
int def_value,
...)
{
va_list ap;
int ret;
va_start(ap, def_value);
ret = heim_config_vget_int_default(context->hcontext, c ? c : context->cf,
def_value, ap);
va_end(ap);
return ret;
}
KRB5_LIB_FUNCTION int KRB5_LIB_CALL
krb5_config_get_int(krb5_context context,
const krb5_config_section *c,
...)
{
va_list ap;
int ret;
va_start(ap, c);
ret = heim_config_vget_int(context->hcontext, c ? c : context->cf, ap);
va_end(ap);
return ret;
}
#ifndef HEIMDAL_SMALLER
/**
* Deprecated: configuration files are not strings
*
* @ingroup krb5_deprecated
*/
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL
krb5_config_parse_string_multi(krb5_context context,
const char *string,
krb5_config_section **res)
KRB5_DEPRECATED_FUNCTION("Use X instead")
{
krb5_error_code ret;
ret = heim_config_parse_string_multi(context->hcontext, string, res);
if (ret == HEIM_ERR_CONFIG_BADFORMAT)
return KRB5_CONFIG_BADFORMAT;
return ret;
}
#endif
Reference in New Issue View Git Blame Copy Permalink