@bowtie/sls
Version:
Serverless helpers & utilities
196 lines (160 loc) • 10.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>validator.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#actionFailureNotifySlack">actionFailureNotifySlack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#bitbucketWebhook">bitbucketWebhook</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChange">buildChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifyBitbucket">buildChangeNotifyBitbucket</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifyGithub">buildChangeNotifyGithub</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#buildChangeNotifySlack">buildChangeNotifySlack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#decodeBody">decodeBody</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployBuild">deployBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployEcr">deployEcr</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deploymentNotifyAirbrake">deploymentNotifyAirbrake</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployments">deployments</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#deployS3">deployS3</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#describeStack">describeStack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findClusterName">findClusterName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findClusterStack">findClusterStack</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#findMigrationTask">findMigrationTask</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getStatusColor">getStatusColor</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#githubWebhook">githubWebhook</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#init">init</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#initMigration">initMigration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#parseBody">parseBody</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#parsePayload">parsePayload</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#prepareBuild">prepareBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#runMigration">runMigration</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#slackCommand">slackCommand</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#slackResponse">slackResponse</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#stackChange">stackChange</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#startBuild">startBuild</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#trackBuild">trackBuild</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">validator.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const https = require('https')
const crypto = require('crypto')
const config = require('./config');
/**
* Validate Bitbucket webhook source using User-Agent header
* @param {object} event
*/
module.exports.bitbucketWebhook = (event) => {
// Return a promise for the promise chain
return new Promise(
(resolve, reject) => {
// Ensure the body exists
if (!event.body) {
reject(new Error('Event has no body.'))
return
}
// Ensure the headers contain a User-Agent
if (!event.headers['User-Agent']) {
reject(new Error('Missing User-Agent header.'))
return
}
// Ensure webhook is coming from bitbucket
if (event.headers['User-Agent'].indexOf('Bitbucket-Webhooks') === 0) {
resolve(event)
} else {
reject(new Error('Invalid User-Agent header'))
}
}
)
}
/**
* Validate github webhooks
*/
module.exports.githubWebhook = (event) => {
// Return a promise for the promise chain
return new Promise(
(resolve, reject) => {
// Ensure the body exists
if (!event.body) {
reject(new Error('Event has no body.'))
return
}
// Ensure the headers contain a Signature
if (!event.headers['x-hub-signature'] && !event.headers['X-Hub-Signature']) {
reject(new Error('Missing signature header.'))
return;
}
const signatureHeader = event.headers['x-hub-signature'] || event.headers['X-Hub-Signature']
const signatureParts = signatureHeader.split('=')
if (signatureParts.length !== 2) {
reject(new Error('Unknown signature header format.'))
return
}
const signatureAlgorithm = signatureParts[0]
const signatureReceived = signatureParts[1]
const signatureComputed = crypto.createHmac(signatureAlgorithm, event.service.github.secret).update(event.body).digest('hex')
if (signatureComputed === signatureReceived) {
resolve(event)
} else {
reject(new Error('Invalid github signature.'))
}
}
)
}
/**
* Validate Slack slash command events
*/
module.exports.slackCommand = (event) => {
// Return a promise for the promise chain
return new Promise(
(resolve, reject) => {
// Ensure the body has been parsed
if (!event.parsed.body) {
reject(new Error('No body has been parsed.'))
return
}
// Ensure the parsed body contains a token
if (!event.parsed.body.token) {
reject(new Error('Missing token in parsed body.'))
return
}
// Compare the parsed body token to the token in the config
if (event.parsed.body.token === event.service.slack.token) {
// Resolve if tokens match!
resolve(event)
} else {
// Reject if tokens do not match
reject(new Error('Invalid slack verification token.'))
}
}
)
}
/**
* Validate Slack response events
*/
module.exports.slackResponse = (event) => {
// Return a promise for the promise chain
return new Promise(
(resolve, reject) => {
// Ensure the payload has been parsed
if (!event.parsed.payload) {
reject(new Error('No payload has been parsed.'))
return
}
// Ensure the parsed payload contains a token
if (!event.parsed.payload.token) {
reject(new Error('Missing token in parsed payload.'))
return
}
// Compare the parsed payload token to the token in the config
if (event.parsed.payload.token === event.service.slack.token) {
// Resolve if tokens match!
resolve(event)
} else {
// Reject if tokens do not match
reject(new Error('Invalid slack verification token.'))
}
}
)
}
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed Apr 10 2024 18:08:07 GMT-0600 (Mountain Daylight Time) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>