HTTPS Server

HTTPS server.

Installation

$ npm install @kgryte/https-server

Usage

var httpsServer = require( '@kgryte/https-server' );

httpsServer( options, logger[, requestListener ] )

Returns a function to create an HTTPS server.

var bunyan = require( 'bunyan' );

// Specify server options...
var opts = {
	'key': 'path/to/private/key',
	'cert': 'path/to/public/certificate',
	'port': 7331,
	'address': '127.0.0.1'
};

// Create a logger...
var logger = bunyan.createLogger({
	'name': 'logger',
	'streams': [
		{
			'name': 'main',
			'level': 'info',
			'stream': process.stdout
		}
	]
});

// Create a function for creating an HTTPS server...
var create = httpsServer( opts, logger );

To bind a request callback to a server, specify a requestListener. For example,

var express = require( 'express' );

// Create a new application:
var app = express();

// Use the application as a request listener...
var create = httpsServer( opts, logger, app );

The function accepts the following options (along with any other tls.createServer options):

• key: path to private key for TLS/SSL.
• cert: path to public certificate for TLS/SSL.
• port: server port. Default: 0 (i.e., randomly assigned).
• maxport: max server port when port hunting. Default: maxport=port.
• hostname: server hostname.
• address: server address. Default: 0.0.0.0.

To specify a range of permissible ports, set the maxport option.

opts.maxport = 9999;

var create = httpsServer( opts, logger, app );

When provided a maxport option, a created server will search for the first available port on which to listen, starting from port.

create( done )

Creates an HTTPS server.

function done( error, server ) {
	if ( error ) {
		throw error;
	}
	console.log( 'Success!' );
	server.close();
}

create( done );

Notes

• Port hunting can be useful in a microservice deployment. When a port is randomly assigned (options.port=0), if a server fails and is restarted, the server is unlikely to bind to its previous port. By allowing a constrained search, assuming no lower ports within a specified range have freed up in the meantime, the likelihood of listening on the same port is increased. A server can typically restart and bind to the same port faster than binding to a new port and re-registering with a microservice registry, thus minimizing possible service interruption and downtime.

Examples

var bunyan = require( 'bunyan' ),
	express = require( 'express' ),
	httpsServer = require( './../lib' );

// Specify server options...
var opts = {
	'key':'path/to/private/key',
	'cert': 'path/to/public/certificate',
	'port': 7331,
	'maxport': 9999,
	'hostname': 'localhost'
};

// Create a logger...
var logger = bunyan.createLogger({
	'name': 'logger',
	'streams': [
		{
			'name': 'main',
			'level': 'info',
			'stream': process.stdout
		}
	]
});

// Create an express app:
var app = express();

// Create a function for creating an HTTPS server...
var create = httpsServer( opts, logger, app );

/**
* FUNCTION: done( error, server )
*	Callback invoked once a server is ready to receive HTTP requests.
*
* @param {Error|Null} error - error object
* @param {Server} server - server instance
* @returns {Void}
*/
function done( error, server ) {
	if ( error ) {
		throw error;
	}
	console.log( 'Success!' );
	server.close();
}

// Create a server:
create( done );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.