crypto/dist/heimdal/lib/krb5/krb5_rcache.3

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