summaryrefslogtreecommitdiffstats
path: root/doc/doxyout/krb5/man/man3/krb5_storage.3
blob: 576895de6669a086729e58977acd74f55fae1977 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
.TH "Heimdal Kerberos 5 storage functions" 3 "30 Jul 2011" "Version 1.5" "HeimdalKerberos5library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Heimdal Kerberos 5 storage functions \- 
.SS "Functions"

.in +1c
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_flags\fP (krb5_storage *sp, krb5_flags flags)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_clear_flags\fP (krb5_storage *sp, krb5_flags flags)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL \fBkrb5_storage_is_flags\fP (krb5_storage *sp, krb5_flags flags)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_byteorder\fP (krb5_storage *sp, krb5_flags byteorder)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL \fBkrb5_storage_get_byteorder\fP (krb5_storage *sp)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_max_alloc\fP (krb5_storage *sp, size_t size)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL \fBkrb5_storage_seek\fP (krb5_storage *sp, off_t offset, int whence)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_truncate\fP (krb5_storage *sp, off_t offset)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_read\fP (krb5_storage *sp, void *buf, size_t len)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL \fBkrb5_storage_write\fP (krb5_storage *sp, const void *buf, size_t len)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION void KRB5_LIB_CALL \fBkrb5_storage_set_eof_code\fP (krb5_storage *sp, int code)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION int KRB5_LIB_CALL \fBkrb5_storage_get_eof_code\fP (krb5_storage *sp)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_free\fP (krb5_storage *sp)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_storage_to_data\fP (krb5_storage *sp, krb5_data *data)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int32\fP (krb5_storage *sp, int32_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint32\fP (krb5_storage *sp, uint32_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int32\fP (krb5_storage *sp, int32_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint32\fP (krb5_storage *sp, uint32_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int16\fP (krb5_storage *sp, int16_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint16\fP (krb5_storage *sp, uint16_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int16\fP (krb5_storage *sp, int16_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint16\fP (krb5_storage *sp, uint16_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_int8\fP (krb5_storage *sp, int8_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_uint8\fP (krb5_storage *sp, uint8_t value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_int8\fP (krb5_storage *sp, int8_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_uint8\fP (krb5_storage *sp, uint8_t *value)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_data\fP (krb5_storage *sp, krb5_data data)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_data\fP (krb5_storage *sp, krb5_data *data)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_string\fP (krb5_storage *sp, const char *s)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_string\fP (krb5_storage *sp, char **string)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_stringz\fP (krb5_storage *sp, const char *s)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_stringz\fP (krb5_storage *sp, char **string)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_principal\fP (krb5_storage *sp, krb5_const_principal p)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_principal\fP (krb5_storage *sp, krb5_principal *princ)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_keyblock\fP (krb5_storage *sp, krb5_keyblock p)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_keyblock\fP (krb5_storage *sp, krb5_keyblock *p)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_times\fP (krb5_storage *sp, krb5_times times)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_times\fP (krb5_storage *sp, krb5_times *times)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_address\fP (krb5_storage *sp, krb5_address p)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_address\fP (krb5_storage *sp, krb5_address *adr)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_addrs\fP (krb5_storage *sp, krb5_addresses p)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_addrs\fP (krb5_storage *sp, krb5_addresses *adr)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_authdata\fP (krb5_storage *sp, krb5_authdata auth)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_authdata\fP (krb5_storage *sp, krb5_authdata *auth)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds\fP (krb5_storage *sp, krb5_creds *creds)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds\fP (krb5_storage *sp, krb5_creds *creds)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_store_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL \fBkrb5_ret_creds_tag\fP (krb5_storage *sp, krb5_creds *creds)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_emem\fP (void)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_fd\fP (krb5_socket_t fd_in)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_mem\fP (void *buf, size_t len)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_data\fP (krb5_data *data)"
.br
.ti -1c
.RI "KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL \fBkrb5_storage_from_readonly_mem\fP (const void *buf, size_t len)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_address (krb5_storage * sp, krb5_address * adr)"
.PP
Read a address block from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIadr\fP the address block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_addrs (krb5_storage * sp, krb5_addresses * adr)"
.PP
Read a addresses block from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIadr\fP the addresses block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_authdata (krb5_storage * sp, krb5_authdata * auth)"
.PP
Read a auth data from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIauth\fP the auth data block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds (krb5_storage * sp, krb5_creds * creds)"
.PP
Read a credentials block from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIcreds\fP the credentials block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds_tag (krb5_storage * sp, krb5_creds * creds)"
.PP
Read a tagged credentials block from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIcreds\fP the credentials block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_data (krb5_storage * sp, krb5_data * data)"
.PP
Parse a data from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to read from 
.br
\fIdata\fP the parsed data
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int16 (krb5_storage * sp, int16_t * value)"
.PP
Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int32 (krb5_storage * sp, int32_t * value)"
.PP
Read a int32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int8 (krb5_storage * sp, int8_t * value)"
.PP
Read a int8 from storage
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_keyblock (krb5_storage * sp, krb5_keyblock * p)"
.PP
Read a keyblock from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIp\fP the keyblock read from storage, free using \fBkrb5_free_keyblock()\fP
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_principal (krb5_storage * sp, krb5_principal * princ)"
.PP
Parse principal from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to read from 
.br
\fIprinc\fP the parsed principal
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_string (krb5_storage * sp, char ** string)"
.PP
Parse a string from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to read from 
.br
\fIstring\fP the parsed string
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_stringz (krb5_storage * sp, char ** string)"
.PP
Parse zero terminated string from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to read from 
.br
\fIstring\fP the parsed string
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_times (krb5_storage * sp, krb5_times * times)"
.PP
Read a times block from the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fItimes\fP the times block read from storage
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint16 (krb5_storage * sp, uint16_t * value)"
.PP
Read a int16 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint32 (krb5_storage * sp, uint32_t * value)"
.PP
Read a uint32 from storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint8 (krb5_storage * sp, uint8_t * value)"
.PP
Read a uint8 from storage
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value read from the buffer
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_clear_flags (krb5_storage * sp, krb5_flags flags)"
.PP
Clear the flags on a storage buffer
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to clear the flags on 
.br
\fIflags\fP the flags to clear 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_emem (void)"
.PP
Create a elastic (allocating) memory storage backend. Memory is allocated on demand. Free returned krb5_storage with \fBkrb5_storage_free()\fP.
.PP
\fBReturns:\fP
.RS 4
A krb5_storage on success, or NULL on out of memory error.
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkrb5_storage_from_mem()\fP 
.PP
\fBkrb5_storage_from_readonly_mem()\fP 
.PP
\fBkrb5_storage_from_fd()\fP 
.PP
\fBkrb5_storage_from_data()\fP 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_free (krb5_storage * sp)"
.PP
Free a krb5 storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to free.
.RE
.PP
\fBReturns:\fP
.RS 4
An Kerberos 5 error code. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_data (krb5_data * data)"
.PP
Create a fixed size memory storage block
.PP
\fBReturns:\fP
.RS 4
A krb5_storage on success, or NULL on out of memory error.
.RE
.PP
\fBSee also:\fP
.RS 4
krb5_storage_mem() 
.PP
\fBkrb5_storage_from_mem()\fP 
.PP
\fBkrb5_storage_from_readonly_mem()\fP 
.PP
\fBkrb5_storage_from_fd()\fP 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_fd (krb5_socket_t fd_in)"
.PP
\fBReturns:\fP
.RS 4
A krb5_storage on success, or NULL on out of memory error.
.RE
.PP
\fBSee also:\fP
.RS 4
\fBkrb5_storage_emem()\fP 
.PP
\fBkrb5_storage_from_mem()\fP 
.PP
\fBkrb5_storage_from_readonly_mem()\fP 
.PP
\fBkrb5_storage_from_data()\fP 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_mem (void * buf, size_t len)"
.PP
Create a fixed size memory storage block
.PP
\fBReturns:\fP
.RS 4
A krb5_storage on success, or NULL on out of memory error.
.RE
.PP
\fBSee also:\fP
.RS 4
krb5_storage_mem() 
.PP
\fBkrb5_storage_from_readonly_mem()\fP 
.PP
\fBkrb5_storage_from_data()\fP 
.PP
\fBkrb5_storage_from_fd()\fP 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_readonly_mem (const void * buf, size_t len)"
.PP
Create a fixed size memory storage block that is read only
.PP
\fBReturns:\fP
.RS 4
A krb5_storage on success, or NULL on out of memory error.
.RE
.PP
\fBSee also:\fP
.RS 4
krb5_storage_mem() 
.PP
\fBkrb5_storage_from_mem()\fP 
.PP
\fBkrb5_storage_from_data()\fP 
.PP
\fBkrb5_storage_from_fd()\fP 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL krb5_storage_get_byteorder (krb5_storage * sp)"
.PP
Return the current byteorder for the buffer. See \fBkrb5_storage_set_byteorder()\fP for the list or byte order contants. 
.SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_get_eof_code (krb5_storage * sp)"
.PP
Get the return code that will be used when end of storage is reached.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage
.RE
.PP
\fBReturns:\fP
.RS 4
storage error code 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_storage_is_flags (krb5_storage * sp, krb5_flags flags)"
.PP
Return true or false depending on if the storage flags is set or not. NB testing for the flag 0 always return true.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to check flags on 
.br
\fIflags\fP The flags to test for
.RE
.PP
\fBReturns:\fP
.RS 4
true if all the flags are set, false if not. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_read (krb5_storage * sp, void * buf, size_t len)"
.PP
Read to the storage buffer.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to read from 
.br
\fIbuf\fP the buffer to store the data in 
.br
\fIlen\fP the length to read
.RE
.PP
\fBReturns:\fP
.RS 4
The length of data read (can be shorter then len), or negative on error. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL krb5_storage_seek (krb5_storage * sp, off_t offset, int whence)"
.PP
Seek to a new offset.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to seek in. 
.br
\fIoffset\fP the offset to seek 
.br
\fIwhence\fP relateive searching, SEEK_CUR from the current position, SEEK_END from the end, SEEK_SET absolute from the start.
.RE
.PP
\fBReturns:\fP
.RS 4
The new current offset 
.RE
.PP

.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_byteorder (krb5_storage * sp, krb5_flags byteorder)"
.PP
Set the new byte order of the storage buffer.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to set the byte order for. 
.br
\fIbyteorder\fP the new byte order.
.RE
.PP
The byte order are: KRB5_STORAGE_BYTEORDER_BE, KRB5_STORAGE_BYTEORDER_LE and KRB5_STORAGE_BYTEORDER_HOST. 
.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_eof_code (krb5_storage * sp, int code)"
.PP
Set the return code that will be used when end of storage is reached.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage 
.br
\fIcode\fP the error code to return on end of storage 
.RE
.PP

.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_flags (krb5_storage * sp, krb5_flags flags)"
.PP
Add the flags on a storage buffer by or-ing in the flags to the buffer.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to set the flags on 
.br
\fIflags\fP the flags to set 
.RE
.PP

.SS "KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_max_alloc (krb5_storage * sp, size_t size)"
.PP
Set the max alloc value
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer set the max allow for 
.br
\fIsize\fP maximum size to allocate, use 0 to remove limit 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_to_data (krb5_storage * sp, krb5_data * data)"
.PP
Copy the contnent of storage
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to copy to a data 
.br
\fIdata\fP the copied data, free with \fBkrb5_data_free()\fP
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_truncate (krb5_storage * sp, off_t offset)"
.PP
Truncate the storage buffer in sp to offset.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to truncate. 
.br
\fIoffset\fP the offset to truncate too.
.RE
.PP
\fBReturns:\fP
.RS 4
An Kerberos 5 error code. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_write (krb5_storage * sp, const void * buf, size_t len)"
.PP
Write to the storage buffer.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIbuf\fP the buffer to write to the storage buffer 
.br
\fIlen\fP the length to write
.RE
.PP
\fBReturns:\fP
.RS 4
The length of data written (can be shorter then len), or negative on error. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_address (krb5_storage * sp, krb5_address p)"
.PP
Write a address block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIp\fP the address block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_addrs (krb5_storage * sp, krb5_addresses p)"
.PP
Write a addresses block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIp\fP the addresses block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_authdata (krb5_storage * sp, krb5_authdata auth)"
.PP
Write a auth data block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIauth\fP the auth data block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds (krb5_storage * sp, krb5_creds * creds)"
.PP
Write a credentials block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIcreds\fP the creds block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds_tag (krb5_storage * sp, krb5_creds * creds)"
.PP
Write a tagged credentials block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIcreds\fP the creds block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_data (krb5_storage * sp, krb5_data data)"
.PP
Store a data to the storage. The data is stored with an int32 as lenght plus the data (not padded).
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIdata\fP the buffer to store.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int16 (krb5_storage * sp, int16_t value)"
.PP
Store a int16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int32 (krb5_storage * sp, int32_t value)"
.PP
Store a int32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int8 (krb5_storage * sp, int8_t value)"
.PP
Store a int8 to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_keyblock (krb5_storage * sp, krb5_keyblock p)"
.PP
Store a keyblock to the storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIp\fP the keyblock to write
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_principal (krb5_storage * sp, krb5_const_principal p)"
.PP
Write a principal block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIp\fP the principal block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_string (krb5_storage * sp, const char * s)"
.PP
Store a string to the buffer. The data is formated as an len:uint32 plus the string itself (not padded).
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIs\fP the string to store.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_stringz (krb5_storage * sp, const char * s)"
.PP
Store a zero terminated string to the buffer. The data is stored one character at a time until a NUL is stored.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fIs\fP the string to store.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_times (krb5_storage * sp, krb5_times times)"
.PP
Write a times block to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage buffer to write to 
.br
\fItimes\fP the times block to write.
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint16 (krb5_storage * sp, uint16_t value)"
.PP
Store a uint16 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint32 (krb5_storage * sp, uint32_t value)"
.PP
Store a uint32 to storage, byte order is controlled by the settings on the storage, see \fBkrb5_storage_set_byteorder()\fP.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

.SS "KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint8 (krb5_storage * sp, uint8_t value)"
.PP
Store a uint8 to storage.
.PP
\fBParameters:\fP
.RS 4
\fIsp\fP the storage to write too 
.br
\fIvalue\fP the value to store
.RE
.PP
\fBReturns:\fP
.RS 4
0 for success, or a Kerberos 5 error code on failure. 
.RE
.PP

OpenPOWER on IntegriCloud