<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ipa_hbac: Host-Based Access Control Resolver</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ipa_hbac
 <span id="projectnumber">1.16.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Host-Based Access Control Resolver</div> </div>
</div><!--header-->
<div class="contents">
<p>Libipa_hbac provides a mechanism to validate FreeIPA HBAC rules as well as evaluate whether they apply to a particular user login attempt.
<a href="#details">More...</a></p>
<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="structhbac__rule__element.html">hbac_rule_element</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Component of an HBAC rule. <a href="structhbac__rule__element.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="structhbac__rule.html">hbac_rule</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">HBAC rule object for evaluation. <a href="structhbac__rule.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="structhbac__request__element.html">hbac_request_element</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Component of an HBAC request. <a href="structhbac__request__element.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="structhbac__eval__req.html">hbac_eval_req</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Request object for an HBAC rule evaluation. <a href="structhbac__eval__req.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="structhbac__info.html">hbac_info</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Extended information. <a href="structhbac__info.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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaedbbc12bed44918a30d673720df85d03"><td class="memItemLeft" align="right" valign="top"><a id="gaedbbc12bed44918a30d673720df85d03"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gaedbbc12bed44918a30d673720df85d03">HBAC_CATEGORY_NULL</a>   0x0000</td></tr>
<tr class="memdesc:gaedbbc12bed44918a30d673720df85d03"><td class="mdescLeft"> </td><td class="mdescRight">No service category specified. <br /></td></tr>
<tr class="separator:gaedbbc12bed44918a30d673720df85d03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaff3d14567e8ca0ed671fc88287e7aaec"><td class="memItemLeft" align="right" valign="top"><a id="gaff3d14567e8ca0ed671fc88287e7aaec"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gaff3d14567e8ca0ed671fc88287e7aaec">HBAC_CATEGORY_ALL</a>   0x0001</td></tr>
<tr class="memdesc:gaff3d14567e8ca0ed671fc88287e7aaec"><td class="mdescLeft"> </td><td class="mdescRight">Rule should apply to all. <br /></td></tr>
<tr class="separator:gaff3d14567e8ca0ed671fc88287e7aaec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae31ab9dce5991045fb4d945f9f04e68d"><td class="memItemLeft" align="right" valign="top"><a id="gae31ab9dce5991045fb4d945f9f04e68d"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gae31ab9dce5991045fb4d945f9f04e68d">HBAC_RULE_ELEMENT_USERS</a>   0x01</td></tr>
<tr class="memdesc:gae31ab9dce5991045fb4d945f9f04e68d"><td class="mdescLeft"> </td><td class="mdescRight">User element. <br /></td></tr>
<tr class="separator:gae31ab9dce5991045fb4d945f9f04e68d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8fda15d21054d3c3754fe1d1948b37ff"><td class="memItemLeft" align="right" valign="top"><a id="ga8fda15d21054d3c3754fe1d1948b37ff"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#ga8fda15d21054d3c3754fe1d1948b37ff">HBAC_RULE_ELEMENT_SERVICES</a>   0x02</td></tr>
<tr class="memdesc:ga8fda15d21054d3c3754fe1d1948b37ff"><td class="mdescLeft"> </td><td class="mdescRight">Service element. <br /></td></tr>
<tr class="separator:ga8fda15d21054d3c3754fe1d1948b37ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga57195713344d39e9ca73a2775ba371a5"><td class="memItemLeft" align="right" valign="top"><a id="ga57195713344d39e9ca73a2775ba371a5"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#ga57195713344d39e9ca73a2775ba371a5">HBAC_RULE_ELEMENT_TARGETHOSTS</a>   0x04</td></tr>
<tr class="memdesc:ga57195713344d39e9ca73a2775ba371a5"><td class="mdescLeft"> </td><td class="mdescRight">Target host element. <br /></td></tr>
<tr class="separator:ga57195713344d39e9ca73a2775ba371a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad39fb6b6afefa7ccbceab5d80eb35684"><td class="memItemLeft" align="right" valign="top"><a id="gad39fb6b6afefa7ccbceab5d80eb35684"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gad39fb6b6afefa7ccbceab5d80eb35684">HBAC_RULE_ELEMENT_SOURCEHOSTS</a>   0x08</td></tr>
<tr class="memdesc:gad39fb6b6afefa7ccbceab5d80eb35684"><td class="mdescLeft"> </td><td class="mdescRight">Source host element. <br /></td></tr>
<tr class="separator:gad39fb6b6afefa7ccbceab5d80eb35684"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gab8400b6ed76fb89701240b1114f464f8"><td class="memItemLeft" align="right" valign="top"><a id="gab8400b6ed76fb89701240b1114f464f8"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gab8400b6ed76fb89701240b1114f464f8">hbac_debug_fn_t</a>) (const char *file, int line, const char *function, enum <a class="el" href="group__ipa__hbac.html#gad8db2e23cb9fe197ba3d2cd7cc9981eb">hbac_debug_level</a>, const char *format,...) HBAC_ATTRIBUTE_PRINTF(5</td></tr>
<tr class="memdesc:gab8400b6ed76fb89701240b1114f464f8"><td class="mdescLeft"> </td><td class="mdescRight">Function pointer to HBAC external debugging function. <br /></td></tr>
<tr class="separator:gab8400b6ed76fb89701240b1114f464f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab627f9114335229990023954682ffdd6"><td class="memItemLeft" align="right" valign="top">typedef void(*) voi </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gab627f9114335229990023954682ffdd6">hbac_enable_debug</a>) (<a class="el" href="group__ipa__hbac.html#gab8400b6ed76fb89701240b1114f464f8">hbac_debug_fn_t</a> external_debug_fn)</td></tr>
<tr class="memdesc:gab627f9114335229990023954682ffdd6"><td class="mdescLeft"> </td><td class="mdescRight">HBAC uses external_debug_fn for logging messages. <a href="#gab627f9114335229990023954682ffdd6">More...</a><br /></td></tr>
<tr class="separator:gab627f9114335229990023954682ffdd6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gad8db2e23cb9fe197ba3d2cd7cc9981eb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gad8db2e23cb9fe197ba3d2cd7cc9981eb">hbac_debug_level</a> { , <a class="el" href="group__ipa__hbac.html#ggad8db2e23cb9fe197ba3d2cd7cc9981ebaa1c55f23449dd5bdd2fadbba54006850">HBAC_DBG_ERROR</a>,
<a class="el" href="group__ipa__hbac.html#ggad8db2e23cb9fe197ba3d2cd7cc9981ebadd95bf7aed56c4571b46ed22be33e3df">HBAC_DBG_WARNING</a>,
<a class="el" href="group__ipa__hbac.html#ggad8db2e23cb9fe197ba3d2cd7cc9981eba69c15053ae680c9e51d7d2d93bbbf99f">HBAC_DBG_INFO</a>,
<a class="el" href="group__ipa__hbac.html#ggad8db2e23cb9fe197ba3d2cd7cc9981ebaa925d6f8deabf2417096b347cfcc56e4">HBAC_DBG_TRACE</a>
}</td></tr>
<tr class="memdesc:gad8db2e23cb9fe197ba3d2cd7cc9981eb"><td class="mdescLeft"> </td><td class="mdescRight">Debug levels for HBAC. <a href="group__ipa__hbac.html#gad8db2e23cb9fe197ba3d2cd7cc9981eb">More...</a><br /></td></tr>
<tr class="separator:gad8db2e23cb9fe197ba3d2cd7cc9981eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad62bd2c7fb837272a3cf80d176410cd6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a> { <a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6ae037f769a8a5b21d518733cdef7bb1c1">HBAC_EVAL_ERROR</a> = -1,
<a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6a7990610222cac06bb359bbef96ec5710">HBAC_EVAL_ALLOW</a>,
<a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6ad2fde36248cdaa69d07c69ced9ecfd59">HBAC_EVAL_DENY</a>,
<a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6a771aaa647d402b3796c8bd9e9bc6e915">HBAC_EVAL_OOM</a>
}</td></tr>
<tr class="memdesc:gad62bd2c7fb837272a3cf80d176410cd6"><td class="mdescLeft"> </td><td class="mdescRight">Result of HBAC evaluation. <a href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">More...</a><br /></td></tr>
<tr class="separator:gad62bd2c7fb837272a3cf80d176410cd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac4bf6648ee5fb44693543581ad8956fd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gac4bf6648ee5fb44693543581ad8956fd">hbac_error_code</a> { <br />
  <a class="el" href="group__ipa__hbac.html#ggac4bf6648ee5fb44693543581ad8956fdab458a5182a5fa817b9170f733e6e2a68">HBAC_ERROR_UNKNOWN</a> = -1,
<a class="el" href="group__ipa__hbac.html#ggac4bf6648ee5fb44693543581ad8956fdad2a456bafa5157c4948c4731f98bd934">HBAC_SUCCESS</a>,
<a class="el" href="group__ipa__hbac.html#ggac4bf6648ee5fb44693543581ad8956fda714c7f58d25e404aa489f7f552a328aa">HBAC_ERROR_NOT_IMPLEMENTED</a>,
<a class="el" href="group__ipa__hbac.html#ggac4bf6648ee5fb44693543581ad8956fda7ab6bd70d35aca7230973453f3996f94">HBAC_ERROR_OUT_OF_MEMORY</a>,
<br />
  <a class="el" href="group__ipa__hbac.html#ggac4bf6648ee5fb44693543581ad8956fda63c32fd2a31addc7bdbbb9f931769b6d">HBAC_ERROR_UNPARSEABLE_RULE</a>
<br />
}</td></tr>
<tr class="memdesc:gac4bf6648ee5fb44693543581ad8956fd"><td class="mdescLeft"> </td><td class="mdescRight">Error code returned by the evaluator. <a href="group__ipa__hbac.html#gac4bf6648ee5fb44693543581ad8956fd">More...</a><br /></td></tr>
<tr class="separator:gac4bf6648ee5fb44693543581ad8956fd"><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:ga5e2ff922594e1c95406a58e11c02e785"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#ga5e2ff922594e1c95406a58e11c02e785">hbac_evaluate</a> (struct <a class="el" href="structhbac__rule.html">hbac_rule</a> **rules, struct <a class="el" href="structhbac__eval__req.html">hbac_eval_req</a> *hbac_req, struct <a class="el" href="structhbac__info.html">hbac_info</a> **info)</td></tr>
<tr class="memdesc:ga5e2ff922594e1c95406a58e11c02e785"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate an authorization request against a set of HBAC rules. <a href="#ga5e2ff922594e1c95406a58e11c02e785">More...</a><br /></td></tr>
<tr class="separator:ga5e2ff922594e1c95406a58e11c02e785"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcf175aab640e89824deaae97160d0f2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gabcf175aab640e89824deaae97160d0f2">hbac_result_string</a> (enum <a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a> result)</td></tr>
<tr class="memdesc:gabcf175aab640e89824deaae97160d0f2"><td class="mdescLeft"> </td><td class="mdescRight">Display result of hbac evaluation in human-readable form. <a href="#gabcf175aab640e89824deaae97160d0f2">More...</a><br /></td></tr>
<tr class="separator:gabcf175aab640e89824deaae97160d0f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03f9ab391cf4a158a2d11bc3e408b2f5"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#ga03f9ab391cf4a158a2d11bc3e408b2f5">hbac_error_string</a> (enum <a class="el" href="group__ipa__hbac.html#gac4bf6648ee5fb44693543581ad8956fd">hbac_error_code</a> code)</td></tr>
<tr class="memdesc:ga03f9ab391cf4a158a2d11bc3e408b2f5"><td class="mdescLeft"> </td><td class="mdescRight">Display error description. <a href="#ga03f9ab391cf4a158a2d11bc3e408b2f5">More...</a><br /></td></tr>
<tr class="separator:ga03f9ab391cf4a158a2d11bc3e408b2f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae3bfb7f61dc7f11f6bbc7f89d5e9cc40"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gae3bfb7f61dc7f11f6bbc7f89d5e9cc40">hbac_free_info</a> (struct <a class="el" href="structhbac__info.html">hbac_info</a> *info)</td></tr>
<tr class="memdesc:gae3bfb7f61dc7f11f6bbc7f89d5e9cc40"><td class="mdescLeft"> </td><td class="mdescRight">Function to safely free <a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> returned by <a class="el" href="group__ipa__hbac.html#ga5e2ff922594e1c95406a58e11c02e785" title="Evaluate an authorization request against a set of HBAC rules.">hbac_evaluate</a>. <a href="#gae3bfb7f61dc7f11f6bbc7f89d5e9cc40">More...</a><br /></td></tr>
<tr class="separator:gae3bfb7f61dc7f11f6bbc7f89d5e9cc40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadef62fdeda3388674ab2cc50f955c406"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ipa__hbac.html#gadef62fdeda3388674ab2cc50f955c406">hbac_rule_is_complete</a> (struct <a class="el" href="structhbac__rule.html">hbac_rule</a> *rule, uint32_t *missing_attrs)</td></tr>
<tr class="memdesc:gadef62fdeda3388674ab2cc50f955c406"><td class="mdescLeft"> </td><td class="mdescRight">Evaluate whether an HBAC rule contains all necessary elements. <a href="#gadef62fdeda3388674ab2cc50f955c406">More...</a><br /></td></tr>
<tr class="separator:gadef62fdeda3388674ab2cc50f955c406"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Libipa_hbac provides a mechanism to validate FreeIPA HBAC rules as well as evaluate whether they apply to a particular user login attempt. </p>
<p>Libipa_hbac is case-insensitive and compatible with UTF-8. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gab627f9114335229990023954682ffdd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab627f9114335229990023954682ffdd6">◆ </a></span>hbac_enable_debug</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(*) voi hbac_enable_debug) (<a class="el" href="group__ipa__hbac.html#gab8400b6ed76fb89701240b1114f464f8">hbac_debug_fn_t</a> external_debug_fn)</td>
</tr>
</table>
</div><div class="memdoc">
<p>HBAC uses external_debug_fn for logging messages. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">external_debug_fn</td><td>Pointer to external logging function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gad8db2e23cb9fe197ba3d2cd7cc9981eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad8db2e23cb9fe197ba3d2cd7cc9981eb">◆ </a></span>hbac_debug_level</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ipa__hbac.html#gad8db2e23cb9fe197ba3d2cd7cc9981eb">hbac_debug_level</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug levels for HBAC. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad8db2e23cb9fe197ba3d2cd7cc9981ebaa1c55f23449dd5bdd2fadbba54006850"></a>HBAC_DBG_ERROR </td><td class="fielddoc"><p>Fatal failure (not used). </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad8db2e23cb9fe197ba3d2cd7cc9981ebadd95bf7aed56c4571b46ed22be33e3df"></a>HBAC_DBG_WARNING </td><td class="fielddoc"><p>Serious failure (out of memory, for example). </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad8db2e23cb9fe197ba3d2cd7cc9981eba69c15053ae680c9e51d7d2d93bbbf99f"></a>HBAC_DBG_INFO </td><td class="fielddoc"><p>Warnings (not used). </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad8db2e23cb9fe197ba3d2cd7cc9981ebaa925d6f8deabf2417096b347cfcc56e4"></a>HBAC_DBG_TRACE </td><td class="fielddoc"><p>HBAC allow/disallow info. </p>
<p>Verbose description of rules. </p>
</td></tr>
</table>
</div>
</div>
<a id="gac4bf6648ee5fb44693543581ad8956fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4bf6648ee5fb44693543581ad8956fd">◆ </a></span>hbac_error_code</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ipa__hbac.html#gac4bf6648ee5fb44693543581ad8956fd">hbac_error_code</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Error code returned by the evaluator. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggac4bf6648ee5fb44693543581ad8956fdab458a5182a5fa817b9170f733e6e2a68"></a>HBAC_ERROR_UNKNOWN </td><td class="fielddoc"><p>Unexpected error. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac4bf6648ee5fb44693543581ad8956fdad2a456bafa5157c4948c4731f98bd934"></a>HBAC_SUCCESS </td><td class="fielddoc"><p>Successful evaluation. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac4bf6648ee5fb44693543581ad8956fda714c7f58d25e404aa489f7f552a328aa"></a>HBAC_ERROR_NOT_IMPLEMENTED </td><td class="fielddoc"><p>Function is not yet implemented. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac4bf6648ee5fb44693543581ad8956fda7ab6bd70d35aca7230973453f3996f94"></a>HBAC_ERROR_OUT_OF_MEMORY </td><td class="fielddoc"><p>Ran out of memory during processing. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggac4bf6648ee5fb44693543581ad8956fda63c32fd2a31addc7bdbbb9f931769b6d"></a>HBAC_ERROR_UNPARSEABLE_RULE </td><td class="fielddoc"><p>Parse error while evaluating rule. </p>
</td></tr>
</table>
</div>
</div>
<a id="gad62bd2c7fb837272a3cf80d176410cd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad62bd2c7fb837272a3cf80d176410cd6">◆ </a></span>hbac_eval_result</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Result of HBAC evaluation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad62bd2c7fb837272a3cf80d176410cd6ae037f769a8a5b21d518733cdef7bb1c1"></a>HBAC_EVAL_ERROR </td><td class="fielddoc"><p>An error occurred See the <a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> for more details. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad62bd2c7fb837272a3cf80d176410cd6a7990610222cac06bb359bbef96ec5710"></a>HBAC_EVAL_ALLOW </td><td class="fielddoc"><p>Evaluation grants access. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad62bd2c7fb837272a3cf80d176410cd6ad2fde36248cdaa69d07c69ced9ecfd59"></a>HBAC_EVAL_DENY </td><td class="fielddoc"><p>Evaluation denies access. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggad62bd2c7fb837272a3cf80d176410cd6a771aaa647d402b3796c8bd9e9bc6e915"></a>HBAC_EVAL_OOM </td><td class="fielddoc"><p>Evaluation failed due to lack of memory <a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> is not available. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga03f9ab391cf4a158a2d11bc3e408b2f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03f9ab391cf4a158a2d11bc3e408b2f5">◆ </a></span>hbac_error_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* hbac_error_string </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__ipa__hbac.html#gac4bf6648ee5fb44693543581ad8956fd">hbac_error_code</a> </td>
<td class="paramname"><em>code</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display error description. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">code</td><td>Error code returned in <a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>English string describing the error </dd></dl>
</div>
</div>
<a id="ga5e2ff922594e1c95406a58e11c02e785"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5e2ff922594e1c95406a58e11c02e785">◆ </a></span>hbac_evaluate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a> hbac_evaluate </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structhbac__rule.html">hbac_rule</a> ** </td>
<td class="paramname"><em>rules</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structhbac__eval__req.html">hbac_eval_req</a> * </td>
<td class="paramname"><em>hbac_req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structhbac__info.html">hbac_info</a> ** </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate an authorization request against a set of HBAC rules. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rules</td><td>A NULL-terminated list of rules to evaluate against </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hbac_req</td><td>A user authorization request </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>Extended information (including the name of the rule that allowed access (or caused a parse error) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li><a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6ae037f769a8a5b21d518733cdef7bb1c1" title="An error occurred See the hbac_info for more details.">HBAC_EVAL_ERROR</a>: An error occurred</li>
<li><a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6a7990610222cac06bb359bbef96ec5710" title="Evaluation grants access.">HBAC_EVAL_ALLOW</a>: Access is granted</li>
<li><a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6ad2fde36248cdaa69d07c69ced9ecfd59" title="Evaluation denies access.">HBAC_EVAL_DENY</a>: Access is denied</li>
<li><a class="el" href="group__ipa__hbac.html#ggad62bd2c7fb837272a3cf80d176410cd6a771aaa647d402b3796c8bd9e9bc6e915" title="Evaluation failed due to lack of memory hbac_info is not available.">HBAC_EVAL_OOM</a>: Insufficient memory to complete the evaluation </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gae3bfb7f61dc7f11f6bbc7f89d5e9cc40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae3bfb7f61dc7f11f6bbc7f89d5e9cc40">◆ </a></span>hbac_free_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void hbac_free_info </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structhbac__info.html">hbac_info</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to safely free <a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> returned by <a class="el" href="group__ipa__hbac.html#ga5e2ff922594e1c95406a58e11c02e785" title="Evaluate an authorization request against a set of HBAC rules.">hbac_evaluate</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td><a class="el" href="structhbac__info.html" title="Extended information.">hbac_info</a> returned by <a class="el" href="group__ipa__hbac.html#ga5e2ff922594e1c95406a58e11c02e785" title="Evaluate an authorization request against a set of HBAC rules.">hbac_evaluate</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabcf175aab640e89824deaae97160d0f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabcf175aab640e89824deaae97160d0f2">◆ </a></span>hbac_result_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* hbac_result_string </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__ipa__hbac.html#gad62bd2c7fb837272a3cf80d176410cd6">hbac_eval_result</a> </td>
<td class="paramname"><em>result</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Display result of hbac evaluation in human-readable form. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>Return value of <a class="el" href="group__ipa__hbac.html#ga5e2ff922594e1c95406a58e11c02e785" title="Evaluate an authorization request against a set of HBAC rules.">hbac_evaluate</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>English string describing the evaluation result </dd></dl>
</div>
</div>
<a id="gadef62fdeda3388674ab2cc50f955c406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadef62fdeda3388674ab2cc50f955c406">◆ </a></span>hbac_rule_is_complete()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hbac_rule_is_complete </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structhbac__rule.html">hbac_rule</a> * </td>
<td class="paramname"><em>rule</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>missing_attrs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Evaluate whether an HBAC rule contains all necessary elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rule</td><td>An HBAC rule to evaluate </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">missing_attrs</td><td>A list of attributes missing from the rule This is a bitmask that may contain one or more of <a class="el" href="group__ipa__hbac.html#gae31ab9dce5991045fb4d945f9f04e68d" title="User element.">HBAC_RULE_ELEMENT_USERS</a>, <a class="el" href="group__ipa__hbac.html#ga8fda15d21054d3c3754fe1d1948b37ff" title="Service element.">HBAC_RULE_ELEMENT_SERVICES</a>, <a class="el" href="group__ipa__hbac.html#ga57195713344d39e9ca73a2775ba371a5" title="Target host element.">HBAC_RULE_ELEMENT_TARGETHOSTS</a> and <a class="el" href="group__ipa__hbac.html#gad39fb6b6afefa7ccbceab5d80eb35684" title="Source host element.">HBAC_RULE_ELEMENT_SOURCEHOSTS</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the rule contains all mandatory attributes</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function does not care if the rule is enabled or disabled </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
2b8767642b0a927316af342b14b4b58e
>
files
>
23
