Yet Another Alipay OpenAPI Smart Development Kit

• OOP风格化的，可弹性扩容的，支付宝OpenAPI SDK
• 低依赖，目前仅依赖 Axios
• 使用Node原生代码实现支付宝OpenAPI的AES(aes-128-cbc)加/解密功能
• 使用Node原生代码实现支付宝OpenAPI的RSA(sha1WithRSAEncryption)及RSA2(sha256WithRSAEncryption)签名、验签功能
• 异步通知消息验签
• 命令行网关交互工具

• 使用 method({请求参数}[, {公共请求参数}[, {特殊头参数}]]) 作为HTTP接口驱动，释义如下：
  • 接口定义中公共请求参数的 method，即作为本SDK标准方法链，弹性扩容，示例使用方法如下，详细审查见文末
  • 接口定义中的请求参数，以 Object 对象作为第一个入参
  • 接口定义中的公共请求参数，以 Object 对象作为第二个入参
  • 特别的，对于图片/视频上传，需要定义 multipart/form-data 头信息，以 Object 对象作为第三个入参，见如下示例
  • 特别的，对于页面表单提交型，即所谓的page类接口，第三参数须定义为 Formatter.page，返回结果可直接作为页面/接口输出，说明用法见如下示例
• 请求数据签名以及返回数据验签均自动完成，开发者仅需关注业务代码即可；特别地，对于验签结果有依赖的情况，可以从返回值的头部获取：
  • headers[x-alipay-verified] 为验签结果，值可能为 ok, undefined
  • headers[x-alipay-signature] 为源返回数据签名值，值可能为 undefined
  • headers[x-alipay-responder] 为源返回值字段名转译，值可能为 undefined, error 或者实际请求的 method 值

以命令行的形式，与OpenAPI网关交互，play the OpenAPI requests over command line.

Usage: cli.js [options]

Options:
  -k, --privateKey  The privateKey pem file path                                                              [required]
  -p, --publicCert  The publicCert pem file path                                                              [required]
  -m, --method      The method, eg: alipay.trade.query                                                        [required]
  -s, --search      The search parameters, eg: search.app_id=2088                                             [required]
  -b, --biz         The biz_content, eg: biz.out_trade_no=abcd1234                                            [required]
  -d, --log         Turn on the request trace log                                                              [boolean]
  -u, --baseURL     The OpenAPI gateway, eg: https://openapi.alipaydev.com/gateway.do
  -h, --help        Show help                                                                                  [boolean]
  -V, --version     Show version number                                                                        [boolean]

Examples:
  cli.js -k merchant.key -p alipay.pub -m alipay.trade.pay      The Face2Face barCode scenario
  -s.app_id=2088 -b.subject=HelloKitty
  -b.out_trade_no=Kitty0001 -b.scene=bar_code
  -b.total_amount=0.01 -b.auth_code=
  cli.js -k merchant.key -p alipay.pub -m alipay.trade.refund   The trade refund scenario
  -s.app_id=2088 -b.refund_amount=0.01 -b.refund_currency=CNY
  -b.out_trade_no=Kitty0001
  cli.js -d -u https://openapi.alipaydev.com/gateway.do -k      The trade query scenario over the sandbox environment
  merchant.key -p alipay.pub -m alipay.trade.query              with trace logging
  -s.app_id=2088 -b.out_trade_no=Kitty0001

Usage: cert.js [command] [options]

Commands:
  cert.js SN       Get the certificatie(s) `SN`                 [default]
  cert.js extract  Extract the chained certificate(s)

Options:
  -f, --file     The certificate(s) file path                   [required]
  -p, --pattern  The algo prefix or suffix, dot(.) for all
  -h, --help     Show help                                      [boolean]
  -V, --version  Show version number                            [boolean]

Examples:
  cert.js SN -f alipayRootCert.crt                              get the `sha256`(default) certificate `SN`
  cert.js SN -f alipayRootCert.crt -p ec                        get the signatureAlgorithm whose contains `ec` words
                                                                certificate `SN`
  cert.js SN -f alipayRootCert.crt -p .                         get all chained certificate(s) `SN`
  cert.js extract -f alipayRootCert.crt                         extract the `sha256`(default) certificate
  cert.js extract -f alipayRootCert.crt -p sha1                 extract the `sha1` certificate
  cert.js extract -f alipayRootCert.crt -p .                    extract all chained certificate(s)
  cert.js extract -f alipayRootCert.crt -p sha1 | openssl x509  piped openssl x509 command
  -noout -text
  cert.js extract -f alipayRootCert.crt -p sha1 > tmp.pem       save to a file

此命令行工具，主要是用来计算并获取 公钥证书模式 所需的 应用公钥证书SN(app_cert_sn)及 支付宝公钥证书SN(alipay_root_cert_sn)。

./bin/cert.js SN -f /path/your/app_cert.crt

./bin/cert.js SN -f /path/your/alipay_root_cert.crt -p RSAEncryption

而SN 命令是 Helpers.SN 的语法糖，可从如下API文档查看更详细用法

const {readFileSync} = require('fs')
const {Alipay} = require('whats-alipay')

//应用app_id
const app_id = '2014072300007148'

//商户私钥证书，须完整格式，同时支持 `PKCS#1` `PKCS#8` 格式
const privateKey = readFileSync('/your/openapi/private_key.pem')

//支付宝公钥证书，须完整格式，同时支持 `PKCS#1` `PKCS#8` 格式
const publicCert = readFileSync('/the/alipay/public_cert.pem')

const whats = new Alipay({ privateKey, publicCert, params: { app_id, } })

证书完整格式 是指： 包含 -----BEGIN 及 -----END，内容是列宽64的base64-encoded字符串，可直接用 openssl 命令行工具进行验证格式。

whats
  .alipay.trade.query({out_trade_no})
  .then(({headers,data}) => ({headers,data}))
  .catch(({response: {data}}) => data)
  .then(console.log)

{
  headers: {
    server: 'Tengine/2.1.0',
    date: 'Fri, 25 Sep 2020 03:27:32 GMT',
    'content-type': 'text/html;charset=utf-8',
    'content-length': '829',
    connection: 'close',
    'set-cookie': [
      'JSESSIONID=6FF6F65BB1EC785992117C95EA7C27BB; Path=/; HttpOnly',
      'spanner=ubOmkyHGnYLtouOsffShT4n70pJgSji6Xt2T4qEYgj0=;path=/;secure;'
    ],
    via: 'spanner-internet-5396.sa127[200]',
    'x-alipay-responder': 'alipay.trade.query',
    'x-alipay-signature': 'gALtsKSWEWRG4wSx8f1aPcLXYrro3ZLGplxNWerZkIAGR4qNz3fP4JCjdRx2M4uFfLfL1uIQ/L1Rt/oZD+NVKn46rLj7YLXWz2jTEnPPofgXywhwHIZ/MfrRc1DjL0xAh00OI6Gur2lileXmn7zaOG0RQoc0mXkSO5AwLWbiO0EnSoh3897TgQFp1hRDpTpXjnxvKSSFiUgr4EDCklfJbc6B3I1i3BvHtzB+lXtHPABukAvzJD/QtjjglIyOeZZ03699cCEl2JmJYGdA1Du+bBjsycLogCNXBLCmdOi5ntRVEo/Tlvl0QYTRleC7dGuCCn1ousZXLy09VUzJ1m85Fw==',
    'x-alipay-verified': 'ok'
  },
  data: {
    code: '10000',
    msg: 'Success',
    buyer_logon_id: '134******38',
    buyer_pay_amount: '183.00',
    buyer_user_id: '2088101117955611',
    fund_bill_list: [ { amount: '183.00', fund_channel: 'ALIPAYACCOUNT' } ],
    invoice_amount: '183.00',
    out_trade_no: '6823789339978248',
    point_amount: '0.00',
    receipt_amount: '183.00',
    send_pay_date: '2020-09-19 17:00:28',
    total_amount: '183.00',
    trade_no: '2013112011001004330000121536',
    trade_status: 'TRADE_SUCCESS'
  }
}

whats
  .alipay.trade.pay({
    out_trade_no,
    scene,
    auth_code,
    product_code,
    subject,
    total_amount,
  })
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .alipay.trade.precreate({
    out_trade_no,
    subject,
    total_amount,
  })
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .alipay.trade.wap.pay({
    out_trade_no,
    subject,
    total_amount,
    product_code,
    quit_url,
  }, {}, Formatter.page)
  .then(res => res)
  .then(console.log)

• 注: 特别地 res 结构做了优化，直接支持 literal(独立服务模式: ${res}) 或者 JSON.stringify (二次接口模式: JSON.stringify(res))

whats
  .alipay.trade.page.pay({
    out_trade_no,
    subject,
    total_amount,
    product_code,
  }, {return_url}, Formatter.page)
  .then(res => res)
  .then(console.log)

• 注: 特别地 res 结构做了优化，直接支持 literal(独立服务模式: ${res}) 或者 JSON.stringify (二次接口模式: JSON.stringify(res))

whats
  .alipay.trade.advance.consult({/*文档上的参数就好*/})
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .koubei.marketing.campaign.activity.batchquery(/*文档上的参数就好*/})
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

const {Form} = require('whats-alipay')
const payload = new Form()
payload.append('image_content', require('fs').readFileSync('/path/for/uploading.jpg'), 'uploading.jpg')

whats
  .ant.merchant.expand.indirect.image.upload(
    payload.getBuffer(),
    {image_type: 'jpg'},
    {...payload.getHeaders()}
  )
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

const {Form} = require('whats-alipay')
const payload = new Form()
payload.append('image_content', require('fs').readFileSync('/path/for/uploading.jpg'), 'uploading.jpg')

whats
  .alipay.offline.material.image.upload(
    payload.getBuffer(),
    {image_type: 'jpg', image_name: 'uploading.jpg'},
    {...payload.getHeaders()}
  )
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .zhima.auth.info.authquery(/*文档上的参数就好*/})
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .alipay.eco.mycar.parking.enterinfo.sync(/*文档上的参数就好*/})
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats
  .alipay.fund.trans.uni.transfer(/*文档上的参数就好*/})
  .then(({data}) => data)
  .catch(({response: {data}}) => data)
  .then(console.log)

whats 上绑定多少 method，即扩容至多少，以上示例打印如下：

console.info(whats)

[Function (anonymous)] {
  ant: [Function: ant] {
    merchant: [Function: ant.merchant] {
      expand: [Function: ant.merchant.expand] {
        indirect: [Function: ant.merchant.expand.indirect] {
          image: [Function: ant.merchant.expand.indirect.image] {
            upload: [Function: ant.merchant.expand.indirect.image.upload]
          }
        }
      }
    }
  },
  alipay: [Function: alipay] {
    trade: [Function: alipay.trade] {
      query: [Function: alipay.trade.query],
      precreate: [Function: alipay.trade.precreate],
      advance: [Function: alipay.trade.advance] {
        consult: [Function: alipay.trade.advance.consult]
      },
      page: [Function: alipay.trade.page] {
        pay: [Function: alipay.trade.page.pay]
      },
      wap: [Function: alipay.trade.wap] {
        pay: [Function: alipay.trade.wap.pay]
      }
    },
    fund: [Function: alipay.fund] {
      trans: [Function: alipay.fund.trans] {
        uni: [Function: alipay.fund.trans.uni] {
          transfer: [Function: alipay.fund.trans.uni.transfer]
        }
      }
    },
    eco: [Function: alipay.eco] {
      mycar: [Function: alipay.eco.mycar] {
        parking: [Function: alipay.eco.mycar.parking] {
          enterinfo: [Function: alipay.eco.mycar.parking.enterinfo] {
            sync: [Function: alipay.eco.mycar.parking.enterinfo.sync]
          }
        }
      }
    },
    offline: [Function: alipay.offline] {
      material: [Function: alipay.offline.material] {
        image: [Function: alipay.offline.material.image] {
          upload: [Function: alipay.offline.material.image.upload]
        }
      }
    }
  },
  zhima: [Function: zhima] {
    auth: [Function: zhima.auth] {
      info: [Function: zhima.auth.info] {
        authquery: [Function: zhima.auth.info.authquery]
      }
    }
  },
  koubei: [Function: koubei] {
    marketing: [Function: koubei.marketing] {
      campaign: [Function: koubei.marketing.campaign] {
        activity: [Function: koubei.marketing.campaign.activity] {
          batchquery: [Function: koubei.marketing.campaign.activity.batchquery]
        }
      }
    }
  }
}

Alipay 类实例链如下:

console.info(Alipay)

<ref *1> [class Alipay] {
  default: [Circular *1],
  Alipay: [Circular *1],
  Rsa: <ref *2> [class Rsa] { default: [Circular *2] },
  Aes: <ref *3> [class Aes] {
    default: [Circular *3],
    AesCbc: [class AesCbc extends Aes]
  },
  AesCbc: [class AesCbc extends Aes],
  Form: <ref *4> [class Form] { default: [Circular *4] },
  Formatter: <ref *5> [class Formatter] { default: [Circular *5] },
  Decorator: <ref *6> [class Decorator] {
    default: [Circular *6],
    [Symbol(PRIVATE_KEY)]: <Buffer 2d 2d 2d 2d 2d 42 45 47 49 4e 20 50 52 49 56 41 54 45 20 4b 45 59 2d 2d 2d 2d 2d 0a 4d 49 49 45 76 67 49 42 41 44 41 4e 42 67 6b 71 68 6b 69 47 39 77 ... 1653 more bytes>,
    [Symbol(PUBLIC_CERT)]: <Buffer 2d 2d 2d 2d 2d 42 45 47 49 4e 20 50 55 42 4c 49 43 20 4b 45 59 2d 2d 2d 2d 2d 0a 4d 49 49 42 49 6a 41 4e 42 67 6b 71 68 6b 69 47 39 77 30 42 41 51 45 ... 400 more bytes>,
    [Symbol(CLIENT)]: [Function: wrap] {
      request: [Function: wrap],
      getUri: [Function: wrap],
      delete: [Function: wrap],
      get: [Function: wrap],
      head: [Function: wrap],
      options: [Function: wrap],
      post: [Function: wrap],
      put: [Function: wrap],
      patch: [Function: wrap],
      defaults: {
        method: 'post',
        headers: {
          common: { Accept: 'application/json, text/plain, */*' },
          delete: {},
          get: {},
          head: {},
          post: { 'Content-Type': 'application/x-www-form-urlencoded' },
          put: { 'Content-Type': 'application/x-www-form-urlencoded' },
          patch: { 'Content-Type': 'application/x-www-form-urlencoded' },
          'User-Agent': 'WhatsAlipay/0.0.9 Node/14.5.0 darwin/x64'
        },
        params: {
          app_id: '2014072300007148',
          format: 'JSON',
          charset: 'utf-8',
          sign_type: 'RSA2',
          version: '1.0'
        },
        baseURL: 'https://openapi.alipay.com/gateway.do',
        transformRequest: [ [Function: transformRequest] ],
        transformResponse: [ [Function: verifier], [Function: transformResponse] ],
        timeout: 0,
        adapter: [Function: httpAdapter],
        xsrfCookieName: 'XSRF-TOKEN',
        xsrfHeaderName: 'X-XSRF-TOKEN',
        maxContentLength: -1,
        maxBodyLength: -1,
        validateStatus: [Function: validateStatus]
      },
      interceptors: {
        request: InterceptorManager {
          handlers: [ { fulfilled: [Function: signer], rejected: undefined } ]
        },
        response: InterceptorManager { handlers: [] }
      }
    }
  }
}

通知消息验签，依赖相关 webserver 提供的 POST 数据解析能力，以下函数在 http.createServer 上做过验证，仅供参考。

function notificationValidator(things, publicCert, withoutSignType = true) {
  const {groups: {sign}} = (typeof things === 'string' ? things : '').match(/\bsign=(?<sign>[^&]+)/) || {groups: {}}
  const source = [...new URLSearchParams(things)].reduce((des, [key, value]) => (des[key] = value, des), {})
  const signType = source['sign_type']
  const signature = (source.sign || '').replace(/ /g, '+').replace(/_/g, '/')
  // The signature with `sign_type` is only for the notifications whose come from `alipay.open.public.*` APIs.
  if (withoutSignType) {
      delete source['sign_type']
  }

  return Rsa.verify(Formatter.queryStringLike(Formatter.ksort(source)), sign || signature, publicCert, signType)
}

Manually generated by for f in lib/*.js; do ./node_modules/.bin/jsdoc2md -d 3 $f; done

Aes

Aes - Advanced Encryption Standard

AesCbc

AesCbc

Aes - Advanced Encryption Standard

Kind: global class

• Aes
  • new Aes()
  • .hex
  • .utf8
  • .base64
  • .BLOCK_SIZE
  • .MODE_CBC
  • .detector(cipherkey, [mode]) ⇒ array

To prevent new operation, works only as static class.

Kind: static property of Aes Properties

Kind: static property of Aes Properties

Kind: static property of Aes Properties

Kind: static property of Aes Properties

Kind: static property of Aes Properties

Detect the algo with given cipherkey length and mode.

Kind: static method of Aes Returns: array - - [algorithm, key] pairs

AesCbc

Kind: global class

• AesCbc
  • .encrypt(plaintext, cipherkey, [iv]) ⇒ string
  • .decrypt(ciphertext, cipherkey, [iv]) ⇒ string

Encrypts plaintext.

Kind: static method of AesCbc Returns: string - Base64-encoded ciphertext.

Decrypts ciphertext.

Kind: static method of AesCbc Returns: string - Utf-8 plaintext.

Alipay

Whats Alipay Core

get(target, property) ⇒ object

Whats Alipay Core

Kind: global class

• Alipay
  • new Alipay(config)
  • .handler
  • .compose([prefix], [suffix]) ⇒ Proxy
  • .chain(method) ⇒ function

To compose the method chain.

Kind: static property of Alipay Properties

Compose a named function with prefix and suffix whose joined by a dot(.)

Kind: static method of Alipay Returns: Proxy - - With a special Getter Function.

Chain the input method

Kind: static method of Alipay Returns: function - - Named as given method function

Kind: global function Returns: object - - An object or object's property

Properties

Decorate the Axios instance

Kind: global class

• Decorator
  • new Decorator(config)
  • .client
  • .privateKey
  • .publicCert
  • .requestInterceptor
  • .responseVerifier
  • .defaults
  • .request(config) ⇒ PromiseLike
  • .withDefaults(config) ⇒ object

Decorate factory

Kind: static property of Decorator Properties

Kind: static property of Decorator Properties

Kind: static property of Decorator Properties

Kind: static property of Decorator Properties

Kind: static property of Decorator Properties

Kind: static property of Decorator Properties

Portable of the axios.request with defaults {method, params, headers} compatible since Axios >= 0.19.0

• Typeof function of config.headers is available since v0.0.9

Kind: static method of Decorator Returns: PromiseLike - - The AxiosPromise instance.

Deep merge the input with the defaults

Kind: static method of Decorator Returns: object - - With the built-in configuration.

Form

Simple and lite of multipart/form-data implementation, most similar to form-data

(new Form)
  .append('a', 1)
  .append('b', '2')
  .append('c', Buffer.from('31'))
  .append('d', JSON.stringify({}), 'any.json')
  .append('e', require('fs').readFileSync('/path/your/file.jpg'), 'file.jpg')
  .getBuffer()

mimeTypes : Object.<string, string>

built-in mime-type mapping

dashDash : Buffer

boundary : Buffer

CRLF : Buffer

data : array.<Buffer>

The Form's data storage

indices : Object.<string, number>

The entities' value indices whose were in this.data

Simple and lite of multipart/form-data implementation, most similar to form-data

(new Form)
  .append('a', 1)
  .append('b', '2')
  .append('c', Buffer.from('31'))
  .append('d', JSON.stringify({}), 'any.json')
  .append('e', require('fs').readFileSync('/path/your/file.jpg'), 'file.jpg')
  .getBuffer()

Kind: global class

• Form
  • new Form()
  • .getBuffer() ⇒ Buffer
  • .getHeaders() ⇒ Object.<string, string>
  • .appendMimeTypes(things) ⇒ Form
  • .append(field, value, [filename]) ⇒ Form

Create a multipart/form-data buffer container for the file uploading.

To retrieve the data buffer

Kind: instance method of Form Returns: Buffer - - The payload buffer

To retrieve the Content-Type multipart/form-data header

Kind: instance method of Form Returns: Object.<string, string> - - The Content-Type header With this.boundary

Append a customized mime-type(s)

Kind: instance method of Form Returns: Form - - The Form class instance self

Append data wrapped by boundary

Kind: instance method of Form Returns: Form - - The Form class instance self

built-in mime-type mapping

Kind: global variable

Kind: global variable

Kind: global variable

Kind: global variable

The Form's data storage

Kind: global variable

The entities' value indices whose were in this.data

Kind: global variable

Provides easy used methods using in this project.

Kind: global class

• Formatter
  • new Formatter()
  • .ksort(thing) ⇒ object
  • .queryStringLike(thing) ⇒ string
  • .localeDateTime([when], [timeZone]) ⇒ string
  • .fromJsonLike(source, [placeholder]) ⇒ object
  • .isLeapYear(numeric) ⇒ boolean
  • .page(options) ⇒ object

To prevent new operation, works only as static class.

Sorts an Object by key.

Kind: static method of Formatter Returns: object - - The sorted object.

Like queryString does but without the sign and empty value entities.

Kind: static method of Formatter Returns: string - - The sorted object.

Retrieve the current yyyy-MM-dd HH:mm:ss date time based on given timeZone.

Notes: NodeJS v10.15.3,v12.18.0,v14.5.0 had strange behavior on Intl.DateTimeFormat, see hourCycle:h23 comments below:

Kind: static method of Formatter Returns: string - - yyyy-MM-dd HH:mm:ss date time string

Parse the source with given placeholder.

Kind: static method of Formatter Returns: object - - {ident, payload, sign} object

Check the given numeric input whether or nor the leap year.

Kind: static method of Formatter Returns: boolean - - True means is leap year, otherwise NOT.

Translate the inputs for the page service, such as alipay.trade.page.pay, alipay.trade.wap.pay OpenAPI methods.

• Available since v0.0.9

Kind: static method of Formatter Returns: object - - Minimal following the AxiosResponse specification, returns {data, toJSON(), toString()} object

Provide some useful functions for the catificate(s)

Kind: global class

• Helpers
  • new Helpers()
  • .LF
  • .OIDs
  • .md5(...things) ⇒ string
  • .wordwrap(str, [width], [char]) ⇒ string
  • .load(thing, [pattern]) ⇒ array.<Certificate>
  • .extract(thing, [pattern]) ⇒ string
  • .SN(thing, [pattern]) ⇒ string

To prevent new operation, works only as static class.

Kind: static property of Helpers Propertiy: LF - The line feed character

Kind: static property of Helpers Propertiy: OIDs - Built-in ASN.1 OIDs

MD5 hash function

Kind: static method of Helpers Returns: string - - The digest string

Similar to require('wordwrap') function for formatting the PEM certificate

Kind: static method of Helpers Returns: string - - The wrapped string

Mapping to @fidm/x509.Certificate.fromPEMs

Kind: static method of Helpers Returns: array.<Certificate> - - Array of the @fidm/x509.Certificate instance

Extract a certificate from given thing

Kind: static method of Helpers Returns: string - - The pem format certificate(s)

Calculate the given certificate(s) SN value string

Note: The primitive BigInt was shipped since nodejs v10.8.0, we're >= 10.15.0 on safety.

Kind: static method of Helpers Returns: string - - The SN value string

Provides sign/verify for the RSA sha1WithRSAEncryption RSA2 sha256WithRSAEncryption cryptos.

Kind: global class

• Rsa
  • new Rsa()
  • .base64
  • .ALGO_TYPE_RSA
  • .ALGO_TYPE_RSA2
  • .sign(message, privateKeyCertificate, [type]) ⇒ string
  • .verify(message, signature, publicCertificate, [type]) ⇒ boolean

To prevent new operation, works only as static class.

Kind: static property of Rsa Properties

Kind: static property of Rsa Properties

Kind: static property of Rsa Properties

Creates and returns a Sign string that uses given type=RSA|RSA2.

Kind: static method of Rsa Returns: string - Base64-encoded signature.

Verifying the message with given signature string that uses given type=RSA|RSA2.

Kind: static method of Rsa Returns: boolean - True is passed, false is failed.

npm test

To disable nock and request with the real gateway, just NOCK_OFF=true npm test

• v0.1.1

  • 输出 Helpers 为本模块基础类之一；
  • 优化 Helpers.SN 方法，兼容多DN属性情况；
  • 优化 Formatter.localeDateTime 方法，使用 String.padStart 计算 h23 小时；
  • 优化文档及测试用例覆盖；

• v0.1.0

  • 调整 同步应答验签 逻辑，遵从本SDK约定，只要能从应答返回中解析出有效负载，即仅返回负载；
  • 新增 异步通知消息 验签文档示例函数；
  • 暂时不支持ts，相关问题 #4；
  • npm install --no-optional(>5.8.0)不起作用，不再可选依赖 form-data，以内置 Form 类为主；

• v0.0.11 新增 whatsCli cli.js 命令行交互工具

• v0.0.10 优化 Formatter.page().data.html, 重点兼容utf8

• v0.0.9 新增 Formatter.page 函数，支持page类接口调用(以第三入参回调)

• v0.0.8 完善 API 文档 by jsdoc2md

• v0.0.7 新增 Helpers 类及 certHelper 命令行工具集

• v0.0.6 新增 Form 类，缩减并兼容 form-data

• v0.0.5 向下兼容 NodeJS >= 10.15.0

• v0.0.4 向下兼容 Axios >= 0.19.0

• v0.0.3 增加测试用例及BUG修复

• v0.0.2 重新发布版本

• v0.0.1 初始版本

The MIT License (MIT)

Copyright (c) 2020 James ZHANG(TheNorthMemory)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.