grpc__security_8h.html 108 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569
  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 File Reference</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">5.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="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li class="current"><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="files.html"><span>File&#160;List</span></a></li>
  66. <li><a href="globals.html"><span>Globals</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="dir_8c22a72beb99e7fdfd27506cb533e734.html">include</a></li><li class="navelem"><a class="el" href="dir_3da487aded176e6fcacfa0e3f4e152fb.html">grpc</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#nested-classes">Data Structures</a> &#124;
  89. <a href="#define-members">Macros</a> &#124;
  90. <a href="#typedef-members">Typedefs</a> &#124;
  91. <a href="#func-members">Functions</a> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc_security.h File Reference</div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <div class="textblock"><code>#include &lt;<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>&gt;</code><br/>
  97. <code>#include &lt;<a class="el" href="grpc__security__constants_8h_source.html">grpc/grpc_security_constants.h</a>&gt;</code><br/>
  98. <code>#include &lt;<a class="el" href="status_8h_source.html">grpc/status.h</a>&gt;</code><br/>
  99. </div>
  100. <p><a href="grpc__security_8h_source.html">Go to the source code of this file.</a></p>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  103. Data Structures</h2></td></tr>
  104. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a></td></tr>
  105. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a></td></tr>
  107. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">value, if not NULL, is guaranteed to be NULL terminated. <a href="structgrpc__auth__property.html#details">More...</a><br/></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a></td></tr>
  110. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object that holds a private key / certificate chain pair in PEM format. <a href="structgrpc__ssl__pem__key__cert__pair.html#details">More...</a><br/></td></tr>
  111. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html">grpc_auth_metadata_context</a></td></tr>
  113. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Context that can be used by metadata credentials plugin in order to create auth related metadata. <a href="structgrpc__auth__metadata__context.html#details">More...</a><br/></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__metadata__credentials__plugin.html">grpc_metadata_credentials_plugin</a></td></tr>
  116. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">grpc_metadata_credentials plugin is an API user provided structure used to create grpc_credentials objects that can be set on a channel (composed) or a call. <a href="structgrpc__metadata__credentials__plugin.html#details">More...</a><br/></td></tr>
  117. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a></td></tr>
  119. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pluggable server-side metadata processor object. <a href="structgrpc__auth__metadata__processor.html#details">More...</a><br/></td></tr>
  120. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  123. Macros</h2></td></tr>
  124. <tr class="memitem:a33e259900dbbac0ea018352adf1a4af7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a33e259900dbbac0ea018352adf1a4af7">GRPC_METADATA_CREDENTIALS_PLUGIN_SYNC_MAX</a>&#160;&#160;&#160;4</td></tr>
  125. <tr class="memdesc:a33e259900dbbac0ea018352adf1a4af7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of metadata entries returnable by a credentials plugin via a synchronous return. <a href="#a33e259900dbbac0ea018352adf1a4af7">More...</a><br/></td></tr>
  126. <tr class="separator:a33e259900dbbac0ea018352adf1a4af7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table><table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  129. Typedefs</h2></td></tr>
  130. <tr class="memitem:aa13f0724cb7ff99995d7f0881c01d553"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a></td></tr>
  131. <tr class="memdesc:aa13f0724cb7ff99995d7f0881c01d553"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Authentication Context. <a href="#aa13f0724cb7ff99995d7f0881c01d553">More...</a><br/></td></tr>
  132. <tr class="separator:aa13f0724cb7ff99995d7f0881c01d553"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a26981fdcb987d885b25d34c7dc66e4cf"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  134. <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a26981fdcb987d885b25d34c7dc66e4cf">grpc_auth_property_iterator</a></td></tr>
  135. <tr class="separator:a26981fdcb987d885b25d34c7dc66e4cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a010fe7d27deaa2ea50b765b48dbad429"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a010fe7d27deaa2ea50b765b48dbad429">grpc_auth_property</a></td></tr>
  137. <tr class="memdesc:a010fe7d27deaa2ea50b765b48dbad429"><td class="mdescLeft">&#160;</td><td class="mdescRight">value, if not NULL, is guaranteed to be NULL terminated. <a href="#a010fe7d27deaa2ea50b765b48dbad429">More...</a><br/></td></tr>
  138. <tr class="separator:a010fe7d27deaa2ea50b765b48dbad429"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ab4ed40ea84a2f70ffd81a84bd8ee634b"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  140. <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a></td></tr>
  141. <tr class="memdesc:ab4ed40ea84a2f70ffd81a84bd8ee634b"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; grpc_channel_credentials object. <a href="#ab4ed40ea84a2f70ffd81a84bd8ee634b">More...</a><br/></td></tr>
  142. <tr class="separator:ab4ed40ea84a2f70ffd81a84bd8ee634b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a005f46357a959bbfbb7b1241a933ef43"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
  144. <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a005f46357a959bbfbb7b1241a933ef43">grpc_ssl_roots_override_callback</a> )(char **pem_root_certs)</td></tr>
  145. <tr class="memdesc:a005f46357a959bbfbb7b1241a933ef43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback for getting the SSL roots override from the application. <a href="#a005f46357a959bbfbb7b1241a933ef43">More...</a><br/></td></tr>
  146. <tr class="separator:a005f46357a959bbfbb7b1241a933ef43"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a2350ef1b38c4f69d0ff8510dcbe40072"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  148. <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a></td></tr>
  149. <tr class="memdesc:a2350ef1b38c4f69d0ff8510dcbe40072"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; grpc_call_credentials object. <a href="#a2350ef1b38c4f69d0ff8510dcbe40072">More...</a><br/></td></tr>
  150. <tr class="separator:a2350ef1b38c4f69d0ff8510dcbe40072"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:acc59d2e9577dc4429895b9cd89450106"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#acc59d2e9577dc4429895b9cd89450106">grpc_credentials_plugin_metadata_cb</a> )(void *user_data, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *creds_md, size_t num_creds_md, <a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> status, const char *error_details)</td></tr>
  152. <tr class="memdesc:acc59d2e9577dc4429895b9cd89450106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to be called by the metadata credentials plugin implementation when the metadata is ready. <a href="#acc59d2e9577dc4429895b9cd89450106">More...</a><br/></td></tr>
  153. <tr class="separator:acc59d2e9577dc4429895b9cd89450106"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aa724192e56fdc03827846f16752deccc"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  155. <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a></td></tr>
  156. <tr class="memdesc:aa724192e56fdc03827846f16752deccc"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; grpc_server_credentials object. <a href="#aa724192e56fdc03827846f16752deccc">More...</a><br/></td></tr>
  157. <tr class="separator:aa724192e56fdc03827846f16752deccc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:acb8bbd3a6006aee7f7b254d4a91d914f"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  159. <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a></td></tr>
  160. <tr class="memdesc:acb8bbd3a6006aee7f7b254d4a91d914f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Server certificate config object holds the server's public certificates and associated private keys, as well as any CA certificates needed for client certificate validation (if applicable). <a href="#acb8bbd3a6006aee7f7b254d4a91d914f">More...</a><br/></td></tr>
  161. <tr class="separator:acb8bbd3a6006aee7f7b254d4a91d914f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a10aa18e9708aa3b13e9464d57ade0782"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
  163. <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a10aa18e9708aa3b13e9464d57ade0782">grpc_ssl_server_certificate_config_callback</a> )(void *user_data, <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> **config)</td></tr>
  164. <tr class="memdesc:a10aa18e9708aa3b13e9464d57ade0782"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback to retrieve updated SSL server certificates, private keys, and trusted CAs (for client authentication). <a href="#a10aa18e9708aa3b13e9464d57ade0782">More...</a><br/></td></tr>
  165. <tr class="separator:a10aa18e9708aa3b13e9464d57ade0782"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:ade0da78380603c2e26c81695f09ea4c8"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
  167. <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a></td></tr>
  168. <tr class="separator:ade0da78380603c2e26c81695f09ea4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a54decefff49649afe0c5a3056d0734f1"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a54decefff49649afe0c5a3056d0734f1">grpc_process_auth_metadata_done_cb</a> )(void *user_data, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *consumed_md, size_t num_consumed_md, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *response_md, size_t num_response_md, <a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> status, const char *error_details)</td></tr>
  170. <tr class="memdesc:a54decefff49649afe0c5a3056d0734f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Auth Metadata Processing &mdash; <a href="#a54decefff49649afe0c5a3056d0734f1">More...</a><br/></td></tr>
  171. <tr class="separator:a54decefff49649afe0c5a3056d0734f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. </table><table class="memberdecls">
  173. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  174. Functions</h2></td></tr>
  175. <tr class="memitem:a064c4dc355a3720cd2bcf6e3ddfb3e05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> const <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a064c4dc355a3720cd2bcf6e3ddfb3e05">grpc_auth_property_iterator_next</a> (<a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> *it)</td></tr>
  176. <tr class="memdesc:a064c4dc355a3720cd2bcf6e3ddfb3e05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns NULL when the iterator is at the end. <a href="#a064c4dc355a3720cd2bcf6e3ddfb3e05">More...</a><br/></td></tr>
  177. <tr class="separator:a064c4dc355a3720cd2bcf6e3ddfb3e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:aedee02a7f6ed58e9bd41b00a518350c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aedee02a7f6ed58e9bd41b00a518350c2">grpc_auth_context_property_iterator</a> (const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
  179. <tr class="memdesc:aedee02a7f6ed58e9bd41b00a518350c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates over the auth context. <a href="#aedee02a7f6ed58e9bd41b00a518350c2">More...</a><br/></td></tr>
  180. <tr class="separator:aedee02a7f6ed58e9bd41b00a518350c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a4d6409cf4a261297cd327bd49e72fcea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a4d6409cf4a261297cd327bd49e72fcea">grpc_auth_context_peer_identity</a> (const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
  182. <tr class="memdesc:a4d6409cf4a261297cd327bd49e72fcea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the peer identity. <a href="#a4d6409cf4a261297cd327bd49e72fcea">More...</a><br/></td></tr>
  183. <tr class="separator:a4d6409cf4a261297cd327bd49e72fcea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a9d3ce2db2aa6fb1c21dd2789ee7c2d18">grpc_auth_context_find_properties_by_name</a> (const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name)</td></tr>
  185. <tr class="memdesc:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds a property in the context. <a href="#a9d3ce2db2aa6fb1c21dd2789ee7c2d18">More...</a><br/></td></tr>
  186. <tr class="separator:a9d3ce2db2aa6fb1c21dd2789ee7c2d18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a5a627008e49efec12fb97c25b5da4628"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5a627008e49efec12fb97c25b5da4628">grpc_auth_context_peer_identity_property_name</a> (const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
  188. <tr class="memdesc:a5a627008e49efec12fb97c25b5da4628"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of the property that indicates the peer identity. <a href="#a5a627008e49efec12fb97c25b5da4628">More...</a><br/></td></tr>
  189. <tr class="separator:a5a627008e49efec12fb97c25b5da4628"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a5bb56dbcba0b0c54e3c6da0635391959"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5bb56dbcba0b0c54e3c6da0635391959">grpc_auth_context_peer_is_authenticated</a> (const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx)</td></tr>
  191. <tr class="memdesc:a5bb56dbcba0b0c54e3c6da0635391959"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns 1 if the peer is authenticated, 0 otherwise. <a href="#a5bb56dbcba0b0c54e3c6da0635391959">More...</a><br/></td></tr>
  192. <tr class="separator:a5bb56dbcba0b0c54e3c6da0635391959"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a3c1860cddc9edaa7f657a98a35b77e80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a3c1860cddc9edaa7f657a98a35b77e80">grpc_call_auth_context</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call)</td></tr>
  194. <tr class="memdesc:a3c1860cddc9edaa7f657a98a35b77e80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the auth context from the call. <a href="#a3c1860cddc9edaa7f657a98a35b77e80">More...</a><br/></td></tr>
  195. <tr class="separator:a3c1860cddc9edaa7f657a98a35b77e80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa9dbfdabaca2ab86c9d7e71cbc81d3d4">grpc_auth_context_release</a> (<a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *context)</td></tr>
  197. <tr class="memdesc:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the auth context returned from grpc_call_auth_context. <a href="#aa9dbfdabaca2ab86c9d7e71cbc81d3d4">More...</a><br/></td></tr>
  198. <tr class="separator:aa9dbfdabaca2ab86c9d7e71cbc81d3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:a93f543166de70abb3a725bdca1d79996"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a93f543166de70abb3a725bdca1d79996">grpc_auth_context_add_property</a> (<a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name, const char *value, size_t value_length)</td></tr>
  200. <tr class="memdesc:a93f543166de70abb3a725bdca1d79996"><td class="mdescLeft">&#160;</td><td class="mdescRight">&ndash; The following auth context methods should only be called by a server metadata processor to set properties extracted from auth metadata. <a href="#a93f543166de70abb3a725bdca1d79996">More...</a><br/></td></tr>
  201. <tr class="separator:a93f543166de70abb3a725bdca1d79996"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a73068ca89b430bb9004f8c3e86a2886a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a73068ca89b430bb9004f8c3e86a2886a">grpc_auth_context_add_cstring_property</a> (<a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name, const char *value)</td></tr>
  203. <tr class="memdesc:a73068ca89b430bb9004f8c3e86a2886a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a C string property. <a href="#a73068ca89b430bb9004f8c3e86a2886a">More...</a><br/></td></tr>
  204. <tr class="separator:a73068ca89b430bb9004f8c3e86a2886a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a9cff913051370085b7cc58aa3ccbd4a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a9cff913051370085b7cc58aa3ccbd4a4">grpc_auth_context_set_peer_identity_property_name</a> (<a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *ctx, const char *name)</td></tr>
  206. <tr class="memdesc:a9cff913051370085b7cc58aa3ccbd4a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the property name. <a href="#a9cff913051370085b7cc58aa3ccbd4a4">More...</a><br/></td></tr>
  207. <tr class="separator:a9cff913051370085b7cc58aa3ccbd4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:a5a32645c900c2b50bc89fa11ebdc5a07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5a32645c900c2b50bc89fa11ebdc5a07">grpc_channel_credentials_release</a> (<a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *creds)</td></tr>
  209. <tr class="memdesc:a5a32645c900c2b50bc89fa11ebdc5a07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a channel credentials object. <a href="#a5a32645c900c2b50bc89fa11ebdc5a07">More...</a><br/></td></tr>
  210. <tr class="separator:a5a32645c900c2b50bc89fa11ebdc5a07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:a68183d792830190c3e14504557d57ad7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a68183d792830190c3e14504557d57ad7">grpc_google_default_credentials_create</a> (void)</td></tr>
  212. <tr class="memdesc:a68183d792830190c3e14504557d57ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates default credentials to connect to a google gRPC service. <a href="#a68183d792830190c3e14504557d57ad7">More...</a><br/></td></tr>
  213. <tr class="separator:a68183d792830190c3e14504557d57ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:a44c23e47832d9cc27bb56822d66bf436"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a44c23e47832d9cc27bb56822d66bf436">grpc_set_ssl_roots_override_callback</a> (<a class="el" href="grpc__security_8h.html#a005f46357a959bbfbb7b1241a933ef43">grpc_ssl_roots_override_callback</a> cb)</td></tr>
  215. <tr class="memdesc:a44c23e47832d9cc27bb56822d66bf436"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup a callback to override the default TLS/SSL roots. <a href="#a44c23e47832d9cc27bb56822d66bf436">More...</a><br/></td></tr>
  216. <tr class="separator:a44c23e47832d9cc27bb56822d66bf436"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:a2dfd4a555352ff0e449ce9c38abd2f21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a2dfd4a555352ff0e449ce9c38abd2f21">grpc_ssl_credentials_create</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pair, void *reserved)</td></tr>
  218. <tr class="memdesc:a2dfd4a555352ff0e449ce9c38abd2f21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an SSL credentials object. <a href="#a2dfd4a555352ff0e449ce9c38abd2f21">More...</a><br/></td></tr>
  219. <tr class="separator:a2dfd4a555352ff0e449ce9c38abd2f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:aeb21611154f3defe05e4eac4cc25af5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aeb21611154f3defe05e4eac4cc25af5a">grpc_call_credentials_release</a> (<a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds)</td></tr>
  221. <tr class="memdesc:aeb21611154f3defe05e4eac4cc25af5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a call credentials object. <a href="#aeb21611154f3defe05e4eac4cc25af5a">More...</a><br/></td></tr>
  222. <tr class="separator:aeb21611154f3defe05e4eac4cc25af5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:a8e4b35968eac741831a708224e207348"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a8e4b35968eac741831a708224e207348">grpc_composite_channel_credentials_create</a> (<a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *channel_creds, <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *call_creds, void *reserved)</td></tr>
  224. <tr class="memdesc:a8e4b35968eac741831a708224e207348"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a composite channel credentials object. <a href="#a8e4b35968eac741831a708224e207348">More...</a><br/></td></tr>
  225. <tr class="separator:a8e4b35968eac741831a708224e207348"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:a5fb84795d5b0306006fdb8d316262a82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5fb84795d5b0306006fdb8d316262a82">grpc_composite_call_credentials_create</a> (<a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds1, <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds2, void *reserved)</td></tr>
  227. <tr class="memdesc:a5fb84795d5b0306006fdb8d316262a82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a composite call credentials object. <a href="#a5fb84795d5b0306006fdb8d316262a82">More...</a><br/></td></tr>
  228. <tr class="separator:a5fb84795d5b0306006fdb8d316262a82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:af66841ff2c26a95ff9cd18ea2cdf38cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#af66841ff2c26a95ff9cd18ea2cdf38cb">grpc_google_compute_engine_credentials_create</a> (void *reserved)</td></tr>
  230. <tr class="memdesc:af66841ff2c26a95ff9cd18ea2cdf38cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a compute engine credentials object for connecting to Google. <a href="#af66841ff2c26a95ff9cd18ea2cdf38cb">More...</a><br/></td></tr>
  231. <tr class="separator:af66841ff2c26a95ff9cd18ea2cdf38cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr class="memitem:a4274ad26c037943386451f437c768961"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a4274ad26c037943386451f437c768961">grpc_max_auth_token_lifetime</a> (void)</td></tr>
  233. <tr class="separator:a4274ad26c037943386451f437c768961"><td class="memSeparator" colspan="2">&#160;</td></tr>
  234. <tr class="memitem:ae8c4bf6c9657d6e19ea1481c1ea9a5d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#ae8c4bf6c9657d6e19ea1481c1ea9a5d5">grpc_service_account_jwt_access_credentials_create</a> (const char *json_key, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> token_lifetime, void *reserved)</td></tr>
  235. <tr class="memdesc:ae8c4bf6c9657d6e19ea1481c1ea9a5d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a JWT credentials object. <a href="#ae8c4bf6c9657d6e19ea1481c1ea9a5d5">More...</a><br/></td></tr>
  236. <tr class="separator:ae8c4bf6c9657d6e19ea1481c1ea9a5d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:aa2108431aea25ab0e9bef17becff7357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa2108431aea25ab0e9bef17becff7357">grpc_google_refresh_token_credentials_create</a> (const char *json_refresh_token, void *reserved)</td></tr>
  238. <tr class="memdesc:aa2108431aea25ab0e9bef17becff7357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Oauth2 Refresh Token credentials object for connecting to Google. <a href="#aa2108431aea25ab0e9bef17becff7357">More...</a><br/></td></tr>
  239. <tr class="separator:aa2108431aea25ab0e9bef17becff7357"><td class="memSeparator" colspan="2">&#160;</td></tr>
  240. <tr class="memitem:aa64d5173a15c51fdb2d80c3c187157ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa64d5173a15c51fdb2d80c3c187157ca">grpc_access_token_credentials_create</a> (const char *access_token, void *reserved)</td></tr>
  241. <tr class="memdesc:aa64d5173a15c51fdb2d80c3c187157ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Oauth2 Access Token credentials with an access token that was aquired by an out of band mechanism. <a href="#aa64d5173a15c51fdb2d80c3c187157ca">More...</a><br/></td></tr>
  242. <tr class="separator:aa64d5173a15c51fdb2d80c3c187157ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  243. <tr class="memitem:a060719c0b294858858dbf41b7ec2abb5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a060719c0b294858858dbf41b7ec2abb5">grpc_google_iam_credentials_create</a> (const char *authorization_token, const char *authority_selector, void *reserved)</td></tr>
  244. <tr class="memdesc:a060719c0b294858858dbf41b7ec2abb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an IAM credentials object for connecting to Google. <a href="#a060719c0b294858858dbf41b7ec2abb5">More...</a><br/></td></tr>
  245. <tr class="separator:a060719c0b294858858dbf41b7ec2abb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  246. <tr class="memitem:aed07d29d954508e9f9da66b547660160"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aed07d29d954508e9f9da66b547660160">grpc_metadata_credentials_create_from_plugin</a> (<a class="el" href="structgrpc__metadata__credentials__plugin.html">grpc_metadata_credentials_plugin</a> plugin, void *reserved)</td></tr>
  247. <tr class="memdesc:aed07d29d954508e9f9da66b547660160"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a credentials object from a plugin. <a href="#aed07d29d954508e9f9da66b547660160">More...</a><br/></td></tr>
  248. <tr class="separator:aed07d29d954508e9f9da66b547660160"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. <tr class="memitem:acad1744e2cdf6f9f11723c3450874ca7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#acad1744e2cdf6f9f11723c3450874ca7">grpc_secure_channel_create</a> (<a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *creds, const char *target, const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *args, void *reserved)</td></tr>
  250. <tr class="memdesc:acad1744e2cdf6f9f11723c3450874ca7"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Secure channel creation. <a href="#acad1744e2cdf6f9f11723c3450874ca7">More...</a><br/></td></tr>
  251. <tr class="separator:acad1744e2cdf6f9f11723c3450874ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  252. <tr class="memitem:a8d8e443300d9a94fa5fe7ef76c77fd38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a8d8e443300d9a94fa5fe7ef76c77fd38">grpc_server_credentials_release</a> (<a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds)</td></tr>
  253. <tr class="memdesc:a8d8e443300d9a94fa5fe7ef76c77fd38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a server_credentials object. <a href="#a8d8e443300d9a94fa5fe7ef76c77fd38">More...</a><br/></td></tr>
  254. <tr class="separator:a8d8e443300d9a94fa5fe7ef76c77fd38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  255. <tr class="memitem:a0fbb46fa71b635516037e6b265f937f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <br class="typebreak"/>
  256. <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a0fbb46fa71b635516037e6b265f937f5">grpc_ssl_server_certificate_config_create</a> (const char *pem_root_certs, const <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pairs, size_t num_key_cert_pairs)</td></tr>
  257. <tr class="memdesc:a0fbb46fa71b635516037e6b265f937f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a grpc_ssl_server_certificate_config object. <a href="#a0fbb46fa71b635516037e6b265f937f5">More...</a><br/></td></tr>
  258. <tr class="separator:a0fbb46fa71b635516037e6b265f937f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  259. <tr class="memitem:a077c39db13d0211eac9c6a952882bc31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a077c39db13d0211eac9c6a952882bc31">grpc_ssl_server_certificate_config_destroy</a> (<a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> *config)</td></tr>
  260. <tr class="memdesc:a077c39db13d0211eac9c6a952882bc31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a grpc_ssl_server_certificate_config object. <a href="#a077c39db13d0211eac9c6a952882bc31">More...</a><br/></td></tr>
  261. <tr class="separator:a077c39db13d0211eac9c6a952882bc31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  262. <tr class="memitem:adde6c7d191f88997fd82fd8b54f9420e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#adde6c7d191f88997fd82fd8b54f9420e">grpc_ssl_server_credentials_create</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pairs, size_t num_key_cert_pairs, int force_client_auth, void *reserved)</td></tr>
  263. <tr class="memdesc:adde6c7d191f88997fd82fd8b54f9420e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated in favor of grpc_ssl_server_credentials_create_ex. <a href="#adde6c7d191f88997fd82fd8b54f9420e">More...</a><br/></td></tr>
  264. <tr class="separator:adde6c7d191f88997fd82fd8b54f9420e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  265. <tr class="memitem:a5f8a4204d09f2b10a3986d25b6583a08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a5f8a4204d09f2b10a3986d25b6583a08">grpc_ssl_server_credentials_create_ex</a> (const char *pem_root_certs, <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *pem_key_cert_pairs, size_t num_key_cert_pairs, <a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> client_certificate_request, void *reserved)</td></tr>
  266. <tr class="memdesc:a5f8a4204d09f2b10a3986d25b6583a08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deprecated in favor of grpc_ssl_server_credentials_create_with_options. <a href="#a5f8a4204d09f2b10a3986d25b6583a08">More...</a><br/></td></tr>
  267. <tr class="separator:a5f8a4204d09f2b10a3986d25b6583a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  268. <tr class="memitem:a019828123e4b76b8a13f7d8045396d28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <br class="typebreak"/>
  269. <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a019828123e4b76b8a13f7d8045396d28">grpc_ssl_server_credentials_create_options_using_config</a> (<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> client_certificate_request, <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> *certificate_config)</td></tr>
  270. <tr class="memdesc:a019828123e4b76b8a13f7d8045396d28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an options object using a certificate config. <a href="#a019828123e4b76b8a13f7d8045396d28">More...</a><br/></td></tr>
  271. <tr class="separator:a019828123e4b76b8a13f7d8045396d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  272. <tr class="memitem:a0bef5efe91a84e2c74b031759a9a7313"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <br class="typebreak"/>
  273. <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a0bef5efe91a84e2c74b031759a9a7313">grpc_ssl_server_credentials_create_options_using_config_fetcher</a> (<a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a> client_certificate_request, <a class="el" href="grpc__security_8h.html#a10aa18e9708aa3b13e9464d57ade0782">grpc_ssl_server_certificate_config_callback</a> cb, void *user_data)</td></tr>
  274. <tr class="memdesc:a0bef5efe91a84e2c74b031759a9a7313"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an options object using a certificate config fetcher. <a href="#a0bef5efe91a84e2c74b031759a9a7313">More...</a><br/></td></tr>
  275. <tr class="separator:a0bef5efe91a84e2c74b031759a9a7313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  276. <tr class="memitem:aa22779b6b4ffefc0efdaf8de4c8314a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aa22779b6b4ffefc0efdaf8de4c8314a8">grpc_ssl_server_credentials_options_destroy</a> (<a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *options)</td></tr>
  277. <tr class="memdesc:aa22779b6b4ffefc0efdaf8de4c8314a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a grpc_ssl_server_credentials_options object. <a href="#aa22779b6b4ffefc0efdaf8de4c8314a8">More...</a><br/></td></tr>
  278. <tr class="separator:aa22779b6b4ffefc0efdaf8de4c8314a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  279. <tr class="memitem:aec838ac89bd393040f0c88dad25a72ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#aec838ac89bd393040f0c88dad25a72ca">grpc_ssl_server_credentials_create_with_options</a> (<a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *options)</td></tr>
  280. <tr class="memdesc:aec838ac89bd393040f0c88dad25a72ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an SSL server_credentials object using the provided options struct. <a href="#aec838ac89bd393040f0c88dad25a72ca">More...</a><br/></td></tr>
  281. <tr class="separator:aec838ac89bd393040f0c88dad25a72ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  282. <tr class="memitem:a53278c0894e787a5f3bb1092d0fdc3f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a53278c0894e787a5f3bb1092d0fdc3f6">grpc_server_add_secure_http2_port</a> (<a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> *server, const char *addr, <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds)</td></tr>
  283. <tr class="memdesc:a53278c0894e787a5f3bb1092d0fdc3f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Server-side secure ports. <a href="#a53278c0894e787a5f3bb1092d0fdc3f6">More...</a><br/></td></tr>
  284. <tr class="separator:a53278c0894e787a5f3bb1092d0fdc3f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  285. <tr class="memitem:ab065a653f78111065e91a579fd2ce2d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a0d5a8bdd6d53d209cacea4b6fa5d785b">grpc_call_error</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#ab065a653f78111065e91a579fd2ce2d2">grpc_call_set_credentials</a> (<a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *call, <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *creds)</td></tr>
  286. <tr class="memdesc:ab065a653f78111065e91a579fd2ce2d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">&mdash; Call specific credentials. <a href="#ab065a653f78111065e91a579fd2ce2d2">More...</a><br/></td></tr>
  287. <tr class="separator:ab065a653f78111065e91a579fd2ce2d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  288. <tr class="memitem:a37da13e43ccc9b19e9f1a6051feaedc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__security_8h.html#a37da13e43ccc9b19e9f1a6051feaedc3">grpc_server_credentials_set_auth_metadata_processor</a> (<a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *creds, <a class="el" href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a> processor)</td></tr>
  289. <tr class="separator:a37da13e43ccc9b19e9f1a6051feaedc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  290. </table>
  291. <h2 class="groupheader">Macro Definition Documentation</h2>
  292. <a class="anchor" id="a33e259900dbbac0ea018352adf1a4af7"></a>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">#define GRPC_METADATA_CREDENTIALS_PLUGIN_SYNC_MAX&#160;&#160;&#160;4</td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. <p>Maximum number of metadata entries returnable by a credentials plugin via a synchronous return. </p>
  302. </div>
  303. </div>
  304. <h2 class="groupheader">Typedef Documentation</h2>
  305. <a class="anchor" id="aa13f0724cb7ff99995d7f0881c01d553"></a>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a></td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>&mdash; Authentication Context. </p>
  315. <hr/>
  316. </div>
  317. </div>
  318. <a class="anchor" id="a010fe7d27deaa2ea50b765b48dbad429"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">typedef struct <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a> <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>value, if not NULL, is guaranteed to be NULL terminated. </p>
  328. </div>
  329. </div>
  330. <a class="anchor" id="a26981fdcb987d885b25d34c7dc66e4cf"></a>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">typedef struct <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. </div>
  340. </div>
  341. <a class="anchor" id="a2350ef1b38c4f69d0ff8510dcbe40072"></a>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a></td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <p>&mdash; grpc_call_credentials object. </p>
  351. <p>A call credentials object represents a way to authenticate on a particular call. These credentials can be composed with a channel credentials object so that they are sent with every call on this channel. </p>
  352. </div>
  353. </div>
  354. <a class="anchor" id="ab4ed40ea84a2f70ffd81a84bd8ee634b"></a>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="memname">
  358. <tr>
  359. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a></td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>&mdash; grpc_channel_credentials object. </p>
  364. <hr/>
  365. <p>A channel credentials object represents a way to authenticate a client on a channel. </p>
  366. </div>
  367. </div>
  368. <a class="anchor" id="acc59d2e9577dc4429895b9cd89450106"></a>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">typedef void(* grpc_credentials_plugin_metadata_cb)(void *user_data, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *creds_md, size_t num_creds_md, <a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> status, const char *error_details)</td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Callback function to be called by the metadata credentials plugin implementation when the metadata is ready. </p>
  378. <ul>
  379. <li>user_data is the opaque pointer that was passed in the get_metadata method of the <a class="el" href="structgrpc__metadata__credentials__plugin.html" title="grpc_metadata_credentials plugin is an API user provided structure used to create grpc_credentials ob...">grpc_metadata_credentials_plugin</a> (see below).</li>
  380. <li>creds_md is an array of credentials metadata produced by the plugin. It may be set to NULL in case of an error.</li>
  381. <li>num_creds_md is the number of items in the creds_md array.</li>
  382. <li>status must be GRPC_STATUS_OK in case of success or another specific error code otherwise.</li>
  383. <li>error_details contains details about the error if any. In case of success it should be NULL and will be otherwise ignored. </li>
  384. </ul>
  385. </div>
  386. </div>
  387. <a class="anchor" id="a54decefff49649afe0c5a3056d0734f1"></a>
  388. <div class="memitem">
  389. <div class="memproto">
  390. <table class="memname">
  391. <tr>
  392. <td class="memname">typedef void(* grpc_process_auth_metadata_done_cb)(void *user_data, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *consumed_md, size_t num_consumed_md, const <a class="el" href="structgrpc__metadata.html">grpc_metadata</a> *response_md, size_t num_response_md, <a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> status, const char *error_details)</td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>&mdash; Auth Metadata Processing &mdash; </p>
  397. <p>Callback function that is called when the metadata processing is done.</p>
  398. <ul>
  399. <li>Consumed metadata will be removed from the set of metadata available on the call. consumed_md may be NULL if no metadata has been consumed.</li>
  400. <li>Response metadata will be set on the response. response_md may be NULL.</li>
  401. <li>status is GRPC_STATUS_OK for success or a specific status for an error. Common error status for auth metadata processing is either GRPC_STATUS_UNAUTHENTICATED in case of an authentication failure or GRPC_STATUS PERMISSION_DENIED in case of an authorization failure.</li>
  402. <li>error_details gives details about the error. May be NULL. </li>
  403. </ul>
  404. </div>
  405. </div>
  406. <a class="anchor" id="aa724192e56fdc03827846f16752deccc"></a>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a></td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>&mdash; grpc_server_credentials object. </p>
  416. <hr/>
  417. <p>A server credentials object represents a way to authenticate a server. </p>
  418. </div>
  419. </div>
  420. <a class="anchor" id="a005f46357a959bbfbb7b1241a933ef43"></a>
  421. <div class="memitem">
  422. <div class="memproto">
  423. <table class="memname">
  424. <tr>
  425. <td class="memname">typedef <a class="el" href="grpc__security__constants_8h.html#a90c47ae1d8c33145342170fe615fa68c">grpc_ssl_roots_override_result</a>(* grpc_ssl_roots_override_callback)(char **pem_root_certs)</td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Callback for getting the SSL roots override from the application. </p>
  430. <p>In case of success, *pem_roots_certs must be set to a NULL terminated string containing the list of PEM encoded root certificates. The ownership is passed to the core and freed (laster by the core) with gpr_free. If this function fails and GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is set to a valid path, it will override the roots specified this func </p>
  431. </div>
  432. </div>
  433. <a class="anchor" id="acb8bbd3a6006aee7f7b254d4a91d914f"></a>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a></td>
  439. </tr>
  440. </table>
  441. </div><div class="memdoc">
  442. <p>Server certificate config object holds the server's public certificates and associated private keys, as well as any CA certificates needed for client certificate validation (if applicable). </p>
  443. <p>Create using <a class="el" href="grpc__security_8h.html#a0fbb46fa71b635516037e6b265f937f5" title="Creates a grpc_ssl_server_certificate_config object. ">grpc_ssl_server_certificate_config_create()</a>. </p>
  444. </div>
  445. </div>
  446. <a class="anchor" id="a10aa18e9708aa3b13e9464d57ade0782"></a>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">typedef <a class="el" href="grpc__security__constants_8h.html#a4f19e93998bbda68d9c24f27673ff627">grpc_ssl_certificate_config_reload_status</a>( * grpc_ssl_server_certificate_config_callback)(void *user_data, <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> **config)</td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. <p>Callback to retrieve updated SSL server certificates, private keys, and trusted CAs (for client authentication). </p>
  456. <ul>
  457. <li>user_data parameter, if not NULL, contains opaque data to be used by the callback.</li>
  458. <li>Use grpc_ssl_server_certificate_config_create to create the config.</li>
  459. <li>The caller assumes ownership of the config. </li>
  460. </ul>
  461. </div>
  462. </div>
  463. <a class="anchor" id="ade0da78380603c2e26c81695f09ea4c8"></a>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <table class="memname">
  467. <tr>
  468. <td class="memname">typedef struct <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a></td>
  469. </tr>
  470. </table>
  471. </div><div class="memdoc">
  472. </div>
  473. </div>
  474. <h2 class="groupheader">Function Documentation</h2>
  475. <a class="anchor" id="aa64d5173a15c51fdb2d80c3c187157ca"></a>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="memname">
  479. <tr>
  480. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_access_token_credentials_create </td>
  481. <td>(</td>
  482. <td class="paramtype">const char *&#160;</td>
  483. <td class="paramname"><em>access_token</em>, </td>
  484. </tr>
  485. <tr>
  486. <td class="paramkey"></td>
  487. <td></td>
  488. <td class="paramtype">void *&#160;</td>
  489. <td class="paramname"><em>reserved</em>&#160;</td>
  490. </tr>
  491. <tr>
  492. <td></td>
  493. <td>)</td>
  494. <td></td><td></td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Creates an Oauth2 Access Token credentials with an access token that was aquired by an out of band mechanism. </p>
  499. </div>
  500. </div>
  501. <a class="anchor" id="a73068ca89b430bb9004f8c3e86a2886a"></a>
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_add_cstring_property </td>
  507. <td>(</td>
  508. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  509. <td class="paramname"><em>ctx</em>, </td>
  510. </tr>
  511. <tr>
  512. <td class="paramkey"></td>
  513. <td></td>
  514. <td class="paramtype">const char *&#160;</td>
  515. <td class="paramname"><em>name</em>, </td>
  516. </tr>
  517. <tr>
  518. <td class="paramkey"></td>
  519. <td></td>
  520. <td class="paramtype">const char *&#160;</td>
  521. <td class="paramname"><em>value</em>&#160;</td>
  522. </tr>
  523. <tr>
  524. <td></td>
  525. <td>)</td>
  526. <td></td><td></td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Add a C string property. </p>
  531. </div>
  532. </div>
  533. <a class="anchor" id="a93f543166de70abb3a725bdca1d79996"></a>
  534. <div class="memitem">
  535. <div class="memproto">
  536. <table class="memname">
  537. <tr>
  538. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_add_property </td>
  539. <td>(</td>
  540. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  541. <td class="paramname"><em>ctx</em>, </td>
  542. </tr>
  543. <tr>
  544. <td class="paramkey"></td>
  545. <td></td>
  546. <td class="paramtype">const char *&#160;</td>
  547. <td class="paramname"><em>name</em>, </td>
  548. </tr>
  549. <tr>
  550. <td class="paramkey"></td>
  551. <td></td>
  552. <td class="paramtype">const char *&#160;</td>
  553. <td class="paramname"><em>value</em>, </td>
  554. </tr>
  555. <tr>
  556. <td class="paramkey"></td>
  557. <td></td>
  558. <td class="paramtype">size_t&#160;</td>
  559. <td class="paramname"><em>value_length</em>&#160;</td>
  560. </tr>
  561. <tr>
  562. <td></td>
  563. <td>)</td>
  564. <td></td><td></td>
  565. </tr>
  566. </table>
  567. </div><div class="memdoc">
  568. <p>&ndash; The following auth context methods should only be called by a server metadata processor to set properties extracted from auth metadata. </p>
  569. <p>&ndash; Add a property. </p>
  570. </div>
  571. </div>
  572. <a class="anchor" id="a9d3ce2db2aa6fb1c21dd2789ee7c2d18"></a>
  573. <div class="memitem">
  574. <div class="memproto">
  575. <table class="memname">
  576. <tr>
  577. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_find_properties_by_name </td>
  578. <td>(</td>
  579. <td class="paramtype">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  580. <td class="paramname"><em>ctx</em>, </td>
  581. </tr>
  582. <tr>
  583. <td class="paramkey"></td>
  584. <td></td>
  585. <td class="paramtype">const char *&#160;</td>
  586. <td class="paramname"><em>name</em>&#160;</td>
  587. </tr>
  588. <tr>
  589. <td></td>
  590. <td>)</td>
  591. <td></td><td></td>
  592. </tr>
  593. </table>
  594. </div><div class="memdoc">
  595. <p>Finds a property in the context. </p>
  596. <p>May return an empty iterator (first _next will return NULL) if no property with this name was found in the context. </p>
  597. </div>
  598. </div>
  599. <a class="anchor" id="a4d6409cf4a261297cd327bd49e72fcea"></a>
  600. <div class="memitem">
  601. <div class="memproto">
  602. <table class="memname">
  603. <tr>
  604. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_peer_identity </td>
  605. <td>(</td>
  606. <td class="paramtype">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  607. <td class="paramname"><em>ctx</em></td><td>)</td>
  608. <td></td>
  609. </tr>
  610. </table>
  611. </div><div class="memdoc">
  612. <p>Gets the peer identity. </p>
  613. <p>Returns an empty iterator (first _next will return NULL) if the peer is not authenticated. </p>
  614. </div>
  615. </div>
  616. <a class="anchor" id="a5a627008e49efec12fb97c25b5da4628"></a>
  617. <div class="memitem">
  618. <div class="memproto">
  619. <table class="memname">
  620. <tr>
  621. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> const char* grpc_auth_context_peer_identity_property_name </td>
  622. <td>(</td>
  623. <td class="paramtype">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  624. <td class="paramname"><em>ctx</em></td><td>)</td>
  625. <td></td>
  626. </tr>
  627. </table>
  628. </div><div class="memdoc">
  629. <p>Gets the name of the property that indicates the peer identity. </p>
  630. <p>Will return NULL if the peer is not authenticated. </p>
  631. </div>
  632. </div>
  633. <a class="anchor" id="a5bb56dbcba0b0c54e3c6da0635391959"></a>
  634. <div class="memitem">
  635. <div class="memproto">
  636. <table class="memname">
  637. <tr>
  638. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_auth_context_peer_is_authenticated </td>
  639. <td>(</td>
  640. <td class="paramtype">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  641. <td class="paramname"><em>ctx</em></td><td>)</td>
  642. <td></td>
  643. </tr>
  644. </table>
  645. </div><div class="memdoc">
  646. <p>Returns 1 if the peer is authenticated, 0 otherwise. </p>
  647. </div>
  648. </div>
  649. <a class="anchor" id="aedee02a7f6ed58e9bd41b00a518350c2"></a>
  650. <div class="memitem">
  651. <div class="memproto">
  652. <table class="memname">
  653. <tr>
  654. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> grpc_auth_context_property_iterator </td>
  655. <td>(</td>
  656. <td class="paramtype">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  657. <td class="paramname"><em>ctx</em></td><td>)</td>
  658. <td></td>
  659. </tr>
  660. </table>
  661. </div><div class="memdoc">
  662. <p>Iterates over the auth context. </p>
  663. </div>
  664. </div>
  665. <a class="anchor" id="aa9dbfdabaca2ab86c9d7e71cbc81d3d4"></a>
  666. <div class="memitem">
  667. <div class="memproto">
  668. <table class="memname">
  669. <tr>
  670. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_auth_context_release </td>
  671. <td>(</td>
  672. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  673. <td class="paramname"><em>context</em></td><td>)</td>
  674. <td></td>
  675. </tr>
  676. </table>
  677. </div><div class="memdoc">
  678. <p>Releases the auth context returned from grpc_call_auth_context. </p>
  679. </div>
  680. </div>
  681. <a class="anchor" id="a9cff913051370085b7cc58aa3ccbd4a4"></a>
  682. <div class="memitem">
  683. <div class="memproto">
  684. <table class="memname">
  685. <tr>
  686. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_auth_context_set_peer_identity_property_name </td>
  687. <td>(</td>
  688. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td>
  689. <td class="paramname"><em>ctx</em>, </td>
  690. </tr>
  691. <tr>
  692. <td class="paramkey"></td>
  693. <td></td>
  694. <td class="paramtype">const char *&#160;</td>
  695. <td class="paramname"><em>name</em>&#160;</td>
  696. </tr>
  697. <tr>
  698. <td></td>
  699. <td>)</td>
  700. <td></td><td></td>
  701. </tr>
  702. </table>
  703. </div><div class="memdoc">
  704. <p>Sets the property name. </p>
  705. <p>Returns 1 if successful or 0 in case of failure (which means that no property with this name exists). </p>
  706. </div>
  707. </div>
  708. <a class="anchor" id="a064c4dc355a3720cd2bcf6e3ddfb3e05"></a>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> const <a class="el" href="structgrpc__auth__property.html">grpc_auth_property</a>* grpc_auth_property_iterator_next </td>
  714. <td>(</td>
  715. <td class="paramtype"><a class="el" href="structgrpc__auth__property__iterator.html">grpc_auth_property_iterator</a> *&#160;</td>
  716. <td class="paramname"><em>it</em></td><td>)</td>
  717. <td></td>
  718. </tr>
  719. </table>
  720. </div><div class="memdoc">
  721. <p>Returns NULL when the iterator is at the end. </p>
  722. </div>
  723. </div>
  724. <a class="anchor" id="a3c1860cddc9edaa7f657a98a35b77e80"></a>
  725. <div class="memitem">
  726. <div class="memproto">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>* grpc_call_auth_context </td>
  730. <td>(</td>
  731. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  732. <td class="paramname"><em>call</em></td><td>)</td>
  733. <td></td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Gets the auth context from the call. </p>
  738. <p>Caller needs to call grpc_auth_context_release on the returned context. </p>
  739. </div>
  740. </div>
  741. <a class="anchor" id="aeb21611154f3defe05e4eac4cc25af5a"></a>
  742. <div class="memitem">
  743. <div class="memproto">
  744. <table class="memname">
  745. <tr>
  746. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_call_credentials_release </td>
  747. <td>(</td>
  748. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
  749. <td class="paramname"><em>creds</em></td><td>)</td>
  750. <td></td>
  751. </tr>
  752. </table>
  753. </div><div class="memdoc">
  754. <p>Releases a call credentials object. </p>
  755. <p>The creator of the credentials object is responsible for its release. </p>
  756. </div>
  757. </div>
  758. <a class="anchor" id="ab065a653f78111065e91a579fd2ce2d2"></a>
  759. <div class="memitem">
  760. <div class="memproto">
  761. <table class="memname">
  762. <tr>
  763. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a0d5a8bdd6d53d209cacea4b6fa5d785b">grpc_call_error</a> grpc_call_set_credentials </td>
  764. <td>(</td>
  765. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a122f8f4f0a585396d993d9b55848f222">grpc_call</a> *&#160;</td>
  766. <td class="paramname"><em>call</em>, </td>
  767. </tr>
  768. <tr>
  769. <td class="paramkey"></td>
  770. <td></td>
  771. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
  772. <td class="paramname"><em>creds</em>&#160;</td>
  773. </tr>
  774. <tr>
  775. <td></td>
  776. <td>)</td>
  777. <td></td><td></td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>&mdash; Call specific credentials. </p>
  782. <hr/>
  783. <p> Sets a credentials to a call. Can only be called on the client side before grpc_call_start_batch. </p>
  784. </div>
  785. </div>
  786. <a class="anchor" id="a5a32645c900c2b50bc89fa11ebdc5a07"></a>
  787. <div class="memitem">
  788. <div class="memproto">
  789. <table class="memname">
  790. <tr>
  791. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_channel_credentials_release </td>
  792. <td>(</td>
  793. <td class="paramtype"><a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td>
  794. <td class="paramname"><em>creds</em></td><td>)</td>
  795. <td></td>
  796. </tr>
  797. </table>
  798. </div><div class="memdoc">
  799. <p>Releases a channel credentials object. </p>
  800. <p>The creator of the credentials object is responsible for its release. </p>
  801. </div>
  802. </div>
  803. <a class="anchor" id="a5fb84795d5b0306006fdb8d316262a82"></a>
  804. <div class="memitem">
  805. <div class="memproto">
  806. <table class="memname">
  807. <tr>
  808. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_composite_call_credentials_create </td>
  809. <td>(</td>
  810. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
  811. <td class="paramname"><em>creds1</em>, </td>
  812. </tr>
  813. <tr>
  814. <td class="paramkey"></td>
  815. <td></td>
  816. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
  817. <td class="paramname"><em>creds2</em>, </td>
  818. </tr>
  819. <tr>
  820. <td class="paramkey"></td>
  821. <td></td>
  822. <td class="paramtype">void *&#160;</td>
  823. <td class="paramname"><em>reserved</em>&#160;</td>
  824. </tr>
  825. <tr>
  826. <td></td>
  827. <td>)</td>
  828. <td></td><td></td>
  829. </tr>
  830. </table>
  831. </div><div class="memdoc">
  832. <p>Creates a composite call credentials object. </p>
  833. </div>
  834. </div>
  835. <a class="anchor" id="a8e4b35968eac741831a708224e207348"></a>
  836. <div class="memitem">
  837. <div class="memproto">
  838. <table class="memname">
  839. <tr>
  840. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a>* grpc_composite_channel_credentials_create </td>
  841. <td>(</td>
  842. <td class="paramtype"><a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td>
  843. <td class="paramname"><em>channel_creds</em>, </td>
  844. </tr>
  845. <tr>
  846. <td class="paramkey"></td>
  847. <td></td>
  848. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a> *&#160;</td>
  849. <td class="paramname"><em>call_creds</em>, </td>
  850. </tr>
  851. <tr>
  852. <td class="paramkey"></td>
  853. <td></td>
  854. <td class="paramtype">void *&#160;</td>
  855. <td class="paramname"><em>reserved</em>&#160;</td>
  856. </tr>
  857. <tr>
  858. <td></td>
  859. <td>)</td>
  860. <td></td><td></td>
  861. </tr>
  862. </table>
  863. </div><div class="memdoc">
  864. <p>Creates a composite channel credentials object. </p>
  865. </div>
  866. </div>
  867. <a class="anchor" id="af66841ff2c26a95ff9cd18ea2cdf38cb"></a>
  868. <div class="memitem">
  869. <div class="memproto">
  870. <table class="memname">
  871. <tr>
  872. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_google_compute_engine_credentials_create </td>
  873. <td>(</td>
  874. <td class="paramtype">void *&#160;</td>
  875. <td class="paramname"><em>reserved</em></td><td>)</td>
  876. <td></td>
  877. </tr>
  878. </table>
  879. </div><div class="memdoc">
  880. <p>Creates a compute engine credentials object for connecting to Google. </p>
  881. <p>WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak. </p>
  882. </div>
  883. </div>
  884. <a class="anchor" id="a68183d792830190c3e14504557d57ad7"></a>
  885. <div class="memitem">
  886. <div class="memproto">
  887. <table class="memname">
  888. <tr>
  889. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a>* grpc_google_default_credentials_create </td>
  890. <td>(</td>
  891. <td class="paramtype">void&#160;</td>
  892. <td class="paramname"></td><td>)</td>
  893. <td></td>
  894. </tr>
  895. </table>
  896. </div><div class="memdoc">
  897. <p>Creates default credentials to connect to a google gRPC service. </p>
  898. <p>WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak. </p>
  899. </div>
  900. </div>
  901. <a class="anchor" id="a060719c0b294858858dbf41b7ec2abb5"></a>
  902. <div class="memitem">
  903. <div class="memproto">
  904. <table class="memname">
  905. <tr>
  906. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_google_iam_credentials_create </td>
  907. <td>(</td>
  908. <td class="paramtype">const char *&#160;</td>
  909. <td class="paramname"><em>authorization_token</em>, </td>
  910. </tr>
  911. <tr>
  912. <td class="paramkey"></td>
  913. <td></td>
  914. <td class="paramtype">const char *&#160;</td>
  915. <td class="paramname"><em>authority_selector</em>, </td>
  916. </tr>
  917. <tr>
  918. <td class="paramkey"></td>
  919. <td></td>
  920. <td class="paramtype">void *&#160;</td>
  921. <td class="paramname"><em>reserved</em>&#160;</td>
  922. </tr>
  923. <tr>
  924. <td></td>
  925. <td>)</td>
  926. <td></td><td></td>
  927. </tr>
  928. </table>
  929. </div><div class="memdoc">
  930. <p>Creates an IAM credentials object for connecting to Google. </p>
  931. </div>
  932. </div>
  933. <a class="anchor" id="aa2108431aea25ab0e9bef17becff7357"></a>
  934. <div class="memitem">
  935. <div class="memproto">
  936. <table class="memname">
  937. <tr>
  938. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_google_refresh_token_credentials_create </td>
  939. <td>(</td>
  940. <td class="paramtype">const char *&#160;</td>
  941. <td class="paramname"><em>json_refresh_token</em>, </td>
  942. </tr>
  943. <tr>
  944. <td class="paramkey"></td>
  945. <td></td>
  946. <td class="paramtype">void *&#160;</td>
  947. <td class="paramname"><em>reserved</em>&#160;</td>
  948. </tr>
  949. <tr>
  950. <td></td>
  951. <td>)</td>
  952. <td></td><td></td>
  953. </tr>
  954. </table>
  955. </div><div class="memdoc">
  956. <p>Creates an Oauth2 Refresh Token credentials object for connecting to Google. </p>
  957. <p>May return NULL if the input is invalid. WARNING: Do NOT use this credentials to connect to a non-google service as this could result in an oauth2 token leak.</p>
  958. <ul>
  959. <li>json_refresh_token is the JSON string containing the refresh token itself along with a client_id and client_secret. </li>
  960. </ul>
  961. </div>
  962. </div>
  963. <a class="anchor" id="a4274ad26c037943386451f437c768961"></a>
  964. <div class="memitem">
  965. <div class="memproto">
  966. <table class="memname">
  967. <tr>
  968. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="structgpr__timespec.html">gpr_timespec</a> grpc_max_auth_token_lifetime </td>
  969. <td>(</td>
  970. <td class="paramtype">void&#160;</td>
  971. <td class="paramname"></td><td>)</td>
  972. <td></td>
  973. </tr>
  974. </table>
  975. </div><div class="memdoc">
  976. </div>
  977. </div>
  978. <a class="anchor" id="aed07d29d954508e9f9da66b547660160"></a>
  979. <div class="memitem">
  980. <div class="memproto">
  981. <table class="memname">
  982. <tr>
  983. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_metadata_credentials_create_from_plugin </td>
  984. <td>(</td>
  985. <td class="paramtype"><a class="el" href="structgrpc__metadata__credentials__plugin.html">grpc_metadata_credentials_plugin</a>&#160;</td>
  986. <td class="paramname"><em>plugin</em>, </td>
  987. </tr>
  988. <tr>
  989. <td class="paramkey"></td>
  990. <td></td>
  991. <td class="paramtype">void *&#160;</td>
  992. <td class="paramname"><em>reserved</em>&#160;</td>
  993. </tr>
  994. <tr>
  995. <td></td>
  996. <td>)</td>
  997. <td></td><td></td>
  998. </tr>
  999. </table>
  1000. </div><div class="memdoc">
  1001. <p>Creates a credentials object from a plugin. </p>
  1002. </div>
  1003. </div>
  1004. <a class="anchor" id="acad1744e2cdf6f9f11723c3450874ca7"></a>
  1005. <div class="memitem">
  1006. <div class="memproto">
  1007. <table class="memname">
  1008. <tr>
  1009. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a>* grpc_secure_channel_create </td>
  1010. <td>(</td>
  1011. <td class="paramtype"><a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a> *&#160;</td>
  1012. <td class="paramname"><em>creds</em>, </td>
  1013. </tr>
  1014. <tr>
  1015. <td class="paramkey"></td>
  1016. <td></td>
  1017. <td class="paramtype">const char *&#160;</td>
  1018. <td class="paramname"><em>target</em>, </td>
  1019. </tr>
  1020. <tr>
  1021. <td class="paramkey"></td>
  1022. <td></td>
  1023. <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
  1024. <td class="paramname"><em>args</em>, </td>
  1025. </tr>
  1026. <tr>
  1027. <td class="paramkey"></td>
  1028. <td></td>
  1029. <td class="paramtype">void *&#160;</td>
  1030. <td class="paramname"><em>reserved</em>&#160;</td>
  1031. </tr>
  1032. <tr>
  1033. <td></td>
  1034. <td>)</td>
  1035. <td></td><td></td>
  1036. </tr>
  1037. </table>
  1038. </div><div class="memdoc">
  1039. <p>&mdash; Secure channel creation. </p>
  1040. <hr/>
  1041. <p> Creates a secure channel using the passed-in credentials. </p>
  1042. </div>
  1043. </div>
  1044. <a class="anchor" id="a53278c0894e787a5f3bb1092d0fdc3f6"></a>
  1045. <div class="memitem">
  1046. <div class="memproto">
  1047. <table class="memname">
  1048. <tr>
  1049. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> int grpc_server_add_secure_http2_port </td>
  1050. <td>(</td>
  1051. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> *&#160;</td>
  1052. <td class="paramname"><em>server</em>, </td>
  1053. </tr>
  1054. <tr>
  1055. <td class="paramkey"></td>
  1056. <td></td>
  1057. <td class="paramtype">const char *&#160;</td>
  1058. <td class="paramname"><em>addr</em>, </td>
  1059. </tr>
  1060. <tr>
  1061. <td class="paramkey"></td>
  1062. <td></td>
  1063. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td>
  1064. <td class="paramname"><em>creds</em>&#160;</td>
  1065. </tr>
  1066. <tr>
  1067. <td></td>
  1068. <td>)</td>
  1069. <td></td><td></td>
  1070. </tr>
  1071. </table>
  1072. </div><div class="memdoc">
  1073. <p>&mdash; Server-side secure ports. </p>
  1074. <hr/>
  1075. <p> Add a HTTP2 over an encrypted link over tcp listener. Returns bound port number on success, 0 on failure. REQUIRES: server not started </p>
  1076. </div>
  1077. </div>
  1078. <a class="anchor" id="a8d8e443300d9a94fa5fe7ef76c77fd38"></a>
  1079. <div class="memitem">
  1080. <div class="memproto">
  1081. <table class="memname">
  1082. <tr>
  1083. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_server_credentials_release </td>
  1084. <td>(</td>
  1085. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td>
  1086. <td class="paramname"><em>creds</em></td><td>)</td>
  1087. <td></td>
  1088. </tr>
  1089. </table>
  1090. </div><div class="memdoc">
  1091. <p>Releases a server_credentials object. </p>
  1092. <p>The creator of the server_credentials object is responsible for its release. </p>
  1093. </div>
  1094. </div>
  1095. <a class="anchor" id="a37da13e43ccc9b19e9f1a6051feaedc3"></a>
  1096. <div class="memitem">
  1097. <div class="memproto">
  1098. <table class="memname">
  1099. <tr>
  1100. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_server_credentials_set_auth_metadata_processor </td>
  1101. <td>(</td>
  1102. <td class="paramtype"><a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a> *&#160;</td>
  1103. <td class="paramname"><em>creds</em>, </td>
  1104. </tr>
  1105. <tr>
  1106. <td class="paramkey"></td>
  1107. <td></td>
  1108. <td class="paramtype"><a class="el" href="structgrpc__auth__metadata__processor.html">grpc_auth_metadata_processor</a>&#160;</td>
  1109. <td class="paramname"><em>processor</em>&#160;</td>
  1110. </tr>
  1111. <tr>
  1112. <td></td>
  1113. <td>)</td>
  1114. <td></td><td></td>
  1115. </tr>
  1116. </table>
  1117. </div><div class="memdoc">
  1118. </div>
  1119. </div>
  1120. <a class="anchor" id="ae8c4bf6c9657d6e19ea1481c1ea9a5d5"></a>
  1121. <div class="memitem">
  1122. <div class="memproto">
  1123. <table class="memname">
  1124. <tr>
  1125. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#a2350ef1b38c4f69d0ff8510dcbe40072">grpc_call_credentials</a>* grpc_service_account_jwt_access_credentials_create </td>
  1126. <td>(</td>
  1127. <td class="paramtype">const char *&#160;</td>
  1128. <td class="paramname"><em>json_key</em>, </td>
  1129. </tr>
  1130. <tr>
  1131. <td class="paramkey"></td>
  1132. <td></td>
  1133. <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
  1134. <td class="paramname"><em>token_lifetime</em>, </td>
  1135. </tr>
  1136. <tr>
  1137. <td class="paramkey"></td>
  1138. <td></td>
  1139. <td class="paramtype">void *&#160;</td>
  1140. <td class="paramname"><em>reserved</em>&#160;</td>
  1141. </tr>
  1142. <tr>
  1143. <td></td>
  1144. <td>)</td>
  1145. <td></td><td></td>
  1146. </tr>
  1147. </table>
  1148. </div><div class="memdoc">
  1149. <p>Creates a JWT credentials object. </p>
  1150. <p>May return NULL if the input is invalid.</p>
  1151. <ul>
  1152. <li>json_key is the JSON key string containing the client's private key.</li>
  1153. <li>token_lifetime is the lifetime of each Json Web Token (JWT) created with this credentials. It should not exceed grpc_max_auth_token_lifetime or will be cropped to this value. </li>
  1154. </ul>
  1155. </div>
  1156. </div>
  1157. <a class="anchor" id="a44c23e47832d9cc27bb56822d66bf436"></a>
  1158. <div class="memitem">
  1159. <div class="memproto">
  1160. <table class="memname">
  1161. <tr>
  1162. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_set_ssl_roots_override_callback </td>
  1163. <td>(</td>
  1164. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a005f46357a959bbfbb7b1241a933ef43">grpc_ssl_roots_override_callback</a>&#160;</td>
  1165. <td class="paramname"><em>cb</em></td><td>)</td>
  1166. <td></td>
  1167. </tr>
  1168. </table>
  1169. </div><div class="memdoc">
  1170. <p>Setup a callback to override the default TLS/SSL roots. </p>
  1171. <p>This function is not thread-safe and must be called at initialization time before any ssl credentials are created to have the desired side effect. If GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment is set to a valid path, the callback will not be called. </p>
  1172. </div>
  1173. </div>
  1174. <a class="anchor" id="a2dfd4a555352ff0e449ce9c38abd2f21"></a>
  1175. <div class="memitem">
  1176. <div class="memproto">
  1177. <table class="memname">
  1178. <tr>
  1179. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ab4ed40ea84a2f70ffd81a84bd8ee634b">grpc_channel_credentials</a>* grpc_ssl_credentials_create </td>
  1180. <td>(</td>
  1181. <td class="paramtype">const char *&#160;</td>
  1182. <td class="paramname"><em>pem_root_certs</em>, </td>
  1183. </tr>
  1184. <tr>
  1185. <td class="paramkey"></td>
  1186. <td></td>
  1187. <td class="paramtype"><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *&#160;</td>
  1188. <td class="paramname"><em>pem_key_cert_pair</em>, </td>
  1189. </tr>
  1190. <tr>
  1191. <td class="paramkey"></td>
  1192. <td></td>
  1193. <td class="paramtype">void *&#160;</td>
  1194. <td class="paramname"><em>reserved</em>&#160;</td>
  1195. </tr>
  1196. <tr>
  1197. <td></td>
  1198. <td>)</td>
  1199. <td></td><td></td>
  1200. </tr>
  1201. </table>
  1202. </div><div class="memdoc">
  1203. <p>Creates an SSL credentials object. </p>
  1204. <ul>
  1205. <li>pem_root_certs is the NULL-terminated string containing the PEM encoding of the server root certificates. If this parameter is NULL, the implementation will first try to dereference the file pointed by the GRPC_DEFAULT_SSL_ROOTS_FILE_PATH environment variable, and if that fails, try to get the roots set by grpc_override_ssl_default_roots. Eventually, if all these fail, it will try to get the roots from a well-known place on disk (in the grpc install directory).</li>
  1206. <li>pem_key_cert_pair is a pointer on the object containing client's private key and certificate chain. This parameter can be NULL if the client does not have such a key/cert pair. </li>
  1207. </ul>
  1208. </div>
  1209. </div>
  1210. <a class="anchor" id="a0fbb46fa71b635516037e6b265f937f5"></a>
  1211. <div class="memitem">
  1212. <div class="memproto">
  1213. <table class="memname">
  1214. <tr>
  1215. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a>* grpc_ssl_server_certificate_config_create </td>
  1216. <td>(</td>
  1217. <td class="paramtype">const char *&#160;</td>
  1218. <td class="paramname"><em>pem_root_certs</em>, </td>
  1219. </tr>
  1220. <tr>
  1221. <td class="paramkey"></td>
  1222. <td></td>
  1223. <td class="paramtype">const <a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *&#160;</td>
  1224. <td class="paramname"><em>pem_key_cert_pairs</em>, </td>
  1225. </tr>
  1226. <tr>
  1227. <td class="paramkey"></td>
  1228. <td></td>
  1229. <td class="paramtype">size_t&#160;</td>
  1230. <td class="paramname"><em>num_key_cert_pairs</em>&#160;</td>
  1231. </tr>
  1232. <tr>
  1233. <td></td>
  1234. <td>)</td>
  1235. <td></td><td></td>
  1236. </tr>
  1237. </table>
  1238. </div><div class="memdoc">
  1239. <p>Creates a grpc_ssl_server_certificate_config object. </p>
  1240. <ul>
  1241. <li>pem_roots_cert is the NULL-terminated string containing the PEM encoding of the client root certificates. This parameter may be NULL if the server does not want the client to be authenticated with SSL.</li>
  1242. <li>pem_key_cert_pairs is an array private key / certificate chains of the server. This parameter cannot be NULL.</li>
  1243. <li>num_key_cert_pairs indicates the number of items in the private_key_files and cert_chain_files parameters. It must be at least 1.</li>
  1244. <li>It is the caller's responsibility to free this object via <a class="el" href="grpc__security_8h.html#a077c39db13d0211eac9c6a952882bc31" title="Destroys a grpc_ssl_server_certificate_config object. ">grpc_ssl_server_certificate_config_destroy()</a>. </li>
  1245. </ul>
  1246. </div>
  1247. </div>
  1248. <a class="anchor" id="a077c39db13d0211eac9c6a952882bc31"></a>
  1249. <div class="memitem">
  1250. <div class="memproto">
  1251. <table class="memname">
  1252. <tr>
  1253. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_ssl_server_certificate_config_destroy </td>
  1254. <td>(</td>
  1255. <td class="paramtype"><a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> *&#160;</td>
  1256. <td class="paramname"><em>config</em></td><td>)</td>
  1257. <td></td>
  1258. </tr>
  1259. </table>
  1260. </div><div class="memdoc">
  1261. <p>Destroys a grpc_ssl_server_certificate_config object. </p>
  1262. </div>
  1263. </div>
  1264. <a class="anchor" id="adde6c7d191f88997fd82fd8b54f9420e"></a>
  1265. <div class="memitem">
  1266. <div class="memproto">
  1267. <table class="memname">
  1268. <tr>
  1269. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a>* grpc_ssl_server_credentials_create </td>
  1270. <td>(</td>
  1271. <td class="paramtype">const char *&#160;</td>
  1272. <td class="paramname"><em>pem_root_certs</em>, </td>
  1273. </tr>
  1274. <tr>
  1275. <td class="paramkey"></td>
  1276. <td></td>
  1277. <td class="paramtype"><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *&#160;</td>
  1278. <td class="paramname"><em>pem_key_cert_pairs</em>, </td>
  1279. </tr>
  1280. <tr>
  1281. <td class="paramkey"></td>
  1282. <td></td>
  1283. <td class="paramtype">size_t&#160;</td>
  1284. <td class="paramname"><em>num_key_cert_pairs</em>, </td>
  1285. </tr>
  1286. <tr>
  1287. <td class="paramkey"></td>
  1288. <td></td>
  1289. <td class="paramtype">int&#160;</td>
  1290. <td class="paramname"><em>force_client_auth</em>, </td>
  1291. </tr>
  1292. <tr>
  1293. <td class="paramkey"></td>
  1294. <td></td>
  1295. <td class="paramtype">void *&#160;</td>
  1296. <td class="paramname"><em>reserved</em>&#160;</td>
  1297. </tr>
  1298. <tr>
  1299. <td></td>
  1300. <td>)</td>
  1301. <td></td><td></td>
  1302. </tr>
  1303. </table>
  1304. </div><div class="memdoc">
  1305. <p>Deprecated in favor of grpc_ssl_server_credentials_create_ex. </p>
  1306. <p>Creates an SSL server_credentials object.</p>
  1307. <ul>
  1308. <li>pem_roots_cert is the NULL-terminated string containing the PEM encoding of the client root certificates. This parameter may be NULL if the server does not want the client to be authenticated with SSL.</li>
  1309. <li>pem_key_cert_pairs is an array private key / certificate chains of the server. This parameter cannot be NULL.</li>
  1310. <li>num_key_cert_pairs indicates the number of items in the private_key_files and cert_chain_files parameters. It should be at least 1.</li>
  1311. <li>force_client_auth, if set to non-zero will force the client to authenticate with an SSL cert. Note that this option is ignored if pem_root_certs is NULL. </li>
  1312. </ul>
  1313. </div>
  1314. </div>
  1315. <a class="anchor" id="a5f8a4204d09f2b10a3986d25b6583a08"></a>
  1316. <div class="memitem">
  1317. <div class="memproto">
  1318. <table class="memname">
  1319. <tr>
  1320. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a>* grpc_ssl_server_credentials_create_ex </td>
  1321. <td>(</td>
  1322. <td class="paramtype">const char *&#160;</td>
  1323. <td class="paramname"><em>pem_root_certs</em>, </td>
  1324. </tr>
  1325. <tr>
  1326. <td class="paramkey"></td>
  1327. <td></td>
  1328. <td class="paramtype"><a class="el" href="structgrpc__ssl__pem__key__cert__pair.html">grpc_ssl_pem_key_cert_pair</a> *&#160;</td>
  1329. <td class="paramname"><em>pem_key_cert_pairs</em>, </td>
  1330. </tr>
  1331. <tr>
  1332. <td class="paramkey"></td>
  1333. <td></td>
  1334. <td class="paramtype">size_t&#160;</td>
  1335. <td class="paramname"><em>num_key_cert_pairs</em>, </td>
  1336. </tr>
  1337. <tr>
  1338. <td class="paramkey"></td>
  1339. <td></td>
  1340. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td>
  1341. <td class="paramname"><em>client_certificate_request</em>, </td>
  1342. </tr>
  1343. <tr>
  1344. <td class="paramkey"></td>
  1345. <td></td>
  1346. <td class="paramtype">void *&#160;</td>
  1347. <td class="paramname"><em>reserved</em>&#160;</td>
  1348. </tr>
  1349. <tr>
  1350. <td></td>
  1351. <td>)</td>
  1352. <td></td><td></td>
  1353. </tr>
  1354. </table>
  1355. </div><div class="memdoc">
  1356. <p>Deprecated in favor of grpc_ssl_server_credentials_create_with_options. </p>
  1357. <p>Same as grpc_ssl_server_credentials_create method except uses grpc_ssl_client_certificate_request_type enum to support more ways to authenticate client cerificates. </p>
  1358. </div>
  1359. </div>
  1360. <a class="anchor" id="a019828123e4b76b8a13f7d8045396d28"></a>
  1361. <div class="memitem">
  1362. <div class="memproto">
  1363. <table class="memname">
  1364. <tr>
  1365. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a>* grpc_ssl_server_credentials_create_options_using_config </td>
  1366. <td>(</td>
  1367. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td>
  1368. <td class="paramname"><em>client_certificate_request</em>, </td>
  1369. </tr>
  1370. <tr>
  1371. <td class="paramkey"></td>
  1372. <td></td>
  1373. <td class="paramtype"><a class="el" href="grpc__security_8h.html#acb8bbd3a6006aee7f7b254d4a91d914f">grpc_ssl_server_certificate_config</a> *&#160;</td>
  1374. <td class="paramname"><em>certificate_config</em>&#160;</td>
  1375. </tr>
  1376. <tr>
  1377. <td></td>
  1378. <td>)</td>
  1379. <td></td><td></td>
  1380. </tr>
  1381. </table>
  1382. </div><div class="memdoc">
  1383. <p>Creates an options object using a certificate config. </p>
  1384. <p>Use this method when the certificates and keys of the SSL server will not change during the server's lifetime.</p>
  1385. <ul>
  1386. <li>Takes ownership of the certificate_config parameter. </li>
  1387. </ul>
  1388. </div>
  1389. </div>
  1390. <a class="anchor" id="a0bef5efe91a84e2c74b031759a9a7313"></a>
  1391. <div class="memitem">
  1392. <div class="memproto">
  1393. <table class="memname">
  1394. <tr>
  1395. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a>* grpc_ssl_server_credentials_create_options_using_config_fetcher </td>
  1396. <td>(</td>
  1397. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a29ffe63a8bb3b4945ecab42d82758f09">grpc_ssl_client_certificate_request_type</a>&#160;</td>
  1398. <td class="paramname"><em>client_certificate_request</em>, </td>
  1399. </tr>
  1400. <tr>
  1401. <td class="paramkey"></td>
  1402. <td></td>
  1403. <td class="paramtype"><a class="el" href="grpc__security_8h.html#a10aa18e9708aa3b13e9464d57ade0782">grpc_ssl_server_certificate_config_callback</a>&#160;</td>
  1404. <td class="paramname"><em>cb</em>, </td>
  1405. </tr>
  1406. <tr>
  1407. <td class="paramkey"></td>
  1408. <td></td>
  1409. <td class="paramtype">void *&#160;</td>
  1410. <td class="paramname"><em>user_data</em>&#160;</td>
  1411. </tr>
  1412. <tr>
  1413. <td></td>
  1414. <td>)</td>
  1415. <td></td><td></td>
  1416. </tr>
  1417. </table>
  1418. </div><div class="memdoc">
  1419. <p>Creates an options object using a certificate config fetcher. </p>
  1420. <p>Use this method to reload the certificates and keys of the SSL server without interrupting the operation of the server. Initial certificate config will be fetched during server initialization.</p>
  1421. <ul>
  1422. <li>user_data parameter, if not NULL, contains opaque data which will be passed to the fetcher (see definition of grpc_ssl_server_certificate_config_callback). </li>
  1423. </ul>
  1424. </div>
  1425. </div>
  1426. <a class="anchor" id="aec838ac89bd393040f0c88dad25a72ca"></a>
  1427. <div class="memitem">
  1428. <div class="memproto">
  1429. <table class="memname">
  1430. <tr>
  1431. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__security_8h.html#aa724192e56fdc03827846f16752deccc">grpc_server_credentials</a>* grpc_ssl_server_credentials_create_with_options </td>
  1432. <td>(</td>
  1433. <td class="paramtype"><a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *&#160;</td>
  1434. <td class="paramname"><em>options</em></td><td>)</td>
  1435. <td></td>
  1436. </tr>
  1437. </table>
  1438. </div><div class="memdoc">
  1439. <p>Creates an SSL server_credentials object using the provided options struct. </p>
  1440. <ul>
  1441. <li>Takes ownership of the options parameter. </li>
  1442. </ul>
  1443. </div>
  1444. </div>
  1445. <a class="anchor" id="aa22779b6b4ffefc0efdaf8de4c8314a8"></a>
  1446. <div class="memitem">
  1447. <div class="memproto">
  1448. <table class="memname">
  1449. <tr>
  1450. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_ssl_server_credentials_options_destroy </td>
  1451. <td>(</td>
  1452. <td class="paramtype"><a class="el" href="grpc__security_8h.html#ade0da78380603c2e26c81695f09ea4c8">grpc_ssl_server_credentials_options</a> *&#160;</td>
  1453. <td class="paramname"><em>options</em></td><td>)</td>
  1454. <td></td>
  1455. </tr>
  1456. </table>
  1457. </div><div class="memdoc">
  1458. <p>Destroys a grpc_ssl_server_credentials_options object. </p>
  1459. </div>
  1460. </div>
  1461. </div><!-- contents -->
  1462. <!-- start footer part -->
  1463. <hr class="footer"/><address class="footer"><small>
  1464. Generated on Fri Feb 2 2018 15:15:10 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  1465. <img class="footer" src="doxygen.png" alt="doxygen"/>
  1466. </a> 1.8.6
  1467. </small></address>
  1468. </body>
  1469. </html>