@contrast/assess 1.18.0 → 1.20.0

package/lib/session-configuration/install/fastify-cookie.js

@@ -0,0 +1,110 @@
+/*
+ * Copyright: 2024 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+'use strict';
+
+const { inspect } = require('util');
+const { toLowerCase } = require('@contrast/common');
+const { patchType } = require('../common');
+
+/**
+ * @param {{
+ *  assess: import('@contrast/assess').Assess,
+ *  scopes: import('@contrast/scopes').Scopes,
+ * }} core
+ */
+module.exports = function (core) {
+  const {
+    assess: {
+      getSourceContext,
+      eventFactory: { createSessionEvent },
+      sessionConfiguration: {
+        handleHttpOnly,
+        handleSecure,
+      },
+    },
+    depHooks,
+    patcher,
+  } = core;
+
+  return core.assess.sessionConfiguration.fastifyCookie = {
+    install () {
+      depHooks.resolve({ name: '@fastify/cookie' }, (_export) => {
+        const patched = patcher.patch(_export, {
+          name: 'express.hookedSessionConstructor',
+          patchType,
+          pre(data) {
+            const [server, options] = data.args;
+
+            // neither default to safe (truthy) values
+            const httpOnly = options?.parseOptions?.httpOnly;
+            const secure = options?.parseOptions?.secure;
+            if (httpOnly && secure) return;
+
+            const displayArg = inspect({ parseOptions: { httpOnly, secure } });
+            const sessionEvent = createSessionEvent({
+              args: [{
+                tracked: false,
+                value: displayArg
+              }],
+              context: `fastifyCookie(${displayArg})`,
+              history: [],
+              name: 'fastifyCookie',
+              moduleName: '@fastify/cookie',
+              methodName: '',
+              object: {
+                tracked: false,
+                value: '@fastify/cookie',
+              },
+              result: {
+                tracked: false,
+              },
+              source: 'P0',
+              stack: [],
+              tags: {},
+              framework: '@fastify/cookie',
+            });
+
+            server.addHook('onRequest', async (request, reply) => {
+              patcher.patch(reply, 'header', {
+                patchType,
+                name: 'fastify.Reply.header',
+                pre(data) {
+                  const [key, value] = data.args;
+                  if (toLowerCase(key) !== 'set-cookie') return;
+
+                  const sourceContext = getSourceContext();
+                  if (!sourceContext) return;
+
+                  if (!httpOnly) {
+                    handleHttpOnly(sourceContext, value, sessionEvent);
+                  }
+
+                  if (!secure) {
+                    handleSecure(sourceContext, value, sessionEvent);
+                  }
+                }
+              });
+            });
+          }
+        });
+
+        _export.default = patched;
+        _export.fastifyCookie = patched;
+
+        return patched;
+      });
+    }
+  };
+};

package/lib/session-configuration/install/hapi.js

@@ -1,5 +1,5 @@
 /*
- * Copyright: 2023 Contrast Security, Inc
+ * Copyright: 2024 Contrast Security, Inc
  * Contact: support@contrastsecurity.com
  * License: Commercial
 
@@ -36,7 +36,6 @@ module.exports = function (core) {
   const inspect = patcher.unwrap(util.inspect);
 
   hapiSession.install = function () {
-
     return depHooks.resolve({ name: '@hapi/hapi', version: '>=18 <21' }, (hapi) => {
       ['server', 'Server'].forEach((server) => {
         patcher.patch(hapi, server, {
@@ -47,14 +46,12 @@ module.exports = function (core) {
               name: 'state',
               patchType,
               post(data) {
-    
                 const options = data.args[1];
-    
                 const httpOnly = Object.prototype.hasOwnProperty.call(options, 'isHttpOnly') ? options.isHttpOnly : true;
                 const isSecure = Object.prototype.hasOwnProperty.call(options, 'isSecure') ? options.isSecure : true;
-    
+
                 if (httpOnly && isSecure) return;
-    
+
                 const sessionEvent = createSessionEvent({
                   args: [{
                     tracked: false,
@@ -80,18 +77,18 @@ module.exports = function (core) {
                   framework: 'hapi',
                   options
                 });
-    
+
                 data.obj.ext('onPostResponse', ({ response: { headers } }) => {
                   const value = headers?.['set-cookie']?.[0];
                   if (!value) return;
-    
+
                   const sourceContext = sources.getStore()?.assess;
                   if (!sourceContext) return;
-    
+
                   if (!httpOnly) {
                     handleHttpOnly(sourceContext, `set-cookie: ${value}`, sessionEvent);
                   }
-    
+
                   if (!isSecure) {
                     handleSecure(sourceContext, `set-cookie: ${value}`, sessionEvent);
                   }
@@ -99,7 +96,7 @@ module.exports = function (core) {
               }
             });
           }
-        });  
+        });
       });
     });
   };

package/lib/session-configuration/install/koa.js

@@ -0,0 +1,101 @@
+/*
+ * Copyright: 2024 Contrast Security, Inc
+ * Contact: support@contrastsecurity.com
+ * License: Commercial
+
+ * NOTICE: This Software and the patented inventions embodied within may only be
+ * used as part of Contrast Security’s commercial offerings. Even though it is
+ * made available through public repositories, use of this Software is subject to
+ * the applicable End User Licensing Agreement found at
+ * https://www.contrastsecurity.com/enduser-terms-0317a or as otherwise agreed
+ * between Contrast Security and the End User. The Software may not be reverse
+ * engineered, modified, repackaged, sold, redistributed or otherwise used in a
+ * way not consistent with the End User License Agreement.
+ */
+'use strict';
+
+const { inspect } = require('util');
+const { patchType } = require('../common');
+
+/**
+ * @param {{
+ *  assess: import('@contrast/assess').Assess,
+ *  scopes: import('@contrast/scopes').Scopes,
+ * }} core
+ */
+module.exports = function (core) {
+  const {
+    assess: {
+      getSourceContext,
+      eventFactory: { createSessionEvent },
+      sessionConfiguration: {
+        handleHttpOnly,
+        handleSecure,
+      },
+    },
+    depHooks,
+    patcher,
+  } = core;
+
+  return core.assess.sessionConfiguration.koa = {
+    install () {
+      depHooks.resolve({ name: 'koa', version: '>=2.3.0' }, (Koa) => {
+        patcher.patch(Koa.prototype, 'use', {
+          name: 'Koa.Application',
+          patchType,
+          pre(data) {
+            const origCtx = data.args[0];
+            data.args[0] = function(...args) {
+              patcher.patch(args[0].cookies, 'set', {
+                name: 'ctx.cookies',
+                patchType,
+                pre({ args }) {
+                  const sourceContext = getSourceContext();
+                  if (!sourceContext) return;
+
+                  const [name,, options] = args;
+
+                  const httpOnly = options?.httpOnly;
+                  const secure = options?.secure;
+                  if (httpOnly && secure) return;
+
+                  const displayArg = inspect(options);
+                  const sessionEvent = createSessionEvent({
+                    args: [{
+                      tracked: false,
+                      value: displayArg
+                    }],
+                    context: `ctx.cookies.set(${displayArg})`,
+                    history: [],
+                    name: 'koaCookie',
+                    moduleName: 'koa',
+                    methodName: '',
+                    object: {
+                      tracked: false,
+                      value: 'koa',
+                    },
+                    result: {
+                      tracked: false,
+                    },
+                    source: 'P',
+                    stack: [],
+                    tags: {},
+                    framework: 'koa',
+                  });
+                  if (!httpOnly) {
+                    handleHttpOnly(sourceContext, name, sessionEvent);
+                  }
+
+                  if (!secure) {
+                    handleSecure(sourceContext, name, sessionEvent);
+                  }
+                }
+              });
+              return origCtx.apply(this, args);
+            };
+          }
+        });
+      });
+    }
+  };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/assess",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "Contrast service providing framework-agnostic Assess support",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.15.1",
+    "@contrast/common": "1.16.0",
     "@contrast/distringuish": "^4.4.0",
     "@contrast/scopes": "1.4.0"
   }