@yunzhanghu/sdk-nodejs 0.0.1-beta.1

package/src/common/client.ts

@@ -0,0 +1,367 @@
+import getInstance from "../common/http"
+import * as crypto from "crypto"
+import YZHSDKHttpException from "./exception/yzhSDKHttpException"
+const clearEncoding = "utf8"
+const cipherEncoding = "base64"
+
+export type ResponseCallback<TReuslt = any> = (error: null | string, rep: TReuslt) => void
+
+type ResponseData = any
+
+export class YZHClient {
+  public dealer_id: string
+  public broker_id: string
+  public app_key: string
+  public des3_key: string
+  public private_key: string
+  public yzh_public_key: string
+  public sign_type: "rsa" | "sha256"
+  public base_url?: string
+
+  /**
+   * 构造函数参数
+   * @param {string} dealer_id 平台企业 ID
+   * @param {string} broker_id 综合服务主体 ID
+   * @param {string} app_key App Key
+   * @param {string} des3_key 3DES Key
+   * @param {string} private_key 平台企业私钥
+   * @param {string} yzh_public_key 云账户公钥
+   * @param {string} sign_type 签名方式"rsa" | "sha256"
+   * @param {string} base_url 可选，默认为 https://api-service.yunzhanghu.com/
+   */
+  constructor(conf: {
+    dealer_id: string
+    broker_id: string
+    app_key: string
+    des3_key: string
+    private_key: string
+    yzh_public_key: string
+    sign_type: "rsa" | "sha256"
+    base_url?: string
+  }) {
+    const { dealer_id, broker_id, app_key, des3_key, private_key, yzh_public_key, sign_type } =
+      conf || {}
+    if (
+      conf &&
+      dealer_id &&
+      broker_id &&
+      app_key &&
+      des3_key &&
+      private_key &&
+      yzh_public_key &&
+      sign_type
+    ) {
+      this.dealer_id = conf.dealer_id
+      this.broker_id = conf.broker_id
+      this.app_key = conf.app_key
+      this.des3_key = conf.des3_key
+      this.private_key = conf.private_key
+      this.yzh_public_key = conf.yzh_public_key
+      this.sign_type = conf.sign_type
+      this.base_url = conf?.base_url
+    } else {
+      throw new YZHSDKHttpException(
+        `实例初始化失败，请检查以下配置是否缺失：\ndealer_id、broker_id、app_key、des3_key、private_key、yzh_public_key、sign_type`
+      )
+    }
+  }
+
+  // 基础请求：进行请求实例生成 Header，动态设置、请求体包装等偏底层操作
+  private doRequest(method: string, action: string, req: any): Promise<ResponseData> {
+    // 请求参数加密
+    const encryptParams = this.generatorResquestParams(req)
+    // 生成请求实例，配置 Header
+    const instance = getInstance({
+      request_id: req?.request_id ?? this.mess(),
+      dealer_id: this.dealer_id,
+      base_url: this.base_url,
+    })
+    // 返回请求实例
+    const baseInstanceConf = { method: method, url: action }
+    let instanceConf
+    if (method === "get") {
+      instanceConf = { ...baseInstanceConf, params: encryptParams }
+    } else {
+      instanceConf = { ...baseInstanceConf, data: encryptParams }
+    }
+    return instance(instanceConf)
+  }
+
+  // 公共请求：调用封装好的基础请求方法 doRequest，进行发送请求与响应内容处理
+  async request(
+    method: string,
+    action: string,
+    req?: any,
+    options?: { encryption: boolean },
+    cb?: ResponseCallback
+  ): Promise<ResponseData> {
+    if (typeof options === "function") {
+      cb = options
+      options = {} as any
+    }
+    try {
+      const result = await this.doRequest(method, action, req ?? {})
+      // 错误码处理 > 验签 > 解密
+      const responseData = await this.parseResponse(result, options?.encryption)
+      cb && cb(null, responseData)
+
+      return responseData
+    } catch (e) {
+      if (cb) {
+        cb(e as any, null)
+      } else {
+        throw e
+      }
+    }
+  }
+
+  /**
+   * 请求参数加密
+   * @param {object} params
+   * @returns {*} object
+   */
+  private generatorResquestParams(params: string) {
+    try {
+      const t = Date.now().toString()
+      const m = this.mess()
+
+      const plaintext = JSON.stringify(params)
+
+      const data = this.encrypt(plaintext)
+
+      const signStr = this.generatorSign(data, m, t)
+      return {
+        data,
+        mess: m,
+        timestamp: t,
+        sign: signStr,
+        sign_type: this.sign_type,
+      }
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 生成签名（RSA-SHA256）
+   * @param {string} data 经过加密后的具体数据
+   * @param {string} mess 自定义随机字符串，用于签名
+   * @param {string} timestamp 时间戳，精确到秒
+   * @returns {string} 签名内容
+   */
+  private generatorSignRSASHA256 = (data: string, mess: string, timestamp: string) => {
+    try {
+      const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
+      const sign = crypto.createSign("RSA-SHA256")
+      sign.update(plaintext)
+      sign.end()
+      return sign.sign(this.private_key, cipherEncoding)
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 生成签名（HmacSHA256）
+   * @param {string} data 经过加密后的具体数据
+   * @param {string} mess 自定义随机字符串，用于签名
+   * @param {string} timestamp 时间戳，精确到秒
+   * @returns {string} 签名内容
+   */
+  private generatorSignHmacSHA256 = (data: string, mess: string, timestamp: string) => {
+    try {
+      const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
+      const hmac = crypto.createHmac("sha256", this.app_key)
+      hmac.update(plaintext)
+      return hmac.digest("hex")
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 生成签名
+   * @param {string} data 经过加密后的具体数据
+   * @param {string} mess 自定义随机字符串，用于签名
+   * @param {string} timestamp 时间戳，精确到秒
+   * @param {string} sign_type 签名方式
+   * @returns {string} 签名内容
+   */
+  private generatorSign = (data: string, mess: string, timestamp: string) => {
+    try {
+      switch (this.sign_type) {
+        case "rsa": {
+          return this.generatorSignRSASHA256(data, mess, timestamp)
+        }
+        case "sha256": {
+          return this.generatorSignHmacSHA256(data, mess, timestamp)
+        }
+        default:
+          throw new YZHSDKHttpException(`sign_type类型不存在`)
+      }
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  // 自定义随机字符串
+  private mess = () => {
+    const buf = crypto.randomBytes(16)
+    const token = buf.toString("hex")
+    return token.toString()
+  }
+
+  /**
+   * 3DES 加密数据
+   * @param plaintext
+   * @returns 字符串加密数据
+   */
+  private encrypt = (plaintext: string) => {
+    try {
+      const iv = this.des3_key.slice(0, 8)
+      const cipherChunks = []
+      const cipher = crypto.createCipheriv("des-ede3-cbc", this.des3_key, iv)
+      cipher.setAutoPadding(true)
+      cipherChunks.push(cipher.update(plaintext, clearEncoding, cipherEncoding))
+      cipherChunks.push(cipher.final(cipherEncoding))
+
+      return cipherChunks.join("")
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  // 返回处理结果
+  private async parseResponse(result: ResponseData, encryption?: boolean) {
+    if (result.status !== 200) {
+      const yzhError = new YZHSDKHttpException(result.statusText)
+      yzhError.httpCode = result.status
+      throw yzhError
+    } else {
+      // httpcode 200
+      const { data: axiosData } = result
+      let response = axiosData
+      // 需解密
+      if (encryption) {
+        response = { ...response, data: this.decryption(response.data) }
+      }
+      return response
+    }
+  }
+
+  /**
+   * 3DES 解密数据
+   * @param ciphertext
+   * @returns 明文数据
+   */
+  decryption = (ciphertext: string) => {
+    try {
+      const iv = this.des3_key.slice(0, 8)
+      const cipherChunks = []
+      const decipher = crypto.createDecipheriv("des-ede3-cbc", this.des3_key, iv)
+      decipher.setAutoPadding(true)
+      cipherChunks.push(decipher.update(ciphertext, cipherEncoding, clearEncoding))
+      cipherChunks.push(decipher.final(clearEncoding))
+      return JSON.parse(cipherChunks.join(""))
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 验签
+   * @param {string} data 返回的数据
+   * @param {string} mess 返回的随机字符串
+   * @param {string} timestamp 返回的时间戳
+   * @param {string} sign 返回的签名
+   * @returns {boolean} true：验签成功；false：验签失败
+   */
+  verifyRSASHA256 = (data: string, mess: string, timestamp: string, sign: string) => {
+    try {
+      const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
+      const verify = crypto.createVerify("RSA-SHA256")
+      verify.update(plaintext)
+      return verify.verify(this.yzh_public_key, sign, cipherEncoding)
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  verifyHmacSHA256 = (data: string, mess: string, timestamp: string, sign: string) => {
+    try {
+      const plaintext = `data=${data}&mess=${mess}&timestamp=${timestamp}&key=${this.app_key}`
+      const hmac = crypto.createHmac("sha256", this.app_key)
+      hmac.update(plaintext)
+      return hmac.digest("hex") === sign
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 文件密码解密
+   * @param ciphertextbase64
+   * @returns 解密后的密码
+   */
+  filePassWordDecryption = (ciphertextbase64: string) => {
+    try {
+      const buff = Buffer.from(ciphertextbase64, "base64")
+
+      const decrypted = crypto.privateDecrypt(
+        {
+          key: this.private_key,
+          padding: crypto.constants.RSA_PKCS1_PADDING,
+        },
+        buff
+      )
+      return decrypted.toString("utf8")
+    } catch (err) {
+      throw new YZHSDKHttpException(`${err}`)
+    }
+  }
+
+  /**
+   * 验签+解密
+   * @param responseData 回调返回对象
+   * @returns
+   */
+  notifyDecoder: (params: {
+    /** 返回的数据 */
+    data: string
+    /** 返回的随机字符串 */
+    mess: string
+    /** 返回的时间戳 */
+    timestamp: string
+    /** 返回的签名 */
+    sign: string
+  }) => {
+    /** 验签结果 */
+    result: boolean
+    /** 解密结果 */
+    plaintext: object
+  } = (responseData) => {
+    const notifyDecoderResult = (data: string, mess: string, timestamp: string, sign: string) => {
+      const verifyMap = {
+        rsa: this.verifyRSASHA256,
+        sha256: this.verifyHmacSHA256,
+      }
+      // 验签结果 boolean
+      const verifyResult = verifyMap[this.sign_type](data, mess, timestamp, sign)
+      let plaintext = {}
+      if (verifyResult) {
+        plaintext = this.decryption(data)
+      }
+      return {
+        result: verifyResult,
+        plaintext,
+      }
+    }
+    const { data, mess, timestamp, sign } = responseData ?? {}
+    if (data && mess && timestamp && sign) {
+      return notifyDecoderResult(data, mess, timestamp, sign)
+    }
+    return { result: false, plaintext: "" }
+  }
+}
+
+export default YZHClient

package/src/common/exception/yzhSDKHttpException.ts

@@ -0,0 +1,32 @@
+export default class YZHSDKHttpException extends Error {
+  // 请求 ID
+  request_id: string
+  // HTTP 状态码
+  httpCode?: number
+  // 接口返回状态码
+  code?: string
+
+  constructor(error: string, request_id = "") {
+    super(error)
+    this.request_id = request_id || ""
+  }
+
+  getMessage(): string {
+    return this.message
+  }
+
+  getRequestId(): string {
+    return this.request_id
+  }
+
+  toString(): string {
+    return `[yzh_sdk_exception]  ${
+      this.code && `code:${this.code}`
+    }  requestId:${this.getRequestId()}  message:${this.getMessage()}`
+  }
+  toLocaleString(): string {
+    return `[yzh_sdk_exception]  ${
+      this.code && `code:${this.code}`
+    }  requestId:${this.getRequestId()}  message:${this.getMessage()}`
+  }
+}

package/src/common/http/index.ts

@@ -0,0 +1,57 @@
+import axios from "axios"
+import * as urlencode from "urlencode"
+import * as pkg from "../../../package.json"
+import * as child_process from "child_process"
+const BASE_URL = "https://api-service.yunzhanghu.com/"
+
+const getInstance = (
+  config: { request_id?: string; dealer_id?: string; base_url?: string } = {}
+) => {
+  const instance = axios.create({
+    baseURL: config.base_url || BASE_URL,
+    headers: {
+      "request-id": config?.request_id,
+      "dealer-id": config?.dealer_id,
+      "Content-Type": "application/x-www-form-urlencoded;charset=UTF-8",
+      "User-Agent": `yunzhanghu-sdk-nodejs/${pkg.version}/${child_process
+        .execSync("uname -m -r -s")
+        .toString("utf-8")
+        .replace("\n", "")}/${process.version}`,
+    },
+    timeout: 30 * 1000,
+  })
+
+  // 拦截器
+  instance.interceptors.request.use(function (config) {
+    // URL Encode
+    if (config.method === "get") {
+      const { params: urlData } = config
+      const { data, sign, ...resData } = urlData
+      config.data = {
+        data: urlencode(data),
+        sign: urlencode(sign),
+        ...resData,
+      }
+    }
+    return config
+  })
+
+  instance.interceptors.response.use(function (response) {
+    const { data } = response
+    if (data) {
+      const { request_id, requestID, ...resResponse } = data
+      if (request_id || requestID) {
+        response.data = {
+          ...resResponse,
+          request_id: request_id || requestID,
+        }
+      }
+    }
+
+    return response
+  })
+
+  return instance
+}
+
+export default getInstance

package/src/common/utils/index.ts

@@ -0,0 +1,18 @@
+import YZHclient from "../client"
+
+export class Util extends YZHclient {
+  constructor(conf: {
+    dealer_id: string
+    broker_id: string
+    app_key: string
+    des3_key: string
+    private_key: string
+    yzh_public_key: string
+    sign_type: "rsa" | "sha256"
+    base_url?: string
+  }) {
+    super(conf)
+  }
+}
+
+export default Util

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./services"

package/src/services/apiusersign/index.ts

@@ -0,0 +1,125 @@
+import YZHclient from "../../common/client";
+
+/** ApiUseSignContractRequest 获取协议预览 URL 请求 */
+interface ApiUseSignContractRequest {
+  /** 平台企业 ID */
+  dealer_id: string
+  /** 综合服务主体 ID */
+  broker_id: string
+}
+
+/** ApiUseSignContractResponse 获取协议预览 URL 返回 */
+interface ApiUseSignContractResponse {
+  /** 预览跳转 URL */
+  url: string
+  /** 协议名称 */
+  title: string
+}
+
+/** ApiUserSignRequest 用户签约请求 */
+interface ApiUserSignRequest {
+  /** 综合服务主体 ID */
+  broker_id: string
+  /** 平台企业 ID */
+  dealer_id: string
+  /** 姓名 */
+  real_name: string
+  /** 证件号码 */
+  id_card: string
+  /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
+  card_type: string
+}
+
+/** ApiUserSignResponse 用户签约返回 */
+interface ApiUserSignResponse {
+  /** 是否签约成功 */
+  status: string
+}
+
+/** GetApiUserSignStatusRequest 获取用户签约状态请求 */
+interface GetApiUserSignStatusRequest {
+  /** 平台企业 ID */
+  dealer_id: string
+  /** 综合服务主体 ID */
+  broker_id: string
+  /** 姓名 */
+  real_name: string
+  /** 证件号码 */
+  id_card: string
+}
+
+/** GetApiUserSignStatusResponse 获取用户签约状态返回 */
+interface GetApiUserSignStatusResponse {
+  /** 签约时间 */
+  signed_at: string
+  /** 用户签约状态 */
+  status: string
+}
+
+/** ApiUserSignReleaseRequest 用户解约（测试账号专用接口）请求 */
+interface ApiUserSignReleaseRequest {
+  /** 综合服务主体 ID */
+  broker_id: string
+  /** 平台企业 ID */
+  dealer_id: string
+  /** 姓名 */
+  real_name: string
+  /** 证件号码 */
+  id_card: string
+  /** 证件类型 idcard：身份证 passport：护照 mtphkm：港澳居民来往内地通行证  mtpt：台湾居民往来大陆通行证 rphkm：中华人民共和国港澳居民居住证 rpt：中华人民共和国台湾居民居住证 fpr：外国人永久居留身份证 ffwp：中华人民共和国外国人就业许可证书 */
+  card_type: string
+}
+
+/** ApiUserSignReleaseResponse 用户解约（测试账号专用接口）返回 */
+interface ApiUserSignReleaseResponse {
+  /** 是否解约成功 */
+  status: string
+}
+
+export class Apiusersign extends YZHclient {
+  constructor(conf: {
+    dealer_id: string
+    broker_id: string
+    app_key: string
+    des3_key: string
+    private_key: string
+    yzh_public_key: string
+    sign_type: "rsa" | "sha256"
+    base_url?: string
+  }) {
+    super(conf)
+  }
+   
+  // ApiUseSignContract 获取协议预览 URL
+  async ApiUseSignContract(
+    req: ApiUseSignContractRequest,
+    cb?: (error: null | string, rep: ApiUseSignContractResponse) => void
+  ): Promise<ApiUseSignContractResponse> {
+    return this.request("get", "/api/sign/v1/user/contract", req, { encryption: false }, cb)
+  }
+
+  // ApiUserSign 用户签约
+  async ApiUserSign(
+    req: ApiUserSignRequest,
+    cb?: (error: null | string, rep: ApiUserSignResponse) => void
+  ): Promise<ApiUserSignResponse> {
+    return this.request("post", "/api/sign/v1/user/sign", req, { encryption: false }, cb)
+  }
+
+  // GetApiUserSignStatus 获取用户签约状态
+  async GetApiUserSignStatus(
+    req: GetApiUserSignStatusRequest,
+    cb?: (error: null | string, rep: GetApiUserSignStatusResponse) => void
+  ): Promise<GetApiUserSignStatusResponse> {
+    return this.request("get", "/api/sign/v1/user/status", req, { encryption: false }, cb)
+  }
+
+  // ApiUserSignRelease 用户解约（测试账号专用接口）
+  async ApiUserSignRelease(
+    req: ApiUserSignReleaseRequest,
+    cb?: (error: null | string, rep: ApiUserSignReleaseResponse) => void
+  ): Promise<ApiUserSignReleaseResponse> {
+    return this.request("post", "/api/sign/v1/user/release", req, { encryption: false }, cb)
+  }
+
+}