Created
January 7, 2015 14:36
-
-
Save jplitza/88d64ce351d38c2f4198 to your computer and use it in GitHub Desktop.
A basic PHP webhook handler for Github, just verifying the signature and some variables before calling another command to do the actual work
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
// where to log errors and successful requests | |
define('LOGFILE', '/tmp/github-webhook.log'); | |
// what command to execute upon retrieval of a valid push event | |
$cmd = 'update-jekyll.sh 2>&1'; | |
// the shared secret, used to sign the POST data (using HMAC with SHA1) | |
$secret = '00000000000000000000000000000000'; | |
// receive POST data for signature calculation, don't change! | |
$post_data = file_get_contents('php://input'); | |
$signature = hash_hmac('sha1', $post_data, $secret); | |
// required data in POST body - set your targeted branch and repository here! | |
$required_data = array( | |
'ref' => 'refs/heads/master', | |
'repository' => array( | |
'full_name' => 'owner/repo', | |
), | |
); | |
// required data in headers - probably doesn't need changing | |
$required_headers = array( | |
'REQUEST_METHOD' => 'POST', | |
'HTTP_X_GITHUB_EVENT' => 'push', | |
'HTTP_USER_AGENT' => 'GitHub-Hookshot/*', | |
'HTTP_X_HUB_SIGNATURE' => 'sha1=' . $signature, | |
); | |
// END OF CONFIGURATION | |
error_reporting(0); | |
function log_msg($msg) { | |
if(LOGFILE != '') { | |
file_put_contents(LOGFILE, $msg . "\n", FILE_APPEND); | |
} | |
} | |
function array_matches($have, $should, $name = 'array') { | |
$ret = true; | |
if(is_array($have)) { | |
foreach($should as $key => $value) { | |
if(!array_key_exists($key, $have)) { | |
log_msg("Missing: $key"); | |
$ret = false; | |
} | |
else if(is_array($value) && is_array($have[$key])) { | |
$ret &= array_matches($have[$key], $value); | |
} | |
else if(is_array($value) || is_array($have[$key])) { | |
log_msg("Type mismatch: $key"); | |
$ret = false; | |
} | |
else if(!fnmatch($value, $have[$key])) { | |
log_msg("Failed comparison: $key={$have[$key]} (expected $value)"); | |
$ret = false; | |
} | |
} | |
} | |
else { | |
log_msg("Not an array: $name"); | |
$ret = false; | |
} | |
return $ret; | |
} | |
log_msg("=== Received request from {$_SERVER['REMOTE_ADDR']} ==="); | |
header("Content-Type: text/plain"); | |
$data = json_decode($post_data, true); | |
// First do all checks and then report back in order to avoid timing attacks | |
$headers_ok = array_matches($_SERVER, $required_headers, '$_SERVER'); | |
$data_ok = array_matches($data, $required_data, '$data'); | |
if($headers_ok && $data_ok) { | |
passthru($cmd); | |
} | |
else { | |
http_response_code(403); | |
die("Forbidden\n"); | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment