| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- <!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.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: include/grpcpp/impl/codegen/security/auth_context.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" />
- <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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">GRPC C++
-  <span id="projectnumber">1.13.0-dev</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li><li class="navelem"><a class="el" href="dir_84040d6f573b73aa8d12512b533ede11.html">impl</a></li><li class="navelem"><a class="el" href="dir_a33e3e3a3b205cffecbb359564791f71.html">codegen</a></li><li class="navelem"><a class="el" href="dir_cff2fbfd0e08cf0650d0f7d30bec4b77.html">security</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">auth_context.h</div> </div>
- </div><!--header-->
- <div class="contents">
- <a href="grpcpp_2impl_2codegen_2security_2auth__context_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">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * 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> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef GRPCPP_IMPL_CODEGEN_SECURITY_AUTH_CONTEXT_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define GRPCPP_IMPL_CODEGEN_SECURITY_AUTH_CONTEXT_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">#include <iterator></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <vector></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">#include <<a class="code" href="grpcpp_2impl_2codegen_2config_8h.html">grpcpp/impl/codegen/config.h</a>></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="grpcpp_2impl_2codegen_2string__ref_8h.html">grpcpp/impl/codegen/string_ref.h</a>></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="keyword">struct </span>grpc_auth_context;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">struct </span>grpc_auth_property;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">struct </span>grpc_auth_property_iterator;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a3a61e9fd24c9d1cea5eaaabc58525d0e"> 33</a></span> <span class="keyword">class </span>SecureAuthContext;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">typedef</span> std::pair<grpc::string_ref, grpc::string_ref> <a class="code" href="namespacegrpc.html#a3a61e9fd24c9d1cea5eaaabc58525d0e">AuthProperty</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="classgrpc_1_1_auth_property_iterator.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  : <span class="keyword">public</span> std::iterator<std::input_iterator_tag, const AuthProperty> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classgrpc_1_1_auth_property_iterator.html#a91a3a2ce5085a948aac11d7371c13b49">~AuthPropertyIterator</a>();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a>& <a class="code" href="classgrpc_1_1_auth_property_iterator.html#ac4a895110475c25b9bdce9b72eb19cd6">operator++</a>();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a> <a class="code" href="classgrpc_1_1_auth_property_iterator.html#ac4a895110475c25b9bdce9b72eb19cd6">operator++</a>(<span class="keywordtype">int</span>);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html#a15e66ce56801c275502cd60805f68499">operator==</a>(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a>& rhs) <span class="keyword">const</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html#ad6de4a1f1b7685e8f26d110233679f8a">operator!=</a>(<span class="keyword">const</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a>& rhs) <span class="keyword">const</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">const</span> AuthProperty <a class="code" href="classgrpc_1_1_auth_property_iterator.html#a564f39b91f4168c6f660bbd3144f1f0e">operator*</a>();</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classgrpc_1_1_auth_property_iterator.html#a2885e02ba1b9caad818a1bcdf648d949">AuthPropertyIterator</a>();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classgrpc_1_1_auth_property_iterator.html#a2885e02ba1b9caad818a1bcdf648d949">AuthPropertyIterator</a>(<span class="keyword">const</span> grpc_auth_property* property,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> grpc_auth_property_iterator* iter);</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="keyword">private</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classgrpc_1_1_auth_property_iterator.html#a18a70918b1f73cdd22cb263845b78d6d"> 53</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_auth_property_iterator.html#a18a70918b1f73cdd22cb263845b78d6d">SecureAuthContext</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> grpc_auth_property* property_;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// The following items form a grpc_auth_property_iterator.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> grpc_auth_context* ctx_;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">size_t</span> index_;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* name_;</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="l00065"></a><span class="lineno"><a class="line" href="classgrpc_1_1_auth_context.html"> 65</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_auth_context.html">AuthContext</a> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classgrpc_1_1_auth_context.html#a3784c5f4eeab56a8524da29981548464"> 67</a></span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_auth_context.html#a3784c5f4eeab56a8524da29981548464">~AuthContext</a>() {}</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsPeerAuthenticated() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> std::vector<grpc::string_ref> GetPeerIdentity() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> GetPeerIdentityPropertyName() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> std::vector<grpc::string_ref> FindPropertyValues(</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& name) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a> begin() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_auth_property_iterator.html">AuthPropertyIterator</a> end() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddProperty(<span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& key,</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">const</span> <a class="code" href="classgrpc_1_1string__ref.html">grpc::string_ref</a>& value) = 0;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetPeerIdentityPropertyName(<span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& name) = 0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">// namespace grpc</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif // GRPCPP_IMPL_CODEGEN_SECURITY_AUTH_CONTEXT_H</span></div><div class="ttc" id="grpcpp_2impl_2codegen_2config_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2config_8h.html">config.h</a></div></div>
- <div class="ttc" id="namespacegrpc_html_a3a61e9fd24c9d1cea5eaaabc58525d0e"><div class="ttname"><a href="namespacegrpc.html#a3a61e9fd24c9d1cea5eaaabc58525d0e">grpc::AuthProperty</a></div><div class="ttdeci">std::pair< grpc::string_ref, grpc::string_ref > AuthProperty</div><div class="ttdef"><b>Definition:</b> auth_context.h:33</div></div>
- <div class="ttc" id="namespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:35</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_context_html"><div class="ttname"><a href="classgrpc_1_1_auth_context.html">grpc::AuthContext</a></div><div class="ttdoc">Class encapsulating the Authentication Information. </div><div class="ttdef"><b>Definition:</b> auth_context.h:65</div></div>
- <div class="ttc" id="grpcpp_2impl_2codegen_2string__ref_8h_html"><div class="ttname"><a href="grpcpp_2impl_2codegen_2string__ref_8h.html">string_ref.h</a></div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_a15e66ce56801c275502cd60805f68499"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#a15e66ce56801c275502cd60805f68499">grpc::AuthPropertyIterator::operator==</a></div><div class="ttdeci">bool operator==(const AuthPropertyIterator &rhs) const</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_a2885e02ba1b9caad818a1bcdf648d949"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#a2885e02ba1b9caad818a1bcdf648d949">grpc::AuthPropertyIterator::AuthPropertyIterator</a></div><div class="ttdeci">AuthPropertyIterator()</div></div>
- <div class="ttc" id="namespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user provided tag to its associated completion queue upon expiry or cancellation...</div><div class="ttdef"><b>Definition:</b> alarm.h:31</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_a564f39b91f4168c6f660bbd3144f1f0e"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#a564f39b91f4168c6f660bbd3144f1f0e">grpc::AuthPropertyIterator::operator*</a></div><div class="ttdeci">const AuthProperty operator*()</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_context_html_a3784c5f4eeab56a8524da29981548464"><div class="ttname"><a href="classgrpc_1_1_auth_context.html#a3784c5f4eeab56a8524da29981548464">grpc::AuthContext::~AuthContext</a></div><div class="ttdeci">virtual ~AuthContext()</div><div class="ttdef"><b>Definition:</b> auth_context.h:67</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_ad6de4a1f1b7685e8f26d110233679f8a"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#ad6de4a1f1b7685e8f26d110233679f8a">grpc::AuthPropertyIterator::operator!=</a></div><div class="ttdeci">bool operator!=(const AuthPropertyIterator &rhs) const</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_ac4a895110475c25b9bdce9b72eb19cd6"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#ac4a895110475c25b9bdce9b72eb19cd6">grpc::AuthPropertyIterator::operator++</a></div><div class="ttdeci">AuthPropertyIterator & operator++()</div></div>
- <div class="ttc" id="classgrpc_1_1string__ref_html"><div class="ttname"><a href="classgrpc_1_1string__ref.html">grpc::string_ref</a></div><div class="ttdoc">This class is a non owning reference to a string. </div><div class="ttdef"><b>Definition:</b> string_ref.h:41</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html">grpc::AuthPropertyIterator</a></div><div class="ttdef"><b>Definition:</b> auth_context.h:37</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_a91a3a2ce5085a948aac11d7371c13b49"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#a91a3a2ce5085a948aac11d7371c13b49">grpc::AuthPropertyIterator::~AuthPropertyIterator</a></div><div class="ttdeci">~AuthPropertyIterator()</div></div>
- <div class="ttc" id="classgrpc_1_1_auth_property_iterator_html_a18a70918b1f73cdd22cb263845b78d6d"><div class="ttname"><a href="classgrpc_1_1_auth_property_iterator.html#a18a70918b1f73cdd22cb263845b78d6d">grpc::AuthPropertyIterator::SecureAuthContext</a></div><div class="ttdeci">friend class SecureAuthContext</div><div class="ttdef"><b>Definition:</b> auth_context.h:53</div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Tue May 15 2018 17:01:01 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|