@haraka/ocsp

中文文档
1.2.0发布于 2026/07/22MITTypeScriptCommonJS近 30 天下载 14.1万

OCSP 客户端和用于节点的服务器 API.js

中文使用文档
文档目录10 节
  1. 安装
  2. 部件
  3. 探员
  4. 缓存
  5. 服务器
  6. 检查()
  7. .核实()
  8. 请求.generate ()
  9. 获取OCSPURI ()
  10. 归属

OCSP 节点API.js

各种 业务支助处- 相关API,用于节点.j.

此软件包是维护的叉 废物/垃圾,其中包含 gitHub分叉网络的校正和改进。 见[变相.md] 为完整的历史.

安装

$ npm install @haraka/ocsp

部件

  1. 探员
  2. 缓存
  3. 服务器
  4. check()编号 :verify()
  5. request.generate()
  6. getOCSPURI()

探员

用法 :

const agent = new ocsp.Agent()

https.request({
  method: ...,
  host: ...,
  port: ...,
  path: ...,
  // Other options

  agent
}, (res) => {
  // ...
})

以下代码片段将向指定的服务器执行请求,并且 使用 OCSP 验证服务器的证书( 要么进行分层, 要么从 (美国) 如果证书未发布 OCSP URL 的广告,则连接为 允许继续.

注:您可通过 options 对象 new ocsp.Agent(options)它可能 具有下列属性:

  • CACacheSize: 保存在缓存中的 CA 证书数量 。 (过失:1024)

缓存

用法 :

const cache = new ocsp.Cache()

const server = https.createServer({
  cert: cert,
  key: key
}, (req, res) => {
  res.end('hello world')
})

server.on('OCSPRequest', (cert, issuer, cb) => {
  ocsp.getOCSPURI(cert, (err, uri) => {
    if (err) return cb(err)
    if (uri === null) return cb()

    const req = ocsp.request.generate(cert, issuer)
    cache.probe(req.id, (err, cached) => {
      if (err) return cb(err)
      if (cached !== false) return cb(null, cached.response)

      cache.request(req.id, { url: uri, ocsp: req.data }, cb)
    })
  })
})

应使用缓存提供 OCSP 安装 对客户的答复.

注:构造器接受一种 options 具有下列属性的对象:

  • probe: 覆盖 .probe() 方法
  • store: 覆盖 .store() 方法
  • filter数字 : filter(url, callback) 要请求的白名单 CA URL

有下列方法:

  • .probe(id, callback) ——检查响应是否被缓存
  • .request(id, options, callback) 获取并缓存新的OCSP响应
  • .store(id, response, maxTime, callback) ——手动存储响应
  • .clear() ——清除所有缓存回复并取消所有待决定时器

服务器

用法 :

const server = ocsp.Server.create({
  caCert: cacert, // optional, defaults to `cert` if not supplied
  cert: cert,
  key: key
})

server.addCert(43, 'good')
server.addCert(44, 'revoked', {
  revocationTime: new Date(),
  revocationReason: 'CACompromise'
})

server.listen(8000)

OCSP 服务器,即为 OCSP 提供 OCSP 响应的 HTTP 服务器 请求.

有下列方法:

  • .addCert(serialNumber, status, info),其中:
    • serialNumber 可以是普通数字,也可以是 bn.js
    • status 这是其中之一 good, (中文(简体) ), revoked
    • info 应该是空的 good 对象 revoked (见上文实例); revocationReason 这是: unspecified, (中文(简体) ), keyCompromise, (中文(简体) ), CACompromise, (中文(简体) ), affiliationChanged, (中文(简体) ), superseded, (中文(简体) ), cessationOfOperation, (中文(简体) ), certificateHold, (中文(简体) ), removeFromCRL, (中文(简体) ), privelegeWithdrawn, (中文(简体) ), AACompromise(中文(简体) )
  • 全体人员 http.Server 办法!

构造器选项 :

  • cert: 服务器证书( PEM 或缓冲)
  • key: 服务器的私钥( PEM 或缓冲)
  • caCert: 签发的 CA 证书( PEM 或缓冲); 默认为 cert
  • nextUpdate: 毫秒到 nextUpdate 响应中的字段(默认值 : 86400000 24小时)

检查()

用法 :

ocsp.check({
  cert: cert,
  issuer: issuerCert
}, (err, res) => {
  if (err) throw err
  console.log(res)
})

向 CA 发送 OCSP 请求并询问证书是否仍然有效 . res 包含信息.

选项 :

  • cert:要检查的证书( PEM、 DER 缓冲或解析)
  • issuer: 签发的 CA 证书( PEM、 DER 缓冲或解析)
  • requestByGet: 如果 true,则通过 HTTP GET 发送OCSP 请求,而不是 POST( 默认 : false(中文(简体) )

.核实()

用法 :

ocsp.verify({
  request: request,
  // Optional, `issuer: issuerCert,`
  response: response
}, (err, res) => {
})

校对 response 与 request 并由CA签名.

选项 :

  • request: OCSP请求对象(来自 request.generate()(中文(简体) )
  • response: 原始OCSP响应缓冲
  • issuer: 签发 CA 证书, 如果尚未在 request.issuer
  • nudge: 时钟可容忍度以毫秒表示 thisUpdate编号 :nextUpdate 检查( 默认 : 60000(中文(简体) )

请求.generate ()

用法 :

const req = ocsp.request.generate(cert, issuerCert)

生成 OCSP 请求 .verify() 或者用于手动发送到OCSP服务器.

获取OCSPURI ()

用法 :

ocsp.getOCSPURI(cert, (err, uri) => {
})

从证书中获取 OCSP 服务器的 URI .

归属

最初作者: 费多尔 作为 废物/垃圾。 。 。 . 继续 技术小组, (中文(简体) ), 拉尼耶里·马齐利,以及 马特·西默森,包含来自GitHub分叉网络的修饰.

自由主义

这个软件根据麻省理工学院的许可证获得许可.

版权所有 Fedor Indutny, 2015.

特此免费准许任何人获得 本软件和相关文档文件的复制件 “软件”,在软件中不受限制地处理,包括 不限制使用、复制、修改、合并、出版、, 软件的分发、分版和/或销售,并允许 提供软件的人 下列条件:

上述版权通知和本许可通知应当包括: 软件的所有副本或大部分.

软件被提供"AS IS", 没有任何恐惧, EXPRESS ,包括但不局限于 紧迫性,特别是目的和非目的的证明。 内 对于任何索赔, 都不得使用任何连锁电话或警察电话, 转让或其他责任,以契约、条约或 产生于、出自或与溶剂有关的 在软件中使用或其他交易.

版本与发布记录

@haraka/ocsp 共发布 2 个版本,首次发布于 2026/04/08;过去 12 个月发布了 2 个版本。

版本发布日期距今
1.2.0latest2026/07/223 个月前
1.1.02026/04/087 个月前

关于 @haraka/ocsp 的常见问题

@haraka/ocsp 是什么?

OCSP 客户端和用于节点的服务器 API.js

如何安装 @haraka/ocsp?

在项目目录运行 npm install @haraka/ocsp,或使用 pnpm add / yarn add / bun add。

@haraka/ocsp 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haraka/ocsp 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@haraka/ocsp 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haraka/ocsp 可以商用吗?

@haraka/ocsp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@haraka/ocsp 的下载量有多少?

根据 npm 官方下载统计,@haraka/ocsp 在 2026/10/17 – 2026/11/15 这 30 天内被下载 141,388 次,日均约 4,713 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haraka/ocsp 还在维护吗?

最新版本 1.2.0 发布于 2026/07/22(3 个月前);至今共发布 2 个版本,其中过去 12 个月发布了 2 个;首次发布于 2026/04/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。