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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials. — MIT Kerberos Documentation</title>
<link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.12.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="author" title="About these documents" href="../../../about.html" />
<link rel="copyright" title="Copyright" href="../../../copyright.html" />
<link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />
<link rel="up" title="krb5 API" href="index.html" />
<link rel="next" title="krb5_mk_safe - Format a KRB-SAFE message." href="krb5_mk_safe.html" />
<link rel="prev" title="krb5_mk_req - Create a KRB_AP_REQ message." href="krb5_mk_req.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_mk_req.html" title="krb5_mk_req - Create a KRB_AP_REQ message."
accesskey="P">previous</a> |
<a href="krb5_mk_safe.html" title="krb5_mk_safe - Format a KRB-SAFE message."
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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials">
<h1>krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.<a class="headerlink" href="#krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="krb5_mk_req_extended">
<a class="reference internal" href="../types/krb5_error_code.html#krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_mk_req_extended</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#krb5_context" title="krb5_context">krb5_context</a><em> context</em>, <a class="reference internal" href="../types/krb5_auth_context.html#krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_flags.html#krb5_flags" title="krb5_flags">krb5_flags</a><em> ap_req_options</em>, <a class="reference internal" href="../types/krb5_data.html#krb5_data" title="krb5_data">krb5_data</a> *<em> in_data</em>, <a class="reference internal" href="../types/krb5_creds.html#krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_data.html#krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><big>)</big><a class="headerlink" href="#krb5_mk_req_extended" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p>
<p><strong>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p>
<p><strong>[in]</strong> <strong>ap_req_options</strong> - <tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS</span></tt> options</p>
<p><strong>[in]</strong> <strong>in_data</strong> - Application data to be checksummed in the authenticator, or NULL</p>
<p><strong>[in]</strong> <strong>in_creds</strong> - Credentials for the service with valid ticket and key</p>
<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REQ</strong> message</p>
</td>
</tr>
</tbody>
</table>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
<li>0 Success; otherwise - Kerberos error codes</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Valid <em>ap_req_options</em> are:</p>
<blockquote>
<div><blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../macros/AP_OPTS_USE_SESSION_KEY.html#AP_OPTS_USE_SESSION_KEY" title="AP_OPTS_USE_SESSION_KEY"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SESSION_KEY</span></tt></a> - Use the session key when creating the request used for user to user authentication.</li>
<li><a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></tt></a> - Request a mutual authentication packet from the reciever.</li>
<li><a class="reference internal" href="../macros/AP_OPTS_USE_SUBKEY.html#AP_OPTS_USE_SUBKEY" title="AP_OPTS_USE_SUBKEY"><tt class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SUBKEY</span></tt></a> - Generate a subsession key from the current session key obtained from the credentials.</li>
</ul>
</div></blockquote>
<p>This function creates a KRB_AP_REQ message using supplied credentials <em>in_creds</em> . <em>auth_context</em> may point to an existing auth context or to NULL, in which case a new one will be created. If <em>in_data</em> is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. Use <a class="reference internal" href="krb5_free_data_contents.html#krb5_free_data_contents" title="krb5_free_data_contents"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_data_contents()</span></tt></a> to free <em>outbuf</em> when it is no longer needed.</p>
</div></blockquote>
<p>On successful return, the authenticator is stored in <em>auth_context</em> with the <em>client</em> and <em>checksum</em> fields nulled out. (This is to prevent pointer-sharing problems; the caller should not need these fields anyway, since the caller supplied them.)</p>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="krb5_mk_req.html#krb5_mk_req" title="krb5_mk_req"><tt class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></tt></a></p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h2>On this page</h2>
<ul>
<li><a class="reference internal" href="#">krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.</a></li>
</ul>
<br/>
<h2>Table of contents</h2>
<ul>
<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"><a class="reference internal" href="../../index.html">For application developers</a></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="../../../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.12.1</i><br />
© <a href="../../../copyright.html">Copyright</a> 1985-2013, MIT.
</div>
<div class="left">
<a href="../../../index.html" title="Full Table of Contents"
>Contents</a> |
<a href="krb5_mk_req.html" title="krb5_mk_req - Create a KRB_AP_REQ message."
>previous</a> |
<a href="krb5_mk_safe.html" title="krb5_mk_safe - Format a KRB-SAFE message."
>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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.">feedback</a>
</div>
</div>
</div>
</body>
</html>
|