lib/webhook.ts
/*
* Copyright (c) 2014-2024 Bjoern Kimminich & the OWASP Juice Shop contributors.
* SPDX-License-Identifier: MIT
*/
import os from 'os'
import { promisify } from 'util'
import request from 'request'
import logger from './logger'
import config from 'config'
import colors from 'colors/safe'
import type { CoreOptions, RequestCallback, Request } from 'request'
import * as utils from './utils'
import { totalCheatScore } from './antiCheat'
// force type of post as promisify doesn't know which one it should take
const post = promisify(request.post as ((uri: string, options?: CoreOptions, callback?: RequestCallback) => Request))
export const notify = async (challenge: { key: any, name: any }, cheatScore = -1, webhook = process.env.SOLUTIONS_WEBHOOK) => {
if (!webhook) {
return
}
const res = await post(webhook, {
json: {
solution: {
challenge: challenge.key,
cheatScore,
totalCheatScore: totalCheatScore(),
issuedOn: new Date().toISOString()
},
ctfFlag: utils.ctfFlag(challenge.name),
issuer: {
hostName: os.hostname(),
os: `${os.type()} (${os.release()})`,
appName: config.get<string>('application.name'),
config: process.env.NODE_ENV ?? 'default',
version: utils.version()
}
}
})
logger.info(`Webhook ${colors.bold(webhook)} notified about ${colors.cyan(challenge.key)} being solved: ${res.statusCode < 400 ? colors.green(res.statusCode.toString()) : colors.red(res.statusCode.toString())}`)
}