doc/html/appdev/refs/api/krb5_rd_safe.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>krb5_rd_safe - Process KRB-SAFE message. &mdash; MIT Kerberos Documentation</title>
  10
  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" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    '../../../',
  18         VERSION:     '1.15.1',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  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_read_password - Read a password from keyboard input." href="krb5_read_password.html" />
  32     <link rel="prev" title="krb5_rd_req - Parse and decrypt a KRB_AP_REQ message." href="krb5_rd_req.html" />
  33   </head>
  34   <body>
  35     <div class="header-wrapper">
  36         <div class="header">
  37
  38
  39             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  40
  41             <div class="rel">
  42
  43         <a href="../../../index.html" title="Full Table of Contents"
  44             accesskey="C">Contents</a> |
  45         <a href="krb5_rd_req.html" title="krb5_rd_req - Parse and decrypt a KRB_AP_REQ message."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_read_password.html" title="krb5_read_password - Read a password from keyboard input."
  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_rd_safe -  Process KRB-SAFE message.">feedback</a>
  54             </div>
  55         </div>
  56     </div>
  57
  58     <div class="content-wrapper">
  59       <div class="content">
  60         <div class="document">
  61
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <div class="section" id="krb5-rd-safe-process-krb-safe-message">
  67 <h1>krb5_rd_safe -  Process KRB-SAFE message.<a class="headerlink" href="#krb5-rd-safe-process-krb-safe-message" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_rd_safe">
  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_rd_safe</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em>&nbsp;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>&nbsp;auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;inbuf</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em>&nbsp;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>&nbsp;outdata</em><big>)</big><a class="headerlink" href="#c.krb5_rd_safe" title="Permalink to this definition">¶</a></dt>
  71 <dd></dd></dl>
  72
  73 <table class="docutils field-list" frame="void" rules="none">
  74 <col class="field-name" />
  75 <col class="field-body" />
  76 <tbody valign="top">
  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>inbuf</strong> - <strong>KRB-SAFE</strong> message to be parsed</p>
  80 <p><strong>[out]</strong> <strong>outbuf</strong> - Data parsed from <strong>KRB-SAFE</strong> message</p>
  81 <p class="last"><strong>[out]</strong> <strong>outdata</strong> - Replay data. Specify NULL if not needed</p>
  82 </td>
  83 </tr>
  84 </tbody>
  85 </table>
  86 <table class="docutils field-list" frame="void" rules="none">
  87 <col class="field-name" />
  88 <col class="field-body" />
  89 <tbody valign="top">
  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>
  92 </ul>
  93 </td>
  94 </tr>
  95 </tbody>
  96 </table>
  97 <p>This function parses a <strong>KRB-SAFE</strong> message, verifies its integrity, and stores its data into <em>outbuf</em> .</p>
  98 <p>If the <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> flag is set in <em>auth_context</em> , the sequence number of the KRB-SAFE message is checked against the remote sequence number field of <em>auth_context</em> . Otherwise, the sequence number is not used.</p>
  99 <p>If the <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> flag is set in <em>auth_context</em> , then two additional checks are performed:</p>
 100 <blockquote>
 101 <div><blockquote>
 102 <div><ul class="simple">
 103 <li>The timestamp in the message must be within the permitted clock skew (which is usually five minutes).</li>
 104 <li>The message must not be a replayed message field in <em>auth_context</em> .</li>
 105 </ul>
 106 </div></blockquote>
 107 <p>Use <a class="reference internal" href="krb5_free_data_contents.html#c.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>
 108 </div></blockquote>
 109 <div class="admonition note">
 110 <p class="first admonition-title">Note</p>
 111 <p>The <em>outdata</em> argument is required if <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 the <em>auth_context</em> .</p>
 112 <p class="last"><em>auth_context</em> must have a remote address set. This address will be used to verify the sender address in the KRB-SAFE message. If <em>auth_context</em> has a local address set, it will be used to verify the receiver address in the KRB-SAFE message if the message contains one. Both addresses must use type <strong>ADDRTYPE_ADDRPORT</strong> .</p>
 113 </div>
 114 </div>
 115
 116
 117           </div>
 118         </div>
 119       </div>
 120         </div>
 121         <div class="sidebar">
 122     <h2>On this page</h2>
 123     <ul>
 124 <li><a class="reference internal" href="#">krb5_rd_safe -  Process KRB-SAFE message.</a></li>
 125 </ul>
 126
 127     <br/>
 128     <h2>Table of contents</h2>
 129     <ul class="current">
 130 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 131 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 132 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 133 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 137 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 138 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 139 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 140 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 141 </ul>
 142 </li>
 143 </ul>
 144 </li>
 145 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 146 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 147 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 148 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 149 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 150 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 151 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 152 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 153 </ul>
 154
 155     <br/>
 156     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 157     <h4>Search</h4>
 158     <form class="search" action="../../../search.html" method="get">
 159       <input type="text" name="q" size="18" />
 160       <input type="submit" value="Go" />
 161       <input type="hidden" name="check_keywords" value="yes" />
 162       <input type="hidden" name="area" value="default" />
 163     </form>
 164         </div>
 165         <div class="clearer"></div>
 166       </div>
 167     </div>
 168
 169     <div class="footer-wrapper">
 170         <div class="footer" >
 171             <div class="right" ><i>Release: 1.15.1</i><br />
 172                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 173             </div>
 174             <div class="left">
 175
 176         <a href="../../../index.html" title="Full Table of Contents"
 177             >Contents</a> |
 178         <a href="krb5_rd_req.html" title="krb5_rd_req - Parse and decrypt a KRB_AP_REQ message."
 179             >previous</a> |
 180         <a href="krb5_read_password.html" title="krb5_read_password - Read a password from keyboard input."
 181             >next</a> |
 182         <a href="../../../genindex.html" title="General Index"
 183             >index</a> |
 184         <a href="../../../search.html" title="Enter search criteria"
 185             >Search</a> |
 186     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_rd_safe -  Process KRB-SAFE message.">feedback</a>
 187             </div>
 188         </div>
 189     </div>
 190
 191   </body>
 192 </html>