summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Tidy up configure options documentationBen Kaduk2012-07-121-45/+2
| | | | | | | | | | | | | Our only C++ code is under src/tests/misc/. Infodir is only referenced in send-pr's makefile but not used in any rules therein. Docdir and its descendants ({html,dvi,pdf,ps}dir) are not used in any install rules. We do not have anything to install into libexecdir or sharedstatedir, and oldincludedir simply has no effect.
* Standardize on commas after "e.g.", "i.e."Ben Kaduk2012-07-129-20/+20
| | | | It seems to be "more correct".
* Sync configure options with configureBen Kaduk2012-07-121-3/+41
| | | | | | | We should try to stay coupled with the actual configure options, as documented by 'configure --help'. Remove an option which is no longer present and add several that were missing.
* Only list --enable-dns-for-realm onceBen Kaduk2012-07-121-3/+0
| | | | | | | | If we list something as "commonly used", we seem to not also list it with the rest of the options. This has the advantage of not requiring us to remember to update two things for future changes, but the disadvantage of requiring users to look in two places for options. Stick with the prevailing form for now.
* Sort configure optionsBen Kaduk2012-07-121-11/+11
| | | | | | | | | Stick to the order of 'configure --help' for most sections, but sort environment variables alphabetically (since, e.g., configure --help does not list CPPFLAGS and there is not a good way to add that). Note that this does not add or remove any content, even though some options are missing/extra.
* Cleanup docs for DNS lookup configure optionsBen Kaduk2012-07-121-6/+5
| | | | | | | DNS lookups for KDCs have been unconditionally enabled in configure since 2003; configure options only affect whether DNS lookups are used for realm names. Change the RST documentation of configure options to catch up.
* Sphinx html: reorder admin/user commands indexZhanna Tsitkov2012-07-112-7/+7
|
* Updated Example section in kdc.confZhanna Tsitkov2012-07-112-5/+19
|
* Revert "Document absolute times for 'kinit -s'"Ben Kaduk2012-07-071-5/+1
| | | | | | | | This reverts commit 20f85a81151f69689e3c060e89852687eb6c5a3c. The ability of 'kinit -s' to accept an absolute time is intentionally undocumented and remains only for backwards compatibility. Leave a comment in the source to this effect, for future generations.
* Document absolute times for 'kinit -s'Ben Kaduk2012-07-061-1/+5
| | | | | | | | | | | kinit's -s argument takes a parameter, which is first interpreted as a time interval ("deltat"), in the same format used for the -l and -r arguments. However, if that fails, the time argument is interpreted as an absolute time, in one of twelve different possible formats, some of which are subject to localization via strptime(). Explicitly listing all twelve possible interpretations is overkill, but give the user a hint that absolute times are possible at all.
* Clarify diff between krb5.conf and kdc.conf filesZhanna Tsitkov2012-07-051-22/+2
|
* Correct an error in GSSAPI initiator cred docsGreg Hudson2012-07-031-3/+3
|
* Minor rst markup fixZhanna Tsitkov2012-07-023-6/+6
|
* Add client keytab initiation supportGreg Hudson2012-07-021-0/+62
| | | | | | | | | Support acquiring GSSAPI krb5 credentials by fetching initial credentials using the client keytab. Credentials obtained this way will be stored in the default ccache or collection, and will be refreshed when they are halfway to expiring. ticket: 7189 (new)
* Document GSSAPI name type behaviorGreg Hudson2012-07-021-24/+59
| | | | | | Separate out the general interpretation of GSSAPI name types by the krb5 mechanism from the specific behavior of host-based and principal name types when used as acceptor names.
* Add krb5_kt_client_default APIGreg Hudson2012-07-027-0/+73
| | | | | | | | | | | | | | | | The default client keytab is intended to be used to automatically acquire initial credentials for client applications. The current hardcoded default is a placeholder, and will likely change before 1.11. Add test framework settings to ensure that a system default client keytab doesn't interfere with tests, and to allow tests to be written to deliberately use the default client keytab. Add documentation about keytabs to the concepts section of the RST docs, and describe the default client keytab there. ticket: 7188 (new)
* Clarify module names in host_configGreg Hudson2012-06-261-2/+5
| | | | | Explicitly state that a module name will usually be the same as the shared object name, but doesn't have to be.
* Fix another plugin example in host_configGreg Hudson2012-06-251-1/+1
|
* Correctly document module setting in host_configGreg Hudson2012-06-251-5/+6
| | | | | The module variable must take the form modname:path, which was not reflected in the example or described in the text.
* Remove orphaned KfM codeGreg Hudson2012-06-2132-7824/+0
|
* Minor reformating for better Sphinx HTML outputZhanna Tsitkov2012-06-192-52/+27
| | | | No content was changed.
* Remove CRs from options2configure.rstGreg Hudson2012-06-181-402/+402
| | | | | options2configure.rst had CRLF newlines, and should have LF newlines like everything else.
* Add krb5_cccol_have_content APIGreg Hudson2012-06-151-0/+1
| | | | | | | Add a new API to determine whether any krb5 credentials are available in the ccache collection. Add tests to t_cccol.py. ticket: 7173 (new)
* Fix spelling of "start_time" in previousTom Yu2012-06-141-1/+1
|
* Document allowed time formats for kinit and ksuZhanna Tsitkov2012-06-142-13/+37
|
* Update Build Kerberos V5 doc sectionZhanna Tsitkov2012-06-082-25/+32
| | | | ticket: 7126
* Add control over session key enctype negotiationNicolas Williams2012-06-062-3/+17
| | | | | | | | | | | | | | | | | | | Adds a principal string attribute named "session_enctypes" which can specify what enctypes the principal supports for session keys. (For what it's worth, this actually allows one to list des-cbc-md5 as a supported session key enctype, though obviously this hardly matters now.) Add a [realms] section parameter for specifying whether to assume that principals (which lack the session_enctypes attribute) support des-cbc-crc for session keys. This allows those who still need to use allow_weak_crypto=true, for whatever reason, to start reducing the number of tickets issued with des-cbc-crc session keys to clients which still give des-cbc-crc preference in their default_tgs_enctypes list. [ghudson@mit.edu: Miscellaneous edits, cleanups, and fixes; refactored test script; documented session_enctypes attribute]
* Add krb5_kt_have_content APIGreg Hudson2012-06-021-0/+1
| | | | | | | | | | | | | Add the krb5_kt_have_content API from Heimdal, which can be used to test whether a keytab exists and contains entries. Add tests to t_keytab.c. There is a deviation from Heimdal in the function signature. Heimdal's signature returns a krb5_boolean at the moment, because the Heimdal implementation actually returns a krb5_error_code. These are generally the same type anyway (int). ticket: 7158 (new)
* Sphinx HTML: Collapse l4 in ToC in the sidebarZhanna Tsitkov2012-06-013-13/+35
| | | | | | | Also, - resize the width of the document vs sidebar; - decrease padding in the sidebar; - mark current l2 in ToC in the sidebar.
* Add a copy of the BSD <sys/queue.h> as k5-queue.hGreg Hudson2012-05-301-1/+2
| | | | | queue.h implements various types of linked lists as cpp macros, without needing any library support.
* Modified the Sphinx HTML page layoutZhanna Tsitkov2012-05-233-38/+106
| | | | | 1. The Feedback button is moved into the footer; 2. The default page/doc width are set to 960px;
* Make doc/coding-style point to wiki pageTom Yu2012-05-221-564/+3
| | | | | | | The old doc/coding-style file was out of date; replace its content with a pointer to the wiki page. ticket: 7147 (new)
* Remove mention of util/autoconfTom Yu2012-05-171-14/+8
| | | | | | | | | We no longer use our own customized version of autoconf, so remove mentions of the src/util/autoconf directory where that used to be. Reported by W. Trevor King. ticket: 7139 (new)
* Add API to interpret changepw result stringsGreg Hudson2012-05-091-0/+1
| | | | | | | | | | | | | Active Directory returns structured policy information in the nominally UTF-8 result string field of a password change reply. Add a new API krb5_chpw_message() to convert a result string into a displayable message, interpreting policy information if present. Patch from stefw@gnome.org with changes. ticket: 7128 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25857 dc483132-0cff-0310-8789-dd5450dbe970
* Process param/defname node for "#define". Zhanna Tsitkov2012-05-053-4/+27
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25851 dc483132-0cff-0310-8789-dd5450dbe970
* For typedef documents in Sphinx do not add short description to the titlesZhanna Tsitkov2012-05-052-30/+14
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25850 dc483132-0cff-0310-8789-dd5450dbe970
* Add generalized definition of krb5_ui_4 and krb5_int32 to the documentation ↵Zhanna Tsitkov2012-05-053-1/+24
| | | | | | for better cross-referencing. Do not include internal structure krb5_cc_ops into Sphinx documentation git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25849 dc483132-0cff-0310-8789-dd5450dbe970
* The new version of Doxygen (1.7.6.1) produces different xml output around ↵Zhanna Tsitkov2012-05-031-1/+3
| | | | | | the <initializer> node. Adopt the script to the change. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25846 dc483132-0cff-0310-8789-dd5450dbe970
* Clarify profile pluggable interface documentationGreg Hudson2012-05-022-3/+11
| | | | | | | Explain how profile plugin modules integrate with libkrb5, since it's a bit different than usual. Also fix a broken note. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25843 dc483132-0cff-0310-8789-dd5450dbe970
* Draft initial credentials API documentationTom Yu2012-04-272-0/+60
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25835 dc483132-0cff-0310-8789-dd5450dbe970
* Rearrange navigation buttons in the HTML headerZhanna Tsitkov2012-04-261-3/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25829 dc483132-0cff-0310-8789-dd5450dbe970
* Minor cleanup (mostly to remove the "Contents" section titles)Zhanna Tsitkov2012-04-255-22/+2
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25824 dc483132-0cff-0310-8789-dd5450dbe970
* Use "agogo" HTML theme (with some modifications) for the Sphinx ↵Zhanna Tsitkov2012-04-253-9/+112
| | | | | | documentation. Do not show the ReST source files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25823 dc483132-0cff-0310-8789-dd5450dbe970
* Edit resources pageGreg Hudson2012-04-171-10/+11
| | | | | | | Improve description of kerberos and krbcore. Remove trailing whitespace throughout. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25813 dc483132-0cff-0310-8789-dd5450dbe970
* Rename mitresources.rst to resources.rstGreg Hudson2012-04-172-3/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25812 dc483132-0cff-0310-8789-dd5450dbe970
* Translate @version Doxygen markup into rst formatZhanna Tsitkov2012-04-173-0/+33
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25811 dc483132-0cff-0310-8789-dd5450dbe970
* Added MIT resources documentZhanna Tsitkov2012-04-172-8/+49
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25809 dc483132-0cff-0310-8789-dd5450dbe970
* Add clock skew testsGreg Hudson2012-04-171-0/+3
| | | | | | | Add a KDC option (-T) to run with a time offset, and use that to test kdc_timesync behavior. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25807 dc483132-0cff-0310-8789-dd5450dbe970
* Correct kdc_timesync documentationGreg Hudson2012-04-171-7/+7
| | | | | | | kdc_timesync is read from the profile as an integer, not a boolean; go back to documenting it that way. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25806 dc483132-0cff-0310-8789-dd5450dbe970
* Edit RST docs on building RST docsGreg Hudson2012-03-311-5/+7
| | | | | | | Fix a couple of grammar errors noted by Ben Kaduk, and elaborate a little bit on why generated man pages are checked into the repository. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25798 dc483132-0cff-0310-8789-dd5450dbe970