@cap-js/audit-logging 0.8.3 → 1.0.0

package/CHANGELOG.md

@@ -4,8 +4,23 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## Version 1.0.0 - 2025-07-11
+
+### Added
+
+- Beta support for next generation SAP Audit Log Service
+  - Use explicit kind `audit-log-to-alsng` or alpha auto-detect kind `audit-log-to-als`
+
+## Version 0.9.0 - 2025-06-05
+
+### Added
+
+- Support for `@sap/cds^9`
+
 ## Version 0.8.3 - 2025-04-09
 
+### Fixed
+
 - Preperation for `@sap/cds^9`
 
 ## Version 0.8.2 - 2024-11-27

package/lib/utils.js

@@ -123,7 +123,8 @@ const _buildSubSelect = (model, { entity, relative, element, next }, row, previo
   const targetAlias = _alias(element._target)
   const relativeAlias = _alias(relative)
 
-  if (!('_relations' in relative)) {
+  // REVISIT: there seems to be a caching issue in cds^9 when elemets are renamed
+  if (!('_relations' in relative) || !relative._relations[element.name]) {
     const newRelation = Relation.to(relative)
     relative._relations = new Proxy(exposeRelation(newRelation), relationHandler(newRelation))
   }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@cap-js/audit-logging",
-  "version": "0.8.3",
+  "version": "1.0.0",
   "description": "CDS plugin providing integration to the SAP Audit Log service as well as out-of-the-box personal data-related audit logging based on annotations.",
   "repository": "cap-js/audit-logging",
   "author": "SAP SE (https://www.sap.com)",
   "homepage": "https://cap.cloud.sap/",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "main": "cds-plugin.js",
   "files": [
     "lib",
@@ -14,21 +14,19 @@
   ],
   "scripts": {
     "lint": "npx eslint .",
-    "test": "npm run test-new-db && npm run test-old-db",
-    "test-new-db": "CDS_ENV='better-sqlite' npx jest --silent",
-    "test-old-db": "CDS_ENV='legacy-sqlite' npx jest --silent"
+    "test": "npx jest --silent"
   },
   "peerDependencies": {
-    "@sap/cds": ">=7"
+    "@sap/cds": ">=8"
   },
   "devDependencies": {
     "@cap-js/audit-logging": "file:.",
-    "@cap-js/sqlite": "^1",
+    "@cap-js/cds-test": ">=0",
+    "@cap-js/sqlite": ">=1",
     "axios": "^1",
     "eslint": "^9",
     "express": "^4",
-    "jest": "^29",
-    "sqlite3": "^5.1.6"
+    "jest": "^29"
   },
   "cds": {
     "requires": {
@@ -55,11 +53,17 @@
         "audit-log-to-console": {
           "impl": "@cap-js/audit-logging/srv/log2console"
         },
+        "audit-log-to-als": {
+          "impl": "@cap-js/audit-logging/srv/log2als"
+        },
         "audit-log-to-restv2": {
           "impl": "@cap-js/audit-logging/srv/log2restv2",
           "vcap": {
             "label": "auditlog"
           }
+        },
+        "audit-log-to-alsng": {
+          "impl": "@cap-js/audit-logging/srv/log2alsng"
         }
       }
     }

package/srv/log2als.js

@@ -0,0 +1,4 @@
+const credentials = JSON.parse(process.env.VCAP_SERVICES) || {}
+const isV3 = credentials['user-provided']?.some(obj => obj.tags.includes('auditlog-ng'))
+
+module.exports = isV3 ? require('./log2alsng') : require('./log2restv2')

package/srv/log2alsng.js

@@ -0,0 +1,178 @@
+const cds = require('@sap/cds')
+
+const LOG = cds.log('audit-log')
+
+const https = require('https')
+
+const AuditLogService = require('./service')
+
+module.exports = class AuditLog2ALSNG extends AuditLogService {
+  constructor() {
+    super()
+    this._vcap = JSON.parse(process.env.VCAP_SERVICES || '{}')
+    this._userProvided = this._vcap['user-provided']?.find(obj => obj.tags.includes('auditlog-ng')) || {}
+    if (!this._userProvided.credentials) throw new Error('No credentials found for SAP Audit Log Service NG')
+    this._vcapApplication = this._vcap['VCAP_APPLICATION'] || {}
+  }
+
+  async init() {
+    this.on('*', function (req) {
+      const { event, data } = req
+      return this.eventMapper(event, data)
+    })
+    await super.init()
+  }
+
+  eventMapper(event, data) {
+    return {
+      PersonalDataModified: () => this.logEvent('dppDataModification', data),
+      SensitiveDataRead: () => this.logEvent('dppDataAccess', data),
+      ConfigurationModified: () => this.logEvent('configurationChange', data),
+      SecurityEvent: () => this.logEvent('legacySecurityWrapper', data)
+    }[event]()
+  }
+
+  eventDataPayload(event, data) {
+    const object = data['object'] || { type: 'not provided', id: { ID: 'not provided' } }
+    const channel = data['channel'] || { type: 'not specified', id: 'not specified' }
+    const subject = data['data_subject'] || { type: 'not provided', id: { ID: 'not provided' } }
+    const attributes = data['attributes'] || [{ name: 'not provided', old: 'not provided', new: 'not provided' }]
+    const objectId = object['id']?.['ID'] || 'not provided'
+    const oldValue = attributes[0]['old'] ?? ''
+    const newValue = attributes[0]['new'] ?? ''
+    const dataSubjectId = subject['id']?.['ID'] || 'not provided'
+    return {
+      dppDataModification: {
+        objectType: object['type'],
+        objectId: objectId,
+        attribute: attributes[0]['name'],
+        oldValue: oldValue,
+        newValue: newValue,
+        dataSubjectType: subject['type'],
+        dataSubjectId: dataSubjectId
+      },
+      dppDataAccess: {
+        channelType: channel['type'],
+        channelId: channel['id'],
+        dataSubjectType: subject['type'],
+        dataSubjectId: dataSubjectId,
+        objectType: object['type'],
+        objectId: objectId,
+        attribute: attributes[0]['name']
+      },
+      configurationChange: {
+        propertyName: attributes[0]['name'],
+        oldValue: oldValue,
+        newValue: newValue,
+        objectType: object['type'],
+        objectId: objectId
+      },
+      legacySecurityWrapper: {
+        origEvent: JSON.stringify({
+          ...data,
+          data:
+            typeof data.data === 'object' && data.data !== null && !Array.isArray(data.data)
+              ? JSON.stringify(data.data)
+              : data.data
+        })
+      }
+    }[event]
+  }
+
+  eventPayload(event, data) {
+    const tenant = cds.context?.tenant || null
+    const timestamp = new Date().toISOString()
+
+    const eventData = {
+      id: cds.utils.uuid(),
+      specversion: 1,
+      source: `/${this._userProvided.credentials?.region}/${this._userProvided.credentials?.namespace}/${tenant}`,
+      type: event,
+      time: timestamp,
+      data: {
+        metadata: {
+          ts: timestamp,
+          appId: this._vcapApplication.application_id || 'default app',
+          infrastructure: {
+            other: {
+              runtimeType: 'Node.js'
+            }
+          },
+          platform: {
+            other: {
+              platformName: 'CAP'
+            }
+          }
+        },
+        data: {
+          [event]: this.eventDataPayload(event, data)
+        }
+      }
+    }
+
+    return eventData
+  }
+
+  logEvent(event, data) {
+    const passphrase = this._userProvided.credentials?.keyPassphrase
+    const url = new URL(`${this._userProvided.credentials?.url}/ingestion/v1/events`)
+    let eventData = []
+
+    if (event === 'legacySecurityWrapper') {
+      eventData = JSON.stringify([this.eventPayload(event, data)])
+    } else {
+      eventData = data['attributes'].map(attr => {
+        return this.eventPayload(event, {
+          ...data,
+          attributes: [attr]
+        })
+      })
+      eventData = JSON.stringify(eventData)
+    }
+
+    const options = {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        'Content-Length': Buffer.byteLength(eventData)
+      },
+      key: this._userProvided.credentials?.key,
+      cert: this._userProvided.credentials?.cert,
+      ...(passphrase !== undefined && { passphrase })
+    }
+
+    return new Promise((resolve, reject) => {
+      const req = https.request(url, options, res => {
+        LOG.trace('🛰️ Status Code:', res.statusCode)
+
+        const chunks = []
+        res.on('data', chunk => chunks.push(chunk))
+
+        res.on('end', () => {
+          const { statusCode, statusMessage } = res
+          let body = Buffer.concat(chunks).toString()
+          if (res.headers['content-type']?.match(/json/)) body = JSON.parse(body)
+          if (res.statusCode >= 400) {
+            // prettier-ignore
+            const err = new Error(`Request failed with${statusMessage ? `: ${statusCode} - ${statusMessage}` : ` status ${statusCode}`}`)
+            err.request = { method: options.method, url, headers: options.headers, body: data }
+            if (err.request.headers.authorization)
+              err.request.headers.authorization = err.request.headers.authorization.split(' ')[0] + ' ***'
+            err.response = { statusCode, statusMessage, headers: res.headers, body }
+            reject(err)
+          } else {
+            resolve(body)
+          }
+        })
+      })
+
+      req.on('error', e => {
+        reject(e.message)
+        LOG.trace(`Problem with request: ${e.message}`)
+      })
+
+      req.write(eventData)
+      req.end()
+    })
+  }
+}

package/srv/service.js

@@ -1,8 +1,6 @@
 const cds = require('@sap/cds')
 
-const Base = cds.outboxed ? cds.Service : require('@sap/cds/libx/_runtime/messaging/Outbox')
-
-module.exports = class AuditLogService extends Base {
+module.exports = class AuditLogService extends cds.Service {
   async init() {
     // add common audit log entry fields
     this.before('*', req => {