Make rules for missing man/catpages

Add the make rules to install the subfiles as man and cat pages,
missed in the previous commit.

Also correct the omission of catpages for the server binaries.

Install missing man pages

Add kadm5.acl, sserver, and sclient to MANSUBS so that we will install
them in the normal build process.

Remove install-oldman

The old man pages are gone, so we can't install them anymore.
Also clean up install and install-unix targets that were installing
the old man pages by hand.

Regenerate NOTICE from RST sources

With manual postprocessing to compensate for the sphinx text output
engine mishandling line blocks.

Use bulleted instead of ordinal lists as needed

The texinfo-generated NOTICE used bullets for some of the lists;
make the RST source consistent with that.

Remove KRB5_DB_LOCKMODE_DONTBLOCK from kdb.h

It's wasn't used and wasn't implemented.

Use blocking locks for policy DB

In the db2 kdb module, use blocking locks for the policy DB as well as
the principal DB.

ticket: 7359

Test in_ccache and pa_types functionality

* Add a krb5int_build_conf_principals() function to allow our get/set
  code to directly prune out duplicate config entries.
* Verify that when we specify a pa_type, it affects whether or not we
  will use a particular preauth plugin.
* Verify that we correctly save the KDC's preauth type number, that we
  tried to answer, to the out_ccache.

Add "pa_type" configuration to ccaches

* When producing preauth data, keep track of the type of padata in the
  KDC's list of acceptable types which prompted the module to produce
  padata.
* After obtaining credentials, store that value as a "pa_type"
  configuration item in the out_ccache.
* Read that allowed preauth type from an in_ccache, if possible.
* If we have an allowed preauth type, only call "real" modules that
  handle that value when filling in responder items and producing a
  client request.

ticket: 7414 (new)

Add an input ccache get_init_creds option

Add a krb5_get_init_creds_opt_set_in_ccache() function.  An input
ccache may hold configuration data which the client libraries can
use to influence their decisions.

ticket: 7413 (new)

Regenerate man pages

Catch up to the RST content updates.

Lots of .sp vertical space macros are removed, and the output engine
spelles "restructuredText" correctly, now.

Check in kadm5.acl.man

Somehow this man page was overlooked, previously.

Remove nroff man pages

We generate man pages from RST sources now; they are checked into
the tree in src/man/.

The gen-manpages directory is no longer needed.

More RST rename follow-up

Update conf.py for paths to man page sources and update make rules
for building the man pages.
Correct README files for the location of the sources.

Avoid bit shifting in krb5.h constants

Our traditional practice is to use hex integer literals for flag bits.
Bit shifting can be dangerous because shifting into the sign bit is
undefined.  Convert existing bit shift expressions to hex literals.

Better doc the accepted values for kdc_timesync

Modify MIT Kerberos Features document

Handle concat OTP responder case

make depend

Don't unparse principal names in process_tgs_req()

Refactor process_tgs_req() 2nd-ticket handling

Refactor some of the second-ticket handling and session key
generation out of process_tgs_req().

Clean up domain->realm referrals

Clean up domain->realm referrals by breaking prep_reprocess_tgs_req()
into smaller functions.  Give the resulting functions more descriptive
names.  Also delete an unnecessary and almost exact copy of
krb5_get_host_realm().

Refactor process_tgs_req() service princ search

The service principal database entry search logic in process_tgs_req()
was excessively complex, containing questionable uses of "goto", along
with deeply nested control flow.  Refactor it into smaller functions.

Move validate_tgs_request() to a separate file

Refactor validate_tgs_request()

Break validate_tgs_request() into smaller functions.  Collect related
checks into helper functions.  As a result, some invalid requests with
multiple problems can produce different error messages.  This is
probably not a problem for most situations.

Move add_to_transited to a separate file

add_to_transited() is fairly large, and also fairly independent of the
other contents of kdc_util.c.  Move it into kdc_transit.c.  Also
simplifies the building of rtest by removing dependencies that
kdc_util.c previously needed to satisfy undefined symbols.

Move KDC PRNG reseed logic to a helper function

Eliminate some KDC globals

Make kdc_active_realm a local variable in every function that needs
it.  Pass it around in various state structures as needed.  Keep the
macros that reference its members remain for now.

Don't use kdc_active_realm in kdc/rtest.c

Too many parts of the KDC rely on the global variable
kdc_active_realm.  rtest.c doesn't actually need any of the
KDC-specific information that's avaiable through kdc_active_realm, so
delete references to it.

Enforce TGS principals having 2 components

RFC 4120 section 7.3 says that TGS principal names have two
components.  Make krb5_is_tgs_principal() and is_cross_tgs_principal()
enforce this constraint.  Code elsewhere in the KDC already checks for
two components anyway.

Catch up to RST move/rename

Change the make rules for the directory structure.
Update the RST sources which include other RST sources for the
loss of the krb_ prefix.

ticket: 7409

Massive reST content rename

All of rst_source/ is now just in doc/.
The krb_ prefix is stripped from the document sub-directories.
rst_tools are now just tools.

The section headers of kadmind, krb5kdc, and sserver match as conflict markers.
bigredbutton: whitespace

ticket: 7409

Whitespace cleanup

Prior to a mass rename of the RST sources and utilities.

Remove stale implement document

As with the texinfo implementor's guide, it is sufficiently stale
so as to be untrustworthy without verification.
Content of this nature should live on k5wiki.kerberos.org.

ticket: 7408

Remove the last vestiges of the texinfo docs

We needed these last stragglers to build the NOTICE file at the
root of the tree, but we now generate a notice.txt from reST.

Man pages have been generated from reST for some time now, we no
longer need scripts to turn them into HTML and ps, as those can
be generated directly from the reST source.

The Makefile only existed to serve the texinfo builds, so it goes
away, too.  (The tgz target appears to have been broken since 1996.)

ticket: 7408

Make rules for building NOTICE from RST

Sphinx-build wants to scan over all the sources in the source dir,
and its text output engine does not handle the spanning row cells
used in some of our fancy tables, so it will crash if we attempt
to generate text output from our full suite of documents.
We could work around this by attempting to just compile the one
source file as an additional argument to sphinx-build, but this
seems to insist on producing an index.txt as well as a notice.txt.
Furthermore, we cannot use the same conf.py as in rst_composite because
the paths substitutions are not available with just the minimal
contents of rst_notice.  Make a copy and remove the irrelevant parts,
for now, changing only the master_doc field as appropriate.

For the HTML build, we use the standard |copy| macro from isonum.txt
to get the unicode copyright symbol glyph, but for ASCII output we
prefer to just use the literal "(C)".

ticket: 7407

Add notice.rst

To replace the texinfo sources previously used to generate NOTICE.

When compiled to HTML, compares well against the original NOTICE;
use notice.rst in mitK5license.rst instead of using a literal
include of the old NOTICE file.

ticket: 7407

Remove texinfo implementors guide

It is sufficiently old and unloved that nothing in it should be
taken as truth without independent verification.
Content of this nature should live on k5wiki.kerberos.org
in the future.

ticket: 7408

Remove unused texinfo sources

Now that the users guide make rules are removed, some of the texinfo
sources are not referenced from anywhere and can be safely removed.

ticket: 7408

Remove make glue for texinfo users guide

Towards removing the texinfo docs entirely.

ticket: 7408

Disconnect the texinfo users guide from the build

Its content has been migrated to or superseded by the krb_users
reST documentation.

The texinfo document attempted to have a general introduction to
Kerberos, but it is not quite suitable for the target audience
of the user's guide and will be rewritten.

A few portions of the texinfo document are simply no longer relevant
and do not need to be migrated.  In particular:
The krb5-appl utilities are out of scope for this document, as they
have been moved to a separate repository.  Coverage of ksu may be
brought back at a later time, though.
The Kerberos Glossary will be expanded and handled separately.

ticket: 7408

Set pointers to NULL after freeing them

Bump libkdb5 API and DAL versions

We made two sets of incompatible changes to the DAL and libkdb5 API
during development for 1.11 (master key list simplification and policy
extensions), so increment the appropriate version numbers.

Wait for correct message in t_iprop.py

The message "Got incremental updates from the master" precedes
actually replaying the updates on the slave.  Instead look for
"Incremental updates:" (the statistics message), which happens just
after the updates are replayed.

Also, we don't need to import time now that we're not sleeping.

Add a -C flag to klist to also show config entries

Use hex escaping for non-printable trace data

When adding {str}, {lenstr}, or {data} to trace output, scan for
bytes which might be non-printable, and add them as hex-escaped
versions of themselves if any are found.

Export krb5_cc_move()

Correct type mismatches for get_as_key callbacks

Handle anonymous-as-signed-data-with-no-signers

Update to generate and consume signed-data with no signer-info, which we
need for anonymous PKINIT.

Make sure that pkinit_octetstring_hkdf() inits NSS

Create an NSS context for use when performing KDF, so that the tests,
which call into the function directly, will work.

Don't try to free an uninitialized keyblock

Sanity-check loading keys and certs from PEM files

Print a debug message if we're unable to locate the matching private key
for a certificate when we've just loaded both of them from PEM files.

Reset the prompt_types list after calling prompter

Reset the prompt_types list immediately after the prompter callback
returns, as is done everywhere else.

Add responder support to preauth_otp

Migrate to non-destructive tokeninfo selection

Move forward tokeninfo filtering

Move pa_data encoding into a separate function

Eliminate races in t_iprop.py

After we start kpropd, read about the initial full dump before making
changes on the master.  Avoid prodding kpropd for this read (by
shifting responsibility for the initial prod to the caller) since
kpropd doesn't sleep before its first request.

When waiting for sync, note whether we got a full propagation and
match that up with our expectations.

Use a long polling interval so kpropd doesn't wake up on its own and
confuse the test script with an extra incremental update.

Don't use void * arithmetic in interposed_oid

Make t_iprop.py faster and more robust

Catch SIGUSR1 in iprop-mode kpropd so that we can use it to interrupt
sleeps and make kpropd do an iprop request immediately.

In k5test.py, add prod_kpropd and read_from_kpropd methods to allow
test scripts to send a SIGUSR1 to kpropd and to read its stdout/stderr
output; also allow the test script to specify additional arguments
when starting kpropd.

In t_iprop.py, start kpropd with -d and, instead of sleeping, read
kpropd output until we see an indication that kpropd is in sync with
the master.  To avoid delays, prod kpropd before waiting for sync and
after a completed full prop.

Fix a couple of typos

Add responder support to preauth_encts/preauth_ec

Add responder support to get_as_key()

This follows the design laid out on the project page:
  http://k5wiki.kerberos.org/wiki/Projects/Password_response_item

Allow null inputs to response item functions

Remove unused texinfo sources

Now that the admin guide make rules are removed, quite a few of the
texinfo sources are not referenced from anywhere and can be safely
removed.

ticket: 7408

Remove make glue for texinfo admin guide

Towards removing the texinfo docs entirely.

ticket: 7408

Disconnect the texinfo admin guide from the build

Its content has been migrated to or superseded by the reST documentation,
essentially entirely in krb_admins.

A few portions of the texinfo document are simply no longer relevant
and do not need to be migrated.  In particular:
Information about reporting bugs lives on k5wiki.kerberos.org.
General Kerberos concepts/introduction will be elsewhere in the tree.
We do not need to document the time zones accepted by kadmin.
We do not need a table of the various error codes and strings in our
formal documentation.
A complete description of the layout of our source tree is not useful
or relevant to most Kerberos administrators.

ticket: 7408

Fix cast regexp in C style checker

In check_cast, we want to match cast operators with or without spaces
after the closing paren, and then check for spaces after we match.
Also, per the comment, we want to match potential cast operators
followed by an open paren.

Improve the ktadd and ktremove synopses

Mention the options on the synopsis line, and do not imply that
the principal argument(s) for ktadd are optional.
reST line blocks are needed to keep the two forms of ktadd on
separate lines.

Fix ordered list style

Sphynx outputs class information that corresponds to its generated
basic.css, which we do not include.  This results in all lists,
even nested lists, using arabic numerals.
Import the class properties into kerb.css for now.

Fix copy/paste errors in dbadmin

We should include the stashsrvpw content in that section, not
the list content.  Likewise, the list_policy content instead
of the destroy_policy content.

Update kdb5_util example output

This text has not caught up with changes to the utility itself.
As a side effect, our output text box is narrower and does not have
to scroll on as many browser windows.

Wordsmith kdb5_util stash -f

The keyfile worth overriding is the one in kdc.conf. Though using
stash -f would override kdb5_util's -sf argument, there is no reason to
pass both flags to the same invocation.
In any case, the "at startup" language is not really correct.

Remove pronoun referent ambiguity

The policy must be unused, not the delete_policy command.

Move cross-realm info to the cross-realm section

It's really not appropriate for the "examples" subsection of
"Adding, modifying and deleting principals".

While here, update the enctype recommendation for cross-realm principals
to something that does not include weak crypto.

Normalize format of kadmin option descriptions

Start with a capital letter and end with a full stop, making
the description a sentence (or at least close to one).

Correct kadm5.acl synopsis

The target principal and restrictions arguments are not orthogonal;
a target principal argument must be given in order for a restriction
list to be supplied.

Make the kadm5.acl example sane

It is an eggregious security violation to give all admin principals
admin rights and then give all null instances permission to change
the password of the associated admin instance.

While here, don't assume that admin and root are the only non-null
instances, and correct the formatting of an entry with restrictions.

kadm5.acl line order is important

Make it a special note in the documentation to help it stand out.

Wordsmith in kadm5_acl.rst

Grammar fixup and avoid jargon.

Fix slow kprop dejagnu test

Fix kpropd -S -t to actually exit after processing one connection (it
was breaking out of the switch statement, not the while loop).  Use
the -t when invoking kpropd from the dejagnu test framework;
previously it was unnecessary because kpropd -S -d exited after one
connection.  Clear up some confusion in the kprop.exp comments about
whether kpropd is expected to exit.

Wordsmith SRV records for KDCs

Tweak the wording a bit to be more clear and avoid using multiple
words deriving from the stem "use" in close succession.

Document TXT records for realm lookup

Even though they are subject to vulnerabilities via DNS spoofing
and we accordingly don't recommend their use, we do have the code
to use them.  Just as we document dns_lookup_realm in krb5.conf(5),
document them here.

ticket: 7407

Fix argument order when calling the responder

Remove unused texinfo sources

Now that the install guide make rules are removed, nothing references
build.texinfo or install.texinfo any more (other than the tgz target,
which is updated accordingly).

ticket: 7408

Remove make glue for texinfo install guide

Towards removing the texinfo docs entirely.

ticket: 7408

Disconnect texinfo install guide from the build

Its content has been migrated to or superseded by the RST documentation,
split amongst krb_build and various sections of krb_admins.

A few portions of the texinfo document are simply no longer relevant
and do not need to be migrated.  In particular:
It's 2012; we don't need to specify that we require a C89 compiler.
It's 2012; it will be easy to get enough disk to build krb5.
The KADM5 tests are part of 'make check' and don't need separate
documentation.
Shared library support is not limited to "a few operating systems".
We do not need to document incompatibilities with ancient/dead OSes.
kadmind4 and v5passwdd are no longer relevant.

ticket: 7408

Add section on updating from single-DES

There are, unfortunately, still some single-DES deployments out
there.  Try to help them along by documenting a procedure for
migrating to stronger crypto.

The texinfo install guide had a section on "upgrading", but it was
not really suitable for direct import into a RST document.  For one,
it gave a high profile to the on-disk incompatibilities in upgrades
to 1.1 and 1.2.  It also was driven at upgrading *to* triple-des (or RC4),
which are something of a dead-end.  This new text attempts to be more
general and applicable to today's environment.

Add a kdb5_util examples for old KDC upgrades

It's a slightly less-contrived use case of the utility than the
other example, which reads more like a usage statement.
Give a motivating sentence before each example, and note that this
new example is not needed in the general upgrade case.

The need to dump/load for upgrades prior to 1.2 was documented in
the texinfo install guide, but not in any RST sources until now.

ticket: 7407

De-conditionalize Camellia code

The Camellia enctypes and cksumtypes have received IANA assignments.
Add #defines using those assignments to krb5.h, remove the CAMELLIA
conditional, and enable testing code as appropriate.

The Camellia draft has not received an RFC number yet, so there is no
Doxygen markup for the enctype and cksumtype #defines.  That can be
added once the RFC number is known.

Document DejaGnu dependency and manual tests

The Texinfo install guide had a separate subsection about the DejaGnu
tests which did not get converted to the RST source.

In the testing section, also link to the wiki page on manual testing.

ticket: 7407

Remove bug-report.texinfo

It is unused; send-pr.texinfo supercedes it at the moment anyway.

ticket: 7408

Untabify preauth_sam2.c

Remove iprop dejagnu test

Both the Python and dejagnu iprop tests are slow since they use sleeps
to give kpropd time to do its work (although we can fix this with some
work).  Since the Python tests cover the same ground as the dejagnu
tests, we don't need both.

Import and complete Greg Hudson's iprop test

ticket: 7374

Prep k5test.py for iprop (add start_kpropd(), ...)

Add a start_kpropd() method to K5Realm and make start_kadmind() use the
kadmind -p, -K, and -F options.

ticket: 7378

krb5_db_delete_principal() can fail to unlock ulog

Not really: only when the KDB backend lacks a delete method.  Still.

ticket: 7403

Remove an old, incorrect comment in kpropd.c

We absolutely do not want a parking brake on the kprop protocol as
described in the comment being removed.  Instead the kprop command
should be fixed so it doesn't die on error (assuming it even still does
or ever did, neither of which I've checked).

Send kpropd debug msgs to stderr

Fix a minor race in kdb5_util load

If a kdb5_util load gets killed between rename()ing the new KDB file
into place and resetting the iprop ulog then the ulog can reflect the
pre-load state, which will almost certainly be incorrect.

This matters because we want to impose a timeout on full resyncs in
kpropd when iprop dictates that a full resync is needed, and the
simplest timeout scheme involves signaling the kdb5_util load process.
But also, we want no such races in general.

The fix is simple: re-initialize the ulog before renaming the new KDB
file into place, then proceed as usual.  If the ulog is not properly
updated at the end of the load it will at least always result in
subsequent iprop get updates operations always indicating that a full
resync is required.

ticket: 7399