PeerTube/server/helpers/audit-logger.ts

275 lines
6.4 KiB
TypeScript
Raw Normal View History

2018-07-31 14:02:47 +02:00
import { diff } from 'deep-object-diff'
2021-08-27 14:32:44 +02:00
import express from 'express'
import flatten from 'flat'
2020-07-01 16:05:30 +02:00
import { chain } from 'lodash'
2021-08-27 14:32:44 +02:00
import { join } from 'path'
import { addColors, config, createLogger, format, transports } from 'winston'
2020-07-01 16:05:30 +02:00
import { AUDIT_LOG_FILENAME } from '@server/initializers/constants'
2021-12-24 10:14:47 +01:00
import { AdminAbuse, CustomConfig, User, VideoChannel, VideoComment, VideoDetails, VideoImport } from '@shared/models'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../initializers/config'
2020-07-01 16:05:30 +02:00
import { jsonLoggerFormat, labelFormatter } from './logger'
2018-09-19 17:02:16 +02:00
function getAuditIdFromRes (res: express.Response) {
2019-03-19 16:23:02 +01:00
return res.locals.oauth.token.User.username
2018-09-19 17:02:16 +02:00
}
2018-07-31 14:02:47 +02:00
enum AUDIT_TYPE {
CREATE = 'create',
UPDATE = 'update',
DELETE = 'delete'
}
2021-08-27 14:32:44 +02:00
const colors = config.npm.colors
colors.audit = config.npm.colors.info
2018-07-31 14:02:47 +02:00
2021-08-27 14:32:44 +02:00
addColors(colors)
2018-07-31 14:02:47 +02:00
2021-08-27 14:32:44 +02:00
const auditLogger = createLogger({
2018-07-31 14:02:47 +02:00
levels: { audit: 0 },
transports: [
2021-08-27 14:32:44 +02:00
new transports.File({
filename: join(CONFIG.STORAGE.LOG_DIR, AUDIT_LOG_FILENAME),
2018-07-31 14:02:47 +02:00
level: 'audit',
maxsize: 5242880,
maxFiles: 5,
2021-08-27 14:32:44 +02:00
format: format.combine(
format.timestamp(),
2020-04-09 11:00:30 +02:00
labelFormatter(),
2021-08-27 14:32:44 +02:00
format.splat(),
2018-07-31 14:02:47 +02:00
jsonLoggerFormat
)
})
],
exitOnError: true
})
function auditLoggerWrapper (domain: string, user: string, action: AUDIT_TYPE, entity: EntityAuditView, oldEntity: EntityAuditView = null) {
let entityInfos: object
if (action === AUDIT_TYPE.UPDATE && oldEntity) {
const oldEntityKeys = oldEntity.toLogKeys()
const diffObject = diff(oldEntityKeys, entity.toLogKeys())
const diffKeys = Object.entries(diffObject).reduce((newKeys, entry) => {
newKeys[`new-${entry[0]}`] = entry[1]
return newKeys
}, {})
entityInfos = { ...oldEntityKeys, ...diffKeys }
} else {
entityInfos = { ...entity.toLogKeys() }
}
auditLogger.log('audit', JSON.stringify({
user,
domain,
action,
...entityInfos
}))
}
function auditLoggerFactory (domain: string) {
return {
create (user: string, entity: EntityAuditView) {
auditLoggerWrapper(domain, user, AUDIT_TYPE.CREATE, entity)
},
update (user: string, entity: EntityAuditView, oldEntity: EntityAuditView) {
auditLoggerWrapper(domain, user, AUDIT_TYPE.UPDATE, entity, oldEntity)
},
delete (user: string, entity: EntityAuditView) {
auditLoggerWrapper(domain, user, AUDIT_TYPE.DELETE, entity)
}
}
}
abstract class EntityAuditView {
2020-01-31 16:56:52 +01:00
constructor (private readonly keysToKeep: string[], private readonly prefix: string, private readonly entityInfos: object) { }
2018-07-31 14:02:47 +02:00
toLogKeys (): object {
2021-08-27 14:32:44 +02:00
return chain(flatten<object, any>(this.entityInfos, { delimiter: '-', safe: true }))
2018-07-31 14:02:47 +02:00
.pick(this.keysToKeep)
2021-08-27 14:32:44 +02:00
.mapKeys((_value, key) => `${this.prefix}-${key}`)
2018-07-31 14:02:47 +02:00
.value()
}
}
const videoKeysToKeep = [
'tags',
'uuid',
'id',
'uuid',
'createdAt',
'updatedAt',
'publishedAt',
'category',
'licence',
'language',
'privacy',
'description',
'duration',
'isLocal',
'name',
'thumbnailPath',
'previewPath',
'nsfw',
'waitTranscoding',
'account-id',
'account-uuid',
'account-name',
'channel-id',
'channel-uuid',
'channel-name',
'support',
'commentsEnabled',
'downloadEnabled'
2018-07-31 14:02:47 +02:00
]
class VideoAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (video: VideoDetails) {
2018-07-31 14:02:47 +02:00
super(videoKeysToKeep, 'video', video)
}
}
2018-08-03 10:26:47 +02:00
const videoImportKeysToKeep = [
'id',
'targetUrl',
'video-name'
]
class VideoImportAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (videoImport: VideoImport) {
2018-08-03 10:26:47 +02:00
super(videoImportKeysToKeep, 'video-import', videoImport)
}
}
const commentKeysToKeep = [
'id',
'text',
'threadId',
'inReplyToCommentId',
'videoId',
'createdAt',
'updatedAt',
'totalReplies',
'account-id',
'account-uuid',
'account-name'
]
class CommentAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (comment: VideoComment) {
super(commentKeysToKeep, 'comment', comment)
}
}
const userKeysToKeep = [
'id',
'username',
'email',
'nsfwPolicy',
'autoPlayVideo',
'role',
'videoQuota',
'createdAt',
'account-id',
'account-uuid',
'account-name',
'account-followingCount',
'account-followersCount',
'account-createdAt',
'account-updatedAt',
'account-avatar-path',
'account-avatar-createdAt',
'account-avatar-updatedAt',
'account-displayName',
'account-description',
'videoChannels'
]
class UserAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (user: User) {
super(userKeysToKeep, 'user', user)
}
}
const channelKeysToKeep = [
'id',
'uuid',
'name',
'followingCount',
'followersCount',
'createdAt',
'updatedAt',
'avatar-path',
'avatar-createdAt',
'avatar-updatedAt',
'displayName',
'description',
'support',
'isLocal',
'ownerAccount-id',
'ownerAccount-uuid',
'ownerAccount-name',
'ownerAccount-displayedName'
]
class VideoChannelAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (channel: VideoChannel) {
super(channelKeysToKeep, 'channel', channel)
}
}
2020-07-01 16:05:30 +02:00
const abuseKeysToKeep = [
'id',
'reason',
'reporterAccount',
'createdAt'
]
2020-07-01 16:05:30 +02:00
class AbuseAuditView extends EntityAuditView {
2022-06-03 16:17:28 +02:00
constructor (abuse: AdminAbuse) {
2020-07-01 16:05:30 +02:00
super(abuseKeysToKeep, 'abuse', abuse)
}
}
const customConfigKeysToKeep = [
'instance-name',
'instance-shortDescription',
'instance-description',
'instance-terms',
'instance-defaultClientRoute',
'instance-defaultNSFWPolicy',
'instance-customizations-javascript',
'instance-customizations-css',
'services-twitter-username',
'services-twitter-whitelisted',
'cache-previews-size',
'cache-captions-size',
'signup-enabled',
'signup-limit',
'signup-requiresEmailVerification',
'admin-email',
'user-videoQuota',
'transcoding-enabled',
'transcoding-threads',
'transcoding-resolutions'
]
class CustomConfigAuditView extends EntityAuditView {
constructor (customConfig: CustomConfig) {
const infos: any = customConfig
const resolutionsDict = infos.transcoding.resolutions
const resolutionsArray = []
2020-01-31 16:56:52 +01:00
Object.entries(resolutionsDict)
.forEach(([ resolution, isEnabled ]) => {
if (isEnabled) resolutionsArray.push(resolution)
})
2018-08-03 11:10:31 +02:00
Object.assign({}, infos, { transcoding: { resolutions: resolutionsArray } })
super(customConfigKeysToKeep, 'config', infos)
}
}
2018-07-31 14:02:47 +02:00
export {
2018-09-19 17:02:16 +02:00
getAuditIdFromRes,
2018-07-31 14:02:47 +02:00
auditLoggerFactory,
2018-08-03 10:26:47 +02:00
VideoImportAuditView,
VideoChannelAuditView,
CommentAuditView,
UserAuditView,
VideoAuditView,
2020-07-01 16:05:30 +02:00
AbuseAuditView,
CustomConfigAuditView
2018-07-31 14:02:47 +02:00
}