mirror of
https://github.com/moparisthebest/mailiverse
synced 2024-11-06 17:35:04 -05:00
496 lines
10 KiB
HTML
496 lines
10 KiB
HTML
|
<!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" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="generator" content="JsDoc Toolkit" />
|
||
|
|
|
||
|
|
<title>jsrsasign 1.2 JavaScript API Reference - RSAKey</title>
|
||
|
|
|
||
|
|
<style type="text/css">
|
||
|
|
/* default.css */
|
||
|
|
body
|
||
|
|
{
|
||
|
|
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
|
||
|
|
width: 800px;
|
||
|
|
}
|
||
|
|
|
||
|
|
.header
|
||
|
|
{
|
||
|
|
clear: both;
|
||
|
|
background-color: #ccc;
|
||
|
|
padding: 8px;
|
||
|
|
}
|
||
|
|
|
||
|
|
h1
|
||
|
|
{
|
||
|
|
font-size: 150%;
|
||
|
|
font-weight: bold;
|
||
|
|
padding: 0;
|
||
|
|
margin: 1em 0 0 .3em;
|
||
|
|
}
|
||
|
|
|
||
|
|
hr
|
||
|
|
{
|
||
|
|
border: none 0;
|
||
|
|
border-top: 1px solid #7F8FB1;
|
||
|
|
height: 1px;
|
||
|
|
}
|
||
|
|
|
||
|
|
pre.code
|
||
|
|
{
|
||
|
|
display: block;
|
||
|
|
padding: 8px;
|
||
|
|
border: 1px dashed #ccc;
|
||
|
|
}
|
||
|
|
|
||
|
|
#index
|
||
|
|
{
|
||
|
|
margin-top: 24px;
|
||
|
|
float: left;
|
||
|
|
width: 160px;
|
||
|
|
position: absolute;
|
||
|
|
left: 8px;
|
||
|
|
background-color: #F3F3F3;
|
||
|
|
padding: 8px;
|
||
|
|
}
|
||
|
|
|
||
|
|
#content
|
||
|
|
{
|
||
|
|
margin-left: 190px;
|
||
|
|
width: 600px;
|
||
|
|
}
|
||
|
|
|
||
|
|
.classList
|
||
|
|
{
|
||
|
|
list-style-type: none;
|
||
|
|
padding: 0;
|
||
|
|
margin: 0 0 0 8px;
|
||
|
|
font-family: arial, sans-serif;
|
||
|
|
font-size: 1em;
|
||
|
|
overflow: auto;
|
||
|
|
}
|
||
|
|
|
||
|
|
.classList li
|
||
|
|
{
|
||
|
|
padding: 0;
|
||
|
|
margin: 0 0 8px 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
.summaryTable { width: 100%; }
|
||
|
|
|
||
|
|
h1.classTitle
|
||
|
|
{
|
||
|
|
font-size:170%;
|
||
|
|
line-height:130%;
|
||
|
|
}
|
||
|
|
|
||
|
|
h2 { font-size: 110%; }
|
||
|
|
caption, div.sectionTitle
|
||
|
|
{
|
||
|
|
background-color: #7F8FB1;
|
||
|
|
color: #fff;
|
||
|
|
font-size:130%;
|
||
|
|
text-align: left;
|
||
|
|
padding: 2px 6px 2px 6px;
|
||
|
|
border: 1px #7F8FB1 solid;
|
||
|
|
}
|
||
|
|
|
||
|
|
div.sectionTitle { margin-bottom: 8px; }
|
||
|
|
.summaryTable thead { display: none; }
|
||
|
|
|
||
|
|
.summaryTable td
|
||
|
|
{
|
||
|
|
vertical-align: top;
|
||
|
|
padding: 4px;
|
||
|
|
border-bottom: 1px #7F8FB1 solid;
|
||
|
|
border-right: 1px #7F8FB1 solid;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*col#summaryAttributes {}*/
|
||
|
|
.summaryTable td.attributes
|
||
|
|
{
|
||
|
|
border-left: 1px #7F8FB1 solid;
|
||
|
|
width: 140px;
|
||
|
|
text-align: right;
|
||
|
|
}
|
||
|
|
|
||
|
|
td.attributes, .fixedFont
|
||
|
|
{
|
||
|
|
line-height: 15px;
|
||
|
|
color: #002EBE;
|
||
|
|
font-family: "Courier New",Courier,monospace;
|
||
|
|
font-size: 13px;
|
||
|
|
}
|
||
|
|
|
||
|
|
.summaryTable td.nameDescription
|
||
|
|
{
|
||
|
|
text-align: left;
|
||
|
|
font-size: 13px;
|
||
|
|
line-height: 15px;
|
||
|
|
}
|
||
|
|
|
||
|
|
.summaryTable td.nameDescription, .description
|
||
|
|
{
|
||
|
|
line-height: 15px;
|
||
|
|
padding: 4px;
|
||
|
|
padding-left: 4px;
|
||
|
|
}
|
||
|
|
|
||
|
|
.summaryTable { margin-bottom: 8px; }
|
||
|
|
|
||
|
|
ul.inheritsList
|
||
|
|
{
|
||
|
|
list-style: square;
|
||
|
|
margin-left: 20px;
|
||
|
|
padding-left: 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
.detailList {
|
||
|
|
margin-left: 20px;
|
||
|
|
line-height: 15px;
|
||
|
|
}
|
||
|
|
.detailList dt { margin-left: 20px; }
|
||
|
|
|
||
|
|
.detailList .heading
|
||
|
|
{
|
||
|
|
font-weight: bold;
|
||
|
|
padding-bottom: 6px;
|
||
|
|
margin-left: 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
.light, td.attributes, .light a:link, .light a:visited
|
||
|
|
{
|
||
|
|
color: #777;
|
||
|
|
font-style: italic;
|
||
|
|
}
|
||
|
|
|
||
|
|
.fineprint
|
||
|
|
{
|
||
|
|
text-align: right;
|
||
|
|
font-size: 10px;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
<!-- ============================== header ================================= -->
|
||
|
|
<!-- begin static/header.html -->
|
||
|
|
<div id="header" style="background: #7F8FB1; color: white; margin: -10px">
|
||
|
|
<b><a href="http://kjur.github.com/jsrsasign/" style="color: white">jsrsasign</a></b> 1.2 JavaScript API Reference
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- end static/header.html -->
|
||
|
|
|
||
|
|
<!-- ============================== classes index ============================ -->
|
||
|
|
<div id="index">
|
||
|
|
<!-- begin publish.classesIndex -->
|
||
|
|
<div align="center"><a href="../index.html">Class Index</a>
|
||
|
|
| <a href="../files.html">File Index</a></div>
|
||
|
|
<hr />
|
||
|
|
<h2>Classes</h2>
|
||
|
|
<ul class="classList">
|
||
|
|
|
||
|
|
<li><i><a href="../symbols/global__.html">global__</a></i></li>
|
||
|
|
|
||
|
|
<li><a href="../symbols/ASN1HEX.html">ASN1HEX</a></li>
|
||
|
|
|
||
|
|
<li><a href="../symbols/RSAKey.html">RSAKey</a></li>
|
||
|
|
|
||
|
|
<li><a href="../symbols/X509.html">X509</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
<hr />
|
||
|
|
<!-- end publish.classesIndex -->
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="content">
|
||
|
|
<!-- ============================== class title ============================ -->
|
||
|
|
<h1 class="classTitle">
|
||
|
|
|
||
|
|
Class RSAKey
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
<!-- ============================== class summary ========================== -->
|
||
|
|
<p class="description">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<br /><i>Defined in: </i> <a href="../symbols/src/rsasign-1.2.js.html">rsasign-1.2.js</a>.
|
||
|
|
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<!-- ============================== constructor summary ==================== -->
|
||
|
|
|
||
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class RSAKey.">
|
||
|
|
<caption>Class Summary</caption>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th scope="col">Constructor Attributes</th>
|
||
|
|
<th scope="col">Constructor Name and Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="attributes"> </td>
|
||
|
|
<td class="nameDescription" >
|
||
|
|
<div class="fixedFont">
|
||
|
|
<b><a href="../symbols/RSAKey.html#constructor">RSAKey</a></b>()
|
||
|
|
</div>
|
||
|
|
<div class="description">Tom Wu's RSA Key class and extension</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== properties summary ===================== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== methods summary ======================== -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class RSAKey.">
|
||
|
|
<caption>Method Summary</caption>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th scope="col">Method Attributes</th>
|
||
|
|
<th scope="col">Method Name and Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="attributes"> </td>
|
||
|
|
<td class="nameDescription">
|
||
|
|
<div class="fixedFont"><b><a href="../symbols/RSAKey.html#readPrivateKeyFromPEMString">readPrivateKeyFromPEMString</a></b>(keyPEM)
|
||
|
|
</div>
|
||
|
|
<div class="description">read PKCS#1 private key from a string</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="attributes"> </td>
|
||
|
|
<td class="nameDescription">
|
||
|
|
<div class="fixedFont"><b><a href="../symbols/RSAKey.html#signString">signString</a></b>(s, hashAlg)
|
||
|
|
</div>
|
||
|
|
<div class="description">sign for a message string with RSA private key.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td class="attributes"> </td>
|
||
|
|
<td class="nameDescription">
|
||
|
|
<div class="fixedFont"><b><a href="../symbols/RSAKey.html#verifyString">verifyString</a></b>(sMsg, hSig)
|
||
|
|
</div>
|
||
|
|
<div class="description">verifies a sigature for a message string with RSA public key.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== events summary ======================== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== constructor details ==================== -->
|
||
|
|
|
||
|
|
<div class="details"><a name="constructor"> </a>
|
||
|
|
<div class="sectionTitle">
|
||
|
|
Class Detail
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="fixedFont">
|
||
|
|
<b>RSAKey</b>()
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Tom Wu's RSA Key class and extension
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== field details ========================== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== method details ========================= -->
|
||
|
|
|
||
|
|
<div class="sectionTitle">
|
||
|
|
Method Detail
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<a name="readPrivateKeyFromPEMString"> </a>
|
||
|
|
<div class="fixedFont">
|
||
|
|
|
||
|
|
|
||
|
|
<b>readPrivateKeyFromPEMString</b>(keyPEM)
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="description">
|
||
|
|
read PKCS#1 private key from a string
|
||
|
|
|
||
|
|
<br />
|
||
|
|
<i>Defined in: </i> <a href="../symbols/src/rsapem-1.1.js.html">rsapem-1.1.js</a>.
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="detailList">
|
||
|
|
<dt class="heading">Parameters:</dt>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<span class="light fixedFont">{String}</span> <b>keyPEM</b>
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>string of PKCS#1 private key.</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
|
||
|
|
<a name="signString"> </a>
|
||
|
|
<div class="fixedFont">
|
||
|
|
|
||
|
|
|
||
|
|
<b>signString</b>(s, hashAlg)
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="description">
|
||
|
|
sign for a message string with RSA private key.<br/>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="detailList">
|
||
|
|
<dt class="heading">Parameters:</dt>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<span class="light fixedFont">{String}</span> <b>s</b>
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>message string to be signed.</dd>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<span class="light fixedFont">{String}</span> <b>hashAlg</b>
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>hash algorithm name for signing.<br/></dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="detailList">
|
||
|
|
<dt class="heading">Returns:</dt>
|
||
|
|
|
||
|
|
<dd>returns hexadecimal string of signature value.</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
|
||
|
|
<a name="verifyString"> </a>
|
||
|
|
<div class="fixedFont">
|
||
|
|
|
||
|
|
|
||
|
|
<b>verifyString</b>(sMsg, hSig)
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="description">
|
||
|
|
verifies a sigature for a message string with RSA public key.<br/>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="detailList">
|
||
|
|
<dt class="heading">Parameters:</dt>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<span class="light fixedFont">{String}</span> <b>sMsg</b>
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>message string to be verified.</dd>
|
||
|
|
|
||
|
|
<dt>
|
||
|
|
<span class="light fixedFont">{String}</span> <b>hSig</b>
|
||
|
|
|
||
|
|
</dt>
|
||
|
|
<dd>hexadecimal string of siganture.<br/>
non-hexadecimal charactors including new lines will be ignored.</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="detailList">
|
||
|
|
<dt class="heading">Returns:</dt>
|
||
|
|
|
||
|
|
<dd>returns 1 if valid, otherwise 0</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== event details ========================= -->
|
||
|
|
|
||
|
|
|
||
|
|
<hr />
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============================== footer ================================= -->
|
||
|
|
<div class="fineprint" style="clear:both">
|
||
|
|
© 2012 Kenji Urushima, All rights reserved<br/>
|
||
|
|
|
||
|
|
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri May 11 2012 21:04:07 GMT+0900 (JST)
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|