<!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.5"/>
<title>xmltooling: xmltooling::SecurityHelper Class Reference</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">xmltooling
 <span id="projectnumber">1.5.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</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">
$(document).ready(function(){initNavTree('a00073.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="a00277.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xmltooling::SecurityHelper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A helper class for working with keys, certificates, etc.
<a href="a00073.html#details">More...</a></p>
<p><code>#include <xmltooling/security/SecurityHelper.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af68899f448b1729753a65b173d8bf3e8"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#af68899f448b1729753a65b173d8bf3e8">guessEncodingFormat</a> (const char *pathname)</td></tr>
<tr class="memdesc:af68899f448b1729753a65b173d8bf3e8"><td class="mdescLeft"> </td><td class="mdescRight">Access a file to try and guess the encoding format used. <a href="#af68899f448b1729753a65b173d8bf3e8">More...</a><br/></td></tr>
<tr class="separator:af68899f448b1729753a65b173d8bf3e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adba4953bee516a644928abb7895639fa"><td class="memItemLeft" align="right" valign="top">static XSECCryptoKey * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#adba4953bee516a644928abb7895639fa">loadKeyFromFile</a> (const char *pathname, const char *format=0, const char *password=0)</td></tr>
<tr class="memdesc:adba4953bee516a644928abb7895639fa"><td class="mdescLeft"> </td><td class="mdescRight">Loads a private key from a local file. <a href="#adba4953bee516a644928abb7895639fa">More...</a><br/></td></tr>
<tr class="separator:adba4953bee516a644928abb7895639fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c30bfbfabe4ae4d7e2d65c95360afb2"><td class="memItemLeft" align="right" valign="top">static std::vector<br class="typebreak"/>
< XSECCryptoX509 * ><br class="typebreak"/>
::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a9c30bfbfabe4ae4d7e2d65c95360afb2">loadCertificatesFromFile</a> (std::vector< XSECCryptoX509 * > &certs, const char *pathname, const char *format=0, const char *password=0)</td></tr>
<tr class="memdesc:a9c30bfbfabe4ae4d7e2d65c95360afb2"><td class="mdescLeft"> </td><td class="mdescRight">Loads certificate(s) from a local file. <a href="#a9c30bfbfabe4ae4d7e2d65c95360afb2">More...</a><br/></td></tr>
<tr class="separator:a9c30bfbfabe4ae4d7e2d65c95360afb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a715213af69a9a05be27342080349e18f"><td class="memItemLeft" align="right" valign="top">static std::vector<br class="typebreak"/>
< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * ><br class="typebreak"/>
::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a715213af69a9a05be27342080349e18f">loadCRLsFromFile</a> (std::vector< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * > &crls, const char *pathname, const char *format=0)</td></tr>
<tr class="memdesc:a715213af69a9a05be27342080349e18f"><td class="mdescLeft"> </td><td class="mdescRight">Loads CRL(s) from a local file. <a href="#a715213af69a9a05be27342080349e18f">More...</a><br/></td></tr>
<tr class="separator:a715213af69a9a05be27342080349e18f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7128cb03fa47ba0c7f262151b60b381"><td class="memItemLeft" align="right" valign="top">static XSECCryptoKey * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ae7128cb03fa47ba0c7f262151b60b381">loadKeyFromURL</a> (<a class="el" href="a00081.html">SOAPTransport</a> &transport, const char *backing, const char *format=0, const char *password=0)</td></tr>
<tr class="memdesc:ae7128cb03fa47ba0c7f262151b60b381"><td class="mdescLeft"> </td><td class="mdescRight">Loads a private key from a URL. <a href="#ae7128cb03fa47ba0c7f262151b60b381">More...</a><br/></td></tr>
<tr class="separator:ae7128cb03fa47ba0c7f262151b60b381"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36455aa87b612dc2872753ee6dc317b9"><td class="memItemLeft" align="right" valign="top">static std::vector<br class="typebreak"/>
< XSECCryptoX509 * ><br class="typebreak"/>
::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a36455aa87b612dc2872753ee6dc317b9">loadCertificatesFromURL</a> (std::vector< XSECCryptoX509 * > &certs, <a class="el" href="a00081.html">SOAPTransport</a> &transport, const char *backing, const char *format=0, const char *password=0)</td></tr>
<tr class="memdesc:a36455aa87b612dc2872753ee6dc317b9"><td class="mdescLeft"> </td><td class="mdescRight">Loads certificate(s) from a URL. <a href="#a36455aa87b612dc2872753ee6dc317b9">More...</a><br/></td></tr>
<tr class="separator:a36455aa87b612dc2872753ee6dc317b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e2759e44a64e7f5e4d3ec9861204695"><td class="memItemLeft" align="right" valign="top">static std::vector<br class="typebreak"/>
< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * ><br class="typebreak"/>
::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a7e2759e44a64e7f5e4d3ec9861204695">loadCRLsFromURL</a> (std::vector< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * > &crls, <a class="el" href="a00081.html">SOAPTransport</a> &transport, const char *backing, const char *format=0)</td></tr>
<tr class="memdesc:a7e2759e44a64e7f5e4d3ec9861204695"><td class="mdescLeft"> </td><td class="mdescRight">Loads CRL(s) from a URL. <a href="#a7e2759e44a64e7f5e4d3ec9861204695">More...</a><br/></td></tr>
<tr class="separator:a7e2759e44a64e7f5e4d3ec9861204695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a114f2ac19bafe9f0fd7f2f1ca29da336"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a114f2ac19bafe9f0fd7f2f1ca29da336">matches</a> (const XSECCryptoKey &key1, const XSECCryptoKey &key2)</td></tr>
<tr class="memdesc:a114f2ac19bafe9f0fd7f2f1ca29da336"><td class="mdescLeft"> </td><td class="mdescRight">Compares two keys for equality. <a href="#a114f2ac19bafe9f0fd7f2f1ca29da336">More...</a><br/></td></tr>
<tr class="separator:a114f2ac19bafe9f0fd7f2f1ca29da336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc935b0c82c5926ea4bf210dde2397a6"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#adc935b0c82c5926ea4bf210dde2397a6">doHash</a> (const char *hashAlg, const char *buf, unsigned long buflen, bool toHex=true)</td></tr>
<tr class="memdesc:adc935b0c82c5926ea4bf210dde2397a6"><td class="mdescLeft"> </td><td class="mdescRight">Performs a hash operation over the supplied data. <a href="#adc935b0c82c5926ea4bf210dde2397a6">More...</a><br/></td></tr>
<tr class="separator:adc935b0c82c5926ea4bf210dde2397a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f22ddd0fa2dceebece0ff462710e229"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a5f22ddd0fa2dceebece0ff462710e229">getDEREncoding</a> (const <a class="el" href="a00023.html">Credential</a> &cred, const char *hash, bool nowrap=true)</td></tr>
<tr class="memdesc:a5f22ddd0fa2dceebece0ff462710e229"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format. <a href="#a5f22ddd0fa2dceebece0ff462710e229">More...</a><br/></td></tr>
<tr class="separator:a5f22ddd0fa2dceebece0ff462710e229"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28b25fe7f72789c9bdbea7b9059d8228"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a28b25fe7f72789c9bdbea7b9059d8228">getDEREncoding</a> (const XSECCryptoKey &key, const char *hash, bool nowrap=true)</td></tr>
<tr class="memdesc:a28b25fe7f72789c9bdbea7b9059d8228"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format. <a href="#a28b25fe7f72789c9bdbea7b9059d8228">More...</a><br/></td></tr>
<tr class="separator:a28b25fe7f72789c9bdbea7b9059d8228"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09eefedfa4b5fe196215d85ae02ec482"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a09eefedfa4b5fe196215d85ae02ec482">getDEREncoding</a> (const XSECCryptoX509 &cert, const char *hash, bool nowrap=true)</td></tr>
<tr class="memdesc:a09eefedfa4b5fe196215d85ae02ec482"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base64-encoded DER encoding of a certifiate's public key in SubjectPublicKeyInfo format. <a href="#a09eefedfa4b5fe196215d85ae02ec482">More...</a><br/></td></tr>
<tr class="separator:a09eefedfa4b5fe196215d85ae02ec482"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a143274c77e97d67ffcf6a3ac84e45685"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a143274c77e97d67ffcf6a3ac84e45685">getDEREncoding</a> (const <a class="el" href="a00023.html">Credential</a> &cred, bool hash=false, bool nowrap=true)</td></tr>
<tr class="separator:a143274c77e97d67ffcf6a3ac84e45685"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43c73864b57074500d31ba9d2a9e7d93"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#a43c73864b57074500d31ba9d2a9e7d93">getDEREncoding</a> (const XSECCryptoKey &key, bool hash=false, bool nowrap=true)</td></tr>
<tr class="separator:a43c73864b57074500d31ba9d2a9e7d93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7a9575d2d3638c2b50a6dbfdc210a26"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#ab7a9575d2d3638c2b50a6dbfdc210a26">getDEREncoding</a> (const XSECCryptoX509 &cert, bool hash=false, bool nowrap=true)</td></tr>
<tr class="separator:ab7a9575d2d3638c2b50a6dbfdc210a26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa243cfe7c5bfdfc805cf34becf1f1dd4"><td class="memItemLeft" align="right" valign="top">static XSECCryptoKey * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#aa243cfe7c5bfdfc805cf34becf1f1dd4">fromDEREncoding</a> (const char *buf, unsigned long buflen, bool base64=true)</td></tr>
<tr class="memdesc:aa243cfe7c5bfdfc805cf34becf1f1dd4"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a DER-encoded public key. <a href="#aa243cfe7c5bfdfc805cf34becf1f1dd4">More...</a><br/></td></tr>
<tr class="separator:aa243cfe7c5bfdfc805cf34becf1f1dd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af17ab5b1fec985954fb4cbdd220d6636"><td class="memItemLeft" align="right" valign="top">static XSECCryptoKey * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00073.html#af17ab5b1fec985954fb4cbdd220d6636">fromDEREncoding</a> (const XMLCh *buf)</td></tr>
<tr class="memdesc:af17ab5b1fec985954fb4cbdd220d6636"><td class="mdescLeft"> </td><td class="mdescRight">Decodes a base64-encoded and DER-encoded public key. <a href="#af17ab5b1fec985954fb4cbdd220d6636">More...</a><br/></td></tr>
<tr class="separator:af17ab5b1fec985954fb4cbdd220d6636"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A helper class for working with keys, certificates, etc. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adc935b0c82c5926ea4bf210dde2397a6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::doHash </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hashAlg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>buflen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>toHex</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Performs a hash operation over the supplied data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hashAlg</td><td>name of hash algorithm, syntax specific to crypto provider </td></tr>
<tr><td class="paramname">buf</td><td>input data to hash </td></tr>
<tr><td class="paramname">buflen</td><td>length of input data </td></tr>
<tr><td class="paramname">toHex</td><td>if true, hex-encodes the resulting raw bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>result of hash operation, or an empty string </dd></dl>
</div>
</div>
<a class="anchor" id="aa243cfe7c5bfdfc805cf34becf1f1dd4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static XSECCryptoKey* xmltooling::SecurityHelper::fromDEREncoding </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>buflen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>base64</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes a DER-encoded public key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>DER encoded data </td></tr>
<tr><td class="paramname">buflen</td><td>length of data in bytes </td></tr>
<tr><td class="paramname">base64</td><td>true iff DER is base64-encoded </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the decoded public key, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="af17ab5b1fec985954fb4cbdd220d6636"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static XSECCryptoKey* xmltooling::SecurityHelper::fromDEREncoding </td>
<td>(</td>
<td class="paramtype">const XMLCh * </td>
<td class="paramname"><em>buf</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes a base64-encoded and DER-encoded public key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>base64 and DER encoded data </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the decoded public key, or nullptr </dd></dl>
</div>
</div>
<a class="anchor" id="a5f22ddd0fa2dceebece0ff462710e229"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00023.html">Credential</a> & </td>
<td class="paramname"><em>cred</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format. </p>
<p>If a hash algorithm is provided, the data is digested before being base64-encoded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cred</td><td>the credential containing the key to encode </td></tr>
<tr><td class="paramname">hash</td><td>optional name of hash algorithm, syntax specific to crypto provider </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="a28b25fe7f72789c9bdbea7b9059d8228"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const XSECCryptoKey & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format. </p>
<p>If a hash algorithm is provided, the data is digested before being base64-encoded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the key to encode </td></tr>
<tr><td class="paramname">hash</td><td>optional name of hash algorithm, syntax specific to crypto provider </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="a09eefedfa4b5fe196215d85ae02ec482"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const XSECCryptoX509 & </td>
<td class="paramname"><em>cert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the base64-encoded DER encoding of a certifiate's public key in SubjectPublicKeyInfo format. </p>
<p>If a hash algorithm is provided, the data is digested before being base64-encoded.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cert</td><td>the certificate's key to encode </td></tr>
<tr><td class="paramname">hash</td><td>optional name of hash algorithm, syntax specific to crypto provider </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="a143274c77e97d67ffcf6a3ac84e45685"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00023.html">Credential</a> & </td>
<td class="paramname"><em>cred</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hash</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="a00207.html#_deprecated000001">Deprecated:</a></b></dt><dd>Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cred</td><td>the credential containing the key to encode </td></tr>
<tr><td class="paramname">hash</td><td>if true, the DER encoded data is hashed with SHA-1 before base64 encoding </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="a43c73864b57074500d31ba9d2a9e7d93"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const XSECCryptoKey & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hash</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="a00207.html#_deprecated000002">Deprecated:</a></b></dt><dd>Returns the base64-encoded DER encoding of a public key in SubjectPublicKeyInfo format.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the key to encode </td></tr>
<tr><td class="paramname">hash</td><td>if true, the DER encoded data is hashed with SHA-1 before base64 encoding </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="ab7a9575d2d3638c2b50a6dbfdc210a26"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string xmltooling::SecurityHelper::getDEREncoding </td>
<td>(</td>
<td class="paramtype">const XSECCryptoX509 & </td>
<td class="paramname"><em>cert</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hash</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>nowrap</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="a00207.html#_deprecated000003">Deprecated:</a></b></dt><dd>Returns the base64-encoded DER encoding of a certificate's public key in SubjectPublicKeyInfo format.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cert</td><td>the certificate's key to encode </td></tr>
<tr><td class="paramname">hash</td><td>if true, the DER encoded data is hashed with SHA-1 before base64 encoding </td></tr>
<tr><td class="paramname">nowrap</td><td>if true, any linefeeds will be stripped from the result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the base64 encoded key value </dd></dl>
</div>
</div>
<a class="anchor" id="af68899f448b1729753a65b173d8bf3e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* xmltooling::SecurityHelper::guessEncodingFormat </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pathname</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Access a file to try and guess the encoding format used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pathname</td><td>path to file </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>constant identifying encoding format </dd></dl>
</div>
</div>
<a class="anchor" id="a9c30bfbfabe4ae4d7e2d65c95360afb2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector<XSECCryptoX509*>::size_type xmltooling::SecurityHelper::loadCertificatesFromFile </td>
<td>(</td>
<td class="paramtype">std::vector< XSECCryptoX509 * > & </td>
<td class="paramname"><em>certs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads certificate(s) from a local file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">certs</td><td>array to populate with certificate(s) </td></tr>
<tr><td class="paramname">pathname</td><td>path to file containing certificate(s) </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying certificate encoding format </td></tr>
<tr><td class="paramname">password</td><td>optional password to decrypt certificate(s) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the resulting array </dd></dl>
</div>
</div>
<a class="anchor" id="a36455aa87b612dc2872753ee6dc317b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector<XSECCryptoX509*>::size_type xmltooling::SecurityHelper::loadCertificatesFromURL </td>
<td>(</td>
<td class="paramtype">std::vector< XSECCryptoX509 * > & </td>
<td class="paramname"><em>certs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00081.html">SOAPTransport</a> & </td>
<td class="paramname"><em>transport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>backing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads certificate(s) from a URL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">certs</td><td>array to populate with certificate(s) </td></tr>
<tr><td class="paramname">transport</td><td>object to use to acquire certificate(s) </td></tr>
<tr><td class="paramname">backing</td><td>backing file for certificate(s) (written to or read from if download fails) </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying certificate encoding format </td></tr>
<tr><td class="paramname">password</td><td>optional password to decrypt certificate(s) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the resulting array </dd></dl>
</div>
</div>
<a class="anchor" id="a715213af69a9a05be27342080349e18f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector<<a class="el" href="a00115.html">XSECCryptoX509CRL</a>*>::size_type xmltooling::SecurityHelper::loadCRLsFromFile </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * > & </td>
<td class="paramname"><em>crls</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads CRL(s) from a local file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">crls</td><td>array to populate with CRL(s) </td></tr>
<tr><td class="paramname">pathname</td><td>path to file containing CRL(s) </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying CRL encoding format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the resulting array </dd></dl>
</div>
</div>
<a class="anchor" id="a7e2759e44a64e7f5e4d3ec9861204695"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector<<a class="el" href="a00115.html">XSECCryptoX509CRL</a>*>::size_type xmltooling::SecurityHelper::loadCRLsFromURL </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="a00115.html">XSECCryptoX509CRL</a> * > & </td>
<td class="paramname"><em>crls</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00081.html">SOAPTransport</a> & </td>
<td class="paramname"><em>transport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>backing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads CRL(s) from a URL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">crls</td><td>array to populate with CRL(s) </td></tr>
<tr><td class="paramname">transport</td><td>object to use to acquire CRL(s) </td></tr>
<tr><td class="paramname">backing</td><td>backing file for CRL(s) (written to or read from if download fails) </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying CRL encoding format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of the resulting array </dd></dl>
</div>
</div>
<a class="anchor" id="adba4953bee516a644928abb7895639fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static XSECCryptoKey* xmltooling::SecurityHelper::loadKeyFromFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pathname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a private key from a local file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pathname</td><td>path to file containing key </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying key encoding format </td></tr>
<tr><td class="paramname">password</td><td>optional password to decrypt key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a populated key object </dd></dl>
</div>
</div>
<a class="anchor" id="ae7128cb03fa47ba0c7f262151b60b381"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static XSECCryptoKey* xmltooling::SecurityHelper::loadKeyFromURL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00081.html">SOAPTransport</a> & </td>
<td class="paramname"><em>transport</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>backing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>password</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a private key from a URL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">transport</td><td>object to use to acquire key </td></tr>
<tr><td class="paramname">backing</td><td>backing file for key (written to or read from if download fails) </td></tr>
<tr><td class="paramname">format</td><td>optional constant identifying key encoding format </td></tr>
<tr><td class="paramname">password</td><td>optional password to decrypt key </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a populated key object </dd></dl>
</div>
</div>
<a class="anchor" id="a114f2ac19bafe9f0fd7f2f1ca29da336"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool xmltooling::SecurityHelper::matches </td>
<td>(</td>
<td class="paramtype">const XSECCryptoKey & </td>
<td class="paramname"><em>key1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XSECCryptoKey & </td>
<td class="paramname"><em>key2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two keys for equality. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key1</td><td>first key to compare </td></tr>
<tr><td class="paramname">key2</td><td>second key to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff the keys match </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xmltooling/security/<a class="el" href="a00164.html">SecurityHelper.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00073.html">SecurityHelper</a></li>
<li class="footer">Generated on Wed Sep 2 2015 18:20:35 for xmltooling by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
