如何在 Node.js 中创建 HTTPS 服务器？

Question

给定 SSL 密钥和证书，如何创建 HTTPS 服务？

Answer 1

Express API 文档非常清楚地说明了这一点。

此外，此答案提供了创建自签名证书的步骤。

我在Node.js HTTPS 文档中添加了一些评论和片段：

var express = require('express');
var https = require('https');
var http = require('http');
var fs = require('fs');

// This line is from the Node.js HTTPS documentation.
var options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.cert')
};

// Create a service (the app object is just a callback).
var app = express();

// Create an HTTP service.
http.createServer(app).listen(80);
// Create an HTTPS service identical to the HTTP service.
https.createServer(options, app).listen(443);

Answer 2

对于 Node 0.3.4 及以上一直到当前 LTS（在此编辑时为 v16）， https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener包含您需要的所有示例代码：

const https = require(`https`);
const fs = require(`fs`);

const options = {
  key: fs.readFileSync(`test/fixtures/keys/agent2-key.pem`),
  cert: fs.readFileSync(`test/fixtures/keys/agent2-cert.pem`)
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end(`hello world\n`);
}).listen(8000);

请注意，如果要使用certbot工具使用 Let's Encrypt 的证书，则私钥称为privkey.pem ，证书称为fullchain.pem ：

const certDir = `/etc/letsencrypt/live`;
const domain = `YourDomainName`;
const options = {
  key: fs.readFileSync(`${certDir}/${domain}/privkey.pem`),
  cert: fs.readFileSync(`${certDir}/${domain}/fullchain.pem`)
};

Answer 3

在谷歌搜索“node https”时发现了这个问题，但接受的答案中的例子很旧 - 取自当前（v0.10）版本节点的文档，它应该是这样的：

var https = require('https');
var fs = require('fs');

var options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};

https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}).listen(8000);

Answer 4

上面的答案很好，但是使用 Express 和 node 这将正常工作。

由于 express 为您创建了应用程序，因此我将在此处跳过。

var express = require('express')
  , fs = require('fs')
  , routes = require('./routes');

var privateKey = fs.readFileSync('cert/key.pem').toString();
var certificate = fs.readFileSync('cert/certificate.pem').toString();  

// To enable HTTPS
var app = module.exports = express.createServer({key: privateKey, cert: certificate});

Answer 5

Node.js 中 HTTPS 服务器的最小设置是这样的：

var https = require('https');
var fs = require('fs');

var httpsOptions = {
    key: fs.readFileSync('path/to/server-key.pem'),
    cert: fs.readFileSync('path/to/server-crt.pem')
};

var app = function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}

https.createServer(httpsOptions, app).listen(4433);

如果您还想支持 http 请求，则只需进行以下小修改：

var http = require('http');
var https = require('https');
var fs = require('fs');

var httpsOptions = {
    key: fs.readFileSync('path/to/server-key.pem'),
    cert: fs.readFileSync('path/to/server-crt.pem')
};

var app = function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}

http.createServer(app).listen(8888);
https.createServer(httpsOptions, app).listen(4433);

Answer 6

更新

通过Greenlock.js使用 Let's Encrypt

原帖

我注意到这些答案都没有表明将中间根 CA添加到链中，这里有一些零配置示例可以查看：

• https://github.com/solderjs/nodejs-ssl-example
• http://coolaj86.com/articles/how-to-create-a-csr-for-https-tls-ssl-rsa-pems/
• https://github.com/solderjs/nodejs-self-signed-certificate-example

片段：

var options = {
  // this is the private key only
  key: fs.readFileSync(path.join('certs', 'my-server.key.pem'))

// this must be the fullchain (cert + intermediates)
, cert: fs.readFileSync(path.join('certs', 'my-server.crt.pem'))

// this stuff is generally only for peer certificates
//, ca: [ fs.readFileSync(path.join('certs', 'my-root-ca.crt.pem'))]
//, requestCert: false
};

var server = https.createServer(options);
var app = require('./my-express-or-connect-app').create(server);
server.on('request', app);
server.listen(443, function () {
  console.log("Listening on " + server.address().address + ":" + server.address().port);
});

var insecureServer = http.createServer();
server.listen(80, function () {
  console.log("Listening on " + server.address().address + ":" + server.address().port);
});

如果您不尝试直接通过 connect 或 express 执行此操作，那么这是通常更容易的事情之一，而是让本机https模块处理它，然后使用它来为您连接/express 应用程序提供服务。

此外，如果您在创建服务器时使用server.on('request', app)而不是传递应用程序，它使您有机会将server实例传递给一些创建连接/快速应用程序的初始化函数（如果需要）例如，在同一台服务器上通过 ssl 执行websockets ）。

Answer 7

要让您的应用分别在端口80和443上侦听http和https ，请执行以下操作

创建一个快递应用：

var express = require('express');
var app = express();

express()返回的应用程序是一个 JavaScript 函数。 它可以作为回调传递给 Node 的 HTTP 服务器来处理请求。 这使得使用相同的代码库轻松提供应用程序的 HTTP 和 HTTPS 版本。

你可以这样做：

var express = require('express');
var https = require('https');
var http = require('http');
var fs = require('fs');
var app = express();

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

http.createServer(app).listen(80);
https.createServer(options, app).listen(443);

有关完整的详细信息，请参阅文档

Answer 8

你也可以使用 Fastify 框架来存档：

const { readFileSync } = require('fs')
const Fastify = require('fastify')

const fastify = Fastify({
  https: {
    key: readFileSync('./test/asset/server.key'),
    cert: readFileSync('./test/asset/server.cert')
  },
  logger: { level: 'debug' }
})

fastify.listen(8080)

（如果需要编写测试，请运行openssl req -nodes -new -x509 -keyout server.key -out server.cert来创建文件）

Answer 9

如果您只需要在本地进行本地开发，我已经为此任务创建了实用程序 - https://github.com/pie6k/easy-https

import { createHttpsDevServer } from 'easy-https';

async function start() {
  const server = await createHttpsDevServer(
    async (req, res) => {
      res.statusCode = 200;
      res.write('ok');
      res.end();
    },
    {
      domain: 'my-app.dev',
      port: 3000,
      subdomains: ['test'], // will add support for test.my-app.dev
      openBrowser: true,
    },
  );
}

start();

它：

• 将自动将适当的域条目添加到 /etc/hosts
• 仅在首次运行/域更改时需要时才询问您的管理员密码
• 将为给定域准备 https 证书
• 将信任您本地机器上的这些证书
• 将在开始时打开浏览器指向您的本地服务器 https url

Answer 10

1. 从这里下载用于 openssl 设置的 rar 文件： https : //indy.fulgan.com/SSL/openssl-0.9.8r-i386-win32-rev2.zip
2. 只需将您的文件夹复制到c盘。
3. 创建 openssl.cnf 文件并从以下位置下载它们的内容： http: //web.mit.edu/crypto/openssl.cnf openssl.cnf 可以放在任何地方，但当我们在命令提示符下给出时，路径应该是正确的。
4. 打开命令提示并设置 openssl.cnf 路径 C:\\set OPENSSL_CONF=d:/openssl.cnf 5.在 cmd 中运行：C:\\openssl-0.9.8r-i386-win32-rev2>openssl.exe
5. 然后运行 ​​OpenSSL> genrsa -des3 -out server.enc.key 1024
6. 然后它会要求输入密码：输入 4 到 11 个字符作为您的证书密码
7. 然后运行这个 Openssl>req -new -key server.enc.key -out server.csr
8. 然后它会询问一些详细信息，例如国家代码州名等，随意填写。 10 . 然后运行 ​​Openssl > rsa -in server.enc.key -out server.key
9. 运行此 OpenSSL> x509 -req -days 365 -in server.csr -signkey server.key -out server.crt 然后使用之前堆栈溢出的代码谢谢

Answer 11

var path = require('path');
var express = require('express');

var app = express();

var staticPath = path.join(__dirname, '/public');
app.use(express.static(staticPath));

app.listen(8070, function() {
  console.log('Server started at port 8070');
});