blob: dbed941269d039c9ddeb4a36f2e9e4edd5278865 [file] [log] [blame]
<!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: src/authentication/executor/jwt_secret_generator.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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;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_e6f9bca8f497e02e6509b719013265e7.html">authentication</a></li><li class="navelem"><a class="el" href="dir_fb2088044c9a721af1f5970a90a94bd4.html">executor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">jwt_secret_generator.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="jwt__secret__generator_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>&#160;<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>&#160;<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>&#160;<span class="comment">// distributed with this work for additional information</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<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>&#160;<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>&#160;<span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<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>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<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>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<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>&#160;<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>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef __MESOS_AUTHENTICATION_EXECUTOR_JWT_SECRET_GENERATOR_HPP__</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __MESOS_AUTHENTICATION_EXECUTOR_JWT_SECRET_GENERATOR_HPP__</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="authentication_2secret__generator_8hpp.html">mesos/authentication/secret_generator.hpp</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">process/authenticator.hpp</a>&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="future_8hpp.html">process/future.hpp</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>mesos {</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="namespacemesos_1_1authentication.html"> 28</a></span>&#160;<span class="keyword">namespace </span>authentication {</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespacemesos_1_1authentication_1_1executor.html"> 29</a></span>&#160;<span class="keyword">namespace </span>executor {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html"> 36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html">JWTSecretGenerator</a> : <span class="keyword">public</span> <a class="code" href="classmesos_1_1SecretGenerator.html">SecretGenerator</a></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#abe7dbdd97984419e33e5f8d7184d53d5">JWTSecretGenerator</a>(<span class="keyword">const</span> std::string&amp; secret);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#aeaf52fab52398d9bf78dc69d9961b07f">~JWTSecretGenerator</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classprocess_1_1Future.html">process::Future&lt;Secret&gt;</a> <a class="code" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#a71fe99eec2d22c6dafbf92912466f327">generate</a>(</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1authentication_1_1Principal.html">process::http::authentication::Principal</a>&amp; principal)</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">override</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; std::string secret_;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;};</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;} <span class="comment">// namespace executor {</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace authentication {</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;} <span class="comment">// namespace mesos {</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="preprocessor">#endif // __MESOS_AUTHENTICATION_EXECUTOR_JWT_SECRET_GENERATOR_HPP__</span></div>
<div class="ttc" id="authentication_2secret__generator_8hpp_html"><div class="ttname"><a href="authentication_2secret__generator_8hpp.html">secret_generator.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator_html"><div class="ttname"><a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html">mesos::authentication::executor::JWTSecretGenerator</a></div><div class="ttdoc">Creates a VALUE-type secret containing a JWT. </div><div class="ttdef"><b>Definition:</b> jwt_secret_generator.hpp:36</div></div>
<div class="ttc" id="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator_html_a71fe99eec2d22c6dafbf92912466f327"><div class="ttname"><a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#a71fe99eec2d22c6dafbf92912466f327">mesos::authentication::executor::JWTSecretGenerator::generate</a></div><div class="ttdeci">process::Future&lt; Secret &gt; generate(const process::http::authentication::Principal &amp;principal) override</div></div>
<div class="ttc" id="classmesos_1_1SecretGenerator_html"><div class="ttname"><a href="classmesos_1_1SecretGenerator.html">mesos::SecretGenerator</a></div><div class="ttdoc">The SecretGenerator interface represents a mechanism to create a secret from a principal. </div><div class="ttdef"><b>Definition:</b> secret_generator.hpp:34</div></div>
<div class="ttc" id="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator_html_abe7dbdd97984419e33e5f8d7184d53d5"><div class="ttname"><a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#abe7dbdd97984419e33e5f8d7184d53d5">mesos::authentication::executor::JWTSecretGenerator::JWTSecretGenerator</a></div><div class="ttdeci">JWTSecretGenerator(const std::string &amp;secret)</div></div>
<div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></div></div>
<div class="ttc" id="structprocess_1_1http_1_1authentication_1_1Principal_html"><div class="ttname"><a href="structprocess_1_1http_1_1authentication_1_1Principal.html">process::http::authentication::Principal</a></div><div class="ttdoc">Contains information associated with an authenticated principal. </div><div class="ttdef"><b>Definition:</b> authenticator.hpp:41</div></div>
<div class="ttc" id="3rdparty_2libprocess_2include_2process_2authenticator_8hpp_html"><div class="ttname"><a href="3rdparty_2libprocess_2include_2process_2authenticator_8hpp.html">authenticator.hpp</a></div></div>
<div class="ttc" id="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator_html_aeaf52fab52398d9bf78dc69d9961b07f"><div class="ttname"><a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#aeaf52fab52398d9bf78dc69d9961b07f">mesos::authentication::executor::JWTSecretGenerator::~JWTSecretGenerator</a></div><div class="ttdeci">~JWTSecretGenerator() override</div></div>
<div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>