SVR.JS mod notes

Berno

Berno is a SSI (Server-Side Includes) engine, which is not maintained.

Current version of Berno allows SSI only in .shtml files. Berno includes parts from very old version of RedBrick (1.x) to handle “exec” SSI directives.

easy-waf integration

easy-waf integration is a WAF (web application firewall) mod.

NOTICE: Using a WAF (Web Application Firewall) is no subsitute for web application security, because attacker will find a way to bypass the WAF.

Configuration file is easywaf-config.json inside SVR.JS installation directory. Configuration is passed to easy-waf. You can see documentation at its GitHub page. This mod requires easy-waf Node.JS module.

From easy-waf-integration 1.2.0, there is also additional mailConfig property, which is an object with those values:

serverConfig - server configuration object passed to nodemailer
from - source e-mail address
to - destination e-mail address

These versions support sending email in case of blocked request (requires nodemailer module).

From easy-waf-integration 1.2.0, there is support of pre-block and post-block hooks in easywaf-hooks.js inside SVR.JS installation directory.

Example easywaf-hooks.js code:

//EasyWAF hooks. For more information read the easy-waf documentation in GitHub.
 
function preBlockHook(req, moduleInfo, ip) {
  //You can add exceptions for WAF. In this example we do add exception for "cgi-bin".
  if (moduleInfo.name == 'directoryTraversal' && req.url.match(/\/cgi-bin(?:$|[#?/])/)) return false;
  //We're also adding XSS exception for YaBB forum software to prevent false positives
  if (moduleInfo.name == 'xss' && /\/YaBB\.(?:pl|cgi)(?:$|[?#])/.test(req.url) && /(?:(\\?)|[;&])action=(?:post2|modify2|imsend2|cdchatupdate|ajxmessage)($|[;&#])/.test(req.url)) return false;
}
 
function postBlockHook(req, moduleInfo, ip) {
  //You can, for example send an e-mail notification or log it into file.
}
 
module.exports = {postBlockHook: postBlockHook, preBlockHook: preBlockHook};

From easy-waf-integration 1.2.4, there are additional configuration properties:

maxRequestCheckedSize - maximum size of the request body (in bytes) to be checked. Default is 65536 (64 KiB).
maxRequestCheckedSizeStrict - option to enable strict request body limits. If the limits are exceeded, then the server will return a 413 Content Too Large error. Default is false.

If you’re using SVR.JS behind a reverse proxy, you need to configure trustProxy property in easy-waf configuration.

Example easywaf-config.json file:

{
  "modules": {
    "xss": {
      "excludePaths": "/^\\/(?:git\\/)?(?:(?!\\.git).)*\\.git\\/|^\\/(?:(?:navbar-)?logo|powered).png$/"
    },
    "noSqlInjection": {
      "excludePaths": "/^\\/(?:git\\/)?(?:(?!\\.git).)*\\.git\\//"
    },
    "crlfInjection": {
      "excludePaths": "/^\\/(?:git\\/)?(?:(?!\\.git).)*\\.git\\//"
    }
  },
  "mailConfig": {
    "serverConfig": {
      "host": "localhost",
      "port": 25,
      "secure": false,
      "ignoreTLS": true
    },
    "from": "svrjs@localhost",
    "to": "sysadmin@localhost"
  }
}

View the change log.

forward-proxy-mod

forward-proxy-mod is a mod, that enables SVR.JS to do forward proxy functionality.

Notes are in the SVR.JS documentation. View the change log.

GreenRhombus

GreenRhombus is a FastCGI (Fast Common Gateway Interface) client.

Notes are in the SVR.JS documentation. View the change log.

Next.js integration

Next.js integration is a mod, that enables SVR.JS to serve Next.js applications.

The webroot (wwwroot config.json property) serves as a Next.js application directory. It’s recommended to set the owner of the Next.js application directory (around with all the files in it) as the user, on which SVR.JS is running (usually “svrjs”). Setting a NODE_ENV environment variable to development in SVR.JS configuration enables Next.js development server.

It’s also recommended to forbid the access to “.env” file, “.next” and “.git” directories, in case Next.js integration mod fails to load. You can set up nonStandardCodes config.json property like this:

{
  "nonStandardCodes": [
    {
      "scode": 403,
      "regex": "/^\\/\\.env(?:\\.local|\\.production)?(?:$|[#?])/"
    },
    { 
      "scode": 403,
      "regex": "/^\\/\\.git/"
    },
    {
      "scode": 403,
      "regex": "/^\\/\\.next(?:$|[\\/#?])/"
    },
    ...other non-standard codes...
  ],
  ...other config.json properties...
}

View the change log.

OrangeCircle

OrangeCircle is a SCGI (Simple Common Gateway Interface) client.

Notes moved to SVR.JS documentation. View the change log.

RedBrick

RedBrick is a CGI (Common Gateway Interface) engine.

Notes moved to SVR.JS documentation. View the change log.

reverse-proxy-mod

reverse-proxy-mod is a mod, that enables SVR.JS to do reverse proxy functionality.

Notes moved to SVR.JS documentation. View the change log.

SvelteKit integration

SvelteKit integration is a mod, that enables SVR.JS to serve SvelteKit applications.

The webroot (wwwroot config.json property) serves as a SvelteKit application directory. It’s recommended to set the owner of the SvelteKit application directory (around with all the files in it) as the user, on which SVR.JS is running (usually “svrjs”).

The SvelteKit application must have Node.JS adapter (@sveltejs/adapter-node npm package) configured, and a “build” directory in order for the integration to work. You can generate the files in the “build” directory by running npm run build on the SvelteKit application.

It’s also recommended to forbid the access to “.env” file, “.svelte-kit” and “.git” directories, in case SvelteKit integration mod fails to load. You can set up nonStandardCodes config.json property like this:

{
  "nonStandardCodes": [
    {
      "scode": 403,
      "regex": "/^\\/\\.env(?:\\.local|\\.production)?(?:$|[#?])/"
    },
    { 
      "scode": 403,
      "regex": "/^\\/\\.git/"
    },
    {
      "scode": 403,
      "regex": "/^\\/\\.svelte-kit(?:$|[\\/#?])/"
    },
    ...other non-standard codes...
  ],
  ...other config.json properties...
}

View the change log.

SVR.JS Cache mod

SVR.JS Cache mod is a simple in-memory cache mod for SVR.JS that works with “Cache-Control” and “Vary” headers. The cache is a per-worker cache.

This mod adds these SVR.JS configuration properties:

cacheVaryHeaders (Array of Strings)
- A list of headers that can vary in a cache. Supplements the “Vary” response header.
maximumCacheResponseSize (Number or null)
- A maximum response size to be cached in bytes. If null, the maximum response size is limited to the maximum size of JavaScript strings.

If you use this mod with SVR.JS’s static file serving functionality, set the caching headers for the cache to work, and add “ETag” and “Accept-Encoding” to either a list of headers in a Vary header or in the cacheVaryHeaders property in the SVR.JS configuration.

View the change log.

YellowSquare

YellowSquare is a JSGI (JavaScript Gateway Interface) engine.

Notes moved to SVR.JS documentation. View the change log.

SVR.JS API (.tar.gz mods and server-side JavaScript)