Webhooks beim Serverless Development nutzen, Teil 4 Webhook für Azure Function per API Key absichern

Autor / Redakteur: Dipl. -Ing. Thomas Drilling / Stephan Augsten

Webhooks eignen sich wunderbar dazu, Aktionen bei bestimmten Server-Ereignissen anzustoßen, nur sind sie von Haus aus nicht sonderlich sicher. Ein API Key soll den Zugriff auf unsere in diesem Tutorial erstellte Azure Function künftig absichern.

Firma zum Thema

In den Webhooks-Einstellungen von GitHub können wir ein eigenes Secret für unsere Payload-URL hinterlegen.
In den Webhooks-Einstellungen von GitHub können wir ein eigenes Secret für unsere Payload-URL hinterlegen.
(Bild: Drilling / GitHub)

Unsere Azure-Function horcht auf jede Nutzlast, die vom konfigurierten Endpunkt gesendet wird, sobald sie zum Empfang von Nutzlasten konfiguriert ist. Oft möchte man aber aus Sicherheitsgründen nur Anforderungen von beispielsweise GitHub akzeptieren und von nirgendwo anders her.

Für ein solches Unterfangen sind verschiedene Möglichkeiten denkbar. Man könnte Anforderungen z. B. nur von GitHub-IP-Adressen erlauben. Professioneller und trotzdem einfacher einzurichten ist es, ein geheimes Token zu konfigurieren und Anforderung nur bei validem Token zuzulassen.

Für die Konfiguration eines Webhooks steht unter GitHub das Feld „Secret“ zur Verfügung
Für die Konfiguration eines Webhooks steht unter GitHub das Feld „Secret“ zur Verfügung
(Bild: Drilling / GitHub)

Mit dem Einrichten eines Webhook-Secrets kann man sicherstellen, dass an die Nutzlast-URL gesendete POST-Anforderungen von GitHub sind. Dazu steht beim Konfigurieren eines Webhooks das bisher nicht besprochene Feld „Secret“ zur Verfügung. Wenn man so ein Geheimnis festlegt, erhält die Webhook-POST-Anforderung den x-hub-signature-Header.

Zur Vorbereitung der Secret-Verwendung in unsere Azure-Function navigieren wir im Azure-Portal erneut zu unserer Funktion und bearbeiten wieder unsere JavaScript-Datei index.js und ergänzen am Anfang der Datei einen Verweis auf die crypto-js-Bibliothek mit Hilfe der module.exports-Anweisung:

const Crypto = require('crypto');

Im Bereich „Funktionsschlüssel“ unter Azure können wir den bestehenden Default-Schlüsselwert in die Zwischenablage kopieren.
Im Bereich „Funktionsschlüssel“ unter Azure können wir den bestehenden Default-Schlüsselwert in die Zwischenablage kopieren.
(Bild: Drilling / Microsoft)

Dann wechseln wir im Menü „Entwickler“ links zum Abschnitt „Funktionsschlüssel“ und zeigen den Wert des Standardschlüssels „default“. Dazu klickt man auf „Werte anzeigen“.

Nun können wir den bestehenden Default-Schlüsselwert in die Zwischenablage kopieren, wechseln dann zurück zum Funktions-Editor und ergänzen …

const hmac = Crypto.createHmac("sha1", "<default key>");
const signature = hmac.update(JSON.stringify(req.body)).digest('hex');

…, wobei der „<default key>“ entsprechend zu ersetzen ist.

Damit der Schlüssel allerdings dem Format von x-hub-signature im Anforderungs-Header entspricht, müssen wir noch ein „sha1=“ zu Beginn des Schlüssels einfügen:

const shaSignature = 'sha1=${signature}';

Dann müssen wir noch den Code zum Abrufen der GitHub-Signatur aus dem Anforderungs-Header ergänzen:

const gitHubSignature = req.headers['x-hub-signature'];

Das Verarbeiten der Anforderung sieht dann wie folgt aus:

Der aktualisierte http-Trigger mit API-Keys.
Der aktualisierte http-Trigger mit API-Keys.
(Bild: Drilling / Microsoft)

if (!shaSignature.localeCompare(gitHubSignature)) {

   // Existing code
   if (req.body.pages[0].title) {

      ...   }
}
else {

   context.res = {

      status: 401,
      body: "Signatures don't match"
   };
}

Das in der Webhook-Konfiguration ergänzte Secret.
Das in der Webhook-Konfiguration ergänzte Secret.
(Bild: Drilling / GitHub)

Jetzt müssen wie das Geheimnis natürlich nur in unseren Webhook-Settings auf GitHub eintragen.

Der „x-Hub-Signature“-Header.
Der „x-Hub-Signature“-Header.
(Bild: Drilling / Microsoft)

Klicken wir nun nach dem Anlegen einer neuen Wiki-Seite oder dem Bearbeiten einer Vorhandenen erneut auf „Update Webhook“, wird im Request-Header die „x-Hub-Signature“ angezeigt werden.

Das Ergebnis der Webhook-Analyse.
Das Ergebnis der Webhook-Analyse.
(Bild: Drilling / Microsoft)

Die Antwort bleibt natürlich gleich.

(ID:47138793)

Über den Autor

Dipl. -Ing. Thomas Drilling

Dipl. -Ing. Thomas Drilling

IT-Consultant, Trainer, Freier Journalist