方法和属性
- https.globalAgent
- https.createServer(options[, requestListener])
- https.request(options, callback)
- https.get(options, callback)
https.globalAgent
https.Agent 的全局实例，应用于所有的 HTTPS 客户端请求。
https.createServer(options[, requestListener])
返回一个新的 HTTPS Web 服务器对象。options 类似于 tls.createServer()。requestListener 是一个自动添加到 'request' 事件上的函数。
示例：
// curl -k https://localhost:8000/
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);
或
const https = require('https');
const fs = require('fs');
const options = {
pfx: fs.readFileSync('server.pfx')
};
https.createServer(options, (req, res) => {
res.writeHead(200);
res.end('hello world\n');
}).listen(8000);
server.listen(handle[, callback])
server.listen(path[, callback])
server.listen(port[, host][, backlog][, callback])
详见 http.listen()。
server.close([callback])
详见 http.close()。
https.request(options, callback)
建立一个安全的 Web 服务器的请求。
options 可以是一个对象或字符串。如果 options 是一个字符串，它会自动使用 url.parse() 解析。
所有的 http.request() 选项都是有效的。
示例：
const https = require('https');
var options = {
hostname: 'encrypted.google.com',
port: 443,
path: '/',
method: 'GET'
};
var req = https.request(options, (res) => {
console.log('statusCode: ', res.statusCode);
console.log('headers: ', res.headers);
res.on('data', (d) => {
process.stdout.write(d);
});
});
req.end();
req.on('error', (e) => {
console.error(e);
});
选项参数有以下选项：
host：发出请求的服务器域名或 IP 地址。默认为'localhost'。hostname：host的别名。以支持 url.parse() 解析hostname会优于host。family：在解析hostname和host时所使用的 IP 地址族。有效值是4或6。当它是unspecified时，将同时使用 IPv4 和 IPv6。port：远程服务器的端口。默认为443。localAddress：绑定到网络连接的本地接口。socketPath：Unix Domain Socket（使用 host:port 和 socketPath 的其中之一）method：一个指定 HTTP 请求方法的字符串。默认为'GET'。path：请求路径。默认为'/'。应包括查询字符串（如有的话）。如'/index.html?page=12'。当请求的路径中包含非法字符时，会引发异常。目前，只有空字符会被拒绝，但在将来可能会发生变化。headers：一个包含请求头的对象。auth：基本身份验证，如，'user:password'来计算 Authorization 头。agent：控制代理行为。如果使用代理请求，默认为Connection: keep-alive。可能的值：undefined（默认）：对主机和端口使用 http.globalAgent。Agent对象：明确地使用代理。false：选择跳出连接池的代理，默认请求Connection: close。
来自 tls.connect() 的以下选项也可以指定。然而，这里静默忽略 globalAgent。
pfx：证书，用于 SSL 的私钥和 CA 证书。默认为null。key：用于 SSL 的私钥。默认为null。passphrase：用于私钥或 pfx 的密码字符串。默认为null。cert：使用的公共 x509 证书。默认为null。ca：一个字符串、Buffer 或字符串数组或受信任证书的 PEM 格式的 Buffers。如果省略，则使用几个著名的“根”的 CA，例如 VeriSign。这些用于授权的连接。ciphers：一个描述使用或排除的加密方式的字符串。在格式上仔细考虑 https://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT。rejectUnauthorized：如果true，对服务器证书验证是否存在于提供的 CA 列表中。如果验证失败会发出一个'error'事件。验证发生在连接层，在发送 HTTP 请求之前。默认为true。secureProtocol：使用的 SSL 方法。如，SSLv3_method强制 SSL 版本 3。可能的值取决于你安装的 OpenSSL 并定义不变的 SSL_METHODS。servername：用于 SNI（服务器名称指示）TLS 扩展的服务器名。
为了指定这些选项，使用自定义代理。
示例：
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, (res) => {
...
}
另外，可以通过不使用代理来退出连接池。
示例：
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, (res) => {
...
}
https.get(options, callback)
类似 http.get()，但基于 HTTPS。
options 可以是对象或字符串。如果 options 是字符串，它会自动使用 url.parse() 解析。
示例：
const https = require('https');
https.get('https://encrypted.google.com/', (res) => {
console.log('statusCode: ', res.statusCode);
console.log('headers: ', res.headers);
res.on('data', (d) => {
process.stdout.write(d);
});
}).on('error', (e) => {
console.error(e);
});