GitHub Webhooks杂记

请移步到我的Blog,获得更好的阅读体验!本文的链接请点这里

我的blog的文章是使用gitbook关联github仓库,用gitbook写文章,然后push到github。这就产生了问题,怎么把文章关联到我的blog呢?这就需要使用GitHub的 Webhooks了。

GitHub Webhooks

Webhooks是GitHub提供的一个API。Webhooks可以在GitHub仓库(repositories)发生事件(比如提交代码,创建分支,发布版本)时,通知到其他服务器。官方介绍点这里

用途

Webhooks可以用来触发CI,更新备份,更新生产环境等。

怎么使用GitHub Webhooks?

我们需要创建一个web服务器来接收Webhooks的请求,这里我使用nodejs来搭建:

const polka = require('polka');
const crypto = require('crypto');
const { json } = require('body-parser');

polka()
.use(json())
.post('/github-webhooks', (req, res) => {
    res.writeHead(200);
    res.end('webhooks success');
})
.listen(4000, err => {
    if (err) throw err;
    console.log(`> Running on localhost:4000`);
});

{% hint style="info" %}
polka是一个很小的http服务器,这里当成express来使用就可以了
{% endhint %}

很简单的一个例子,接收post请求,返回'webhooks success',具体业务就不写啦。

接下来,需要打开我们的GitHub仓库界面,点这里的Settings:

[图片上传失败...(image-f20c94-1563087198853)]

然后再点左侧栏的Webhooks,右边有Add werbhook按钮,点击增加Webhook:

[图片上传失败...(image-8eda08-1563087198853)]

Payload URL中输入我们的接口地址

Content type选择application/json

Secret是用来做加密验证的,可以随便填一些字符串,我们这里推荐填随机生成的字符串.也就是当GitHub访问我们的接口时会带上签名,我们的服务器需要进行验证,验证通过才能执行业务逻辑

add webhook

输入完成后,点击下面的绿色Add webpack按钮,GitHub会ping我们的接口,测试我们的接口能不能正常接收请求.

这个页面下面就出现一条ping的请求,可以看到,我们的例子接口是可以正常请求的。

[图片上传失败...(image-ef221d-1563087198853)]

Secret签名验证怎么做?

我们在GitHub上输入Secret后,需要在服务器中去验证签名,GitHub签名是使用 HMAC 来做加密验证的,我们需要把GitHub的hook传递过来的request.body转成字符串,然后去进行加密,加密后得到的字符串去跟请求头中的`x-hub-signature`参数做比较,如果一致则验证通过。下面是nodejs的代码实现:

const polka = require('polka');
const crypto = require('crypto');
const crypto = require('crypto');
const { json } = require('body-parser');

const SECRET_TOKEN = '在Secret中输入的字符串'

polka()
.use(json())
.post('/github-webhooks', (req, res) => {
  const reg = /^sha1=/;
  let sha1 = req.headers['x-hub-signature'];
  if (reg.test(sha1)) {
  
    sha1 = sha1.replace(reg, '');
  
    const payload = JSON.stringify(req.body);
  
    const hash = crypto.createHmac('sha1', SECRET_TOKEN).update(payload);
  
    const token = hash.digest('hex');
  
    if (token !== sha1) {
      res.writeHead(401)
      res.end('unauthorized');
      return;
    }
    res.writeHead(200);
    res.end('webhooks success');
    return;
  } else {
    res.writeHead(401)
    res.end('unauthorized');
    return;
  }
})
.listen(4000, err => {
    if (err) throw err;
    console.log(`> Running on localhost:4000`);
});

这样,加密签名验证就完成啦。

后面会分享关于GitHub的release和tags的hook使用,当前就结束啦

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容