| <!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 Core: src/core/tsi/ssl_transport_security.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 Core |
|  <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="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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_99f60d2bb6231896bcd2887028065f74.html">tsi</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">ssl_transport_security.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="ssl__transport__security_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <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 GRPC_INTERNAL_CORE_TSI_SSL_TRANSPORT_SECURITY_H</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define GRPC_INTERNAL_CORE_TSI_SSL_TRANSPORT_SECURITY_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 "<a class="code" href="transport__security__interface_8h.html">src/core/tsi/transport_security_interface.h</a>"</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">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/* Value for the TSI_CERTIFICATE_TYPE_PEER_PROPERTY property for X509 certs. */</span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="ssl__transport__security_8h.html#a394dce2eccd1a35e54ea94ed19b95a7c"> 44</a></span> <span class="preprocessor">#define TSI_X509_CERTIFICATE_TYPE "X509"</span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/* This property is of type TSI_PEER_PROPERTY_STRING. */</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="ssl__transport__security_8h.html#a3015d52d16728b0e28f354217fbb6296"> 47</a></span> <span class="preprocessor">#define TSI_X509_SUBJECT_COMMON_NAME_PEER_PROPERTY "x509_subject_common_name"</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="ssl__transport__security_8h.html#a64e0648b7d1eec9671f01aa79f508c0f"> 48</a></span> <span class="preprocessor"></span><span class="preprocessor">#define TSI_X509_SUBJECT_ALTERNATIVE_NAME_PEER_PROPERTY \</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"> "x509_subject_alternative_name"</span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="ssl__transport__security_8h.html#a7772b205a40f5d0e6bf613f666df70fa"> 51</a></span> <span class="preprocessor">#define TSI_SSL_ALPN_SELECTED_PROTOCOL "ssl_alpn_selected_protocol"</span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/* --- tsi_ssl_handshaker_factory object ---</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> This object creates tsi_handshaker objects implemented in terms of the</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> TLS 1.2 specificiation. */</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> |
| <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="ssl__transport__security_8h.html#a33648ab82d52fddf97cd254ab14cad32"> 58</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a> <a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a>;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/* Creates a client handshaker factory.</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</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="l00062"></a><span class="lineno"> 62</span> <span class="comment"> private key. This parameter can be NULL if the client does not have a</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> private key.</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> - pem_private_key_size is the size of the associated buffer.</span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</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="l00066"></a><span class="lineno"> 66</span> <span class="comment"> certificate chain. This parameter can be NULL if the client does not have</span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> a certificate chain.</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> - pem_cert_chain_size is the size of the associated buffer.</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</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> root certificates. This parameter cannot be NULL.</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> - pem_roots_cert_size is the size of the associated buffer.</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> - cipher_suites contains an optional list of the ciphers that the client</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> supports. The format of this string is described in:</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> https://www.openssl.org/docs/apps/ciphers.html.</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> This parameter can be set to NULL to use the default set of ciphers.</span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> TODO(jboeuf): Revisit the format of this parameter.</span></div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> - alpn_protocols is an array containing the protocol names that the</span></div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> handshakers created with this factory support. This parameter can be NULL.</span></div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> - alpn_protocols_lengths is an array containing the lengths of the alpn</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> protocols specified in alpn_protocols. This parameter can be NULL.</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> - num_alpn_protocols is the number of alpn protocols and associated lengths</span></div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> specified. If this parameter is 0, the other alpn parameters must be NULL.</span></div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> - factory is the address of the factory pointer to be created.</span></div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> - This method returns TSI_OK on success or TSI_INVALID_PARAMETER in the case</span></div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> where a parameter is invalid. */</span></div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <a class="code" href="transport__security__interface_8h.html#a368f59529aaab1dab4d117adfabcb468">tsi_result</a> <a class="code" href="ssl__transport__security_8h.html#a24150414d752e0cf6a28ff47a7b1c954">tsi_create_ssl_client_handshaker_factory</a>(</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pem_private_key, <span class="keywordtype">size_t</span> pem_private_key_size,</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pem_cert_chain, <span class="keywordtype">size_t</span> pem_cert_chain_size,</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pem_root_certs, <span class="keywordtype">size_t</span> pem_root_certs_size,</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* cipher_suites, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>** alpn_protocols,</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* alpn_protocols_lengths, uint16_t num_alpn_protocols,</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a>** factory);</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">/* Creates a server handshaker factory.</span></div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> - version indicates which version of the specification to use.</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> - pem_private_keys is an array containing the PEM encoding of the server's</span></div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> private keys. This parameter cannot be NULL. The size of the array is</span></div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> given by the key_cert_pair_count parameter.</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> - pem_private_keys_sizes is the array containing the sizes of the associated</span></div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> buffers.</span></div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> - pem_cert_chains is an array containing the PEM encoding of the server's</span></div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> cert chains. This parameter cannot be NULL. The size of the array is</span></div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> given by the key_cert_pair_count parameter.</span></div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> - pem_cert_chains_sizes is the array containing the sizes of the associated</span></div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> buffers.</span></div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> - key_cert_pair_count indicates the number of items in the private_key_files</span></div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> and cert_chain_files parameters.</span></div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> - pem_client_roots is the buffer containing the PEM encoding of the client</span></div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> root certificates. This parameter may be NULL in which case the server will</span></div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> not authenticate the client. If not NULL, the force_client_auth parameter</span></div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> specifies if the server will accept only authenticated clients or both</span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> authenticated and non-authenticated clients.</span></div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> - pem_client_root_certs_size is the size of the associated buffer.</span></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> - force_client_auth, if set to non-zero will force the client to authenticate</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> with an SSL cert. Note that this option is ignored if pem_client_root_certs</span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> is NULL or pem_client_roots_certs_size is 0</span></div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> - cipher_suites contains an optional list of the ciphers that the server</span></div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> supports. The format of this string is described in:</span></div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> https://www.openssl.org/docs/apps/ciphers.html.</span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> This parameter can be set to NULL to use the default set of ciphers.</span></div> |
| <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> TODO(jboeuf): Revisit the format of this parameter.</span></div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> - alpn_protocols is an array containing the protocol names that the</span></div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> handshakers created with this factory support. This parameter can be NULL.</span></div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> - alpn_protocols_lengths is an array containing the lengths of the alpn</span></div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> protocols specified in alpn_protocols. This parameter can be NULL.</span></div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> - num_alpn_protocols is the number of alpn protocols and associated lengths</span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> specified. If this parameter is 0, the other alpn parameters must be NULL.</span></div> |
| <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> - factory is the address of the factory pointer to be created.</span></div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> - This method returns TSI_OK on success or TSI_INVALID_PARAMETER in the case</span></div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> where a parameter is invalid. */</span></div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <a class="code" href="transport__security__interface_8h.html#a368f59529aaab1dab4d117adfabcb468">tsi_result</a> <a class="code" href="ssl__transport__security_8h.html#a07cacb661f68fba399bd2a8075246104">tsi_create_ssl_server_handshaker_factory</a>(</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>** pem_private_keys,</div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span>* pem_private_keys_sizes, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>** pem_cert_chains,</div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> <span class="keywordtype">size_t</span>* pem_cert_chains_sizes, <span class="keywordtype">size_t</span> key_cert_pair_count,</div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* pem_client_root_certs,</div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">size_t</span> pem_client_root_certs_size, <span class="keywordtype">int</span> force_client_auth,</div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* cipher_suites, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>** alpn_protocols,</div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* alpn_protocols_lengths, uint16_t num_alpn_protocols,</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a>** factory);</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment">/* Creates a handshaker.</span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> - self is the factory from which the handshaker will be created.</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> - server_name_indication indicates the name of the server the client is</span></div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> trying to connect to which will be relayed to the server using the SNI</span></div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> extension.</span></div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> This parameter must be NULL for a server handshaker factory.</span></div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> - handhshaker is the address of the handshaker pointer to be created.</span></div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> - This method returns TSI_OK on success or TSI_INVALID_PARAMETER in the case</span></div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> where a parameter is invalid. */</span></div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <a class="code" href="transport__security__interface_8h.html#a368f59529aaab1dab4d117adfabcb468">tsi_result</a> <a class="code" href="ssl__transport__security_8h.html#a640862c021958b7cc4e841d5842b3142">tsi_ssl_handshaker_factory_create_handshaker</a>(</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a>* <span class="keyword">self</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* server_name_indication,</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <a class="code" href="structtsi__handshaker.html">tsi_handshaker</a>** handshaker);</div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/* Destroys the handshaker factory. WARNING: it is unsafe to destroy a factory</span></div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> while handshakers created with this factory are still in use. */</span></div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keywordtype">void</span> <a class="code" href="ssl__transport__security_8h.html#a55e5ff567c916f396a960d9ba259fd5b">tsi_ssl_handshaker_factory_destroy</a>(<a class="code" href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a>* <span class="keyword">self</span>);</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/* Util that checks that an ssl peer matches a specific name.</span></div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> Still TODO(jboeuf):</span></div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> - handle mixed case.</span></div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> - handle %encoded chars.</span></div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> - handle public suffix wildchar more strictly (e.g. *.co.uk)</span></div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> - handle IP addresses in SAN. */</span></div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keywordtype">int</span> <a class="code" href="ssl__transport__security_8h.html#a22edee478b3473e184d77d74c13d9647">tsi_ssl_peer_matches_name</a>(<span class="keyword">const</span> <a class="code" href="structtsi__peer.html">tsi_peer</a>* peer, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span> </div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="preprocessor">#ifdef __cplusplus</span></div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="preprocessor"></span>}</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="preprocessor">#endif</span></div> |
| <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor">#endif </span><span class="comment">/* GRPC_INTERNAL_CORE_TSI_SSL_TRANSPORT_SECURITY_H */</span><span class="preprocessor"></span></div> |
| <div class="ttc" id="ssl__transport__security_8h_html_a24150414d752e0cf6a28ff47a7b1c954"><div class="ttname"><a href="ssl__transport__security_8h.html#a24150414d752e0cf6a28ff47a7b1c954">tsi_create_ssl_client_handshaker_factory</a></div><div class="ttdeci">tsi_result tsi_create_ssl_client_handshaker_factory(const unsigned char *pem_private_key, size_t pem_private_key_size, const unsigned char *pem_cert_chain, size_t pem_cert_chain_size, const unsigned char *pem_root_certs, size_t pem_root_certs_size, const char *cipher_suites, const unsigned char **alpn_protocols, const unsigned char *alpn_protocols_lengths, uint16_t num_alpn_protocols, tsi_ssl_handshaker_factory **factory)</div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:1214</div></div> |
| <div class="ttc" id="transport__security__interface_8h_html"><div class="ttname"><a href="transport__security__interface_8h.html">transport_security_interface.h</a></div></div> |
| <div class="ttc" id="ssl__transport__security_8h_html_a07cacb661f68fba399bd2a8075246104"><div class="ttname"><a href="ssl__transport__security_8h.html#a07cacb661f68fba399bd2a8075246104">tsi_create_ssl_server_handshaker_factory</a></div><div class="ttdeci">tsi_result tsi_create_ssl_server_handshaker_factory(const unsigned char **pem_private_keys, const size_t *pem_private_keys_sizes, const unsigned char **pem_cert_chains, const size_t *pem_cert_chains_sizes, size_t key_cert_pair_count, const unsigned char *pem_client_root_certs, size_t pem_client_root_certs_size, int force_client_auth, const char *cipher_suites, const unsigned char **alpn_protocols, const unsigned char *alpn_protocols_lengths, uint16_t num_alpn_protocols, tsi_ssl_handshaker_factory **factory)</div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:1291</div></div> |
| <div class="ttc" id="structtsi__ssl__handshaker__factory_html"><div class="ttname"><a href="structtsi__ssl__handshaker__factory.html">tsi_ssl_handshaker_factory</a></div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:71</div></div> |
| <div class="ttc" id="ssl__transport__security_8h_html_a640862c021958b7cc4e841d5842b3142"><div class="ttname"><a href="ssl__transport__security_8h.html#a640862c021958b7cc4e841d5842b3142">tsi_ssl_handshaker_factory_create_handshaker</a></div><div class="ttdeci">tsi_result tsi_ssl_handshaker_factory_create_handshaker(tsi_ssl_handshaker_factory *self, const char *server_name_indication, tsi_handshaker **handshaker)</div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:955</div></div> |
| <div class="ttc" id="structtsi__peer_html"><div class="ttname"><a href="structtsi__peer.html">tsi_peer</a></div><div class="ttdef"><b>Definition:</b> transport_security_interface.h:192</div></div> |
| <div class="ttc" id="transport__security__interface_8h_html_a368f59529aaab1dab4d117adfabcb468"><div class="ttname"><a href="transport__security__interface_8h.html#a368f59529aaab1dab4d117adfabcb468">tsi_result</a></div><div class="ttdeci">tsi_result</div><div class="ttdef"><b>Definition:</b> transport_security_interface.h:46</div></div> |
| <div class="ttc" id="ssl__transport__security_8h_html_a55e5ff567c916f396a960d9ba259fd5b"><div class="ttname"><a href="ssl__transport__security_8h.html#a55e5ff567c916f396a960d9ba259fd5b">tsi_ssl_handshaker_factory_destroy</a></div><div class="ttdeci">void tsi_ssl_handshaker_factory_destroy(tsi_ssl_handshaker_factory *self)</div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:962</div></div> |
| <div class="ttc" id="ssl__transport__security_8h_html_a22edee478b3473e184d77d74c13d9647"><div class="ttname"><a href="ssl__transport__security_8h.html#a22edee478b3473e184d77d74c13d9647">tsi_ssl_peer_matches_name</a></div><div class="ttdeci">int tsi_ssl_peer_matches_name(const tsi_peer *peer, const char *name)</div><div class="ttdef"><b>Definition:</b> ssl_transport_security.c:1396</div></div> |
| <div class="ttc" id="structtsi__handshaker_html"><div class="ttname"><a href="structtsi__handshaker.html">tsi_handshaker</a></div><div class="ttdef"><b>Definition:</b> transport_security.h:86</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Aug 5 2015 08:17:07 for GRPC Core 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> |