OAuth 2.0 Beispielanwendung | Dokumentation

Roblox bietet eine Node.js Beispielanwendung, die zeigt, wie man OAuth 2.0 verwendet, um es Benutzern zu ermöglichen, sich in ihre Roblox-Konten einzuloggen und Nachrichten über ihre Spiele zu senden. Diese Anwendung verwendet den Authorization Code Flow ohne PKCE und ist daher nur für vertrauliche Clients geeignet, wie private Server.

Nachdem Sie die .zip-Datei heruntergeladen haben, extrahieren Sie sie in einen eigenen Ordner.

Registrieren Sie die Anwendung

Der erste Schritt zur Einrichtung der Anwendung besteht darin, sie auf der Roblox-Website zu registrieren und die Client-ID und das Geheimnis an einem sicheren Ort zu speichern. Folgen Sie dann den standardmäßigen Registrierungsverfahren mit diesen Einstellungen:

Unter Berechtigungen fügen Sie die Scopes openid, profile und universe-messaging-service:publish hinzu.
Unter Redirect-URLs fügen Sie die http://localhost:3000/oauth/callback hinzu. Wenn Sie einen nicht-standardmäßigen Port für Ihre Anwendung verwenden möchten, geben Sie ihn hier an.

Umgebungsvariablen festlegen

Anstatt sie im Code zu speichern (nicht empfohlen), verwendet die Anwendung Umgebungsvariablen für Ihre Client-ID und Ihr Geheimnis. Der Prozess zum Hinzufügen von Umgebungsvariablen unterscheidet sich je nach Betriebssystem.

Unter Windows führen Sie die folgenden PowerShell-Befehle aus:


$env:ROBLOX_CLIENT_ID='your_client_id_here'
$env:ROBLOX_CLIENT_SECRET='your_client_secret_here'
$env:ROBLOX_PORT=3000 # Optional. Standard ist 3000.

Unter Mac und den meisten Linux-Distributionen führen Sie diese Befehle im Terminal aus:


export ROBLOX_CLIENT_ID=your_client_id_here
export ROBLOX_CLIENT_SECRET=your_client_secret_here
export ROBLOX_PORT=3000 # Optional. Standard ist 3000.

Wenn Sie bei der Registrierung Ihrer Anwendung eine nicht-standardmäßige Portnummer in der Redirect-URL angegeben haben, stellen Sie sicher, dass Sie die Variable ROBLOX_PORT hinzufügen.

Diese Befehle setzen die Umgebungsvariablen nur für die Dauer Ihrer Terminal-Sitzung. Wenn Sie diese Variablen jedes Mal laden möchten, wenn Sie ein neues Terminalfenster öffnen, fügen Sie die Befehle zu Ihrer Shell-Konfigurationsdatei hinzu, wie z.B. .zshrc oder .bashrc. Viele Hosting-Dienste bieten Funktionen, um Ihnen das Hinzufügen von Umgebungsvariablen zu Ihren Servern zu erleichtern.

Abhängigkeiten installieren

Die Anwendung hat einige Abhängigkeiten, die in package.json sichtbar sind. Um sie zu installieren, führen Sie aus:


npm ci

Anwendung starten

Um die Anwendung zu starten, führen Sie aus:


npm start

Navigieren Sie dann zu http://localhost:3000 (oder Ihrem nicht-standardmäßigen Port) in einem Webbrowser.

Die Anwendung leitet Sie sofort zur Roblox-Anmeldeseite weiter, wo Sie sich anmelden, die Berechtigungen, die die Anwendung anfordert, prüfen und auf Bestätigen und Zugriffsgewährung klicken können.

Roblox leitet Sie dann zurück zu localhost, wo Sie sehen können, dass die Anwendung nun einige minimale Benutzerinformationen anzeigt, einen Link zu Ihrem Profil auf Roblox und Felder, die Sie verwenden können, um Nachrichten über Ihre Spiele zu senden.

Über die Anwendung

In groben Zügen führt index.js die folgenden Operationen aus:

Startet einen neuen Webserver mit express.
Ruft die Roblox OpenID Connect (OIDC) Konfiguration ab, die Endpunkte für Autorisierung, Benutzerinformationen usw. enthält. Für weitere Informationen zu diesen Endpunkten siehe OAuth 2.0 Authentifizierung.
Erstellt einen neuen Open ID-Client mit openid-client und Ihren gespeicherten Anmeldeinformationen. Dieser Client vereinfacht den Prozess erheblich, HTTP-Anfragen an die OAuth 2.0 Endpunkte ordnungsgemäß zu formen und zu senden.
Definiert die Routen für die Anwendung, einschließlich Redirects für die Anmelde- und Abmeldeflüsse sowie den OAuth 2.0 Callback.
Nach einer erfolgreichen Anmeldung speichert sie die verschiedenen Token als Cookies, zusammen mit einigen minimalen Benutzerinformationen, die sie mit Hilfe von getHomeHtml.js als HTML anzeigt.