@collabee-tech/collabee-ch-audit v0.0.3

nodelib-atle-base-audit

Biblioteca de auditorua para aplicações desenvolvidas na plataforma Collabee.

Introdução

A biblioteca de segurança da Collabee contem um conjunto de middlewares para implementar a geração de eventos de auditoria em aplicações baseadas no servidor ExpressJS.

O formato das mensagens de log é o mesmo adotado por outras bibliotecas já em uso na Collabee, o qual baseia-se no padrão LEEF. Para maiores detalhes sobre este padrão, incluindo a descrição dos diversos campos, consulte a página de referência.

Incluindo a biblioteca em seu projeto

$ npm i @collabee-tech/collabee-ch-audit

Utilizando o middleware global de segurança

A função auditMiddleware cria o middleware de auditoria global utilizando configurações padrão:

import { auditMiddleware } from '@collabee-tech/collabee-ch-audit'
let express = require('express');
let app = express();

app.use(auditMiddleware())

NOTA 1: O middleware deve ser adicionado à aplicação via método use ANTES da mesma ser iniciada.

NOTA 2: O scaffold para criação de aplicações padrão já adiciona de forma automática este middleware ao servidor Express.

Gerando eventos adicionais

A configuração inicial gerada pelo scaffold gera eventos de auditoria sem necessidade de código adicional para todas as chamadas HTTP entrantes e saíntes da aplicação.

Caso seja necessário adicionar algum evento adicional de auditoria, deve-se utilizar a classe AuditEvent e AuditLogger:

import {AuditEvent, AuditLogger,Outcome} from '@collabee-tech/collabee-ch-audit'

// cria evento de auditoria
let evt: AuditEvent = AuditEvent.builder()
  .withMEventId("Meu_evento_auditavel")
  .withOutcome(Outcome.SUCCESS)
  ... outras propriedades do evento (omitidas)
  .build(); // Finaliza criação do evento

// Loga evento
AuditLogger.log(evt);

Informações coletadas pelo middleware

A tabela a seguir apresenta as informações coletadas pelo middlewar de forma automática: