mailiverse/gwt/war/js/crypt/jsrsasign-1.3/api/symbols/ASN1HEX.html
2013-07-21 13:40:17 -04:00

1089 lines
25 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 - ASN1HEX</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">
&nbsp; <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 ASN1HEX
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br />Version
1.1 (09 May 2012).<br />
ASN.1 DER encoded hexadecimal string utility class
<br /><i>Defined in: </i> <a href="../symbols/src/asn1hex-1.1.js.html">asn1hex-1.1.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class ASN1HEX.">
<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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/ASN1HEX.html#constructor">ASN1HEX</a></b>()
</div>
<div class="description">ASN.1 DER encoded hexadecimal string utility class</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class ASN1HEX.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getByteLengthOfL_AtObj">getByteLengthOfL_AtObj</a></b>(s, pos)
</div>
<div class="description">get byte length for ASN.1 L(length) bytes</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getDecendantHexTLVByNthList">getDecendantHexTLVByNthList</a></b>(h, currentIndex, nthList)
</div>
<div class="description">get hexadecimal string of ASN.1 TLV refered by current index and nth index list.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getDecendantHexVByNthList">getDecendantHexVByNthList</a></b>(h, currentIndex, nthList)
</div>
<div class="description">get hexadecimal string of ASN.1 V refered by current index and nth index list.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getDecendantIndexByNthList">getDecendantIndexByNthList</a></b>(h, currentIndex, nthList)
</div>
<div class="description">get string index of nth child object of ASN.1 object refered by h, idx</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getHexOfL_AtObj">getHexOfL_AtObj</a></b>(s, pos)
</div>
<div class="description">get hexadecimal string for ASN.1 L(length) bytes</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getHexOfTLV_AtObj">getHexOfTLV_AtObj</a></b>(s, pos)
</div>
<div class="description">get hexadecimal string of ASN.1 TLV at</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getHexOfV_AtObj">getHexOfV_AtObj</a></b>(s, pos)
</div>
<div class="description">get hexadecimal string of ASN.1 V(value)</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getIntOfL_AtObj">getIntOfL_AtObj</a></b>(s, pos)
</div>
<div class="description">get integer value of ASN.1 length for ASN.1 data</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getNthChildIndex_AtObj">getNthChildIndex_AtObj</a></b>(h, idx, nth)
</div>
<div class="description">get string index of nth child object of ASN.1 object refered by h, idx</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getPosArrayOfChildren_AtObj">getPosArrayOfChildren_AtObj</a></b>(s, start)
</div>
<div class="description">get array of indexes of child ASN.1 objects</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getPosOfNextSibling_AtObj">getPosOfNextSibling_AtObj</a></b>(s, pos)
</div>
<div class="description">get next sibling starting index for ASN.1 object string</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">ASN1HEX.<b><a href="../symbols/ASN1HEX.html#.getStartPosOfV_AtObj">getStartPosOfV_AtObj</a></b>(s, pos)
</div>
<div class="description">get ASN.1 value starting string position for ASN.1 object refered by index 'idx'.</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>ASN1HEX</b>()
</div>
<div class="description">
ASN.1 DER encoded hexadecimal string utility class
<br /><i>Author: </i>Kenji Urushima.
</div>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd><a href="http://kjur.github.com/jsrsasigns/">'jwrsasign'(RSA Sign JavaScript Library) home page http://kjur.github.com/jsrsasign/</a></dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".getByteLengthOfL_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">ASN1HEX.</span><b>getByteLengthOfL_AtObj</b>(s, pos)
</div>
<div class="description">
get byte length for ASN.1 L(length) bytes
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>byte length for ASN.1 L(length) bytes</dd>
</dl>
<hr />
<a name=".getDecendantHexTLVByNthList"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Number}</span>
<span class="light">ASN1HEX.</span><b>getDecendantHexTLVByNthList</b>(h, currentIndex, nthList)
</div>
<div class="description">
get hexadecimal string of ASN.1 TLV refered by current index and nth index list.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>h</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>currentIndex</b>
</dt>
<dd>start string index of ASN.1 object</dd>
<dt>
<span class="light fixedFont">{Array of Number}</span> <b>nthList</b>
</dt>
<dd>array list of nth</dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> hexadecimal string of ASN.1 TLV refered by nthList</dd>
</dl>
<hr />
<a name=".getDecendantHexVByNthList"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Number}</span>
<span class="light">ASN1HEX.</span><b>getDecendantHexVByNthList</b>(h, currentIndex, nthList)
</div>
<div class="description">
get hexadecimal string of ASN.1 V refered by current index and nth index list.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>h</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>currentIndex</b>
</dt>
<dd>start string index of ASN.1 object</dd>
<dt>
<span class="light fixedFont">{Array of Number}</span> <b>nthList</b>
</dt>
<dd>array list of nth</dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> hexadecimal string of ASN.1 V refered by nthList</dd>
</dl>
<hr />
<a name=".getDecendantIndexByNthList"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Number}</span>
<span class="light">ASN1HEX.</span><b>getDecendantIndexByNthList</b>(h, currentIndex, nthList)
</div>
<div class="description">
get string index of nth child object of ASN.1 object refered by h, idx
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>h</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>currentIndex</b>
</dt>
<dd>start string index of ASN.1 object</dd>
<dt>
<span class="light fixedFont">{Array of Number}</span> <b>nthList</b>
</dt>
<dd>array list of nth</dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> string index refered by nthList</dd>
</dl>
<hr />
<a name=".getHexOfL_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{String}</span>
<span class="light">ASN1HEX.</span><b>getHexOfL_AtObj</b>(s, pos)
</div>
<div class="description">
get hexadecimal string for ASN.1 L(length) bytes
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{String}</span> hexadecimal string for ASN.1 L(length) bytes</dd>
</dl>
<hr />
<a name=".getHexOfTLV_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{String}</span>
<span class="light">ASN1HEX.</span><b>getHexOfTLV_AtObj</b>(s, pos)
</div>
<div class="description">
get hexadecimal string of ASN.1 TLV at
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{String}</span> hexadecimal string of ASN.1 TLV.</dd>
</dl>
<hr />
<a name=".getHexOfV_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{String}</span>
<span class="light">ASN1HEX.</span><b>getHexOfV_AtObj</b>(s, pos)
</div>
<div class="description">
get hexadecimal string of ASN.1 V(value)
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{String}</span> hexadecimal string of ASN.1 value.</dd>
</dl>
<hr />
<a name=".getIntOfL_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">ASN1HEX.</span><b>getIntOfL_AtObj</b>(s, pos)
</div>
<div class="description">
get integer value of ASN.1 length for ASN.1 data
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>ASN.1 L(length) integer value</dd>
</dl>
<hr />
<a name=".getNthChildIndex_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Number}</span>
<span class="light">ASN1HEX.</span><b>getNthChildIndex_AtObj</b>(h, idx, nth)
</div>
<div class="description">
get string index of nth child object of ASN.1 object refered by h, idx
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>h</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>idx</b>
</dt>
<dd>start string index of ASN.1 object</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>nth</b>
</dt>
<dd>for child</dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>1.1</dd>
</dl>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> string index of nth child.</dd>
</dl>
<hr />
<a name=".getPosArrayOfChildren_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Array of Number}</span>
<span class="light">ASN1HEX.</span><b>getPosArrayOfChildren_AtObj</b>(s, start)
</div>
<div class="description">
get array of indexes of child ASN.1 objects
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>start</b>
</dt>
<dd>string index of ASN.1 object</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Array of Number}</span> array of indexes for childen of ASN.1 objects</dd>
</dl>
<hr />
<a name=".getPosOfNextSibling_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">ASN1HEX.</span><b>getPosOfNextSibling_AtObj</b>(s, pos)
</div>
<div class="description">
get next sibling starting index for ASN.1 object string
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd>next sibling starting index for ASN.1 object string</dd>
</dl>
<hr />
<a name=".getStartPosOfV_AtObj"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">ASN1HEX.</span><b>getStartPosOfV_AtObj</b>(s, pos)
</div>
<div class="description">
get ASN.1 value starting string position for ASN.1 object refered by index 'idx'.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>s</b>
</dt>
<dd>hexadecimal string of ASN.1 DER encoded data</dd>
<dt>
<span class="light fixedFont">{Number}</span> <b>pos</b>
</dt>
<dd>string index</dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
&copy; 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>