crypto/heimdal/doc/doxyout/krb5/man/man3/krb5_storage.3

   1 .TH "Heimdal Kerberos 5 storage functions" 3 "11 Jan 2012" "Version 1.5.2" "HeimdalKerberos5library" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 Heimdal Kerberos 5 storage functions \-
   6 .SS "Functions"
   7
   8 .in +1c
   9 .ti -1c
  10 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_flags\fP (krb5_storage *sp, krb5_flags flags)"
  11 .br
  12 .ti -1c
  13 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_clear_flags\fP (krb5_storage *sp, krb5_flags flags)"
  14 .br
  15 .ti -1c
  16 .RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_storage_is_flags\fP (krb5_storage *sp, krb5_flags flags)"
  17 .br
  18 .ti -1c
  19 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_byteorder\fP (krb5_storage *sp, krb5_flags byteorder)"
  20 .br
  21 .ti -1c
  22 .RI "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL \fBkrb5_storage_get_byteorder\fP (krb5_storage *sp)"
  23 .br
  24 .ti -1c
  25 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_max_alloc\fP (krb5_storage *sp, size_t size)"
  26 .br
  27 .ti -1c
  28 .RI "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL \fBkrb5_storage_seek\fP (krb5_storage *sp, off_t offset, int whence)"
  29 .br
  30 .ti -1c
  31 .RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_truncate\fP (krb5_storage *sp, off_t offset)"
  32 .br
  33 .ti -1c
  34 .RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_read\fP (krb5_storage *sp, void *buf, size_t len)"
  35 .br
  36 .ti -1c
  37 .RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_write\fP (krb5_storage *sp, const void *buf, size_t len)"
  38 .br
  39 .ti -1c
  40 .RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_eof_code\fP (krb5_storage *sp, int code)"
  41 .br
  42 .ti -1c
  43 .RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_get_eof_code\fP (krb5_storage *sp)"
  44 .br
  45 .ti -1c
  46 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_free\fP (krb5_storage *sp)"
  47 .br
  48 .ti -1c
  49 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_to_data\fP (krb5_storage *sp, krb5_data *data)"
  50 .br
  51 .ti -1c
  52 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int32\fP (krb5_storage *sp, int32_t value)"
  53 .br
  54 .ti -1c
  55 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint32\fP (krb5_storage *sp, uint32_t value)"
  56 .br
  57 .ti -1c
  58 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int32\fP (krb5_storage *sp, int32_t *value)"
  59 .br
  60 .ti -1c
  61 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint32\fP (krb5_storage *sp, uint32_t *value)"
  62 .br
  63 .ti -1c
  64 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int16\fP (krb5_storage *sp, int16_t value)"
  65 .br
  66 .ti -1c
  67 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint16\fP (krb5_storage *sp, uint16_t value)"
  68 .br
  69 .ti -1c
  70 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int16\fP (krb5_storage *sp, int16_t *value)"
  71 .br
  72 .ti -1c
  73 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint16\fP (krb5_storage *sp, uint16_t *value)"
  74 .br
  75 .ti -1c
  76 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int8\fP (krb5_storage *sp, int8_t value)"
  77 .br
  78 .ti -1c
  79 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint8\fP (krb5_storage *sp, uint8_t value)"
  80 .br
  81 .ti -1c
  82 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int8\fP (krb5_storage *sp, int8_t *value)"
  83 .br
  84 .ti -1c
  85 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint8\fP (krb5_storage *sp, uint8_t *value)"
  86 .br
  87 .ti -1c
  88 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_data\fP (krb5_storage *sp, krb5_data data)"
  89 .br
  90 .ti -1c
  91 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_data\fP (krb5_storage *sp, krb5_data *data)"
  92 .br
  93 .ti -1c
  94 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_string\fP (krb5_storage *sp, const char *s)"
  95 .br
  96 .ti -1c
  97 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_string\fP (krb5_storage *sp, char **string)"
  98 .br
  99 .ti -1c
 100 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_stringz\fP (krb5_storage *sp, const char *s)"
 101 .br
 102 .ti -1c
 103 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_stringz\fP (krb5_storage *sp, char **string)"
 104 .br
 105 .ti -1c
 106 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_principal\fP (krb5_storage *sp, krb5_const_principal p)"
 107 .br
 108 .ti -1c
 109 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_principal\fP (krb5_storage *sp, krb5_principal *princ)"
 110 .br
 111 .ti -1c
 112 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_keyblock\fP (krb5_storage *sp, krb5_keyblock p)"
 113 .br
 114 .ti -1c
 115 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_keyblock\fP (krb5_storage *sp, krb5_keyblock *p)"
 116 .br
 117 .ti -1c
 118 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_times\fP (krb5_storage *sp, krb5_times times)"
 119 .br
 120 .ti -1c
 121 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_times\fP (krb5_storage *sp, krb5_times *times)"
 122 .br
 123 .ti -1c
 124 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_address\fP (krb5_storage *sp, krb5_address p)"
 125 .br
 126 .ti -1c
 127 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_address\fP (krb5_storage *sp, krb5_address *adr)"
 128 .br
 129 .ti -1c
 130 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_addrs\fP (krb5_storage *sp, krb5_addresses p)"
 131 .br
 132 .ti -1c
 133 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_addrs\fP (krb5_storage *sp, krb5_addresses *adr)"
 134 .br
 135 .ti -1c
 136 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_authdata\fP (krb5_storage *sp, krb5_authdata auth)"
 137 .br
 138 .ti -1c
 139 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_authdata\fP (krb5_storage *sp, krb5_authdata *auth)"
 140 .br
 141 .ti -1c
 142 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds\fP (krb5_storage *sp, krb5_creds *creds)"
 143 .br
 144 .ti -1c
 145 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds\fP (krb5_storage *sp, krb5_creds *creds)"
 146 .br
 147 .ti -1c
 148 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
 149 .br
 150 .ti -1c
 151 .RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
 152 .br
 153 .ti -1c
 154 .RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_emem\fP (void)"
 155 .br
 156 .ti -1c
 157 .RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_fd\fP (krb5_socket_t fd_in)"
 158 .br
 159 .ti -1c
 160 .RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_mem\fP (void *buf, size_t len)"
 161 .br
 162 .ti -1c
 163 .RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_data\fP (krb5_data *data)"
 164 .br
 165 .ti -1c
 166 .RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_readonly_mem\fP (const void *buf, size_t len)"
 167 .br
 168 .in -1c
 169 .SH "Detailed Description"
 170 .PP
 171
 172 .SH "Function Documentation"
 173 .PP
 174 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_address (krb5_storage * sp, krb5_address * adr)"
 175 .PP
 176 Read a address block from the storage.
 177 .PP
 178 \fBParameters:\fP
 179 .RS 4
 180 \fIsp\fP the storage buffer to write to
 181 .br
 182 \fIadr\fP the address block read from storage
 183 .RE
 184 .PP
 185 \fBReturns:\fP
 186 .RS 4
 187 0 on success, a Kerberos 5 error code on failure.
 188 .RE
 189 .PP
 190
 191 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_addrs (krb5_storage * sp, krb5_addresses * adr)"
 192 .PP
 193 Read a addresses block from the storage.
 194 .PP
 195 \fBParameters:\fP
 196 .RS 4
 197 \fIsp\fP the storage buffer to write to
 198 .br
 199 \fIadr\fP the addresses block read from storage
 200 .RE
 201 .PP
 202 \fBReturns:\fP
 203 .RS 4
 204 0 on success, a Kerberos 5 error code on failure.
 205 .RE
 206 .PP
 207
 208 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_authdata (krb5_storage * sp, krb5_authdata * auth)"
 209 .PP
 210 Read a auth data from the storage.
 211 .PP
 212 \fBParameters:\fP
 213 .RS 4
 214 \fIsp\fP the storage buffer to write to
 215 .br
 216 \fIauth\fP the auth data block read from storage
 217 .RE
 218 .PP
 219 \fBReturns:\fP
 220 .RS 4
 221 0 on success, a Kerberos 5 error code on failure.
 222 .RE
 223 .PP
 224
 225 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds (krb5_storage * sp, krb5_creds * creds)"
 226 .PP
 227 Read a credentials block from the storage.
 228 .PP
 229 \fBParameters:\fP
 230 .RS 4
 231 \fIsp\fP the storage buffer to write to
 232 .br
 233 \fIcreds\fP the credentials block read from storage
 234 .RE
 235 .PP
 236 \fBReturns:\fP
 237 .RS 4
 238 0 on success, a Kerberos 5 error code on failure.
 239 .RE
 240 .PP
 241
 242 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds_tag (krb5_storage * sp, krb5_creds * creds)"
 243 .PP
 244 Read a tagged credentials block from the storage.
 245 .PP
 246 \fBParameters:\fP
 247 .RS 4
 248 \fIsp\fP the storage buffer to write to
 249 .br
 250 \fIcreds\fP the credentials block read from storage
 251 .RE
 252 .PP
 253 \fBReturns:\fP
 254 .RS 4
 255 0 on success, a Kerberos 5 error code on failure.
 256 .RE
 257 .PP
 258
 259 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_data (krb5_storage * sp, krb5_data * data)"
 260 .PP
 261 Parse a data from the storage.
 262 .PP
 263 \fBParameters:\fP
 264 .RS 4
 265 \fIsp\fP the storage buffer to read from
 266 .br
 267 \fIdata\fP the parsed data
 268 .RE
 269 .PP
 270 \fBReturns:\fP
 271 .RS 4
 272 0 on success, a Kerberos 5 error code on failure.
 273 .RE
 274 .PP
 275
 276 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int16 (krb5_storage * sp, int16_t * value)"
 277 .PP
 278 Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 279 .PP
 280 \fBParameters:\fP
 281 .RS 4
 282 \fIsp\fP the storage to write too
 283 .br
 284 \fIvalue\fP the value read from the buffer
 285 .RE
 286 .PP
 287 \fBReturns:\fP
 288 .RS 4
 289 0 for success, or a Kerberos 5 error code on failure.
 290 .RE
 291 .PP
 292
 293 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int32 (krb5_storage * sp, int32_t * value)"
 294 .PP
 295 Read a int32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 296 .PP
 297 \fBParameters:\fP
 298 .RS 4
 299 \fIsp\fP the storage to write too
 300 .br
 301 \fIvalue\fP the value read from the buffer
 302 .RE
 303 .PP
 304 \fBReturns:\fP
 305 .RS 4
 306 0 for success, or a Kerberos 5 error code on failure.
 307 .RE
 308 .PP
 309
 310 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int8 (krb5_storage * sp, int8_t * value)"
 311 .PP
 312 Read a int8 from storage
 313 .PP
 314 \fBParameters:\fP
 315 .RS 4
 316 \fIsp\fP the storage to write too
 317 .br
 318 \fIvalue\fP the value read from the buffer
 319 .RE
 320 .PP
 321 \fBReturns:\fP
 322 .RS 4
 323 0 for success, or a Kerberos 5 error code on failure.
 324 .RE
 325 .PP
 326
 327 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_keyblock (krb5_storage * sp, krb5_keyblock * p)"
 328 .PP
 329 Read a keyblock from the storage.
 330 .PP
 331 \fBParameters:\fP
 332 .RS 4
 333 \fIsp\fP the storage buffer to write to
 334 .br
 335 \fIp\fP the keyblock read from storage, free using \fBkrb5_free_keyblock()\fP
 336 .RE
 337 .PP
 338 \fBReturns:\fP
 339 .RS 4
 340 0 on success, a Kerberos 5 error code on failure.
 341 .RE
 342 .PP
 343
 344 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_principal (krb5_storage * sp, krb5_principal * princ)"
 345 .PP
 346 Parse principal from the storage.
 347 .PP
 348 \fBParameters:\fP
 349 .RS 4
 350 \fIsp\fP the storage buffer to read from
 351 .br
 352 \fIprinc\fP the parsed principal
 353 .RE
 354 .PP
 355 \fBReturns:\fP
 356 .RS 4
 357 0 on success, a Kerberos 5 error code on failure.
 358 .RE
 359 .PP
 360
 361 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_string (krb5_storage * sp, char ** string)"
 362 .PP
 363 Parse a string from the storage.
 364 .PP
 365 \fBParameters:\fP
 366 .RS 4
 367 \fIsp\fP the storage buffer to read from
 368 .br
 369 \fIstring\fP the parsed string
 370 .RE
 371 .PP
 372 \fBReturns:\fP
 373 .RS 4
 374 0 on success, a Kerberos 5 error code on failure.
 375 .RE
 376 .PP
 377
 378 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_stringz (krb5_storage * sp, char ** string)"
 379 .PP
 380 Parse zero terminated string from the storage.
 381 .PP
 382 \fBParameters:\fP
 383 .RS 4
 384 \fIsp\fP the storage buffer to read from
 385 .br
 386 \fIstring\fP the parsed string
 387 .RE
 388 .PP
 389 \fBReturns:\fP
 390 .RS 4
 391 0 on success, a Kerberos 5 error code on failure.
 392 .RE
 393 .PP
 394
 395 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_times (krb5_storage * sp, krb5_times * times)"
 396 .PP
 397 Read a times block from the storage.
 398 .PP
 399 \fBParameters:\fP
 400 .RS 4
 401 \fIsp\fP the storage buffer to write to
 402 .br
 403 \fItimes\fP the times block read from storage
 404 .RE
 405 .PP
 406 \fBReturns:\fP
 407 .RS 4
 408 0 on success, a Kerberos 5 error code on failure.
 409 .RE
 410 .PP
 411
 412 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint16 (krb5_storage * sp, uint16_t * value)"
 413 .PP
 414 Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 415 .PP
 416 \fBParameters:\fP
 417 .RS 4
 418 \fIsp\fP the storage to write too
 419 .br
 420 \fIvalue\fP the value read from the buffer
 421 .RE
 422 .PP
 423 \fBReturns:\fP
 424 .RS 4
 425 0 for success, or a Kerberos 5 error code on failure.
 426 .RE
 427 .PP
 428
 429 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint32 (krb5_storage * sp, uint32_t * value)"
 430 .PP
 431 Read a uint32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 432 .PP
 433 \fBParameters:\fP
 434 .RS 4
 435 \fIsp\fP the storage to write too
 436 .br
 437 \fIvalue\fP the value read from the buffer
 438 .RE
 439 .PP
 440 \fBReturns:\fP
 441 .RS 4
 442 0 for success, or a Kerberos 5 error code on failure.
 443 .RE
 444 .PP
 445
 446 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint8 (krb5_storage * sp, uint8_t * value)"
 447 .PP
 448 Read a uint8 from storage
 449 .PP
 450 \fBParameters:\fP
 451 .RS 4
 452 \fIsp\fP the storage to write too
 453 .br
 454 \fIvalue\fP the value read from the buffer
 455 .RE
 456 .PP
 457 \fBReturns:\fP
 458 .RS 4
 459 0 for success, or a Kerberos 5 error code on failure.
 460 .RE
 461 .PP
 462
 463 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_clear_flags (krb5_storage * sp, krb5_flags flags)"
 464 .PP
 465 Clear the flags on a storage buffer
 466 .PP
 467 \fBParameters:\fP
 468 .RS 4
 469 \fIsp\fP the storage buffer to clear the flags on
 470 .br
 471 \fIflags\fP the flags to clear
 472 .RE
 473 .PP
 474
 475 .SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_emem (void)"
 476 .PP
 477 Create a elastic (allocating) memory storage backend. Memory is allocated on demand. Free returned krb5_storage with \fBkrb5_storage_free()\fP.
 478 .PP
 479 \fBReturns:\fP
 480 .RS 4
 481 A krb5_storage on success, or NULL on out of memory error.
 482 .RE
 483 .PP
 484 \fBSee also:\fP
 485 .RS 4
 486 \fBkrb5_storage_from_mem()\fP
 487 .PP
 488 \fBkrb5_storage_from_readonly_mem()\fP
 489 .PP
 490 \fBkrb5_storage_from_fd()\fP
 491 .PP
 492 \fBkrb5_storage_from_data()\fP
 493 .RE
 494 .PP
 495
 496 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_free (krb5_storage * sp)"
 497 .PP
 498 Free a krb5 storage.
 499 .PP
 500 \fBParameters:\fP
 501 .RS 4
 502 \fIsp\fP the storage to free.
 503 .RE
 504 .PP
 505 \fBReturns:\fP
 506 .RS 4
 507 An Kerberos 5 error code.
 508 .RE
 509 .PP
 510
 511 .SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_data (krb5_data * data)"
 512 .PP
 513 Create a fixed size memory storage block
 514 .PP
 515 \fBReturns:\fP
 516 .RS 4
 517 A krb5_storage on success, or NULL on out of memory error.
 518 .RE
 519 .PP
 520 \fBSee also:\fP
 521 .RS 4
 522 krb5_storage_mem()
 523 .PP
 524 \fBkrb5_storage_from_mem()\fP
 525 .PP
 526 \fBkrb5_storage_from_readonly_mem()\fP
 527 .PP
 528 \fBkrb5_storage_from_fd()\fP
 529 .RE
 530 .PP
 531
 532 .SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_fd (krb5_socket_t fd_in)"
 533 .PP
 534 \fBReturns:\fP
 535 .RS 4
 536 A krb5_storage on success, or NULL on out of memory error.
 537 .RE
 538 .PP
 539 \fBSee also:\fP
 540 .RS 4
 541 \fBkrb5_storage_emem()\fP
 542 .PP
 543 \fBkrb5_storage_from_mem()\fP
 544 .PP
 545 \fBkrb5_storage_from_readonly_mem()\fP
 546 .PP
 547 \fBkrb5_storage_from_data()\fP
 548 .RE
 549 .PP
 550
 551 .SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_mem (void * buf, size_t len)"
 552 .PP
 553 Create a fixed size memory storage block
 554 .PP
 555 \fBReturns:\fP
 556 .RS 4
 557 A krb5_storage on success, or NULL on out of memory error.
 558 .RE
 559 .PP
 560 \fBSee also:\fP
 561 .RS 4
 562 krb5_storage_mem()
 563 .PP
 564 \fBkrb5_storage_from_readonly_mem()\fP
 565 .PP
 566 \fBkrb5_storage_from_data()\fP
 567 .PP
 568 \fBkrb5_storage_from_fd()\fP
 569 .RE
 570 .PP
 571
 572 .SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_readonly_mem (const void * buf, size_t len)"
 573 .PP
 574 Create a fixed size memory storage block that is read only
 575 .PP
 576 \fBReturns:\fP
 577 .RS 4
 578 A krb5_storage on success, or NULL on out of memory error.
 579 .RE
 580 .PP
 581 \fBSee also:\fP
 582 .RS 4
 583 krb5_storage_mem()
 584 .PP
 585 \fBkrb5_storage_from_mem()\fP
 586 .PP
 587 \fBkrb5_storage_from_data()\fP
 588 .PP
 589 \fBkrb5_storage_from_fd()\fP
 590 .RE
 591 .PP
 592
 593 .SS "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL krb5_storage_get_byteorder (krb5_storage * sp)"
 594 .PP
 595 Return the current byteorder for the buffer. See \fBkrb5_storage_set_byteorder()\fP for the list or byte order contants.
 596 .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_get_eof_code (krb5_storage * sp)"
 597 .PP
 598 Get the return code that will be used when end of storage is reached.
 599 .PP
 600 \fBParameters:\fP
 601 .RS 4
 602 \fIsp\fP the storage
 603 .RE
 604 .PP
 605 \fBReturns:\fP
 606 .RS 4
 607 storage error code
 608 .RE
 609 .PP
 610
 611 .SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_storage_is_flags (krb5_storage * sp, krb5_flags flags)"
 612 .PP
 613 Return true or false depending on if the storage flags is set or not. NB testing for the flag 0 always return true.
 614 .PP
 615 \fBParameters:\fP
 616 .RS 4
 617 \fIsp\fP the storage buffer to check flags on
 618 .br
 619 \fIflags\fP The flags to test for
 620 .RE
 621 .PP
 622 \fBReturns:\fP
 623 .RS 4
 624 true if all the flags are set, false if not.
 625 .RE
 626 .PP
 627
 628 .SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_read (krb5_storage * sp, void * buf, size_t len)"
 629 .PP
 630 Read to the storage buffer.
 631 .PP
 632 \fBParameters:\fP
 633 .RS 4
 634 \fIsp\fP the storage buffer to read from
 635 .br
 636 \fIbuf\fP the buffer to store the data in
 637 .br
 638 \fIlen\fP the length to read
 639 .RE
 640 .PP
 641 \fBReturns:\fP
 642 .RS 4
 643 The length of data read (can be shorter then len), or negative on error.
 644 .RE
 645 .PP
 646
 647 .SS "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL krb5_storage_seek (krb5_storage * sp, off_t offset, int whence)"
 648 .PP
 649 Seek to a new offset.
 650 .PP
 651 \fBParameters:\fP
 652 .RS 4
 653 \fIsp\fP the storage buffer to seek in.
 654 .br
 655 \fIoffset\fP the offset to seek
 656 .br
 657 \fIwhence\fP relateive searching, SEEK_CUR from the current position, SEEK_END from the end, SEEK_SET absolute from the start.
 658 .RE
 659 .PP
 660 \fBReturns:\fP
 661 .RS 4
 662 The new current offset
 663 .RE
 664 .PP
 665
 666 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_byteorder (krb5_storage * sp, krb5_flags byteorder)"
 667 .PP
 668 Set the new byte order of the storage buffer.
 669 .PP
 670 \fBParameters:\fP
 671 .RS 4
 672 \fIsp\fP the storage buffer to set the byte order for.
 673 .br
 674 \fIbyteorder\fP the new byte order.
 675 .RE
 676 .PP
 677 The byte order are: KRB5_STORAGE_BYTEORDER_BE, KRB5_STORAGE_BYTEORDER_LE and KRB5_STORAGE_BYTEORDER_HOST.
 678 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_eof_code (krb5_storage * sp, int code)"
 679 .PP
 680 Set the return code that will be used when end of storage is reached.
 681 .PP
 682 \fBParameters:\fP
 683 .RS 4
 684 \fIsp\fP the storage
 685 .br
 686 \fIcode\fP the error code to return on end of storage
 687 .RE
 688 .PP
 689
 690 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_flags (krb5_storage * sp, krb5_flags flags)"
 691 .PP
 692 Add the flags on a storage buffer by or-ing in the flags to the buffer.
 693 .PP
 694 \fBParameters:\fP
 695 .RS 4
 696 \fIsp\fP the storage buffer to set the flags on
 697 .br
 698 \fIflags\fP the flags to set
 699 .RE
 700 .PP
 701
 702 .SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_max_alloc (krb5_storage * sp, size_t size)"
 703 .PP
 704 Set the max alloc value
 705 .PP
 706 \fBParameters:\fP
 707 .RS 4
 708 \fIsp\fP the storage buffer set the max allow for
 709 .br
 710 \fIsize\fP maximum size to allocate, use 0 to remove limit
 711 .RE
 712 .PP
 713
 714 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_to_data (krb5_storage * sp, krb5_data * data)"
 715 .PP
 716 Copy the contnent of storage
 717 .PP
 718 \fBParameters:\fP
 719 .RS 4
 720 \fIsp\fP the storage to copy to a data
 721 .br
 722 \fIdata\fP the copied data, free with \fBkrb5_data_free()\fP
 723 .RE
 724 .PP
 725 \fBReturns:\fP
 726 .RS 4
 727 0 for success, or a Kerberos 5 error code on failure.
 728 .RE
 729 .PP
 730
 731 .SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_truncate (krb5_storage * sp, off_t offset)"
 732 .PP
 733 Truncate the storage buffer in sp to offset.
 734 .PP
 735 \fBParameters:\fP
 736 .RS 4
 737 \fIsp\fP the storage buffer to truncate.
 738 .br
 739 \fIoffset\fP the offset to truncate too.
 740 .RE
 741 .PP
 742 \fBReturns:\fP
 743 .RS 4
 744 An Kerberos 5 error code.
 745 .RE
 746 .PP
 747
 748 .SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_write (krb5_storage * sp, const void * buf, size_t len)"
 749 .PP
 750 Write to the storage buffer.
 751 .PP
 752 \fBParameters:\fP
 753 .RS 4
 754 \fIsp\fP the storage buffer to write to
 755 .br
 756 \fIbuf\fP the buffer to write to the storage buffer
 757 .br
 758 \fIlen\fP the length to write
 759 .RE
 760 .PP
 761 \fBReturns:\fP
 762 .RS 4
 763 The length of data written (can be shorter then len), or negative on error.
 764 .RE
 765 .PP
 766
 767 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_address (krb5_storage * sp, krb5_address p)"
 768 .PP
 769 Write a address block to storage.
 770 .PP
 771 \fBParameters:\fP
 772 .RS 4
 773 \fIsp\fP the storage buffer to write to
 774 .br
 775 \fIp\fP the address block to write.
 776 .RE
 777 .PP
 778 \fBReturns:\fP
 779 .RS 4
 780 0 on success, a Kerberos 5 error code on failure.
 781 .RE
 782 .PP
 783
 784 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_addrs (krb5_storage * sp, krb5_addresses p)"
 785 .PP
 786 Write a addresses block to storage.
 787 .PP
 788 \fBParameters:\fP
 789 .RS 4
 790 \fIsp\fP the storage buffer to write to
 791 .br
 792 \fIp\fP the addresses block to write.
 793 .RE
 794 .PP
 795 \fBReturns:\fP
 796 .RS 4
 797 0 on success, a Kerberos 5 error code on failure.
 798 .RE
 799 .PP
 800
 801 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_authdata (krb5_storage * sp, krb5_authdata auth)"
 802 .PP
 803 Write a auth data block to storage.
 804 .PP
 805 \fBParameters:\fP
 806 .RS 4
 807 \fIsp\fP the storage buffer to write to
 808 .br
 809 \fIauth\fP the auth data block to write.
 810 .RE
 811 .PP
 812 \fBReturns:\fP
 813 .RS 4
 814 0 on success, a Kerberos 5 error code on failure.
 815 .RE
 816 .PP
 817
 818 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds (krb5_storage * sp, krb5_creds * creds)"
 819 .PP
 820 Write a credentials block to storage.
 821 .PP
 822 \fBParameters:\fP
 823 .RS 4
 824 \fIsp\fP the storage buffer to write to
 825 .br
 826 \fIcreds\fP the creds block to write.
 827 .RE
 828 .PP
 829 \fBReturns:\fP
 830 .RS 4
 831 0 on success, a Kerberos 5 error code on failure.
 832 .RE
 833 .PP
 834
 835 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds_tag (krb5_storage * sp, krb5_creds * creds)"
 836 .PP
 837 Write a tagged credentials block to storage.
 838 .PP
 839 \fBParameters:\fP
 840 .RS 4
 841 \fIsp\fP the storage buffer to write to
 842 .br
 843 \fIcreds\fP the creds block to write.
 844 .RE
 845 .PP
 846 \fBReturns:\fP
 847 .RS 4
 848 0 on success, a Kerberos 5 error code on failure.
 849 .RE
 850 .PP
 851
 852 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_data (krb5_storage * sp, krb5_data data)"
 853 .PP
 854 Store a data to the storage. The data is stored with an int32 as lenght plus the data (not padded).
 855 .PP
 856 \fBParameters:\fP
 857 .RS 4
 858 \fIsp\fP the storage buffer to write to
 859 .br
 860 \fIdata\fP the buffer to store.
 861 .RE
 862 .PP
 863 \fBReturns:\fP
 864 .RS 4
 865 0 on success, a Kerberos 5 error code on failure.
 866 .RE
 867 .PP
 868
 869 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int16 (krb5_storage * sp, int16_t value)"
 870 .PP
 871 Store a int16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 872 .PP
 873 \fBParameters:\fP
 874 .RS 4
 875 \fIsp\fP the storage to write too
 876 .br
 877 \fIvalue\fP the value to store
 878 .RE
 879 .PP
 880 \fBReturns:\fP
 881 .RS 4
 882 0 for success, or a Kerberos 5 error code on failure.
 883 .RE
 884 .PP
 885
 886 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int32 (krb5_storage * sp, int32_t value)"
 887 .PP
 888 Store a int32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
 889 .PP
 890 \fBParameters:\fP
 891 .RS 4
 892 \fIsp\fP the storage to write too
 893 .br
 894 \fIvalue\fP the value to store
 895 .RE
 896 .PP
 897 \fBReturns:\fP
 898 .RS 4
 899 0 for success, or a Kerberos 5 error code on failure.
 900 .RE
 901 .PP
 902
 903 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int8 (krb5_storage * sp, int8_t value)"
 904 .PP
 905 Store a int8 to storage.
 906 .PP
 907 \fBParameters:\fP
 908 .RS 4
 909 \fIsp\fP the storage to write too
 910 .br
 911 \fIvalue\fP the value to store
 912 .RE
 913 .PP
 914 \fBReturns:\fP
 915 .RS 4
 916 0 for success, or a Kerberos 5 error code on failure.
 917 .RE
 918 .PP
 919
 920 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_keyblock (krb5_storage * sp, krb5_keyblock p)"
 921 .PP
 922 Store a keyblock to the storage.
 923 .PP
 924 \fBParameters:\fP
 925 .RS 4
 926 \fIsp\fP the storage buffer to write to
 927 .br
 928 \fIp\fP the keyblock to write
 929 .RE
 930 .PP
 931 \fBReturns:\fP
 932 .RS 4
 933 0 on success, a Kerberos 5 error code on failure.
 934 .RE
 935 .PP
 936
 937 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_principal (krb5_storage * sp, krb5_const_principal p)"
 938 .PP
 939 Write a principal block to storage.
 940 .PP
 941 \fBParameters:\fP
 942 .RS 4
 943 \fIsp\fP the storage buffer to write to
 944 .br
 945 \fIp\fP the principal block to write.
 946 .RE
 947 .PP
 948 \fBReturns:\fP
 949 .RS 4
 950 0 on success, a Kerberos 5 error code on failure.
 951 .RE
 952 .PP
 953
 954 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_string (krb5_storage * sp, const char * s)"
 955 .PP
 956 Store a string to the buffer. The data is formated as an len:uint32 plus the string itself (not padded).
 957 .PP
 958 \fBParameters:\fP
 959 .RS 4
 960 \fIsp\fP the storage buffer to write to
 961 .br
 962 \fIs\fP the string to store.
 963 .RE
 964 .PP
 965 \fBReturns:\fP
 966 .RS 4
 967 0 on success, a Kerberos 5 error code on failure.
 968 .RE
 969 .PP
 970
 971 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_stringz (krb5_storage * sp, const char * s)"
 972 .PP
 973 Store a zero terminated string to the buffer. The data is stored one character at a time until a NUL is stored.
 974 .PP
 975 \fBParameters:\fP
 976 .RS 4
 977 \fIsp\fP the storage buffer to write to
 978 .br
 979 \fIs\fP the string to store.
 980 .RE
 981 .PP
 982 \fBReturns:\fP
 983 .RS 4
 984 0 on success, a Kerberos 5 error code on failure.
 985 .RE
 986 .PP
 987
 988 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_times (krb5_storage * sp, krb5_times times)"
 989 .PP
 990 Write a times block to storage.
 991 .PP
 992 \fBParameters:\fP
 993 .RS 4
 994 \fIsp\fP the storage buffer to write to
 995 .br
 996 \fItimes\fP the times block to write.
 997 .RE
 998 .PP
 999 \fBReturns:\fP
1000 .RS 4
1001 0 on success, a Kerberos 5 error code on failure.
1002 .RE
1003 .PP
1004
1005 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint16 (krb5_storage * sp, uint16_t value)"
1006 .PP
1007 Store a uint16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
1008 .PP
1009 \fBParameters:\fP
1010 .RS 4
1011 \fIsp\fP the storage to write too
1012 .br
1013 \fIvalue\fP the value to store
1014 .RE
1015 .PP
1016 \fBReturns:\fP
1017 .RS 4
1018 0 for success, or a Kerberos 5 error code on failure.
1019 .RE
1020 .PP
1021
1022 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint32 (krb5_storage * sp, uint32_t value)"
1023 .PP
1024 Store a uint32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
1025 .PP
1026 \fBParameters:\fP
1027 .RS 4
1028 \fIsp\fP the storage to write too
1029 .br
1030 \fIvalue\fP the value to store
1031 .RE
1032 .PP
1033 \fBReturns:\fP
1034 .RS 4
1035 0 for success, or a Kerberos 5 error code on failure.
1036 .RE
1037 .PP
1038
1039 .SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint8 (krb5_storage * sp, uint8_t value)"
1040 .PP
1041 Store a uint8 to storage.
1042 .PP
1043 \fBParameters:\fP
1044 .RS 4
1045 \fIsp\fP the storage to write too
1046 .br
1047 \fIvalue\fP the value to store
1048 .RE
1049 .PP
1050 \fBReturns:\fP
1051 .RS 4
1052 0 for success, or a Kerberos 5 error code on failure.
1053 .RE
1054 .PP
1055