The first revision after the creation of the

implementor's guide

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@3770 dc483132-0cff-0310-8789-dd5450dbe970

1 files changed, 43 insertions, 76 deletions

diff --git a/doc/api/ccache.tex b/doc/api/ccache.tex
index 983eb0d8b..d35c80094 100644
--- a/doc/api/ccache.tex
+++ b/doc/api/ccache.tex
@@ -3,31 +3,57 @@ specific types of credentials caches) deal with storing credentials
 (tickets, session keys, and other identifying information) in a
 semi-permanent store for later use by different programs.
 
-\subsubsection{Per-type functions}
-The following entry points must be implemented for each type of
-credentials cache; however, applications are not expected to have a need
-to call either \funcname{krb5_cc_resolve_internal} or
-\funcname{krb5_cc_gennew_internal}.
+\begin{funcdecl}{krb5_cc_resolve}{krb5_error_code}{\funcin}
+\funcarg{char *}{string_name}
+\funcout
+\funcarg{krb5_ccache *}{id}
+\end{funcdecl}
 
+Fills in \funcparam{id} with a ccache identifier which corresponds to
+the name in \funcparam{string_name}.  
 
-\begin{funcdecl}{krb5_cc_resolve_internal}{krb5_error_code}{\funcout}
+Requires that \funcparam{string_name} be of the form ``type:residual'' and
+``type'' is a type known to the library.
+
+\begin{funcdecl}{krb5_cc_generate_new}{krb5_error_code}{\funcin}
+\funcarg{krb5_cc_ops *}{ops}
+\funcout
 \funcarg{krb5_ccache *}{id}
-\funcin
-\funcarg{char *}{residual}
 \end{funcdecl}
 
-Creates a credentials cache named by \funcparam{residual} (which may be
-interpreted differently by each type of ccache).  The cache is not
-opened, but the cache name is held in reserve.
 
-\begin{funcdecl}{krb5_cc_gen_new_internal}{krb5_error_code}{\funcout}
-\funcarg{krb5_ccache *}{id}
+Fills in \funcparam{id} with a unique ccache identifier of a type defined by
+\funcparam{ops}.  The cache is left unopened.
+
+\begin{funcdecl}{krb5_cc_register}{krb5_error_code}{\funcin}
+\funcarg{krb5_cc_ops *}{ops}
+\funcarg{krb5_boolean}{override}
 \end{funcdecl}
 
-Creates a new credentials cache whose name is guaranteed to be
-unique.  The cache is not opened. \funcparam{*id} is
-filled in with a \datatype{krb5_ccache} which may be used in subsequent
-calls to ccache functions.
+Adds a new cache type identified and implemented by \funcparam{ops} to
+the set recognized by \funcname{krb5_cc_resolve}.
+If \funcparam{override} is FALSE, a ticket cache type named
+\funcparam{ops{\ptsto}prefix} must not be known.
+
+\begin{funcdecl}{krb5_cc_get_name}{char *}{\funcin}
+\funcarg{krb5_ccache}{id}
+\end{funcdecl}
+
+Returns the name of the ccache denoted by \funcparam{id}.
+
+\begin{funcdecl}{krb5_cc_default_name}{char *}{\funcvoid}
+\end{funcdecl}
+
+Returns the name of the default credentials cache; this may be equivalent to
+\funcnamenoparens{getenv}({\tt "KRB5CCACHE"}) with an appropriate fallback.
+
+\begin{funcdecl}{krb5_cc_default}{krb5_error_code}{\funcout}
+\funcarg{krb5_ccache *}{ccache}
+\end{funcdecl}
+
+Equivalent to
+\funcnamenoparens{krb5_cc_resolve}(\funcname{krb5_cc_default_name},
+\funcparam{ccache}).
 
 \begin{funcdecl}{krb5_cc_initialize}{krb5_error_code}{\funcinout}
 \funcarg{krb5_ccache}{id}
@@ -117,8 +143,6 @@ Requires that \funcparam{id} identifies a valid credentials cache.
 \end{funcdecl}
 
 Prepares to sequentially read every set of cached credentials.
-Requires that \funcparam{id} identifies a valid credentials cache opened by
-\funcname{krb5_cc_open}.
 \funcparam{cursor} is filled in with a cursor to be used in calls to
 \funcname{krb5_cc_next_cred}.
 
@@ -178,60 +202,3 @@ Sets the flags on the cache \funcparam{id} to \funcparam{flags}.  Useful
 flags are defined in {\tt <krb5/ccache.h>}.
 
 
-\subsubsection{Glue functions}
-The following functions are implemented in the base library and serve to
-glue together the various types of credentials caches.
-
-
-\begin{funcdecl}{krb5_cc_resolve}{krb5_error_code}{\funcin}
-\funcarg{char *}{string_name}
-\funcout
-\funcarg{krb5_ccache *}{id}
-\end{funcdecl}
-
-Fills in \funcparam{id} with a ccache identifier which corresponds to
-the name in \funcparam{string_name}.  The cache is left unopened.
-
-Requires that \funcparam{string_name} be of the form ``type:residual'' and
-``type'' is a type known to the library.
-
-\begin{funcdecl}{krb5_cc_generate_new}{krb5_error_code}{\funcin}
-\funcarg{krb5_cc_ops *}{ops}
-\funcout
-\funcarg{krb5_ccache *}{id}
-\end{funcdecl}
-
-
-Fills in \funcparam{id} with a unique ccache identifier of a type defined by
-\funcparam{ops}.  The cache is left unopened.
-
-\begin{funcdecl}{krb5_cc_register}{krb5_error_code}{\funcin}
-\funcarg{krb5_cc_ops *}{ops}
-\funcarg{krb5_boolean}{override}
-\end{funcdecl}
-
-Adds a new cache type identified and implemented by \funcparam{ops} to
-the set recognized by \funcname{krb5_cc_resolve}.
-If \funcparam{override} is FALSE, a ticket cache type named
-\funcparam{ops{\ptsto}prefix} must not be known.
-
-\begin{funcdecl}{krb5_cc_get_name}{char *}{\funcin}
-\funcarg{krb5_ccache}{id}
-\end{funcdecl}
-
-Returns the name of the ccache denoted by \funcparam{id}.
-
-\begin{funcdecl}{krb5_cc_default_name}{char *}{\funcvoid}
-\end{funcdecl}
-
-Returns the name of the default credentials cache; this may be equivalent to
-\funcnamenoparens{getenv}({\tt "KRB5CCACHE"}) with an appropriate fallback.
-
-\begin{funcdecl}{krb5_cc_default}{krb5_error_code}{\funcout}
-\funcarg{krb5_ccache *}{ccache}
-\end{funcdecl}
-
-Equivalent to
-\funcnamenoparens{krb5_cc_resolve}(\funcname{krb5_cc_default_name},
-\funcparam{ccache}).
-