forked from nodejscn/node-api-cn
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhttps_request_options_callback.md
More file actions
115 lines (93 loc) · 4.03 KB
/
https_request_options_callback.md
File metadata and controls
115 lines (93 loc) · 4.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!-- YAML
added: v0.3.6
-->
向一个安全的服务器发起一个请求。
参数 `options` 可以是一个对象或是一个字符串。
如果参数 `options` 是一个字符串, 它自动被 [`url.parse()`] 所解析。
所有来自 [`http.request()`] 的参数都是可用的。
例子:
```js
const https = require('https');
var options = {
hostname: 'encrypted.google.com',
port: 443,
path: '/',
method: 'GET'
};
var req = https.request(options, (res) => {
console.log('状态码：', res.statusCode);
console.log('请求头：', res.headers);
res.on('data', (d) => {
process.stdout.write(d);
});
});
req.on('error', (e) => {
console.error(e);
});
req.end();
```
`options` 参数可以有以下选择：
- `host`: 一个处理请求的服务器的域名或者IP地址，默认是 `loaclhost`。
- `hostname`: `host` 的别名。为了更好地支持 `url.parse()`，`hostname` 比 `host` 更被推荐使用。
- `family`: 用于解析 `host` and `hostname` 的 IP 地址族。
`4` 或者 `6` 都是有效数值。当不被指定时，IPv4 和 IPv6 都将被使用。
- `port`: 远程服务器的端口。默认是 443。
- `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` (默认): 这个主机和端口使用 [`globalAgent`]。
- `Agent` 对象: 显式地在 `Agent` 中用传进来的参数。
- `false`: 不对连接池使用 Agent, 默认是 `Connection: close`。
下面是来自 [`tls.connect()`] 的参数，它也可以被设置为:
- `pfx`: 证书, 用于 SSL 的私钥和 CA 证书。默认是 `null`。
- `key`: 用于 SSL 的私钥。默认是 `null`。
- `passphrase`: 用于私钥或是 pfx 的密码字符串。默认是 `null`。
- `cert`: 公共 x509 证书。默认是 `null`。
- `ca`: 一个字符串、[`Buffer`]、字符串数组、或 PEM 格式的可信赖证书的 [`Buffer`]。
如果这被忽略，那么著名的根证书将被使用，比如说 VeriSign 数字证书。这些被用来授权连接。
- `ciphers`: 一个用来描述要使用或排除的密码的字符串。
查看 <https://www.openssl.org/docs/man1.0.2/apps/ciphers.html#CIPHER-LIST-FORMAT> 获取格式的细节。
- `rejectUnauthorized`: 如果设置为 `true`, 服务器证书根据CA提供的列表来进行验证。
如果验证失败的话，一个 `'error'` 事件将被触发。
验证发生在连接层次, *早于* HTTP请求的发送。默认是 `true`。
- `secureProtocol`: 使用的 SSL 方法，
例如 `SSLv3_method` 来强制使用 SSL 版本 3。
可能的值取决于安装的 OpenSSL 的版本，它被定义在 [`SSL_METHODS`] 常数中。
- `servername`: SNI (Server Name Indication) TLS 扩展的服务器名。
为了确定这些参数, 用一个定制的 [`Agent`]。
例子:
```js
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) => {
...
});
```
也可以不对连接池使用 `Agent`。
例子:
```js
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) => {
...
});
```