1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>GRPC C++: include/grpc++/credentials.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GRPC C++
 <span id="projectnumber">0.10.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_f1b2ab2a88927c1e950e43c1cf4b634b.html">grpc++</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">credentials.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="credentials_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015, Google Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modification, are permitted provided that the following conditions are</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Redistributions in binary form must reproduce the above</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * in the documentation and/or other materials provided with the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * distribution.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * contributors may be used to endorse or promote products derived from</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * this software without specific prior written permission.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef GRPCXX_CREDENTIALS_H</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define GRPCXX_CREDENTIALS_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <memory></span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <<a class="code" href="config_8h.html">grpc++/config.h</a>></span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include <<a class="code" href="grpc__library_8h.html">grpc++/impl/grpc_library.h</a>></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">namespace </span>grpc {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>ChannelArguments;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">class </span>ChannelInterface;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>SecureCredentials;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classgrpc_1_1_credentials.html"> 47</a></span> <span class="keyword">class </span><a class="code" href="classgrpc_1_1_credentials.html">Credentials</a> : <span class="keyword">public</span> <a class="code" href="classgrpc_1_1_grpc_library.html">GrpcLibrary</a> {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classgrpc_1_1_credentials.html#af4e8a65a6cee2b847e11134671c213f2">~Credentials</a>() <a class="code" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classgrpc_1_1_credentials.html#a2b3162e0dbb4530ac1c4b81a0339b1e1">ApplyToCall</a>(grpc_call* call) = 0;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">friend</span> std::shared_ptr<Credentials> <a class="code" href="classgrpc_1_1_credentials.html#a319db47fafb1868e66fd34b8bc084f3f">CompositeCredentials</a>(</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> std::shared_ptr<Credentials>& creds1,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> std::shared_ptr<Credentials>& creds2);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> SecureCredentials* <a class="code" href="classgrpc_1_1_credentials.html#aefc960d2b52b15f2561946e0f840874f">AsSecureCredentials</a>() = 0;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">friend</span> std::shared_ptr<ChannelInterface> <a class="code" href="classgrpc_1_1_credentials.html#a6cd496f9dd7e19b5bdbafaa41036fe69">CreateChannel</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& target, <span class="keyword">const</span> std::shared_ptr<Credentials>& creds,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">const</span> <a class="code" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>& args);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> std::shared_ptr<ChannelInterface> <a class="code" href="classgrpc_1_1_credentials.html#a6cd496f9dd7e19b5bdbafaa41036fe69">CreateChannel</a>(</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& target, <span class="keyword">const</span> <a class="code" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>& args) = 0;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> };</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// Options used to build SslCredentials</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// pem_roots_cert is the buffer containing the PEM encoding of the server root</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// certificates. If this parameter is empty, the default roots will be used.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// pem_private_key is the buffer containing the PEM encoding of the client's</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment">// private key. This parameter can be empty if the client does not have a</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// private key.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// pem_cert_chain is the buffer containing the PEM encoding of the client's</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// certificate chain. This parameter can be empty if the client does not have</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">// a certificate chain.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_credentials_options.html"> 77</a></span> <span class="keyword">struct </span><a class="code" href="structgrpc_1_1_ssl_credentials_options.html">SslCredentialsOptions</a> {</div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869"> 78</a></span>  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> <a class="code" href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869">pem_root_certs</a>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e"> 79</a></span>  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> <a class="code" href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e">pem_private_key</a>;</div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b"> 80</a></span>  <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> <a class="code" href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b">pem_cert_chain</a>;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Factories for building different types of Credentials</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// The functions may return empty shared_ptr when credentials cannot be created.</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">// If a Credentials pointer is returned, it can still be invalid when used to</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// create a channel. A lame channel will be created then and all rpcs will</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">// fail on it.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment">// Builds credentials with reasonable defaults.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a63d3b2c5cb11f48742da0d245b0771d3">GoogleDefaultCredentials</a>();</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// Builds SSL Credentials given SSL specific options</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#adeb675883da0c9ad8ae4dd38214c3f16">SslCredentials</a>(</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">const</span> <a class="code" href="structgrpc_1_1_ssl_credentials_options.html">SslCredentialsOptions</a>& options);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// Builds credentials for use when running in GCE</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a485ca55548022e260806c32d74095c8c">ComputeEngineCredentials</a>();</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// Builds service account credentials.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">// json_key is the JSON key string containing the client's private key.</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// scope is a space-delimited list of the requested permissions.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// token_lifetime_seconds is the lifetime in seconds of each token acquired</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// through this service account credentials. It should be positive and should</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// not exceed grpc_max_auth_token_lifetime or will be cropped to this value.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#af2624b99e948624865a346311a613848">ServiceAccountCredentials</a>(</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& json_key, <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& scope,</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">long</span> token_lifetime_seconds);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// Builds Service Account JWT Access credentials.</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">// json_key is the JSON key string containing the client's private key.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// token_lifetime_seconds is the lifetime in seconds of each Json Web Token</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">// (JWT) created with this credentials. It should not exceed</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment">// grpc_max_auth_token_lifetime or will be cropped to this value.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a5802d0b8e29f4937281c57bbe07f3517">ServiceAccountJWTAccessCredentials</a>(</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& json_key, <span class="keywordtype">long</span> token_lifetime_seconds);</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">// Builds refresh token credentials.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// json_refresh_token is the JSON string containing the refresh token along</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// with a client_id and client_secret.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#af69bf38a7cfbd24e127deb86d50dc41d">RefreshTokenCredentials</a>(</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& json_refresh_token);</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">// Builds access token credentials.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// access_token is an oauth2 access token that was fetched using an out of band</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment">// mechanism.</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a2a08189bab0ce54afb01754bd92ebd7f">AccessTokenCredentials</a>(</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& access_token);</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">// Builds IAM credentials.</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a78c4ecc2e69303f203fd67fd272b6c96">IAMCredentials</a>(</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& authorization_token,</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">const</span> <a class="code" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>& authority_selector);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment">// Combines two credentials objects into a composite credentials</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#a0ffe059f3158d41d0e268fd375a0815c">CompositeCredentials</a>(</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> std::shared_ptr<Credentials>& creds1,</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">const</span> std::shared_ptr<Credentials>& creds2);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">// Credentials for an unencrypted, unauthenticated channel</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> std::shared_ptr<Credentials> <a class="code" href="namespacegrpc.html#ab7d08c50ff1dd9a368a9ff8191f855c3">InsecureCredentials</a>();</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> } <span class="comment">// namespace grpc</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#endif // GRPCXX_CREDENTIALS_H</span></div>
<div class="ttc" id="namespacegrpc_html_adeb675883da0c9ad8ae4dd38214c3f16"><div class="ttname"><a href="namespacegrpc.html#adeb675883da0c9ad8ae4dd38214c3f16">grpc::SslCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > SslCredentials(const SslCredentialsOptions &options)</div></div>
<div class="ttc" id="namespacegrpc_html_ab04a87625da3bf85cdaf5e7856b00203"><div class="ttname"><a href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a></div><div class="ttdeci">std::string string</div><div class="ttdef"><b>Definition:</b> config.h:112</div></div>
<div class="ttc" id="classgrpc_1_1_channel_arguments_html"><div class="ttname"><a href="classgrpc_1_1_channel_arguments.html">grpc::ChannelArguments</a></div><div class="ttdef"><b>Definition:</b> channel_arguments.h:52</div></div>
<div class="ttc" id="namespacegrpc_html_a5802d0b8e29f4937281c57bbe07f3517"><div class="ttname"><a href="namespacegrpc.html#a5802d0b8e29f4937281c57bbe07f3517">grpc::ServiceAccountJWTAccessCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > ServiceAccountJWTAccessCredentials(const grpc::string &json_key, long token_lifetime_seconds)</div></div>
<div class="ttc" id="namespacegrpc_html_af2624b99e948624865a346311a613848"><div class="ttname"><a href="namespacegrpc.html#af2624b99e948624865a346311a613848">grpc::ServiceAccountCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > ServiceAccountCredentials(const grpc::string &json_key, const grpc::string &scope, long token_lifetime_seconds)</div></div>
<div class="ttc" id="grpc__library_8h_html"><div class="ttname"><a href="grpc__library_8h.html">grpc_library.h</a></div></div>
<div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html_af4e8a65a6cee2b847e11134671c213f2"><div class="ttname"><a href="classgrpc_1_1_credentials.html#af4e8a65a6cee2b847e11134671c213f2">grpc::Credentials::~Credentials</a></div><div class="ttdeci">~Credentials() GRPC_OVERRIDE</div></div>
<div class="ttc" id="namespacegrpc_html_a2a08189bab0ce54afb01754bd92ebd7f"><div class="ttname"><a href="namespacegrpc.html#a2a08189bab0ce54afb01754bd92ebd7f">grpc::AccessTokenCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > AccessTokenCredentials(const grpc::string &access_token)</div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html_a2b3162e0dbb4530ac1c4b81a0339b1e1"><div class="ttname"><a href="classgrpc_1_1_credentials.html#a2b3162e0dbb4530ac1c4b81a0339b1e1">grpc::Credentials::ApplyToCall</a></div><div class="ttdeci">virtual bool ApplyToCall(grpc_call *call)=0</div></div>
<div class="ttc" id="namespacegrpc_html_a485ca55548022e260806c32d74095c8c"><div class="ttname"><a href="namespacegrpc.html#a485ca55548022e260806c32d74095c8c">grpc::ComputeEngineCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > ComputeEngineCredentials()</div></div>
<div class="ttc" id="structgrpc_1_1_ssl_credentials_options_html_a0ce1730020e18d04b6af48c88e069869"><div class="ttname"><a href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869">grpc::SslCredentialsOptions::pem_root_certs</a></div><div class="ttdeci">grpc::string pem_root_certs</div><div class="ttdef"><b>Definition:</b> credentials.h:78</div></div>
<div class="ttc" id="structgrpc_1_1_ssl_credentials_options_html"><div class="ttname"><a href="structgrpc_1_1_ssl_credentials_options.html">grpc::SslCredentialsOptions</a></div><div class="ttdef"><b>Definition:</b> credentials.h:77</div></div>
<div class="ttc" id="classgrpc_1_1_grpc_library_html"><div class="ttname"><a href="classgrpc_1_1_grpc_library.html">grpc::GrpcLibrary</a></div><div class="ttdef"><b>Definition:</b> grpc_library.h:41</div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html_aefc960d2b52b15f2561946e0f840874f"><div class="ttname"><a href="classgrpc_1_1_credentials.html#aefc960d2b52b15f2561946e0f840874f">grpc::Credentials::AsSecureCredentials</a></div><div class="ttdeci">virtual SecureCredentials * AsSecureCredentials()=0</div></div>
<div class="ttc" id="namespacegrpc_html_af69bf38a7cfbd24e127deb86d50dc41d"><div class="ttname"><a href="namespacegrpc.html#af69bf38a7cfbd24e127deb86d50dc41d">grpc::RefreshTokenCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > RefreshTokenCredentials(const grpc::string &json_refresh_token)</div></div>
<div class="ttc" id="structgrpc_1_1_ssl_credentials_options_html_a01015d8ec7dbf49f2ac3cd21f21d383b"><div class="ttname"><a href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b">grpc::SslCredentialsOptions::pem_cert_chain</a></div><div class="ttdeci">grpc::string pem_cert_chain</div><div class="ttdef"><b>Definition:</b> credentials.h:80</div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html"><div class="ttname"><a href="classgrpc_1_1_credentials.html">grpc::Credentials</a></div><div class="ttdef"><b>Definition:</b> credentials.h:47</div></div>
<div class="ttc" id="structgrpc_1_1_ssl_credentials_options_html_a5b661f8daf02db7283774e0fb9a8979e"><div class="ttname"><a href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e">grpc::SslCredentialsOptions::pem_private_key</a></div><div class="ttdeci">grpc::string pem_private_key</div><div class="ttdef"><b>Definition:</b> credentials.h:79</div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html_a6cd496f9dd7e19b5bdbafaa41036fe69"><div class="ttname"><a href="classgrpc_1_1_credentials.html#a6cd496f9dd7e19b5bdbafaa41036fe69">grpc::Credentials::CreateChannel</a></div><div class="ttdeci">friend std::shared_ptr< ChannelInterface > CreateChannel(const grpc::string &target, const std::shared_ptr< Credentials > &creds, const ChannelArguments &args)</div></div>
<div class="ttc" id="namespacegrpc_html_a63d3b2c5cb11f48742da0d245b0771d3"><div class="ttname"><a href="namespacegrpc.html#a63d3b2c5cb11f48742da0d245b0771d3">grpc::GoogleDefaultCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > GoogleDefaultCredentials()</div></div>
<div class="ttc" id="classgrpc_1_1_credentials_html_a319db47fafb1868e66fd34b8bc084f3f"><div class="ttname"><a href="classgrpc_1_1_credentials.html#a319db47fafb1868e66fd34b8bc084f3f">grpc::Credentials::CompositeCredentials</a></div><div class="ttdeci">friend std::shared_ptr< Credentials > CompositeCredentials(const std::shared_ptr< Credentials > &creds1, const std::shared_ptr< Credentials > &creds2)</div></div>
<div class="ttc" id="namespacegrpc_html_ab7d08c50ff1dd9a368a9ff8191f855c3"><div class="ttname"><a href="namespacegrpc.html#ab7d08c50ff1dd9a368a9ff8191f855c3">grpc::InsecureCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > InsecureCredentials()</div></div>
<div class="ttc" id="namespacegrpc_html_a0ffe059f3158d41d0e268fd375a0815c"><div class="ttname"><a href="namespacegrpc.html#a0ffe059f3158d41d0e268fd375a0815c">grpc::CompositeCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > CompositeCredentials(const std::shared_ptr< Credentials > &creds1, const std::shared_ptr< Credentials > &creds2)</div></div>
<div class="ttc" id="config_8h_html_a9a884d706be26697c9c892365a3402a9"><div class="ttname"><a href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></div><div class="ttdeci">#define GRPC_OVERRIDE</div><div class="ttdef"><b>Definition:</b> config.h:77</div></div>
<div class="ttc" id="namespacegrpc_html_a78c4ecc2e69303f203fd67fd272b6c96"><div class="ttname"><a href="namespacegrpc.html#a78c4ecc2e69303f203fd67fd272b6c96">grpc::IAMCredentials</a></div><div class="ttdeci">std::shared_ptr< Credentials > IAMCredentials(const grpc::string &authorization_token, const grpc::string &authority_selector)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:06 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|
