Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

app deployed #6

Merged
merged 1 commit into from
Jul 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docs-in-tickets",
"vendor": "vtexhelp",
"version": "1.0.0",
"version": "1.0.3",
"title": "Docs in Tickets",
"description": "Process information about documentation links sent in support tickets.",
"categories": [],
Expand Down
10 changes: 8 additions & 2 deletions node/clients/zendesk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

import { ExternalClient, IOContext, InstanceOptions } from '@vtex/api'

const username = 'xxxxxxxxxxxxxxxxxxxxxxxx'
const token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxx'
const username = 'xxxxxxxxxxxxxxxxx'
const token = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
const authValue = btoa(`${username}/token:${token}`)

// Below are sandbox auth variables, just to facilitate debugging. Note that the format is different.
// const username = 'xxxxxxxxxxxxxxxxx'
// const token = 'xxxxxxxxxxxxxxxxx'
// const authValue = btoa(`${username}:${token}`)

const requestHeaders = {
'Content-Type': 'application/json',
'Authorization': `Basic ${authValue}`,
Expand Down
7 changes: 3 additions & 4 deletions node/middlewares/processTicket.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// The processMessage function gets the ticket message from the context and formats its content to be saved in a database later.

import bodyParser from 'co-body'
import { or } from 'ramda'

import type { MessageData } from '../clients/redshift'
Expand All @@ -27,7 +26,8 @@ export async function processTicket(
) {
console.info('Running processTicket')

const requestBody = await bodyParser(ctx.req)
const requestBody = ctx.state.body
console.info(requestBody)
const zendeskTicket = requestBody.ticketId

const zendesk = ctx.clients.zendesk
Expand Down Expand Up @@ -99,8 +99,7 @@ export async function processTicket(

allCommentsWithUrls.push(messageData)

const redshiftResponse = await redshift.saveMessage(messageData)
console.log('redshift >>> '+JSON.stringify(redshiftResponse))
await redshift.saveMessage(messageData)
}
}

Expand Down
28 changes: 20 additions & 8 deletions node/middlewares/verifyZendeskSignature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
import bodyParser from 'co-body'
import * as crypto from 'crypto'

const ZENDESK_SECRET_KEY = "xxxxxxxxxxxxxxxxxxxxxxx"
const ZENDESK_SECRET_KEY_PRODUCTION = "xxxxxxxxxxxxxxxxx"
const ZENDESK_SECRET_KEY_SANDBOX = "xxxxxxxxxxxxxxxxxx"
const SIGNING_SECRET_ALGORITHM = "sha256"

export async function verifyZendeskSignature (
Expand All @@ -13,38 +14,49 @@ export async function verifyZendeskSignature (
console.info('Running verifyZendeskSignature')

// Determining whether the signature is compatible with the expected, according to the secret key provided by zendesk. This key is exclusive to this webhook.
function isValidSignature(signature: string, body: string, timestamp: string): boolean {
function isValidSignature(signature: string, body: object, timestamp: string, key: string): boolean {

console.info('Running isValidSignature')
let hmac = crypto.createHmac(SIGNING_SECRET_ALGORITHM, ZENDESK_SECRET_KEY)
let hmac = crypto.createHmac(SIGNING_SECRET_ALGORITHM, key)
let sig = hmac.update(timestamp + body).digest('base64')
const comparison = Buffer.compare(
Buffer.from(signature, 'base64'),
Buffer.from(sig.toString(), 'base64')
)

return (
comparison === 0
)
return (comparison === 0)
}

if (ctx.request.headers['x-zendesk-webhook-signature'] !== undefined) {
const requestBody = await bodyParser(ctx.req, { returnRawBody: true })
ctx.state.body = requestBody.parsed
console.info(ctx.state.body)
const requestSignature: string = ctx.request.headers["x-zendesk-webhook-signature"] as string
const requestSignatureTimestamp: string = ctx.request.headers["x-zendesk-webhook-signature-timestamp"] as string

if (isValidSignature(requestSignature, requestBody.raw, requestSignatureTimestamp)) {
if (isValidSignature(requestSignature, requestBody.raw, requestSignatureTimestamp, ZENDESK_SECRET_KEY_PRODUCTION)) {

console.info('Zendesk signature verified successfully.')
console.info('Zendesk production signature verified successfully.')
await next()

} else {

if (isValidSignature(requestSignature, requestBody.raw, requestSignatureTimestamp, ZENDESK_SECRET_KEY_SANDBOX)) {

console.info('Zendesk sandbox signature verified successfully.')
await next()

} else {

ctx.status = 400
ctx.response.body = {
message: 'Zendesk signature not valid.'
}
console.info('Zendesk signature not valid.')
return

}

}
} else {
ctx.status = 400
Expand Down
Loading