So, on this blog I've given a Node.js simple web service example before but it was plain vanilla and didn't handle either secure connections with HTTPS or handle this curious protocol called CORS (see below). I remedy that here by given some working code which allows POSTing of json payloads.
So to make your Node.js web service handle https you need to use
var https = require('https');
var fs = require('fs');
var options = {
// create the following two files beforehand with openssl
// https://stackoverflow.com/questions/12871565/how-to-create-pem-files-for-https-web-server#answer-12907165
key: fs.readFileSync('key.pem'),
cert: fs.readFileSync('cert.pem')
};
where you are specifying the private key and the SSL certificate which you must have created before. Switch to your node.js source files directory so openssl.exe creates the files in the right place. A good stack overflow Q&A here shows how to create these files.
CORS Cross-Origin Resource Sharing
Ideally all files and content are delivered from one single web domain (+port). Sometimes a use case is not that simple. Sometimes a web resource needs to be accessed from a different origin. CORS allows this cross origin request. As you can imagine you are opening up a security hole; so in production think carefully about where cross-origin requests might originate and tie down as much as possible. In production, don't use wildcards like in sample code given below! A naughty person could launch a denial of service attack if you allow them! A good CORS guide is here.
Pre-flight request
Today I learnt that some client will send an HTTP OPTIONS request before sending a HTTP POST request; this is known as a "pre-flight request". If you are not using a web server framework then you will need to handle this manually by setting HTTP response headers like the following...
// IN PRODUCTION DO NOT USE WILDCARDS!!!
response.setHeader("Access-Control-Allow-Origin", "*");
response.setHeader('Access-Control-Allow-Methods', 'POST, OPTIONS');
response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, content-type, Accept");
So in the above code I have not tied down Origin but you dear reader must do in production! But this is a blog sample. I have tied down the HTTP methods, only allowing POST and OPTIONS. I have also tied down the headers.
Whilst one should should tie down options as much as possible if you tie down too much your client will assume it has been refused permission and not send the follow-on POST request (in my use case). I had to debug CORS today because my POSTs were not coming through. If the preflight OPTIONS request is not implemented then yes any POST request will not follow on.
Anyway, here is a full working example. The following code runs an HTTPS service at 127.0.0.1:8000 and only allows OPTIONS and GET. Don't forget in production to further restrict the origin and not use wildcards...
'use strict';
var https = require('https');
var fs = require('fs');
var options = {
// create the following two files beforehand with openssl
// https://stackoverflow.com/questions/12871565/how-to-create-pem-files-for-https-web-server#answer-12907165
key: fs.readFileSync('key.pem'),
cert: fs.readFileSync('cert.pem')
};
const port = 8000;
console.log('nversion 0.001n');
//https://stackoverflow.com/questions/5998694/how-to-create-an-https-server-in-node-js#answer-21809393
https.createServer(options, function (request, response) {
switch (request.method) {
case "OPTIONS":
// IN PRODUCTION DO NOT USE WILDCARDS!!!
response.setHeader("Access-Control-Allow-Origin", "*");
response.setHeader('Access-Control-Allow-Methods', 'POST, OPTIONS');
response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, content-type, Accept");
response.end();
break;
case "GET":
console.log(request.url);
response.end('Hello Node.js Server!');
break;
case "POST":
// IN PRODUCTION DO NOT USE WILDCARDS!!!
response.setHeader("Access-Control-Allow-Origin", "*");
response.setHeader('Access-Control-Allow-Methods', 'POST, OPTIONS');
response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, content-type, Accept");
//https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/
let body = [];
request.on('data', (chunk) => {
body.push(chunk);
}).on('end', () => {
body = Buffer.concat(body).toString();
// at this point, `body` has the entire request body stored in it as a string
console.log('nbody received:nn' + body);
});
response.end();
break;
}
}).listen(port);