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 .\" $Id$
  33 .\"
  34 .Dd May  1, 2006
  35 .Dt KRB5_RCACHE 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_rcache ,
  39 .Nm krb5_rc_close ,
  40 .Nm krb5_rc_default ,
  41 .Nm krb5_rc_default_name ,
  42 .Nm krb5_rc_default_type ,
  43 .Nm krb5_rc_destroy ,
  44 .Nm krb5_rc_expunge ,
  45 .Nm krb5_rc_get_lifespan ,
  46 .Nm krb5_rc_get_name ,
  47 .Nm krb5_rc_get_type ,
  48 .Nm krb5_rc_initialize ,
  49 .Nm krb5_rc_recover ,
  50 .Nm krb5_rc_resolve ,
  51 .Nm krb5_rc_resolve_full ,
  52 .Nm krb5_rc_resolve_type ,
  53 .Nm krb5_rc_store ,
  54 .Nm krb5_get_server_rcache
  55 .Nd Kerberos 5 replay cache
  56 .Sh LIBRARY
  57 Kerberos 5 Library (libkrb5, -lkrb5)
  58 .Sh SYNOPSIS
  59 .In krb5.h
  60 .Pp
  61 .Li "struct krb5_rcache;"
  62 .Pp
  63 .Ft krb5_error_code
  64 .Fo krb5_rc_close
  65 .Fa "krb5_context context"
  66 .Fa "krb5_rcache id"
  67 .Fc
  68 .Ft krb5_error_code
  69 .Fo krb5_rc_default
  70 .Fa "krb5_context context"
  71 .Fa "krb5_rcache *id"
  72 .Fc
  73 .Ft "const char *"
  74 .Fo krb5_rc_default_name
  75 .Fa "krb5_context context"
  76 .Fc
  77 .Ft "const char *"
  78 .Fo krb5_rc_default_type
  79 .Fa "krb5_context context"
  80 .Fc
  81 .Ft krb5_error_code
  82 .Fo krb5_rc_destroy
  83 .Fa "krb5_context context"
  84 .Fa "krb5_rcache id"
  85 .Fc
  86 .Ft krb5_error_code
  87 .Fo krb5_rc_expunge
  88 .Fa "krb5_context context"
  89 .Fa "krb5_rcache id"
  90 .Fc
  91 .Ft krb5_error_code
  92 .Fo krb5_rc_get_lifespan
  93 .Fa "krb5_context context"
  94 .Fa "krb5_rcache id"
  95 .Fa "krb5_deltat *auth_lifespan"
  96 .Fc
  97 .Ft "const char*"
  98 .Fo krb5_rc_get_name
  99 .Fa "krb5_context context"
 100 .Fa "krb5_rcache id"
 101 .Fc
 102 .Ft "const char*"
 103 .Fo "krb5_rc_get_type"
 104 .Fa "krb5_context context"
 105 .Fa "krb5_rcache id"
 106 .Fc
 107 .Ft krb5_error_code
 108 .Fo krb5_rc_initialize
 109 .Fa "krb5_context context"
 110 .Fa "krb5_rcache id"
 111 .Fa "krb5_deltat auth_lifespan"
 112 .Fc
 113 .Ft krb5_error_code
 114 .Fo krb5_rc_recover
 115 .Fa "krb5_context context"
 116 .Fa "krb5_rcache id"
 117 .Fc
 118 .Ft krb5_error_code
 119 .Fo krb5_rc_resolve
 120 .Fa "krb5_context context"
 121 .Fa "krb5_rcache id"
 122 .Fa "const char *name"
 123 .Fc
 124 .Ft krb5_error_code
 125 .Fo krb5_rc_resolve_full
 126 .Fa "krb5_context context"
 127 .Fa "krb5_rcache *id"
 128 .Fa "const char *string_name"
 129 .Fc
 130 .Ft krb5_error_code
 131 .Fo krb5_rc_resolve_type
 132 .Fa "krb5_context context"
 133 .Fa "krb5_rcache *id"
 134 .Fa "const char *type"
 135 .Fc
 136 .Ft krb5_error_code
 137 .Fo krb5_rc_store
 138 .Fa "krb5_context context"
 139 .Fa "krb5_rcache id"
 140 .Fa "krb5_donot_replay *rep"
 141 .Fc
 142 .Ft krb5_error_code
 143 .Fo krb5_get_server_rcache
 144 .Fa "krb5_context context"
 145 .Fa "const krb5_data *piece"
 146 .Fa "krb5_rcache *id"
 147 .Fc
 148 .Sh DESCRIPTION
 149 The
 150 .Li krb5_rcache
 151 structure holds a storage element that is used for data manipulation.
 152 The structure contains no public accessible elements.
 153 .Pp
 154 .Fn krb5_rc_initialize
 155 Creates the reply cache
 156 .Fa id
 157 and sets it lifespan to
 158 .Fa auth_lifespan .
 159 If the cache already exists, the content is destroyed.
 160 .Sh SEE ALSO
 161 .Xr krb5 3 ,
 162 .Xr krb5_data 3 ,
 163 .Xr kerberos 8