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

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.

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.

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:

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 …

…, 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:

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

Das Verarbeiten der Anforderung sieht dann wie folgt aus:

if (!shaSignature.localeCompare(gitHubSignature)) {

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

      ...   }
}
else {

   context.res = {

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

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

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.

Die Antwort bleibt natürlich gleich.

(ID:47138793)