<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.3.1"/>
<title>dmlite: src/core/builtin/Authn.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="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 style="padding-left: 0.5em;">
<div id="projectname">dmlite
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</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_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_7620f3c01c16793ba41ae300cf864fd5.html">builtin</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Authn.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_authn_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/// @file core/builtin/Authn.h</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"></span><span class="comment">/// @brief User and group mapping using the system's ones.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span><span class="comment">/// @details This will be used by default when no other Authn</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span><span class="comment">/// implementeation is loaded.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span><span class="comment">/// @author Alejandro Álvarez Ayllon <aalvarez@cern.ch></span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span><span class="preprocessor">#ifndef BUILTIN_AUTHN_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor"></span><span class="preprocessor">#define BUILTIN_AUTHN_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <<a class="code" href="authn_8h.html" title="Authentication API. Any sort of security check is plugin-specific.">dmlite/cpp/authn.h</a>></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span>dmlite {</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn.html"> 13</a></span>  <span class="keyword">class </span><a class="code" href="classdmlite_1_1_built_in_authn.html">BuiltInAuthn</a>: <span class="keyword">public</span> <a class="code" href="classdmlite_1_1_authn.html">Authn</a> {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <a class="code" href="classdmlite_1_1_built_in_authn.html#a400f402471921017a62413d63f4cb7b8">BuiltInAuthn</a>(<span class="keyword">const</span> std::string&, <span class="keyword">const</span> std::string&);</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="classdmlite_1_1_built_in_authn.html#ad9d8c3077bb615d7b2e3d92326a22605">~BuiltInAuthn</a>();</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  std::string <a class="code" href="classdmlite_1_1_built_in_authn.html#a0b74fa839e341ae987d58d2bff304dbf" title="String ID of the user DB implementation.">getImplId</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> <span class="keywordflow">throw</span>();</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="structdmlite_1_1_security_context.html" title="Security context. To be created by the Authn.">SecurityContext</a>* <a class="code" href="classdmlite_1_1_authn.html#a0628d9f2fca14ebbff0e1c83e502b45f">createSecurityContext</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_security_credentials.html" title="Security credentials. To be filled by the front-end.">SecurityCredentials</a>& cred) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <a class="code" href="structdmlite_1_1_group_info.html">GroupInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a88de4490f1186b4de8bcf87bfd44c675">newGroup</a> (<span class="keyword">const</span> std::string& gname) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="structdmlite_1_1_group_info.html">GroupInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a3072f2281aa4d799066f75732a830fe6">getGroup</a> (gid_t gid) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="structdmlite_1_1_group_info.html">GroupInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a3072f2281aa4d799066f75732a830fe6">getGroup</a> (<span class="keyword">const</span> std::string& groupName) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="structdmlite_1_1_group_info.html">GroupInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a3072f2281aa4d799066f75732a830fe6">getGroup</a> (<span class="keyword">const</span> std::string& key,</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">const</span> boost::any& value) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn.html#af4db3a081d2cea9069e54f1317cf011c">updateGroup</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_group_info.html">GroupInfo</a>& group) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn.html#a045718d945d183d37055051373b5c165" title="Delete a group.">deleteGroup</a>(<span class="keyword">const</span> std::string& groupName) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a0ee13bbbf8a1877e13ecdf35315d6b49">newUser</a> (<span class="keyword">const</span> std::string& uname) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a9f6e57a2607f30f71bc6a0e81c8ab2e4">getUser</a> (<span class="keyword">const</span> std::string& userName) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a9f6e57a2607f30f71bc6a0e81c8ab2e4">getUser</a> (<span class="keyword">const</span> std::string& userName,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  gid_t* group) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a> <a class="code" href="classdmlite_1_1_built_in_authn.html#a9f6e57a2607f30f71bc6a0e81c8ab2e4">getUser</a> (<span class="keyword">const</span> std::string& key,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">const</span> boost::any& value) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn.html#aac983897e46c83f00b72b355b84ff098">updateUser</a>(<span class="keyword">const</span> <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a>& user) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn.html#ac9e41caa351dcb8c95fe87e44c1122c1" title="Delete a user.">deleteUser</a>(<span class="keyword">const</span> std::string& userName) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  std::vector<GroupInfo> <a class="code" href="classdmlite_1_1_built_in_authn.html#acb979e7028ceac4c1cb539e1fe2ad0bd" title="Get the group list.">getGroups</a>(<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  std::vector<UserInfo> <a class="code" href="classdmlite_1_1_built_in_authn.html#ad327fce1e8439cd4f2c1e3bc61ac51b5" title="Get the user list.">getUsers</a> (<span class="keywordtype">void</span>) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn.html#a4b39d5f6eb3f666802af16026efc6bd1">getIdMap</a>(<span class="keyword">const</span> std::string& userName,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">const</span> std::vector<std::string>& groupNames,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structdmlite_1_1_user_info.html">UserInfo</a>* user,</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::vector<GroupInfo>* groups) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn.html#a797cca2c6e2962af6b37e7b8b2da45fa"> 47</a></span>  std::string <a class="code" href="classdmlite_1_1_built_in_authn.html#a797cca2c6e2962af6b37e7b8b2da45fa">nobody_</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn.html#ac5d196fcdd6d54e39c5bd2feb75dfa8a"> 48</a></span>  std::string <a class="code" href="classdmlite_1_1_built_in_authn.html#ac5d196fcdd6d54e39c5bd2feb75dfa8a">nogroup_</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  };</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn_factory.html"> 51</a></span>  <span class="keyword">class </span><a class="code" href="classdmlite_1_1_built_in_authn_factory.html">BuiltInAuthnFactory</a>: <span class="keyword">public</span> <a class="code" href="classdmlite_1_1_authn_factory.html" title="AuthnFactory.">AuthnFactory</a> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#a930bc74ef1a3d5734e83c8f8ccc9788b">BuiltInAuthnFactory</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#a71d806771cd44d485b7a1c80552b26d8">~BuiltInAuthnFactory</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">void</span> <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#ac970866b9971e0d64923296819c1e041">configure</a>(<span class="keyword">const</span> std::string& key, <span class="keyword">const</span> std::string& value) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classdmlite_1_1_authn.html">Authn</a>* <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#a257a6df801fd10ea7fa5e67dd25c2431" title="Instantiate a implementation of Authn.">createAuthn</a>(<a class="code" href="classdmlite_1_1_plugin_manager.html" title="CatalogInterface can only be instantiated through this class.">PluginManager</a>* pm) <span class="keywordflow">throw</span> (<a class="code" href="classdmlite_1_1_dm_exception.html" title="Base exception class.">DmException</a>);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn_factory.html#ab2435f497ee17a6adc408e7a7fe54ace"> 61</a></span>  std::string <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#ab2435f497ee17a6adc408e7a7fe54ace">nobody_</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="classdmlite_1_1_built_in_authn_factory.html#a4b40d78ed49033da518ea4895301b134"> 62</a></span>  std::string <a class="code" href="classdmlite_1_1_built_in_authn_factory.html#a4b40d78ed49033da518ea4895301b134">nogroup_</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  };</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> };</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif // BUILTIN_AUTHN_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jul 12 2013 07:34:22 for dmlite by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
