xref: /netbsd-src/crypto/external/bsd/heimdal/dist/doc/doxyout/krb5/html/group__krb5__pac.html (revision dd75ac5b443e967e26b4d18cc8cd5eb98512bfbf)
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>Heimdal Kerberos 5 PAC handling functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<p>
8<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a>
9</p>
10<!-- end of header marker -->
11<!-- Generated by Doxygen 1.9.1 -->
12<script type="text/javascript" src="menudata.js"></script>
13<script type="text/javascript" src="menu.js"></script>
14<script type="text/javascript">
15/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
16$(function() {
17  initMenu('',false,false,'search.php','Search');
18});
19/* @license-end */</script>
20<div id="main-nav"></div>
21</div><!-- top -->
22<div class="header">
23  <div class="summary">
24<a href="#func-members">Functions</a>  </div>
25  <div class="headertitle">
26<div class="title">Heimdal Kerberos 5 PAC handling functions</div>  </div>
27</div><!--header-->
28<div class="contents">
29<table class="memberdecls">
30<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
31Functions</h2></td></tr>
32<tr class="memitem:gad25693feb5786c4c964bfcff87961bf7"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__pac.html#gad25693feb5786c4c964bfcff87961bf7">krb5_pac_get_buffer</a> (krb5_context context, krb5_pac p, uint32_t type, krb5_data *data)</td></tr>
33<tr class="separator:gad25693feb5786c4c964bfcff87961bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
34<tr class="memitem:ga07a7fffbb07e4434a0e3526653c629a0"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__pac.html#ga07a7fffbb07e4434a0e3526653c629a0">krb5_pac_verify</a> (krb5_context context, const krb5_pac pac, time_t authtime, krb5_const_principal principal, const krb5_keyblock *server, const krb5_keyblock *privsvr)</td></tr>
35<tr class="separator:ga07a7fffbb07e4434a0e3526653c629a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
36</table>
37<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
38<h2 class="groupheader">Function Documentation</h2>
39<a id="gad25693feb5786c4c964bfcff87961bf7"></a>
40<h2 class="memtitle"><span class="permalink"><a href="#gad25693feb5786c4c964bfcff87961bf7">&#9670;&nbsp;</a></span>krb5_pac_get_buffer()</h2>
41
42<div class="memitem">
43<div class="memproto">
44      <table class="memname">
45        <tr>
46          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_pac_get_buffer </td>
47          <td>(</td>
48          <td class="paramtype">krb5_context&#160;</td>
49          <td class="paramname"><em>context</em>, </td>
50        </tr>
51        <tr>
52          <td class="paramkey"></td>
53          <td></td>
54          <td class="paramtype">krb5_pac&#160;</td>
55          <td class="paramname"><em>p</em>, </td>
56        </tr>
57        <tr>
58          <td class="paramkey"></td>
59          <td></td>
60          <td class="paramtype">uint32_t&#160;</td>
61          <td class="paramname"><em>type</em>, </td>
62        </tr>
63        <tr>
64          <td class="paramkey"></td>
65          <td></td>
66          <td class="paramtype">krb5_data *&#160;</td>
67          <td class="paramname"><em>data</em>&#160;</td>
68        </tr>
69        <tr>
70          <td></td>
71          <td>)</td>
72          <td></td><td></td>
73        </tr>
74      </table>
75</div><div class="memdoc">
76<p>Get the PAC buffer of specific type from the pac.</p>
77<dl class="params"><dt>Parameters</dt><dd>
78  <table class="params">
79    <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr>
80    <tr><td class="paramname">p</td><td>the pac structure returned by krb5_pac_parse(). </td></tr>
81    <tr><td class="paramname">type</td><td>type of buffer to get </td></tr>
82    <tr><td class="paramname">data</td><td>return data, free with <a class="el" href="group__krb5.html#gab4b80ac7a8bbab89fe947ae1c7828ea8">krb5_data_free()</a>.</td></tr>
83  </table>
84  </dd>
85</dl>
86<dl class="section return"><dt>Returns</dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
87
88</div>
89</div>
90<a id="ga07a7fffbb07e4434a0e3526653c629a0"></a>
91<h2 class="memtitle"><span class="permalink"><a href="#ga07a7fffbb07e4434a0e3526653c629a0">&#9670;&nbsp;</a></span>krb5_pac_verify()</h2>
92
93<div class="memitem">
94<div class="memproto">
95      <table class="memname">
96        <tr>
97          <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_pac_verify </td>
98          <td>(</td>
99          <td class="paramtype">krb5_context&#160;</td>
100          <td class="paramname"><em>context</em>, </td>
101        </tr>
102        <tr>
103          <td class="paramkey"></td>
104          <td></td>
105          <td class="paramtype">const krb5_pac&#160;</td>
106          <td class="paramname"><em>pac</em>, </td>
107        </tr>
108        <tr>
109          <td class="paramkey"></td>
110          <td></td>
111          <td class="paramtype">time_t&#160;</td>
112          <td class="paramname"><em>authtime</em>, </td>
113        </tr>
114        <tr>
115          <td class="paramkey"></td>
116          <td></td>
117          <td class="paramtype">krb5_const_principal&#160;</td>
118          <td class="paramname"><em>principal</em>, </td>
119        </tr>
120        <tr>
121          <td class="paramkey"></td>
122          <td></td>
123          <td class="paramtype">const krb5_keyblock *&#160;</td>
124          <td class="paramname"><em>server</em>, </td>
125        </tr>
126        <tr>
127          <td class="paramkey"></td>
128          <td></td>
129          <td class="paramtype">const krb5_keyblock *&#160;</td>
130          <td class="paramname"><em>privsvr</em>&#160;</td>
131        </tr>
132        <tr>
133          <td></td>
134          <td>)</td>
135          <td></td><td></td>
136        </tr>
137      </table>
138</div><div class="memdoc">
139<p>Verify the PAC.</p>
140<dl class="params"><dt>Parameters</dt><dd>
141  <table class="params">
142    <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr>
143    <tr><td class="paramname">pac</td><td>the pac structure returned by krb5_pac_parse(). </td></tr>
144    <tr><td class="paramname">authtime</td><td>The time of the ticket the PAC belongs to. </td></tr>
145    <tr><td class="paramname">principal</td><td>the principal to verify. </td></tr>
146    <tr><td class="paramname">server</td><td>The service key, most always be given. </td></tr>
147    <tr><td class="paramname">privsvr</td><td>The KDC key, may be given.</td></tr>
148  </table>
149  </dd>
150</dl>
151<dl class="section return"><dt>Returns</dt><dd>Returns 0 to indicate success. Otherwise an kerberos et error code is returned, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl>
152
153</div>
154</div>
155</div><!-- contents -->
156<hr size="1"><address style="text-align: right;"><small>
157Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address>
158</body>
159</html>
160