aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/helpers
diff options
context:
space:
mode:
authorAurélien Bertron <aurelienbertron@gmail.com>2018-07-31 14:02:47 +0200
committerChocobozzz <me@florianbigard.com>2018-07-31 15:40:29 +0200
commit59390818384baa0ffc0cb71af2e67350c6b39172 (patch)
treeea63aa445277a3d4bc9f5650b2bde0aadbefbc64 /server/helpers
parent1c3386e87f947d5b1dabb9be6a3b1a5d0fbf0d50 (diff)
downloadPeerTube-59390818384baa0ffc0cb71af2e67350c6b39172.tar.gz
PeerTube-59390818384baa0ffc0cb71af2e67350c6b39172.tar.zst
PeerTube-59390818384baa0ffc0cb71af2e67350c6b39172.zip
Add audit logs module
Diffstat (limited to 'server/helpers')
-rw-r--r--server/helpers/audit-logger.ts123
-rw-r--r--server/helpers/logger.ts2
2 files changed, 124 insertions, 1 deletions
diff --git a/server/helpers/audit-logger.ts b/server/helpers/audit-logger.ts
new file mode 100644
index 000000000..4b237316f
--- /dev/null
+++ b/server/helpers/audit-logger.ts
@@ -0,0 +1,123 @@
1import * as path from 'path'
2import { diff } from 'deep-object-diff'
3import { chain } from 'lodash'
4import * as flatten from 'flat'
5import * as winston from 'winston'
6import { CONFIG } from '../initializers'
7import { jsonLoggerFormat, labelFormatter } from './logger'
8import { VideoDetails } from '../../shared'
9
10enum AUDIT_TYPE {
11 CREATE = 'create',
12 UPDATE = 'update',
13 DELETE = 'delete'
14}
15
16const colors = winston.config.npm.colors
17colors.audit = winston.config.npm.colors.info
18
19winston.addColors(colors)
20
21const auditLogger = winston.createLogger({
22 levels: { audit: 0 },
23 transports: [
24 new winston.transports.File({
25 filename: path.join(CONFIG.STORAGE.LOG_DIR, 'peertube-audit.log'),
26 level: 'audit',
27 maxsize: 5242880,
28 maxFiles: 5,
29 format: winston.format.combine(
30 winston.format.timestamp(),
31 labelFormatter,
32 winston.format.splat(),
33 jsonLoggerFormat
34 )
35 })
36 ],
37 exitOnError: true
38})
39
40function auditLoggerWrapper (domain: string, user: string, action: AUDIT_TYPE, entity: EntityAuditView, oldEntity: EntityAuditView = null) {
41 let entityInfos: object
42 if (action === AUDIT_TYPE.UPDATE && oldEntity) {
43 const oldEntityKeys = oldEntity.toLogKeys()
44 const diffObject = diff(oldEntityKeys, entity.toLogKeys())
45 const diffKeys = Object.entries(diffObject).reduce((newKeys, entry) => {
46 newKeys[`new-${entry[0]}`] = entry[1]
47 return newKeys
48 }, {})
49 entityInfos = { ...oldEntityKeys, ...diffKeys }
50 } else {
51 entityInfos = { ...entity.toLogKeys() }
52 }
53 auditLogger.log('audit', JSON.stringify({
54 user,
55 domain,
56 action,
57 ...entityInfos
58 }))
59}
60
61function auditLoggerFactory (domain: string) {
62 return {
63 create (user: string, entity: EntityAuditView) {
64 auditLoggerWrapper(domain, user, AUDIT_TYPE.CREATE, entity)
65 },
66 update (user: string, entity: EntityAuditView, oldEntity: EntityAuditView) {
67 auditLoggerWrapper(domain, user, AUDIT_TYPE.UPDATE, entity, oldEntity)
68 },
69 delete (user: string, entity: EntityAuditView) {
70 auditLoggerWrapper(domain, user, AUDIT_TYPE.DELETE, entity)
71 }
72 }
73}
74
75abstract class EntityAuditView {
76 constructor (private keysToKeep: Array<string>, private prefix: string, private entityInfos: object) { }
77 toLogKeys (): object {
78 return chain(flatten(this.entityInfos, { delimiter: '-', safe: true }))
79 .pick(this.keysToKeep)
80 .mapKeys((value, key) => `${this.prefix}-${key}`)
81 .value()
82 }
83}
84
85const videoKeysToKeep = [
86 'tags',
87 'uuid',
88 'id',
89 'uuid',
90 'createdAt',
91 'updatedAt',
92 'publishedAt',
93 'category',
94 'licence',
95 'language',
96 'privacy',
97 'description',
98 'duration',
99 'isLocal',
100 'name',
101 'thumbnailPath',
102 'previewPath',
103 'nsfw',
104 'waitTranscoding',
105 'account-id',
106 'account-uuid',
107 'account-name',
108 'channel-id',
109 'channel-uuid',
110 'channel-name',
111 'support',
112 'commentsEnabled'
113]
114class VideoAuditView extends AuditEntity {
115 constructor (private video: VideoDetails) {
116 super(videoKeysToKeep, 'video', video)
117 }
118}
119
120export {
121 auditLoggerFactory,
122 VideoAuditView
123}
diff --git a/server/helpers/logger.ts b/server/helpers/logger.ts
index 6d369a8fb..04a19a9c6 100644
--- a/server/helpers/logger.ts
+++ b/server/helpers/logger.ts
@@ -96,13 +96,13 @@ const bunyanLogger = {
96 error: bunyanLogFactory('error'), 96 error: bunyanLogFactory('error'),
97 fatal: bunyanLogFactory('error') 97 fatal: bunyanLogFactory('error')
98} 98}
99
100// --------------------------------------------------------------------------- 99// ---------------------------------------------------------------------------
101 100
102export { 101export {
103 timestampFormatter, 102 timestampFormatter,
104 labelFormatter, 103 labelFormatter,
105 consoleLoggerFormat, 104 consoleLoggerFormat,
105 jsonLoggerFormat,
106 logger, 106 logger,
107 bunyanLogger 107 bunyanLogger
108} 108}