forked from rachanon/stdbWeb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
925 lines
26 KiB
925 lines
26 KiB
<!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 4.8.7 JavaScript API Reference - KJUR.crypto.Mac</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> 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/Base64x.html">Base64x</a></li> |
|
|
|
<li><a href="../symbols/KEYUTIL.html">KEYUTIL</a></li> |
|
|
|
<li><a href="../symbols/KJUR.html">KJUR</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.html">KJUR.asn1</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.ASN1Object.html">KJUR.asn1.ASN1Object</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.ASN1Util.html">KJUR.asn1.ASN1Util</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.html">KJUR.asn1.cades</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.CAdESUtil.html">KJUR.asn1.cades.CAdESUtil</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.CompleteCertificateRefs.html">KJUR.asn1.cades.CompleteCertificateRefs</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.OtherCertID.html">KJUR.asn1.cades.OtherCertID</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.OtherHash.html">KJUR.asn1.cades.OtherHash</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.OtherHashAlgAndValue.html">KJUR.asn1.cades.OtherHashAlgAndValue</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.SignaturePolicyIdentifier.html">KJUR.asn1.cades.SignaturePolicyIdentifier</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cades.SignatureTimeStamp.html">KJUR.asn1.cades.SignatureTimeStamp</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.html">KJUR.asn1.cms</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.Attribute.html">KJUR.asn1.cms.Attribute</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.AttributeList.html">KJUR.asn1.cms.AttributeList</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.CMSUtil.html">KJUR.asn1.cms.CMSUtil</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.ContentInfo.html">KJUR.asn1.cms.ContentInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.ContentType.html">KJUR.asn1.cms.ContentType</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.EncapsulatedContentInfo.html">KJUR.asn1.cms.EncapsulatedContentInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.IssuerAndSerialNumber.html">KJUR.asn1.cms.IssuerAndSerialNumber</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.MessageDigest.html">KJUR.asn1.cms.MessageDigest</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.SignedData.html">KJUR.asn1.cms.SignedData</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.SignerInfo.html">KJUR.asn1.cms.SignerInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.SigningCertificate.html">KJUR.asn1.cms.SigningCertificate</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.SigningCertificateV2.html">KJUR.asn1.cms.SigningCertificateV2</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.cms.SigningTime.html">KJUR.asn1.cms.SigningTime</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.csr.html">KJUR.asn1.csr</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.csr.CertificationRequest.html">KJUR.asn1.csr.CertificationRequest</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.csr.CertificationRequestInfo.html">KJUR.asn1.csr.CertificationRequestInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.csr.CSRUtil.html">KJUR.asn1.csr.CSRUtil</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERAbstractString.html">KJUR.asn1.DERAbstractString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERAbstractStructured.html">KJUR.asn1.DERAbstractStructured</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERAbstractTime.html">KJUR.asn1.DERAbstractTime</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERBitString.html">KJUR.asn1.DERBitString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERBoolean.html">KJUR.asn1.DERBoolean</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DEREnumerated.html">KJUR.asn1.DEREnumerated</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERGeneralizedTime.html">KJUR.asn1.DERGeneralizedTime</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERIA5String.html">KJUR.asn1.DERIA5String</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERInteger.html">KJUR.asn1.DERInteger</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERNull.html">KJUR.asn1.DERNull</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERNumericString.html">KJUR.asn1.DERNumericString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERObjectIdentifier.html">KJUR.asn1.DERObjectIdentifier</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DEROctetString.html">KJUR.asn1.DEROctetString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERPrintableString.html">KJUR.asn1.DERPrintableString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERSequence.html">KJUR.asn1.DERSequence</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERSet.html">KJUR.asn1.DERSet</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERTaggedObject.html">KJUR.asn1.DERTaggedObject</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERTeletexString.html">KJUR.asn1.DERTeletexString</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERUTCTime.html">KJUR.asn1.DERUTCTime</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.DERUTF8String.html">KJUR.asn1.DERUTF8String</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.html">KJUR.asn1.tsp</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.AbstractTSAAdapter.html">KJUR.asn1.tsp.AbstractTSAAdapter</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.Accuracy.html">KJUR.asn1.tsp.Accuracy</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.FixedTSAAdapter.html">KJUR.asn1.tsp.FixedTSAAdapter</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.MessageImprint.html">KJUR.asn1.tsp.MessageImprint</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.PKIFailureInfo.html">KJUR.asn1.tsp.PKIFailureInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.PKIFreeText.html">KJUR.asn1.tsp.PKIFreeText</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.PKIStatus.html">KJUR.asn1.tsp.PKIStatus</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.PKIStatusInfo.html">KJUR.asn1.tsp.PKIStatusInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.SimpleTSAAdapter.html">KJUR.asn1.tsp.SimpleTSAAdapter</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.TimeStampReq.html">KJUR.asn1.tsp.TimeStampReq</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.TimeStampResp.html">KJUR.asn1.tsp.TimeStampResp</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.TSPUtil.html">KJUR.asn1.tsp.TSPUtil</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.tsp.TSTInfo.html">KJUR.asn1.tsp.TSTInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.html">KJUR.asn1.x509</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.AlgorithmIdentifier.html">KJUR.asn1.x509.AlgorithmIdentifier</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.AttributeTypeAndValue.html">KJUR.asn1.x509.AttributeTypeAndValue</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.AuthorityKeyIdentifier.html">KJUR.asn1.x509.AuthorityKeyIdentifier</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.BasicConstraints.html">KJUR.asn1.x509.BasicConstraints</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.Certificate.html">KJUR.asn1.x509.Certificate</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.CRL.html">KJUR.asn1.x509.CRL</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.CRLDistributionPoints.html">KJUR.asn1.x509.CRLDistributionPoints</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.CRLEntry.html">KJUR.asn1.x509.CRLEntry</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.DistributionPoint.html">KJUR.asn1.x509.DistributionPoint</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.DistributionPointName.html">KJUR.asn1.x509.DistributionPointName</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.Extension.html">KJUR.asn1.x509.Extension</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.ExtKeyUsage.html">KJUR.asn1.x509.ExtKeyUsage</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.GeneralName.html">KJUR.asn1.x509.GeneralName</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.GeneralNames.html">KJUR.asn1.x509.GeneralNames</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.KeyUsage.html">KJUR.asn1.x509.KeyUsage</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.OID.html">KJUR.asn1.x509.OID</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.RDN.html">KJUR.asn1.x509.RDN</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.SubjectPublicKeyInfo.html">KJUR.asn1.x509.SubjectPublicKeyInfo</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.TBSCertificate.html">KJUR.asn1.x509.TBSCertificate</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.TBSCertList.html">KJUR.asn1.x509.TBSCertList</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.Time.html">KJUR.asn1.x509.Time</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.X500Name.html">KJUR.asn1.x509.X500Name</a></li> |
|
|
|
<li><a href="../symbols/KJUR.asn1.x509.X509Util.html">KJUR.asn1.x509.X509Util</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.html">KJUR.crypto</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.DSA.html">KJUR.crypto.DSA</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.ECDSA.html">KJUR.crypto.ECDSA</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.ECParameterDB.html">KJUR.crypto.ECParameterDB</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.Mac.html">KJUR.crypto.Mac</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.MessageDigest.html">KJUR.crypto.MessageDigest</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.OID.html">KJUR.crypto.OID</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.Signature.html">KJUR.crypto.Signature</a></li> |
|
|
|
<li><a href="../symbols/KJUR.crypto.Util.html">KJUR.crypto.Util</a></li> |
|
|
|
<li><a href="../symbols/KJUR.jws.html">KJUR.jws</a></li> |
|
|
|
<li><a href="../symbols/KJUR.jws.IntDate.html">KJUR.jws.IntDate</a></li> |
|
|
|
<li><a href="../symbols/KJUR.jws.JWS.html">KJUR.jws.JWS</a></li> |
|
|
|
<li><a href="../symbols/KJUR.jws.JWSJS.html">KJUR.jws.JWSJS</a></li> |
|
|
|
<li><a href="../symbols/PKCS5PKEY.html">PKCS5PKEY</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 KJUR.crypto.Mac |
|
</h1> |
|
|
|
<!-- ============================== class summary ========================== --> |
|
<p class="description"> |
|
|
|
|
|
|
|
Mac class which is very similar to java.security.Mac class |
|
|
|
|
|
<br /><i>Defined in: </i> <a href="../symbols/src/crypto-1.1.js.html">crypto-1.1.js</a>. |
|
|
|
</p> |
|
|
|
<!-- ============================== constructor summary ==================== --> |
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class KJUR.crypto.Mac."> |
|
<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/KJUR.crypto.Mac.html#constructor">KJUR.crypto.Mac</a></b>(params) |
|
</div> |
|
<div class="description">Mac(Message Authentication Code) class which is very similar to java.security.Mac class |
|
<br/> |
|
Currently this supports following algorithm and providers combination: |
|
<ul> |
|
<li>hmacmd5 - cryptojs</li> |
|
<li>hmacsha1 - cryptojs</li> |
|
<li>hmacsha224 - cryptojs</li> |
|
<li>hmacsha256 - cryptojs</li> |
|
<li>hmacsha384 - cryptojs</li> |
|
<li>hmacsha512 - cryptojs</li> |
|
</ul> |
|
NOTE: HmacSHA224 and HmacSHA384 issue was fixed since jsrsasign 4.1.4.</div> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
|
|
|
|
<!-- ============================== properties summary ===================== --> |
|
|
|
|
|
<!-- ============================== methods summary ======================== --> |
|
|
|
|
|
|
|
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class KJUR.crypto.Mac."> |
|
<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"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.doFinal">doFinal</a></b>() |
|
</div> |
|
<div class="description">completes hash calculation and returns hash result |
|
</div> |
|
</td> |
|
</tr> |
|
|
|
<tr> |
|
<td class="attributes"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.doFinalHex">doFinalHex</a></b>(hex) |
|
</div> |
|
<div class="description">performs final update on the digest using hexadecimal string, |
|
then completes the digest computation |
|
</div> |
|
</td> |
|
</tr> |
|
|
|
<tr> |
|
<td class="attributes"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.doFinalString">doFinalString</a></b>(str) |
|
</div> |
|
<div class="description">performs final update on the digest using string, then completes the digest computation |
|
</div> |
|
</td> |
|
</tr> |
|
|
|
<tr> |
|
<td class="attributes"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.setPassword">setPassword</a></b>(pass) |
|
</div> |
|
<div class="description">set password for Mac |
|
This method will set password for (H)Mac internally.</div> |
|
</td> |
|
</tr> |
|
|
|
<tr> |
|
<td class="attributes"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.updateHex">updateHex</a></b>(hex) |
|
</div> |
|
<div class="description">update digest by specified hexadecimal string |
|
</div> |
|
</td> |
|
</tr> |
|
|
|
<tr> |
|
<td class="attributes"><static> </td> |
|
<td class="nameDescription"> |
|
<div class="fixedFont">KJUR.crypto.Mac.<b><a href="../symbols/KJUR.crypto.Mac.html#.updateString">updateString</a></b>(str) |
|
</div> |
|
<div class="description">update digest by specified string |
|
</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>KJUR.crypto.Mac</b>(params) |
|
</div> |
|
|
|
<div class="description"> |
|
Mac(Message Authentication Code) class which is very similar to java.security.Mac class |
|
<br/> |
|
Currently this supports following algorithm and providers combination: |
|
<ul> |
|
<li>hmacmd5 - cryptojs</li> |
|
<li>hmacsha1 - cryptojs</li> |
|
<li>hmacsha224 - cryptojs</li> |
|
<li>hmacsha256 - cryptojs</li> |
|
<li>hmacsha384 - cryptojs</li> |
|
<li>hmacsha512 - cryptojs</li> |
|
</ul> |
|
NOTE: HmacSHA224 and HmacSHA384 issue was fixed since jsrsasign 4.1.4. |
|
Please use 'ext/cryptojs-312-core-fix*.js' instead of 'core.js' of original CryptoJS |
|
to avoid those issue. |
|
<br/> |
|
NOTE2: Hmac signature bug was fixed in jsrsasign 4.9.0 by providing CryptoJS |
|
bug workaround. |
|
<br/> |
|
Please see <a href="../symbols/KJUR.crypto.Mac.html#.setPassword">KJUR.crypto.Mac.setPassword</a>, how to provide password |
|
in various ways in detail. |
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">var mac = new KJUR.crypto.Mac({alg: "HmacSHA1", "pass": "pass"}); |
|
mac.updateString('aaa') |
|
var macHex = md.doFinal() |
|
|
|
// other password representation |
|
var mac = new KJUR.crypto.Mac({alg: "HmacSHA256", "pass": {"hex": "6161"}}); |
|
var mac = new KJUR.crypto.Mac({alg: "HmacSHA256", "pass": {"utf8": "aa"}}); |
|
var mac = new KJUR.crypto.Mac({alg: "HmacSHA256", "pass": {"rstr": "\x61\x61"}}); |
|
var mac = new KJUR.crypto.Mac({alg: "HmacSHA256", "pass": {"b64": "Mi02/+...a=="}}); |
|
var mac = new KJUR.crypto.Mac({alg: "HmacSHA256", "pass": {"b64u": "Mi02_-...a"}});</pre> |
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{Array}</span> <b>params</b> |
|
|
|
</dt> |
|
<dd>parameters for constructor</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
<!-- ============================== field details ========================== --> |
|
|
|
|
|
<!-- ============================== method details ========================= --> |
|
|
|
<div class="sectionTitle"> |
|
Method Detail |
|
</div> |
|
|
|
<a name=".doFinal"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>doFinal</b>() |
|
|
|
</div> |
|
<div class="description"> |
|
completes hash calculation and returns hash result |
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">md.digest()</pre> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr /> |
|
|
|
<a name=".doFinalHex"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>doFinalHex</b>(hex) |
|
|
|
</div> |
|
<div class="description"> |
|
performs final update on the digest using hexadecimal string, |
|
then completes the digest computation |
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">md.digestHex('0f2abd')</pre> |
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{String}</span> <b>hex</b> |
|
|
|
</dt> |
|
<dd>hexadecimal string to final update</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr /> |
|
|
|
<a name=".doFinalString"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>doFinalString</b>(str) |
|
|
|
</div> |
|
<div class="description"> |
|
performs final update on the digest using string, then completes the digest computation |
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">md.digestString('aaa')</pre> |
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{String}</span> <b>str</b> |
|
|
|
</dt> |
|
<dd>string to final update</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr /> |
|
|
|
<a name=".setPassword"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>setPassword</b>(pass) |
|
|
|
</div> |
|
<div class="description"> |
|
set password for Mac |
|
This method will set password for (H)Mac internally. |
|
Argument 'pass' can be specified as following: |
|
<ul> |
|
<li>even length string of 0..9, a..f or A-F: implicitly specified as hexadecimal string</li> |
|
<li>not above string: implicitly specified as raw string</li> |
|
<li>{rstr: "\x65\x70"}: explicitly specified as raw string</li> |
|
<li>{hex: "6570"}: explicitly specified as hexacedimal string</li> |
|
<li>{utf8: "秘密"}: explicitly specified as UTF8 string</li> |
|
<li>{b64: "Mi78..=="}: explicitly specified as Base64 string</li> |
|
<li>{b64u: "Mi7-_"}: explicitly specified as Base64URL string</li> |
|
</ul> |
|
It is *STRONGLY RECOMMENDED* that explicit representation of password argument |
|
to avoid ambiguity. For example string "6161" can mean a string "6161" or |
|
a hexadecimal string of "aa" (i.e. \x61\x61). |
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">mac = KJUR.crypto.Mac({'alg': 'hmacsha256'}); |
|
// set password by implicit raw string |
|
mac.setPassword("\x65\x70\xb9\x0b"); |
|
mac.setPassword("password"); |
|
// set password by implicit hexadecimal string |
|
mac.setPassword("6570b90b"); |
|
mac.setPassword("6570B90B"); |
|
// set password by explicit raw string |
|
mac.setPassword({"rstr": "\x65\x70\xb9\x0b"}); |
|
// set password by explicit hexadecimal string |
|
mac.setPassword({"hex": "6570b90b"}); |
|
// set password by explicit utf8 string |
|
mac.setPassword({"utf8": "passwordパスワード"); |
|
// set password by explicit Base64 string |
|
mac.setPassword({"b64": "Mb+c3f/=="}); |
|
// set password by explicit Base64URL string |
|
mac.setPassword({"b64u": "Mb-c3f_"});</pre> |
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{Object}</span> <b>pass</b> |
|
|
|
</dt> |
|
<dd>password for Mac</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Since:</dt> |
|
<dd>crypto 1.1.7 jsrsasign 4.9.0</dd> |
|
</dl> |
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr /> |
|
|
|
<a name=".updateHex"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>updateHex</b>(hex) |
|
|
|
</div> |
|
<div class="description"> |
|
update digest by specified hexadecimal string |
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">md.updateHex('0afe36');</pre> |
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{String}</span> <b>hex</b> |
|
|
|
</dt> |
|
<dd>hexadecimal string to update</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr /> |
|
|
|
<a name=".updateString"> </a> |
|
<div class="fixedFont"><static> |
|
|
|
|
|
<span class="light">KJUR.crypto.Mac.</span><b>updateString</b>(str) |
|
|
|
</div> |
|
<div class="description"> |
|
update digest by specified string |
|
|
|
|
|
|
|
</div> |
|
|
|
|
|
|
|
<pre class="code">md.updateString('New York');</pre> |
|
|
|
|
|
|
|
|
|
<dl class="detailList"> |
|
<dt class="heading">Parameters:</dt> |
|
|
|
<dt> |
|
<span class="light fixedFont">{String}</span> <b>str</b> |
|
|
|
</dt> |
|
<dd>string to update</dd> |
|
|
|
</dl> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ============================== event details ========================= --> |
|
|
|
|
|
<hr /> |
|
</div> |
|
|
|
|
|
<!-- ============================== footer ================================= --> |
|
<div class="fineprint" style="clear:both"> |
|
© 2012-2015 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 |
|
</div> |
|
</body> |
|
</html>
|
|
|