2020-11-29 06:34:38 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2020-11-11 02:29:23 +01:00
< 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" / >
2021-03-22 00:17:23 +01:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2020-11-29 06:34:38 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2020-11-11 02:29:23 +01:00
< title > SSLClient: src/SSLClientParameters.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 = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.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 style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > SSLClient
2020-11-29 06:42:54 +01:00
  < span id = "projectnumber" > v1.6.10< / span >
2020-11-11 02:29:23 +01:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2021-03-22 00:17:23 +01:00
<!-- Generated by Doxygen 1.9.1 -->
2020-11-11 02:29:23 +01:00
< script type = "text/javascript" >
2020-11-29 06:34:38 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2021-03-22 00:17:23 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2020-11-29 06:34:38 +01:00
/* @license-end */
2020-11-11 02:29:23 +01:00
< / script >
2020-11-29 06:34:38 +01:00
< 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:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
2020-11-11 02:29:23 +01:00
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2020-11-29 06:34:38 +01:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_s_s_l_client_parameters_8h_source.html',''); initResizable(); });
/* @license-end */
2020-11-11 02:29:23 +01:00
< / script >
< div id = "doc-content" >
<!-- 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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > SSLClientParameters.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2020-11-29 06:34:38 +01:00
< a href = "_s_s_l_client_parameters_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" > /* Copyright 2019 OSU OPEnS Lab< / 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" > * Permission is hereby granted, free of charge, to any person obtaining a copy of this< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > * software and associated documentation files (the " Software" ), to deal in the Software< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > * without restriction, including without limitation the rights to use, copy, modify,< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "comment" > * permit persons to whom the Software is furnished to do so, subject to the following< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "comment" > * conditions:< / 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" > * The above copyright notice and this permission notice shall be included in all< / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "comment" > * copies or substantial portions of the Software.< / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < span class = "comment" > * THE SOFTWARE IS PROVIDED " AS IS" , WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,< / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < span class = "comment" > * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A< / span > < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "comment" > * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT< / span > < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "comment" > * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION< / span > < / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "comment" > * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE< / span > < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "comment" > * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.< / 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 >   < / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "preprocessor" > #include " bearssl.h" < / span > < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "preprocessor" > #undef min< / span > < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < span class = "preprocessor" > #undef max< / span > < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < span class = "preprocessor" > #include < vector> < / span > < / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < span class = "preprocessor" > #ifndef SSLClientParameters_H_< / span > < / div >
< div class = "line" > < a name = "l00034" > < / a > < span class = "lineno" > 34< / span >   < span class = "preprocessor" > #define SSLClientParameters_H_< / span > < / div >
< div class = "line" > < a name = "l00035" > < / a > < span class = "lineno" > 35< / span >   < / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_s_l_client_parameters.html" > 52< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "class_s_s_l_client_parameters.html" > SSLClientParameters< / a > {< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00084" > < / a > < span class = "lineno" > 84< / span >   < span class = "keyword" > static< / span > < a class = "code" href = "class_s_s_l_client_parameters.html" > SSLClientParameters< / a > < a class = "code" href = "class_s_s_l_client_parameters.html#ac5ddf993f7d560581297471593051ea6" > fromPEM< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * cert_pem, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > cert_len, < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * key_pem, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > key_len);< / div >
< div class = "line" > < a name = "l00085" > < / a > < span class = "lineno" > 85< / span >   < / div >
< div class = "line" > < a name = "l00112" > < / a > < span class = "lineno" > 112< / span >   < span class = "keyword" > static< / span > < a class = "code" href = "class_s_s_l_client_parameters.html" > SSLClientParameters< / a > < a class = "code" href = "class_s_s_l_client_parameters.html#a12e44f4b8340ef7f1dcbbed7649e4bef" > fromDER< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * cert_der, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > cert_len, < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * key_der, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > key_len);< / div >
< div class = "line" > < a name = "l00113" > < / a > < span class = "lineno" > 113< / span >   < / div >
< div class = "line" > < a name = "l00115" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_s_l_client_parameters.html#af5686b2c601812f55477a7089b3b2c2d" > 115< / a > < / span >   < span class = "keyword" > const< / span > br_x509_certificate* < a class = "code" href = "class_s_s_l_client_parameters.html#af5686b2c601812f55477a7089b3b2c2d" > getCertChain< / a > ()< span class = "keyword" > const < / span > { < span class = "keywordflow" > return< / span > & m_cert_struct; }< / div >
< div class = "line" > < a name = "l00116" > < / a > < span class = "lineno" > 116< / span >   < / div >
< div class = "line" > < a name = "l00118" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_s_l_client_parameters.html#a90d581703308881714d64d1ada785ad2" > 118< / a > < / span >   < span class = "keywordtype" > int< / span > < a class = "code" href = "class_s_s_l_client_parameters.html#a90d581703308881714d64d1ada785ad2" > getCertType< / a > ()< span class = "keyword" > const < / span > { < span class = "keywordflow" > return< / span > br_skey_decoder_key_type(& m_key_struct); }< / div >
< div class = "line" > < a name = "l00119" > < / a > < span class = "lineno" > 119< / span >   < / div >
< div class = "line" > < a name = "l00121" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_s_l_client_parameters.html#ad9beb80ce98ed9aa34db28783f0264c5" > 121< / a > < / span >   < span class = "keyword" > const< / span > br_ec_private_key* < a class = "code" href = "class_s_s_l_client_parameters.html#ad9beb80ce98ed9aa34db28783f0264c5" > getECKey< / a > ()< span class = "keyword" > const < / span > { < span class = "keywordflow" > return< / span > br_skey_decoder_get_ec(& m_key_struct); }< / div >
< div class = "line" > < a name = "l00122" > < / a > < span class = "lineno" > 122< / span >   < / div >
< div class = "line" > < a name = "l00124" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_s_l_client_parameters.html#a82c21b0ae4690a6b7842a0d74b12f67f" > 124< / a > < / span >   < span class = "keyword" > const< / span > br_rsa_private_key* < a class = "code" href = "class_s_s_l_client_parameters.html#a82c21b0ae4690a6b7842a0d74b12f67f" > getRSAKey< / a > ()< span class = "keyword" > const < / span > { < span class = "keywordflow" > return< / span > br_skey_decoder_get_rsa(& m_key_struct); }< / div >
< div class = "line" > < a name = "l00125" > < / a > < span class = "lineno" > 125< / span >   < / div >
< div class = "line" > < a name = "l00126" > < / a > < span class = "lineno" > 126< / span >   < span class = "keyword" > protected< / span > :< / div >
< div class = "line" > < a name = "l00127" > < / a > < span class = "lineno" > 127< / span >   < a class = "code" href = "class_s_s_l_client_parameters.html#a97213b5554e90908fbf284669b5f22f3" > SSLClientParameters< / a > (< span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * cert, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > cert_len, < span class = "keyword" > const< / span > < span class = "keywordtype" > char< / span > * key, < span class = "keyword" > const< / span > < span class = "keywordtype" > size_t< / span > key_len, < span class = "keywordtype" > bool< / span > is_der);< / 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 = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00130" > < / a > < span class = "lineno" > 130< / span >   < span class = "keyword" > const< / span > std::vector< char> m_cert;< / div >
< div class = "line" > < a name = "l00131" > < / a > < span class = "lineno" > 131< / span >   < span class = "keyword" > const< / span > br_x509_certificate m_cert_struct;< / div >
< div class = "line" > < a name = "l00132" > < / a > < span class = "lineno" > 132< / span >   < span class = "keyword" > const< / span > br_skey_decoder_context m_key_struct;< / 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 >   < / div >
< div class = "line" > < a name = "l00135" > < / a > < span class = "lineno" > 135< / span >   < span class = "preprocessor" > #endif< / span > < / div >
2021-03-22 00:17:23 +01:00
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html" > SSLClientParameters< / a > < / div > < div class = "ttdoc" > This class stores data required for SSLClient to use mutual authentication.< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.h:52< / div > < / div >
2020-11-29 06:34:38 +01:00
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_a12e44f4b8340ef7f1dcbbed7649e4bef" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#a12e44f4b8340ef7f1dcbbed7649e4bef" > SSLClientParameters::fromDER< / a > < / div > < div class = "ttdeci" > static SSLClientParameters fromDER(const char *cert_der, const size_t cert_len, const char *key_der, const size_t key_len)< / div > < div class = "ttdoc" > Create mutual authentication parameters from a DER certificate and private key.< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.cpp:91< / div > < / div >
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_a82c21b0ae4690a6b7842a0d74b12f67f" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#a82c21b0ae4690a6b7842a0d74b12f67f" > SSLClientParameters::getRSAKey< / a > < / div > < div class = "ttdeci" > const br_rsa_private_key * getRSAKey() const< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.h:124< / div > < / div >
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_a90d581703308881714d64d1ada785ad2" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#a90d581703308881714d64d1ada785ad2" > SSLClientParameters::getCertType< / a > < / div > < div class = "ttdeci" > int getCertType() const< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.h:118< / div > < / div >
2021-03-22 00:17:23 +01:00
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_a97213b5554e90908fbf284669b5f22f3" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#a97213b5554e90908fbf284669b5f22f3" > SSLClientParameters::SSLClientParameters< / a > < / div > < div class = "ttdeci" > SSLClientParameters(const char *cert, const size_t cert_len, const char *key, const size_t key_len, bool is_der)< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.cpp:80< / div > < / div >
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_ac5ddf993f7d560581297471593051ea6" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#ac5ddf993f7d560581297471593051ea6" > SSLClientParameters::fromPEM< / a > < / div > < div class = "ttdeci" > static SSLClientParameters fromPEM(const char *cert_pem, const size_t cert_len, const char *key_pem, const size_t key_len)< / div > < div class = "ttdoc" > Create mutual authentication parameters from a PEM certificate and private key.< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.cpp:86< / div > < / div >
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_ad9beb80ce98ed9aa34db28783f0264c5" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#ad9beb80ce98ed9aa34db28783f0264c5" > SSLClientParameters::getECKey< / a > < / div > < div class = "ttdeci" > const br_ec_private_key * getECKey() const< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.h:121< / div > < / div >
< div class = "ttc" id = "aclass_s_s_l_client_parameters_html_af5686b2c601812f55477a7089b3b2c2d" > < div class = "ttname" > < a href = "class_s_s_l_client_parameters.html#af5686b2c601812f55477a7089b3b2c2d" > SSLClientParameters::getCertChain< / a > < / div > < div class = "ttdeci" > const br_x509_certificate * getCertChain() const< / div > < div class = "ttdef" > < b > Definition:< / b > SSLClientParameters.h:115< / div > < / div >
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2020-11-11 02:29:23 +01:00
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "dir_68267d1309a1af8e8297ef4c3efbcdba.html" > src< / a > < / li > < li class = "navelem" > < a class = "el" href = "_s_s_l_client_parameters_8h.html" > SSLClientParameters.h< / a > < / li >
2021-03-22 00:17:23 +01:00
< li class = "footer" > 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.1 < / li >
2020-11-11 02:29:23 +01:00
< / ul >
< / div >
< / body >
< / html >
