Merge pull request #43 from cernops/gitlab_token

Add support for Gitlab tokens

Author: nbarrientos

INSTALL.md

@@ -356,6 +356,20 @@ are enqueued:
 INFO 2015-12-10T14:43:01.705468 - hostgroups/foo - '0000003c/56698165ac7909' added to the queue
 ```
 
+Requests can be authenticated using a [secret
+token](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#validate-payloads-by-using-a-secret-token)
+which has to be configured both on the Gitlab side (via the group or
+repository settings) and on the Jens side via:
+
+```ini
+[gitlabproducer]
+secret_token = your_token_here
+```
+
+If there's no token set (default) then all requests will be accepted
+regardless of the presence or the value of the header
+`X-Gitlab-Token`.
+
 ### Setting a timeout for Git operations via SSH
 
 To protect Jens from hanging indefinitely in case of a lack of response from

conf/main.conf

@@ -29,3 +29,6 @@ queuedir = /var/spool/jens-update
 
 [git]
 ssh_cmd_path = /etc/jens/myssh.sh
+
+[gitlabproducer]
+secret_token = placeholder

jens/configfile.py

@@ -31,4 +31,6 @@
 queuedir = string(default='/var/spool/jens-update')
 [git]
 ssh_cmd_path = string(default=None)
+[gitlabproducer]
+secret_token = string(default=None)
 """

jens/settings.py

@@ -76,6 +76,9 @@ def parse_config(self, config_file_path):
         # [git]
         self.SSH_CMD_PATH = config["git"]["ssh_cmd_path"]
 
+        # [gitlabproducer]
+        self.GITLAB_PRODUCER_SECRET_TOKEN = config["gitlabproducer"]["secret_token"]
+
         if self.logfile:
             logging.basicConfig(
                 level=getattr(logging, self.DEBUG_LEVEL),

jens/webapps/gitlabproducer.py

@@ -27,6 +27,13 @@ def hello_gitlab():
         payload = request.get_json(silent=True) or {}
         if payload:
             logging.debug('Incoming request with payload: %s' % str(payload))
+
+        if settings.GITLAB_PRODUCER_SECRET_TOKEN:
+            server_token = request.headers.get('X-Gitlab-Token')
+            if server_token != settings.GITLAB_PRODUCER_SECRET_TOKEN:
+                logging.error("Bad Gitlab Token (%s)", server_token)
+                return 'Unauthorised', 401
+
         try:
             url = payload['repository']['git_ssh_url']
         except (KeyError, TypeError) as error:

jens/webapps/test/test_gitlabproducer.py

@@ -84,3 +84,62 @@ def test_repository_not_found(self):
                         }
                     }))
         self.assertEqual(reply.status_code, 404)
+
+    @patch('jens.webapps.gitlabproducer.enqueue_hint')
+    def test_secret_token_ignored_if_not_configured(self, mock_eq):
+        self.settings.GITLAB_PRODUCER_SECRET_TOKEN = None
+        _payload = {
+            'repository': {
+                'name': 'it-puppet-site',
+                'git_ssh_url': "file://%s" % self.site_bare
+            }
+        }
+        reply = self.app.post('/gitlab',
+                              content_type='application/json',
+                              headers={'X-Gitlab-Token': 'tokenvalue'},
+                              data=json.dumps(_payload))
+        mock_eq.assert_called_once_with('common', 'site')
+        self.assertEqual(reply.status_code, 200)
+
+    def test_wrong_secret_token(self):
+        self.settings.GITLAB_PRODUCER_SECRET_TOKEN = 'expected'
+        _payload = {
+            'repository': {
+                'name': 'it-puppet-site',
+                'git_ssh_url': "file://%s" % self.site_bare
+            }
+        }
+        reply = self.app.post('/gitlab',
+                              content_type='application/json',
+                              data=json.dumps(_payload))
+        self.assertEqual(reply.status_code, 401)
+
+    def test_secret_token_configured_wrong_token(self):
+        self.settings.GITLAB_PRODUCER_SECRET_TOKEN = 'expected'
+        _payload = {
+            'repository': {
+                'name': 'it-puppet-site',
+                'git_ssh_url': "file://%s" % self.site_bare
+            }
+        }
+        reply = self.app.post('/gitlab',
+                              content_type='application/json',
+                              headers={'X-Gitlab-Token': 'tokenvalue'},
+                              data=json.dumps(_payload))
+        self.assertEqual(reply.status_code, 401)
+
+    @patch('jens.webapps.gitlabproducer.enqueue_hint')
+    def test_secret_token_configured_good_token(self, mock_eq):
+        self.settings.GITLAB_PRODUCER_SECRET_TOKEN = 'expected'
+        _payload = {
+            'repository': {
+                'name': 'it-puppet-site',
+                'git_ssh_url': "file://%s" % self.site_bare
+            }
+        }
+        reply = self.app.post('/gitlab',
+                              content_type='application/json',
+                              headers={'X-Gitlab-Token': 'expected'},
+                              data=json.dumps(_payload))
+        mock_eq.assert_called_once_with('common', 'site')
+        self.assertEqual(reply.status_code, 200)