.\"	$NetBSD: krb5_rcache.3,v 1.2 2017/01/28 21:31:49 christos Exp $
.\"
.\" Copyright (c) 2004 Kungliga Tekniska Högskolan
.\" (Royal Institute of Technology, Stockholm, Sweden).
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" 3. Neither the name of the Institute nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" Id
.\"
.Dd May  1, 2006
.Dt KRB5_RCACHE 3
.Os
.Sh NAME
.Nm krb5_rcache ,
.Nm krb5_rc_close ,
.Nm krb5_rc_default ,
.Nm krb5_rc_default_name ,
.Nm krb5_rc_default_type ,
.Nm krb5_rc_destroy ,
.Nm krb5_rc_expunge ,
.Nm krb5_rc_get_lifespan ,
.Nm krb5_rc_get_name ,
.Nm krb5_rc_get_type ,
.Nm krb5_rc_initialize ,
.Nm krb5_rc_recover ,
.Nm krb5_rc_resolve ,
.Nm krb5_rc_resolve_full ,
.Nm krb5_rc_resolve_type ,
.Nm krb5_rc_store ,
.Nm krb5_get_server_rcache
.Nd Kerberos 5 replay cache
.Sh LIBRARY
Kerberos 5 Library (libkrb5, -lkrb5)
.Sh SYNOPSIS
.In krb5/krb5.h
.Pp
.Li "struct krb5_rcache;"
.Pp
.Ft krb5_error_code
.Fo krb5_rc_close
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_default
.Fa "krb5_context context"
.Fa "krb5_rcache *id"
.Fc
.Ft "const char *"
.Fo krb5_rc_default_name
.Fa "krb5_context context"
.Fc
.Ft "const char *"
.Fo krb5_rc_default_type
.Fa "krb5_context context"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_destroy
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_expunge
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_get_lifespan
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fa "krb5_deltat *auth_lifespan"
.Fc
.Ft "const char*"
.Fo krb5_rc_get_name
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft "const char*"
.Fo "krb5_rc_get_type"
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_initialize
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fa "krb5_deltat auth_lifespan"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_recover
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_resolve
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fa "const char *name"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_resolve_full
.Fa "krb5_context context"
.Fa "krb5_rcache *id"
.Fa "const char *string_name"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_resolve_type
.Fa "krb5_context context"
.Fa "krb5_rcache *id"
.Fa "const char *type"
.Fc
.Ft krb5_error_code
.Fo krb5_rc_store
.Fa "krb5_context context"
.Fa "krb5_rcache id"
.Fa "krb5_donot_replay *rep"
.Fc
.Ft krb5_error_code
.Fo krb5_get_server_rcache
.Fa "krb5_context context"
.Fa "const krb5_data *piece"
.Fa "krb5_rcache *id"
.Fc
.Sh DESCRIPTION
The
.Li krb5_rcache
structure holds a storage element that is used for data manipulation.
The structure contains no public accessible elements.
.Pp
.Fn krb5_rc_initialize
Creates the reply cache
.Fa id
and sets it lifespan to
.Fa auth_lifespan .
If the cache already exists, the content is destroyed.
.Sh SEE ALSO
.Xr krb5 3 ,
.Xr krb5_data 3 ,
.Xr kerberos 8