[Heimdal-source-changes] [heimdal/heimdal] b2823c: Move some infra bits of lib/krb5/ to lib/base/ (1)

[Nico Williams]

  Branch: refs/heads/master
  Home:   https://github.com/heimdal/heimdal
  Commit: b2823cbd74ad94e704cb8d6b9cac571a34f1e8b3
      https://github.com/heimdal/heimdal/commit/b2823cbd74ad94e704cb8d6b9cac571a34f1e8b3
  Author: Nicolas Williams <nico at twosigma.com>
  Date:   2020-03-02 (Mon, 02 Mar 2020)

  Changed paths:
    A lib/base/config_file.c
    A lib/base/config_reg.c
    A lib/base/expand_path.c
    A lib/base/log.c
    A lib/base/plugin.c
    A lib/base/warn.c
    R lib/krb5/config_file.c
    R lib/krb5/config_reg.c
    R lib/krb5/expand_path.c
    R lib/krb5/log.c
    R lib/krb5/plugin.c
    R lib/krb5/warn.c

  Log Message:
  -----------
  Move some infra bits of lib/krb5/ to lib/base/ (1)

This is the first 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.

This commit only renames files to enable git log/diff/blame to follow
the renames: to help future code archeology, and to make reviewing these
two commits easier.

The next commit in this series ensures that the moved files have the
correct content (i.e., defining heim APIs instead of krb5 APIs), and
will create files in lib/krb5 with the same names and krb5 API wrappers
around the new heim API functions.

The next commit also explains the motivation, which, briefly, is to:

 - remove krb5 API usage from lib/gssapi/,
 - enable the use of configuration and plugins in lib/hx509/
   (as well as lib/gssapi/ and future projects),

and

 - enable the further disentanglement of bx509d from kdc/.


  Commit: ea90ca86664c73fb8d415f3cc7baacdf8a6dd685
      https://github.com/heimdal/heimdal/commit/ea90ca86664c73fb8d415f3cc7baacdf8a6dd685
  Author: Nicolas Williams <nico at twosigma.com>
  Date:   2020-03-02 (Mon, 02 Mar 2020)

  Changed paths:
    M include/config.h.w32
    M include/heim_threads.h
    M kdc/cjwt_token_validator.c
    M kdc/csr_authorizer.c
    M kdc/ipc_csr_authorizer.c
    M kdc/negotiate_token_validator.c
    M kdc/simple_csr_authorizer.c
    M kdc/token_validator.c
    M kdc/windc.c
    M lib/Makefile.am
    M lib/NTMakefile
    M lib/base/Makefile.am
    M lib/base/NTMakefile
    M lib/base/baselocl.h
    A lib/base/common_plugin.h
    M lib/base/config_file.c
    M lib/base/config_reg.c
    A lib/base/context.c
    M lib/base/expand_path.c
    A lib/base/heim_err.et
    M lib/base/heimbase.h
    M lib/base/log.c
    M lib/base/plugin.c
    M lib/base/version-script.map
    M lib/base/warn.c
    M lib/gssapi/NTMakefile
    M lib/gssapi/mech/context.c
    M lib/hdb/hdb.c
    M lib/kadm5/private.h
    M lib/kadm5/server_hooks.c
    M lib/krb5/Makefile.am
    M lib/krb5/NTMakefile
    M lib/krb5/aname_to_localname.c
    M lib/krb5/cache.c
    M lib/krb5/ccache_plugin.h
    R lib/krb5/common_plugin.h
    A lib/krb5/config_file.c
    M lib/krb5/context.c
    M lib/krb5/db_plugin.c
    A lib/krb5/expand_path.c
    R lib/krb5/heim_err.et
    M lib/krb5/krb5-plugin.7
    M lib/krb5/krb5.h
    M lib/krb5/krb5_locl.h
    M lib/krb5/krbhst.c
    M lib/krb5/kuserok.c
    A lib/krb5/log.c
    M lib/krb5/pcache.c
    A lib/krb5/plugin.c
    M lib/krb5/send_to_kdc.c
    M lib/krb5/verify_krb5_conf.c
    A lib/krb5/warn.c
    M windows/NTMakefile.w32

  Log Message:
  -----------
  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/


  Commit: 3c0f59b658dd8f33df0e275c083f8adc4c826450
      https://github.com/heimdal/heimdal/commit/3c0f59b658dd8f33df0e275c083f8adc4c826450
  Author: Nicolas Williams <nico at twosigma.com>
  Date:   2020-03-02 (Mon, 02 Mar 2020)

  Changed paths:
    M lib/hdb/keys.c

  Log Message:
  -----------
  hdb: Fix memory leak in hdb_generate_key_set()


  Commit: 5ab1a2b7a673a9710b5375911a02205ad91431d1
      https://github.com/heimdal/heimdal/commit/5ab1a2b7a673a9710b5375911a02205ad91431d1
  Author: Nicolas Williams <nico at twosigma.com>
  Date:   2020-03-02 (Mon, 02 Mar 2020)

  Changed paths:
    M appveyor.yml

  Log Message:
  -----------
  appveyor: Minor improvements for debugging


Compare: https://github.com/heimdal/heimdal/compare/e8de24f236ed...5ab1a2b7a673