Skip to content

IoT.js-API-HTTPS.md

Latest commit

 

History

History
97 lines (72 loc) · 4.53 KB

IoT.js-API-HTTPS.md

File metadata and controls

97 lines (72 loc) · 4.53 KB

Platform Support

The following shows Https module APIs available for each platform.

Linux
(Ubuntu)		 Tizen
(Raspberry Pi)		 Raspbian
(Raspberry Pi)		 NuttX
(STM32F4-Discovery)		 TizenRT
(Artik053)
https.createServer O O O △ ¹ △ ¹
https.request O O O △ ¹ △ ¹
https.get O O O △ ¹ △ ¹
  1. On NuttX/STM32F4-Discovery and TizenRT/Artik053, even a couple of sockets/server/requests might not work properly.

Https

IoT.js provides HTTPS to support HTTPS clients enabling users to send HTTPS requests easily.

https.request(options[, callback])

  • options {Object}
    • host {string} A domain name or IP address of the server to issue the request to. Default: 'localhost'.
    • hostname {string} Alias for host.
    • port {number} Port of remote server. Default: 443.
    • method {string} A string specifying the HTTPS request method. Default: 'GET'.
    • path {string} Request path. Default: '/'. Should include query string if any. E.G. '/index.html?page=12'. An exception is thrown when the request path contains illegal characters. Currently, only spaces are rejected but that may change in the future.
    • headers {Object} An object containing request headers.
    • auth {string} Optional Basic Authentication in the form username:password. Used to compute HTTPS Basic Authentication header.
    • ca {string} Optional file path to CA certificate. Allows to override system trusted CA certificates.
    • cert {string} Optional file path to client authentication certificate in PEM format.
    • key {string} Optional file path to private keys for client cert in PEM format.
    • rejectUnauthorized {boolean} Optional Specify whether to verify the Server's certificate against CA certificates. WARNING - Making this false may be a security risk. Default: true
  • callback {Function}
    • response {https.IncomingMessage}
  • Returns: {https.ClientRequest}

Example:

var https = require('https');

var request = https.request({
  method: 'POST',
  port: 443,
  headers: {'Content-Length': 3}
});

...

request.end();

Note that in the example req.end() was called. With https.request() one must always call req.end() to signify that you're done with the request - even if there is no data being written to the request body.

https.get(options[, callback])

  • options {Object}
    • host {string} A domain name or IP address of the server to issue the request to. Default: 'localhost'.
    • hostname {string} Alias for host.
    • port {number} Port of remote server. Default: 443.
    • method {string} A string specifying the HTTPS request method. Default: 'GET'.
    • path {string} Request path. Default: '/'. Should include query string if any. E.G. '/index.html?page=12'. An exception is thrown when the request path contains illegal characters. Currently, only spaces are rejected but that may change in the future.
    • headers {Object} An object containing request headers.
    • auth {string} Optional Basic Authentication in the form username:password. Used to compute HTTPS Basic Authentication header.
    • ca {string} Optional file path to CA certificate. Allows to override system trusted CA certificates.
    • cert {string} Optional file path to client authentication certificate in PEM format.
    • key {string} Optional file path to private keys for client cert in PEM format.
    • rejectUnauthorized {boolean} Optional Specify whether to verify the Server's certificate against CA certificates. WARNING - Making this false may be a security risk. Default: true
  • callback {Function}
    • response {https.IncomingMessage}
  • Returns: {https.ClientRequest}

Same as https.request except that https.get automatically call req.end() at the end.

Example:

var https = require('https');

https.get({
  port: 443,
}, function(res) {
...
});

https.METHODS

A list of HTTPS methods supported by the parser as string properties of an Object.

Class: https.ClientRequest

This object is created internally and returned from https.request(). It represents an in-progress request whose header has already been queued.

See also: http.ClientRequest

Class: https.IncomingMessage

This object is created internally and returned to the callback in https.request(). It represents the response sent by a server to a request.

See also: http.IncomingMessage