xref: /minix3/crypto/external/bsd/heimdal/dist/lib/krb5/krb5_rcache.3 (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc.\"	$NetBSD: krb5_rcache.3,v 1.1.1.2 2011/04/14 14:09:23 elric Exp $
2*ebfedea0SLionel Sambuc.\"
3*ebfedea0SLionel Sambuc.\" Copyright (c) 2004 Kungliga Tekniska Högskolan
4*ebfedea0SLionel Sambuc.\" (Royal Institute of Technology, Stockholm, Sweden).
5*ebfedea0SLionel Sambuc.\" All rights reserved.
6*ebfedea0SLionel Sambuc.\"
7*ebfedea0SLionel Sambuc.\" Redistribution and use in source and binary forms, with or without
8*ebfedea0SLionel Sambuc.\" modification, are permitted provided that the following conditions
9*ebfedea0SLionel Sambuc.\" are met:
10*ebfedea0SLionel Sambuc.\"
11*ebfedea0SLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright
12*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer.
13*ebfedea0SLionel Sambuc.\"
14*ebfedea0SLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright
15*ebfedea0SLionel Sambuc.\"    notice, this list of conditions and the following disclaimer in the
16*ebfedea0SLionel Sambuc.\"    documentation and/or other materials provided with the distribution.
17*ebfedea0SLionel Sambuc.\"
18*ebfedea0SLionel Sambuc.\" 3. Neither the name of the Institute nor the names of its contributors
19*ebfedea0SLionel Sambuc.\"    may be used to endorse or promote products derived from this software
20*ebfedea0SLionel Sambuc.\"    without specific prior written permission.
21*ebfedea0SLionel Sambuc.\"
22*ebfedea0SLionel Sambuc.\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
23*ebfedea0SLionel Sambuc.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*ebfedea0SLionel Sambuc.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*ebfedea0SLionel Sambuc.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
26*ebfedea0SLionel Sambuc.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27*ebfedea0SLionel Sambuc.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28*ebfedea0SLionel Sambuc.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29*ebfedea0SLionel Sambuc.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30*ebfedea0SLionel Sambuc.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31*ebfedea0SLionel Sambuc.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32*ebfedea0SLionel Sambuc.\" SUCH DAMAGE.
33*ebfedea0SLionel Sambuc.\"
34*ebfedea0SLionel Sambuc.\" Id
35*ebfedea0SLionel Sambuc.\"
36*ebfedea0SLionel Sambuc.Dd May  1, 2006
37*ebfedea0SLionel Sambuc.Dt KRB5_RCACHE 3
38*ebfedea0SLionel Sambuc.Os
39*ebfedea0SLionel Sambuc.Sh NAME
40*ebfedea0SLionel Sambuc.Nm krb5_rcache ,
41*ebfedea0SLionel Sambuc.Nm krb5_rc_close ,
42*ebfedea0SLionel Sambuc.Nm krb5_rc_default ,
43*ebfedea0SLionel Sambuc.Nm krb5_rc_default_name ,
44*ebfedea0SLionel Sambuc.Nm krb5_rc_default_type ,
45*ebfedea0SLionel Sambuc.Nm krb5_rc_destroy ,
46*ebfedea0SLionel Sambuc.Nm krb5_rc_expunge ,
47*ebfedea0SLionel Sambuc.Nm krb5_rc_get_lifespan ,
48*ebfedea0SLionel Sambuc.Nm krb5_rc_get_name ,
49*ebfedea0SLionel Sambuc.Nm krb5_rc_get_type ,
50*ebfedea0SLionel Sambuc.Nm krb5_rc_initialize ,
51*ebfedea0SLionel Sambuc.Nm krb5_rc_recover ,
52*ebfedea0SLionel Sambuc.Nm krb5_rc_resolve ,
53*ebfedea0SLionel Sambuc.Nm krb5_rc_resolve_full ,
54*ebfedea0SLionel Sambuc.Nm krb5_rc_resolve_type ,
55*ebfedea0SLionel Sambuc.Nm krb5_rc_store ,
56*ebfedea0SLionel Sambuc.Nm krb5_get_server_rcache
57*ebfedea0SLionel Sambuc.Nd Kerberos 5 replay cache
58*ebfedea0SLionel Sambuc.Sh LIBRARY
59*ebfedea0SLionel SambucKerberos 5 Library (libkrb5, -lkrb5)
60*ebfedea0SLionel Sambuc.Sh SYNOPSIS
61*ebfedea0SLionel Sambuc.In krb5/krb5.h
62*ebfedea0SLionel Sambuc.Pp
63*ebfedea0SLionel Sambuc.Li "struct krb5_rcache;"
64*ebfedea0SLionel Sambuc.Pp
65*ebfedea0SLionel Sambuc.Ft krb5_error_code
66*ebfedea0SLionel Sambuc.Fo krb5_rc_close
67*ebfedea0SLionel Sambuc.Fa "krb5_context context"
68*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
69*ebfedea0SLionel Sambuc.Fc
70*ebfedea0SLionel Sambuc.Ft krb5_error_code
71*ebfedea0SLionel Sambuc.Fo krb5_rc_default
72*ebfedea0SLionel Sambuc.Fa "krb5_context context"
73*ebfedea0SLionel Sambuc.Fa "krb5_rcache *id"
74*ebfedea0SLionel Sambuc.Fc
75*ebfedea0SLionel Sambuc.Ft "const char *"
76*ebfedea0SLionel Sambuc.Fo krb5_rc_default_name
77*ebfedea0SLionel Sambuc.Fa "krb5_context context"
78*ebfedea0SLionel Sambuc.Fc
79*ebfedea0SLionel Sambuc.Ft "const char *"
80*ebfedea0SLionel Sambuc.Fo krb5_rc_default_type
81*ebfedea0SLionel Sambuc.Fa "krb5_context context"
82*ebfedea0SLionel Sambuc.Fc
83*ebfedea0SLionel Sambuc.Ft krb5_error_code
84*ebfedea0SLionel Sambuc.Fo krb5_rc_destroy
85*ebfedea0SLionel Sambuc.Fa "krb5_context context"
86*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
87*ebfedea0SLionel Sambuc.Fc
88*ebfedea0SLionel Sambuc.Ft krb5_error_code
89*ebfedea0SLionel Sambuc.Fo krb5_rc_expunge
90*ebfedea0SLionel Sambuc.Fa "krb5_context context"
91*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
92*ebfedea0SLionel Sambuc.Fc
93*ebfedea0SLionel Sambuc.Ft krb5_error_code
94*ebfedea0SLionel Sambuc.Fo krb5_rc_get_lifespan
95*ebfedea0SLionel Sambuc.Fa "krb5_context context"
96*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
97*ebfedea0SLionel Sambuc.Fa "krb5_deltat *auth_lifespan"
98*ebfedea0SLionel Sambuc.Fc
99*ebfedea0SLionel Sambuc.Ft "const char*"
100*ebfedea0SLionel Sambuc.Fo krb5_rc_get_name
101*ebfedea0SLionel Sambuc.Fa "krb5_context context"
102*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
103*ebfedea0SLionel Sambuc.Fc
104*ebfedea0SLionel Sambuc.Ft "const char*"
105*ebfedea0SLionel Sambuc.Fo "krb5_rc_get_type"
106*ebfedea0SLionel Sambuc.Fa "krb5_context context"
107*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
108*ebfedea0SLionel Sambuc.Fc
109*ebfedea0SLionel Sambuc.Ft krb5_error_code
110*ebfedea0SLionel Sambuc.Fo krb5_rc_initialize
111*ebfedea0SLionel Sambuc.Fa "krb5_context context"
112*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
113*ebfedea0SLionel Sambuc.Fa "krb5_deltat auth_lifespan"
114*ebfedea0SLionel Sambuc.Fc
115*ebfedea0SLionel Sambuc.Ft krb5_error_code
116*ebfedea0SLionel Sambuc.Fo krb5_rc_recover
117*ebfedea0SLionel Sambuc.Fa "krb5_context context"
118*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
119*ebfedea0SLionel Sambuc.Fc
120*ebfedea0SLionel Sambuc.Ft krb5_error_code
121*ebfedea0SLionel Sambuc.Fo krb5_rc_resolve
122*ebfedea0SLionel Sambuc.Fa "krb5_context context"
123*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
124*ebfedea0SLionel Sambuc.Fa "const char *name"
125*ebfedea0SLionel Sambuc.Fc
126*ebfedea0SLionel Sambuc.Ft krb5_error_code
127*ebfedea0SLionel Sambuc.Fo krb5_rc_resolve_full
128*ebfedea0SLionel Sambuc.Fa "krb5_context context"
129*ebfedea0SLionel Sambuc.Fa "krb5_rcache *id"
130*ebfedea0SLionel Sambuc.Fa "const char *string_name"
131*ebfedea0SLionel Sambuc.Fc
132*ebfedea0SLionel Sambuc.Ft krb5_error_code
133*ebfedea0SLionel Sambuc.Fo krb5_rc_resolve_type
134*ebfedea0SLionel Sambuc.Fa "krb5_context context"
135*ebfedea0SLionel Sambuc.Fa "krb5_rcache *id"
136*ebfedea0SLionel Sambuc.Fa "const char *type"
137*ebfedea0SLionel Sambuc.Fc
138*ebfedea0SLionel Sambuc.Ft krb5_error_code
139*ebfedea0SLionel Sambuc.Fo krb5_rc_store
140*ebfedea0SLionel Sambuc.Fa "krb5_context context"
141*ebfedea0SLionel Sambuc.Fa "krb5_rcache id"
142*ebfedea0SLionel Sambuc.Fa "krb5_donot_replay *rep"
143*ebfedea0SLionel Sambuc.Fc
144*ebfedea0SLionel Sambuc.Ft krb5_error_code
145*ebfedea0SLionel Sambuc.Fo krb5_get_server_rcache
146*ebfedea0SLionel Sambuc.Fa "krb5_context context"
147*ebfedea0SLionel Sambuc.Fa "const krb5_data *piece"
148*ebfedea0SLionel Sambuc.Fa "krb5_rcache *id"
149*ebfedea0SLionel Sambuc.Fc
150*ebfedea0SLionel Sambuc.Sh DESCRIPTION
151*ebfedea0SLionel SambucThe
152*ebfedea0SLionel Sambuc.Li krb5_rcache
153*ebfedea0SLionel Sambucstructure holds a storage element that is used for data manipulation.
154*ebfedea0SLionel SambucThe structure contains no public accessible elements.
155*ebfedea0SLionel Sambuc.Pp
156*ebfedea0SLionel Sambuc.Fn krb5_rc_initialize
157*ebfedea0SLionel SambucCreates the reply cache
158*ebfedea0SLionel Sambuc.Fa id
159*ebfedea0SLionel Sambucand sets it lifespan to
160*ebfedea0SLionel Sambuc.Fa auth_lifespan .
161*ebfedea0SLionel SambucIf the cache already exists, the content is destroyed.
162*ebfedea0SLionel Sambuc.Sh SEE ALSO
163*ebfedea0SLionel Sambuc.Xr krb5 3 ,
164*ebfedea0SLionel Sambuc.Xr krb5_data 3 ,
165*ebfedea0SLionel Sambuc.Xr kerberos 8
166