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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Heimdal Kerberos 5 credential handing functions</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<p>
<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
</p>
<!-- end of header marker -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Heimdal Kerberos 5 credential handing functions</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7335efb74572151bb521c367c39b7a4a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga7335efb74572151bb521c367c39b7a4a">krb5_fwd_tgt_creds</a> (krb5_context context, krb5_auth_context auth_context, const char *hostname, krb5_principal client, krb5_principal server, krb5_ccache ccache, int forwardable, krb5_data *out_data)</td></tr>
<tr class="separator:ga7335efb74572151bb521c367c39b7a4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6429a273ae5ed0d9333a22f5b5f1f42a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga6429a273ae5ed0d9333a22f5b5f1f42a">krb5_get_forwarded_creds</a> (krb5_context context, krb5_auth_context auth_context, krb5_ccache ccache, krb5_flags flags, const char *hostname, krb5_creds *in_creds, krb5_data *out_data)</td></tr>
<tr class="separator:ga6429a273ae5ed0d9333a22f5b5f1f42a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc0922393cb5c5eecec2d83f1851c21b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gabc0922393cb5c5eecec2d83f1851c21b">krb5_get_init_creds_opt_alloc</a> (krb5_context context, krb5_get_init_creds_opt **opt)</td></tr>
<tr class="separator:gabc0922393cb5c5eecec2d83f1851c21b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2be2f013c88153be9535c17a2b16f336"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga2be2f013c88153be9535c17a2b16f336">krb5_get_init_creds_opt_free</a> (krb5_context context, krb5_get_init_creds_opt *opt)</td></tr>
<tr class="separator:ga2be2f013c88153be9535c17a2b16f336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1a610bb2706e4048e8220225da110033"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga1a610bb2706e4048e8220225da110033">krb5_init_creds_init</a> (krb5_context context, krb5_principal client, krb5_prompter_fct prompter, void *prompter_data, krb5_deltat start_time, krb5_get_init_creds_opt *options, krb5_init_creds_context *rctx)</td></tr>
<tr class="separator:ga1a610bb2706e4048e8220225da110033"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga71f386b20c42540d4e733eeb7c0cb18e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga71f386b20c42540d4e733eeb7c0cb18e">krb5_init_creds_set_service</a> (krb5_context context, krb5_init_creds_context ctx, const char *service)</td></tr>
<tr class="separator:ga71f386b20c42540d4e733eeb7c0cb18e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a1d093a3c43b57b5e84206e73441d68"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga0a1d093a3c43b57b5e84206e73441d68">krb5_init_creds_set_password</a> (krb5_context context, krb5_init_creds_context ctx, const char *password)</td></tr>
<tr class="separator:ga0a1d093a3c43b57b5e84206e73441d68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab80179f38c8cc87627752d5db22c8203"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab80179f38c8cc87627752d5db22c8203">krb5_init_creds_set_keytab</a> (krb5_context context, krb5_init_creds_context ctx, krb5_keytab keytab)</td></tr>
<tr class="separator:gab80179f38c8cc87627752d5db22c8203"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9b1f54a05b9e7b60bef0c7d5f40b351b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga9b1f54a05b9e7b60bef0c7d5f40b351b">krb5_init_creds_step</a> (krb5_context context, krb5_init_creds_context ctx, krb5_data *in, krb5_data *out, krb5_krbhst_info *hostinfo, unsigned int *flags)</td></tr>
<tr class="separator:ga9b1f54a05b9e7b60bef0c7d5f40b351b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab5b9ab4698f5af99c06dbcc015c39e27"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab5b9ab4698f5af99c06dbcc015c39e27">krb5_init_creds_get_error</a> (krb5_context context, krb5_init_creds_context ctx, KRB_ERROR *error)</td></tr>
<tr class="separator:gab5b9ab4698f5af99c06dbcc015c39e27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf878f5715a3048995f175c09e95a3a71"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gaf878f5715a3048995f175c09e95a3a71">krb5_init_creds_free</a> (krb5_context context, krb5_init_creds_context ctx)</td></tr>
<tr class="separator:gaf878f5715a3048995f175c09e95a3a71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1716df7cb25ebea9bbf652094970bce"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gab1716df7cb25ebea9bbf652094970bce">krb5_init_creds_get</a> (krb5_context context, krb5_init_creds_context ctx)</td></tr>
<tr class="separator:gab1716df7cb25ebea9bbf652094970bce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae7e4852f19e7f83bd743952491d1f4b1"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#gae7e4852f19e7f83bd743952491d1f4b1">krb5_get_init_creds_password</a> (krb5_context context, krb5_creds *creds, krb5_principal client, const char *password, krb5_prompter_fct prompter, void *data, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr>
<tr class="separator:gae7e4852f19e7f83bd743952491d1f4b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga32573c317cca5198b04550d753b369a1"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga32573c317cca5198b04550d753b369a1">krb5_get_init_creds_keyblock</a> (krb5_context context, krb5_creds *creds, krb5_principal client, krb5_keyblock *keyblock, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr>
<tr class="separator:ga32573c317cca5198b04550d753b369a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga83e4a8a74b08522bd778c2d59ef1f2b6"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__credential.html#ga83e4a8a74b08522bd778c2d59ef1f2b6">krb5_get_init_creds_keytab</a> (krb5_context context, krb5_creds *creds, krb5_principal client, krb5_keytab keytab, krb5_deltat start_time, const char *in_tkt_service, krb5_get_init_creds_opt *options)</td></tr>
<tr class="separator:ga83e4a8a74b08522bd778c2d59ef1f2b6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7335efb74572151bb521c367c39b7a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7335efb74572151bb521c367c39b7a4a">◆ </a></span>krb5_fwd_tgt_creds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_fwd_tgt_creds </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_auth_context </td>
<td class="paramname"><em>auth_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hostname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_ccache </td>
<td class="paramname"><em>ccache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>forwardable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_data * </td>
<td class="paramname"><em>out_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Forward credentials for client to host hostname , making them forwardable if forwardable, and returning the blob of data to sent in out_data. If hostname == NULL, pick it from server.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>A kerberos 5 context. </td></tr>
<tr><td class="paramname">auth_context</td><td>the auth context with the key to encrypt the out_data. </td></tr>
<tr><td class="paramname">hostname</td><td>the host to forward the tickets too. </td></tr>
<tr><td class="paramname">client</td><td>the client to delegate from. </td></tr>
<tr><td class="paramname">server</td><td>the server to delegate the credential too. </td></tr>
<tr><td class="paramname">ccache</td><td>credential cache to use. </td></tr>
<tr><td class="paramname">forwardable</td><td>make the forwarded ticket forwabledable. </td></tr>
<tr><td class="paramname">out_data</td><td>the resulting credential.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0. </dd></dl>
</div>
</div>
<a id="ga6429a273ae5ed0d9333a22f5b5f1f42a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6429a273ae5ed0d9333a22f5b5f1f42a">◆ </a></span>krb5_get_forwarded_creds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_forwarded_creds </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_auth_context </td>
<td class="paramname"><em>auth_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_ccache </td>
<td class="paramname"><em>ccache</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_flags </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hostname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_creds * </td>
<td class="paramname"><em>in_creds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_data * </td>
<td class="paramname"><em>out_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets tickets forwarded to hostname. If the tickets that are forwarded are address-less, the forwarded tickets will also be address-less.</p>
<p>If the ticket have any address, hostname will be used for figure out the address to forward the ticket too. This since this might use DNS, its insecure and also doesn't represent configured all addresses of the host. For example, the host might have two adresses, one IPv4 and one IPv6 address where the later is not published in DNS. This IPv6 address might be used communications and thus the resulting ticket useless.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>A kerberos 5 context. </td></tr>
<tr><td class="paramname">auth_context</td><td>the auth context with the key to encrypt the out_data. </td></tr>
<tr><td class="paramname">ccache</td><td>credential cache to use </td></tr>
<tr><td class="paramname">flags</td><td>the flags to control the resulting ticket flags </td></tr>
<tr><td class="paramname">hostname</td><td>the host to forward the tickets too. </td></tr>
<tr><td class="paramname">in_creds</td><td>the in client and server ticket names. The client and server components forwarded to the remote host. </td></tr>
<tr><td class="paramname">out_data</td><td>the resulting credential.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0. </dd></dl>
<p>Some older of the MIT gssapi library used clear-text tickets (warped inside AP-REQ encryption), use the krb5_auth_context flag KRB5_AUTH_CONTEXT_CLEAR_FORWARDED_CRED to support those tickets. The session key is used otherwise to encrypt the forwarded ticket.</p>
</div>
</div>
<a id="ga32573c317cca5198b04550d753b369a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga32573c317cca5198b04550d753b369a1">◆ </a></span>krb5_get_init_creds_keyblock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_keyblock </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_creds * </td>
<td class="paramname"><em>creds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_keyblock * </td>
<td class="paramname"><em>keyblock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_deltat </td>
<td class="paramname"><em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>in_tkt_service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt * </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get new credentials using keyblock. </p>
</div>
</div>
<a id="ga83e4a8a74b08522bd778c2d59ef1f2b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga83e4a8a74b08522bd778c2d59ef1f2b6">◆ </a></span>krb5_get_init_creds_keytab()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_keytab </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_creds * </td>
<td class="paramname"><em>creds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_keytab </td>
<td class="paramname"><em>keytab</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_deltat </td>
<td class="paramname"><em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>in_tkt_service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt * </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get new credentials using keytab. </p>
</div>
</div>
<a id="gabc0922393cb5c5eecec2d83f1851c21b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc0922393cb5c5eecec2d83f1851c21b">◆ </a></span>krb5_get_init_creds_opt_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_opt_alloc </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt ** </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a new krb5_get_init_creds_opt structure, free with <a class="el" href="group__krb5__credential.html#ga2be2f013c88153be9535c17a2b16f336">krb5_get_init_creds_opt_free()</a>. </p>
</div>
</div>
<a id="ga2be2f013c88153be9535c17a2b16f336"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2be2f013c88153be9535c17a2b16f336">◆ </a></span>krb5_get_init_creds_opt_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_get_init_creds_opt_free </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt * </td>
<td class="paramname"><em>opt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free krb5_get_init_creds_opt structure. </p>
</div>
</div>
<a id="gae7e4852f19e7f83bd743952491d1f4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7e4852f19e7f83bd743952491d1f4b1">◆ </a></span>krb5_get_init_creds_password()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_get_init_creds_password </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_creds * </td>
<td class="paramname"><em>creds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_prompter_fct </td>
<td class="paramname"><em>prompter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_deltat </td>
<td class="paramname"><em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>in_tkt_service</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt * </td>
<td class="paramname"><em>options</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get new credentials using password. </p>
</div>
</div>
<a id="gaf878f5715a3048995f175c09e95a3a71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf878f5715a3048995f175c09e95a3a71">◆ </a></span>krb5_init_creds_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_init_creds_free </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the krb5_init_creds_context allocated by <a class="el" href="group__krb5__credential.html#ga1a610bb2706e4048e8220225da110033">krb5_init_creds_init()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>The krb5_init_creds_context to free. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab1716df7cb25ebea9bbf652094970bce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1716df7cb25ebea9bbf652094970bce">◆ </a></span>krb5_init_creds_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get new credentials as setup by the krb5_init_creds_context.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>The krb5_init_creds_context to process. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab5b9ab4698f5af99c06dbcc015c39e27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab5b9ab4698f5af99c06dbcc015c39e27">◆ </a></span>krb5_init_creds_get_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_get_error </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KRB_ERROR * </td>
<td class="paramname"><em>error</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the last error from the transaction.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns 0 or an error code </dd></dl>
</div>
</div>
<a id="ga1a610bb2706e4048e8220225da110033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1a610bb2706e4048e8220225da110033">◆ </a></span>krb5_init_creds_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_init </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_principal </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_prompter_fct </td>
<td class="paramname"><em>prompter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>prompter_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_deltat </td>
<td class="paramname"><em>start_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_get_init_creds_opt * </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context * </td>
<td class="paramname"><em>rctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start a new context to get a new initial credential.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr>
<tr><td class="paramname">client</td><td>The Kerberos principal to get the credential for, if NULL is given, the default principal is used as determined by krb5_get_default_principal(). </td></tr>
<tr><td class="paramname">prompter</td><td></td></tr>
<tr><td class="paramname">prompter_data</td><td></td></tr>
<tr><td class="paramname">start_time</td><td>the time the ticket should start to be valid or 0 for now. </td></tr>
<tr><td class="paramname">options</td><td>a options structure, can be NULL for default options. </td></tr>
<tr><td class="paramname">rctx</td><td>A new allocated free with <a class="el" href="group__krb5__credential.html#gaf878f5715a3048995f175c09e95a3a71">krb5_init_creds_free()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
</div>
</div>
<a id="gab80179f38c8cc87627752d5db22c8203"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab80179f38c8cc87627752d5db22c8203">◆ </a></span>krb5_init_creds_set_keytab()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_keytab </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_keytab </td>
<td class="paramname"><em>keytab</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the keytab to use for authentication.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr>
<tr><td class="paramname">keytab</td><td>the keytab to read the key from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
</div>
</div>
<a id="ga0a1d093a3c43b57b5e84206e73441d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a1d093a3c43b57b5e84206e73441d68">◆ </a></span>krb5_init_creds_set_password()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_password </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the password that will use for the request.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr>
<tr><td class="paramname">password</td><td>the password to use.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
</div>
</div>
<a id="ga71f386b20c42540d4e733eeb7c0cb18e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga71f386b20c42540d4e733eeb7c0cb18e">◆ </a></span>krb5_init_creds_set_service()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_set_service </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>service</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the service that the is requested. This call is only neede for special initial tickets, by default the a krbtgt is fetched in the default realm.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>a krb5_init_creds_context context. </td></tr>
<tr><td class="paramname">service</td><td>the service given as a string, for example "kadmind/admin". If NULL, the default krbtgt in the clients realm is set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
</div>
</div>
<a id="ga9b1f54a05b9e7b60bef0c7d5f40b351b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9b1f54a05b9e7b60bef0c7d5f40b351b">◆ </a></span>krb5_init_creds_step()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_init_creds_step </td>
<td>(</td>
<td class="paramtype">krb5_context </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_init_creds_context </td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_data * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_data * </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">krb5_krbhst_info * </td>
<td class="paramname"><em>hostinfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The core loop if krb5_get_init_creds() function family. Create the packets and have the caller send them off to the KDC.</p>
<p>If the caller want all work been done for them, use <a class="el" href="group__krb5__credential.html#gab1716df7cb25ebea9bbf652094970bce">krb5_init_creds_get()</a> instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr>
<tr><td class="paramname">ctx</td><td>ctx krb5_init_creds_context context. </td></tr>
<tr><td class="paramname">in</td><td>input data from KDC, first round it should be reset by krb5_data_zer(). </td></tr>
<tr><td class="paramname">out</td><td>reply to KDC. </td></tr>
<tr><td class="paramname">hostinfo</td><td>KDC address info, first round it can be NULL. </td></tr>
<tr><td class="paramname">flags</td><td>status of the round, if KRB5_INIT_CREDS_STEP_FLAG_CONTINUE is set, continue one more round.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 for success, or an Kerberos 5 error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
</div>
</div>
</div><!-- contents -->
<hr size="1"><address style="text-align: right;"><small>
Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
</body>
</html>
|
