HTTPS

This class is a subclass of and emits events same as
http.Server. See http.Server for more information.

See http.Server#setTimeout().

server.timeout

See http.Server#timeout.

https.createServer(options[, requestListener])

Returns a new HTTPS web server object. The options is similar 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);

Or

server.listen(path[, callback])

See http.listen() for details.

server.close([callback])

Makes a request to a secure web server.

options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().

All options from are valid.

Example:

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

The options argument has the following options

• host: A domain name or IP address of the server to issue the request to.
  Defaults to 'localhost'.
• hostname: To support url.parse() hostname is preferred over host
• port: Port of remote server. Defaults to 443.
• method: A string specifying the HTTP request method. Defaults to 'GET'.
• headers: An object containing request headers.
• auth: Basic authentication i.e. 'user:password' to compute an
  Authorization header.
• agent: Controls Agent behavior. When an Agent is used request will
  default to Connection: keep-alive. Possible values:
  • undefined (default): use for this host and port.
  • Agent object: explicitly use the passed in Agent.
  • false: opts out of connection pooling with an Agent, defaults request to
    Connection: close.

The following options from tls.connect() can also be specified. However, a
silently ignores these.

• pfx: Certificate, Private key and CA certificates to use for SSL. Default .
• key: Private key to use for SSL. Default null.
• passphrase: A string of passphrase for the private key or pfx. 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.
• ciphers: A string describing the ciphers to use or exclude. Consult
  http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT for
  details on the format.
• rejectUnauthorized: If true, the server certificate is verified against
  the list of supplied CAs. An 'error' event is emitted if verification
  fails. Verification happens at the connection level, before the HTTP
  request is sent. Default true.
• secureProtocol: The SSL method to use, e.g. TLSv1_method to force
  TLS version 1. The possible values depend on your installation of
  OpenSSL and are defined in the constant .

In order to specify these options, use a custom Agent.

Or does not use an Agent.

Example:

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)

Like http.get() but for HTTPS.

options can be an object or a string. If options is a string, it is
automatically parsed with .

Example:

An Agent object for HTTPS similar to http.Agent. See
for more information.

https.globalAgent

Global instance of for all HTTPS client requests.