diff options
Diffstat (limited to 'doc/doxyout/krb5/html/group__krb5__support.html')
| -rw-r--r-- | doc/doxyout/krb5/html/group__krb5__support.html | 1370 |
1 files changed, 0 insertions, 1370 deletions
diff --git a/doc/doxyout/krb5/html/group__krb5__support.html b/doc/doxyout/krb5/html/group__krb5__support.html deleted file mode 100644 index 92be508e89ee..000000000000 --- a/doc/doxyout/krb5/html/group__krb5__support.html +++ /dev/null @@ -1,1370 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>Heimdal Kerberos 5 support functions</title> -<link href="doxygen.css" rel="stylesheet" type="text/css"> -<link href="tabs.css" rel="stylesheet" type="text/css"> -</head><body> -<p> -<a href="http://www.h5l.org/"><img src="http://www.h5l.org/keyhole-heimdal.png" alt="keyhole logo"/></a> -</p> -<!-- end of header marker --> -<!-- Generated by Doxygen 1.9.1 --> -<script type="text/javascript" src="menudata.js"></script> -<script type="text/javascript" src="menu.js"></script> -<script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -$(function() { - initMenu('',false,false,'search.php','Search'); -}); -/* @license-end */</script> -<div id="main-nav"></div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#nested-classes">Data Structures</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">Heimdal Kerberos 5 support functions</div> </div> -</div><!--header--> -<div class="contents"> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> -Data Structures</h2></td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkrb5plugin__an2ln__ftable__desc.html">krb5plugin_an2ln_ftable_desc</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Description of the krb5_aname_to_lname(3) plugin facility. <a href="structkrb5plugin__an2ln__ftable__desc.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkrb5plugin__db__ftable__desc.html">krb5plugin_db_ftable_desc</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Description of the krb5 DB plugin facility. <a href="structkrb5plugin__db__ftable__desc.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkrb5plugin__kuserok__ftable__desc.html">krb5plugin_kuserok_ftable_desc</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Description of the krb5_kuserok(3) plugin facility. <a href="structkrb5plugin__kuserok__ftable__desc.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:ga245208f2d59a8fd7187089ad445e51d0"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string</a> (krb5_context context, const char *string, const char *format,...)</td></tr> -<tr class="separator:ga245208f2d59a8fd7187089ad445e51d0"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga7c5dbc1743dc0bc63765edf82d10eb9e"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga7c5dbc1743dc0bc63765edf82d10eb9e">krb5_acl_match_file</a> (krb5_context context, const char *file, const char *format,...)</td></tr> -<tr class="separator:ga7c5dbc1743dc0bc63765edf82d10eb9e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga3da1c15fbc425a71da10784139140644"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga3da1c15fbc425a71da10784139140644">krb5_aname_to_localname</a> (krb5_context context, krb5_const_principal aname, size_t lnsize, char *lname)</td></tr> -<tr class="separator:ga3da1c15fbc425a71da10784139140644"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga59892cdf61d0a6a59b3dd2e9998b541a"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga59892cdf61d0a6a59b3dd2e9998b541a">krb5_config_parse_file_multi</a> (krb5_context context, const char *fname, krb5_config_section **res)</td></tr> -<tr class="separator:ga59892cdf61d0a6a59b3dd2e9998b541a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga84277205c4b221cc28f1fd36be19dba8"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga84277205c4b221cc28f1fd36be19dba8">krb5_config_file_free</a> (krb5_context context, krb5_config_section *s)</td></tr> -<tr class="separator:ga84277205c4b221cc28f1fd36be19dba8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaee87399e25e34ac1e0e4a1841951e2fa"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const krb5_config_binding *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaee87399e25e34ac1e0e4a1841951e2fa">krb5_config_get_list</a> (krb5_context context, const krb5_config_section *c,...)</td></tr> -<tr class="separator:gaee87399e25e34ac1e0e4a1841951e2fa"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gafbc6548d480aaf5118025b742f4f468d"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const krb5_config_binding *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gafbc6548d480aaf5118025b742f4f468d">krb5_config_vget_list</a> (krb5_context context, const krb5_config_section *c, va_list args)</td></tr> -<tr class="separator:gafbc6548d480aaf5118025b742f4f468d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gac0845cba8c8f7fd2e447de60d81556ac"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gac0845cba8c8f7fd2e447de60d81556ac">krb5_config_get_string</a> (krb5_context context, const krb5_config_section *c,...)</td></tr> -<tr class="separator:gac0845cba8c8f7fd2e447de60d81556ac"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaec7eaee2b6f04f1ed4a64b37efa767e4"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaec7eaee2b6f04f1ed4a64b37efa767e4">krb5_config_vget_string</a> (krb5_context context, const krb5_config_section *c, va_list args)</td></tr> -<tr class="separator:gaec7eaee2b6f04f1ed4a64b37efa767e4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga124f18195eb05c3662ce2bcf06c7451b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga124f18195eb05c3662ce2bcf06c7451b">krb5_config_vget_string_default</a> (krb5_context context, const krb5_config_section *c, const char *def_value, va_list args)</td></tr> -<tr class="separator:ga124f18195eb05c3662ce2bcf06c7451b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaaef298c290e0c315d7f4bf07ba272b60"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION const char *KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaaef298c290e0c315d7f4bf07ba272b60">krb5_config_get_string_default</a> (krb5_context context, const krb5_config_section *c, const char *def_value,...)</td></tr> -<tr class="separator:gaaef298c290e0c315d7f4bf07ba272b60"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga614850564b4d21b92e113fde9420bf3c"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION char **KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga614850564b4d21b92e113fde9420bf3c">krb5_config_vget_strings</a> (krb5_context context, const krb5_config_section *c, va_list args)</td></tr> -<tr class="separator:ga614850564b4d21b92e113fde9420bf3c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8f43dbe4a34a820a70d081e5d3190e01"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION char **KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga8f43dbe4a34a820a70d081e5d3190e01">krb5_config_get_strings</a> (krb5_context context, const krb5_config_section *c,...)</td></tr> -<tr class="separator:ga8f43dbe4a34a820a70d081e5d3190e01"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga3440f86b07fa86aae0f0889445a0def2"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION void KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga3440f86b07fa86aae0f0889445a0def2">krb5_config_free_strings</a> (char **strings)</td></tr> -<tr class="separator:ga3440f86b07fa86aae0f0889445a0def2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga8a29a130369232a638629cb37bfbeb66"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga8a29a130369232a638629cb37bfbeb66">krb5_config_vget_bool_default</a> (krb5_context context, const krb5_config_section *c, krb5_boolean def_value, va_list args)</td></tr> -<tr class="separator:ga8a29a130369232a638629cb37bfbeb66"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga16e5b2da5e3751d7b3d4fe8d43f0a677"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga16e5b2da5e3751d7b3d4fe8d43f0a677">krb5_config_vget_bool</a> (krb5_context context, const krb5_config_section *c, va_list args)</td></tr> -<tr class="separator:ga16e5b2da5e3751d7b3d4fe8d43f0a677"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaca6abdb90a74af3747f87bfb5e9c85ab"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaca6abdb90a74af3747f87bfb5e9c85ab">krb5_config_get_bool_default</a> (krb5_context context, const krb5_config_section *c, krb5_boolean def_value,...)</td></tr> -<tr class="separator:gaca6abdb90a74af3747f87bfb5e9c85ab"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga39402ca8c1b1eb2af4b514eed826f971"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga39402ca8c1b1eb2af4b514eed826f971">krb5_config_get_bool</a> (krb5_context context, const krb5_config_section *c,...)</td></tr> -<tr class="separator:ga39402ca8c1b1eb2af4b514eed826f971"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga11d7ea1fa9a910acb568c42d8dd28350"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION int KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga11d7ea1fa9a910acb568c42d8dd28350">krb5_config_vget_time_default</a> (krb5_context context, const krb5_config_section *c, int def_value, va_list args)</td></tr> -<tr class="separator:ga11d7ea1fa9a910acb568c42d8dd28350"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga88331c69f41e1e65abc49a9b66efc7d5"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION int KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga88331c69f41e1e65abc49a9b66efc7d5">krb5_config_vget_time</a> (krb5_context context, const krb5_config_section *c, va_list args)</td></tr> -<tr class="separator:ga88331c69f41e1e65abc49a9b66efc7d5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga019554d71140a32f64b6e4a2244d1168"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION int KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga019554d71140a32f64b6e4a2244d1168">krb5_config_get_time_default</a> (krb5_context context, const krb5_config_section *c, int def_value,...)</td></tr> -<tr class="separator:ga019554d71140a32f64b6e4a2244d1168"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaf797bad7e8499b7be6099ccff7f56226"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION int KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaf797bad7e8499b7be6099ccff7f56226">krb5_config_get_time</a> (krb5_context context, const krb5_config_section *c,...)</td></tr> -<tr class="separator:gaf797bad7e8499b7be6099ccff7f56226"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga947f1780e8b73fe0edb4f64da2f0b2f3"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga947f1780e8b73fe0edb4f64da2f0b2f3">krb5_expand_hostname</a> (krb5_context context, const char *orig_hostname, char **new_hostname)</td></tr> -<tr class="separator:ga947f1780e8b73fe0edb4f64da2f0b2f3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga933f524c34ae6a80ba8aa6c0700992ef"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga933f524c34ae6a80ba8aa6c0700992ef">krb5_expand_hostname_realms</a> (krb5_context context, const char *orig_hostname, char **new_hostname, char ***realms)</td></tr> -<tr class="separator:ga933f524c34ae6a80ba8aa6c0700992ef"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gaca0ab80d3affb5986aa5061f3782401b"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gaca0ab80d3affb5986aa5061f3782401b">krb5_free_host_realm</a> (krb5_context context, krb5_realm *realmlist)</td></tr> -<tr class="separator:gaca0ab80d3affb5986aa5061f3782401b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga6368eceea4261ef2ccb8dc39ecc87772"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#ga6368eceea4261ef2ccb8dc39ecc87772">krb5_kuserok</a> (krb5_context context, krb5_principal principal, const char *luser)</td></tr> -<tr class="separator:ga6368eceea4261ef2ccb8dc39ecc87772"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:gab6e4d59cca3b2e65abbd83204ad0e789"><td class="memItemLeft" align="right" valign="top">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL </td><td class="memItemRight" valign="bottom"><a class="el" href="group__krb5__support.html#gab6e4d59cca3b2e65abbd83204ad0e789">krb5_plugin_register</a> (krb5_context context, enum krb5_plugin_type type, const char *name, void *symbol)</td></tr> -<tr class="separator:gab6e4d59cca3b2e65abbd83204ad0e789"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<h2 class="groupheader">Function Documentation</h2> -<a id="ga7c5dbc1743dc0bc63765edf82d10eb9e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga7c5dbc1743dc0bc63765edf82d10eb9e">◆ </a></span>krb5_acl_match_file()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_acl_match_file </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>file</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>format</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>krb5_acl_match_file matches ACL format against each line in a file using <a class="el" href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string()</a>. Lines starting with # are treated like comments and ignored.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr> - <tr><td class="paramname">file</td><td>file with acl listed in the file. </td></tr> - <tr><td class="paramname">format</td><td>format to match. </td></tr> - <tr><td class="paramname">...</td><td>parameter to format string.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0.</dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string</a> </dd></dl> - -</div> -</div> -<a id="ga245208f2d59a8fd7187089ad445e51d0"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga245208f2d59a8fd7187089ad445e51d0">◆ </a></span>krb5_acl_match_string()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_acl_match_string </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>string</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>format</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>krb5_acl_match_string matches ACL format against a string.</p> -<p>The ACL format has three format specifiers: s, f, and r. Each specifier will retrieve one argument from the variable arguments for either matching or storing data. The input string is split up using " " (space) and "\t" (tab) as a delimiter; multiple and "\t" in a row are considered to be the same.</p> -<p>List of format specifiers:</p><ul> -<li>s Matches a string using strcmp(3) (case sensitive).</li> -<li>f Matches the string with fnmatch(3). Theflags argument (the last argument) passed to the fnmatch function is 0.</li> -<li>r Returns a copy of the string in the char ** passed in; the copy must be freed with free(3). There is no need to free(3) the string on error: the function will clean up and set the pointer to NULL.</li> -</ul> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>Kerberos 5 context </td></tr> - <tr><td class="paramname">string</td><td>string to match with </td></tr> - <tr><td class="paramname">format</td><td>format to match </td></tr> - <tr><td class="paramname">...</td><td>parameter to format string</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0.</dd></dl> -<div class="fragment"><div class="line"><span class="keywordtype">char</span> *s;</div> -<div class="line"> </div> -<div class="line">ret = <a class="code" href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string</a>(context, <span class="stringliteral">"foo"</span>, <span class="stringliteral">"s"</span>, <span class="stringliteral">"foo"</span>);</div> -<div class="line"><span class="keywordflow">if</span> (ret)</div> -<div class="line"> <a class="code" href="group__krb5__error.html#ga1b898cb64c7e0e9a61d52440e1ada17e">krb5_errx</a>(context, 1, <span class="stringliteral">"acl didn't match"</span>);</div> -<div class="line">ret = <a class="code" href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string</a>(context, <span class="stringliteral">"foo foo baz/kaka"</span>,</div> -<div class="line"> <span class="stringliteral">"ss"</span>, <span class="stringliteral">"foo"</span>, &s, <span class="stringliteral">"foo/\\*"</span>);</div> -<div class="line"><span class="keywordflow">if</span> (ret) {</div> -<div class="line"> <span class="comment">// no need to free(s) on error</span></div> -<div class="line"> assert(s == NULL);</div> -<div class="line"> <a class="code" href="group__krb5__error.html#ga1b898cb64c7e0e9a61d52440e1ada17e">krb5_errx</a>(context, 1, <span class="stringliteral">"acl didn't match"</span>);</div> -<div class="line">}</div> -<div class="line">free(s);</div> -<div class="ttc" id="agroup__krb5__error_html_ga1b898cb64c7e0e9a61d52440e1ada17e"><div class="ttname"><a href="group__krb5__error.html#ga1b898cb64c7e0e9a61d52440e1ada17e">krb5_errx</a></div><div class="ttdeci">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_errx(krb5_context context, int eval, const char *fmt,...) __attribute__((__noreturn__</div></div> -<div class="ttc" id="agroup__krb5__support_html_ga245208f2d59a8fd7187089ad445e51d0"><div class="ttname"><a href="group__krb5__support.html#ga245208f2d59a8fd7187089ad445e51d0">krb5_acl_match_string</a></div><div class="ttdeci">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_acl_match_string(krb5_context context, const char *string, const char *format,...)</div><div class="ttdef"><b>Definition:</b> acl.c:200</div></div> -</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__krb5__support.html#ga7c5dbc1743dc0bc63765edf82d10eb9e">krb5_acl_match_file</a> </dd></dl> - -</div> -</div> -<a id="ga3da1c15fbc425a71da10784139140644"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga3da1c15fbc425a71da10784139140644">◆ </a></span>krb5_aname_to_localname()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_aname_to_localname </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_const_principal </td> - <td class="paramname"><em>aname</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">size_t </td> - <td class="paramname"><em>lnsize</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">char * </td> - <td class="paramname"><em>lname</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Map a principal name to a local username.</p> -<p>Returns 0 on success, KRB5_NO_LOCALNAME if no mapping was found, or some Kerberos or system error.</p> -<p>Inputs:</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A krb5_context </td></tr> - <tr><td class="paramname">aname</td><td>A principal name </td></tr> - <tr><td class="paramname">lnsize</td><td>The size of the buffer into which the username will be written </td></tr> - <tr><td class="paramname">lname</td><td>The buffer into which the username will be written </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a id="ga84277205c4b221cc28f1fd36be19dba8"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga84277205c4b221cc28f1fd36be19dba8">◆ </a></span>krb5_config_file_free()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_config_file_free </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_config_section * </td> - <td class="paramname"><em>s</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free configuration file section, the result of krb5_config_parse_file() and <a class="el" href="group__krb5__support.html#ga59892cdf61d0a6a59b3dd2e9998b541a">krb5_config_parse_file_multi()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context </td></tr> - <tr><td class="paramname">s</td><td>the configuration section to free</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>returns 0 on successes, otherwise an error code, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a> </dd></dl> - -</div> -</div> -<a id="ga3440f86b07fa86aae0f0889445a0def2"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga3440f86b07fa86aae0f0889445a0def2">◆ </a></span>krb5_config_free_strings()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_config_free_strings </td> - <td>(</td> - <td class="paramtype">char ** </td> - <td class="paramname"><em>strings</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free the resulting strings from krb5_config-get_strings() and <a class="el" href="group__krb5__support.html#ga614850564b4d21b92e113fde9420bf3c">krb5_config_vget_strings()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">strings</td><td>strings to free </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<a id="ga39402ca8c1b1eb2af4b514eed826f971"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga39402ca8c1b1eb2af4b514eed826f971">◆ </a></span>krb5_config_get_bool()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_get_bool </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Like <a class="el" href="group__krb5__support.html#ga39402ca8c1b1eb2af4b514eed826f971">krb5_config_get_bool()</a> but with a va_list list of configuration selection.</p> -<p>Configuration value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="gaca6abdb90a74af3747f87bfb5e9c85ab"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaca6abdb90a74af3747f87bfb5e9c85ab">◆ </a></span>krb5_config_get_bool_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_get_bool_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_boolean </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group__krb5__support.html#gaca6abdb90a74af3747f87bfb5e9c85ab">krb5_config_get_bool_default()</a> will convert the configuration option value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="gaee87399e25e34ac1e0e4a1841951e2fa"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaee87399e25e34ac1e0e4a1841951e2fa">◆ </a></span>krb5_config_get_list()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const krb5_config_binding* KRB5_LIB_CALL krb5_config_get_list </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get a list of configuration binding list for more processing</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>NULL if configuration list is not found, a list otherwise </dd></dl> - -</div> -</div> -<a id="gac0845cba8c8f7fd2e447de60d81556ac"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gac0845cba8c8f7fd2e447de60d81556ac">◆ </a></span>krb5_config_get_string()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_get_string </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns a "const char *" to a string in the configuration database. The string may not be valid after a reload of the configuration database so a caller should make a local copy if it needs to keep the string.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>NULL if configuration string not found, a string otherwise </dd></dl> - -</div> -</div> -<a id="gaaef298c290e0c315d7f4bf07ba272b60"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaaef298c290e0c315d7f4bf07ba272b60">◆ </a></span>krb5_config_get_string_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_get_string_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Like <a class="el" href="group__krb5__support.html#gac0845cba8c8f7fd2e447de60d81556ac">krb5_config_get_string()</a>, but instead of returning NULL, instead return a default value.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>a configuration string </dd></dl> - -</div> -</div> -<a id="ga8f43dbe4a34a820a70d081e5d3190e01"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga8f43dbe4a34a820a70d081e5d3190e01">◆ </a></span>krb5_config_get_strings()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION char** KRB5_LIB_CALL krb5_config_get_strings </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get a list of configuration strings, free the result with <a class="el" href="group__krb5__support.html#ga3440f86b07fa86aae0f0889445a0def2">krb5_config_free_strings()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="gaf797bad7e8499b7be6099ccff7f56226"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaf797bad7e8499b7be6099ccff7f56226">◆ </a></span>krb5_config_get_time()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_get_time </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the time from the configuration file using a relative time, for example: 1h30s</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>parsed the time or -1 on error </dd></dl> - -</div> -</div> -<a id="ga019554d71140a32f64b6e4a2244d1168"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga019554d71140a32f64b6e4a2244d1168">◆ </a></span>krb5_config_get_time_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_get_time_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"> </td> - <td class="paramname"><em>...</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the time from the configuration file using a relative time, for example: 1h30s</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">...</td><td>a list of names, terminated with NULL.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>parsed the time (or def_value on parse error) </dd></dl> - -</div> -</div> -<a id="ga59892cdf61d0a6a59b3dd2e9998b541a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga59892cdf61d0a6a59b3dd2e9998b541a">◆ </a></span>krb5_config_parse_file_multi()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_config_parse_file_multi </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>fname</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_config_section ** </td> - <td class="paramname"><em>res</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Parse a configuration file and add the result into res. This interface can be used to parse several configuration files into one resulting krb5_config_section by calling it repeatably.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a Kerberos 5 context. </td></tr> - <tr><td class="paramname">fname</td><td>a file name to a Kerberos configuration file </td></tr> - <tr><td class="paramname">res</td><td>the returned result, must be free with <a class="el" href="group__krb5.html#gace1b568d05875e7c4fbc6e5af5a8bdbf">krb5_free_config_files()</a>. </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> -<p>If the fname starts with "~/" parse configuration file in the current users home directory. The behavior can be disabled and enabled by calling <a class="el" href="group__krb5.html#ga3a8e40d622ff1460b2f554d83a9059ea">krb5_set_home_dir_access()</a>.</p> - -</div> -</div> -<a id="ga16e5b2da5e3751d7b3d4fe8d43f0a677"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga16e5b2da5e3751d7b3d4fe8d43f0a677">◆ </a></span>krb5_config_vget_bool()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_vget_bool </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group__krb5__support.html#ga39402ca8c1b1eb2af4b514eed826f971">krb5_config_get_bool()</a> will convert the configuration option value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="ga8a29a130369232a638629cb37bfbeb66"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga8a29a130369232a638629cb37bfbeb66">◆ </a></span>krb5_config_vget_bool_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_config_vget_bool_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_boolean </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Like <a class="el" href="group__krb5__support.html#gaca6abdb90a74af3747f87bfb5e9c85ab">krb5_config_get_bool_default()</a> but with a va_list list of configuration selection.</p> -<p>Configuration value to a boolean value, where yes/true and any non-zero number means TRUE and other value is FALSE.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="gafbc6548d480aaf5118025b742f4f468d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gafbc6548d480aaf5118025b742f4f468d">◆ </a></span>krb5_config_vget_list()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const krb5_config_binding* KRB5_LIB_CALL krb5_config_vget_list </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get a list of configuration binding list for more processing</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>NULL if configuration list is not found, a list otherwise </dd></dl> - -</div> -</div> -<a id="gaec7eaee2b6f04f1ed4a64b37efa767e4"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaec7eaee2b6f04f1ed4a64b37efa767e4">◆ </a></span>krb5_config_vget_string()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_vget_string </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Like <a class="el" href="group__krb5__support.html#gac0845cba8c8f7fd2e447de60d81556ac">krb5_config_get_string()</a>, but uses a va_list instead of ...</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>NULL if configuration string not found, a string otherwise </dd></dl> - -</div> -</div> -<a id="ga124f18195eb05c3662ce2bcf06c7451b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga124f18195eb05c3662ce2bcf06c7451b">◆ </a></span>krb5_config_vget_string_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION const char* KRB5_LIB_CALL krb5_config_vget_string_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Like <a class="el" href="group__krb5__support.html#gaec7eaee2b6f04f1ed4a64b37efa767e4">krb5_config_vget_string()</a>, but instead of returning NULL, instead return a default value.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>a configuration string </dd></dl> - -</div> -</div> -<a id="ga614850564b4d21b92e113fde9420bf3c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga614850564b4d21b92e113fde9420bf3c">◆ </a></span>krb5_config_vget_strings()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION char** KRB5_LIB_CALL krb5_config_vget_strings </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get a list of configuration strings, free the result with <a class="el" href="group__krb5__support.html#ga3440f86b07fa86aae0f0889445a0def2">krb5_config_free_strings()</a>.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>TRUE or FALSE </dd></dl> - -</div> -</div> -<a id="ga88331c69f41e1e65abc49a9b66efc7d5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga88331c69f41e1e65abc49a9b66efc7d5">◆ </a></span>krb5_config_vget_time()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_vget_time </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the time from the configuration file using a relative time, for example: 1h30s</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>parsed the time or -1 on error </dd></dl> - -</div> -</div> -<a id="ga11d7ea1fa9a910acb568c42d8dd28350"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga11d7ea1fa9a910acb568c42d8dd28350">◆ </a></span>krb5_config_vget_time_default()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_config_vget_time_default </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const krb5_config_section * </td> - <td class="paramname"><em>c</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">int </td> - <td class="paramname"><em>def_value</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">va_list </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Get the time from the configuration file using a relative time.</p> -<p>Like <a class="el" href="group__krb5__support.html#ga019554d71140a32f64b6e4a2244d1168">krb5_config_get_time_default()</a> but with a va_list list of configuration selection.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">c</td><td>a configuration section, or NULL to use the section from context </td></tr> - <tr><td class="paramname">def_value</td><td>the default value to return if no configuration found in the database. </td></tr> - <tr><td class="paramname">args</td><td>a va_list of arguments</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>parsed the time (or def_value on parse error) </dd></dl> - -</div> -</div> -<a id="ga947f1780e8b73fe0edb4f64da2f0b2f3"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga947f1780e8b73fe0edb4f64da2f0b2f3">◆ </a></span>krb5_expand_hostname()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_expand_hostname </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>orig_hostname</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">char ** </td> - <td class="paramname"><em>new_hostname</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group__krb5__support.html#ga947f1780e8b73fe0edb4f64da2f0b2f3">krb5_expand_hostname()</a> tries to make orig_hostname into a more canonical one in the newly allocated space returned in new_hostname.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a Keberos context </td></tr> - <tr><td class="paramname">orig_hostname</td><td>hostname to canonicalise. </td></tr> - <tr><td class="paramname">new_hostname</td><td>output hostname, caller must free hostname with krb5_xfree().</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> - -</div> -</div> -<a id="ga933f524c34ae6a80ba8aa6c0700992ef"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga933f524c34ae6a80ba8aa6c0700992ef">◆ </a></span>krb5_expand_hostname_realms()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_expand_hostname_realms </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>orig_hostname</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">char ** </td> - <td class="paramname"><em>new_hostname</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">char *** </td> - <td class="paramname"><em>realms</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p><a class="el" href="group__krb5__support.html#ga933f524c34ae6a80ba8aa6c0700992ef">krb5_expand_hostname_realms()</a> expands orig_hostname to a name we believe to be a hostname in newly allocated space in new_hostname and return the realms new_hostname is believed to belong to in realms.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a Keberos context </td></tr> - <tr><td class="paramname">orig_hostname</td><td>hostname to canonicalise. </td></tr> - <tr><td class="paramname">new_hostname</td><td>output hostname, caller must free hostname with krb5_xfree(). </td></tr> - <tr><td class="paramname">realms</td><td>output possible realms, is an array that is terminated with NULL. Caller must free with <a class="el" href="group__krb5__support.html#gaca0ab80d3affb5986aa5061f3782401b">krb5_free_host_realm()</a>.</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Return an error code or 0, see <a class="el" href="group__krb5__error.html#ga35cbf80e68f43a6d9503952886b85ed2">krb5_get_error_message()</a>. </dd></dl> - -</div> -</div> -<a id="gaca0ab80d3affb5986aa5061f3782401b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gaca0ab80d3affb5986aa5061f3782401b">◆ </a></span>krb5_free_host_realm()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_free_host_realm </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_realm * </td> - <td class="paramname"><em>realmlist</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Free all memory allocated by ‘realmlist’</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>A Kerberos 5 context. </td></tr> - <tr><td class="paramname">realmlist</td><td>realmlist to free, NULL is ok</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>a Kerberos error code, always 0. </dd></dl> - -</div> -</div> -<a id="ga6368eceea4261ef2ccb8dc39ecc87772"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ga6368eceea4261ef2ccb8dc39ecc87772">◆ </a></span>krb5_kuserok()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_kuserok </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">krb5_principal </td> - <td class="paramname"><em>principal</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>luser</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>This function takes the name of a local user and checks if principal is allowed to log in as that user.</p> -<p>The user may have a ~/.k5login file listing principals that are allowed to login as that user. If that file does not exist, all principals with a only one component that is identical to the username, and a realm considered local, are allowed access.</p> -<p>The .k5login file must contain one principal per line, be owned by user and not be writable by group or other (but must be readable by anyone).</p> -<p>Note that if the file exists, no implicit access rights are given to user@LOCALREALM.</p> -<p>Optionally, a set of files may be put in ~/.k5login.d (a directory), in which case they will all be checked in the same manner as .k5login. The files may be called anything, but files starting with a hash (#) , or ending with a tilde (~) are ignored. Subdirectories are not traversed. Note that this directory may not be checked by other Kerberos implementations.</p> -<p>If no configuration file exists, match user against local domains, ie luser@LOCAL-REALMS-IN-CONFIGURATION-FILES.</p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>Kerberos 5 context. </td></tr> - <tr><td class="paramname">principal</td><td>principal to check if allowed to login </td></tr> - <tr><td class="paramname">luser</td><td>local user id</td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>returns TRUE if access should be granted, FALSE otherwise. </dd></dl> - -</div> -</div> -<a id="gab6e4d59cca3b2e65abbd83204ad0e789"></a> -<h2 class="memtitle"><span class="permalink"><a href="#gab6e4d59cca3b2e65abbd83204ad0e789">◆ </a></span>krb5_plugin_register()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_plugin_register </td> - <td>(</td> - <td class="paramtype">krb5_context </td> - <td class="paramname"><em>context</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">enum krb5_plugin_type </td> - <td class="paramname"><em>type</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>name</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">void * </td> - <td class="paramname"><em>symbol</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Register a plugin symbol name of specific type. </p><dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">context</td><td>a Keberos context </td></tr> - <tr><td class="paramname">type</td><td>type of plugin symbol </td></tr> - <tr><td class="paramname">name</td><td>name of plugin symbol </td></tr> - <tr><td class="paramname">symbol</td><td>a pointer to the named symbol </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>In case of error a non zero error com_err error is returned and the Kerberos error string is set. </dd></dl> - -</div> -</div> -</div><!-- contents --> -<hr size="1"><address style="text-align: right;"><small> -Generated on Tue Nov 15 2022 14:04:26 for Heimdal Kerberos 5 library by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.9.1</small></address> -</body> -</html> |