Indefero Commit Details

Date:

2011-09-25 18:36:04 (13 years 2 months ago)

Author:

Thomas Keller

Branch:

develop, release-1.3

Commit:

920432025f6d8c2bc197bbf411fa77123f4005da

Parents:

7ff298af79f43a23d40633f608ef6749810eb3de

Message:

Change post-commit webhooks to issue PUTs instead of POST requests and generalize the HTTP header name for the auth digest; introduce an option to restore the old behaviour and document that; place a big warning in NEWS.mdtext about this change.

This change has been sponsored by Scilab.

Changes:

File differences

-6
7 7
8 8
9
10
11
12
13
14
15
16
17
9 18
10 19
11 20
+ATTENTION: You need Pluf [324ae60b](http://projects.ceondo.com/p/pluf/source/commit/324ae60b)␊
or newer to properly run this version of Indefero!␊
␊
## Changes␊
␊
- Indefero's post-commit web hook now by default issues HTTP PUT instead of␊
  HTTP POST requests and carries the authentication digest in the new␊
  `Web-Hook-Hmac` header.  The old behaviour can be re-enabled by setting the␊
  `$cfg['webhook_processing']` flag to "compat", we urge you to change the␊
  implementations of this web hook as this setting is likely to be removed␊
  in future versions of Indefero.␊
 ␊
## New Features␊
␊
- Indefero's issue tracker can now bi-directionally link issues with variable, configurable␊
 ATTENTION: You need Pluf [324ae60b](http://projects.ceondo.com/p/pluf/source/commit/324ae60b)␊
 or newer to properly run this version of Indefero!␊
 ␊
+## Changes␊
+␊
+- Indefero's post-commit web hook now by default issues HTTP PUT instead of␊
+  HTTP POST requests and carries the authentication digest in the new␊
+  `Web-Hook-Hmac` header.  The old behaviour can be re-enabled by setting the␊
+  `$cfg['webhook_processing']` flag to "compat", we urge you to change the␊
+  implementations of this web hook as this setting is likely to be removed␊
+  in future versions of Indefero.␊
+ ␊
 ## New Features␊
 ␊
 - Indefero's issue tracker can now bi-directionally link issues with variable, configurable␊

-287
288 288
289 289
290
291
292
293
294
295
290 296
291 297
292 298
... ...
299 305
300 306
301 307
302 
308
303 309
304 310
305 311
+        $url = str_replace(array('%p', '%r'),␊
                           array($project->shortname, $this->scm_id),␊
                           $conf->getVal('webhook_url', ''));␊
␊
        // trigger a POST instead of the standard PUT if we're asked for␊
        $method = 'PUT';␊
        if (Pluf::f('webhook_processing', '') === 'compat') {␊
            $method = 'POST';␊
        }␊
        $payload = array('to_send' => array(␊
                                            'project' => $project->shortname,␊
                                            'rev' => $this->scm_id,␊

                         'project_id' => $project->id,␊
                         'authkey' => $project->getWebHookKey(),␊
                         'url' => $url,␊
                         'method' => 'POST',␊
                         'method' => $method,␊
                         );␊
        $item = new IDF_Queue();␊
        $item->type = 'new_commit';␊
 ...
         $url = str_replace(array('%p', '%r'),␊
                            array($project->shortname, $this->scm_id),␊
                            $conf->getVal('webhook_url', ''));␊
+␊
+        // trigger a POST instead of the standard PUT if we're asked for␊
+        $method = 'PUT';␊
+        if (Pluf::f('webhook_processing', '') === 'compat') {␊
+            $method = 'POST';␊
+        }␊
         $payload = array('to_send' => array(␊
                                             'project' => $project->shortname,␊
                                             'rev' => $this->scm_id,␊
                          'project_id' => $project->id,␊
                          'authkey' => $project->getWebHookKey(),␊
                          'url' => $url,␊
-                         'method' => 'POST',␊
+                         'method' => $method,␊
                          );␊
         $item = new IDF_Queue();␊
         $item->type = 'new_commit';␊

-594
595 595
596 596
597
598
599
600
597 601
598 602
599 603
... ...
603 607
604 608
605 609
610
606 611
607 612
608 613
+                         'mtn' => __('monotone'),␊
                         );␊
        $repository_type = $options[$scm];␊
        $hook_request_method = 'PUT';␊
        if (Pluf::f('webhook_processing','') === 'compat') {␊
            $hook_request_method = 'POST';␊
        }␊
        return Pluf_Shortcuts_RenderToResponse('idf/admin/source.html',␊
                                               array(␊
                                                     'remote_svn' => $remote_svn,␊

                                                     'page_title' => $title,␊
                                                     'form' => $form,␊
                                                     'hookkey' => $prj->getWebHookKey(),␊
                                                     'hook_request_method' => $hook_request_method,␊
                                                     ),␊
                                               $request);␊
    }␊
 ...
                          'mtn' => __('monotone'),␊
                          );␊
         $repository_type = $options[$scm];␊
+        $hook_request_method = 'PUT';␊
+        if (Pluf::f('webhook_processing','') === 'compat') {␊
+            $hook_request_method = 'POST';␊
+        }␊
         return Pluf_Shortcuts_RenderToResponse('idf/admin/source.html',␊
                                                array(␊
                                                      'remote_svn' => $remote_svn,␊
                                                      'page_title' => $title,␊
                                                      'form' => $form,␊
                                                      'hookkey' => $prj->getWebHookKey(),␊
+                                                     'hook_request_method' => $hook_request_method,␊
                                                      ),␊
                                                $request);␊
     }␊

-39
40 40
41 41
42
43
44
45
46
42 47
43 48
49
44 50
45 51
46 52
47 53
48 54
49 
55
50 56
51 57
52 58
+    public static function processNotification($payload)␊
    {␊
        $data = json_encode($payload['to_send']);␊
        $sign_header = 'Web-Hook-Hmac';␊
        // use the old signature header if we're asked for␊
        if (Pluf::f('webhook_processing', '') === 'compat') {␊
            $sign_header = 'Post-Commit-Hook-Hmac';␊
        }␊
        $sign = hash_hmac('md5', $data, $payload['authkey']);␊
        $params = array('http' => array(␊
                      // fall-back to POST for old queue items␊
                      'method' => empty($payload['method']) ? 'POST' : $payload['method'],␊
                      'content' => $data,␊
                      'user_agent' => 'Indefero Hook Sender (http://www.indefero.net)',␊
                      'max_redirects' => 0,␊
                      'timeout' => 15,␊
                      'header'=> 'Post-Commit-Hook-Hmac: '.$sign."\r\n"␊
                      'header'=> $sign_header.': '.$sign."\r\n"␊
                                .'Content-Type: application/json'."\r\n",␊
                                        )␊
                        );␊
     public static function processNotification($payload)␊
     {␊
         $data = json_encode($payload['to_send']);␊
+        $sign_header = 'Web-Hook-Hmac';␊
+        // use the old signature header if we're asked for␊
+        if (Pluf::f('webhook_processing', '') === 'compat') {␊
+            $sign_header = 'Post-Commit-Hook-Hmac';␊
+        }␊
         $sign = hash_hmac('md5', $data, $payload['authkey']);␊
         $params = array('http' => array(␊
+                      // fall-back to POST for old queue items␊
                       'method' => empty($payload['method']) ? 'POST' : $payload['method'],␊
                       'content' => $data,␊
                       'user_agent' => 'Indefero Hook Sender (http://www.indefero.net)',␊
                       'max_redirects' => 0,␊
                       'timeout' => 15,␊
-                      'header'=> 'Post-Commit-Hook-Hmac: '.$sign."\r\n"␊
+                      'header'=> $sign_header.': '.$sign."\r\n"␊
                                 .'Content-Type: application/json'."\r\n",␊
                                         )␊
                         );␊

-495
496 496
497 497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
498 513
499 514
+# always have precedence.␊
# $cfg['max_upload_size'] = 2097152; // Size in bytes␊
␊
# Older versions of Indefero submitted a POST request to a configured␊
# post-commit web hook when new revisions arrived, whereas a PUT request␊
# would have been more appropriate.  Also, the payload's HMAC digest was␊
# submitted as value of the HTTP header 'Post-Commit-Hook-Hmac' during␊
# such a request.  Since newer versions of Indefero use the same authentication␊
# mechanism (based on the same secret key) for other web hooks of the same␊
# project as well, the name of this HTTP header was no longer appropriate ␊
# and as such changed to simply 'Web-Hook-Hmac'.␊
#␊
# Setting the following configuration option to 'compat' now restores the␊
# old behaviour in both cases. Please notice however that this compatibility␊
# option is likely to go away in the next major version of Indefero, so you␊
# should really change the other end of your web hooks!␊
$cfg['webhook_processing'] = 'compat';␊
␊
return $cfg;␊
␊
 # always have precedence.␊
 # $cfg['max_upload_size'] = 2097152; // Size in bytes␊
 ␊
+# Older versions of Indefero submitted a POST request to a configured␊
+# post-commit web hook when new revisions arrived, whereas a PUT request␊
+# would have been more appropriate.  Also, the payload's HMAC digest was␊
+# submitted as value of the HTTP header 'Post-Commit-Hook-Hmac' during␊
+# such a request.  Since newer versions of Indefero use the same authentication␊
+# mechanism (based on the same secret key) for other web hooks of the same␊
+# project as well, the name of this HTTP header was no longer appropriate ␊
+# and as such changed to simply 'Web-Hook-Hmac'.␊
+#␊
+# Setting the following configuration option to 'compat' now restores the␊
+# old behaviour in both cases. Please notice however that this compatibility␊
+# option is likely to go away in the next major version of Indefero, so you␊
+# should really change the other end of your web hooks!␊
+$cfg['webhook_processing'] = 'compat';␊
+␊
 return $cfg;␊
 ␊

-67
68 68
69 69
70 
71 
72 
70
71
72
73 73
74 74
75 75
+<br>␊
<div class="issue-submit-info">␊
␊
{blocktrans}<p>The webhook URL setting specifies an URL to which a HTTP POST␊
request is sent after each repository commit. If this field is empty,␊
notifications are disabled.</p>␊
{blocktrans}<p>The webhook URL setting specifies an URL to which a HTTP ␊
<strong>{$hook_request_method}</strong> request is sent after each repository␊
commit. If this field is empty, notifications are disabled.</p>␊
␊
<p>Only properly-escaped <strong>HTTP</strong> URLs are supported, for example:</p>␊
␊
 <br>␊
 <div class="issue-submit-info">␊
 ␊
-{blocktrans}<p>The webhook URL setting specifies an URL to which a HTTP POST␊
-request is sent after each repository commit. If this field is empty,␊
-notifications are disabled.</p>␊
+{blocktrans}<p>The webhook URL setting specifies an URL to which a HTTP ␊
+<strong>{$hook_request_method}</strong> request is sent after each repository␊
+commit. If this field is empty, notifications are disabled.</p>␊
 ␊
 <p>Only properly-escaped <strong>HTTP</strong> URLs are supported, for example:</p>␊
 ␊

Download the corresponding diff file

Indefero

File differences

Branches

Tags