@types/jsrsasign

declare namespace jsrsasign { interface RevokedCertificate { sn: { hex: string; }; date: string; ext: ExtParam[]; } class X509CRL { /** * hexadecimal string of X.509 CRL ASN.1 data. */ hex: string; /** * index of revokedCertificates field in TBSCertList depends on CRL version and nextUpdate field. */ posRevCert: number; /** * index of SignatureAlgorithm field in TBSCertList position depends on CRL version field. */ posSigAlg: number; parsed: null | { sigalg: string; issuer: IdentityResponse; thisupdate: string; nextupdate?: string | null; revCerts?: RevokedCertificate[]; ext?: RevokedCertificate[]; sighex: { array?: IdentityArray; str: string; }; tbshex?: string; }; constructor(params?: string); /* * set field position of SignatureAlgorithm and revokedCertificates * @description * This method will set "posSigAlg" and "posRevCert" properties. */ _setPos(): void; /** * get X.509 CRL format version * name getVersion * memberOf X509CRL# * * @return Number version field value (generally 2) or null * @description * This method returns a version field value TBSCertList. * This returns null if there is no such field. * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getVersion() → 2 */ getVersion(): number | null; /** * get signature algorithm name in basic field * name getSignatureAlgorithmField * memberOf X509CRL# * * @return String signature algorithm name (ex. SHA1withRSA, SHA256withECDSA, SHA512withRSAandMGF1) * @see X509#getSignatureAlgorithmField * @see KJUR.asn1.x509.AlgirithmIdentifier * * @description * This method will get a name of signature algorithm in CRL. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getSignatureAlgorithmField() → "SHA256withRSAandMGF1" */ getSignatureAlgorithmField(): string; /** * get JSON object of issuer field * name getIssuer * memberOf X509CRL# * * @return Array JSON object of issuer field * @see X509#getIssuer * @see X509#getX500Name * @see KJUR.asn1.x509.X500Name * * @description * This method returns parsed issuer field value as * JSON object. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * x.getIssuer() → * { array: [[{type:'C',value:'JP',ds:'prn'}],...], * str: "/C=JP/..." } */ getIssuer(): X500Name; /** * get hexadecimal string of issuer field TLV of certificate. * name getIssuerHex * memberOf X509CRL# * * @return string hexadecial string of issuer DN ASN.1 * @see X509CRL#getIssuer * @since jsrsasign 10.5.5 x509crl 1.0.3 * * @description * This method returns ASN.1 DER hexadecimal string of * issuer field. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * x.getIssuerHex() → "30..." */ getIssuerHex(): string; /** * get JSON object of thisUpdate field * name getThisUpdate * memberOf X509CRL# * * @return String string of thisUpdate field (ex. "YYMMDDHHmmSSZ") * @see X509#getNotBefore * @see X509CRL#getNextUpdate * @see KJUR.asn1.x509.Time * * @description * This method returns parsed thisUpdate field value as * string. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * x.getThisUpdate() → "200825235959Z" */ getThisUpdate(): string; /** * get JSON object of nextUpdate field * name getNextUpdate * memberOf X509CRL# * * @return String string of nextUpdate field or null * @see X509#getNotBefore * @see X509CRL#getThisUpdate * @see KJUR.asn1.x509.Time * * @description * This method returns parsed nextUpdate field value as * string. "nextUpdate" is OPTIONAL field so * when nextUpdate field doesn't exists, this returns null. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getNextUpdate() → "200825235959Z" */ getNextUpdate(): string | null; /** * get array for revokedCertificates field * name getRevCertArray * memberOf X509CRL# * * @return Array array of revokedCertificate parameter or null * @see X509CRL#getRevCert * * @description * This method returns parsed revokedCertificates field value as * array of revokedCertificate parameter. * If the field doesn't exists, it returns null. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getRevCertArray() → * [{sn:"123a", date:"208025235959Z", ext: [{extname:"cRLReason",code:3}]}, * {sn:"123b", date:"208026235959Z", ext: [{extname:"cRLReason",code:0}]}] */ getRevCertArray(): RevokedCertificate[] | null; /** * get revokedCertificate JSON parameter * name getRevCert * memberOf X509CRL# * * @return Array JSON object for revokedCertificate parameter * @see X509CRL#getRevCertArray * * @description * This method returns parsed revokedCertificate parameter * as JSON object. * * @example * crl = new X509CRL(); * crl.getRevCertArray("30...") → * {sn:"123a", date:"208025235959Z", ext: [{extname:"cRLReason",code:3}]} */ getRevCert(): RevokedCertificate; /** * get revokedCertificate associative array for checking certificate * name findRevCert * memberOf X509CRL# * * @param PEM or hexadecimal string of certificate to be revocation-checked * @return Object JSON object for revokedCertificate or null * @see X509CRL#getParam * @see X509CRL#findRevCertBySN * @since jsrsasign 10.5.5 x509crl 1.0.3 * * @description * This method will find revokedCertificate entry as JSON object * for a specified certificate. * When the serial number is not found in the entry, this returns null. * Before finding, {@link X509CRL#getParam} is called internally * to parse CRL. * NOTE: This method will just find an entry for a serial number. * You need to check whether CRL is proper one or not * for checking certificate such as signature validation or * name checking. * * @example * crl = new X509CRL(PEMCRL); * * crl.findRevCert(PEMCERT-REVOKED) → * {sn:"123a", date:"208025235959Z", ext: [{extname:"cRLReason",code:3}]} * * crl.findRevCert(PEMCERT-NOTREVOKED) → null * * crl.findRevCert(CERT-HEX) → null or {sn:...} */ findRevCert(sCert: string): RevokedCertificate | null; /** * get revokedCertificate associative array for serial number * name findRevCertBySN * memberOf X509CRL# * * @param hexadecimal string of checking certificate serial number * @return object JSON object for revokedCertificate or null * @see X509CRL#getParam * @see X509CRL#findRevCert * @since jsrsasign 10.5.5 x509crl 1.0.3 * * @description * This method will find revokedCertificate entry as JSON object * for a specified serial number. * When the serial number is not found in the entry, this returns null. * Before finding, {@link X509CRL#getParam} is called internally * to parse CRL. * NOTE: This method will just find an entry for a serial number. * You need to check whether CRL is proper one or not * for checking certificate such as signature validation or * name checking. * * @example * crl = new X509CRL(PEMCRL); * crl.findRevCertBySN("123a") → // revoked * {sn:"123a", date:"208025235959Z", ext: [{extname:"cRLReason",code:3}]} * * crl.findRevCertBySN("0000") → null // not revoked */ findRevCertBySN(hSN: string): RevokedCertificate | null; /** * get signature value as hexadecimal string * name getSignatureValueHex * memberOf X509CRL# * * @return String signature value hexadecimal string without BitString unused bits * * @description * This method will get signature value of CRL. * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getSignatureValueHex() &rarr "8a4c47913..." */ getSignatureValueHex(): string; /** * verifies signature value by public key * name verifySignature * memberOf X509CRL# * * @param pubKey public key object, pubkey PEM or PEM issuer cert * @return Boolean true if signature value is valid otherwise false * @see X509#verifySignature * @see KJUR.crypto.Signature * * @description * This method verifies signature value of hexadecimal string of * X.509 CRL by specified public key. * The signature algorithm used to verify will refer * signatureAlgorithm field. * (See {@link X509CRL#getSignatureAlgorithmField}) * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * x.verifySignature(pubKey) → true, false or raising exception */ verifySignature(pubKey: string | RSAKey | KJUR.crypto.DSA | KJUR.crypto.ECDSA | ECCPrivateKey): boolean; /** * get JSON object for CRL parameters * name getParam * memberOf X509CRL# * * @return Array JSON object for CRL parameters * @see KJUR.asn1.x509.CRL * * @description * This method returns a JSON object of the CRL * parameters. * Return value can be passed to * {@link KJUR.asn1.x509.CRL} constructor. * * NOTE1: From jsrsasign 10.5.16, optional argument can be applied. * It can have following members: * <ul> * <li>tbshex - if this is true, tbshex member with hex value of * tbsCertList will be added</li> * <li>nodnarray - if this is true, array member for subject and * issuer will be deleted to simplify it<li> * </ul> * * @example * crl = new X509CRL("-----BEGIN X509 CRL..."); * crl.getParam() → * {version: 2, * sigalg: "SHA256withRSA", * issuer: {array: * [[{type:"C",value:"JP",ds:"prn"}],[{type:"O",value:"T1",ds:"prn"}]]}, * thisupdate: "200820212434Z", * nextupdate: "200910212434Z", * revcert: [ * {sn:{hex:"123d..."}, * date:"061110000000Z", * ext:[{extname:"cRLReason",code:4}]}], * ext: [ * {extname:"authorityKeyIdentifier",kid:{hex: "03de..."}}, * {extname:"cRLNumber",num:{hex:"0211"}}], * sighex: "3c5e..."} * * crl.getParam({tbshex: true}) → { ... , tbshex: "30..." } * crl.getParam({nodnarray: true}) → {issuer: {str: "/C=JP"}, ...} */ getParam(): { version?: number; sigalg: string; issuer: X500Name | Omit<X500Name, "array">; thisupdate: string; nextupdate?: string; revcert?: RevokedCertificate[]; ext?: ExtParam[]; sighex: string; tbshex?: string; }; } }