Nomenclature Processing Machine
Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

otiluke

5.4.3 • Public • Published

Otiluke otiluke-logo

Toolbox for deploying JavaScript code transformers written in JavaScript themselves on node and browsers.

Virus Interface

Otiluke deploys on node and browsers JavaScript code transformers expressed as virus modules. Virus modules are CommonJS module which exports a function that takes an array of user-defined arguments and return JavaScript transformation function. For instance:

module.exports = (argm, callback) => {
  console.log("Virus initialized with: "+JSON.stringify(argm));
  setTimeout(() => {
    callback(null, (script, source) => [
      "console.log("+JSON.stringify("Begin "+source)+");",
      script,
      "console.log("+JSON.stringify("End"+source)+");"
    ].join("\n"));
  }, 0);
};

Calling context of virus functions:

Virus(argm, (error, transform) => {
  if (error)
    throw error;
  script2 = transform(script1, source);
});
  • argm :: {string}: A mapping of user-defined arguments. For node these are command line arguments. For browsers, these are
  • script1 :: string: The original script.
  • source :: string
    • otiluke/node: absolute path to a node module.
    • otiluke/browser
      • inline script: the dom id (otiluke will create one of it does not exists) of the script element.
      • inline event handler: the dom id (otiluke will create one of it does not exists) of the target element followed by a space and the handler name. e.g. "button1 onclick".
      • external script: absolute url.
  • script2 :: string: The transformed script.

OtilukeNode

OtilukeNode infects node applications by modifying the require procedure performed by node. Examples: test/node/run.sh.

require("otiluke/node")(Virus, options={})

  • Virus :: function: Virus constructor (function exported by a virus module).
  • options :: object
    • _ :: [array] Array of string interpreted as the command to launch the node process to be infected. For instance: ["main.js", "foo", "bar"].
    • ...: Remaining properties will be used to compute argument mapping argm passed to virus.

Alternatively, if Otiluke is installed globally, the otiluke-node command can be used:

otiluke-node --virus <path> ... -- <command>`

For instance: otiluke-node --virus virus.js --foo=123 --bar=456 -- main.js --qux=789 will result into {foo:123, bar:456} being passed to the virus.js module, while node main.js --qux=789 will be used to launch the node process to be infected.

OtilukeBrowser

OtilukeBrowser modifies html pages served over http(s) by performing a man-in-the-middle attack with a forward proxy. Such attack requires the browser to redirect all its requests to the forward proxy. For pages securely served over https it also requires the browser to trust the self-signed certificate, by default at browser/ca-home/cert.pem. Examples: test/browser/run-hello.sh and test/browser/run-google.sh.

require("otiluke/browser/ca")(options={})

This function prepares a directory to serve as the home directory of a certificate authority.

  • options.cahome :: string, default "node_modules/otiluke/browser/ca-home": The directory will be populated with the subdirectories: req, key and cert and the files: req.pem, key.pem, cert.pem and serial.srl.
  • options.subj :: string, default "/CN=otiluke/O=Otiluke": The -subj argument to pass to openssl -req.

Alternatively, if Otiluke is installed globally, the following command can be used:

otiluke-browser-ca [--ca-home <path>] [--subj arg]

Warning Making a browser trust a root certificate has serious security consequences. Everyone having access to the corresponding private key can falsify any identity on that browser (which is exactly what OtilukeBrowser needs to do). To avoid security breach, we recommend to use a dedicated browser and never fill in it any sensitive information.

listeners = require("otiluke/browser/listeners")(vpath, options={})

Create listeners for a man-in-the-middle proxy.

  • vpath :: string: Path to a virus module.
  • options.cahome :: string, default "node_modules/otiluke/browser/ca-home" Path to a certificate authority home directory.
  • options.sockdir :: string, default $TMPDIR ("\\?\pipe" on windows). Address namespace for local sockets (aka named piped in windows).
  • options.argmpfx :: string, default "otiluke-": Prefix to look for in the search part of the url to create the argm object. For instance, the url http://example.com/path?otiluke-foo=123&otiluke-bar=456&qux=789 will result into {foo:123, bar:456} being passed to the virus module.
  • options.gvar :: string, default __OTILUKE__. Global variable used to store the transformation function.
  • options.agents :: object, default {http: new http.Agent()} Node http agent to use for performing http requests.
  • options.intercept :: object, default {request: () => {}, connect: () => {}, upgrade: () => {}}. A set a function defined by the user to intercept traffic passing by Otiluke servers. The this argument is always pointing to the server that intercepted the traffic.
    • intercepted = intercept.request(request, response) Called whenever a regular request is intercepted by either the proxy or one of the forged servers. Unless this function return a truthy value, Otiluke will forward the regular request to the rightful address.
      • request :: http(s).IncomingMessage
      • response :: http(s).ServerResponse
      • intercepted :: boolean
    • intercepted = intercept.connect(request, socket, head) Called whenever a connect request is intercepted by one of the forged servers. Unless this function return a truthy value, Otiluke will forward the connect request to the rightful address and blindly relay subsequent traffic.
      • request :: http(s).IncomingMessage
      • socket :: (net|tls).Socket
      • head :: Buffer
      • intercepted :: boolean
    • intercepted = intercept.upgrade(request, socket, head) Called whenever a connect request is intercepted by either the proxy or one of the forged servers. Unless this function return a truthy value, Otiluke will forward the upgrade request to the rightful address and blindly relay subsequent traffic.
      • request :: http(s).IncomingMessage
      • socket :: (net|tls).Socket
      • head :: Buffer
      • intercepted :: boolean
  • options.register :: object, default {} During its lifetime Otiluke will create several objects susceptible to throw errors. To help diagnose erros, these objects are passed to callback functions:
    • register.forgery(hostname, server) Called whenever a hostname is being impersonated. The this argument is the proxy to which Otiluke listeners are attached.
      • hostname :: string
      • server :: https.Server
    • register.request(request) Called whenever a request is forwarded to the rightful address. The this argument is the server that intercepted the initial request.
      • request :: http(s).ClientRequest
    • register.connect(socket) Called whenever a connect request is forwarded to the rightful address. The this argument is the server that intercepted the initial request.
      • socket :: net.Socket
    • register.upgrade(socket) Called whenever an upgrade request is forwarded to the rightful address. The this argument is the server that intercepted the initial request.
      • socket :: net.Socket
  • listeners :: object Object containing event listeners which should be attached to a user-created http.Server to setup the man-in-the-middle attack.
    • listeners.request(request, response)
    • listeners.upgrade(request, socket, head)
    • listeners.connect(request, socket, head)

Alternatively, if Otiluke is installed globally, the following command can be used:

otiluke-browser-proxy --vpath=<path> --port=<number> [--intercept=<path>] [--cahome=<path>] [--sockdir=<path>] [--gvar=<token>] [--argmpfx=<token>] 

proxy = require("otiluke/browser")(vpath, options)

Similar to require("otiluke/browser/listener") but returns a http.Server already attached to Otiluke listeners. Also, provide options.register which centralises all the errors to the user-provided function options.failure(location, hostname, message). Finally every servers can closes by calling proxy.closeAll() and every socket can be destroyed by calling proxy.destroyAll().

Redirect the browser requests to the man-in-the-middle proxy

Firefox

Go to about:preferences, at the bottom of the General menu, click on Settings.... Tick the checkbox Manual proxy configuration and Use this proxy server for all protocols. The HTTP Proxy field should be localhost and the Port field should refer to the port to which is the proxy is listening. Make sure that loopback addresses such as localhost and 127.0.0.1 are not present in the field No Proxy for.

Chrome

Use the --proxy-server switch. For instance, on OSX:

/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --proxy-server=127.0.0.1:8080

System

Changing the system-level proxy settings would also work but it will redirect every http(s) request performed by your system. In OSX, system-level proxy settings are available in: System Preferences > Network > Advanced... > Proxies.

Make browsers trust Otiluke's root certificate

This step is only required if you need to infect html pages securely served over https.

Firefox

Go to about:preferences, at the bottom of the Privacy & Security menu, click on View Certificates. Import Otiluke's root certificate an restart Firefox to avoid sec_error_reused_issuer_and_serial error.

System

Otiluke's root certificate can also be trusted at the system level but that means that every browser will trust Otiluke's signed certificate. If your certificate authority directory is compromised, data can be stolen from each one of your browsers. In OSX, go to Keychain Access > Files > Import Items and select Otiluke's root certificate.

install

npm i otiluke

Downloadsweekly downloads

1,225

version

5.4.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability