Imported Upstream version 1.15.1
[platform/upstream/krb5.git] / doc / html / appdev / refs / api / krb5_auth_con_genaddrs.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_auth_con_genaddrs - Generate auth context addresses from a connected socket. &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_auth_con_get_checksum_func - Get the checksum callback from an auth context." href="krb5_auth_con_get_checksum_func.html" />
32     <link rel="prev" title="krb5_auth_con_free - Free a krb5_auth_context structure." href="krb5_auth_con_free.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_auth_con_free.html" title="krb5_auth_con_free - Free a krb5_auth_context structure."
46             accesskey="P">previous</a> |
47         <a href="krb5_auth_con_get_checksum_func.html" title="krb5_auth_con_get_checksum_func - Get the checksum callback from an auth context."
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_auth_con_genaddrs -  Generate auth context addresses from a connected socket.">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-auth-con-genaddrs-generate-auth-context-addresses-from-a-connected-socket">
67 <h1>krb5_auth_con_genaddrs -  Generate auth context addresses from a connected socket.<a class="headerlink" href="#krb5-auth-con-genaddrs-generate-auth-context-addresses-from-a-connected-socket" title="Permalink to this headline">¶</a></h1>
68 <dl class="function">
69 <dt id="c.krb5_auth_con_genaddrs">
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_auth_con_genaddrs</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>, int<em>&nbsp;infd</em>, int<em>&nbsp;flags</em><big>)</big><a class="headerlink" href="#c.krb5_auth_con_genaddrs" 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>infd</strong> - Connected socket descriptor</p>
80 <p class="last"><strong>[in]</strong> <strong>flags</strong> - Flags</p>
81 </td>
82 </tr>
83 </tbody>
84 </table>
85 <table class="docutils field-list" frame="void" rules="none">
86 <col class="field-name" />
87 <col class="field-body" />
88 <tbody valign="top">
89 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first last simple">
90 <li>0   Success; otherwise - Kerberos error codes</li>
91 </ul>
92 </td>
93 </tr>
94 </tbody>
95 </table>
96 <p>This function sets the local and/or remote addresses in <em>auth_context</em> based on the local and remote endpoints of the socket <em>infd</em> . The following flags determine the operations performed:</p>
97 <blockquote>
98 <div><ul class="simple">
99 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR</span></tt></a> Generate local address.</li>
100 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR</span></tt></a> Generate remote address.</li>
101 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR</span></tt></a> Generate local address and port.</li>
102 <li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR</span></tt></a> Generate remote address and port.</li>
103 </ul>
104 </div></blockquote>
105 </div>
106
107
108           </div>
109         </div>
110       </div>
111         </div>
112         <div class="sidebar">
113     <h2>On this page</h2>
114     <ul>
115 <li><a class="reference internal" href="#">krb5_auth_con_genaddrs -  Generate auth context addresses from a connected socket.</a></li>
116 </ul>
117
118     <br/>
119     <h2>Table of contents</h2>
120     <ul class="current">
121 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
122 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
123 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
124 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
125 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
126 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
127 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
128 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
129 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
130 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
131 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
132 </ul>
133 </li>
134 </ul>
135 </li>
136 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
137 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
138 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
139 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
140 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
141 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
142 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
143 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
144 </ul>
145
146     <br/>
147     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
148     <h4>Search</h4>
149     <form class="search" action="../../../search.html" method="get">
150       <input type="text" name="q" size="18" />
151       <input type="submit" value="Go" />
152       <input type="hidden" name="check_keywords" value="yes" />
153       <input type="hidden" name="area" value="default" />
154     </form>
155         </div>
156         <div class="clearer"></div>
157       </div>
158     </div>
159
160     <div class="footer-wrapper">
161         <div class="footer" >
162             <div class="right" ><i>Release: 1.15.1</i><br />
163                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
164             </div>
165             <div class="left">
166                 
167         <a href="../../../index.html" title="Full Table of Contents"
168             >Contents</a> |
169         <a href="krb5_auth_con_free.html" title="krb5_auth_con_free - Free a krb5_auth_context structure."
170             >previous</a> |
171         <a href="krb5_auth_con_get_checksum_func.html" title="krb5_auth_con_get_checksum_func - Get the checksum callback from an auth context."
172             >next</a> |
173         <a href="../../../genindex.html" title="General Index"
174             >index</a> |
175         <a href="../../../search.html" title="Enter search criteria"
176             >Search</a> |
177     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_auth_con_genaddrs -  Generate auth context addresses from a connected socket.">feedback</a>
178             </div>
179         </div>
180     </div>
181
182   </body>
183 </html>