blob: 45f86f1a26fb9a87ecc4c86583734563c06bf63c [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: mesos::authentication::executor::JWTSecretGenerator Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemesos.html">mesos</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1authentication.html">authentication</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1authentication_1_1executor.html">executor</a></li><li class="navelem"><a class="el" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html">JWTSecretGenerator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mesos::authentication::executor::JWTSecretGenerator Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Creates a VALUE-type secret containing a JWT.
<a href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="jwt__secret__generator_8hpp_source.html">jwt_secret_generator.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mesos::authentication::executor::JWTSecretGenerator:</div>
<div class="dyncontent">
<div class="center">
<img src="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.png" usemap="#mesos::authentication::executor::JWTSecretGenerator_map" alt=""/>
<map id="mesos::authentication::executor::JWTSecretGenerator_map" name="mesos::authentication::executor::JWTSecretGenerator_map">
<area href="classmesos_1_1SecretGenerator.html" title="The SecretGenerator interface represents a mechanism to create a secret from a principal. " alt="mesos::SecretGenerator" shape="rect" coords="0,0,311,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe7dbdd97984419e33e5f8d7184d53d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#abe7dbdd97984419e33e5f8d7184d53d5">JWTSecretGenerator</a> (const std::string &amp;secret)</td></tr>
<tr class="separator:abe7dbdd97984419e33e5f8d7184d53d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeaf52fab52398d9bf78dc69d9961b07f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#aeaf52fab52398d9bf78dc69d9961b07f">~JWTSecretGenerator</a> () override</td></tr>
<tr class="separator:aeaf52fab52398d9bf78dc69d9961b07f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71fe99eec2d22c6dafbf92912466f327"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classprocess_1_1Future.html">process::Future</a>&lt; Secret &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1authentication_1_1executor_1_1JWTSecretGenerator.html#a71fe99eec2d22c6dafbf92912466f327">generate</a> (const <a class="el" href="structprocess_1_1http_1_1authentication_1_1Principal.html">process::http::authentication::Principal</a> &amp;principal) override</td></tr>
<tr class="separator:a71fe99eec2d22c6dafbf92912466f327"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classmesos_1_1SecretGenerator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmesos_1_1SecretGenerator')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classmesos_1_1SecretGenerator.html">mesos::SecretGenerator</a></td></tr>
<tr class="memitem:ac517647974bbe9cdd1f36b93cce92ec4 inherit pub_methods_classmesos_1_1SecretGenerator"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1SecretGenerator.html#ac517647974bbe9cdd1f36b93cce92ec4">~SecretGenerator</a> ()</td></tr>
<tr class="separator:ac517647974bbe9cdd1f36b93cce92ec4 inherit pub_methods_classmesos_1_1SecretGenerator"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates a VALUE-type secret containing a JWT. </p>
<p>When the secret is presented to the 'JWTAuthenticator' module, the authenticator will return the principal which is provided here as an argument. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="abe7dbdd97984419e33e5f8d7184d53d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mesos::authentication::executor::JWTSecretGenerator::JWTSecretGenerator </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>secret</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aeaf52fab52398d9bf78dc69d9961b07f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mesos::authentication::executor::JWTSecretGenerator::~JWTSecretGenerator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a71fe99eec2d22c6dafbf92912466f327"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classprocess_1_1Future.html">process::Future</a>&lt;Secret&gt; mesos::authentication::executor::JWTSecretGenerator::generate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structprocess_1_1http_1_1authentication_1_1Principal.html">process::http::authentication::Principal</a> &amp;&#160;</td>
<td class="paramname"><em>principal</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classmesos_1_1SecretGenerator.html#ab68cb02f25731c646bec2cdebef9f419">mesos::SecretGenerator</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/authentication/executor/<a class="el" href="jwt__secret__generator_8hpp_source.html">jwt_secret_generator.hpp</a></li>
</ul>
</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>