HTTPS

稳定度: 2 - 稳定

HTTPS是建立在TLS/SSL之上的HTTP协议。在node.js中，它被作为单独模块实现。

Class: https.Server

这个类是tls.Server的子类，并且和http.Server触发相同的事件。更多信息请参阅http.Server。

server.setTimeout(msecs, callback)

参阅http.Server#setTimeout()。

server.timeout

参阅http.Server#timeout。

https.createServer(options[, requestListener])

返回一个新的HTTPS web服务器对象。options与tls.createServer()中的类似。requestListener会被自动添加为request事件的监听器。

例子：

// curl -k https://localhost:8000/
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);

或

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

var options = {
  pfx: fs.readFileSync('server.pfx')
};

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

server.listen(port[, host][, backlog][, callback])

server.listen(path[, callback])

server.listen(handle[, callback])

详情参阅http.listen()。

server.close([callback])

详情参阅http.close()。

https.request(options, callback)

向一个安全web服务器发送请求。

options可以是一个对象或一个字符串。如果options是一个字符串，它会自动被url.parse()解析。

所有的http.request()选项都是可用的。

例子：

var https = require('https');

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET'
};

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

  res.on('data', function(d) {
    process.stdout.write(d);
  });
});
req.end();

req.on('error', function(e) {
  console.error(e);
});

options参数有以下选项：

• host: 一个将要向其发送请求的服务器域名或IP地址。默认为localhost。
• hostname: host的别名。为了支持url.parse()的话，hostname比host更好些。
• family: 解析host和hostname时的IP地址协议族。合法值是4和6。当没有指定时，将都被使用。
• port: 远程服务器端口。默认为80。
• localAddress: 用于绑定网络连接的本地端口。
• socketPath: Unix域socket（使用host:port或socketPath）。
• method: 指定HTTP请求方法的字符串。默认为GET。
• path: 请求路径。默认为/。如果有查询字符串，则需要包含。例如'/index.html?page=12'。请求路径包含非法字符时抛出异常。目前，只否决空格，不过在未来可能改变。
• headers: 一个包含请求头的对象。
• auth: 用于计算认证头的基本认证，即'user:password'。
• agent: 控制agent行为。当使用一个代理时，请求将默认为Connection: keep-alive。可能值有：
  • undefined (默认): 在这个主机和端口上使用全局`agent。
  • Agent object: 在agent中显示使用passed。
  • false: 跳出agent的连接池。默认请求为Connection: close。

以下来自tls.connect()的选项也可以被指定。但是，一个globalAgent会默默忽略这些。

• pfx: 证书，SSL所用的私钥和CA证书。默认为null。
• key: SSL所用的私钥。默认为null。
• passphrase: 私钥或pfx的口令字符串。默认为null。
• cert: 所用的公共x509证书。默认为null。
• ca: 一个用来检查远程主机的权威证书或权威证书数组。
• ciphers: 一个描述要使用或排除的密码的字符串。更多格式信息请查询http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT。
• rejectUnauthorized: 如果设置为true，服务器证书会使用所给的CA列表验证。验证失败时，一个error事件会被触发。验证发生于连接层，在HTTP请求发送之前。默认为true。
• secureProtocol: 所用的SSL方法，如SSLv3_method强制使用SSL v3。可用的值取决你的OpenSSL安装和SSL_METHODS常量。

要指定这些选项，使用一个自定义的Agent。

例子：

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};
options.agent = new https.Agent(options);

var req = https.request(options, function(res) {
  ...
}

或不使用Agent。

例子：

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
  agent: false
};

var req = https.request(options, function(res) {
  ...
}

https.get(options, callback)

类似于http.get()，但是使用HTTPS。

options可以是一个对象或一个字符串。如果options是一个字符串，它会自动被url.parse()解析。

例子：

var https = require('https');

https.get('https://encrypted.google.com/', function(res) {
  console.log("statusCode: ", res.statusCode);
  console.log("headers: ", res.headers);

  res.on('data', function(d) {
    process.stdout.write(d);
  });

}).on('error', function(e) {
  console.error(e);
});

Class: https.Agent

一个与http.Agent类似的HTTPS Agent对象。更多信息请参阅https.request()。

https.globalAgent

所有HTTPS客户端请求的全局https.Agent实例。