doc/html/appdev/refs/api/krb5_sname_match.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_sname_match - Test whether a principal matches a matching principal. &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_sname_to_principal - Generate a full principal name from a service name." href="krb5_sname_to_principal.html" />
  32     <link rel="prev" title="krb5_set_trace_filename - Specify a file name for directing trace events." href="krb5_set_trace_filename.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_set_trace_filename.html" title="krb5_set_trace_filename - Specify a file name for directing trace events."
  46             accesskey="P">previous</a> |
  47         <a href="krb5_sname_to_principal.html" title="krb5_sname_to_principal - Generate a full principal name from a service name."
  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_sname_match -  Test whether a principal matches a matching principal.">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-sname-match-test-whether-a-principal-matches-a-matching-principal">
  67 <h1>krb5_sname_match -  Test whether a principal matches a matching principal.<a class="headerlink" href="#krb5-sname-match-test-whether-a-principal-matches-a-matching-principal" title="Permalink to this headline">¶</a></h1>
  68 <dl class="function">
  69 <dt id="c.krb5_sname_match">
  70 <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <tt class="descname">krb5_sname_match</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_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em>&nbsp;matching</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em>&nbsp;princ</em><big>)</big><a class="headerlink" href="#c.krb5_sname_match" 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>matching</strong> - Matching principal</p>
  79 <p class="last"><strong>[in]</strong> <strong>princ</strong> - Principal to test</p>
  80 </td>
  81 </tr>
  82 </tbody>
  83 </table>
  84 <table class="docutils field-list" frame="void" rules="none">
  85 <col class="field-name" />
  86 <col class="field-body" />
  87 <tbody valign="top">
  88 <tr class="field-odd field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
  89 <li>TRUE if princ matches matching , FALSE otherwise.</li>
  90 </ul>
  91 </td>
  92 </tr>
  93 </tbody>
  94 </table>
  95 <p>If <em>matching</em> is NULL, return TRUE. If <em>matching</em> is not a matching principal, return the value of krb5_principal_compare(context, matching, princ).</p>
  96 <div class="admonition note">
  97 <p class="first admonition-title">Note</p>
  98 <p class="last">A matching principal is a host-based principal with an empty realm and/or second data component (hostname). Profile configuration may cause the hostname to be ignored even if it is present. A principal matches a matching principal if the former has the same non-empty (and non-ignored) components of the latter.</p>
  99 </div>
 100 </div>
 101
 102
 103           </div>
 104         </div>
 105       </div>
 106         </div>
 107         <div class="sidebar">
 108     <h2>On this page</h2>
 109     <ul>
 110 <li><a class="reference internal" href="#">krb5_sname_match -  Test whether a principal matches a matching principal.</a></li>
 111 </ul>
 112
 113     <br/>
 114     <h2>Table of contents</h2>
 115     <ul class="current">
 116 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 117 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 118 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 119 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 120 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 121 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 123 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 124 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 125 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 126 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 127 </ul>
 128 </li>
 129 </ul>
 130 </li>
 131 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 132 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 133 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 134 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 135 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 136 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 137 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 138 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 139 </ul>
 140
 141     <br/>
 142     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 143     <h4>Search</h4>
 144     <form class="search" action="../../../search.html" method="get">
 145       <input type="text" name="q" size="18" />
 146       <input type="submit" value="Go" />
 147       <input type="hidden" name="check_keywords" value="yes" />
 148       <input type="hidden" name="area" value="default" />
 149     </form>
 150         </div>
 151         <div class="clearer"></div>
 152       </div>
 153     </div>
 154
 155     <div class="footer-wrapper">
 156         <div class="footer" >
 157             <div class="right" ><i>Release: 1.15.1</i><br />
 158                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2017, MIT.
 159             </div>
 160             <div class="left">
 161
 162         <a href="../../../index.html" title="Full Table of Contents"
 163             >Contents</a> |
 164         <a href="krb5_set_trace_filename.html" title="krb5_set_trace_filename - Specify a file name for directing trace events."
 165             >previous</a> |
 166         <a href="krb5_sname_to_principal.html" title="krb5_sname_to_principal - Generate a full principal name from a service name."
 167             >next</a> |
 168         <a href="../../../genindex.html" title="General Index"
 169             >index</a> |
 170         <a href="../../../search.html" title="Enter search criteria"
 171             >Search</a> |
 172     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_sname_match -  Test whether a principal matches a matching principal.">feedback</a>
 173             </div>
 174         </div>
 175     </div>
 176
 177   </body>
 178 </html>