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