| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.9.6"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>libguac: guacamole/socket-ssl.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">libguac<span id="projectnumber"> 1.5.3</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.6 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_6bb9fad85c98b48a11165f494b9f53ce.html">guacamole</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">socket-ssl.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="socket-ssl_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef __GUACD_SOCKET_SSL_H</span></div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define __GUACD_SOCKET_SSL_H</span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include "<a class="code" href="socket-types_8h.html">socket-types.h</a>"</span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#include <openssl/ssl.h></span></div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structguac__socket__ssl__data.html"> 38</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structguac__socket__ssl__data.html">guac_socket_ssl_data</a> {</div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structguac__socket__ssl__data.html#a4b6134fe4c41d78e42abbe5d8c27330a"> 44</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structguac__socket__ssl__data.html#a4b6134fe4c41d78e42abbe5d8c27330a">fd</a>;</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structguac__socket__ssl__data.html#a22b295ba9b80cc15a5dfa4c06aea541f"> 49</a></span> SSL_CTX* <a class="code hl_variable" href="structguac__socket__ssl__data.html#a22b295ba9b80cc15a5dfa4c06aea541f">context</a>;</div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="structguac__socket__ssl__data.html#ab86a780b4801fdbf411a24255cf700ac"> 55</a></span> SSL* <a class="code hl_variable" href="structguac__socket__ssl__data.html#ab86a780b4801fdbf411a24255cf700ac">ssl</a>;</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>} <a class="code hl_struct" href="structguac__socket__ssl__data.html">guac_socket_ssl_data</a>;</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="socket-ssl_8h.html#ad831993464afec46efccf69990bdda50"> 74</a></span><a class="code hl_struct" href="structguac__socket.html">guac_socket</a>* <a class="code hl_function" href="socket-ssl_8h.html#ad831993464afec46efccf69990bdda50">guac_socket_open_secure</a>(SSL_CTX* context, <span class="keywordtype">int</span> fd);</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div> |
| <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#endif</span></div> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="ttc" id="asocket-ssl_8h_html_ad831993464afec46efccf69990bdda50"><div class="ttname"><a href="socket-ssl_8h.html#ad831993464afec46efccf69990bdda50">guac_socket_open_secure</a></div><div class="ttdeci">guac_socket * guac_socket_open_secure(SSL_CTX *context, int fd)</div><div class="ttdoc">Creates a new guac_socket which will use SSL for all communication.</div></div> |
| <div class="ttc" id="asocket-types_8h_html"><div class="ttname"><a href="socket-types_8h.html">socket-types.h</a></div><div class="ttdoc">Type definitions related to the guac_socket object.</div></div> |
| <div class="ttc" id="astructguac__socket__ssl__data_html"><div class="ttname"><a href="structguac__socket__ssl__data.html">guac_socket_ssl_data</a></div><div class="ttdoc">SSL socket-specific data.</div><div class="ttdef"><b>Definition:</b> socket-ssl.h:38</div></div> |
| <div class="ttc" id="astructguac__socket__ssl__data_html_a22b295ba9b80cc15a5dfa4c06aea541f"><div class="ttname"><a href="structguac__socket__ssl__data.html#a22b295ba9b80cc15a5dfa4c06aea541f">guac_socket_ssl_data::context</a></div><div class="ttdeci">SSL_CTX * context</div><div class="ttdoc">The current SSL context.</div><div class="ttdef"><b>Definition:</b> socket-ssl.h:49</div></div> |
| <div class="ttc" id="astructguac__socket__ssl__data_html_a4b6134fe4c41d78e42abbe5d8c27330a"><div class="ttname"><a href="structguac__socket__ssl__data.html#a4b6134fe4c41d78e42abbe5d8c27330a">guac_socket_ssl_data::fd</a></div><div class="ttdeci">int fd</div><div class="ttdoc">The file descriptor that SSL communication will take place over.</div><div class="ttdef"><b>Definition:</b> socket-ssl.h:44</div></div> |
| <div class="ttc" id="astructguac__socket__ssl__data_html_ab86a780b4801fdbf411a24255cf700ac"><div class="ttname"><a href="structguac__socket__ssl__data.html#ab86a780b4801fdbf411a24255cf700ac">guac_socket_ssl_data::ssl</a></div><div class="ttdeci">SSL * ssl</div><div class="ttdoc">The SSL connection, created automatically via guac_socket_open_secure().</div><div class="ttdef"><b>Definition:</b> socket-ssl.h:55</div></div> |
| <div class="ttc" id="astructguac__socket_html"><div class="ttname"><a href="structguac__socket.html">guac_socket</a></div><div class="ttdoc">The core I/O object of Guacamole.</div><div class="ttdef"><b>Definition:</b> socket.h:39</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 |
| </small></address> |
| </body> |
| </html> |
