Nosy Pinocchio Manners

    rec.la

    0.3.2 • Public • Published

    rec.la

    npm License

    Loopback domain and SSL certificates:

    https://<any subdomain>.rec.la/ → https://localhost/

    Any subdomain of rec.la points to localhost!

    Exception: www.rec.la, which points to a page where you can download the certificates.

    Why ?

    At Pryv we often have to locally develop web applications that intensively use AJAX REST requests.

    Browsers enforce the same-origin policy mechanism that restricts the loading of resources from another origin. This can be allowed by sending correct Cross-Origin Resource Sharing (CORS) headers.

    But making requests to HTTPS APIs from HTTP sites on localhost would not be possible without changing security options on your browser, which is why we refurbished a domain and its SSL certificates as a full loopback domain, to let anyone benefit from a signed certificate on localhost.

    Update: where are the certificates?

    From v0.2 onwards, certificates are not bundled with the npm package, but downloaded and updated from www.rec.la at installation and runtime, or manually with rec.la-update.

    Note: If the certificates are outdated and loaded synchronously with require('rec.la').httpsOptions() (see usage below), they will be updated and the service stopped, so it can be rebooted manually.

    Usage

    Installation

    npm install rec.la
    

    Command line

    (Don't forget to prefix commands with npx if not installed globally.)

    Start a webserver serving the contents of a directory on https://l.rec.la:<port>/:

    rec.la <path> [<port>]
    

    Start a proxy on https://l.rec.la:<port>/:

    rec.la-proxy <target host>[:<target port>] [<port>]
    

    Manually update the certificates:

    rec.la-update
    

    Certificate files

    You can also directly use the certificates files on www.rec.la:

    • rec.la-cert.crt: The certificate
    • rec.la-key.pem: The private key
    • rec.la-ca.pem: Certificate of the authority
    • rec.la-bundle.crt: Bundle of key + CA
    • pack.json: All the above in a JSON file

    From a node app

    Pure Node.js

    const https = require('https');
    const options = require('rec.la').httpsOptions();
    
    https.createServer(options, (req, res) => {
      res.writeHead(200);
      res.end('hello world\n');
    }).listen(8443);

    Or (check and update before):

    const https = require('https');
    const httpsOptionsAsync = require('rec.la').httpsOptionsAsync;
    
    httpsOptionsAsync(function (err, httpsOptions) {
      https.createServer(httpsOptions, (req, res) => {
        res.writeHead(200);
        res.end('hello world\n');
      }).listen(8443);
    });

    Express

    const https = require('https');
    const httpsOptionsAsync = require('rec.la').httpsOptionsAsync;
    const express = require('express');
    const app = express();
    
    // ...your code...
    
    httpsOptionsAsync(function (err, httpsOptions) {
      https.createServer(httpsOptions, app).listen(8443);
    });

    Vue.js

    Enable local HTTPS for development:

    const recLaOptions = require('rec.la').httpsOptions();
    recLaOptions.https = true;
    recLaOptions.host = 'l.rec.la';
    
    module.exports = {
      // ...your options...
      devServer: recLaOptions
    };

    Now vue-cli-service serve will be served on https://l.rec.la

    Contributing

    npm run start starts the webserver (see rec.la CLI command above)

    npm run proxy starts the proxy (see rec.la-proxy CLI command above)

    npm run lint lints the code with Semi-Standard.

    Pull requests are welcome.

    License

    BSD-3-Clause

    Install

    npm i rec.la

    DownloadsWeekly Downloads

    24

    Version

    0.3.2

    License

    BSD-3-Clause

    Unpacked Size

    14.1 kB

    Total Files

    11

    Last publish

    Collaborators

    • perki
    • sgoumaz