api-console-assets

<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style> .KEYW {color: #933;} .COMM {color: #bbb; font-style: italic;} .NUMB {color: #393;} .STRN {color: #393;} .REGX {color: #339;} .line {border-right: 1px dotted #666; color: #666; font-style: normal;} </style></head><body><pre> 1 /* x509-1.1.20.js (c) 2012-2018 Kenji Urushima | kjur.github.io/jsrsasign/license 2 */ 3 /* 4 * x509.js - X509 class to read subject public key from certificate. 5 * 6 * Copyright (c) 2010-2018 Kenji Urushima (kenji.urushima@gmail.com) 7 * 8 * This software is licensed under the terms of the MIT License. 9 * https://kjur.github.io/jsrsasign/license 10 * 11 * The above copyright and license notice shall be 12 * included in all copies or substantial portions of the Software. 13 */ 14 15 /** 16 * @fileOverview 17 * @name x509-1.1.js 18 * @author Kenji Urushima kenji.urushima@gmail.com 19 * @version jsrsasign 8.0.10 x509 1.1.20 (2018-Apr-09) 20 * @since jsrsasign 1.x.x 21 * @license <a href="https://kjur.github.io/jsrsasign/license/">MIT License</a> 22 */ 23 24 /** 25 * hexadecimal X.509 certificate ASN.1 parser class. 26 * @class hexadecimal X.509 certificate ASN.1 parser class 27 * @property {String} hex hexacedimal string for X.509 certificate. 28 * @property {Number} version format version (1: X509v1, 3: X509v3, otherwise: unknown) since jsrsasign 7.1.4 29 * @author Kenji Urushima 30 * @version 1.0.1 (08 May 2012) 31 * @see <a href="https://kjur.github.io/jsrsasigns/">'jsrsasign'(RSA Sign JavaScript Library) home page https://kjur.github.io/jsrsasign/</a> 32 * @description 33 * X509 class provides following functionality: 34 * <ul> 35 * <li>parse X.509 certificate ASN.1 structure</li> 36 * <li>get basic fields, extensions, signature algorithms and signature values</li> 37 * <li>read PEM certificate</li> 38 * </ul> 39 * 40 * <ul> 41 * <li>TO GET FIELDS 42 * <ul> 43 * <li>serial - {@link X509#getSerialNumberHex}</li> 44 * <li>signature algorithm field - {@link X509#getSignatureAlgorithmField}</li> 45 * <li>issuer - {@link X509#getIssuerHex}</li> 46 * <li>issuer - {@link X509#getIssuerString}</li> 47 * <li>notBefore - {@link X509#getNotBefore}</li> 48 * <li>notAfter - {@link X509#getNotAfter}</li> 49 * <li>subject - {@link X509#getSubjectHex}</li> 50 * <li>subject - {@link X509#getSubjectString}</li> 51 * <li>subjectPublicKeyInfo - {@link X509#getPublicKey}</li> 52 * <li>subjectPublicKeyInfo - {@link X509#getPublicKeyHex}</li> 53 * <li>subjectPublicKeyInfo - {@link X509#getPublicKeyIdx}</li> 54 * <li>subjectPublicKeyInfo - {@link X509.getPublicKeyFromCertPEM}</li> 55 * <li>subjectPublicKeyInfo - {@link X509.getPublicKeyFromCertHex}</li> 56 * <li>subjectPublicKeyInfo - {@link X509#getPublicKeyContentIdx}</li> 57 * <li>signature algorithm - {@link X509#getSignatureAlgorithmName}</li> 58 * <li>signature value - {@link X509#getSignatureValueHex}</li> 59 * </ul> 60 * </li> 61 * <li>X509 METHODS TO GET EXTENSIONS 62 * <ul> 63 * <li>basicConstraints - {@link X509#getExtBasicConstraints}</li> 64 * <li>keyUsage - {@link X509#getExtKeyUsageBin}</li> 65 * <li>keyUsage - {@link X509#getExtKeyUsageString}</li> 66 * <li>subjectKeyIdentifier - {@link X509#getExtSubjectKeyIdentifier}</li> 67 * <li>authorityKeyIdentifier - {@link X509#getExtAuthorityKeyIdentifier}</li> 68 * <li>extKeyUsage - {@link X509#getExtExtKeyUsageName}</li> 69 * <li>subjectAltName(DEPRECATED) - {@link X509#getExtSubjectAltName}</li> 70 * <li>subjectAltName2 - {@link X509#getExtSubjectAltName2}</li> 71 * <li>cRLDistributionPoints - {@link X509#getExtCRLDistributionPointsURI}</li> 72 * <li>authorityInfoAccess - {@link X509#getExtAIAInfo}</li> 73 * <li>certificatePolicies - {@link X509#getExtCertificatePolicies}</li> 74 * </ul> 75 * </li> 76 * <li>UTILITIES 77 * <ul> 78 * <li>reading PEM X.509 certificate - {@link X509#readCertPEM}</li> 79 * <li>reading hexadecimal string of X.509 certificate - {@link X509#readCertHex}</li> 80 * <li>get all certificate information - {@link X509#getInfo}</li> 81 * <li>get specified extension information - {@link X509#getExtInfo}</li> 82 * <li>verify signature value - {@link X509#verifySignature}</li> 83 * </ul> 84 * </li> 85 * </ul> 86 */ 87 function X509() { 88 var _ASN1HEX = ASN1HEX, 89 _getChildIdx = _ASN1HEX.getChildIdx, 90 _getV = _ASN1HEX.getV, 91 _getTLV = _ASN1HEX.getTLV, 92 _getVbyList = _ASN1HEX.getVbyList, 93 _getTLVbyList = _ASN1HEX.getTLVbyList, 94 _getIdxbyList = _ASN1HEX.getIdxbyList, 95 _getVidx = _ASN1HEX.getVidx, 96 _oidname = _ASN1HEX.oidname, 97 _X509 = X509, 98 _pemtohex = pemtohex; 99 100 this.hex = null; 101 this.version = 0; // version (1: X509v1, 3: X509v3, others: unspecified) 102 this.foffset = 0; // field index offset (-1: for X509v1, 0: for X509v3) 103 this.aExtInfo = null; 104 105 // ===== get basic fields from hex ===================================== 106 107 /** 108 * get format version (X.509v1 or v3 certificate) 109 * @name getVersion 110 * @memberOf X509# 111 * @function 112 * @return {Number} 1 for X509v1, 3 for X509v3, otherwise 0 113 * @since jsrsasign 7.1.14 x509 1.1.13 114 * @description 115 * This method returns a format version of X.509 certificate. 116 * It returns 1 for X.509v1 certificate and 3 for v3 certificate. 117 * Otherwise returns 0. 118 * This method will be automatically called in 119 * {@link X509#readCertPEM}. After then, you can use 120 * {@link X509.version} parameter. 121 * @example 122 * var x = new X509(); 123 * x.readCertPEM(sCertPEM); 124 * version = x.getVersion(); // 1 or 3 125 * sn = x.getSerialNumberHex(); // return string like "01ad..." 126 */ 127 this.getVersion = function() { 128 if (this.hex === null || this.version !== 0) return this.version; 129 130 // check if the first item of tbsCertificate "[0] { INTEGER 2 }" 131 if (_getTLVbyList(this.hex, 0, [0, 0]) !== 132 "a003020102") { 133 this.version = 1; 134 this.foffset = -1; 135 return 1; 136 } 137 138 this.version = 3; 139 return 3; 140 }; 141 142 /** 143 * get hexadecimal string of serialNumber field of certificate. 144 * @name getSerialNumberHex 145 * @memberOf X509# 146 * @function 147 * @return {String} hexadecimal string of certificate serial number 148 * @example 149 * var x = new X509(); 150 * x.readCertPEM(sCertPEM); 151 * var sn = x.getSerialNumberHex(); // return string like "01ad..." 152 */ 153 this.getSerialNumberHex = function() { 154 return _getVbyList(this.hex, 0, [0, 1 + this.foffset], "02"); 155 }; 156 157 /** 158 * get signature algorithm name in basic field 159 * @name getSignatureAlgorithmField 160 * @memberOf X509# 161 * @function 162 * @return {String} signature algorithm name (ex. SHA1withRSA, SHA256withECDSA) 163 * @since x509 1.1.8 164 * @description 165 * This method will get a name of signature algorithm field of certificate: 166 * @example 167 * var x = new X509(); 168 * x.readCertPEM(sCertPEM); 169 * algName = x.getSignatureAlgorithmField(); 170 */ 171 this.getSignatureAlgorithmField = function() { 172 return _oidname(_getVbyList(this.hex, 0, [0, 2 + this.foffset, 0], "06")); 173 }; 174 175 /** 176 * get hexadecimal string of issuer field TLV of certificate. 177 * @name getIssuerHex 178 * @memberOf X509# 179 * @function 180 * @return {String} hexadecial string of issuer DN ASN.1 181 * @example 182 * var x = new X509(); 183 * x.readCertPEM(sCertPEM); 184 * var issuer = x.getIssuerHex(); // return string like "3013..." 185 */ 186 this.getIssuerHex = function() { 187 return _getTLVbyList(this.hex, 0, [0, 3 + this.foffset], "30"); 188 }; 189 190 /** 191 * get string of issuer field of certificate. 192 * @name getIssuerString 193 * @memberOf X509# 194 * @function 195 * @return {String} issuer DN string 196 * @example 197 * var x = new X509(); 198 * x.readCertPEM(sCertPEM); 199 * var issuer = x.getIssuerString(); // return string like "/C=US/O=TEST" 200 */ 201 this.getIssuerString = function() { 202 return _X509.hex2dn(this.getIssuerHex()); 203 }; 204 205 /** 206 * get hexadecimal string of subject field of certificate. 207 * @name getSubjectHex 208 * @memberOf X509# 209 * @function 210 * @return {String} hexadecial string of subject DN ASN.1 211 * @example 212 * var x = new X509(); 213 * x.readCertPEM(sCertPEM); 214 * var subject = x.getSubjectHex(); // return string like "3013..." 215 */ 216 this.getSubjectHex = function() { 217 return _getTLVbyList(this.hex, 0, [0, 5 + this.foffset], "30"); 218 }; 219 220 /** 221 * get string of subject field of certificate. 222 * @name getSubjectString 223 * @memberOf X509# 224 * @function 225 * @return {String} subject DN string 226 * @example 227 * var x = new X509(); 228 * x.readCertPEM(sCertPEM); 229 * var subject = x.getSubjectString(); // return string like "/C=US/O=TEST" 230 */ 231 this.getSubjectString = function() { 232 return _X509.hex2dn(this.getSubjectHex()); 233 }; 234 235 /** 236 * get notBefore field string of certificate. 237 * @name getNotBefore 238 * @memberOf X509# 239 * @function 240 * @return {String} not before time value (ex. "151231235959Z") 241 * @example 242 * var x = new X509(); 243 * x.readCertPEM(sCertPEM); 244 * var notBefore = x.getNotBefore(); // return string like "151231235959Z" 245 */ 246 this.getNotBefore = function() { 247 var s = _getVbyList(this.hex, 0, [0, 4 + this.foffset, 0]); 248 s = s.replace(/(..)/g, "%$1"); 249 s = decodeURIComponent(s); 250 return s; 251 }; 252 253 /** 254 * get notAfter field string of certificate. 255 * @name getNotAfter 256 * @memberOf X509# 257 * @function 258 * @return {String} not after time value (ex. "151231235959Z") 259 * @example 260 * var x = new X509(); 261 * x.readCertPEM(sCertPEM); 262 * var notAfter = x.getNotAfter(); // return string like "151231235959Z" 263 */ 264 this.getNotAfter = function() { 265 var s = _getVbyList(this.hex, 0, [0, 4 + this.foffset, 1]); 266 s = s.replace(/(..)/g, "%$1"); 267 s = decodeURIComponent(s); 268 return s; 269 }; 270 271 /** 272 * get a hexadecimal string of subjectPublicKeyInfo field. 273 * @name getPublicKeyHex 274 * @memberOf X509# 275 * @function 276 * @return {String} ASN.1 SEQUENCE hexadecimal string of subjectPublicKeyInfo field 277 * @since jsrsasign 7.1.4 x509 1.1.13 278 * @example 279 * x = new X509(); 280 * x.readCertPEM(sCertPEM); 281 * hSPKI = x.getPublicKeyHex(); // return string like "30820122..." 282 */ 283 this.getPublicKeyHex = function() { 284 return _ASN1HEX.getTLVbyList(this.hex, 0, [0, 6 + this.foffset], "30"); 285 }; 286 287 /** 288 * get a string index of subjectPublicKeyInfo field for hexadecimal string certificate. 289 * @name getPublicKeyIdx 290 * @memberOf X509# 291 * @function 292 * @return {Number} string index of subjectPublicKeyInfo field for hexadecimal string certificate. 293 * @since jsrsasign 7.1.4 x509 1.1.13 294 * @example 295 * x = new X509(); 296 * x.readCertPEM(sCertPEM); 297 * idx = x.getPublicKeyIdx(); // return string index in x.hex parameter 298 */ 299 this.getPublicKeyIdx = function() { 300 return _getIdxbyList(this.hex, 0, [0, 6 + this.foffset], "30"); 301 }; 302 303 /** 304 * get a string index of contents of subjectPublicKeyInfo BITSTRING value from hexadecimal certificate 305 * @name getPublicKeyContentIdx 306 * @memberOf X509# 307 * @function 308 * @return {Integer} string index of key contents 309 * @since jsrsasign 8.0.0 x509 1.2.0 310 * @example 311 * x = new X509(); 312 * x.readCertPEM(sCertPEM); 313 * idx = x.getPublicKeyContentIdx(); // return string index in x.hex parameter 314 */ 315 // NOTE: Without BITSTRING encapsulation. 316 this.getPublicKeyContentIdx = function() { 317 var idx = this.getPublicKeyIdx(); 318 return _getIdxbyList(this.hex, idx, [1, 0], "30"); 319 }; 320 321 /** 322 * get a RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field. 323 * @name getPublicKey 324 * @memberOf X509# 325 * @function 326 * @return {Object} RSAKey/ECDSA/DSA public key object of subjectPublicKeyInfo field 327 * @since jsrsasign 7.1.4 x509 1.1.13 328 * @example 329 * x = new X509(); 330 * x.readCertPEM(sCertPEM); 331 * pubkey= x.getPublicKey(); 332 */ 333 this.getPublicKey = function() { 334 return KEYUTIL.getKey(this.getPublicKeyHex(), null, "pkcs8pub"); 335 }; 336 337 /** 338 * get signature algorithm name from hexadecimal certificate data 339 * @name getSignatureAlgorithmName 340 * @memberOf X509# 341 * @function 342 * @param {String} hCert hexadecimal string of X.509 certificate binary 343 * @return {String} signature algorithm name (ex. SHA1withRSA, SHA256withECDSA) 344 * @since jsrsasign 7.2.0 x509 1.1.14 345 * @description 346 * This method will get signature algorithm name of certificate: 347 * @example 348 * var x = new X509(); 349 * x.readCertPEM(sCertPEM); 350 * x.getSignatureAlgorithmName() → "SHA256withRSA" 351 */ 352 this.getSignatureAlgorithmName = function() { 353 return _oidname(_getVbyList(this.hex, 0, [1, 0], "06")); 354 }; 355 356 /** 357 * get signature value in hexadecimal string 358 * @name getSignatureValueHex 359 * @memberOf X509# 360 * @function 361 * @return {String} signature value hexadecimal string without BitString unused bits 362 * @since jsrsasign 7.2.0 x509 1.1.14 363 * @description 364 * This method will get signature value of certificate: 365 * @example 366 * var x = new X509(); 367 * x.readCertPEM(sCertPEM); 368 * x.getSignatureValueHex() &rarr "8a4c47913..." 369 */ 370 this.getSignatureValueHex = function() { 371 return _getVbyList(this.hex, 0, [2], "03", true); 372 }; 373 374 /** 375 * verifies signature value by public key 376 * @name verifySignature 377 * @memberOf X509# 378 * @function 379 * @param {Object} pubKey public key object 380 * @return {Boolean} true if signature value is valid otherwise false 381 * @since jsrsasign 7.2.0 x509 1.1.14 382 * @description 383 * This method verifies signature value of hexadecimal string of 384 * X.509 certificate by specified public key object. 385 *