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

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