Native Messaging

Erweiterungen, die mit einer nativen Anwendung kommunizieren:

• Setzen Sie die "nativeMessaging"-Berechtigung oder optionale Berechtigung in der manifest.json Datei.
• Geben Sie Ihre Add-on-ID explizit an. Verwenden Sie den browser_specific_settings Manifestschlüssel. (Das App-Manifest wird den Satz von Erweiterungen identifizieren, die eine Verbindung zu den IDs ermöglichen).

Beispiel manifest.json-Datei:

{
  "description": "Native messaging example add-on",
  "manifest_version": 2,
  "name": "Native messaging example",
  "version": "1.0",
  "icons": {
    "48": "icons/message.svg"
  },

  "browser_specific_settings": {
    "gecko": {
      "id": "ping_pong@example.org",
      "strict_min_version": "50.0"
    }
  },

  "background": {
    "scripts": ["background.js"]
  },

  "browser_action": {
    "default_icon": "icons/message.svg"
  },

  "permissions": ["nativeMessaging"]
}

Das App-Manifest beschreibt dem Browser, wie es eine Verbindung zur nativen Anwendung herstellen kann.

Die App-Manifest-Datei muss zusammen mit der nativen Anwendung installiert werden. Der Browser liest und validiert App-Manifest-Dateien, installiert oder verwaltet sie jedoch nicht. Das Sicherheitsmodell für die Installation und Aktualisierung dieser Dateien ähnelt mehr dem für native Anwendungen als dem für Erweiterungen mit WebExtension-APIs.

Details zur Syntax und zum Standort des nativen App-Manifests finden Sie unter Native Manifests.

Zum Beispiel hier ein Manifest für die "ping_pong"-native Anwendung:

{
  "name": "ping_pong",
  "description": "Example host for native messaging",
  "path": "/path/to/native-messaging/app/ping_pong.py",
  "type": "stdio",
  "allowed_extensions": ["ping_pong@example.org"]
}

Dies ermöglicht es der Erweiterung mit der ID "ping_pong@example.org", eine Verbindung herzustellen, indem der Name "ping_pong" in die relevante runtime-API-Funktion übergeben wird. Die Anwendung selbst befindet sich unter "/path/to/native-messaging/app/ping_pong.py".

Als Beispiel können Sie auch das Readme zur Native-Messaging-Erweiterung auf GitHub heranziehen. Wenn Sie Ihre lokale Einrichtung nach dem Forken dieses Repositories auf einem Windows-Rechner überprüfen möchten, können Sie check_config_win.py ausführen, um einige Probleme zu beheben.

App-Manifest

Im obigen Beispiel ist die native Anwendung ein Python-Skript. Es kann schwierig sein, Windows dazu zu bringen, Python-Skripte zuverlässig auf diese Weise auszuführen, daher ist eine Alternative, eine .bat-Datei bereitzustellen und in der Anwendungsmanifestdatei darauf zu verlinken:

{
  "name": "ping_pong",
  "description": "Example host for native messaging",
  "path": "c:\\path\\to\\native-messaging\\app\\ping_pong_win.bat",
  "type": "stdio",
  "allowed_extensions": ["ping_pong@example.org"]
}

(Siehe den Hinweis oben zur Chrome-Kompatibilität bezüglich des allowed_extensions-Schlüssels und seines Gegenstücks in Chrome).

Die Batch-Datei ruft dann das Python-Skript auf:

@echo off

python -u "c:\\path\\to\\native-messaging\\app\\ping_pong.py"

Registry

Der Browser findet die Erweiterung basierend auf Registrierungsschlüsseln, die an einem bestimmten Ort platziert sind. Sie müssen sie entweder programmatisch mit Ihrer endgültigen Anwendung hinzufügen oder manuell, wenn Sie das Beispiel von GitHub verwenden. Weitere Details finden Sie unter Manifeststandort.

Weiter mit dem ping_pong-Beispiel, wenn Sie Firefox verwenden (siehe diese Seite für Chrome), sollte einer der beiden Registrierungseinträge für die Nachrichtenübermittlung erstellt werden:

• HKEY_CURRENT_USER\Software\Mozilla\NativeMessagingHosts\ping_pong
• HKEY_LOCAL_MACHINE\Software\Mozilla\NativeMessagingHosts\ping_pong

Der Standardwert für den Schlüssel sollte der Pfad zum Anwendungs-Manifest sein: z. B. C:\Users\<myusername>\webextensions-examples\native-messaging\app\ping_pong.json.

Angesichts der oben genannten Einrichtung kann eine Erweiterung JSON-Nachrichten mit einer nativen Anwendung austauschen.

Native Messaging kann nicht direkt in Inhalts-Skripts verwendet werden. Sie müssen es indirekt über Hintergrundskripts tun.

Es gibt zwei Muster, die Sie hier verwenden können: verbindungsbasierte Nachrichtenübermittlung und verbindungslos Nachrichtenübermittlung.

Verbindungsbasierte Nachrichtenübermittlung

Mit diesem Muster rufen Sie runtime.connectNative() auf und übergeben den Namen der Anwendung (den Wert der "name"-Eigenschaft im App-Manifest). Dies startet die Anwendung, wenn sie nicht bereits läuft und gibt ein runtime.Port-Objekt an die Erweiterung zurück.

Zwei Argumente werden an die native App übergeben, wenn sie startet:

• Der vollständige Pfad zum App-Manifest.
• (neu in Firefox 55) die ID (wie im browser_specific_settings manifest.json Schlüssel angegeben) des Add-ons, das sie gestartet hat.

Die Anwendung bleibt in Betrieb, bis die Erweiterung Port.disconnect() aufruft oder die Seite, die mit ihr verbunden ist, geschlossen wird.

Um Nachrichten mit Port zu senden, rufen Sie ihre postMessage()-Funktion auf und übergeben die zu sendende JSON-Nachricht. Um auf Nachrichten mittels Port zu hören, fügen Sie den Listener mit ihrer onMessage.addListener()-Funktion hinzu.

Hier ist ein Beispiel eines Hintergrundskriptes, das eine Verbindung zur "ping_pong"-App herstellt, auf Nachrichten von ihr hört und dann eine "ping"-Nachricht sendet, wann immer der Benutzer auf die Browser-Aktion klickt:

/*
On startup, connect to the "ping_pong" app.
*/
let port = browser.runtime.connectNative("ping_pong");

/*
Listen for messages from the app.
*/
port.onMessage.addListener((response) => {
  console.log(`Received: ${response}`);
});

/*
On a click on the browser action, send the app a message.
*/
browser.browserAction.onClicked.addListener(() => {
  console.log("Sending:  ping");
  port.postMessage("ping");
});

Verbindungslos Nachrichtenübermittlung

Mit diesem Muster rufen Sie runtime.sendNativeMessage() auf, indem Sie es übergeben:

• den Namen der Anwendung
• die zu sendende JSON-Nachricht
• optional, einen Callback.

Für jede Nachricht wird eine neue Instanz der App erstellt. Die App erhält beim Starten zwei Argumente:

• den vollständigen Pfad zum App-Manifest
• (neu in Firefox 55) die ID (wie in den browser_specific_settings manifest.json Schlüssel angegeben) des Add-ons, das es gestartet hat.

Die erste Nachricht, die von der App gesendet wird, wird als Antwort auf den Aufruf von sendNativeMessage() behandelt und wird in den Callback eingespeist.

Hier ist das obige Beispiel, umgeschrieben, um runtime.sendNativeMessage() zu verwenden:

function onResponse(response) {
  console.log(`Received ${response}`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

/*
On a click on the browser action, send the app a message.
*/
browser.browserAction.onClicked.addListener(() => {
  console.log("Sending:  ping");
  let sending = browser.runtime.sendNativeMessage("ping_pong", "ping");
  sending.then(onResponse, onError);
});

Auf der Seite der Anwendung nutzen Sie den Standard-Eingang, um Nachrichten zu empfangen und den Standard-Ausgang, um sie zu senden.

Jede Nachricht wird mit JSON serialisiert, UTF-8 kodiert und wird mit einem vorangestellten 32-Bit-Wert versehen, der die Nachrichtenlänge in der Byte-Reihenfolge des Hostsystems enthält.

Die maximale Größe einer einzelnen Nachricht von der Anwendung beträgt 1 MB. Die maximale Größe einer an die Anwendung gesendeten Nachricht beträgt 4 GB.

Sie können schnell mit dem Senden und Empfangen von Nachrichten mit diesem NodeJS-Code nm_nodejs.mjs anfangen:

#!/usr/bin/env -S /full/path/to/node

import fs from "node:fs/promises";

async function getMessage() {
  const header = new Uint32Array(1);
  await readFullAsync(1, header);
  const message = await readFullAsync(header[0]);
  return message;
}

async function readFullAsync(length, buffer = new Uint8Array(65536)) {
  const data = [];
  while (data.length < length) {
    const input = await fs.open("/dev/stdin");
    const { bytesRead } = await input.read({ buffer });
    await input.close();
    if (bytesRead === 0) {
      break;
    }
    data.push(...buffer.subarray(0, bytesRead));
  }
  return new Uint8Array(data);
}

async function sendMessage(message) {
  const header = Buffer.from(new Uint32Array([message.length]).buffer);
  const stdout = process.stdout;
  await stdout.write(header);
  await stdout.write(message);
}

while (true) {
  try {
    const message = await getMessage();
    await sendMessage(message);
  } catch (e) {
    console.error(e);
    process.exit(1);
  }
}

Hier ist ein weiteres Beispiel, das in Python geschrieben ist. Es hört auf Nachrichten von der Erweiterung. Beachten Sie, dass die Datei unter Linux ausführbar sein muss. Wenn die Nachricht "ping" lautet, antwortet sie mit einer Nachricht "pong".

Das ist die Python 2 Version:

#!/usr/bin/env -S python2 -u

# Note that running python with the `-u` flag is required on Windows,
# in order to ensure that stdin and stdout are opened in binary, rather
# than text, mode.

import json
import sys
import struct

# Read a message from stdin and decode it.
def get_message():
    raw_length = sys.stdin.read(4)
    if not raw_length:
        sys.exit(0)
    message_length = struct.unpack('=I', raw_length)[0]
    message = sys.stdin.read(message_length)
    return json.loads(message)

# Encode a message for transmission, given its content.
def encode_message(message_content):
    # https://docs.python.org/3/library/json.html#basic-usage
    # To get the most compact JSON representation, you should specify
    # (',', ':') to eliminate whitespace.
    # We want the most compact representation because the browser rejects
    # messages that exceed 1 MB.
    encoded_content = json.dumps(message_content, separators=(',', ':'))
    encoded_length = struct.pack('=I', len(encoded_content))
    return {'length': encoded_length, 'content': encoded_content}

# Send an encoded message to stdout.
def send_message(encoded_message):
    sys.stdout.write(encoded_message['length'])
    sys.stdout.write(encoded_message['content'])
    sys.stdout.flush()

while True:
    message = get_message()
    if message == "ping":
        send_message(encode_message("pong"))

In Python 3 müssen die empfangenen Binärdaten in einen String dekodiert werden. Der Inhalt, der an das Add-On zurückgesendet werden soll, muss unter Verwendung eines Structs in Binärdaten kodiert werden:

#!/usr/bin/env -S python3 -u

# Note that running python with the `-u` flag is required on Windows,
# in order to ensure that stdin and stdout are opened in binary, rather
# than text, mode.

import sys
import json
import struct

# Read a message from stdin and decode it.
def getMessage():
    rawLength = sys.stdin.buffer.read(4)
    if len(rawLength) == 0:
        sys.exit(0)
    messageLength = struct.unpack('@I', rawLength)[0]
    message = sys.stdin.buffer.read(messageLength).decode('utf-8')
    return json.loads(message)

# Encode a message for transmission,
# given its content.
def encodeMessage(messageContent):
    # https://docs.python.org/3/library/json.html#basic-usage
    # To get the most compact JSON representation, you should specify
    # (',', ':') to eliminate whitespace.
    # We want the most compact representation because the browser rejects # messages that exceed 1 MB.
    encodedContent = json.dumps(messageContent, separators=(',', ':')).encode('utf-8')
    encodedLength = struct.pack('@I', len(encodedContent))
    return {'length': encodedLength, 'content': encodedContent}

# Send an encoded message to stdout
def sendMessage(encodedMessage):
    sys.stdout.buffer.write(encodedMessage['length'])
    sys.stdout.buffer.write(encodedMessage['content'])
    sys.stdout.buffer.flush()

while True:
    receivedMessage = getMessage()
    if receivedMessage == "ping":
        sendMessage(encodeMessage("pong"))

Wenn Sie sich mit der nativen Anwendung über runtime.connectNative() verbunden haben, bleibt sie in Betrieb, bis die Erweiterung Port.disconnect() aufruft oder die Seite, die mit ihr verbunden ist, geschlossen wird. Wenn Sie die native Anwendung durch Senden von runtime.sendNativeMessage() gestartet haben, wird sie geschlossen, nachdem sie die Nachricht empfangen und eine Antwort gesendet hat.

Um die native Anwendung zu schließen:

• Auf *nix-Systemen wie macOS und Linux sendet der Browser SIGTERM an die native Anwendung, dann SIGKILL, nachdem die Anwendung die Möglichkeit hatte, sich ordnungsgemäß zu beenden. Diese Signale werden an alle Unterprozesse weitergegeben, es sei denn, sie trennen sich in eine neue Prozessgruppe.
• Unter Windows platziert der Browser den Prozess der nativen Anwendung in ein Job-Objekt und beendet das Job-Objekt. Wenn die native Anwendung zusätzliche Prozesse startet und diese offen bleiben sollen, nachdem die native Anwendung geschlossen wurde, muss die native Anwendung den zusätzlichen Prozess mit dem CREATE_BREAKAWAY_FROM_JOB Flag starten, etwa durch die Verwendung von CreateProcess.

Wenn etwas schiefgeht, überprüfen Sie die Browser-Konsole. Wenn die native Anwendung eine Ausgabe an stderr sendet, leitet der Browser diese an die Browser-Konsole weiter. Wenn Sie es geschafft haben, die native Anwendung zu starten, sehen Sie alle Fehlernachrichten, die sie ausgibt.

Wenn Sie es nicht geschafft haben, die Anwendung zu starten, sollten Sie eine Fehlermeldung sehen, die Ihnen einen Hinweis auf das Problem gibt.

"No such native application <name>"

• Überprüfen Sie, ob der Name, der an runtime.connectNative() übergeben wird, mit dem Namen im App-Manifest übereinstimmt.

• macOS/Linux: Überprüfen Sie, ob der Name des App-Manifests <name>.json lautet.

• macOS/Linux: Überprüfen Sie den Standort der Manifestdatei der nativen Anwendung wie hier angegeben.

• Windows: Überprüfen Sie, ob der Registrierungsschlüssel an der richtigen Stelle ist und ob sein Name mit dem Namen im App-Manifest übereinstimmt.

• Windows: Überprüfen Sie, ob der im Registrierungsschlüssel angegebene Pfad auf das App-Manifest verweist.

  "Error: Invalid application <name>"
  

• Überprüfen Sie, ob der Name der Anwendung keine ungültigen Zeichen enthält.

  "'python' is not recognized as an internal or external command, ..."
  

• Windows: Wenn Ihre Anwendung ein Python-Skript ist, überprüfen Sie, ob Sie Python installiert haben und Ihr Pfad dafür eingerichtet ist.

  "File at path <path> does not exist, or is not executable"
  

• Wenn Sie dies sehen, wurde das App-Manifest erfolgreich gefunden.

• Überprüfen Sie, ob der "path" im App-Manifest korrekt ist.

• Windows: Überprüfen Sie, ob Sie die Pfadtrennzeichen korrekt escaped haben ("c:\\path\\to\\file").

• Überprüfen Sie, ob sich die App am im "path"-Property des App-Manifests angegebenen Ort befindet.

• Überprüfen Sie, ob die App ausführbar ist.

  "This extension does not have permission to use native application <name>"
  

• Überprüfen Sie, ob der "allowed_extensions"-Schlüssel im App-Manifest die ID des Add-ons enthält.

      "TypeError: browser.runtime.connectNative is not a function"
  

• Überprüfen Sie, ob die Erweiterung die "nativeMessaging"-Berechtigung besitzt.

  "[object Object]       NativeMessaging.jsm:218"
  

• Es gab ein Problem beim Starten der Anwendung.

Es gibt eine Reihe von Unterschieden zwischen Browsern, die sich auf native Messaging in Web Extensions auswirken, einschließlich der an die native App übergebenen Argumente, des Standorts der Manifestdatei usw. Diese Unterschiede werden in Chrome Inkompatibilitäten > Native Messaging diskutiert.