xref: /freebsd/crypto/krb5/doc/html/appdev/refs/api/krb5_auth_con_getflags.html (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1
2<!DOCTYPE html>
3
4<html>
5  <head>
6    <meta charset="utf-8" />
7    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
8
9    <title>krb5_auth_con_getflags - Retrieve flags from a krb5_auth_context structure. &#8212; MIT Kerberos Documentation</title>
10    <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
11    <link rel="stylesheet" type="text/css" href="../../../_static/agogo.css" />
12    <link rel="stylesheet" type="text/css" href="../../../_static/kerb.css" />
13    <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
14    <script src="../../../_static/jquery.js"></script>
15    <script src="../../../_static/underscore.js"></script>
16    <script src="../../../_static/doctools.js"></script>
17    <link rel="author" title="About these documents" href="../../../about.html" />
18    <link rel="index" title="Index" href="../../../genindex.html" />
19    <link rel="search" title="Search" href="../../../search.html" />
20    <link rel="copyright" title="Copyright" href="../../../copyright.html" />
21    <link rel="next" title="krb5_auth_con_getkey - Retrieve the session key from an auth context as a keyblock." href="krb5_auth_con_getkey.html" />
22    <link rel="prev" title="krb5_auth_con_getauthenticator - Retrieve the authenticator from an auth context." href="krb5_auth_con_getauthenticator.html" />
23  </head><body>
24    <div class="header-wrapper">
25        <div class="header">
26
27
28            <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
29
30            <div class="rel">
31
32        <a href="../../../index.html" title="Full Table of Contents"
33            accesskey="C">Contents</a> |
34        <a href="krb5_auth_con_getauthenticator.html" title="krb5_auth_con_getauthenticator - Retrieve the authenticator from an auth context."
35            accesskey="P">previous</a> |
36        <a href="krb5_auth_con_getkey.html" title="krb5_auth_con_getkey - Retrieve the session key from an auth context as a keyblock."
37            accesskey="N">next</a> |
38        <a href="../../../genindex.html" title="General Index"
39            accesskey="I">index</a> |
40        <a href="../../../search.html" title="Enter search criteria"
41            accesskey="S">Search</a> |
42    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_auth_con_getflags -  Retrieve flags from a krb5_auth_context structure.">feedback</a>
43            </div>
44        </div>
45    </div>
46
47    <div class="content-wrapper">
48      <div class="content">
49        <div class="document">
50
51      <div class="documentwrapper">
52        <div class="bodywrapper">
53          <div class="body" role="main">
54
55  <section id="krb5-auth-con-getflags-retrieve-flags-from-a-krb5-auth-context-structure">
56<h1>krb5_auth_con_getflags -  Retrieve flags from a krb5_auth_context structure.<a class="headerlink" href="#krb5-auth-con-getflags-retrieve-flags-from-a-krb5-auth-context-structure" title="Permalink to this headline">¶</a></h1>
57<dl class="c function">
58<dt class="sig sig-object c" id="c.krb5_auth_con_getflags">
59<a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code"><span class="n"><span class="pre">krb5_error_code</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_auth_con_getflags</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context"><span class="n"><span class="pre">krb5_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">context</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getflags" title="Permalink to this definition">¶</a><br /></dt>
60<dd></dd></dl>
61
62<dl class="field-list">
63<dt class="field-odd">param</dt>
64<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p>
65<p><strong>[in]</strong> <strong>auth_context</strong> - Authentication context</p>
66<p><strong>[out]</strong> <strong>flags</strong> - Flags bit mask</p>
67</dd>
68</dl>
69<dl class="field-list simple">
70<dt class="field-odd">retval</dt>
71<dd class="field-odd"><ul class="simple">
72<li><p>0   (always)</p></li>
73</ul>
74</dd>
75</dl>
76<p>Valid values for <em>flags</em> are:</p>
77<blockquote>
78<div><ul class="simple">
79<li><p>#KRB5_AUTH_CONTEXT_DO_TIME Use timestamps</p></li>
80<li><p>#KRB5_AUTH_CONTEXT_RET_TIME Save timestamps</p></li>
81<li><p>#KRB5_AUTH_CONTEXT_DO_SEQUENCE Use sequence numbers</p></li>
82<li><p>#KRB5_AUTH_CONTEXT_RET_SEQUENCE Save sequence numbers</p></li>
83</ul>
84</div></blockquote>
85</section>
86
87
88            <div class="clearer"></div>
89          </div>
90        </div>
91      </div>
92        </div>
93        <div class="sidebar">
94
95    <h2>On this page</h2>
96    <ul>
97<li><a class="reference internal" href="#">krb5_auth_con_getflags -  Retrieve flags from a krb5_auth_context structure.</a></li>
98</ul>
99
100    <br/>
101    <h2>Table of contents</h2>
102    <ul class="current">
103<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
104<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
105<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
106<li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
108<li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
109<li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
110<li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
111<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
112<li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
113<li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
114<li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
115</ul>
116</li>
117</ul>
118</li>
119<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
120<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
121<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
122<li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
123<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
124<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
125<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
126<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
127</ul>
128
129    <br/>
130    <h4><a href="../../../index.html">Full Table of Contents</a></h4>
131    <h4>Search</h4>
132    <form class="search" action="../../../search.html" method="get">
133      <input type="text" name="q" size="18" />
134      <input type="submit" value="Go" />
135      <input type="hidden" name="check_keywords" value="yes" />
136      <input type="hidden" name="area" value="default" />
137    </form>
138
139        </div>
140        <div class="clearer"></div>
141      </div>
142    </div>
143
144    <div class="footer-wrapper">
145        <div class="footer" >
146            <div class="right" ><i>Release: 1.21.3</i><br />
147                &copy; <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT.
148            </div>
149            <div class="left">
150
151        <a href="../../../index.html" title="Full Table of Contents"
152            >Contents</a> |
153        <a href="krb5_auth_con_getauthenticator.html" title="krb5_auth_con_getauthenticator - Retrieve the authenticator from an auth context."
154            >previous</a> |
155        <a href="krb5_auth_con_getkey.html" title="krb5_auth_con_getkey - Retrieve the session key from an auth context as a keyblock."
156            >next</a> |
157        <a href="../../../genindex.html" title="General Index"
158            >index</a> |
159        <a href="../../../search.html" title="Enter search criteria"
160            >Search</a> |
161    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_auth_con_getflags -  Retrieve flags from a krb5_auth_context structure.">feedback</a>
162            </div>
163        </div>
164    </div>
165
166  </body>
167</html>