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
|
<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>krb5_kt_read_service_key - Retrieve a service key from a key table. — MIT Kerberos Documentation</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../../_static/agogo.css?v=879f3c71" />
<link rel="stylesheet" type="text/css" href="../../../_static/kerb.css?v=6a0b3979" />
<script src="../../../_static/documentation_options.js?v=6dbce55c"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="author" title="About these documents" href="../../../about.html" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="copyright" title="Copyright" href="../../../copyright.html" />
<link rel="next" title="krb5_kt_remove_entry - Remove an entry from a key table." href="krb5_kt_remove_entry.html" />
<link rel="prev" title="krb5_kt_next_entry - Retrieve the next entry from the key table." href="krb5_kt_next_entry.html" />
</head><body>
<div class="header-wrapper">
<div class="header">
<h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
<div class="rel">
<a href="../../../index.html" title="Full Table of Contents"
accesskey="C">Contents</a> |
<a href="krb5_kt_next_entry.html" title="krb5_kt_next_entry - Retrieve the next entry from the key table."
accesskey="P">previous</a> |
<a href="krb5_kt_remove_entry.html" title="krb5_kt_remove_entry - Remove an entry from a key table."
accesskey="N">next</a> |
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a> |
<a href="../../../search.html" title="Enter search criteria"
accesskey="S">Search</a> |
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_kt_read_service_key - Retrieve a service key from a key table.">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="krb5-kt-read-service-key-retrieve-a-service-key-from-a-key-table">
<h1>krb5_kt_read_service_key - Retrieve a service key from a key table.<a class="headerlink" href="#krb5-kt-read-service-key-retrieve-a-service-key-from-a-key-table" title="Link to this heading">¶</a></h1>
<dl class="c function">
<dt class="sig sig-object c" id="c.krb5_kt_read_service_key">
<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_kt_read_service_key</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">keyprocarg</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <a class="reference internal" href="../types/krb5_kvno.html#c.krb5_kvno" title="krb5_kvno"><span class="n"><span class="pre">krb5_kvno</span></span></a><span class="w"> </span><span class="n"><span class="pre">vno</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock"><span class="n"><span class="pre">krb5_keyblock</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_read_service_key" title="Link to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="field-list">
<dt class="field-odd">param<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>
<p><strong>[in]</strong> <strong>keyprocarg</strong> - Name of a key table (NULL to use default name)</p>
<p><strong>[in]</strong> <strong>principal</strong> - Service principal</p>
<p><strong>[in]</strong> <strong>vno</strong> - Key version number (0 for highest available)</p>
<p><strong>[in]</strong> <strong>enctype</strong> - Encryption type (0 for any type)</p>
<p><strong>[out]</strong> <strong>key</strong> - Service key from key table</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">retval<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p>0 Success</p></li>
</ul>
</dd>
<dt class="field-even">return<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p>Kerberos error code if not found or keyprocarg is invalid.</p></li>
</ul>
</dd>
</dl>
<p>Open and search the specified key table for the entry identified by <em>principal</em> , <em>enctype</em> , and <em>vno</em> . If no key is found, return an error code.</p>
<p>The default key table is used, unless <em>keyprocarg</em> is non-null. <em>keyprocarg</em> designates a specific key table.</p>
<p>Use krb5_free_keyblock() to free <em>key</em> when it is no longer needed.</p>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h2>On this page</h2>
<ul>
<li><a class="reference internal" href="#">krb5_kt_read_service_key - Retrieve a service key from a key table.</a></li>
</ul>
<br/>
<h2>Table of contents</h2>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
<li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
<li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
</ul>
<br/>
<h4><a href="../../../index.html">Full Table of Contents</a></h4>
<h4>Search</h4>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer" >
<div class="right" ><i>Release: 1.22.1</i><br />
© <a href="../../../copyright.html">Copyright</a> 1985-2025, MIT.
</div>
<div class="left">
<a href="../../../index.html" title="Full Table of Contents"
>Contents</a> |
<a href="krb5_kt_next_entry.html" title="krb5_kt_next_entry - Retrieve the next entry from the key table."
>previous</a> |
<a href="krb5_kt_remove_entry.html" title="krb5_kt_remove_entry - Remove an entry from a key table."
>next</a> |
<a href="../../../genindex.html" title="General Index"
>index</a> |
<a href="../../../search.html" title="Enter search criteria"
>Search</a> |
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_kt_read_service_key - Retrieve a service key from a key table.">feedback</a>
</div>
</div>
</div>
</body>
</html>
|
