logo_kerberos.gif

Difference between revisions of "Projects/Documentation Tasks"

From K5Wiki
Jump to: navigation, search
(Updated the list of the topics in the Application Development section)
m (fix formatting (spurious empty cells))
Line 93: Line 93:
 
| <ul><li> Thread safety</ul>|| || || ||
  
| <ul><li> Thread safety</ul>|| || || ||
 
|-
  
|-
−
| MIT Kerberos features : quick facts || ZT || || || ongoing ||
 +
| MIT Kerberos features : quick facts || ZT || || || ongoing
 
|-
  
|-
 
|}
  
|}
Line 156: Line 156:
 
| Troubleshooting|| || || ||
  
| Troubleshooting|| || || ||
 
|-
  
|-
−
| <ul><li>Troubleshooting errors</ul> || ZT || || || ongoing||
 +
| <ul><li>Troubleshooting errors</ul> || ZT || || || ongoing
 
|-
  
|-
 
| <ul><li>Trace logging</ul>|| || || ||
  
| <ul><li>Trace logging</ul>|| || || ||
 
|-
  
|-
−
| Using LDAP server for Kerberos backend|| ZT || || || Ubuntu 10.4 (lucid)||
 +
| Using LDAP server for Kerberos backend|| ZT || || || Ubuntu 10.4 (lucid)
 
|-
  
|-
 
|}
  
|}
Line 215: Line 215:
 
| krb5_free_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_free_principal.html]|| ZT ||GH || ||
  
| krb5_free_principal [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_free_principal.html]|| ZT ||GH || ||
 
|-
  
|-
−
| krb5_fwd_tgt_cred [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_fwd_tgt_cred.html]|| ZT || GH|| || Needs example ||
 +
| krb5_fwd_tgt_cred [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_fwd_tgt_cred.html]|| ZT || GH|| || Needs example
 
|-
  
|-
 
| krb5_get_default_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_default_realm.html]|| ZT || GH|| ||
  
| krb5_get_default_realm [http://web.mit.edu/tsitkova/www/build/refs/api/krb5_get_default_realm.html]|| ZT || GH|| ||
Line 358: Line 358:
 
|-
  
|-
 
|-
  
|-
−
| GH || Greg Hudson ||
 +
| GH || Greg Hudson
 
|-
  
|-
−
| MIT || MITKC group||
 +
| MIT || MITKC group
 
|-
  
|-
−
| TY|| Tom Yu ||
 +
| TY|| Tom Yu
 
|-
  
|-
−
| ZT || Zhanna Tsitkova ||
 +
| ZT || Zhanna Tsitkova
 
|-
  
|-
 
|}
  
|}

Revision as of 11:25, 31 August 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.


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


Application development

task who writes? who reviews? reviewed? comments
Designing a new protocol, or extending existing one, to use GSS-API
Choosing security API
  • GSS-API vs SASL vs KRB5
  • A guide to the similarities and differences between Heimdal and MIT Kerberos API
GSS-API
  • A basic introduction to GSS-API, making use of the sample client and server, with special attention paid to Kerberos-related GSS-API issues
  • How to tell the GSS-API library on the client side where the existing Kerberos ticket cache is
  • How to write mechanism-independent GSS-API code
  • Acceptor naming - How to get servers to use any key in a keytab
 GH
  • A guide to GSS-API naming as compared to Kerberos principal naming
  • Using IAKERB
  • Anonymous credentials
  • Delegating credentials
 MIT
  • Available extensions
 ZT
  • Thread safety
Developing plugins GH
  • A guide to developing plugins
  • Overview of existing pluggable interfaces
Krb5 library guide
  • A more advanced introduction to using the Kerberos libraries for initial authentication, focusing on the authentication steps, validating initial credential
 TY
  • An introduction to ticket caches and keytabs and their corresponding APIs
  • An advanced guide to the pre-auth mechanisms, FAST
  • An advanced guide to the principal manipulation and parsing
 TY
  • Thread safety
MIT Kerberos features : quick facts ZT ongoing


Administration

task who writes? who reviews? reviewed? comments
Setting a new realm
  • Choosing backend: LDAP vs DB2
  • Replication
Integration Kerberos with Login System
  • Validating Kerberos tickets
  • Clear text password over HTTPS
  • Configuring with krb5_pam module
  • Storing/locating keytab
Cross-realm
  • cross-realm interaction with AD
Performance
  • Performance tuning tips
  • Performance tradeoffs
Keying workstation/ host key setting
Using Smartcard with PKINIT
Selecting and configuring plugins
Kerberized ssh
  • Configuration
  • Cross-realm and ssh
Selecting and configuring plugins GH
Anonymity support
A guide to principal naming basics and structure
Troubleshooting
  • Troubleshooting errors
 ZT ongoing
  • Trace logging
Using LDAP server for Kerberos backend ZT Ubuntu 10.4 (lucid)


API documentation

Most commonly used API functions (in alphabetical order)

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

Abbreviations

abbreviation full names?
GH Greg Hudson
MIT MITKC group
TY Tom Yu
ZT Zhanna Tsitkova
Retrieved from "https://k5wiki.kerberos.org./wiki?title=Projects/Documentation_Tasks&oldid=3938"