grpc__security_8h_source.html 78 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC Core: include/grpc/grpc_security.h Source File</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC Core
  26. &#160;<span id="projectnumber">0.11.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  42. <li class="current"><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="files.html"><span>File&#160;List</span></a></li>
  64. <li><a href="globals.html"><span>Globals</span></a></li>
  65. </ul>
  66. </div>
  67. <!-- window showing the filter options -->
  68. <div id="MSearchSelectWindow"
  69. onmouseover="return searchBox.OnSearchSelectShow()"
  70. onmouseout="return searchBox.OnSearchSelectHide()"
  71. onkeydown="return searchBox.OnSearchSelectKey(event)">
  72. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  73. <!-- iframe showing the search results (closed by default) -->
  74. <div id="MSearchResultsWindow">
  75. <iframe src="javascript:void(0)" frameborder="0"
  76. name="MSearchResults" id="MSearchResults">
  77. </iframe>
  78. </div>
  79. <div id="nav-path" class="navpath">
  80. <ul>
  81. <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li> </ul>
  82. </div>
  83. </div><!-- top -->
  84. <div class="header">
  85. <div class="headertitle">
  86. <div class="title">grpc_security.h</div> </div>
  87. </div><!--header-->
  88. <div class="contents">
  89. <a href="grpc__security_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>&#160;<span class="comment">/*</span></div>
  90. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  91. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015, Google Inc.</span></div>
  92. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * All rights reserved.</span></div>
  93. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
  94. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
  95. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions are</span></div>
  96. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * met:</span></div>
  97. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
  98. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
  99. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
  100. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * * Redistributions in binary form must reproduce the above</span></div>
  101. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div>
  102. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * in the documentation and/or other materials provided with the</span></div>
  103. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * distribution.</span></div>
  104. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div>
  105. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * contributors may be used to endorse or promote products derived from</span></div>
  106. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * this software without specific prior written permission.</span></div>
  107. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> *</span></div>
  108. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
  109. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
  110. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
  111. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
  112. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
  113. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
  114. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
  115. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
  116. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
  117. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
  118. <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
  119. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> *</span></div>
  120. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> */</span></div>
  121. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
  122. <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#ifndef GRPC_GRPC_SECURITY_H</span></div>
  123. <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_GRPC_SECURITY_H</span></div>
  124. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor"></span></div>
  125. <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpc_8h.html">grpc/grpc.h</a>&gt;</span></div>
  126. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="status_8h.html">grpc/status.h</a>&gt;</span></div>
  127. <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
  128. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
  129. <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
  130. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#endif</span></div>
  131. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor"></span></div>
  132. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">/* --- grpc_credentials object. ---</span></div>
  133. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"></span></div>
  134. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> A credentials object represents a way to authenticate a client. */</span></div>
  135. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
  136. <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e"> 48</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> <a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a>;</div>
  137. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
  138. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment">/* Releases a credentials object.</span></div>
  139. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> The creator of the credentials object is responsible for its release. */</span></div>
  140. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#a6c01e107d41e964458fdf701b8b81440">grpc_credentials_release</a>(<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *creds);</div>
  141. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
  142. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment">/* Environment variable that points to the google default application</span></div>
  143. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> credentials json key or refresh token. Used in the</span></div>
  144. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> grpc_google_default_credentials_create function. */</span></div>
  145. <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a3874f70577fc9fe15fd2c4ce68a36ecd"> 57</a></span>&#160;<span class="preprocessor">#define GRPC_GOOGLE_CREDENTIALS_ENV_VAR &quot;GOOGLE_APPLICATION_CREDENTIALS&quot;</span></div>
  146. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="preprocessor"></span></div>
  147. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment">/* Creates default credentials to connect to a google gRPC service.</span></div>
  148. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> WARNING: Do NOT use this credentials to connect to a non-google service as</span></div>
  149. <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> this could result in an oauth2 token leak. */</span></div>
  150. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#a5e3fb8f208c302245a1392c7ef16d170">grpc_google_default_credentials_create</a>(<span class="keywordtype">void</span>);</div>
  151. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
  152. <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment">/* Environment variable that points to the default SSL roots file. This file</span></div>
  153. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> must be a PEM encoded file with all the roots such as the one that can be</span></div>
  154. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> downloaded from https://pki.google.com/roots.pem. */</span></div>
  155. <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a48565da473b7c82fa2453798f620fd59"> 67</a></span>&#160;<span class="preprocessor">#define GRPC_DEFAULT_SSL_ROOTS_FILE_PATH_ENV_VAR \</span></div>
  156. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="preprocessor"> &quot;GRPC_DEFAULT_SSL_ROOTS_FILE_PATH&quot;</span></div>
  157. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor"></span></div>
  158. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">/* Object that holds a private key / certificate chain pair in PEM format. */</span></div>
  159. <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="structgrpc__ssl__pem__key__cert__pair.html"> 71</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
  160. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">/* private_key is the NULL-terminated string containing the PEM encoding of</span></div>
  161. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="comment"> the client&#39;s private key. */</span></div>
  162. <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structgrpc__ssl__pem__key__cert__pair.html#a2d4e3bdbc59d906bc9ca8b873120fd72"> 74</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgrpc__ssl__pem__key__cert__pair.html#a2d4e3bdbc59d906bc9ca8b873120fd72">private_key</a>;</div>
  163. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
  164. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">/* cert_chain is the NULL-terminated string containing the PEM encoding of</span></div>
  165. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"> the client&#39;s certificate chain. */</span></div>
  166. <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structgrpc__ssl__pem__key__cert__pair.html#a483c3601705853f48dfbc8ee66d5e656"> 78</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgrpc__ssl__pem__key__cert__pair.html#a483c3601705853f48dfbc8ee66d5e656">cert_chain</a>;</div>
  167. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;} <a class="code" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a>;</div>
  168. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div>
  169. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;<span class="comment">/* Creates an SSL credentials object.</span></div>
  170. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> - pem_roots_cert is the NULL-terminated string containing the PEM encoding</span></div>
  171. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> of the server root certificates. If this parameter is NULL, the</span></div>
  172. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> implementation will first try to dereference the file pointed by the</span></div>
  173. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails,</span></div>
  174. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> get the roots from a well-known place on disk (in the grpc install</span></div>
  175. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> directory).</span></div>
  176. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"> - pem_key_cert_pair is a pointer on the object containing client&#39;s private</span></div>
  177. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> key and certificate chain. This parameter can be NULL if the client does</span></div>
  178. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"> not have such a key/cert pair. */</span></div>
  179. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#a2e1970bc7f3d1fd221161adc0a56ff32">grpc_ssl_credentials_create</a>(</div>
  180. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pem_root_certs, <a class="code" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pair,</div>
  181. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">void</span> *reserved);</div>
  182. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div>
  183. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment">/* Creates a composite credentials object. */</span></div>
  184. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#a60bbfa5d24aaa4f9075c6045181e9ddd">grpc_composite_credentials_create</a>(<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *creds1,</div>
  185. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *creds2,</div>
  186. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">void</span> *reserved);</div>
  187. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
  188. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment">/* Creates a compute engine credentials object for connecting to Google.</span></div>
  189. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"> WARNING: Do NOT use this credentials to connect to a non-google service as</span></div>
  190. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> this could result in an oauth2 token leak. */</span></div>
  191. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#aa186fa3ea6c3a5a551d1a8fa9ddc9372">grpc_google_compute_engine_credentials_create</a>(<span class="keywordtype">void</span> *reserved);</div>
  192. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div>
  193. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <a class="code" href="structgpr__timespec.html">gpr_timespec</a> <a class="code" href="grpc__security_8h.html#a6112c5b60b1c0197531f80fdc56f7772">grpc_max_auth_token_lifetime</a>;</div>
  194. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
  195. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment">/* Creates a JWT credentials object. May return NULL if the input is invalid.</span></div>
  196. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> - json_key is the JSON key string containing the client&#39;s private key.</span></div>
  197. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> - token_lifetime is the lifetime of each Json Web Token (JWT) created with</span></div>
  198. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> this credentials. It should not exceed grpc_max_auth_token_lifetime or</span></div>
  199. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> will be cropped to this value. */</span></div>
  200. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#ab471a46dec4eb4e1c4ce986f237dbf66">grpc_service_account_jwt_access_credentials_create</a>(</div>
  201. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *json_key, <a class="code" href="structgpr__timespec.html">gpr_timespec</a> token_lifetime, <span class="keywordtype">void</span> *reserved);</div>
  202. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div>
  203. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;<span class="comment">/* Creates an Oauth2 Refresh Token credentials object for connecting to Google.</span></div>
  204. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="comment"> May return NULL if the input is invalid.</span></div>
  205. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160;<span class="comment"> WARNING: Do NOT use this credentials to connect to a non-google service as</span></div>
  206. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"> this could result in an oauth2 token leak.</span></div>
  207. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> - json_refresh_token is the JSON string containing the refresh token itself</span></div>
  208. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> along with a client_id and client_secret. */</span></div>
  209. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#ae44d54a3099c9c8499764706e1c69919">grpc_google_refresh_token_credentials_create</a>(</div>
  210. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *json_refresh_token, <span class="keywordtype">void</span> *reserved);</div>
  211. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;</div>
  212. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;<span class="comment">/* Creates an Oauth2 Access Token credentials with an access token that was</span></div>
  213. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="comment"> aquired by an out of band mechanism. */</span></div>
  214. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#a56df677a9fafe181dca4eb3280228d0b">grpc_access_token_credentials_create</a>(</div>
  215. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *access_token, <span class="keywordtype">void</span> *reserved);</div>
  216. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div>
  217. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment">/* Creates an IAM credentials object for connecting to Google. */</span></div>
  218. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *<a class="code" href="grpc__security_8h.html#a672ef3a65799cabdd63b9e5cb7592446">grpc_google_iam_credentials_create</a>(</div>
  219. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *authorization_token, <span class="keyword">const</span> <span class="keywordtype">char</span> *authority_selector,</div>
  220. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordtype">void</span> *reserved);</div>
  221. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div>
  222. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment">/* --- Secure channel creation. --- */</span></div>
  223. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div>
  224. <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160;<span class="comment">/* Creates a secure channel using the passed-in credentials. */</span></div>
  225. <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;<a class="code" href="grpc_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a> *<a class="code" href="grpc__security_8h.html#a29bf879141d7c0ca7eb86e0e26d585af">grpc_secure_channel_create</a>(<a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *creds,</div>
  226. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *target,</div>
  227. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc__channel__args.html">grpc_channel_args</a> *args,</div>
  228. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordtype">void</span> *reserved);</div>
  229. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;</div>
  230. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;<span class="comment">/* --- grpc_server_credentials object. ---</span></div>
  231. <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;<span class="comment"></span></div>
  232. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="comment"> A server credentials object represents a way to authenticate a server. */</span></div>
  233. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
  234. <div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc"> 146</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> <a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a>;</div>
  235. <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;</div>
  236. <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment">/* Releases a server_credentials object.</span></div>
  237. <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="comment"> The creator of the server_credentials object is responsible for its release.</span></div>
  238. <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment"> */</span></div>
  239. <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#a6e9f9320f4f8d2d534d04ed642f032ea">grpc_server_credentials_release</a>(<a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds);</div>
  240. <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div>
  241. <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="comment">/* Creates an SSL server_credentials object.</span></div>
  242. <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="comment"> - pem_roots_cert is the NULL-terminated string containing the PEM encoding of</span></div>
  243. <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"> the client root certificates. This parameter may be NULL if the server does</span></div>
  244. <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"> not want the client to be authenticated with SSL.</span></div>
  245. <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> - pem_key_cert_pairs is an array private key / certificate chains of the</span></div>
  246. <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment"> server. This parameter cannot be NULL.</span></div>
  247. <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> - num_key_cert_pairs indicates the number of items in the private_key_files</span></div>
  248. <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> and cert_chain_files parameters. It should be at least 1.</span></div>
  249. <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="comment"> - force_client_auth, if set to non-zero will force the client to authenticate</span></div>
  250. <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment"> with an SSL cert. Note that this option is ignored if pem_root_certs is</span></div>
  251. <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"> NULL. */</span></div>
  252. <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *<a class="code" href="grpc__security_8h.html#aa79cf1d662f3e26bbc7dc34192dba500">grpc_ssl_server_credentials_create</a>(</div>
  253. <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *pem_root_certs, <a class="code" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pairs,</div>
  254. <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordtype">size_t</span> num_key_cert_pairs, <span class="keywordtype">int</span> force_client_auth, <span class="keywordtype">void</span> *reserved);</div>
  255. <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;</div>
  256. <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160;<span class="comment">/* --- Server-side secure ports. --- */</span></div>
  257. <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;</div>
  258. <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;<span class="comment">/* Add a HTTP2 over an encrypted link over tcp listener.</span></div>
  259. <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;<span class="comment"> Returns bound port number on success, 0 on failure.</span></div>
  260. <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="comment"> REQUIRES: server not started */</span></div>
  261. <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="keywordtype">int</span> <a class="code" href="grpc__security_8h.html#a5d0db200d00b62b79138472dc9b1fe59">grpc_server_add_secure_http2_port</a>(<a class="code" href="grpc_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> *server, <span class="keyword">const</span> <span class="keywordtype">char</span> *addr,</div>
  262. <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; <a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds);</div>
  263. <div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;</div>
  264. <div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment">/* --- Call specific credentials. --- */</span></div>
  265. <div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;</div>
  266. <div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment">/* Sets a credentials to a call. Can only be called on the client side before</span></div>
  267. <div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"> grpc_call_start_batch. */</span></div>
  268. <div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<a class="code" href="grpc_8h.html#a0d5a8bdd6d53d209cacea4b6fa5d785b">grpc_call_error</a> <a class="code" href="grpc__security_8h.html#a56de54ae2563e67e236c10e8fa419f60">grpc_call_set_credentials</a>(<a class="code" href="grpc_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call,</div>
  269. <div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <a class="code" href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a> *creds);</div>
  270. <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;</div>
  271. <div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="comment">/* --- Authentication Context. --- */</span></div>
  272. <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;</div>
  273. <div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#aff82fdff9e7c40c4dd4bdc650e38e25a"> 185</a></span>&#160;<span class="preprocessor">#define GRPC_TRANSPORT_SECURITY_TYPE_PROPERTY_NAME &quot;transport_security_type&quot;</span></div>
  274. <div class="line"><a name="l00186"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a35a35c597b7090b8ac7e2d854c9bcc7a"> 186</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_SSL_TRANSPORT_SECURITY_TYPE &quot;ssl&quot;</span></div>
  275. <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="preprocessor"></span></div>
  276. <div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#afee5e0fade6e0af1954529f1f08afe0c"> 188</a></span>&#160;<span class="preprocessor">#define GRPC_X509_CN_PROPERTY_NAME &quot;x509_common_name&quot;</span></div>
  277. <div class="line"><a name="l00189"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a1412421653b7999544296f56025a0f36"> 189</a></span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_X509_SAN_PROPERTY_NAME &quot;x509_subject_alternative_name&quot;</span></div>
  278. <div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<span class="preprocessor"></span></div>
  279. <div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553"> 191</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>;</div>
  280. <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;</div>
  281. <div class="line"><a name="l00193"></a><span class="lineno"><a class="line" href="structgrpc__auth__property__iterator.html"> 193</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> {</div>
  282. <div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="structgrpc__auth__property__iterator.html#a971904d29fa6f6ca6a853d078cae2f58"> 194</a></span>&#160; <span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *<a class="code" href="structgrpc__auth__property__iterator.html#a971904d29fa6f6ca6a853d078cae2f58">ctx</a>;</div>
  283. <div class="line"><a name="l00195"></a><span class="lineno"><a class="line" href="structgrpc__auth__property__iterator.html#ac2b2a0501f097562a6d8856e3da5e7e6"> 195</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structgrpc__auth__property__iterator.html#ac2b2a0501f097562a6d8856e3da5e7e6">index</a>;</div>
  284. <div class="line"><a name="l00196"></a><span class="lineno"><a class="line" href="structgrpc__auth__property__iterator.html#a3838efa5eb622c7e2c071497132b1cc7"> 196</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structgrpc__auth__property__iterator.html#a3838efa5eb622c7e2c071497132b1cc7">name</a>;</div>
  285. <div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;} <a class="code" href="grpc__security_8h.html#a26981fdcb987d885b25d34c7dc66e4cf">grpc_auth_property_iterator</a>;</div>
  286. <div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;</div>
  287. <div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="comment">/* value, if not NULL, is guaranteed to be NULL terminated. */</span></div>
  288. <div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="structgrpc__auth__property.html"> 200</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structgrpc__auth__property.html">grpc_auth_property</a> {</div>
  289. <div class="line"><a name="l00201"></a><span class="lineno"><a class="line" href="structgrpc__auth__property.html#a83fb830ffe7321265dc9b628e9246a27"> 201</a></span>&#160; <span class="keywordtype">char</span> *<a class="code" href="structgrpc__auth__property.html#a83fb830ffe7321265dc9b628e9246a27">name</a>;</div>
  290. <div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="structgrpc__auth__property.html#af44f45ac4673a0298d00354c47d0907e"> 202</a></span>&#160; <span class="keywordtype">char</span> *<a class="code" href="structgrpc__auth__property.html#af44f45ac4673a0298d00354c47d0907e">value</a>;</div>
  291. <div class="line"><a name="l00203"></a><span class="lineno"><a class="line" href="structgrpc__auth__property.html#a07359a178c29240cab42a89ef047b101"> 203</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structgrpc__auth__property.html#a07359a178c29240cab42a89ef047b101">value_length</a>;</div>
  292. <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;} <a class="code" href="grpc__security_8h.html#a010fe7d27deaa2ea50b765b48dbad429">grpc_auth_property</a>;</div>
  293. <div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;</div>
  294. <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment">/* Returns NULL when the iterator is at the end. */</span></div>
  295. <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="keyword">const</span> <a class="code" href="structgrpc__auth__property.html">grpc_auth_property</a> *<a class="code" href="grpc__security_8h.html#ac20e3890d5e5e0de6ae6b5cb57cae1ae">grpc_auth_property_iterator_next</a>(</div>
  296. <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160; <a class="code" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> *it);</div>
  297. <div class="line"><a name="l00209"></a><span class="lineno"> 209</span>&#160;</div>
  298. <div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160;<span class="comment">/* Iterates over the auth context. */</span></div>
  299. <div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160;<a class="code" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> <a class="code" href="grpc__security_8h.html#aaad9fed074f7aebed63ed075bb6ff780">grpc_auth_context_property_iterator</a>(</div>
  300. <div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; <span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx);</div>
  301. <div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;</div>
  302. <div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;<span class="comment">/* Gets the peer identity. Returns an empty iterator (first _next will return</span></div>
  303. <div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160;<span class="comment"> NULL) if the peer is not authenticated. */</span></div>
  304. <div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160;<a class="code" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> <a class="code" href="grpc__security_8h.html#a144c6f3a56c8592489b3978e0c5caced">grpc_auth_context_peer_identity</a>(</div>
  305. <div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160; <span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx);</div>
  306. <div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;</div>
  307. <div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160;<span class="comment">/* Finds a property in the context. May return an empty iterator (first _next</span></div>
  308. <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;<span class="comment"> will return NULL) if no property with this name was found in the context. */</span></div>
  309. <div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160;<a class="code" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> <a class="code" href="grpc__security_8h.html#a5298ac64614986581fc314f63fa9afd7">grpc_auth_context_find_properties_by_name</a>(</div>
  310. <div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160; <span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
  311. <div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160;</div>
  312. <div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160;<span class="comment">/* Gets the name of the property that indicates the peer identity. Will return</span></div>
  313. <div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160;<span class="comment"> NULL if the peer is not authenticated. */</span></div>
  314. <div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="grpc__security_8h.html#ac05022ccd5b972ba089950437727ff23">grpc_auth_context_peer_identity_property_name</a>(</div>
  315. <div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx);</div>
  316. <div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160;</div>
  317. <div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160;<span class="comment">/* Returns 1 if the peer is authenticated, 0 otherwise. */</span></div>
  318. <div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160;<span class="keywordtype">int</span> <a class="code" href="grpc__security_8h.html#af33fe6681dedb389edbf708020680093">grpc_auth_context_peer_is_authenticated</a>(<span class="keyword">const</span> <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx);</div>
  319. <div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160;</div>
  320. <div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160;<span class="comment">/* Gets the auth context from the call. Caller needs to call</span></div>
  321. <div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160;<span class="comment"> grpc_auth_context_release on the returned context. */</span></div>
  322. <div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160;<a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *<a class="code" href="grpc__security_8h.html#a0b439e6d2875c8b5e2e901a959f6a2fe">grpc_call_auth_context</a>(<a class="code" href="grpc_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call);</div>
  323. <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160;</div>
  324. <div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="comment">/* Releases the auth context returned from grpc_call_auth_context. */</span></div>
  325. <div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#a2eea99f76030b21ad58afdf615f4d2b9">grpc_auth_context_release</a>(<a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *context);</div>
  326. <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160;</div>
  327. <div class="line"><a name="l00239"></a><span class="lineno"> 239</span>&#160;<span class="comment">/* --</span></div>
  328. <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160;<span class="comment"> The following auth context methods should only be called by a server metadata</span></div>
  329. <div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160;<span class="comment"> processor to set properties extracted from auth metadata.</span></div>
  330. <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;<span class="comment"> -- */</span></div>
  331. <div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;</div>
  332. <div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160;<span class="comment">/* Add a property. */</span></div>
  333. <div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#a6c64d6535e657a200f425be4441eaf20">grpc_auth_context_add_property</a>(<a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div>
  334. <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keywordtype">size_t</span> value_length);</div>
  335. <div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;</div>
  336. <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;<span class="comment">/* Add a C string property. */</span></div>
  337. <div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#a7cde3a0627117899b2c7a412719a92c3">grpc_auth_context_add_cstring_property</a>(<a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx,</div>
  338. <div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div>
  339. <div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
  340. <div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160;</div>
  341. <div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160;<span class="comment">/* Sets the property name. Returns 1 if successful or 0 in case of failure</span></div>
  342. <div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;<span class="comment"> (which means that no property with this name exists). */</span></div>
  343. <div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160;<span class="keywordtype">int</span> <a class="code" href="grpc__security_8h.html#a5891cb5ed3b06389711892a2262542fa">grpc_auth_context_set_peer_identity_property_name</a>(<a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx,</div>
  344. <div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
  345. <div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160;</div>
  346. <div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;<span class="comment">/* --- Auth Metadata Processing --- */</span></div>
  347. <div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160;</div>
  348. <div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="comment">/* Callback function that is called when the metadata processing is done.</span></div>
  349. <div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="comment"> - Consumed metadata will be removed from the set of metadata available on the</span></div>
  350. <div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="comment"> call. consumed_md may be NULL if no metadata has been consumed.</span></div>
  351. <div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment"> - Response metadata will be set on the response. response_md may be NULL.</span></div>
  352. <div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="comment"> - status is GRPC_STATUS_OK for success or a specific status for an error.</span></div>
  353. <div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment"> Common error status for auth metadata processing is either</span></div>
  354. <div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment"> GRPC_STATUS_UNAUTHENTICATED in case of an authentication failure or</span></div>
  355. <div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;<span class="comment"> GRPC_STATUS PERMISSION_DENIED in case of an authorization failure.</span></div>
  356. <div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;<span class="comment"> - error_details gives details about the error. May be NULL. */</span></div>
  357. <div class="line"><a name="l00269"></a><span class="lineno"><a class="line" href="grpc__security_8h.html#a54decefff49649afe0c5a3056d0734f1"> 269</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="grpc__security_8h.html#a54decefff49649afe0c5a3056d0734f1">grpc_process_auth_metadata_done_cb</a>)(</div>
  358. <div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160; <span class="keywordtype">void</span> *user_data, <span class="keyword">const</span> <a class="code" href="structgrpc__metadata.html">grpc_metadata</a> *consumed_md, <span class="keywordtype">size_t</span> num_consumed_md,</div>
  359. <div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc__metadata.html">grpc_metadata</a> *response_md, <span class="keywordtype">size_t</span> num_response_md,</div>
  360. <div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160; <a class="code" href="status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> status, <span class="keyword">const</span> <span class="keywordtype">char</span> *error_details);</div>
  361. <div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;</div>
  362. <div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<span class="comment">/* Pluggable server-side metadata processor object. */</span></div>
  363. <div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="structgrpc__auth__metadata__processor.html"> 275</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
  364. <div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160; <span class="comment">/* The context object is read/write: it contains the properties of the</span></div>
  365. <div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="comment"> channel peer and it is the job of the process function to augment it with</span></div>
  366. <div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="comment"> properties derived from the passed-in metadata.</span></div>
  367. <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;<span class="comment"> The lifetime of these objects is guaranteed until cb is invoked. */</span></div>
  368. <div class="line"><a name="l00280"></a><span class="lineno"><a class="line" href="structgrpc__auth__metadata__processor.html#a600fce6862323bb4dc4a3a1b2f844c68"> 280</a></span>&#160; void (*process)(<span class="keywordtype">void</span> *state, <a class="code" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *context,</div>
  369. <div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160; <span class="keyword">const</span> <a class="code" href="structgrpc__metadata.html">grpc_metadata</a> *md, <span class="keywordtype">size_t</span> num_md,</div>
  370. <div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160; <a class="code" href="grpc__security_8h.html#a54decefff49649afe0c5a3056d0734f1">grpc_process_auth_metadata_done_cb</a> cb, <span class="keywordtype">void</span> *user_data);</div>
  371. <div class="line"><a name="l00283"></a><span class="lineno"><a class="line" href="structgrpc__auth__metadata__processor.html#a08bf8229b6032ddff4456596f765fdab"> 283</a></span>&#160; void (*destroy)(<span class="keywordtype">void</span> *state);</div>
  372. <div class="line"><a name="l00284"></a><span class="lineno"><a class="line" href="structgrpc__auth__metadata__processor.html#af85de1293dfd5e846339d5ef4b7b41dc"> 284</a></span>&#160; <span class="keywordtype">void</span> *<a class="code" href="structgrpc__auth__metadata__processor.html#af85de1293dfd5e846339d5ef4b7b41dc">state</a>;</div>
  373. <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;} <a class="code" href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a>;</div>
  374. <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;</div>
  375. <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="keywordtype">void</span> <a class="code" href="grpc__security_8h.html#ab6af590e826340f94cee5d8aaab109bc">grpc_server_credentials_set_auth_metadata_processor</a>(</div>
  376. <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160; <a class="code" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds, <a class="code" href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a> processor);</div>
  377. <div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;</div>
  378. <div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
  379. <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;<span class="preprocessor"></span>}</div>
  380. <div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;<span class="preprocessor">#endif</span></div>
  381. <div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<span class="preprocessor"></span></div>
  382. <div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_GRPC_SECURITY_H */</span><span class="preprocessor"></span></div>
  383. <div class="ttc" id="grpc__security_8h_html_a5891cb5ed3b06389711892a2262542fa"><div class="ttname"><a href="grpc__security_8h.html#a5891cb5ed3b06389711892a2262542fa">grpc_auth_context_set_peer_identity_property_name</a></div><div class="ttdeci">int grpc_auth_context_set_peer_identity_property_name(grpc_auth_context *ctx, const char *name)</div></div>
  384. <div class="ttc" id="grpc__security_8h_html_a54decefff49649afe0c5a3056d0734f1"><div class="ttname"><a href="grpc__security_8h.html#a54decefff49649afe0c5a3056d0734f1">grpc_process_auth_metadata_done_cb</a></div><div class="ttdeci">void(* grpc_process_auth_metadata_done_cb)(void *user_data, const grpc_metadata *consumed_md, size_t num_consumed_md, const grpc_metadata *response_md, size_t num_response_md, grpc_status_code status, const char *error_details)</div><div class="ttdef"><b>Definition:</b> grpc_security.h:269</div></div>
  385. <div class="ttc" id="grpc__security_8h_html_ae44d54a3099c9c8499764706e1c69919"><div class="ttname"><a href="grpc__security_8h.html#ae44d54a3099c9c8499764706e1c69919">grpc_google_refresh_token_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_google_refresh_token_credentials_create(const char *json_refresh_token, void *reserved)</div></div>
  386. <div class="ttc" id="grpc__security_8h_html_a5d0db200d00b62b79138472dc9b1fe59"><div class="ttname"><a href="grpc__security_8h.html#a5d0db200d00b62b79138472dc9b1fe59">grpc_server_add_secure_http2_port</a></div><div class="ttdeci">int grpc_server_add_secure_http2_port(grpc_server *server, const char *addr, grpc_server_credentials *creds)</div></div>
  387. <div class="ttc" id="structgrpc__auth__property_html_a07359a178c29240cab42a89ef047b101"><div class="ttname"><a href="structgrpc__auth__property.html#a07359a178c29240cab42a89ef047b101">grpc_auth_property::value_length</a></div><div class="ttdeci">size_t value_length</div><div class="ttdef"><b>Definition:</b> grpc_security.h:203</div></div>
  388. <div class="ttc" id="grpc__security_8h_html_aa724192e56fdc03827846f16752deccc"><div class="ttname"><a href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a></div><div class="ttdeci">struct grpc_server_credentials grpc_server_credentials</div><div class="ttdef"><b>Definition:</b> grpc_security.h:146</div></div>
  389. <div class="ttc" id="grpc__security_8h_html_a56de54ae2563e67e236c10e8fa419f60"><div class="ttname"><a href="grpc__security_8h.html#a56de54ae2563e67e236c10e8fa419f60">grpc_call_set_credentials</a></div><div class="ttdeci">grpc_call_error grpc_call_set_credentials(grpc_call *call, grpc_credentials *creds)</div></div>
  390. <div class="ttc" id="grpc__security_8h_html_a6c01e107d41e964458fdf701b8b81440"><div class="ttname"><a href="grpc__security_8h.html#a6c01e107d41e964458fdf701b8b81440">grpc_credentials_release</a></div><div class="ttdeci">void grpc_credentials_release(grpc_credentials *creds)</div></div>
  391. <div class="ttc" id="structgrpc__channel__args_html"><div class="ttname"><a href="structgrpc__channel__args.html">grpc_channel_args</a></div><div class="ttdoc">An array of arguments that can be passed around. </div><div class="ttdef"><b>Definition:</b> grpc.h:111</div></div>
  392. <div class="ttc" id="structgrpc__auth__property_html_af44f45ac4673a0298d00354c47d0907e"><div class="ttname"><a href="structgrpc__auth__property.html#af44f45ac4673a0298d00354c47d0907e">grpc_auth_property::value</a></div><div class="ttdeci">char * value</div><div class="ttdef"><b>Definition:</b> grpc_security.h:202</div></div>
  393. <div class="ttc" id="grpc_8h_html_a2bbbaad8f7a806f6c834b68c5dd916d8"><div class="ttname"><a href="grpc_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a></div><div class="ttdeci">struct grpc_server grpc_server</div><div class="ttdoc">A server listens to some port and responds to request calls. </div><div class="ttdef"><b>Definition:</b> grpc.h:63</div></div>
  394. <div class="ttc" id="grpc__security_8h_html_a6112c5b60b1c0197531f80fdc56f7772"><div class="ttname"><a href="grpc__security_8h.html#a6112c5b60b1c0197531f80fdc56f7772">grpc_max_auth_token_lifetime</a></div><div class="ttdeci">const gpr_timespec grpc_max_auth_token_lifetime</div></div>
  395. <div class="ttc" id="grpc__security_8h_html_ab6af590e826340f94cee5d8aaab109bc"><div class="ttname"><a href="grpc__security_8h.html#ab6af590e826340f94cee5d8aaab109bc">grpc_server_credentials_set_auth_metadata_processor</a></div><div class="ttdeci">void grpc_server_credentials_set_auth_metadata_processor(grpc_server_credentials *creds, grpc_auth_metadata_processor processor)</div></div>
  396. <div class="ttc" id="grpc__security_8h_html_a5e3fb8f208c302245a1392c7ef16d170"><div class="ttname"><a href="grpc__security_8h.html#a5e3fb8f208c302245a1392c7ef16d170">grpc_google_default_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_google_default_credentials_create(void)</div></div>
  397. <div class="ttc" id="grpc__security_8h_html_a60bbfa5d24aaa4f9075c6045181e9ddd"><div class="ttname"><a href="grpc__security_8h.html#a60bbfa5d24aaa4f9075c6045181e9ddd">grpc_composite_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_composite_credentials_create(grpc_credentials *creds1, grpc_credentials *creds2, void *reserved)</div></div>
  398. <div class="ttc" id="grpc__security_8h_html_a6c64d6535e657a200f425be4441eaf20"><div class="ttname"><a href="grpc__security_8h.html#a6c64d6535e657a200f425be4441eaf20">grpc_auth_context_add_property</a></div><div class="ttdeci">void grpc_auth_context_add_property(grpc_auth_context *ctx, const char *name, const char *value, size_t value_length)</div></div>
  399. <div class="ttc" id="structgrpc__ssl__pem__key__cert__pair_html_a2d4e3bdbc59d906bc9ca8b873120fd72"><div class="ttname"><a href="structgrpc__ssl__pem__key__cert__pair.html#a2d4e3bdbc59d906bc9ca8b873120fd72">grpc_ssl_pem_key_cert_pair::private_key</a></div><div class="ttdeci">const char * private_key</div><div class="ttdef"><b>Definition:</b> grpc_security.h:74</div></div>
  400. <div class="ttc" id="grpc__security_8h_html_ac20e3890d5e5e0de6ae6b5cb57cae1ae"><div class="ttname"><a href="grpc__security_8h.html#ac20e3890d5e5e0de6ae6b5cb57cae1ae">grpc_auth_property_iterator_next</a></div><div class="ttdeci">const grpc_auth_property * grpc_auth_property_iterator_next(grpc_auth_property_iterator *it)</div></div>
  401. <div class="ttc" id="structgrpc__auth__metadata__processor_html_af85de1293dfd5e846339d5ef4b7b41dc"><div class="ttname"><a href="structgrpc__auth__metadata__processor.html#af85de1293dfd5e846339d5ef4b7b41dc">grpc_auth_metadata_processor::state</a></div><div class="ttdeci">void * state</div><div class="ttdef"><b>Definition:</b> grpc_security.h:284</div></div>
  402. <div class="ttc" id="grpc__security_8h_html_ab471a46dec4eb4e1c4ce986f237dbf66"><div class="ttname"><a href="grpc__security_8h.html#ab471a46dec4eb4e1c4ce986f237dbf66">grpc_service_account_jwt_access_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_service_account_jwt_access_credentials_create(const char *json_key, gpr_timespec token_lifetime, void *reserved)</div></div>
  403. <div class="ttc" id="grpc_8h_html_a122f8f4f0a585396d993d9b55848f222"><div class="ttname"><a href="grpc_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a></div><div class="ttdeci">struct grpc_call grpc_call</div><div class="ttdoc">A Call represents an RPC. </div><div class="ttdef"><b>Definition:</b> grpc.h:68</div></div>
  404. <div class="ttc" id="structgrpc__auth__property_html_a83fb830ffe7321265dc9b628e9246a27"><div class="ttname"><a href="structgrpc__auth__property.html#a83fb830ffe7321265dc9b628e9246a27">grpc_auth_property::name</a></div><div class="ttdeci">char * name</div><div class="ttdef"><b>Definition:</b> grpc_security.h:201</div></div>
  405. <div class="ttc" id="grpc__security_8h_html_a2e1970bc7f3d1fd221161adc0a56ff32"><div class="ttname"><a href="grpc__security_8h.html#a2e1970bc7f3d1fd221161adc0a56ff32">grpc_ssl_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_ssl_credentials_create(const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pair, void *reserved)</div></div>
  406. <div class="ttc" id="grpc__security_8h_html_a17768c857575e4500cdd12bb94d3f33e"><div class="ttname"><a href="grpc__security_8h.html#a17768c857575e4500cdd12bb94d3f33e">grpc_credentials</a></div><div class="ttdeci">struct grpc_credentials grpc_credentials</div><div class="ttdef"><b>Definition:</b> grpc_security.h:48</div></div>
  407. <div class="ttc" id="structgrpc__auth__property__iterator_html_a971904d29fa6f6ca6a853d078cae2f58"><div class="ttname"><a href="structgrpc__auth__property__iterator.html#a971904d29fa6f6ca6a853d078cae2f58">grpc_auth_property_iterator::ctx</a></div><div class="ttdeci">const grpc_auth_context * ctx</div><div class="ttdef"><b>Definition:</b> grpc_security.h:194</div></div>
  408. <div class="ttc" id="grpc__security_8h_html_ac05022ccd5b972ba089950437727ff23"><div class="ttname"><a href="grpc__security_8h.html#ac05022ccd5b972ba089950437727ff23">grpc_auth_context_peer_identity_property_name</a></div><div class="ttdeci">const char * grpc_auth_context_peer_identity_property_name(const grpc_auth_context *ctx)</div></div>
  409. <div class="ttc" id="grpc__security_8h_html_af33fe6681dedb389edbf708020680093"><div class="ttname"><a href="grpc__security_8h.html#af33fe6681dedb389edbf708020680093">grpc_auth_context_peer_is_authenticated</a></div><div class="ttdeci">int grpc_auth_context_peer_is_authenticated(const grpc_auth_context *ctx)</div></div>
  410. <div class="ttc" id="structgrpc__auth__property__iterator_html_a3838efa5eb622c7e2c071497132b1cc7"><div class="ttname"><a href="structgrpc__auth__property__iterator.html#a3838efa5eb622c7e2c071497132b1cc7">grpc_auth_property_iterator::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition:</b> grpc_security.h:196</div></div>
  411. <div class="ttc" id="grpc_8h_html_a0d5a8bdd6d53d209cacea4b6fa5d785b"><div class="ttname"><a href="grpc_8h.html#a0d5a8bdd6d53d209cacea4b6fa5d785b">grpc_call_error</a></div><div class="ttdeci">grpc_call_error</div><div class="ttdoc">Result of a grpc call. </div><div class="ttdef"><b>Definition:</b> grpc.h:162</div></div>
  412. <div class="ttc" id="structgrpc__auth__property__iterator_html_ac2b2a0501f097562a6d8856e3da5e7e6"><div class="ttname"><a href="structgrpc__auth__property__iterator.html#ac2b2a0501f097562a6d8856e3da5e7e6">grpc_auth_property_iterator::index</a></div><div class="ttdeci">size_t index</div><div class="ttdef"><b>Definition:</b> grpc_security.h:195</div></div>
  413. <div class="ttc" id="structgrpc__auth__property__iterator_html"><div class="ttname"><a href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a></div><div class="ttdef"><b>Definition:</b> grpc_security.h:193</div></div>
  414. <div class="ttc" id="grpc__security_8h_html_a7cde3a0627117899b2c7a412719a92c3"><div class="ttname"><a href="grpc__security_8h.html#a7cde3a0627117899b2c7a412719a92c3">grpc_auth_context_add_cstring_property</a></div><div class="ttdeci">void grpc_auth_context_add_cstring_property(grpc_auth_context *ctx, const char *name, const char *value)</div></div>
  415. <div class="ttc" id="grpc_8h_html_a432bfa6b9f6603643cdf9de8804c254e"><div class="ttname"><a href="grpc_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a></div><div class="ttdeci">struct grpc_channel grpc_channel</div><div class="ttdoc">The Channel interface allows creation of Call objects. </div><div class="ttdef"><b>Definition:</b> grpc.h:60</div></div>
  416. <div class="ttc" id="structgrpc__ssl__pem__key__cert__pair_html"><div class="ttname"><a href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a></div><div class="ttdef"><b>Definition:</b> grpc_security.h:71</div></div>
  417. <div class="ttc" id="structgrpc__metadata_html"><div class="ttname"><a href="structgrpc__metadata.html">grpc_metadata</a></div><div class="ttdoc">A single metadata element. </div><div class="ttdef"><b>Definition:</b> grpc.h:207</div></div>
  418. <div class="ttc" id="grpc__security_8h_html_aa13f0724cb7ff99995d7f0881c01d553"><div class="ttname"><a href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a></div><div class="ttdeci">struct grpc_auth_context grpc_auth_context</div><div class="ttdef"><b>Definition:</b> grpc_security.h:191</div></div>
  419. <div class="ttc" id="grpc__security_8h_html_a26981fdcb987d885b25d34c7dc66e4cf"><div class="ttname"><a href="grpc__security_8h.html#a26981fdcb987d885b25d34c7dc66e4cf">grpc_auth_property_iterator</a></div><div class="ttdeci">struct grpc_auth_property_iterator grpc_auth_property_iterator</div></div>
  420. <div class="ttc" id="structgrpc__ssl__pem__key__cert__pair_html_a483c3601705853f48dfbc8ee66d5e656"><div class="ttname"><a href="structgrpc__ssl__pem__key__cert__pair.html#a483c3601705853f48dfbc8ee66d5e656">grpc_ssl_pem_key_cert_pair::cert_chain</a></div><div class="ttdeci">const char * cert_chain</div><div class="ttdef"><b>Definition:</b> grpc_security.h:78</div></div>
  421. <div class="ttc" id="grpc__security_8h_html_a144c6f3a56c8592489b3978e0c5caced"><div class="ttname"><a href="grpc__security_8h.html#a144c6f3a56c8592489b3978e0c5caced">grpc_auth_context_peer_identity</a></div><div class="ttdeci">grpc_auth_property_iterator grpc_auth_context_peer_identity(const grpc_auth_context *ctx)</div></div>
  422. <div class="ttc" id="structgrpc__auth__metadata__processor_html"><div class="ttname"><a href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a></div><div class="ttdef"><b>Definition:</b> grpc_security.h:275</div></div>
  423. <div class="ttc" id="structgrpc__auth__property_html"><div class="ttname"><a href="structgrpc__auth__property.html">grpc_auth_property</a></div><div class="ttdef"><b>Definition:</b> grpc_security.h:200</div></div>
  424. <div class="ttc" id="grpc__security_8h_html_a56df677a9fafe181dca4eb3280228d0b"><div class="ttname"><a href="grpc__security_8h.html#a56df677a9fafe181dca4eb3280228d0b">grpc_access_token_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_access_token_credentials_create(const char *access_token, void *reserved)</div></div>
  425. <div class="ttc" id="grpc__security_8h_html_a010fe7d27deaa2ea50b765b48dbad429"><div class="ttname"><a href="grpc__security_8h.html#a010fe7d27deaa2ea50b765b48dbad429">grpc_auth_property</a></div><div class="ttdeci">struct grpc_auth_property grpc_auth_property</div></div>
  426. <div class="ttc" id="grpc__security_8h_html_a29bf879141d7c0ca7eb86e0e26d585af"><div class="ttname"><a href="grpc__security_8h.html#a29bf879141d7c0ca7eb86e0e26d585af">grpc_secure_channel_create</a></div><div class="ttdeci">grpc_channel * grpc_secure_channel_create(grpc_credentials *creds, const char *target, const grpc_channel_args *args, void *reserved)</div></div>
  427. <div class="ttc" id="grpc__security_8h_html_aa79cf1d662f3e26bbc7dc34192dba500"><div class="ttname"><a href="grpc__security_8h.html#aa79cf1d662f3e26bbc7dc34192dba500">grpc_ssl_server_credentials_create</a></div><div class="ttdeci">grpc_server_credentials * grpc_ssl_server_credentials_create(const char *pem_root_certs, grpc_ssl_pem_key_cert_pair *pem_key_cert_pairs, size_t num_key_cert_pairs, int force_client_auth, void *reserved)</div></div>
  428. <div class="ttc" id="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div>
  429. <div class="ttc" id="grpc__security_8h_html_aa186fa3ea6c3a5a551d1a8fa9ddc9372"><div class="ttname"><a href="grpc__security_8h.html#aa186fa3ea6c3a5a551d1a8fa9ddc9372">grpc_google_compute_engine_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_google_compute_engine_credentials_create(void *reserved)</div></div>
  430. <div class="ttc" id="grpc__security_8h_html_aaad9fed074f7aebed63ed075bb6ff780"><div class="ttname"><a href="grpc__security_8h.html#aaad9fed074f7aebed63ed075bb6ff780">grpc_auth_context_property_iterator</a></div><div class="ttdeci">grpc_auth_property_iterator grpc_auth_context_property_iterator(const grpc_auth_context *ctx)</div></div>
  431. <div class="ttc" id="grpc__security_8h_html_a0b439e6d2875c8b5e2e901a959f6a2fe"><div class="ttname"><a href="grpc__security_8h.html#a0b439e6d2875c8b5e2e901a959f6a2fe">grpc_call_auth_context</a></div><div class="ttdeci">grpc_auth_context * grpc_call_auth_context(grpc_call *call)</div></div>
  432. <div class="ttc" id="structgpr__timespec_html"><div class="ttname"><a href="structgpr__timespec.html">gpr_timespec</a></div><div class="ttdef"><b>Definition:</b> time.h:63</div></div>
  433. <div class="ttc" id="status_8h_html_a35ab2a68917eb836de84cb23253108eb"><div class="ttname"><a href="status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a></div><div class="ttdeci">grpc_status_code</div><div class="ttdef"><b>Definition:</b> status.h:41</div></div>
  434. <div class="ttc" id="grpc__security_8h_html_a6e9f9320f4f8d2d534d04ed642f032ea"><div class="ttname"><a href="grpc__security_8h.html#a6e9f9320f4f8d2d534d04ed642f032ea">grpc_server_credentials_release</a></div><div class="ttdeci">void grpc_server_credentials_release(grpc_server_credentials *creds)</div></div>
  435. <div class="ttc" id="grpc__security_8h_html_a5298ac64614986581fc314f63fa9afd7"><div class="ttname"><a href="grpc__security_8h.html#a5298ac64614986581fc314f63fa9afd7">grpc_auth_context_find_properties_by_name</a></div><div class="ttdeci">grpc_auth_property_iterator grpc_auth_context_find_properties_by_name(const grpc_auth_context *ctx, const char *name)</div></div>
  436. <div class="ttc" id="grpc__security_8h_html_a2eea99f76030b21ad58afdf615f4d2b9"><div class="ttname"><a href="grpc__security_8h.html#a2eea99f76030b21ad58afdf615f4d2b9">grpc_auth_context_release</a></div><div class="ttdeci">void grpc_auth_context_release(grpc_auth_context *context)</div></div>
  437. <div class="ttc" id="grpc_8h_html"><div class="ttname"><a href="grpc_8h.html">grpc.h</a></div></div>
  438. <div class="ttc" id="grpc__security_8h_html_a672ef3a65799cabdd63b9e5cb7592446"><div class="ttname"><a href="grpc__security_8h.html#a672ef3a65799cabdd63b9e5cb7592446">grpc_google_iam_credentials_create</a></div><div class="ttdeci">grpc_credentials * grpc_google_iam_credentials_create(const char *authorization_token, const char *authority_selector, void *reserved)</div></div>
  439. </div><!-- fragment --></div><!-- contents -->
  440. <!-- start footer part -->
  441. <hr class="footer"/><address class="footer"><small>
  442. Generated on Tue Oct 27 2015 21:07:30 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  443. <img class="footer" src="doxygen.png" alt="doxygen"/>
  444. </a> 1.8.6
  445. </small></address>
  446. </body>
  447. </html>