summaryrefslogtreecommitdiffstats
path: root/doc/rst_source/krb_appldev
Commit message (Collapse)AuthorAgeFilesLines
* Massive reST content renameBen Kaduk2012-10-1511-1289/+0
| | | | | | | | | | | 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 cleanupBen Kaduk2012-10-151-2/+2
| | | | Prior to a mass rename of the RST sources and utilities.
* Add responder support to preauth_otpNathaniel McCallum2012-10-151-0/+3
|
* Add new api to Sphinx doc; doc introduced versionZhanna Tsitkov2012-09-111-0/+4
|
* Introduce gss_export_cred and gss_import_credGreg Hudson2012-09-111-0/+48
| | | | | | | | Add gss_export_cred and gss_import_cred mechglue functions to serialize and unserialize GSSAPI credential handles. Mechanism implementations and tests will follow. ticket: 7354 (new)
* Doc newly introduced padata types for OTP supportZhanna Tsitkov2012-08-231-0/+4
| | | | | Remove KRB5_PADATA_OTP_CONFIRM pre-authentication data (padata) type as it is marked as OBSOLETE in RFC 6560.
* Use '---' for em dashes in rst sourceBen Kaduk2012-08-061-1/+1
| | | | | | | | | Our sphinx configuration uses SmartyPants, which produces smart quotes and dashes in HTML output, using '--' for en dash and '---' for em dash. (This is also the LaTeX convention.) These points in the text are meant to be em dashes, so format them as such. Also standardize on no spaces around the dash per Chicago Manual of Style (and others).
* Correct an error in GSSAPI initiator cred docsGreg Hudson2012-07-031-3/+3
|
* 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-021-0/+1
| | | | | | | | | | | | | | | | 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)
* Minor reformating for better Sphinx HTML outputZhanna Tsitkov2012-06-191-51/+24
| | | | No content was changed.
* 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)
* 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)
* 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
* 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
* 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
* Minor cleanup (mostly to remove the "Contents" section titles)Zhanna Tsitkov2012-04-251-3/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25824 dc483132-0cff-0310-8789-dd5450dbe970
* Automate RST HTML generation with doxygen infoGreg Hudson2012-03-281-0/+5
| | | | | | | | | In src/doc/Makefile.in, create an "rsthtml" target for generating release tarball/web site HTML docs in doc/rst_html. For now, eliminate support for the bridge to the Doxygen HTML output; just generate XML output with Doxygen and convert it to RST format. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25791 dc483132-0cff-0310-8789-dd5450dbe970
* Use substitutions in RST docsGreg Hudson2012-03-221-4/+4
| | | | | | | Create an rst_epilog variable defining substitutions for pathnames and default enctypes, and use them in the RST source files. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25784 dc483132-0cff-0310-8789-dd5450dbe970
* Remove "Feedback" paragraphs from the rst files.Zhanna Tsitkov2012-03-083-21/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25750 dc483132-0cff-0310-8789-dd5450dbe970
* Add GSSAPI acceptor names documentationGreg Hudson2012-02-292-0/+76
| | | | | | | | | In the application developer documentation, create a little bit of framing for documentation about krb5 GSS mechanism behavior and extensions, and create an initial section about how host-based service names affect keytab principal selection. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25722 dc483132-0cff-0310-8789-dd5450dbe970
* Format pass over RST documentationGreg Hudson2012-02-263-37/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Without substantially changing the content, reformat RST documentation sources, normalizing: * Whitespace: four-space indentation where indentation is arbitrary; no trailing whitespace or tabs. Two spaces after sentence periods. * 70-column fill where lines can be wrapped (outside tables, mostly) * Section header underlines: = for page titles, - for sections, ~ and then # for subsections. Underlines exactly as long as titles. No trailing punctuation in titles. * Bullet lists: * for top-level bullets, - for sub-bullets. No indentation of the list bullets relative to the surrounding content. * Inline markup: italics for words representing variable text, boldface for config keywords and command option names, monospaced text for examples, pathnames. No adornment for command names and filenames. * Man page subcommands: subsection header for the subcommand, indented command synposis, then non-indented description and option list. * Man page command synopses: newline in source before each option. All parts of synopsis at same indentation level. (Ideally we'd want a hanging indent to the length of the command name, but RST doesn't seem to support that.) * Feedback links: in a separate section at the end. (This will need to be revisited as it affects some multi-level tables of contents.) git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25712 dc483132-0cff-0310-8789-dd5450dbe970
* Updated text for the KRB5_TRACE env variable.Zhanna Tsitkov2011-11-092-7/+9
| | | | | | | Updated Sphinx index with the new API functions and changed macros names. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25465 dc483132-0cff-0310-8789-dd5450dbe970
* Expanded documentation on configure/build optionsZhanna Tsitkov2011-10-281-55/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25421 dc483132-0cff-0310-8789-dd5450dbe970
* Updated "MIT Kerberos defaults" with references to the internet ↵Zhanna Tsitkov2011-10-211-0/+1
| | | | | | | | drafts/standards and projects On the unrelated note, commiting the reference to the new API krb5_pac_sign in krb_appldev/refs/api/index.rst git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25404 dc483132-0cff-0310-8789-dd5450dbe970
* Documentation - Updated the API list with the new interfaces. Zhanna Tsitkov2011-09-261-0/+7
| | | | | | Added reference to the examples subdirectory in Doxygen configuration file. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25238 dc483132-0cff-0310-8789-dd5450dbe970
* Option to add API documentation to the Sphinx doc treeZhanna Tsitkov2011-08-014-0/+840
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25065 dc483132-0cff-0310-8789-dd5450dbe970
* Initial commit of the Sphinx documentation source.Zhanna Tsitkov2011-06-233-0/+223
One can build Sphinx documentation set in the html format by calling: sphinx-build sourcedir builddir For example: sphinx-build ./rst_source /tmp/build Note: This commit does not include the "Complete Reference - API and datatypes". This results into partial disabling of the function cross-referencing enhancement in the generated documentation. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24981 dc483132-0cff-0310-8789-dd5450dbe970
generated by cgit (git 2.34.1) at 2026-03-07 20:13:15 +0000