atna-audit - npm Package Compare versions

Comparing version 0.5.0 to 1.0.0

index.js

 'use strict';
 
-var js2xml = require('js2xmlparser');
-var os = require('os');
-
-// Event Outcome Indicator
-exports.OUTCOME_SUCCESS = 0;
-exports.OUTCOME_MINOR_FAILURE = 4;
-exports.OUTCOME_SERIOUS_FAILURE = 8;
-exports.OUTCOME_MAJOR_FAILURE = 12;
-
-// Network Access Point Type Code
-exports.EVENT_ACTION_CREATE = 'C';
-exports.EVENT_ACTION_READ = 'R';
-exports.EVENT_ACTION_UPDATE = 'U';
-exports.EVENT_ACTION_DELETE = 'D';
-exports.EVENT_ACTION_EXECUTE = 'E';
-
-// Network Access Point Type Code
-exports.NET_AP_TYPE_DNS = 1;
-exports.NET_AP_TYPE_IP = 2;
-exports.NET_AP_TYPE_TEL = 3;
-
-// Audit Source Type Code
-exports.AUDIT_SRC_TYPE_UI = 1;
-exports.AUDIT_SRC_TYPE_DATA_AQUISITION = 2;
-exports.AUDIT_SRC_TYPE_WEB_SERVER = 3;
-exports.AUDIT_SRC_TYPE_APP_SERVER = 4;
-exports.AUDIT_SRC_TYPE_DB_SERVER = 5;
-exports.AUDIT_SRC_TYPE_SECURITY_SERVER = 6;
-exports.AUDIT_SRC_TYPE_NET_COMP = 7;
-exports.AUDIT_SRC_TYPE_OS = 8;
-exports.AUDIT_SRC_TYPE_EXTERN = 9;
-
-// Participant Object Type Code
-exports.OBJ_TYPE_PERSON = 1;
-exports.OBJ_TYPE_SYS_OBJ = 2;
-exports.OBJ_TYPE_ORG = 3;
-exports.OBJ_TYPE_OTHER = 4;
-
-// Participant Object Type Code Role
-exports.OBJ_TYPE_CODE_ROLE_PATIENT = 1;
-exports.OBJ_TYPE_CODE_ROLE_LOCATION = 2;
-exports.OBJ_TYPE_CODE_ROLE_REPORT = 3;
-exports.OBJ_TYPE_CODE_ROLE_RESOURCE = 4;
-exports.OBJ_TYPE_CODE_ROLE_MASTER_FILE = 5;
-exports.OBJ_TYPE_CODE_ROLE_USER = 6;
-exports.OBJ_TYPE_CODE_ROLE_LIST = 7;
-exports.OBJ_TYPE_CODE_ROLE_DOCTOR = 8;
-exports.OBJ_TYPE_CODE_ROLE_SUBSCRIBER = 9;
-exports.OBJ_TYPE_CODE_ROLE_GUARANTOR = 10;
-exports.OBJ_TYPE_CODE_ROLE_SECURITY_USER_ENTITY = 11;
-exports.OBJ_TYPE_CODE_ROLE_SECURITY_USER_GROUP = 12;
-exports.OBJ_TYPE_CODE_ROLE_SECURITY_RESOURCE = 13;
-exports.OBJ_TYPE_CODE_ROLE_SECURITY_GRANULARITY = 14;
-exports.OBJ_TYPE_CODE_ROLE_PROVIDER = 15;
-exports.OBJ_TYPE_CODE_ROLE_DATA_DESTINATION = 16;
-exports.OBJ_TYPE_CODE_ROLE_DATA_REPOSITORY = 17;
-exports.OBJ_TYPE_CODE_ROLE_SCHEDULE = 18;
-exports.OBJ_TYPE_CODE_ROLE_CUSTOMER = 19;
-exports.OBJ_TYPE_CODE_ROLE_JOB = 20;
-exports.OBJ_TYPE_CODE_ROLE_JOB_STREAM = 21;
-
-// Participant Object ID Type Code
-exports.OBJ_ID_TYPE_MRN = 1;
-exports.OBJ_ID_TYPE_PAT_NUM = 2;
-exports.OBJ_ID_TYPE_ENCOUNTER_NUM = 3;
-exports.OBJ_ID_TYPE_ENROLLEE_NUM = 4;
-exports.OBJ_ID_TYPE_SSN = 5;
-exports.OBJ_ID_TYPE_ACC_NUM = 6;
-exports.OBJ_ID_TYPE_GUARANTOR_NUM = 7;
-exports.OBJ_ID_TYPE_REPORT_NAME = 8;
-exports.OBJ_ID_TYPE_REPORT_NUM = 9;
-exports.OBJ_ID_TYPE_SEARCH_CRIT = 10;
-exports.OBJ_ID_TYPE_USER_ID = 11;
-exports.OBJ_ID_TYPE_URI = 12;
-
-function Code(code, originalText, codeSystemName, displayName) {
-  this['@'] = {
-    'csd-code': code,
-    originalText: originalText,
-    codeSystemName: codeSystemName
-  };
-  if (displayName) {
-    this['@'].displayName = displayName;
-  }
-}
-Code.prototype.constructor = Code;
-Code.prototype.toXML = function() {
-  return js2xml('Code', this);
-};
-exports.Code = Code;
-
-/**
- * ValuePair class
- *  
- * @param  {String} type the type 
- * @param  {String} val  the value, this will be automatically base64 encoded 
- */ 
-function ValuePair(type, val) {
-  this['@'] = {
-    type: type,
-    value: new Buffer(val).toString('base64')
-  };
-}
-ValuePair.prototype.constructor = ValuePair;
-ValuePair.prototype.toXML = function() {
-  return js2xml('ValuePair', this);
-};
-exports.ValuePair = ValuePair;
-
-function EventIdentification(actionCode, datetime, outcome, eventID, typeCode) {
-  this['@'] = {
-    EventActionCode: actionCode,
-    EventDateTime: datetime.toISOString(),
-    EventOutcomeIndicator: outcome
-  };
-  this.EventID = eventID;
-  if (typeCode) {
-    this.EventTypeCode = typeCode;
-  }
-}
-EventIdentification.prototype.constructor = EventIdentification;
-EventIdentification.prototype.toXML = function() {
-  return js2xml('EventIdentification', this);
-};
-exports.EventIdentification = EventIdentification;
-
-function ActiveParticipant(userId, altUserId, userIsRequestor, netAccessPointId, netAccessPointTypeCode, roleCodes) {
-  this['@'] = {
-    UserID: userId,
-    AlternativeUserID: altUserId,
-    UserIsRequestor: userIsRequestor
-  };
-  if (netAccessPointId) {
-    this['@'].NetworkAccessPointID = netAccessPointId;
-  }
-  if (netAccessPointTypeCode) {
-    this['@'].NetworkAccessPointTypeCode = netAccessPointTypeCode;
-  }
-  this.RoleIDCode = roleCodes;
-}
-ActiveParticipant.prototype.constructor = ActiveParticipant;
-ActiveParticipant.prototype.toXML = function() {
-  return js2xml('ActiveParticipant', this);
-};
-exports.ActiveParticipant = ActiveParticipant;
-
-function ParticipantObjectIdentification(objId, objTypeCode, objTypeCodeRole, objDataLifeCycle, objSensitivity, objIdTypeCode, objName, objQuery, objDetails) {
-  this['@'] = {
-    ParticipantObjectID: objId
-  };
-  if (objTypeCode) {
-    this['@'].ParticipantObjectTypeCode = objTypeCode;
-  }
-  if (objTypeCodeRole) {
-    this['@'].ParticipantObjectTypeCodeRole = objTypeCodeRole;
-  }
-  if (objDataLifeCycle) {
-    this['@'].ParticipantObjectDataLifeCycle = objDataLifeCycle;
-  }
-  if (objSensitivity) {
-    this['@'].ParticipantObjectSensitivity = objSensitivity;
-  }
-  this.ParticipantObjectIDTypeCode = objIdTypeCode;
-  if (objName) {
-    this.ParticipantObjectName = objName;
-  } else if (objQuery) {
-    this.ParticipantObjectQuery = objQuery;
-  }
-  if (objDetails && objDetails.length > 0) {
-    this.ParticipantObjectDetail = objDetails;
-  }
-}
-ParticipantObjectIdentification.prototype.constructor = ParticipantObjectIdentification;
-ParticipantObjectIdentification.prototype.toXML = function() {
-  return js2xml('ParticipantObjectIdentification', this);
-};
-exports.ParticipantObjectIdentification = ParticipantObjectIdentification;
-
-function AuditSourceIdentification(auditEnterpriseSiteId, auditSourceId, auditSourceTypeCode) {
-  this['@'] = {
-    AuditEnterpriseSiteID: auditEnterpriseSiteId,
-    AuditSourceID: auditSourceId,
-    code: auditSourceTypeCode['@']['csd-code'],
-    codeSystemName: auditSourceTypeCode['@'].codeSystemName,
-    originalText: auditSourceTypeCode['@'].originalText
-  };
-}
-AuditSourceIdentification.prototype.constructor = AuditSourceIdentification;
-AuditSourceIdentification.prototype.toXML = function() {
-  return js2xml('AuditSourceIdentification', this);
-};
-exports.AuditSourceIdentification = AuditSourceIdentification;
-
-function AuditMessage(eventIdent, activeParticipants, participantObjs, auditSources) {
-  if (eventIdent) {
-    this.EventIdentification = eventIdent;
-  }
-  if (activeParticipants && activeParticipants.length > 0) {
-    this.ActiveParticipant = activeParticipants;
-  }
-  if (auditSources && auditSources.length > 0) {
-    this.AuditSourceIdentification = auditSources;
-  }
-  if (participantObjs && participantObjs.length > 0) {
-    this.ParticipantObjectIdentification = participantObjs;
-  }
-}
-AuditMessage.prototype.constructor = AuditMessage;
-AuditMessage.prototype.toXML = function() {
-  return js2xml('AuditMessage', this);
-};
-exports.AuditMessage = AuditMessage;
-
-function wrapInSyslog(msg) {
-  return '<85>1 ' + new Date().toISOString() + ' ' + os.hostname() + ' atna-audit.js ' + process.pid + ' IHE+RFC-3881 - ' + msg;
-}
-exports.wrapInSyslog = wrapInSyslog;
-
-exports.userLoginAudit = function(outcome, sysname, hostname, username, userRole, userRoleCode) {
-  var eventID = new Code(110114, 'UserAuthenticated', 'DCM');
-  var typeCode = new Code(110122, 'Login', 'DCM');
-  var eIdent = new EventIdentification(exports.EVENT_ACTION_EXECUTE, new Date(), outcome, eventID, typeCode);
-
-  var sysRoleCode = new Code(110150, 'Application', 'DCM');
-  var sysParticipant = new ActiveParticipant(sysname, '', false, hostname, exports.NET_AP_TYPE_DNS, [sysRoleCode]);
-
-  var userRoleCodeDef = new Code(userRole, userRole, userRoleCode);
-  var userParticipant = new ActiveParticipant(username, '', true, null, null, [userRoleCodeDef]);
-
-  var sourceTypeCode = new Code(exports.AUDIT_SRC_TYPE_UI, '', '');
-  var sourceIdent = new AuditSourceIdentification(null, sysname, sourceTypeCode);
-
-  var audit = new AuditMessage(eIdent, [sysParticipant, userParticipant], null, [sourceIdent]);
-  return  audit.toXML();
-};
-
-exports.appActivityAudit = function(isStart, sysname, hostname, username) {
-  if (!username) {
-    username = 'root';
-  }
-
-  var eventID = new Code(110100, 'Application Activity', 'DCM');
-  var typeCode;
-  if (isStart) {
-    typeCode = new Code(110120, 'Application Start', 'DCM');
-  } else {
-    typeCode = new Code(110121, 'Application Stop', 'DCM');
-  }
-  var eIdent = new EventIdentification(exports.EVENT_ACTION_EXECUTE, new Date(), exports.OUTCOME_SUCCESS, eventID, typeCode);
-
-  var sysRoleCode = new Code(110150, 'Application', 'DCM');
-  var sysParticipant = new ActiveParticipant(sysname, '', false, hostname, exports.NET_AP_TYPE_DNS, [sysRoleCode]);
-
-  var userRoleCodeDef = new Code(110151, 'Application Launcher', 'DCM');
-  var userParticipant = new ActiveParticipant(username, '', true, null, null, [userRoleCodeDef]);
-
-  var sourceTypeCode = new Code(exports.AUDIT_SRC_TYPE_WEB_SERVER, '', '');
-  var sourceIdent = new AuditSourceIdentification(null, sysname, sourceTypeCode);
-
-  var audit = new AuditMessage(eIdent, [sysParticipant, userParticipant], null, [sourceIdent]);
-  return audit.toXML();
-};
-
-/**
- * Generates a 'Audit Log Used' audit message in XML format
- * @param  {Number} outcome       the desired outcome, e.g. atna.OUTCOME_SUCCESS.
- * @param  {String} sysname       the system name of the system that generated this audit.
- * @param  {String} hostname      the hostname of the system that generated this audit.
- * @param  {String} username      the username of the person viewing the audit
- * @param  {String} userRole      the user role of the person viewing the audit
- * @param  {String} userRoleCode  the role code of the person viewing the audit
- * @param  {String} auditLogURI   a URI identifying the used audit message
- * @param  {Object} objDetails    (optional) participant object details. Should be a ValuePair object
- * @return {String}               the xml of this audit message.
- */
-exports.auditLogUsedAudit = function(outcome, sysname, hostname, username, userRole, userRoleCode, auditLogURI, objDetails) {
-  var eventID = new Code(110101, 'Audit Log Used', 'DCM');
-  var eIdent = new EventIdentification(exports.EVENT_ACTION_READ, new Date(), outcome, eventID, null);
-
-  var sysRoleCode = new Code(110150, 'Application', 'DCM');
-  var sysParticipant = new ActiveParticipant(sysname, '', false, hostname, exports.NET_AP_TYPE_DNS, [sysRoleCode]);
-
-  var userRoleCodeDef = new Code(userRole, userRole, userRoleCode);
-  var userParticipant = new ActiveParticipant(username, '', true, null, null, [userRoleCodeDef]);
-
-  var sourceTypeCode = new Code(exports.AUDIT_SRC_TYPE_UI, '', '');
-  var sourceIdent = new AuditSourceIdentification(null, sysname, sourceTypeCode);
-
-  var objIdTypeCode = new Code(exports.OBJ_ID_TYPE_URI, 'URI');
-  var participantObj = new ParticipantObjectIdentification(
-    auditLogURI, exports.OBJ_TYPE_SYS_OBJ, exports.OBJ_TYPE_CODE_ROLE_SECURITY_RESOURCE, null, null, objIdTypeCode, 'Security Audit Log', objDetails
-  );
-  var audit = new AuditMessage(eIdent, [sysParticipant, userParticipant], [participantObj], [sourceIdent]);
-  return  audit.toXML();
-}
-
-/*
- * Generates a node authentication audit.
- *  
- * @param  {String} nodeIP    the IP address of the node that attempted authentication.
- * @param  {String} sysname   the system name of the system that generated this audit.
- * @param  {String} hostname  the hostname of the system that generated this audit.
- * @param  {Number} outcome   the desired outcome, for authentication failure use atna.OUTCOME_MINOR_FAILURE.
- * @return {String}           the xml of this audit message.
- */ 
-exports.nodeAuthentication = function (nodeIP, sysname, hostname, outcome) {
-  var eventID = new Code(110113, 'Security Alert', 'DCM');
-  var typeCode = new Code(110126, 'Node Authentication', 'DCM');
-  var eIdent = new EventIdentification(exports.EVENT_ACTION_EXECUTE, new Date(), outcome, eventID, typeCode);
-  
-  var sysRoleCode = new Code(110150, 'Application', 'DCM');
-  var sysParticipant = new ActiveParticipant(sysname, '', false, hostname, exports.NET_AP_TYPE_DNS, [sysRoleCode]);
-
-  var objIdTypeCode = new Code(110182, 'Node ID', 'DCM');
-  var nodeParticipant = new ParticipantObjectIdentification(nodeIP, 2, null, null, null, objIdTypeCode, nodeIP, null, null);
-  
-  var sourceTypeCode = new Code(exports.AUDIT_SRC_TYPE_WEB_SERVER, '', '');
-  var sourceIdent = new AuditSourceIdentification(null, sysname, sourceTypeCode);
-  
-  var audit = new AuditMessage(eIdent, [sysParticipant], [nodeParticipant], [sourceIdent]);
-  return audit.toXML();
-};
+module.exports = {
+  constants : require('./lib/constants.js'),
+  construct : require('./lib/construct.js'),
+  send : require('./lib/sendAudit.js')
+}

package.json

 {
   "name": "atna-audit",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "description": "Assists in the creation of ATNA audit trail messages for IHE profiles.",
@@ -8,4 +8,6 @@ "main": "index.js",
     "pretest": "npm run gen:rng",
-    "test": "tap --cov test.js",
-    "gen:rng": "sed 's/#.*//' dicom.rnc > temp.rnc && trang temp.rnc dicom.rng && rm temp.rnc"
+    "test": "tap --cov --reporter=spec tests/**.js",
+    "gen:rng": "sed 's/#.*//' dicom.rnc > temp.rnc && trang temp.rnc dicom.rng && rm temp.rnc",
+    "cov": "npm run test:code -- --coverage-report=lcov",
+    "test:upload-cov": "tap --coverage-report=lcov && codecov"
   },
@@ -18,2 +20,3 @@ "author": "Jembi Health Systems NPC",
   "devDependencies": {
+    "codecov": "^1.0.1",
     "eslint": "^1.7.3",
@@ -20,0 +23,0 @@ "tap": "^5.0.1"

README.md

@@ -16,4 +16,4 @@ [![Build Status](https://travis-ci.org/jembi/atna-audit.svg)](https://travis-ci.org/jembi/atna-audit) [![codecov.io](https://codecov.io/github/jembi/atna-audit/coverage.svg?branch=master)](https://codecov.io/github/jembi/atna-audit?branch=master)
 ```js
-var audit = atna.userLoginAudit(atna.OUTCOME_SUCCESS, 'openhim', 'x.x.x.x', 'testUser', 'testRole', '123');
-var syslog = atna.wrapInSyslog(audit);
+var audit = atna.construct.userLoginAudit(atna.OUTCOME_SUCCESS, 'openhim', 'x.x.x.x', 'testUser', 'testRole', '123');
+var syslog = atna.construct.wrapInSyslog(audit);
 ```
@@ -24,19 +24,45 @@
 ```js
-var eventID = new atna.Code(110114, 'UserAuthenticated', 'DCM');
-var typeCode = new atna.Code(110122, 'Login', 'DCM');
-var eIdent = new atna.EventIdentification(atna.EVENT_ACTION_EXECUTE, new Date(), atna.OUTCOME_SUCCESS, eventID, typeCode);
-var sysRoleCode = new atna.Code(110150, 'Application', 'DCM');
-var sysParticipant = new atna.ActiveParticipant(sysname, '', true, sysIp, atna.NET_AP_TYPE_IP, [sysRoleCode]);
-var userRoleCodeDef = new atna.Code(userRole, userRole, userRoleCode);
-var userParticipant = new atna.ActiveParticipant(username, '', true, null, null, [userRoleCodeDef]);
-var sourceTypeCode = new atna.Code(atna.AUDIT_SRC_TYPE_UI, '', '');
-var sourceIdent = new atna.AuditSourceIdentification(null, sysname, sourceTypeCode);
-var audit = new atna.AuditMessage(eIdent, [sysParticipant, userParticipant], null, [sourceIdent]);
+var eventID = new atna.construct.Code(110114, 'UserAuthenticated', 'DCM');
+var typeCode = new atna.construct.Code(110122, 'Login', 'DCM');
+var eIdent = new atna.construct.EventIdentification(atna.EVENT_ACTION_EXECUTE, new Date(), atna.OUTCOME_SUCCESS, eventID, typeCode);
+var sysRoleCode = new atna.construct.Code(110150, 'Application', 'DCM');
+var sysParticipant = new atna.construct.ActiveParticipant(sysname, '', true, sysIp, atna.NET_AP_TYPE_IP, [sysRoleCode]);
+var userRoleCodeDef = new atna.construct.Code(userRole, userRole, userRoleCode);
+var userParticipant = new atna.construct.ActiveParticipant(username, '', true, null, null, [userRoleCodeDef]);
+var sourceTypeCode = new atna.construct.Code(atna.AUDIT_SRC_TYPE_UI, '', '');
+var sourceIdent = new atna.construct.AuditSourceIdentification(null, sysname, sourceTypeCode);
+var audit = new atna.construct.AuditMessage(eIdent, [sysParticipant, userParticipant], null, [sourceIdent]);
 var xml = audit.toXML();
 ```
 
+## Sending an Audit to an ATNA supported server
+
+Connection Details
+
+```js
+var connDetails = {
+  interface: 'udp|tls|tcp', // specify the interface to use when sending the audit
+  host: 'localhost', // specify the host 
+  port: 5050, // specify the port 
+  options: { // when interface type is 'tls', you need to supply the certificate details
+    key: fs.readFileSync('./path/to/key.pem').toString(), 
+    cert: fs.readFileSync('./path/to/cert.pem').toString(),
+    ca: fs.readFileSync('./path/to/cert.pem').toString(),
+  }
+}
+```
+
+Sending the Audit
+
+
+```js
+atna.send.sendAuditEvent(msg, connDetail, function (err) {
+  // handle errors if needed
+})
+```
+
 ## Testing
 
-To test the code you will need `xmllint` and `trang` on your PATH. `sudo apt-get install xmllint trang`
+To test the code you will need `xmllint` and `trang` on your PATH. `sudo apt-get install libxml2-utils trang`
 
 Then run `npm test`

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 3 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

43394

increased by67.27%

Number of package files

19

increased by111.11%

Lines of code

572

increased by67.74%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

67

increased by63.41%

Worsened metrics

Dev dependency count

3

increased by50%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

8

increased by300%

No dependency changes