1
.TH "Heimdal Kerberos 5 storage functions" 3 "30 Jul 2011" "Version 1.5" "HeimdalKerberos5library" \" -*- nroff -*-
5
Heimdal Kerberos 5 storage functions \-
10
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_flags\fP (krb5_storage *sp, krb5_flags flags)"
13
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_clear_flags\fP (krb5_storage *sp, krb5_flags flags)"
16
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_storage_is_flags\fP (krb5_storage *sp, krb5_flags flags)"
19
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_byteorder\fP (krb5_storage *sp, krb5_flags byteorder)"
22
.RI "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL \fBkrb5_storage_get_byteorder\fP (krb5_storage *sp)"
25
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_max_alloc\fP (krb5_storage *sp, size_t size)"
28
.RI "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL \fBkrb5_storage_seek\fP (krb5_storage *sp, off_t offset, int whence)"
31
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_truncate\fP (krb5_storage *sp, off_t offset)"
34
.RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_read\fP (krb5_storage *sp, void *buf, size_t len)"
37
.RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_write\fP (krb5_storage *sp, const void *buf, size_t len)"
40
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_eof_code\fP (krb5_storage *sp, int code)"
43
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_get_eof_code\fP (krb5_storage *sp)"
46
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_free\fP (krb5_storage *sp)"
49
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_to_data\fP (krb5_storage *sp, krb5_data *data)"
52
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int32\fP (krb5_storage *sp, int32_t value)"
55
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint32\fP (krb5_storage *sp, uint32_t value)"
58
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int32\fP (krb5_storage *sp, int32_t *value)"
61
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint32\fP (krb5_storage *sp, uint32_t *value)"
64
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int16\fP (krb5_storage *sp, int16_t value)"
67
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint16\fP (krb5_storage *sp, uint16_t value)"
70
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int16\fP (krb5_storage *sp, int16_t *value)"
73
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint16\fP (krb5_storage *sp, uint16_t *value)"
76
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int8\fP (krb5_storage *sp, int8_t value)"
79
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint8\fP (krb5_storage *sp, uint8_t value)"
82
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int8\fP (krb5_storage *sp, int8_t *value)"
85
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint8\fP (krb5_storage *sp, uint8_t *value)"
88
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_data\fP (krb5_storage *sp, krb5_data data)"
91
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_data\fP (krb5_storage *sp, krb5_data *data)"
94
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_string\fP (krb5_storage *sp, const char *s)"
97
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_string\fP (krb5_storage *sp, char **string)"
100
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_stringz\fP (krb5_storage *sp, const char *s)"
103
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_stringz\fP (krb5_storage *sp, char **string)"
106
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_principal\fP (krb5_storage *sp, krb5_const_principal p)"
109
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_principal\fP (krb5_storage *sp, krb5_principal *princ)"
112
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_keyblock\fP (krb5_storage *sp, krb5_keyblock p)"
115
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_keyblock\fP (krb5_storage *sp, krb5_keyblock *p)"
118
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_times\fP (krb5_storage *sp, krb5_times times)"
121
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_times\fP (krb5_storage *sp, krb5_times *times)"
124
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_address\fP (krb5_storage *sp, krb5_address p)"
127
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_address\fP (krb5_storage *sp, krb5_address *adr)"
130
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_addrs\fP (krb5_storage *sp, krb5_addresses p)"
133
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_addrs\fP (krb5_storage *sp, krb5_addresses *adr)"
136
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_authdata\fP (krb5_storage *sp, krb5_authdata auth)"
139
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_authdata\fP (krb5_storage *sp, krb5_authdata *auth)"
142
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds\fP (krb5_storage *sp, krb5_creds *creds)"
145
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds\fP (krb5_storage *sp, krb5_creds *creds)"
148
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
151
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
154
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_emem\fP (void)"
157
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_fd\fP (krb5_socket_t fd_in)"
160
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_mem\fP (void *buf, size_t len)"
163
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_data\fP (krb5_data *data)"
166
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_readonly_mem\fP (const void *buf, size_t len)"
169
.SH "Detailed Description"
172
.SH "Function Documentation"
174
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_address (krb5_storage * sp, krb5_address * adr)"
176
Read a address block from the storage.
180
\fIsp\fP the storage buffer to write to
182
\fIadr\fP the address block read from storage
187
0 on success, a Kerberos 5 error code on failure.
191
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_addrs (krb5_storage * sp, krb5_addresses * adr)"
193
Read a addresses block from the storage.
197
\fIsp\fP the storage buffer to write to
199
\fIadr\fP the addresses block read from storage
204
0 on success, a Kerberos 5 error code on failure.
208
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_authdata (krb5_storage * sp, krb5_authdata * auth)"
210
Read a auth data from the storage.
214
\fIsp\fP the storage buffer to write to
216
\fIauth\fP the auth data block read from storage
221
0 on success, a Kerberos 5 error code on failure.
225
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds (krb5_storage * sp, krb5_creds * creds)"
227
Read a credentials block from the storage.
231
\fIsp\fP the storage buffer to write to
233
\fIcreds\fP the credentials block read from storage
238
0 on success, a Kerberos 5 error code on failure.
242
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds_tag (krb5_storage * sp, krb5_creds * creds)"
244
Read a tagged credentials block from the storage.
248
\fIsp\fP the storage buffer to write to
250
\fIcreds\fP the credentials block read from storage
255
0 on success, a Kerberos 5 error code on failure.
259
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_data (krb5_storage * sp, krb5_data * data)"
261
Parse a data from the storage.
265
\fIsp\fP the storage buffer to read from
267
\fIdata\fP the parsed data
272
0 on success, a Kerberos 5 error code on failure.
276
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int16 (krb5_storage * sp, int16_t * value)"
278
Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
282
\fIsp\fP the storage to write too
284
\fIvalue\fP the value read from the buffer
289
0 for success, or a Kerberos 5 error code on failure.
293
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int32 (krb5_storage * sp, int32_t * value)"
295
Read a int32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
299
\fIsp\fP the storage to write too
301
\fIvalue\fP the value read from the buffer
306
0 for success, or a Kerberos 5 error code on failure.
310
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int8 (krb5_storage * sp, int8_t * value)"
312
Read a int8 from storage
316
\fIsp\fP the storage to write too
318
\fIvalue\fP the value read from the buffer
323
0 for success, or a Kerberos 5 error code on failure.
327
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_keyblock (krb5_storage * sp, krb5_keyblock * p)"
329
Read a keyblock from the storage.
333
\fIsp\fP the storage buffer to write to
335
\fIp\fP the keyblock read from storage, free using \fBkrb5_free_keyblock()\fP
340
0 on success, a Kerberos 5 error code on failure.
344
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_principal (krb5_storage * sp, krb5_principal * princ)"
346
Parse principal from the storage.
350
\fIsp\fP the storage buffer to read from
352
\fIprinc\fP the parsed principal
357
0 on success, a Kerberos 5 error code on failure.
361
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_string (krb5_storage * sp, char ** string)"
363
Parse a string from the storage.
367
\fIsp\fP the storage buffer to read from
369
\fIstring\fP the parsed string
374
0 on success, a Kerberos 5 error code on failure.
378
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_stringz (krb5_storage * sp, char ** string)"
380
Parse zero terminated string from the storage.
384
\fIsp\fP the storage buffer to read from
386
\fIstring\fP the parsed string
391
0 on success, a Kerberos 5 error code on failure.
395
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_times (krb5_storage * sp, krb5_times * times)"
397
Read a times block from the storage.
401
\fIsp\fP the storage buffer to write to
403
\fItimes\fP the times block read from storage
408
0 on success, a Kerberos 5 error code on failure.
412
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint16 (krb5_storage * sp, uint16_t * value)"
414
Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
418
\fIsp\fP the storage to write too
420
\fIvalue\fP the value read from the buffer
425
0 for success, or a Kerberos 5 error code on failure.
429
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint32 (krb5_storage * sp, uint32_t * value)"
431
Read a uint32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
435
\fIsp\fP the storage to write too
437
\fIvalue\fP the value read from the buffer
442
0 for success, or a Kerberos 5 error code on failure.
446
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint8 (krb5_storage * sp, uint8_t * value)"
448
Read a uint8 from storage
452
\fIsp\fP the storage to write too
454
\fIvalue\fP the value read from the buffer
459
0 for success, or a Kerberos 5 error code on failure.
463
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_clear_flags (krb5_storage * sp, krb5_flags flags)"
465
Clear the flags on a storage buffer
469
\fIsp\fP the storage buffer to clear the flags on
471
\fIflags\fP the flags to clear
475
.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_emem (void)"
477
Create a elastic (allocating) memory storage backend. Memory is allocated on demand. Free returned krb5_storage with \fBkrb5_storage_free()\fP.
481
A krb5_storage on success, or NULL on out of memory error.
486
\fBkrb5_storage_from_mem()\fP
488
\fBkrb5_storage_from_readonly_mem()\fP
490
\fBkrb5_storage_from_fd()\fP
492
\fBkrb5_storage_from_data()\fP
496
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_free (krb5_storage * sp)"
502
\fIsp\fP the storage to free.
507
An Kerberos 5 error code.
511
.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_data (krb5_data * data)"
513
Create a fixed size memory storage block
517
A krb5_storage on success, or NULL on out of memory error.
524
\fBkrb5_storage_from_mem()\fP
526
\fBkrb5_storage_from_readonly_mem()\fP
528
\fBkrb5_storage_from_fd()\fP
532
.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_fd (krb5_socket_t fd_in)"
536
A krb5_storage on success, or NULL on out of memory error.
541
\fBkrb5_storage_emem()\fP
543
\fBkrb5_storage_from_mem()\fP
545
\fBkrb5_storage_from_readonly_mem()\fP
547
\fBkrb5_storage_from_data()\fP
551
.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_mem (void * buf, size_t len)"
553
Create a fixed size memory storage block
557
A krb5_storage on success, or NULL on out of memory error.
564
\fBkrb5_storage_from_readonly_mem()\fP
566
\fBkrb5_storage_from_data()\fP
568
\fBkrb5_storage_from_fd()\fP
572
.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_readonly_mem (const void * buf, size_t len)"
574
Create a fixed size memory storage block that is read only
578
A krb5_storage on success, or NULL on out of memory error.
585
\fBkrb5_storage_from_mem()\fP
587
\fBkrb5_storage_from_data()\fP
589
\fBkrb5_storage_from_fd()\fP
593
.SS "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL krb5_storage_get_byteorder (krb5_storage * sp)"
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)"
598
Get the return code that will be used when end of storage is reached.
611
.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_storage_is_flags (krb5_storage * sp, krb5_flags flags)"
613
Return true or false depending on if the storage flags is set or not. NB testing for the flag 0 always return true.
617
\fIsp\fP the storage buffer to check flags on
619
\fIflags\fP The flags to test for
624
true if all the flags are set, false if not.
628
.SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_read (krb5_storage * sp, void * buf, size_t len)"
630
Read to the storage buffer.
634
\fIsp\fP the storage buffer to read from
636
\fIbuf\fP the buffer to store the data in
638
\fIlen\fP the length to read
643
The length of data read (can be shorter then len), or negative on error.
647
.SS "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL krb5_storage_seek (krb5_storage * sp, off_t offset, int whence)"
649
Seek to a new offset.
653
\fIsp\fP the storage buffer to seek in.
655
\fIoffset\fP the offset to seek
657
\fIwhence\fP relateive searching, SEEK_CUR from the current position, SEEK_END from the end, SEEK_SET absolute from the start.
662
The new current offset
666
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_byteorder (krb5_storage * sp, krb5_flags byteorder)"
668
Set the new byte order of the storage buffer.
672
\fIsp\fP the storage buffer to set the byte order for.
674
\fIbyteorder\fP the new byte order.
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)"
680
Set the return code that will be used when end of storage is reached.
686
\fIcode\fP the error code to return on end of storage
690
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_flags (krb5_storage * sp, krb5_flags flags)"
692
Add the flags on a storage buffer by or-ing in the flags to the buffer.
696
\fIsp\fP the storage buffer to set the flags on
698
\fIflags\fP the flags to set
702
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_max_alloc (krb5_storage * sp, size_t size)"
704
Set the max alloc value
708
\fIsp\fP the storage buffer set the max allow for
710
\fIsize\fP maximum size to allocate, use 0 to remove limit
714
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_to_data (krb5_storage * sp, krb5_data * data)"
716
Copy the contnent of storage
720
\fIsp\fP the storage to copy to a data
722
\fIdata\fP the copied data, free with \fBkrb5_data_free()\fP
727
0 for success, or a Kerberos 5 error code on failure.
731
.SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_truncate (krb5_storage * sp, off_t offset)"
733
Truncate the storage buffer in sp to offset.
737
\fIsp\fP the storage buffer to truncate.
739
\fIoffset\fP the offset to truncate too.
744
An Kerberos 5 error code.
748
.SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_write (krb5_storage * sp, const void * buf, size_t len)"
750
Write to the storage buffer.
754
\fIsp\fP the storage buffer to write to
756
\fIbuf\fP the buffer to write to the storage buffer
758
\fIlen\fP the length to write
763
The length of data written (can be shorter then len), or negative on error.
767
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_address (krb5_storage * sp, krb5_address p)"
769
Write a address block to storage.
773
\fIsp\fP the storage buffer to write to
775
\fIp\fP the address block to write.
780
0 on success, a Kerberos 5 error code on failure.
784
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_addrs (krb5_storage * sp, krb5_addresses p)"
786
Write a addresses block to storage.
790
\fIsp\fP the storage buffer to write to
792
\fIp\fP the addresses block to write.
797
0 on success, a Kerberos 5 error code on failure.
801
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_authdata (krb5_storage * sp, krb5_authdata auth)"
803
Write a auth data block to storage.
807
\fIsp\fP the storage buffer to write to
809
\fIauth\fP the auth data block to write.
814
0 on success, a Kerberos 5 error code on failure.
818
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds (krb5_storage * sp, krb5_creds * creds)"
820
Write a credentials block to storage.
824
\fIsp\fP the storage buffer to write to
826
\fIcreds\fP the creds block to write.
831
0 on success, a Kerberos 5 error code on failure.
835
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds_tag (krb5_storage * sp, krb5_creds * creds)"
837
Write a tagged credentials block to storage.
841
\fIsp\fP the storage buffer to write to
843
\fIcreds\fP the creds block to write.
848
0 on success, a Kerberos 5 error code on failure.
852
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_data (krb5_storage * sp, krb5_data data)"
854
Store a data to the storage. The data is stored with an int32 as lenght plus the data (not padded).
858
\fIsp\fP the storage buffer to write to
860
\fIdata\fP the buffer to store.
865
0 on success, a Kerberos 5 error code on failure.
869
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int16 (krb5_storage * sp, int16_t value)"
871
Store a int16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
875
\fIsp\fP the storage to write too
877
\fIvalue\fP the value to store
882
0 for success, or a Kerberos 5 error code on failure.
886
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int32 (krb5_storage * sp, int32_t value)"
888
Store a int32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
892
\fIsp\fP the storage to write too
894
\fIvalue\fP the value to store
899
0 for success, or a Kerberos 5 error code on failure.
903
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int8 (krb5_storage * sp, int8_t value)"
905
Store a int8 to storage.
909
\fIsp\fP the storage to write too
911
\fIvalue\fP the value to store
916
0 for success, or a Kerberos 5 error code on failure.
920
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_keyblock (krb5_storage * sp, krb5_keyblock p)"
922
Store a keyblock to the storage.
926
\fIsp\fP the storage buffer to write to
928
\fIp\fP the keyblock to write
933
0 on success, a Kerberos 5 error code on failure.
937
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_principal (krb5_storage * sp, krb5_const_principal p)"
939
Write a principal block to storage.
943
\fIsp\fP the storage buffer to write to
945
\fIp\fP the principal block to write.
950
0 on success, a Kerberos 5 error code on failure.
954
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_string (krb5_storage * sp, const char * s)"
956
Store a string to the buffer. The data is formated as an len:uint32 plus the string itself (not padded).
960
\fIsp\fP the storage buffer to write to
962
\fIs\fP the string to store.
967
0 on success, a Kerberos 5 error code on failure.
971
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_stringz (krb5_storage * sp, const char * s)"
973
Store a zero terminated string to the buffer. The data is stored one character at a time until a NUL is stored.
977
\fIsp\fP the storage buffer to write to
979
\fIs\fP the string to store.
984
0 on success, a Kerberos 5 error code on failure.
988
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_times (krb5_storage * sp, krb5_times times)"
990
Write a times block to storage.
994
\fIsp\fP the storage buffer to write to
996
\fItimes\fP the times block to write.
1001
0 on success, a Kerberos 5 error code on failure.
1005
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint16 (krb5_storage * sp, uint16_t value)"
1007
Store a uint16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
1011
\fIsp\fP the storage to write too
1013
\fIvalue\fP the value to store
1018
0 for success, or a Kerberos 5 error code on failure.
1022
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint32 (krb5_storage * sp, uint32_t value)"
1024
Store a uint32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
1028
\fIsp\fP the storage to write too
1030
\fIvalue\fP the value to store
1035
0 for success, or a Kerberos 5 error code on failure.
1039
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint8 (krb5_storage * sp, uint8_t value)"
1041
Store a uint8 to storage.
1045
\fIsp\fP the storage to write too
1047
\fIvalue\fP the value to store
1052
0 for success, or a Kerberos 5 error code on failure.
added
removed
doc/doxyout/krb5/man/man3/krb5_storage.3
