diff options
| author | Greg Hudson <ghudson@mit.edu> | 2009-10-30 10:49:38 +0000 |
|---|---|---|
| committer | Greg Hudson <ghudson@mit.edu> | 2009-10-30 10:49:38 +0000 |
| commit | 181ffdcba43c63b78f173bfebfac3a7b7c1bb6e0 (patch) | |
| tree | 4f1b81f4e72a9e463f1a03f6b3733a82210e9a25 /doc | |
| parent | 066b1f5f4de6531c90fb98d06329437dbe3adb83 (diff) | |
| download | krb5-181ffdcba43c63b78f173bfebfac3a7b7c1bb6e0.zip krb5-181ffdcba43c63b78f173bfebfac3a7b7c1bb6e0.tar.gz krb5-181ffdcba43c63b78f173bfebfac3a7b7c1bb6e0.tar.bz2 | |
Update the kadm5 design documentation slightly to reflect that MIT
doesn't commit to a stable libkadm5 C API.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@23095 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/kadm5/api-server-design.tex | 23 |
1 files changed, 17 insertions, 6 deletions
diff --git a/doc/kadm5/api-server-design.tex b/doc/kadm5/api-server-design.tex index 61fc868..228e831 100644 --- a/doc/kadm5/api-server-design.tex +++ b/doc/kadm5/api-server-design.tex @@ -130,12 +130,23 @@ CHECK_HANDLE and return the result. \section{API Versioning} -The KADM5 system is designed to support multiple versions of the KADM5 -API. Presently, two versions exist: KADM5_API_VERSION_1 and -KADM5_API_VERSION_2. The former is equivalant to the initial -OpenVision API, OVSEC_KADM_API_VERSION_1; the latter was created -during the initial integration of the OpenVision system into the MIT -release. +The KADM5 system was designed by OpenVision to support multiple +versions of the KADM5 API. MIT has not adopted this level of support, +and considers the KADM5 C API to be unstable from release to release. +This section describes the original design intent; bear in mind that +only the most recent API is supported by current MIT krb5 releases, +and that the API version does not necessarily change with API changes +unless there is a need to do so for wire compatibility. + +Historically, three versions of the KADM5 API have existed: +KADM5_API_VERSION_1 through KADM5_API_VERSION_3. The first version +was equivalent to the initial OpenVision API, +OVSEC_KADM_API_VERSION_1; the second was created during the initial +integration of the OpenVision system into the MIT release; and the +third was created for MIT krb5 1.8 to add lockout fields to policy +entries. MIT dropped wire compatibility support for version 1 in MIT +krb5 1.8 (as version 1 was never used in shipped MIT code), but +retains wire compatibility support for version 2. Implementing a versioned API in C via with both local and RPC access presents a number of design issues, some of them quite subtle. The |