<!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>sss_certmap: src/lib/certmap/sss_certmap.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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">sss_certmap
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_c85d3e3c5052e9ad9ce18c6863244a25.html">lib</a></li><li class="navelem"><a class="el" href="dir_c4cd08d867bbc84764b9e15d0e1262ca.html">certmap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">sss_certmap.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> SSSD</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Library for rule based certificate to user mapping</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Authors:</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Sumit Bose <sbose@redhat.com></span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> Copyright (C) 2017 Red Hat</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This program is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> This program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> GNU General Public License for more details.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef _SSS_CERTMAP_H_</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define _SSS_CERTMAP_H_</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <stdlib.h></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <talloc.h></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">struct </span>sss_certmap_ctx;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="group__sss__certmap.html#ga647ab117b6efe243171efc0a8115ae3b"> 47</a></span> <span class="preprocessor">#define SSS_CERTMAP_MIN_PRIO UINT32_MAX</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__sss__certmap.html#gac80bf9c5fb28d4507e89ff7a36957c11"> 52</a></span> <span class="keyword">typedef</span> void (<a class="code" href="group__sss__certmap.html#gac80bf9c5fb28d4507e89ff7a36957c11">sss_certmap_ext_debug</a>)(<span class="keywordtype">void</span> *pvt,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">long</span> line,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keyword">function</span>,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keywordtype">int</span> <a class="code" href="group__sss__certmap.html#ga9c2cd86a51d26536d64b6e2830fa7ac8">sss_certmap_init</a>(TALLOC_CTX *mem_ctx,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="group__sss__certmap.html#gac80bf9c5fb28d4507e89ff7a36957c11">sss_certmap_ext_debug</a> *debug, <span class="keywordtype">void</span> *debug_priv,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">struct</span> sss_certmap_ctx **ctx);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keywordtype">void</span> <a class="code" href="group__sss__certmap.html#ga0eeecccf37d34dafb78ef0482e84926a">sss_certmap_free_ctx</a>(<span class="keyword">struct</span> sss_certmap_ctx *ctx);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">int</span> <a class="code" href="group__sss__certmap.html#ga0c23fb2d13a0371eb63464679719525d">sss_certmap_add_rule</a>(<span class="keyword">struct</span> sss_certmap_ctx *ctx,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  uint32_t priority, <span class="keyword">const</span> <span class="keywordtype">char</span> *match_rule,</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *map_rule, <span class="keyword">const</span> <span class="keywordtype">char</span> **domains);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">int</span> <a class="code" href="group__sss__certmap.html#ga0a1d6c73648130a76b5d2aa3792ebd11">sss_certmap_match_cert</a>(<span class="keyword">struct</span> sss_certmap_ctx *ctx,</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> uint8_t *der_cert, <span class="keywordtype">size_t</span> der_size);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="keywordtype">int</span> <a class="code" href="group__sss__certmap.html#ga5b3549a0b8bb1343351a0154eaf9d5c5">sss_certmap_get_search_filter</a>(<span class="keyword">struct</span> sss_certmap_ctx *ctx,</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> uint8_t *der_cert, <span class="keywordtype">size_t</span> der_size,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordtype">char</span> **filter, <span class="keywordtype">char</span> ***domains);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="keywordtype">void</span> <a class="code" href="group__sss__certmap.html#ga7944c89e92883b7c2fe8c279b02bd1a8">sss_certmap_free_filter_and_domains</a>(<span class="keywordtype">char</span> *filter, <span class="keywordtype">char</span> **domains);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif </span><span class="comment">/* _SSS_CERTMAP_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="group__sss__certmap_html_ga0c23fb2d13a0371eb63464679719525d"><div class="ttname"><a href="group__sss__certmap.html#ga0c23fb2d13a0371eb63464679719525d">sss_certmap_add_rule</a></div><div class="ttdeci">int sss_certmap_add_rule(struct sss_certmap_ctx *ctx, uint32_t priority, const char *match_rule, const char *map_rule, const char **domains)</div><div class="ttdoc">Add a rule to the certmap context.</div></div>
<div class="ttc" id="group__sss__certmap_html_ga9c2cd86a51d26536d64b6e2830fa7ac8"><div class="ttname"><a href="group__sss__certmap.html#ga9c2cd86a51d26536d64b6e2830fa7ac8">sss_certmap_init</a></div><div class="ttdeci">int sss_certmap_init(TALLOC_CTX *mem_ctx, sss_certmap_ext_debug *debug, void *debug_priv, struct sss_certmap_ctx **ctx)</div><div class="ttdoc">Initialize certmap context.</div></div>
<div class="ttc" id="group__sss__certmap_html_ga5b3549a0b8bb1343351a0154eaf9d5c5"><div class="ttname"><a href="group__sss__certmap.html#ga5b3549a0b8bb1343351a0154eaf9d5c5">sss_certmap_get_search_filter</a></div><div class="ttdeci">int sss_certmap_get_search_filter(struct sss_certmap_ctx *ctx, const uint8_t *der_cert, size_t der_size, char **filter, char ***domains)</div><div class="ttdoc">Get the LDAP filter string for a certificate.</div></div>
<div class="ttc" id="group__sss__certmap_html_gac80bf9c5fb28d4507e89ff7a36957c11"><div class="ttname"><a href="group__sss__certmap.html#gac80bf9c5fb28d4507e89ff7a36957c11">sss_certmap_ext_debug</a></div><div class="ttdeci">void() sss_certmap_ext_debug(void *pvt, const char *file, long line, const char *function, const char *format,...)</div><div class="ttdef"><b>Definition:</b> sss_certmap.h:52</div></div>
<div class="ttc" id="group__sss__certmap_html_ga0eeecccf37d34dafb78ef0482e84926a"><div class="ttname"><a href="group__sss__certmap.html#ga0eeecccf37d34dafb78ef0482e84926a">sss_certmap_free_ctx</a></div><div class="ttdeci">void sss_certmap_free_ctx(struct sss_certmap_ctx *ctx)</div><div class="ttdoc">Free certmap context.</div></div>
<div class="ttc" id="group__sss__certmap_html_ga7944c89e92883b7c2fe8c279b02bd1a8"><div class="ttname"><a href="group__sss__certmap.html#ga7944c89e92883b7c2fe8c279b02bd1a8">sss_certmap_free_filter_and_domains</a></div><div class="ttdeci">void sss_certmap_free_filter_and_domains(char *filter, char **domains)</div><div class="ttdoc">Free data returned by sss_certmap_get_search_filter.</div></div>
<div class="ttc" id="group__sss__certmap_html_ga0a1d6c73648130a76b5d2aa3792ebd11"><div class="ttname"><a href="group__sss__certmap.html#ga0a1d6c73648130a76b5d2aa3792ebd11">sss_certmap_match_cert</a></div><div class="ttdeci">int sss_certmap_match_cert(struct sss_certmap_ctx *ctx, const uint8_t *der_cert, size_t der_size)</div><div class="ttdoc">Check if a certificate matches any of the applied rules.</div></div>
</div><!-- fragment --></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>
