mirror of
https://github.com/nodejs/node.git
synced 2024-12-01 16:10:02 +01:00
99 lines
2.3 KiB
Markdown
99 lines
2.3 KiB
Markdown
## HTTPS
|
|
|
|
HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
|
|
separate module.
|
|
|
|
## https.Server
|
|
|
|
This class is a subclass of `tls.Server` and emits events same as
|
|
`http.Server`. See `http.Server` for more information.
|
|
|
|
## https.createServer(options, [requestListener])
|
|
|
|
Returns a new HTTPS web server object. The `options` is similer to
|
|
`tls.createServer()`. The `requestListener` is a function which is
|
|
automatically added to the `'request'` event.
|
|
|
|
Example:
|
|
|
|
// 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);
|
|
|
|
|
|
## https.request(options, callback)
|
|
|
|
Makes a request to a secure web server.
|
|
Similar options to `http.request()`.
|
|
|
|
Example:
|
|
|
|
var https = require('https');
|
|
|
|
var options = {
|
|
host: '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);
|
|
});
|
|
|
|
The options argument has the following options
|
|
|
|
- host: IP or domain of host to make request to. Defaults to `'localhost'`.
|
|
- port: port of host to request to. Defaults to 443.
|
|
- path: Path to request. Default `'/'`.
|
|
- method: HTTP request method. Default `'GET'`.
|
|
- key: Private key to use for SSL. Default `null`.
|
|
- cert: Public x509 certificate to use. Default `null`.
|
|
- ca: An authority certificate or array of authority certificates to check
|
|
the remote host against.
|
|
|
|
|
|
## https.get(options, callback)
|
|
|
|
Like `http.get()` but for HTTPS.
|
|
|
|
Example:
|
|
|
|
var https = require('https');
|
|
|
|
https.get({ host: 'encrypted.google.com', path: '/' }, 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);
|
|
});
|
|
|
|
|
|
|
|
|