Node.js HTTPS

穩(wěn)定性: 3 - 穩(wěn)定

HTTPS是什么？HTTPS是基于TLS/SSL的HTTP協(xié)議，在Node.js里它可以作為單獨(dú)的模塊來(lái)實(shí)現(xiàn)。在本文中，你將了解HTTPS的使用方法。

類: https.Server

https.Server是tls.Server的子類，并且和http.Server一樣觸發(fā)事件。更多信息參見(jiàn)http.Server。

server.setTimeout(msecs, callback)

詳情參見(jiàn)http.Server#setTimeout().

server.timeout

詳情參見(jiàn)http.Server#timeout.

https.createServer(options[, requestListener])

返回一個(gè)新的HTTPS服務(wù)器對(duì)象。其中options類似于 [tls.createServer()][tls.md#tls_tls_createserver_options_secureconnectionlistener]。 requestListener函數(shù)自動(dòng)加到'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])

詳情參見(jiàn)http.listen()。

server.close([callback])

詳情參見(jiàn)http.close()。

https.request(options, callback)

可以給安全web服務(wù)器發(fā)送請(qǐng)求。

options可以是一個(gè)對(duì)象或字符串。如果options是字符串，則會(huì)被url.parse()解析。

所有來(lái)自http.request()選項(xiàng)都是經(jīng)過(guò)驗(yàn)證的。

例如:

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);
});

option參數(shù)具有以下的值：

• host: 請(qǐng)求的服務(wù)器域名或IP地址，默認(rèn)：'localhost'
• hostname: 用于支持url.parse()。hostname優(yōu)于host
• port: 遠(yuǎn)程服務(wù)器端口。默認(rèn)： 443。
• method: 指定HTTP請(qǐng)求方法。默認(rèn)：'GET'。
• path: 請(qǐng)求路徑。默認(rèn)：'/'。如果有查詢字符串，則需要包含。比如'/index.html?page=12'
• headers: 包含請(qǐng)求頭的對(duì)象
• auth: 用于計(jì)算認(rèn)證頭的基本認(rèn)證，即user:password
• agent: 控制Agent的行為。當(dāng)使用了一個(gè)Agent的時(shí)候，請(qǐng)求將默認(rèn)為Connection: keep-alive?？赡艿闹禐椋?ul>
• undefined (default): 在這個(gè)主機(jī)和端口上使用[global Agent][]
• Agent object: 在Agent中顯式使用passed.
• false: 選擇性停用連接池,默認(rèn)請(qǐng)求為：Connection: close

tls.connect()的參數(shù)也能指定。但是，globalAgent會(huì)忽略他們。

• pfx: SSL使用的證書(shū)，私鑰，和證書(shū)Certificate，默認(rèn)為null.
• key: SSL使用的私鑰. 默認(rèn)為null.
• passphrase: 私鑰或pfx的口令字符串. 默認(rèn)為null.
• cert: 所用公有x509證書(shū). 默認(rèn)為null.
• ca: 用于檢查遠(yuǎn)程主機(jī)的證書(shū)頒發(fā)機(jī)構(gòu)或包含一系列證書(shū)頒發(fā)機(jī)構(gòu)的數(shù)組。
• ciphers: 描述要使用或排除的密碼的字符串，格式請(qǐng)參閱http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT
• rejectUnauthorized: 如為true則服務(wù)器證書(shū)會(huì)使用所給CA列表驗(yàn)證。如果驗(yàn)證失敗則會(huì)觸發(fā)error事件。驗(yàn)證過(guò)程發(fā)生于連接層，在HTTP請(qǐng)求發(fā)送之前。默認(rèn)為true.
• secureProtocol: 所用的SSL方法，比如TLSv1_method強(qiáng)制使用TLS version 1?？扇≈等Q于您安裝的OpenSSL，和定義于SSL_METHODS的常量。

要指定這些選項(xiàng)，使用一個(gè)自定義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()類似，不過(guò)是HTTPS版本的.

options可以是字符串對(duì)象. 如果options是字符串, 會(huì)自動(dòng)使用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);
});

類: https.Agent

HTTPS的Agent對(duì)象，和http.Agent類似。詳情參見(jiàn)https.request()。

https.globalAgent

所有HTTPS客戶端請(qǐng)求的https.Agent全局實(shí)例。