summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
...
* Add web pages to resources.rstTom Yu2012-12-171-0/+7
| | | | | | | | | In resources.rst, add links to the MIT Kerberos software and MIT Kerberos Consortium web pages. ticket: 7512 (new) target_version: 1.11 tags: pullup
* Update retiring-des with real-world experienceBen Kaduk2012-12-171-66/+337
| | | | | | | | | | | We took notes when upgrading the ZONE.MIT.EDU realm to reduce its usage of single-DES. Use these to give examples for the upgrade procedure, and flesh out some parts of it that were missing or under-specified. ticket: 7501 (new) tags: pullup target_version: 1.11
* Document enctypesTom Yu2012-12-172-0/+146
| | | | | | | | | | | Add enctypes.rst to document Kerberos enctypes, including some considerations about configuring and choosing enctypes. [kaduk@mit.edu: normalize formatting and describe reply keys a bit more.] ticket: 7507 (new) target_version: 1.11 tags: pullup
* Add copyright footer to HTML docsTom Yu2012-12-174-1/+22
| | | | | | | | | | | | | The technique we use for inserting the feedback link in the footer overrides the Sphinx basic/layout.html and agogo/layout.html footers in a way that prevents us from getting the copyright link footer. Copy the relevant part of the Sphinx basic/layout.html for now. Add a copyright.rst that links to mitK5license.rst. ticket: 7510 (new) target_version: 1.11 tags: pullup
* Update README for Sphinx documentationTom Yu2012-12-171-12/+32
| | | | | | | | | The README pointed at the obsolete Texinfo documentation. Update it to point at the Sphinx documentation. ticket: 7509 (new) target_version: 1.11 tags: pullup
* PKINIT (draft9) null ptr deref [CVE-2012-1016]Nalin Dahyabhai2012-12-141-2/+3
| | | | | | | | | | | | | | | | | | Don't check for an agility KDF identifier in the non-draft9 reply structure when we're building a draft9 reply, because it'll be NULL. The KDC plugin for PKINIT can dereference a null pointer when handling a draft9 request, leading to a crash of the KDC process. An attacker would need to have a valid PKINIT certificate, or an unauthenticated attacker could execute the attack if anonymous PKINIT is enabled. CVSSv2 vector: AV:N/AC:M/Au:N/C:N/I:N/A:P/E:P/RL:O/RC:C [tlyu@mit.edu: reformat comment and edit log message] ticket: 7506 (new) target_version: 1.11 tags: pullup
* Conditionally include MITKC logo in HTML docTom Yu2012-12-143-5/+6
| | | | | | | | | | | | | Conditionally include the MITKC logo in the HTML output from Sphinx if the environment variable HTML_LOGO is set. During official builds for the web site, that environment variable will point to an appropriately scaled copy of the MITKC logo. Adjust HTML document colors to match logo. ticket: 7504 (new) target_version: 1.11 tags: pullup
* Fix documentation browser resizing behaviorTom Yu2012-12-142-2/+9
| | | | | | | | | | | | | Remove hardcoded dimensions from a few CSS parameters to prevent layout problems when readers resize their browsers to have a narrower window. Set a max-width: 60em on the main content so that text remains readable on wide browser windows. ticket: 7503 (new) target_version: 1.11 tags: pullup
* Better names for doxygen-Sphinx bridge functionsBen Kaduk2012-12-143-25/+22
| | | | | | | | | | | It is confusing when the codepath for the production doc build involves calling functions with names like "test". Rename things which are in active use so that routines which are actually only used for testing are more discernable as such. ticket: 7505 (new) tags: pullup target_version: 1.11
* Make the doc build quieterBen Kaduk2012-12-143-9/+1
| | | | | | | | | | | | | | Don't print out every node processed (or not processed) in the doxygen-Sphinx bridge, nor print out a summary of how many types or functions were processed. While here, tell doxygen to be quiet in its output as well, and not print out each file that is generated. It still outputs warnings, though. ticket: 7495 (new) tags: pullup target_version: 1.11
* Add examples to init_creds.rstGreg Hudson2012-12-131-4/+134
| | | | | | ticket: 7500 (new) target_version: 1.11 tags: pullup
* Use an empty challenge for the password questionGreg Hudson2012-12-131-1/+1
| | | | | | | | | | | If a question's challenge is NULL, it is unnecessarily difficult for a responder callback to detect whether it was asked. So it's better to use an empty challenge when there is no challenge data to communicate. Do this for the "password" question. ticket: 7499 (new) target_version: 1.11 tags: pullup
* Document principal name interactions with DNSTom Yu2012-12-122-0/+114
| | | | | | | | | Add princ_dns.rst to document the interactions of host-based Keberos service principal names and DNS. ticket: 7498 (new) target_version: 1.11 tags: pullup
* Update mkrel for SPHINX_ARGSTom Yu2012-12-121-2/+2
| | | | | | | | | Update mkrel so that it will explicitly set SPHINX_ARGS=-W to make warnings fatal and so that it will work in an unconfigured tree. ticket: 7497 (new) target_version: 1.11 tags: pullup
* Document API for getting anonymous ticketsGreg Hudson2012-12-122-0/+28
| | | | | | | | | In init_creds.rst, document how to get anonymous credentials from an application. ticket: 7496 (new) target_version: 1.11 tags: pullup
* Don't finalize libraries in static buildGreg Hudson2012-12-121-11/+13
| | | | | | | | | | | | In a build with static libraries, functions tagged with __attribute__((destructor)) may be executed in any order, not in a topologically sorted order as they are in shared libraries. This could result in libcom_err functions being invoked (from another library's finalizer) after libcom_err has been finalized, which would (at minimum) result in using a mutex after it is destroyed. To prevent this kind of problem, disable finalizers in the static build regardless of whether we have compiler or linker support for them. Reported by Mihai Serban <mihai.serban@gmail.com>.
* Regenerate checked-in man pagesBen Kaduk2012-12-112-7/+19
| | | | | | | | | | Pick up changes to kadmin.rst and krb5_conf.rst adding cross-references for account lockout and detailing parameter expansion for keytab and credentials cache names in krb5.conf ticket: 7494 (new) tags: pullup target_version: 1.11
* Update manpage version on masterBen Kaduk2012-12-1124-24/+24
| | | | | | Now that version.py is in place to update Sphinx's idea of the version number in accordance reality, update the version in the man pages that we check in; the master branch is currently a 1.12 prerelease.
* Make sphinx warnings fatal for doc buildBen Kaduk2012-12-112-3/+4
| | | | | | | | | | | | | | | We currently do not have any warnings. Let us keep it that way by making warnings fatal in maintainer-mode (and configurable on the buildslaves). Using sphinx-build -W also causes errors to be reported in the exit status and picked up by make, which is quite useful. In order to allow the build bot to use -W but end-users to not use it, SPHINX_ARGS must be passed on the command line; it cannot be set by the convenience target 'htmlsrc'. Document this. ticket: 7468 (new) tags: pullup target_version: 1.11
* Make building docs easier in an unconfigured treeBen Kaduk2012-12-112-5/+7
| | | | | | | | | | | | | Instead of requiring the user to specify srcdir, top_srcdir, PYTHON, and possibly more in the future, make an 'htmlsrc' target that does so for them. This also lets us do the clean in the same step, so that only one command is required of the user. ticket: 7491 (new) tags: pullup target_version: 1.11
* Update comments for RFC 3244 kpasswd extensionsBen Kaduk2012-12-111-3/+4
| | | | | | | | | Remove the inaccurate comments "unused" and replace them with more useful representations of what they mean. ticket: 7490 (new) tags: pullup target_version: 1.11
* Do not document unused symbolsBen Kaduk2012-12-115-6/+4
| | | | | | | | | | | | | | | | The macro KRB5_KEYUSAGE_PA_REFERRAL was defined in an early revision of draft-ietf-krb-wg-kerberos-referrals but did not make it into RFC 6806. We retain the definition so as to not break code implementing the early draft, but need not document it. Likewise, the krb5_octet_data structure and krb5_free_octet_data routine are marked as having been originally introduced for PKINIT and "Do not use this." They are in fact unused, and should not be documented, but the actual definitions must remain for compatibility. ticket: 7489 (new) tags: pullup target_version: 1.11
* Don't use $(RM) in src/doc/Makefile.inBen Kaduk2012-12-111-1/+1
| | | | | | | | | | We allow these rules to be used in an unconfigured tree, and some makes do not supply a value for RM by default. ticket: 7492 (new) subject: Doc build in unconfigured tree broken on some platforms tags: pullup target_version: 1.11
* Fix various integer issuesGreg Hudson2012-12-105-39/+19
| | | | | | | | | | | | | | | In kdc_util.c and spnego_mech.c, error returns from ASN.1 length functions could be ignored because they were assigned to unsigned values. In spnego_mech.c, two buffer size checks could be rewritten to reduce the likelihood of pointer overflow. In dump.c and kdc_preauth.c, calloc() could be used to simplify the code and avoid multiplication overflow. In pkinit_clnt.c, the wrong value was checked for a null result from malloc(), and the code could be simplified. Reported by Nickolai Zeldovich <nickolai@csail.mit.edu>. ticket: 7488
* Fix typoBen Kaduk2012-12-101-1/+1
| | | | | | | | | We do not have any files with extension "rxt". ticket: 7471 (new) title: typo in exclude_patterns for notice build tags: pullup target_version: 1.11
* Note notice.txt's dependency on version.pyBen Kaduk2012-12-101-1/+1
| | | | | | | | | | | | This dependency has been in effect since the notice build was changed to use the main conf.py, due to its unconditional execfile('version.py'). Adding another conditional in conf.py seems to add needless complication, it is easier to just note the dependency in the Makefile and carry on. ticket: 7470 (new) title: NOTICE build has unnoted dependency on version.py tags: pullup target_version: 1.11
* Do not include hidden files in the sidebarBen Kaduk2012-12-101-1/+1
| | | | | | | | | | We play games with hidden toctrees in the RST source to avoid Sphinx warnings; make sure that they do not affect the rendered output. ticket: 7467 (new) tags: pullup target_version: 1.11
* Do not generate unused parts of toctreeBen Kaduk2012-12-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | Our css only displays up to depth 3 of the toctree, partially because the API reference content explodes at depth 4 and that would not be pretty to see in the sidebar. However, we would previously always generate HTML for the full toctree and hide parts with CSS. For the apiref, this proved to be about 65k per html file, and we have one html file per function/type/macro. Limit the depth of the toctree that gets generated to save on space in the release tarball. Unfortunately, there seems to be a Sphinx bug wherein the toctree will only be generated to depth 1 for a document at a depth greater than the maxdepth of the toctree, so the sidebar table of contents on individual apiref pages will just be the toplevel toctree. This issue is being tracked at https://bitbucket.org/birkenfeld/sphinx/issue/1046/ ticket: 7466 (new) tags: pullup target_version: 1.11
* Reformat RST to avoid sphinx warningsBen Kaduk2012-12-1016-32/+108
| | | | | | | | | | | | | | | | | | | | | | | Old versions of docutils will see inline markup (e.g., :ref:`foo`) at the beginning of a line in the content of a directive block and attempt to interpret that markup as options or arguments to the directive. RST intended as inline markup (as opposed to modifying the behavior of the directive) will not be interpretable in this context, and causes Sphinx to emit a warning. Work around this behavior by always leaving a blank line before the content of a directive block, forcing it to be interpreted as content and not options or arguments. The buggy behavior was only encountered in note environments, but for consistency of style, also reformat warning and error blocks. Note the new style constraint in doc/README. ticket: 7469 (new) title: doc buildslave generates sphinx warnings tags: pullup target_version: 1.11
* Make resources.rst more useful to non-devsTom Yu2012-12-091-17/+15
| | | | | | | | | | | | | | | Reorder the IRC channel listing so #kerberos is first. (Developers form a smaller part of our audience for this documentation set.) Remove some details that are available on the wiki and not of interest to non-developers. Add a pointer to the wiki. Fix minor grammar errors in Archives. ticket: 7482 (new) target_version: 1.11 tags: pullup
* Don't return a host referral to the service realmGreg Hudson2012-12-063-1/+25
| | | | | | | | | | A host referral to the same realm we just looked up the principal in is useless at best and confusing to the client at worst. Don't respond with one in the KDC. ticket: 7483 target_version: 1.11 tags: pullup
* Fix typo for windows versionsBen Kaduk2012-12-051-1/+1
| | | | | | | | | | | We omit the patchlevel if it is zero, but the check whether the patchlevel was zero was checking the wrong variable, and thus always succeeding. ticket: 7481 (new) queue: kfw tags: pullup target_version: 1.10.4
* Access keys for the KfW ribbon interfaceBen Kaduk2012-12-051-3/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | Improve accessibility by actually enabling access keys for ribbon elements (tap alt and follow the onscreen hints for keys to press), instead of just underlining a letter in the name of each element. Supply an underlined letter in the text of each element, corresponding to this access key, even if there is not a shortcut key bound to that element. While here, fix conflicting assignment to 'R' on the 'options' tab (between "Renewable Until" and "Automatic Ticket Renewal") by making "Automatic Ticket Renewal" use 'T'. Microsoft's UI recommendations seem to say that access keys should be easy to locate when searching through the menu, and thus using the first letter of the first or second word is advisable. The Ribbon XML Reference seems to indicate that these elements should be "keytip" elements, but MSVS creates "keys" elements, which seem to work, whereas "keytip" does not. Apparently 'F' is standard for the application button menu (which contains exit). Access keys work somewhat poorly for us in this menu, as they appear on top of the text of the menu items, since we have no icons here. ticket: 7441 tags: pullup target_version: 1.10.4
* Rewrap the Leash ribbon conf fileBen Kaduk2012-12-051-1/+331
| | | | | | | | | | A big pile of XML on one line is not very readable. Use 'xmllint --format' to make things more sane. ticket: 7478 (new) queue: kfw tags: pullup target_version: 1.10.4
* Leave 'OK' button visible in Leash AboutBoxBen Kaduk2012-12-051-1/+1
| | | | | | | | | | | | | | | | | | | | The AboutBox dialog as specified in the resource file is larger than the one we display; the dialog init routine marks several things as non-visible, moves the 'OK' button up to where the now-invisible items were, and shrinks the dialog's bounding rectangle. However, the edit boxes containing copyright and version information seem to always present as being on top of the 'OK' button, and their background causes the button to appear almost invisible with the current repositioning. To keep the 'OK' button visible, reduce the amount that it is moved (and the amount the dialog is shrunk) so that the button does not overlap with the edit box. ticket: 7443 tags: pullup target_version: 1.10.4
* Build fixes for windowsBen Kaduk2012-12-053-4/+6
| | | | | | | | | | | | Add entries to OBJS and SRCS as well as STLIBOBJS. Use KRB5_CALLCONV at function definition as well as declaration. Declare missing variable in _WIN32-conditional code. ticket: 7479 (new) tags: pullup target_version: 1.11
* Cross-reference account lockout documentationGreg Hudson2012-12-053-26/+33
| | | | | | | | | | | | Link to the database.rst description of policy objects when talking about them. Briefly mention the "default" policy. Link to the kadmin_local.rst description of policy fields when referencing them. Describe policy fields more briefly, and expand the kadmin_local.rst descriptions where appropriate. ticket: 7480 (new) target_version: 1.11 tags: pullup
* Document account lockout configurationGreg Hudson2012-12-032-0/+141
| | | | | | ticket: 7477 (new) target_version: 1.11 tags: pullup
* Document key usage assigned number conflictZhanna Tsitkov2012-11-301-11/+10
| | | | | | | | | | | | | | | | Document the fact that the key usage type 26 is used by both KBKRB5_KEYUSAGE_PA_S4U_X509_USER_REQUEST and KRB5_KEYUSAGE_PA_S4U_X509_USER_REQUEST, while 27 - by KRB5_KEYUSAGE_PA_S4U_X509_USER_REPLY and KRB5_KEYUSAGE_PA_SAM_RESPONSE. Also, since KRB5_KEYUSAGE_PA_REFERRAL is not actually used in MIT Kerberos code and is not defined in the latest referrals draft (http://tools.ietf.org/html/draft-ietf-krb-wg-kerberos-referrals-15) mark it as "unused". ticket: 7474 tags: pullup target_version: 1.11
* Document param expansion for keytab/ccache namesZhanna Tsitkov2012-11-292-4/+9
| | | | | | | | | | The DEFCCNAME, DEFCKTNAME and DEFKTNAME configuration options are subjects to parameter expansion. Also note that this feature was first introduced in release 1.11. ticket: 7472 tags: pullup target_version: 1.11
* Update documentation Feature list with 1.11 itemsZhanna Tsitkov2012-11-291-11/+15
| | | | | | | | | Also, change the reference for Camellia enc type to rfc6803 and do minor table re-formatting. ticket: 7456 tags: pullup target_version: 1.11
* Avoid redundant socket cleanup in sendto_kdc.cGreg Hudson2012-11-291-4/+0
| | | | | | | | Since r25120, kill_conn() has been responsible for closing and invalidating conn->fd. In the unlikely event that the KDC sends a TCP response to us before we send a TCP request, we were cleaning up the socket again, which is useless (though also harmless). Get rid of that code.
* Fix spin-loop bug in k5_sendto_kdcGreg Hudson2012-11-291-1/+1
| | | | | | | | | | | | In the second part of the first pass over the server list, we passed the wrong list pointer to service_fds, causing it to see only a subset of the server entries corresponding to sel_state. This could cause service_fds to spin if an event is reported on an fd not in the subset. ticket: 7454 target_version: 1.10.4 tags: pullup
* Add camellia_key_cleanupBen Kaduk2012-11-281-1/+9
| | | | | | | | Fix memory leak. ticket: 7457 tags: pullup target_version: 1.11
* Remove last "document not in toctree" warningsBen Kaduk2012-11-272-0/+6
| | | | | | | | | | | | | | | | | | | | There were two of them, for notice.rst and mitK5license.rst. The former is included in the latter, which is linked to from the mitK5features document but not listed in a table of contents otherwise. Includes are processed unconditionally, so we can add notice.rst to the exclude_patterns array (formerly unused_docs) and its content will still be included. If we attempt to do the same for mitK5license.rst, it is not processed at all, and the attempt to link to it will fail. Instead, put a dummy table of contents in the mitK5features document (which links to the license document), with the "hidden" attribute. This satisfies the Sphinx need to know where all the input documents are without changing the displayed table of contents. ticket: 7447 tags: pullup target_version: 1.11
* Render macros as literalsBen Kaduk2012-11-272-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Some convenience macros are referring to and dereferencing pointers, and Sphinx will get a bit confused trying to interpret this as markup. There should never be any markup intended to be interpreted in the value of a macro definition, so we can silence this class of warnings by treating them as literals. (In some sense, they actually are literals, too.) This will cause a warning for macros that only cause a symbol to be defined, that is, a literal "#define MACRO" with no initializer, due to the lack of body in the inline-literal markup. Such macros should probably be added to the exclude list for conversion to reStructuredText in the Doxygen-Sphinx bridge, as was already done for KRB5_OLD_CRYPTO. Support code to programmatically omit macros of this sort is deliberately *not* included, so that explicit action must be taken when a new macro is to be undocumented. Also, strip leading and trailing whitespace from the macro name, since this causes problems with the markup. ticket: 7447 tags: pullup target_version: 1.11
* Handle multiline macro definitionsBen Kaduk2012-11-271-0/+2
| | | | | | | | Compress them onto one line for printing in the generated table. ticket: 7447 tags: pullup target_version: 1.11
* Exclude lists for doxygen API docsBen Kaduk2012-11-273-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | Doxygen will pick up every function, macro, and typedef defined in krb5.h; some of these may not actually be part of the public API for one reason or another. Provide hardcoded exclude lists for macro/function/type names for which we do not want to emit reStructuredText documentation, and check these lists when processing the Doxygen XML output. Seed these lists with the macros TRUE, FALSE, KRB5_OLD_CRYPTO, KRB5_GENERAL__, KRB5_CALLCONV, KRB5_CALLCONV_C, KRB5_CALLCONV_WRONG, KRB5INT_BEGIN_DECLS, KRB5INT_END_DECLS, and KRB5_ATTR_DEPRECATED, and typedefs krb5_cc_ops and krb5_responder_context. The booleans are compatibility cruft that we do not want to advertise, and the other macros are for internal use for signalling and platform compatibility. The typedefs are functioning just as forward declarations. For consistency, remove KRB5_OLD_CRYPTO.rst from the macros index; it had no content even when we did generate it. ticket: 7447 tags: pullup target_version: 1.11
* Handle adjacent notes from doxygen more correctlyBen Kaduk2012-11-271-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | The Doxygen documentation seems to claim that adjacent @note entries will be collapsed into a single "note" element, as separate paragraphs. This seems to be reflected in the XML output: multiple <para> entries in a single <simplesec kind="note"> with a <simplesecsep/> element between them. Our XML-to-RST converter gets the entire contents of the simplesec element, parsed into a unicode string with a single newline between paragraphs. Paragraphs seem to always start with two spaces, though I have not tracked down the origin of this behavior. Prior to this commit, we would just output this entire unicode string directly. Since our template puts a tab character before the note string, this means that the first paragraph is indented by a tab and two spaces, and the second paragraph by just two spaces. Sphinx warns about this, as "block did not end with blank line; unexpected whitespace", and the paragraphs are indented differently within the note. Fix the warning by checking for newlines in the interior of the parsed unicode string, and introducing the appropriate whitespace for the Sphinx parser. ticket: 7447 tags: pullup target_version: 1.11
* Fix overflowing cell in HTML tableBen Kaduk2012-11-271-0/+3
| | | | | | | | | | | | | | | | | sphinx-build defaults to the 'tabulary' environment for tables, but uses regular 'tabular' for those involving literal blocks, since tabulary does not handle them properly. It seems that this deficiency of tabulary also applies to inline literals, which are rendered as \code{} sections by the latex builder. Fortunately, sphinx provides a workaround to force a particular column specification for the table. The requirement for a table:: statement after the tabularcolumns:: statement is very poorly documented. ticket: 7447 tags: pullup target_version: 1.11
generated by cgit (git 2.34.1) at 2025-09-27 16:09:27 +0000