logo_kerberos.gif

Difference between revisions of "Projects/Documentation Tasks"

From K5Wiki
Jump to: navigation, search
m (added link to the exiting docs (as an experiment))
m (Added links to Sphinx documentation. Split the original Tier_1 table to separate higher and lower priorities.)
Line 33: Line 33:
   
   
 
  +
===Most commonly used API functions (in alphabetical order)===
   
 
{| class="wikitable"
 
{| class="wikitable"
|+ Tier 1 - most commonly used API functions (in alphabetical order)
 
  +
|+ Tier 1 - Highest priority
 
|-
 
|-
 
! API
 
! API
Line 51: Line 51:
 
| krb5_build_principal_ext [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_build_principal_ext.html]|| || || ||
 
| krb5_build_principal_ext [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_build_principal_ext.html]|| || || ||
 
|-
 
|-
| krb5_cc_close || || || ||
 
  +
| krb5_change_password [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_change_password.html]|| || || ||
 
|-
 
|-
| krb5_cc_default || || || ||
 
  +
| krb5_free_context [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_free_context.html]|| || || ||
 
|-
 
|-
| krb5_cc_default_name || || || ||
 
  +
| krb5_free_error_message [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_free_error_message.html]|| || || ||
 
|-
 
|-
| krb5_cc_destroy || || || ||
 
  +
| krb5_free_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_free_principal.html]|| || || ||
 
|-
 
|-
| krb5_cc_dup || || || ||
 
  +
| krb5_fwd_tgt_cred [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_fwd_tgt_cred.html]|| || || ||
 
|-
 
|-
| krb5_cc_get_name || || || ||
 
  +
| krb5_get_default_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_default_realm.html]|| || || ||
 
|-
 
|-
| krb5_cc_get_principal || || || ||
 
  +
| krb5_get_error_message [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_error_message.html]|| || || ||
 
|-
 
|-
| krb5_cc_get_type || || || ||
 
  +
| krb5_get_host_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_host_realm.html]|| || || ||
 
|-
 
|-
| krb5_cc_initialize || || || ||
 
  +
| krb5_get_credentials [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_credentials.html]|| || || ||
 
|-
 
|-
| krb5_cc_new_unique || || || ||
 
  +
| krb5_get_fallback_host_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_fallback_host_realm.html]|| || || ||
 
|-
 
|-
| krb5_cc_resolve || || || ||
 
  +
| krb5_get_init_creds_keytab [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_keytab.html]|| || || ||
 
|-
 
|-
| krb5_change_password || || || ||
 
  +
| krb5_get_init_creds_opt_alloc [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_alloc.html]|| || || ||
 
|-
 
|-
| krb5_free_context || || || ||
 
  +
| krb5_get_init_creds_opt_free [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_free.html]|| || || ||
 
|-
 
|-
| krb5_free_error_message || || || ||
 
  +
| krb5_get_init_creds_opt_get_fast_flags [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_get_fast_flags.html]|| || || ||
 
|-
 
|-
| krb5_free_principal || || || ||
 
  +
| krb5_get_init_creds_opt_init [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_init.html]|| || || ||
 
|-
 
|-
| krb5_fwd_tgt_cred || || || ||
 
  +
| krb5_get_init_creds_opt_set_address_list [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_address_list.html]|| || || ||
 
|-
 
|-
| krb5_get_default_realm || || || ||
 
  +
| krb5_get_init_creds_opt_set_anonymous [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_anonymous.html]|| || || ||
 
|-
 
|-
| krb5_get_error_message || || || ||
 
  +
| krb5_get_init_creds_opt_set_canonicalize [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_canonicalize.html]|| || || ||
 
|-
 
|-
| krb5_get_host_realm || || || ||
 
  +
| krb5_get_init_creds_opt_set_change_password_prompt [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_change_password_prompt.html]|| || || ||
 
|-
 
|-
| krb5_get_credentials || || || ||
 
  +
| krb5_get_init_creds_opt_set_etype_list [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_etype_list.html]|| || || ||
 
|-
 
|-
| krb5_get_fallback_host_realm || || || ||
 
  +
| krb5_get_init_creds_opt_set_expire_callback [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_expire_callback.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_keytab || || || ||
 
  +
| krb5_get_init_creds_opt_set_fast_ccache [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_fast_ccache.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_alloc || || || ||
 
  +
| krb5_get_init_creds_opt_set_fast_ccache_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_fast_ccache_name.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_free || || || ||
 
  +
| krb5_get_init_creds_opt_set_fast_flags [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_fast_flags.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_get_fast_flags || || || ||
 
  +
| krb5_get_init_creds_opt_set_forwardable [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_forwardable.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_init || || || ||
 
  +
| krb5_get_init_creds_opt_set_out_ccache [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_out_ccache.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_address_list || || || ||
 
  +
| krb5_get_init_creds_opt_set_pa [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_pa.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_anonymous || || || ||
 
  +
| krb5_get_init_creds_opt_set_preauth_list [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_preauth_list.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_canonicalize || || || ||
 
  +
| krb5_get_init_creds_opt_set_proxiable [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_proxiable.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_change_password_prompt || || || ||
 
  +
| krb5_get_init_creds_opt_set_renew_life [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_renew_life.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_etype_list || || || ||
 
  +
| krb5_get_init_creds_opt_set_salt [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_salt.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_expire_callback || || || ||
 
  +
| krb5_get_init_creds_opt_set_tkt_life [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_opt_set_tkt_life.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_fast_ccache || || || ||
 
  +
| krb5_get_init_creds_password [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_init_creds_password.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_fast_ccache_name || || || ||
 
  +
| krb5_get_profile [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_profile.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_fast_flags || || || ||
 
  +
| krb5_get_prompt_types [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_prompt_types.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_forwardable || || || ||
 
  +
| krb5_get_renewed_creds [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_renewed_creds.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_out_ccache || || || ||
 
  +
| krb5_get_validated_creds [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_validated_creds.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_pa || || || ||
 
  +
| krb5_init_context [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_init_context.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_preauth_list || || || ||
 
  +
| krb5_init_secure_context [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_init_secure_context.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_proxiable || || || ||
 
  +
| krb5_is_config_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_is_config_principal.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_renew_life || || || ||
 
  +
| krb5_is_thread_safe [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_is_thread_safe.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_salt || || || ||
 
  +
| krb5_kt_close [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_close.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_opt_set_tkt_life || || || ||
 
  +
| krb5_kt_default [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_default.html]|| || || ||
 
|-
 
|-
| krb5_get_init_creds_password || || || ||
 
  +
| krb5_kt_default_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_default_name.html]|| || || ||
 
|-
 
|-
| krb5_get_profile || || || ||
 
  +
| krb5_kt_get_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_get_name.html]|| || || ||
 
|-
 
|-
| krb5_get_prompt_types || || || ||
 
  +
| krb5_kt_get_type [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_get_type.html] || || || ||
 
|-
 
|-
| krb5_get_renewed_creds || || || ||
 
  +
| krb5_kt_resolve [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kt_resolve.html]|| || || ||
 
|-
 
|-
| krb5_get_validated_creds || || || ||
 
  +
| krb5_kuserok [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_kuserok.html] || || || ||
 
|-
 
|-
| krb5_init_context || || || ||
 
  +
| krb5_parse_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_parse_name.html]|| || || ||
 
|-
 
|-
| krb5_init_secure_context || || || ||
 
  +
| krb5_parse_name_flags [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_parse_name_flags.html]|| || || ||
 
|-
 
|-
| krb5_is_config_principal || || || ||
 
  +
| krb5_principal_compare [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_principal_compare.html]|| || || ||
 
|-
 
|-
| krb5_is_thread_safe || || || ||
 
  +
| krb5_principal_compare_any_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_principal_compare_any_realm.html]|| || || ||
 
|-
 
|-
| krb5_kt_close || || || ||
 
  +
| krb5_principal_compare_flags [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_principal_compare_flags.html]|| || || ||
 
|-
 
|-
| krb5_kt_default || || || ||
 
  +
| krb5_prompter_posix [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_prompter_posix.html]|| || || ||
 
|-
 
|-
| krb5_kt_default_name || || || ||
 
  +
| krb5_realm_compare [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_realm_compare.html]|| || || ||
 
|-
 
|-
| krb5_kt_get_name || || || ||
 
  +
| krb5_recvauth [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_recvauth.html]|| || || ||
 
|-
 
|-
| krb5_kt_get_type || || || ||
 
  +
| krb5_recvauth_version [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_recvauth_version.html] || || || ||
 
|-
 
|-
| krb5_kt_resolve || || || ||
 
  +
| krb5_set_default_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_default_realm.html]|| || || ||
 
|-
 
|-
| krb5_kuserok || || || ||
 
  +
| krb5_set_password [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_password.html]|| || || ||
 
|-
 
|-
| krb5_parse_name || || || ||
 
  +
| krb5_set_password_using_ccache [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_password_using_ccache.html] || || || ||
 
|-
 
|-
| krb5_parse_name_flags || || || ||
 
  +
| krb5_set_principal_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_principal_realm.html] || || || ||
 
|-
 
|-
| krb5_principal_compare || || || ||
 
  +
| krb5_set_trace_callback [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_trace_callback.html]|| || || ||
 
|-
 
|-
| krb5_principal_compare_any_realm || || || ||
 
  +
| krb5_set_trace_filename [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_set_trace_filename.html]|| || || ||
 
|-
 
|-
| krb5_principal_compare_flags || || || ||
 
  +
| krb5_sname_to_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_sname_to_principal.html]|| || || ||
 
|-
 
|-
| krb5_prompter_posix || || || ||
 
  +
| krb5_unparse_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_unparse_name.html]|| || || ||
 
|-
 
|-
| krb5_realm_compare || || || ||
 
  +
| krb5_unparse_name_ext [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_unparse_name_ext.html]|| || || ||
 
|-
 
|-
| krb5_recvauth || || || ||
 
  +
| krb5_unparse_name_flags [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_unparse_name_flags.html] || || || ||
 
|-
 
|-
| krb5_recvauth_version || || || ||
 
  +
| krb5_unparse_name_flags_ext [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_unparse_name_flags_ext.html] || || || ||
 
|-
 
|-
| krb5_set_default_realm || || || ||
 
  +
| krb5_us_timeofday [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_us_timeofday.html]|| || || ||
  +
|-
  +
| krb5_verify_authdata_kdc_issued [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_verify_authdata_kdc_issued.html]|| || || ||
  +
|-
  +
|}
  +
  +
{| class="wikitable"
  +
|+ Tier 2 - High priority
  +
|-
  +
! API
  +
! who writes?
  +
! who reviews?
  +
! reviewed?
  +
! comments
 
|-
 
|-
| krb5_set_password || || || ||
 
 
|-
 
|-
| krb5_set_password_using_ccache || || || ||
 
  +
| krb5_cc_close [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_close.html] || || || ||
 
|-
 
|-
| krb5_set_principal_realm || || || ||
 
  +
| krb5_cc_default [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_default.html]|| || || ||
 
|-
 
|-
| krb5_set_trace_callback || || || ||
 
  +
| krb5_cc_default_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_default_name.html]|| || || ||
 
|-
 
|-
| krb5_set_trace_filename || || || ||
 
  +
| krb5_cc_destroy [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_destroy.html]|| || || ||
 
|-
 
|-
| krb5_sname_to_principal || || || ||
 
  +
| krb5_cc_dup [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_dup.html]|| || || ||
 
|-
 
|-
| krb5_unparse_name || || || ||
 
  +
| krb5_cc_get_name [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_get_name.html]|| || || ||
 
|-
 
|-
| krb5_unparse_name_ext || || || ||
 
  +
| krb5_cc_get_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_get_principal.html]|| || || ||
 
|-
 
|-
| krb5_unparse_name_flags || || || ||
 
  +
| krb5_cc_get_type [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_get_type.html]|| || || ||
 
|-
 
|-
| krb5_unparse_name_flags_ext || || || ||
 
  +
| krb5_cc_initialize [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_initialize.html]|| || || ||
 
|-
 
|-
| krb5_us_timeofday || || || ||
 
  +
| krb5_cc_new_unique [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_new_unique.html]|| || || ||
 
|-
 
|-
| krb5_verify_authdata_kdc_issued || || || ||
 
  +
| krb5_cc_resolve [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_cc_resolve.html]|| || || ||
 
|-
 
|-
 
|}
 
|}

Revision as of 17:39, 31 January 2011

This is an early stage project for MIT Kerberos. It is being fleshed out by its proponents. Feel free to help flesh out the details of this project. After the project is ready, it will be presented for review and approval.


Purpose

To keep track of the various tasks that need to be documented such as function documentation, administration, troubleshooting etc.

API documentation

Matrix of Document-Type VS Intended Readership
Doc-type/Reader Architectural Guide Setup & Config of Kerberos Admin & Operations of Kerberos Custom Build API Description API Details
End-users
Architects
System Admins
Application Developers
GSSAPI Developers
Kerberos Developers


Most commonly used API functions (in alphabetical order)

Tier 1 - Highest priority
API who writes? who reviews? reviewed? comments
krb5_build_principal [1]
krb5_build_principal_alloc_va [2]
krb5_build_principal_ext [3]
krb5_change_password [4]
krb5_free_context [5]
krb5_free_error_message [6]
krb5_free_principal [7]
krb5_fwd_tgt_cred [8]
krb5_get_default_realm [9]
krb5_get_error_message [10]
krb5_get_host_realm [11]
krb5_get_credentials [12]
krb5_get_fallback_host_realm [13]
krb5_get_init_creds_keytab [14]
krb5_get_init_creds_opt_alloc [15]
krb5_get_init_creds_opt_free [16]
krb5_get_init_creds_opt_get_fast_flags [17]
krb5_get_init_creds_opt_init [18]
krb5_get_init_creds_opt_set_address_list [19]
krb5_get_init_creds_opt_set_anonymous [20]
krb5_get_init_creds_opt_set_canonicalize [21]
krb5_get_init_creds_opt_set_change_password_prompt [22]
krb5_get_init_creds_opt_set_etype_list [23]
krb5_get_init_creds_opt_set_expire_callback [24]
krb5_get_init_creds_opt_set_fast_ccache [25]
krb5_get_init_creds_opt_set_fast_ccache_name [26]
krb5_get_init_creds_opt_set_fast_flags [27]
krb5_get_init_creds_opt_set_forwardable [28]
krb5_get_init_creds_opt_set_out_ccache [29]
krb5_get_init_creds_opt_set_pa [30]
krb5_get_init_creds_opt_set_preauth_list [31]
krb5_get_init_creds_opt_set_proxiable [32]
krb5_get_init_creds_opt_set_renew_life [33]
krb5_get_init_creds_opt_set_salt [34]
krb5_get_init_creds_opt_set_tkt_life [35]
krb5_get_init_creds_password [36]
krb5_get_profile [37]
krb5_get_prompt_types [38]
krb5_get_renewed_creds [39]
krb5_get_validated_creds [40]
krb5_init_context [41]
krb5_init_secure_context [42]
krb5_is_config_principal [43]
krb5_is_thread_safe [44]
krb5_kt_close [45]
krb5_kt_default [46]
krb5_kt_default_name [47]
krb5_kt_get_name [48]
krb5_kt_get_type [49]
krb5_kt_resolve [50]
krb5_kuserok [51]
krb5_parse_name [52]
krb5_parse_name_flags [53]
krb5_principal_compare [54]
krb5_principal_compare_any_realm [55]
krb5_principal_compare_flags [56]
krb5_prompter_posix [57]
krb5_realm_compare [58]
krb5_recvauth [59]
krb5_recvauth_version [60]
krb5_set_default_realm [61]
krb5_set_password [62]
krb5_set_password_using_ccache [63]
krb5_set_principal_realm [64]
krb5_set_trace_callback [65]
krb5_set_trace_filename [66]
krb5_sname_to_principal [67]
krb5_unparse_name [68]
krb5_unparse_name_ext [69]
krb5_unparse_name_flags [70]
krb5_unparse_name_flags_ext [71]
krb5_us_timeofday [72]
krb5_verify_authdata_kdc_issued [73]
Tier 2 - High priority
API who writes? who reviews? reviewed? comments
krb5_cc_close [74]
krb5_cc_default [75]
krb5_cc_default_name [76]
krb5_cc_destroy [77]
krb5_cc_dup [78]
krb5_cc_get_name [79]
krb5_cc_get_principal [80]
krb5_cc_get_type [81]
krb5_cc_initialize [82]
krb5_cc_new_unique [83]
krb5_cc_resolve [84]