next up previous contents
Next: Key table functions Up: Replay cache functions Previous: The krb5_rc_ops structure   Contents

Per-type functions

The following entry points must be implemented for each type of replay cache.


\begin{funcdecl}{init}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\funcarg{krb5_deltat}{auth_lifespan}
\end{funcdecl}

Creates/refreshes the replay cache identified by id and sets its authenticator lifespan to auth_lifespan. If the replay cache already exists, its contents are destroyed.


\begin{funcdecl}{recover}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\end{funcdecl}
Attempts to recover the replay cache id, (presumably after a system crash or server restart).


\begin{funcdecl}{destroy}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\end{funcdecl}

Destroys the replay cache id. Requires that id identifies a valid replay cache.


\begin{funcdecl}{close}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\end{funcdecl}

Closes the replay cache id, invalidates id, and releases any other resources acquired during use of the replay cache. Requires that id identifies a valid replay cache.


\begin{funcdecl}{store}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\funcarg{krb5_donot_replay *}{rep}
\end{funcdecl}
Stores rep in the replay cache id. Requires that id identifies a valid replay cache.

Returns KRB5KRB_AP_ERR_REPEAT if rep is already in the cache. May also return permission errors, storage failure errors.


\begin{funcdecl}{expunge}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\end{funcdecl}
Removes all expired replay information (i.e. those entries which are older than then authenticator lifespan of the cache) from the cache id. Requires that id identifies a valid replay cache.


\begin{funcdecl}{get_span}{krb5_error_code}{\funcin}
\funcarg{krb5_rcache}{id}
\funcout
\funcarg{krb5_deltat *}{auth_lifespan}
\end{funcdecl}
Fills in auth_lifespan with the lifespan of the cache id. Requires that id identifies a valid replay cache.


\begin{funcdecl}{resolve}{krb5_error_code}{\funcinout}
\funcarg{krb5_rcache}{id}
\funcin
\funcarg{char *}{name}
\end{funcdecl}

Initializes private data attached to id. This function MUST be called before the other per-replay cache functions.

Requires that id points to allocated space, with an initialized idops field.

Since resolve allocates memory, close must be called to free the allocated memory, even if neither init or recover were successfully called by the application.


\begin{funcdecl}{krb5_rc_get_name}{char *}{\funcin}
\funcarg{krb5_rcache}{id}
\end{funcdecl}

Returns the name (excluding the type) of the rcache id. Requires that id identifies a valid replay cache.


next up previous contents
Next: Key table functions Up: Replay cache functions Previous: The krb5_rc_ops structure   Contents
Autobuild 2006-06-16