logo_kerberos.gif

Difference between revisions of "Projects/Documentation Tasks"

From K5Wiki
Jump to: navigation, search
(→‎API documentation)
(→‎API documentation: remove extra nameless column on right edge of tables)
Line 19: Line 19:
 
|-
  
|-
 
|-
  
|-
−
| End-users || || || || || || ||
 +
| End-users || || || || || ||
 
|-
  
|-
−
| Architects || || || || || || ||
 +
| Architects || || || || || ||
 
|-
  
|-
−
|System Admins || || || || || || ||
 +
|System Admins || || || || || ||
 
|-
  
|-
−
|Application Developers || || || || || || ||
 +
|Application Developers || || || || || ||
 
|-
  
|-
−
|GSSAPI Developers || || || || || || ||
 +
|GSSAPI Developers || || || || || ||
 
|-
  
|-
−
|Kerberos Developers || || || || || || ||
 +
|Kerberos Developers || || || || || ||
 
|}
  
|}
   
Line 45: Line 45:
 
|-
  
|-
 
|-
  
|-
−
| krb5_build_principal || || || || ||
 +
| krb5_build_principal || || || ||
 
|-
  
|-
−
| krb5_build_principal || || || || ||
 +
| krb5_build_principal || || || ||
 
|-
  
|-
−
|krb5_build_principal_alloc_val || || || || ||
 +
|krb5_build_principal_alloc_val || || || ||
 
|-
  
|-
−
| krb5_build_principal_ext || || || || ||
 +
| krb5_build_principal_ext || || || ||
 
|-
  
|-
−
| krb5_cc_close || || || || ||
 +
| krb5_cc_close || || || ||
 
|-
  
|-
−
| krb5_cc_default || || || || ||
 +
| krb5_cc_default || || || ||
 
|-
  
|-
−
| krb5_cc_default_name || || || || ||
 +
| krb5_cc_default_name || || || ||
 
|-
  
|-
−
| krb5_cc_destroy || || || || ||
 +
| krb5_cc_destroy || || || ||
 
|-
  
|-
−
| krb5_cc_dup || || || || ||
 +
| krb5_cc_dup || || || ||
 
|-
  
|-
−
| krb5_cc_get_name || || || || ||
 +
| krb5_cc_get_name || || || ||
 
|-
  
|-
−
| krb5_cc_get_principal || || || || ||
 +
| krb5_cc_get_principal || || || ||
 
|-
  
|-
−
| krb5_cc_get_type || || || || ||
 +
| krb5_cc_get_type || || || ||
 
|-
  
|-
−
| krb5_cc_initialize || || || || ||
 +
| krb5_cc_initialize || || || ||
 
|-
  
|-
−
| krb5_cc_new_unique || || || || ||
 +
| krb5_cc_new_unique || || || ||
 
|-
  
|-
−
| krb5_cc_resolve || || || || ||
 +
| krb5_cc_resolve || || || ||
 
|-
  
|-
−
| krb5_change_password || || || || ||
 +
| krb5_change_password || || || ||
 
|-
  
|-
−
| krb5_free_context || || || || ||
 +
| krb5_free_context || || || ||
 
|-
  
|-
−
| krb5_free_error_message || || || || ||
 +
| krb5_free_error_message || || || ||
 
|-
  
|-
−
| krb5_free_principal || || || || ||
 +
| krb5_free_principal || || || ||
 
|-
  
|-
−
| krb5_fwd_tgt_cred || || || || ||
 +
| krb5_fwd_tgt_cred || || || ||
 
|-
  
|-
−
| krb5_get_default_realm || || || || ||
 +
| krb5_get_default_realm || || || ||
 
|-
  
|-
−
| krb5_get_error_message || || || || ||
 +
| krb5_get_error_message || || || ||
 
|-
  
|-
−
| krb5_get_host_realm || || || || ||
 +
| krb5_get_host_realm || || || ||
 
|-
  
|-
−
| krb5_get_credentials || || || || ||
 +
| krb5_get_credentials || || || ||
 
|-
  
|-
−
| krb5_get_fallback_host_realm || || || || ||
 +
| krb5_get_fallback_host_realm || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_keytab || || || || ||
 +
| krb5_get_init_creds_keytab || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_alloc || || || || ||
 +
| krb5_get_init_creds_opt_alloc || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_free || || || || ||
 +
| krb5_get_init_creds_opt_free || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_get_fast_flags || || || || ||
 +
| krb5_get_init_creds_opt_get_fast_flags || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_init || || || || ||
 +
| krb5_get_init_creds_opt_init || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_address_list || || || || ||
 +
| krb5_get_init_creds_opt_set_address_list || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_anonymous || || || || ||
 +
| krb5_get_init_creds_opt_set_anonymous || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_canonicalize || || || || ||
 +
| krb5_get_init_creds_opt_set_canonicalize || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_change_password_prompt || || || || ||
 +
| krb5_get_init_creds_opt_set_change_password_prompt || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_etype_list || || || || ||
 +
| krb5_get_init_creds_opt_set_etype_list || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_expire_callback || || || || ||
 +
| krb5_get_init_creds_opt_set_expire_callback || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_fast_ccache || || || || ||
 +
| krb5_get_init_creds_opt_set_fast_ccache || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_fast_ccache_name || || || || ||
 +
| krb5_get_init_creds_opt_set_fast_ccache_name || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_fast_flags || || || || ||
 +
| krb5_get_init_creds_opt_set_fast_flags || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_forwardable || || || || ||
 +
| krb5_get_init_creds_opt_set_forwardable || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_out_ccache || || || || ||
 +
| krb5_get_init_creds_opt_set_out_ccache || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_pa || || || || ||
 +
| krb5_get_init_creds_opt_set_pa || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_preauth_list || || || || ||
 +
| krb5_get_init_creds_opt_set_preauth_list || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_proxiable || || || || ||
 +
| krb5_get_init_creds_opt_set_proxiable || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_renew_life || || || || ||
 +
| krb5_get_init_creds_opt_set_renew_life || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_salt || || || || ||
 +
| krb5_get_init_creds_opt_set_salt || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_opt_set_tkt_life || || || || ||
 +
| krb5_get_init_creds_opt_set_tkt_life || || || ||
 
|-
  
|-
−
| krb5_get_init_creds_password || || || || ||
 +
| krb5_get_init_creds_password || || || ||
 
|-
  
|-
−
| krb5_get_profile || || || || ||
 +
| krb5_get_profile || || || ||
 
|-
  
|-
−
| krb5_get_prompt_types || || || || ||
 +
| krb5_get_prompt_types || || || ||
 
|-
  
|-
−
| krb5_get_renewed_creds || || || || ||
 +
| krb5_get_renewed_creds || || || ||
 
|-
  
|-
−
| krb5_get_validated_creds || || || || ||
 +
| krb5_get_validated_creds || || || ||
 
|-
  
|-
−
| krb5_init_context || || || || ||
 +
| krb5_init_context || || || ||
 
|-
  
|-
−
| krb5_init_secure_context || || || || ||
 +
| krb5_init_secure_context || || || ||
 
|-
  
|-
−
| krb5_is_config_principal || || || || ||
 +
| krb5_is_config_principal || || || ||
 
|-
  
|-
−
| krb5_is_thread_safe || || || || ||
 +
| krb5_is_thread_safe || || || ||
 
|-
  
|-
−
| krb5_kt_close || || || || ||
 +
| krb5_kt_close || || || ||
 
|-
  
|-
−
| krb5_kt_default || || || || ||
 +
| krb5_kt_default || || || ||
 
|-
  
|-
−
| krb5_kt_default_name || || || || ||
 +
| krb5_kt_default_name || || || ||
 
|-
  
|-
−
| krb5_kt_get_name || || || || ||
 +
| krb5_kt_get_name || || || ||
 
|-
  
|-
−
| krb5_kt_get_type || || || || ||
 +
| krb5_kt_get_type || || || ||
 
|-
  
|-
−
| krb5_kt_resolve || || || || ||
 +
| krb5_kt_resolve || || || ||
 
|-
  
|-
−
| krb5_kuserok || || || || ||
 +
| krb5_kuserok || || || ||
 
|-
  
|-
−
| krb5_parse_name || || || || ||
 +
| krb5_parse_name || || || ||
 
|-
  
|-
−
| krb5_parse_name_flags || || || || ||
 +
| krb5_parse_name_flags || || || ||
 
|-
  
|-
−
| krb5_principal_compare || || || || ||
 +
| krb5_principal_compare || || || ||
 
|-
  
|-
−
| krb5_principal_compare_any_realm || || || || ||
 +
| krb5_principal_compare_any_realm || || || ||
 
|-
  
|-
−
| krb5_principal_compare_flags || || || || ||
 +
| krb5_principal_compare_flags || || || ||
 
|-
  
|-
−
| krb5_prompter_posix || || || || ||
 +
| krb5_prompter_posix || || || ||
 
|-
  
|-
−
| krb5_realm_compare || || || || ||
 +
| krb5_realm_compare || || || ||
 
|-
  
|-
−
| krb5_recvauth || || || || ||
 +
| krb5_recvauth || || || ||
 
|-
  
|-
−
| krb5_recvauth_version || || || || ||
 +
| krb5_recvauth_version || || || ||
 
|-
  
|-
−
| krb5_set_default_realm || || || || ||
 +
| krb5_set_default_realm || || || ||
 
|-
  
|-
−
| krb5_set_password || || || || ||
 +
| krb5_set_password || || || ||
 
|-
  
|-
−
| krb5_set_password_using_ccache || || || || ||
 +
| krb5_set_password_using_ccache || || || ||
 
|-
  
|-
−
| krb5_set_principal_realm || || || || ||
 +
| krb5_set_principal_realm || || || ||
 
|-
  
|-
−
| krb5_set_trace_callback || || || || ||
 +
| krb5_set_trace_callback || || || ||
 
|-
  
|-
−
| krb5_set_trace_filename || || || || ||
 +
| krb5_set_trace_filename || || || ||
 
|-
  
|-
−
| krb5_sname_to_principal || || || || ||
 +
| krb5_sname_to_principal || || || ||
 
|-
  
|-
−
| krb5_unparse_name || || || || ||
 +
| krb5_unparse_name || || || ||
 
|-
  
|-
−
| krb5_unparse_name_ext || || || || ||
 +
| krb5_unparse_name_ext || || || ||
 
|-
  
|-
−
| krb5_unparse_name_flags || || || || ||
 +
| krb5_unparse_name_flags || || || ||
 
|-
  
|-
−
| krb5_unparse_name_flags_ext || || || || ||
 +
| krb5_unparse_name_flags_ext || || || ||
 
|-
  
|-
−
| krb5_us_timeofday || || || || ||
 +
| krb5_us_timeofday || || || ||
 
|-
  
|-
−
| krb5_verify_authdata_kdc_issued || || || || ||
 +
| krb5_verify_authdata_kdc_issued || || || ||
 
|-
  
|-
 
|}
  
|}

Revision as of 01:23, 14 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



Tier 1 - most commonly used API functions (in alphabetical order)
API who writes? who reviews? reviewed? comments
krb5_build_principal
krb5_build_principal
krb5_build_principal_alloc_val
krb5_build_principal_ext
krb5_cc_close
krb5_cc_default
krb5_cc_default_name
krb5_cc_destroy
krb5_cc_dup
krb5_cc_get_name
krb5_cc_get_principal
krb5_cc_get_type
krb5_cc_initialize
krb5_cc_new_unique
krb5_cc_resolve
krb5_change_password
krb5_free_context
krb5_free_error_message
krb5_free_principal
krb5_fwd_tgt_cred
krb5_get_default_realm
krb5_get_error_message
krb5_get_host_realm
krb5_get_credentials
krb5_get_fallback_host_realm
krb5_get_init_creds_keytab
krb5_get_init_creds_opt_alloc
krb5_get_init_creds_opt_free
krb5_get_init_creds_opt_get_fast_flags
krb5_get_init_creds_opt_init
krb5_get_init_creds_opt_set_address_list
krb5_get_init_creds_opt_set_anonymous
krb5_get_init_creds_opt_set_canonicalize
krb5_get_init_creds_opt_set_change_password_prompt
krb5_get_init_creds_opt_set_etype_list
krb5_get_init_creds_opt_set_expire_callback
krb5_get_init_creds_opt_set_fast_ccache
krb5_get_init_creds_opt_set_fast_ccache_name
krb5_get_init_creds_opt_set_fast_flags
krb5_get_init_creds_opt_set_forwardable
krb5_get_init_creds_opt_set_out_ccache
krb5_get_init_creds_opt_set_pa
krb5_get_init_creds_opt_set_preauth_list
krb5_get_init_creds_opt_set_proxiable
krb5_get_init_creds_opt_set_renew_life
krb5_get_init_creds_opt_set_salt
krb5_get_init_creds_opt_set_tkt_life
krb5_get_init_creds_password
krb5_get_profile
krb5_get_prompt_types
krb5_get_renewed_creds
krb5_get_validated_creds
krb5_init_context
krb5_init_secure_context
krb5_is_config_principal
krb5_is_thread_safe
krb5_kt_close
krb5_kt_default
krb5_kt_default_name
krb5_kt_get_name
krb5_kt_get_type
krb5_kt_resolve
krb5_kuserok
krb5_parse_name
krb5_parse_name_flags
krb5_principal_compare
krb5_principal_compare_any_realm
krb5_principal_compare_flags
krb5_prompter_posix
krb5_realm_compare
krb5_recvauth
krb5_recvauth_version
krb5_set_default_realm
krb5_set_password
krb5_set_password_using_ccache
krb5_set_principal_realm
krb5_set_trace_callback
krb5_set_trace_filename
krb5_sname_to_principal
krb5_unparse_name
krb5_unparse_name_ext
krb5_unparse_name_flags
krb5_unparse_name_flags_ext
krb5_us_timeofday
krb5_verify_authdata_kdc_issued
Retrieved from "https://k5wiki.kerberos.org/wiki?title=Projects/Documentation_Tasks&oldid=3776"