node/doc/api/https.markdown

91 lines
2.0 KiB
Markdown
Raw Normal View History

2011-01-22 05:12:35 +08:00
## HTTPS
HTTPS is the HTTP protocol over TLS/SSL. In Node this is implemented as a
separate module.
## https.Server
## https.createServer
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);
2011-01-22 05:21:01 +08:00
## https.request(options, callback)
2011-01-22 05:12:35 +08:00
Makes a request to a secure web server.
2011-01-22 05:21:01 +08:00
Similar options to `http.request()`.
2011-01-22 05:12:35 +08:00
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.
2011-01-22 05:21:01 +08:00
## https.get(options, callback)
2011-01-22 05:12:35 +08:00
2011-01-22 05:21:01 +08:00
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);
});
2011-01-22 05:12:35 +08:00