crypto/heimdal/lib/krb5/krb5_data.3

   1 .\" Copyright (c) 2003 - 2005, 2007 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: krb5_data.3 20040 2007-01-23 20:35:12Z lha $
  33 .\"
  34 .Dd Jan 23, 2007
  35 .Dt KRB5_DATA 3
  36 .Os HEIMDAL
  37 .Sh NAME
  38 .Nm krb5_data ,
  39 .Nm krb5_data_zero ,
  40 .Nm krb5_data_free ,
  41 .Nm krb5_free_data_contents ,
  42 .Nm krb5_free_data ,
  43 .Nm krb5_data_alloc ,
  44 .Nm krb5_data_realloc ,
  45 .Nm krb5_data_copy ,
  46 .Nm krb5_copy_data ,
  47 .Nm krb5_data_cmp
  48 .Nd operates on the Kerberos datatype krb5_data
  49 .Sh LIBRARY
  50 Kerberos 5 Library (libkrb5, -lkrb5)
  51 .Sh SYNOPSIS
  52 .In krb5.h
  53 .Pp
  54 .Li "struct krb5_data;"
  55 .Ft void
  56 .Fn krb5_data_zero "krb5_data *p"
  57 .Ft void
  58 .Fn krb5_data_free "krb5_data *p"
  59 .Ft void
  60 .Fn krb5_free_data_contents "krb5_context context" "krb5_data *p"
  61 .Ft void
  62 .Fn krb5_free_data "krb5_context context" "krb5_data *p"
  63 .Ft krb5_error_code
  64 .Fn krb5_data_alloc "krb5_data *p" "int len"
  65 .Ft krb5_error_code
  66 .Fn krb5_data_realloc "krb5_data *p" "int len"
  67 .Ft krb5_error_code
  68 .Fn krb5_data_copy "krb5_data *p" "const void *data" "size_t len"
  69 .Ft krb5_error_code
  70 .Fn krb5_copy_data "krb5_context context" "const krb5_data *indata" "krb5_data **outdata"
  71 .Ft krb5_error_code
  72 .Fn krb5_data_cmp "const krb5_data *data1" "const krb5_data *data2"
  73 .Sh DESCRIPTION
  74 The
  75 .Li krb5_data
  76 structure holds a data element.
  77 The structure contains two public accessible elements
  78 .Fa length
  79 (the length of data)
  80 and
  81 .Fa data
  82 (the data itself).
  83 The structure must always be initiated and freed by the functions
  84 documented in this manual.
  85 .Pp
  86 .Fn krb5_data_zero
  87 resets the content of
  88 .Fa p .
  89 .Pp
  90 .Fn krb5_data_free
  91 free the data in
  92 .Fa p
  93 and reset the content of the structure with
  94 .Fn krb5_data_zero .
  95 .Pp
  96 .Fn krb5_free_data_contents
  97 works the same way as
  98 .Fa krb5_data_free .
  99 The diffrence is that krb5_free_data_contents is more portable (exists
 100 in MIT api).
 101 .Pp
 102 .Fn krb5_free_data
 103 frees the data in
 104 .Fa p
 105 and
 106 .Fa p
 107 itself.
 108 .Pp
 109 .Fn krb5_data_alloc
 110 allocates
 111 .Fa len
 112 bytes in
 113 .Fa p .
 114 Returns 0 or an error.
 115 .Pp
 116 .Fn  krb5_data_realloc
 117 reallocates the length of
 118 .Fa p
 119 to the length in
 120 .Fa len .
 121 Returns 0 or an error.
 122 .Pp
 123 .Fn krb5_data_copy
 124 copies the
 125 .Fa data
 126 that have the length
 127 .Fa len
 128 into
 129 .Fa p .
 130 .Fa p
 131 is not freed so the calling function should make sure the
 132 .Fa p
 133 doesn't contain anything needs to be freed.
 134 Returns 0 or an error.
 135 .Pp
 136 .Fn krb5_copy_data
 137 copies the
 138 .Li krb5_data
 139 in
 140 .Fa indata
 141 to
 142 .Fa outdata .
 143 .Fa outdata
 144 is not freed so the calling function should make sure the
 145 .Fa outdata
 146 doesn't contain anything needs to be freed.
 147 .Fa outdata
 148 should be freed using
 149 .Fn krb5_free_data .
 150 Returns 0 or an error.
 151 .Pp
 152 .Fn krb5_data_cmp
 153 will compare two data object and check if they are the same in a
 154 simular way as memcmp does it.  The return value can be used for
 155 sorting.
 156 .Sh SEE ALSO
 157 .Xr krb5 3 ,
 158 .Xr krb5_storage 3 ,
 159 .Xr kerberos 8