| <!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.5"/> |
| <title>Apache Mesos: include/mesos/zookeeper/authentication.hpp 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">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <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> |
| <li><a href="examples.html"><span>Examples</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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a00cdca4cac44d29e96ac7c7cae2bc86.html">mesos</a></li><li class="navelem"><a class="el" href="dir_c17ba5dacf03ff8b8f3824850be465e6.html">zookeeper</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">authentication.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="zookeeper_2authentication_8hpp.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">// Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</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">// http://www.apache.org/licenses/LICENSE-2.0</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">// Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// limitations under the License</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#ifndef __MESOS_ZOOKEEPER_AUTHENTICATION_HPP__</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"></span><span class="preprocessor">#define __MESOS_ZOOKEEPER_AUTHENTICATION_HPP__</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <zookeeper.h></span></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> <span class="preprocessor">#ifdef __WINDOWS__</span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="comment">// NOTE: We need to undefine this macro to prevent it from bleeding</span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// into our code and thereby break compilation of our namespaced ACLs.</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// This macro is defined in zookeeper/src/c/include/winconfig.h.</span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#undef ACL</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor">#endif // __WINDOWS__</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include <glog/logging.h></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacezookeeper.html"> 33</a></span> <span class="keyword">namespace </span>zookeeper {</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structzookeeper_1_1Authentication.html"> 35</a></span> <span class="keyword">struct </span><a class="code" href="structzookeeper_1_1Authentication.html">Authentication</a></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structzookeeper_1_1Authentication.html#ab83afefc5084a841eb2e3ce7527a0980"> 37</a></span>  <a class="code" href="structzookeeper_1_1Authentication.html#ab83afefc5084a841eb2e3ce7527a0980">Authentication</a>(</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">const</span> std::string& _scheme,</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">const</span> std::string& _credentials)</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  : <a class="code" href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691">scheme</a>(_scheme),</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="structzookeeper_1_1Authentication.html#a1d3dcf01ba00a3887317bdc61eeea210">credentials</a>(_credentials)</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  {</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// TODO(benh): Fix output operator below once this changes.</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  CHECK_EQ(<a class="code" href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691">scheme</a>, <span class="stringliteral">"digest"</span>) << <span class="stringliteral">"Unsupported authentication scheme"</span>;</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  }</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691"> 47</a></span>  <span class="keyword">const</span> std::string <a class="code" href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691">scheme</a>;</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structzookeeper_1_1Authentication.html#a1d3dcf01ba00a3887317bdc61eeea210"> 48</a></span>  <span class="keyword">const</span> std::string <a class="code" href="structzookeeper_1_1Authentication.html#a1d3dcf01ba00a3887317bdc61eeea210">credentials</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"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// An ACL that ensures we're the only authenticated user to mutate our</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// nodes - others are welcome to read.</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">extern</span> <span class="keyword">const</span> ACL_vector <a class="code" href="namespacezookeeper.html#ae7996d91e04a4e7122cdf2ddacb5766d">EVERYONE_READ_CREATOR_ALL</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="comment">// An ACL that allows others to create child nodes and read nodes, but</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">// we're the only authenticated user to mutate our nodes.</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">extern</span> <span class="keyword">const</span> ACL_vector <a class="code" href="namespacezookeeper.html#a520e93e970fb994ef0446f92046d3784">EVERYONE_CREATE_AND_READ_CREATOR_ALL</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> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="namespacezookeeper.html#a7809602b75b99bb5626bb3a926b750b1"> 61</a></span> <span class="keyword">inline</span> std::ostream& <a class="code" href="namespacezookeeper.html#a7809602b75b99bb5626bb3a926b750b1">operator<<</a>(</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::ostream& stream,</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">const</span> <a class="code" href="structzookeeper_1_1Authentication.html">Authentication</a>& authentication)</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>  <span class="comment">// TODO(benh): Fix this once we support more than just 'digest'.</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  CHECK_EQ(authentication.<a class="code" href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691">scheme</a>, <span class="stringliteral">"digest"</span>);</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> stream << authentication.<a class="code" href="structzookeeper_1_1Authentication.html#a1d3dcf01ba00a3887317bdc61eeea210">credentials</a>;</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> } <span class="comment">// namespace zookeeper {</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor">#endif // __MESOS_ZOOKEEPER_AUTHENTICATION_HPP__</span></div> |
| <div class="ttc" id="namespacezookeeper_html_a7809602b75b99bb5626bb3a926b750b1"><div class="ttname"><a href="namespacezookeeper.html#a7809602b75b99bb5626bb3a926b750b1">zookeeper::operator<<</a></div><div class="ttdeci">std::ostream & operator<<(std::ostream &stream, const Authentication &authentication)</div><div class="ttdef"><b>Definition:</b> authentication.hpp:61</div></div> |
| <div class="ttc" id="structzookeeper_1_1Authentication_html_a1d3dcf01ba00a3887317bdc61eeea210"><div class="ttname"><a href="structzookeeper_1_1Authentication.html#a1d3dcf01ba00a3887317bdc61eeea210">zookeeper::Authentication::credentials</a></div><div class="ttdeci">const std::string credentials</div><div class="ttdef"><b>Definition:</b> authentication.hpp:48</div></div> |
| <div class="ttc" id="structzookeeper_1_1Authentication_html"><div class="ttname"><a href="structzookeeper_1_1Authentication.html">zookeeper::Authentication</a></div><div class="ttdef"><b>Definition:</b> authentication.hpp:35</div></div> |
| <div class="ttc" id="namespacezookeeper_html_ae7996d91e04a4e7122cdf2ddacb5766d"><div class="ttname"><a href="namespacezookeeper.html#ae7996d91e04a4e7122cdf2ddacb5766d">zookeeper::EVERYONE_READ_CREATOR_ALL</a></div><div class="ttdeci">const ACL_vector EVERYONE_READ_CREATOR_ALL</div></div> |
| <div class="ttc" id="namespacezookeeper_html_a520e93e970fb994ef0446f92046d3784"><div class="ttname"><a href="namespacezookeeper.html#a520e93e970fb994ef0446f92046d3784">zookeeper::EVERYONE_CREATE_AND_READ_CREATOR_ALL</a></div><div class="ttdeci">const ACL_vector EVERYONE_CREATE_AND_READ_CREATOR_ALL</div></div> |
| <div class="ttc" id="structzookeeper_1_1Authentication_html_a3b65f63c4f97ecfd6d289d3112284691"><div class="ttname"><a href="structzookeeper_1_1Authentication.html#a3b65f63c4f97ecfd6d289d3112284691">zookeeper::Authentication::scheme</a></div><div class="ttdeci">const std::string scheme</div><div class="ttdef"><b>Definition:</b> authentication.hpp:47</div></div> |
| <div class="ttc" id="structzookeeper_1_1Authentication_html_ab83afefc5084a841eb2e3ce7527a0980"><div class="ttname"><a href="structzookeeper_1_1Authentication.html#ab83afefc5084a841eb2e3ce7527a0980">zookeeper::Authentication::Authentication</a></div><div class="ttdeci">Authentication(const std::string &_scheme, const std::string &_credentials)</div><div class="ttdef"><b>Definition:</b> authentication.hpp:37</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.5 |
| </small></address> |
| </body> |
| </html> |
