@ianlucas/remix-auth-steam 2.0.0

package/License.txt

@@ -0,0 +1,24 @@
+
+MIT License
+
+Copyright (c) 2021 Sergio Xalambrí
+Copyright (c) 2022 Andreychik32
+Copyright (c) 2024 - present Ian Lucas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# remix-auth-steam
+
+This is a [Steam](https://steamcommunity.com/) strategy for [remix-auth](https://github.com/sergiodxa/remix-auth) library.
+
+## Install
+
+```bash
+npm install @ianlucas/remix-auth-steam
+```
+
+## Usage
+
+Refer to the [original repo](https://github.com/Andreychik32/remix-auth-steam#file-structure) for usage instructions.

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { SessionStorage } from "@remix-run/server-runtime";
+import { AuthenticateOptions, Strategy, StrategyVerifyCallback } from "remix-auth";
+import { UserSummary } from "steamapi";
+export interface SteamStrategyOptions {
+    returnURL: string;
+    realm?: string;
+    apiKey: string;
+}
+export type SteamStrategyVerifyParams = UserSummary;
+export declare class SteamStrategy<User> extends Strategy<User, SteamStrategyVerifyParams> {
+    name: string;
+    private options;
+    constructor(options: SteamStrategyOptions | (() => Promise<SteamStrategyOptions>), verify: StrategyVerifyCallback<User, SteamStrategyVerifyParams>);
+    authenticate(request: Request, sessionStorage: SessionStorage, options: AuthenticateOptions): Promise<User>;
+}

package/dist/index.js

@@ -0,0 +1,41 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Ian Lucas. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import { redirect } from "@remix-run/server-runtime";
+import { Strategy } from "remix-auth";
+import OpenID from "openid";
+import { PromiseAuthenticate, PromiseVerifyAssertion } from "./promises";
+import SteamAPI from "steamapi";
+export class SteamStrategy extends Strategy {
+    name = "steam";
+    options;
+    constructor(options, verify) {
+        super(verify);
+        this.options = options;
+    }
+    async authenticate(request, sessionStorage, options) {
+        const { apiKey, returnURL, realm } = typeof this.options === "function" ? await this.options() : this.options;
+        const relyingParty = new OpenID.RelyingParty(returnURL, realm ?? null, true, false, []);
+        const steamApi = new SteamAPI(apiKey);
+        try {
+            const result = await PromiseVerifyAssertion(relyingParty, request);
+            if (!result.authenticated || !result.claimedIdentifier)
+                return this.failure(`Not authenticated from result`, request, sessionStorage, options);
+            try {
+                const userSteamID = result.claimedIdentifier.toString().split("/").at(-1);
+                const steamUserSummary = (await steamApi.getUserSummary(userSteamID));
+                const user = await this.verify(steamUserSummary);
+                return this.success(user, request, sessionStorage, options);
+            }
+            catch (error) {
+                let message = error.message;
+                return this.failure(message, request, sessionStorage, options);
+            }
+        }
+        catch {
+            const result = await PromiseAuthenticate(relyingParty);
+            throw redirect(result);
+        }
+    }
+}

package/dist/promises.d.ts

@@ -0,0 +1,6 @@
+import type OpenID from "openid";
+export declare const PromiseAuthenticate: (relyingParty: OpenID.RelyingParty) => Promise<string>;
+export declare const PromiseVerifyAssertion: (relyingParty: OpenID.RelyingParty, req: Request) => Promise<{
+    authenticated: boolean;
+    claimedIdentifier?: string | undefined;
+}>;

package/dist/promises.js

@@ -0,0 +1,26 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Ian Lucas. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+export const PromiseAuthenticate = (relyingParty) => new Promise((resolve, reject) => {
+    relyingParty.authenticate("https://steamcommunity.com/openid", false, (err, url) => {
+        if (err) {
+            return reject(err);
+        }
+        if (!url) {
+            return reject("Got no URL from authenticate method");
+        }
+        return resolve(url);
+    });
+});
+export const PromiseVerifyAssertion = (relyingParty, req) => new Promise((resolve, reject) => {
+    relyingParty.verifyAssertion(req, (err, result) => {
+        if (err) {
+            return reject(err);
+        }
+        if (!result) {
+            return reject(`No result from verifyAssertion`);
+        }
+        return resolve(result);
+    });
+});

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@ianlucas/remix-auth-steam",
+    "version": "2.0.0",
+    "description": "Remix authentication strategy for Steam",
+    "license": "MIT",
+    "author": "Ian Lucas",
+    "repository": "ianlucas/remix-auth-steam",
+    "main": "./dist/index.js",
+    "keywords": [
+        "auth",
+        "authentication",
+        "remix-auth",
+        "remix-steam",
+        "remix",
+        "steam",
+        "strategy"
+    ],
+    "scripts": {
+        "prepack": "([ -d dist ] && rm -rf dist); tsc",
+        "typecheck": "tsc --project tsconfig.json --noEmit",
+        "format": "prettier . --write"
+    },
+    "peerDependencies": {
+        "@remix-run/server-runtime": "^2.8.1"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.24.1",
+        "@babel/preset-env": "^7.24.1",
+        "@babel/preset-react": "^7.24.1",
+        "@babel/preset-typescript": "^7.24.1",
+        "@remix-run/node": "^2.8.1",
+        "@remix-run/react": "^2.8.1",
+        "@remix-run/server-runtime": "^2.8.1",
+        "@types/node": "^20.11.30",
+        "@types/openid": "^2.0.5",
+        "prettier": "^3.2.5",
+        "react": "^18.2.0",
+        "typescript": "^5.4.2"
+    },
+    "dependencies": {
+        "@types/steamapi": "^2.2.5",
+        "openid": "^2.0.12",
+        "remix-auth": "^3.6.0",
+        "steamapi": "^3.0.8"
+    }
+}