node-http-signature 技术文档

1. 安装指南

首先，您需要确保您的系统中已经安装了Node.js。然后，通过以下命令安装node-http-signature库：

npm install http-signature

确保在执行安装命令之前，您已经具有相应的权限。

2. 项目的使用说明

node-http-signature是一个Node.js库，包括客户端和服务器端组件，用于Joyent的HTTP签名方案。以下是如何使用这个库的说明：

客户端使用

客户端主要用于对HTTP请求进行签名。以下是一个简单示例：

var fs = require('fs');
var https = require('https');
var httpSignature = require('http-signature');

var key = fs.readFileSync('./key.pem', 'ascii');

var options = {
  host: 'localhost',
  port: 8443,
  path: '/',
  method: 'GET',
  headers: {}
};

var req = https.request(options, function(res) {
  console.log(res.statusCode);
});

httpSignature.sign(req, {
  key: key,
  keyId: './cert.pem',
  keyPassphrase: 'secret' // (可选)
});

req.end();

服务器端使用

服务器端主要验证接收到的HTTP请求的签名。以下是一个示例：

var fs = require('fs');
var https = require('https');
var httpSignature = require('http-signature');

var options = {
  key: fs.readFileSync('./key.pem'),
  cert: fs.readFileSync('./cert.pem')
};

https.createServer(options, function (req, res) {
  var rc = 200;
  var parsed = httpSignature.parseRequest(req);
  var pub = fs.readFileSync(parsed.keyId, 'ascii');
  if (!httpSignature.verifySignature(parsed, pub))
    rc = 401;

  res.writeHead(rc);
  res.end();
}).listen(8443);

请确保在运行示例代码之前，您已经有相应的私钥和证书文件。

3. 项目API使用文档

node-http-signature提供了以下API：

• httpSignature.sign(request, options): 对HTTP请求进行签名。

  • request: 待签名的HTTP请求。
  • options: 签名选项，包括key（私钥），keyId（证书路径），和keyPassphrase（私钥密码，可选）。

• httpSignature.parseRequest(request): 解析HTTP请求以获取签名信息。

  • request: 待解析的HTTP请求。

• httpSignature.verifySignature(parsed, publicKey): 验证签名的有效性。

  • parsed: 通过httpSignature.parseRequest得到的解析结果。
  • publicKey: 公钥文件路径。

4. 项目安装方式

项目的安装方式已在“安装指南”部分进行了说明。简要概括，就是通过npm install http-signature命令来安装。请确保您有Node.js环境以及相应的权限来执行该命令。