@newrelic/security-agent 0.0.1

package/lib/nr-security-api/index.js

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2023 New Relic Corporation. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+let newrelic;
+let  NRAgent;
+
+/**
+ * 
+ * @returns NewRelic Agent instance
+ */
+function getNRAgent(){
+    return NRAgent;
+}
+
+/**
+ * API to set newrelic agent object.
+ * @param {*} agent 
+ */
+function setNRAgent(agent){
+    NRAgent = agent;
+}
+
+/**
+ * API to get security agent
+ * @returns Security Agent instanace
+ */
+function getSecAgent(){
+    const Agent = require('../nr-security-agent/lib/core/agent').Agent;
+    const csecAgent = Agent.getAgent();
+    if(csecAgent){
+         return csecAgent;
+    }
+}
+
+/**
+ * API to get status of security agent
+ * @returns Security Agent status
+ */
+function getSecAgentStatus(){
+    const Agent = require('../nr-security-agent/lib/core/agent').Agent;
+    if(Agent.getAgent()){
+        return Agent.getAgent().status.getStatus()
+   }
+}
+
+/**
+ * API to generate security event from the intermediate data
+ * @param {*} securityMetadata 
+ * @returns security event object
+ */
+function generateSecEvent(securityMetadata){
+   return require('../nr-security-agent/lib/core/sec-util').generateSecEvent(securityMetadata);
+}
+
+/**
+ * API to send security event 
+ * @param {*} secEvent 
+ */
+function sendEvent(secEvent){
+    require('../nr-security-agent/lib/core/sec-util').sendEvent(secEvent);
+}
+
+/**
+ * API to get logger instance
+ * @returns 
+ */
+function getLogger(){
+    return require('../nr-security-agent/lib/core/logging').getLogger();
+}
+/**
+ * API to validate RXSS
+ * @param {*} secRequest 
+ * @param {*} responseBody 
+ * @param {*} responseHeaders 
+ * @returns 
+ */
+function checkForReflectedXSS(secRequest, responseBody, responseHeaders){
+    return require('../nr-security-agent/lib/core/xss-utils').checkForReflectedXSS(secRequest, responseBody, responseHeaders);
+}
+
+/**
+ * API to get security agent policy
+ * @returns security agent policy
+ */
+function getPolicy(){
+    return require('../nr-security-agent/lib/core/Policy').getInstance();
+}
+
+/**
+ * API to generate Exit event
+ * @param {*} event 
+ */
+function generateExitEvent(event){
+    require('../nr-security-agent/lib/core/sec-util').generateExitEvent(event);
+}
+
+module.exports = {
+    newrelic,
+    getNRAgent,
+    getSecAgent,
+    getSecAgentStatus,
+    generateSecEvent,
+    sendEvent,
+    getLogger,
+    checkForReflectedXSS,
+    getPolicy,
+    generateExitEvent,
+    setNRAgent
+}

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@newrelic/security-agent",
+  "version": "0.0.1",
+  "description": "Newrelic Security Agent for Node.js",
+  "main": "index.js",
+  "collectorVersion": "1.0.1-limited-preview",
+  "buildNumber": 103,
+  "jsonVersion": "1.0.1",
+  "contributors": [
+    {
+      "name": "Sumit Suthar",
+      "email": "ssuthar@newrelic.com",
+      "web": "http://newrelic.com"
+    },
+    {
+      "name": "Pratik Gunjetiya",
+      "email": "pgunjetiya@newrelic.com",
+      "web": "http://newrelic.com"
+    }
+  ],
+  "scripts": {
+    "test": "tap --test-regex='(\\/|^test\\/instrumentation-security\\/.*\\.test\\.js)$' --no-coverage",
+    "posttest": "rm -f newrelic_agent.log && rm -rf nr-security-home && rm -rf .nyc_output",
+    "third-party-updates": "oss third-party manifest && oss third-party notices && git add THIRD_PARTY_NOTICES.md third_party_manifest.json"
+  },
+  "keywords": [],
+  "author": "newrelic",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/newrelic/csec-node-agent.git"
+  },
+  "dependencies": {
+    "@aws-sdk/client-lambda": "3.276.0",
+    "axios": "0.21.4",
+    "check-disk-space": "^3.1.0",
+    "content-type": "^1.0.4",
+    "fast-safe-stringify": "^2.0.7",
+    "find-package-json": "^1.2.0",
+    "hash.js": "^1.1.7",
+    "html-entities": "^1.2.1",
+    "is-invalid-path": "^1.0.2",
+    "js-yaml": "^4.1.0",
+    "jsonschema": "^1.4.0",
+    "lodash": "^4.17.21",
+    "log4js": "^6.0.0",
+    "pretty-bytes": "^5.6.0",
+    "request-ip": "^2.1.3",
+    "ringbufferjs": "^2.0.0",
+    "semver": "^6.3.0",
+    "sync-request": "^6.1.0",
+    "unescape": "^1.0.1",
+    "unescape-js": "^1.1.4",
+    "uuid": "^3.4.0",
+    "ws": "^7.5.9"
+  },
+  "devDependencies": {
+    "@hapi/hapi": "^21.3.0",
+    "@koa/router": "^12.0.0",
+    "@newrelic/newrelic-oss-cli": "^0.1.2",
+    "@newrelic/test-utilities": "7.2.1",
+    "@typescript-eslint/eslint-plugin": "^4.15.0",
+    "@typescript-eslint/parser": "^4.15.0",
+    "director": "^1.2.8",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-disable": "^2.0.1",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jsdoc": "^39.3.6",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-sonarjs": "^0.15.0",
+    "koa": "^2.14.1",
+    "mongodb": "^4.13.0",
+    "mongodb-memory-server": "^8.11.2",
+    "mongodb2": "npm:mongodb@^2.2.36",
+    "mongodb3": "npm:mongodb@^3.7.3",
+    "newrelic": "^9.15.0",
+    "request": "^2.88.2",
+    "restify": "^11.1.0",
+    "sinon": "^15.0.0",
+    "tap": "^16.3.2",
+    "xmldom": "^0.6.0",
+    "xpath": "^0.0.32",
+    "xpath.js": "^1.1.0"
+  },
+  "files": [
+    "index.js",
+    "*.md",
+    "LICENSE",
+    "lib/"
+  ]
+}