1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>krb5_mk_priv - Format a KRB-PRIV message. — MIT Kerberos Documentation</title>
11 <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
12 <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13 <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
15 <script type="text/javascript">
16 var DOCUMENTATION_OPTIONS = {
17 URL_ROOT: '../../../',
19 COLLAPSE_INDEX: false,
24 <script type="text/javascript" src="../../../_static/jquery.js"></script>
25 <script type="text/javascript" src="../../../_static/underscore.js"></script>
26 <script type="text/javascript" src="../../../_static/doctools.js"></script>
27 <link rel="author" title="About these documents" href="../../../about.html" />
28 <link rel="copyright" title="Copyright" href="../../../copyright.html" />
29 <link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />
30 <link rel="up" title="krb5 API" href="index.html" />
31 <link rel="next" title="krb5_mk_rep - Format and encrypt a KRB_AP_REP message." href="krb5_mk_rep.html" />
32 <link rel="prev" title="krb5_mk_ncred - Format a KRB-CRED message for an array of credentials." href="krb5_mk_ncred.html" />
35 <div class="header-wrapper">
39 <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
43 <a href="../../../index.html" title="Full Table of Contents"
44 accesskey="C">Contents</a> |
45 <a href="krb5_mk_ncred.html" title="krb5_mk_ncred - Format a KRB-CRED message for an array of credentials."
46 accesskey="P">previous</a> |
47 <a href="krb5_mk_rep.html" title="krb5_mk_rep - Format and encrypt a KRB_AP_REP message."
48 accesskey="N">next</a> |
49 <a href="../../../genindex.html" title="General Index"
50 accesskey="I">index</a> |
51 <a href="../../../search.html" title="Enter search criteria"
52 accesskey="S">Search</a> |
53 <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_mk_priv - Format a KRB-PRIV message.">feedback</a>
58 <div class="content-wrapper">
60 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <div class="section" id="krb5-mk-priv-format-a-krb-priv-message">
67 <h1>krb5_mk_priv - Format a KRB-PRIV message.<a class="headerlink" href="#krb5-mk-priv-format-a-krb-priv-message" title="Permalink to this headline">¶</a></h1>
69 <dt id="c.krb5_mk_priv">
70 <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_mk_priv</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> context</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> userdata</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> outdata</em><big>)</big><a class="headerlink" href="#c.krb5_mk_priv" title="Permalink to this definition">¶</a></dt>
73 <table class="docutils field-list" frame="void" rules="none">
74 <col class="field-name" />
75 <col class="field-body" />
77 <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>
78 <p><strong>[in]</strong> <strong>auth_context</strong> - Authentication context</p>
79 <p><strong>[in]</strong> <strong>userdata</strong> - User data for <strong>KRB-PRIV</strong> message</p>
80 <p><strong>[out]</strong> <strong>outbuf</strong> - Formatted <strong>KRB-PRIV</strong> message</p>
81 <p class="last"><strong>[out]</strong> <strong>outdata</strong> - Replay cache handle (NULL if not needed)</p>
86 <table class="docutils field-list" frame="void" rules="none">
87 <col class="field-name" />
88 <col class="field-body" />
90 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
91 <li>0 Success; otherwise - Kerberos error codes</li>
97 <p>This function is similar to <a class="reference internal" href="krb5_mk_safe.html#c.krb5_mk_safe" title="krb5_mk_safe"><tt class="xref c c-func docutils literal"><span class="pre">krb5_mk_safe()</span></tt></a> , but the message is encrypted and integrity-protected, not just integrity-protected.</p>
98 <p>The local address in <em>auth_context</em> must be set, and is used to form the sender address used in the KRB-SAFE message. The remote address is optional; if specified, it will be used to form the receiver address used in the message.</p>
100 <div><ul class="simple">
101 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_TIME.html#KRB5_AUTH_CONTEXT_DO_TIME" title="KRB5_AUTH_CONTEXT_DO_TIME"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></tt></a> - Use timestamps in <em>outdata</em></li>
102 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_TIME.html#KRB5_AUTH_CONTEXT_RET_TIME" title="KRB5_AUTH_CONTEXT_RET_TIME"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></tt></a> - Copy timestamp to <em>outdata</em> .</li>
103 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_DO_SEQUENCE.html#KRB5_AUTH_CONTEXT_DO_SEQUENCE" title="KRB5_AUTH_CONTEXT_DO_SEQUENCE"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></tt></a> - Use local sequence numbers from <em>auth_context</em> in replay cache.</li>
104 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_SEQUENCE.html#KRB5_AUTH_CONTEXT_RET_SEQUENCE" title="KRB5_AUTH_CONTEXT_RET_SEQUENCE"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></tt></a> - Use local sequence numbers from <em>auth_context</em> as a sequence number in the encrypted message <em>outbuf</em> .</li>
107 <div class="admonition note">
108 <p class="first admonition-title">Note</p>
109 <p>If the <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_TIME.html#KRB5_AUTH_CONTEXT_RET_TIME" title="KRB5_AUTH_CONTEXT_RET_TIME"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></tt></a> or <a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_RET_SEQUENCE.html#KRB5_AUTH_CONTEXT_RET_SEQUENCE" title="KRB5_AUTH_CONTEXT_RET_SEQUENCE"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></tt></a> flag is set in <em>auth_context</em> , the <em>outdata</em> is required.</p>
110 <p class="last">The flags from <em>auth_context</em> specify whether sequence numbers or timestamps will be used to identify the message. Valid values are:</p>
119 <div class="sidebar">
120 <h2>On this page</h2>
122 <li><a class="reference internal" href="#">krb5_mk_priv - Format a KRB-PRIV message.</a></li>
126 <h2>Table of contents</h2>
128 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
129 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
130 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
131 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
132 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
133 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
134 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
135 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
136 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
137 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
138 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
143 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
144 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
145 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
146 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
147 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
148 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
149 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
150 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
154 <h4><a href="../../../index.html">Full Table of Contents</a></h4>
156 <form class="search" action="../../../search.html" method="get">
157 <input type="text" name="q" size="18" />
158 <input type="submit" value="Go" />
159 <input type="hidden" name="check_keywords" value="yes" />
160 <input type="hidden" name="area" value="default" />
163 <div class="clearer"></div>
167 <div class="footer-wrapper">
168 <div class="footer" >
169 <div class="right" ><i>Release: 1.15.1</i><br />
170 © <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
174 <a href="../../../index.html" title="Full Table of Contents"
176 <a href="krb5_mk_ncred.html" title="krb5_mk_ncred - Format a KRB-CRED message for an array of credentials."
178 <a href="krb5_mk_rep.html" title="krb5_mk_rep - Format and encrypt a KRB_AP_REP message."
180 <a href="../../../genindex.html" title="General Index"
182 <a href="../../../search.html" title="Enter search criteria"
184 <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_mk_priv - Format a KRB-PRIV message.">feedback</a>