@eienjs/adonisjs-simple-auth 1.0.1 → 2.0.0

package/build/providers/simple_auth_provider.js

@@ -1,30 +1,20 @@
-import {
-  SimpleAuthMiddleware
-} from "../chunk-TVVNPJ4M.js";
-import "../chunk-JUF7K25A.js";
-import "../chunk-EUXUH3YW.js";
-
-// providers/simple_auth_provider.ts
+import SimpleAuthMiddleware from "../middleware/simple_auth_middleware.js";
 import { configProvider } from "@adonisjs/core";
 import { RuntimeException } from "@adonisjs/core/exceptions";
+//#region providers/simple_auth_provider.ts
 var SimpleAuthProvider = class {
-  constructor(app) {
-    this.app = app;
-  }
-  register() {
-    this.app.container.singleton(SimpleAuthMiddleware, async () => {
-      const simpleAuthConfigProvider = this.app.config.get("simpleauth");
-      const config = await configProvider.resolve(this.app, simpleAuthConfigProvider);
-      if (!config) {
-        throw new RuntimeException(
-          'Invalid "config/simpleauth.ts" file. Make sure you are using the "defineConfig" method'
-        );
-      }
-      return new SimpleAuthMiddleware(config);
-    });
-  }
+	app;
+	constructor(app) {
+		this.app = app;
+	}
+	register() {
+		this.app.container.singleton(SimpleAuthMiddleware, async () => {
+			const simpleAuthConfigProvider = this.app.config.get("simpleauth");
+			const config = await configProvider.resolve(this.app, simpleAuthConfigProvider);
+			if (!config) throw new RuntimeException("Invalid \"config/simpleauth.ts\" file. Make sure you are using the \"defineConfig\" method");
+			return new SimpleAuthMiddleware(config);
+		});
+	}
 };
-export {
-  SimpleAuthProvider as default
-};
-//# sourceMappingURL=simple_auth_provider.js.map
+//#endregion
+export { SimpleAuthProvider as default };

package/build/src/define_config.d.ts

@@ -1,3 +1,7 @@
-import { type ConfigProvider } from '@adonisjs/core/types';
-import { type ResolvedSimpleAuthConfig, type SimpleAuthConfig } from './types.js';
-export declare const defineConfig: (config: SimpleAuthConfig) => ConfigProvider<ResolvedSimpleAuthConfig>;
+import { ResolvedSimpleAuthConfig, SimpleAuthConfig } from "../types.js";
+import { ConfigProvider } from "@adonisjs/core/types";
+
+//#region src/define_config.d.ts
+declare const defineConfig: (config: SimpleAuthConfig) => ConfigProvider<ResolvedSimpleAuthConfig>;
+//#endregion
+export { defineConfig };

package/build/src/define_config.js

@@ -0,0 +1,13 @@
+import { configProvider } from "@adonisjs/core";
+import { Secret } from "@adonisjs/core/helpers";
+//#region src/define_config.ts
+const defineConfig = (config) => {
+	return configProvider.create(async (_) => {
+		return {
+			apiKeyHeader: config.apiKeyHeader ?? "x-api-key",
+			apiKeyValue: new Secret(config.apiKeyValue)
+		};
+	});
+};
+//#endregion
+export { defineConfig };

package/build/src/errors.d.ts

@@ -1,17 +1,21 @@
-import { Exception } from '@adonisjs/core/exceptions';
-import { type HttpContext } from '@adonisjs/core/http';
-export declare class SimpleAuthException extends Exception {
-    static readonly code = "E_SIMPLE_UNAUTHORIZED_ACCESS";
-    static readonly status = 401;
-    /**
-     * Translation identifier. Can be customized
-     */
-    identifier: string;
-    /**
-     * Returns the message to be sent in the HTTP response.
-     * Feel free to override this method and return a custom
-     * response.
-     */
-    getResponseMessage(error: this, ctx: HttpContext): string;
-    handle(error: this, ctx: HttpContext): Promise<void>;
+import { Exception } from "@adonisjs/core/exceptions";
+import { HttpContext } from "@adonisjs/core/http";
+
+//#region src/errors.d.ts
+declare class SimpleAuthException extends Exception {
+  static readonly code = "E_SIMPLE_UNAUTHORIZED_ACCESS";
+  static readonly status = 401;
+  /**
+   * Translation identifier. Can be customized
+   */
+  identifier: string;
+  /**
+   * Returns the message to be sent in the HTTP response.
+   * Feel free to override this method and return a custom
+   * response.
+   */
+  getResponseMessage(error: this, ctx: HttpContext): string;
+  handle(error: this, ctx: HttpContext): Promise<void>;
 }
+//#endregion
+export { SimpleAuthException };

package/build/src/errors.js

@@ -0,0 +1,41 @@
+import { Exception } from "@adonisjs/core/exceptions";
+//#region src/errors.ts
+var SimpleAuthException = class SimpleAuthException extends Exception {
+	static code = "E_SIMPLE_UNAUTHORIZED_ACCESS";
+	static status = 401;
+	/**
+	* Translation identifier. Can be customized
+	*/
+	identifier = `errors.${SimpleAuthException.code}`;
+	/**
+	* Returns the message to be sent in the HTTP response.
+	* Feel free to override this method and return a custom
+	* response.
+	*/
+	getResponseMessage(error, ctx) {
+		if ("i18n" in ctx) return ctx.i18n.t(error.identifier, {}, error.message);
+		return error.message;
+	}
+	async handle(error, ctx) {
+		const message = this.getResponseMessage(error, ctx);
+		switch (ctx.request.accepts([
+			"html",
+			"application/vnd.api+json",
+			"json"
+		])) {
+			case "html":
+			case null:
+			case "json":
+				ctx.response.status(error.status).send({ errors: [{ message }] });
+				break;
+			case "application/vnd.api+json":
+				ctx.response.status(error.status).send({ errors: [{
+					code: error.code,
+					title: message
+				}] });
+				break;
+		}
+	}
+};
+//#endregion
+export { SimpleAuthException };

package/build/src/helpers/crc32.js

@@ -0,0 +1,308 @@
+import { TextEncoder } from "node:util";
+//#region src/helpers/crc32.ts
+/**
+* We use CRC32 just to add a recognizable checksum to tokens. This helps
+* secret scanning tools like https://docs.github.com/en/github/administering-a-repository/about-secret-scanning easily detect tokens generated by a given program.
+*
+* You can learn more about appending checksum to a hash here in this Github
+* article. https://github.blog/2021-04-05-behind-githubs-new-authentication-token-formats/
+*
+* Code taken from:
+* https://github.com/adonisjs/auth/blob/9.x/modules/access_tokens_guard/crc32.ts
+*/
+var CRC32 = class {
+	/**
+	* Lookup table calculated for 0xEDB88320 divisor
+	*/
+	lookupTable = [
+		0,
+		1996959894,
+		3993919788,
+		2567524794,
+		124634137,
+		1886057615,
+		3915621685,
+		2657392035,
+		249268274,
+		2044508324,
+		3772115230,
+		2547177864,
+		162941995,
+		2125561021,
+		3887607047,
+		2428444049,
+		498536548,
+		1789927666,
+		4089016648,
+		2227061214,
+		450548861,
+		1843258603,
+		4107580753,
+		2211677639,
+		325883990,
+		1684777152,
+		4251122042,
+		2321926636,
+		335633487,
+		1661365465,
+		4195302755,
+		2366115317,
+		997073096,
+		1281953886,
+		3579855332,
+		2724688242,
+		1006888145,
+		1258607687,
+		3524101629,
+		2768942443,
+		901097722,
+		1119000684,
+		3686517206,
+		2898065728,
+		853044451,
+		1172266101,
+		3705015759,
+		2882616665,
+		651767980,
+		1373503546,
+		3369554304,
+		3218104598,
+		565507253,
+		1454621731,
+		3485111705,
+		3099436303,
+		671266974,
+		1594198024,
+		3322730930,
+		2970347812,
+		795835527,
+		1483230225,
+		3244367275,
+		3060149565,
+		1994146192,
+		31158534,
+		2563907772,
+		4023717930,
+		1907459465,
+		112637215,
+		2680153253,
+		3904427059,
+		2013776290,
+		251722036,
+		2517215374,
+		3775830040,
+		2137656763,
+		141376813,
+		2439277719,
+		3865271297,
+		1802195444,
+		476864866,
+		2238001368,
+		4066508878,
+		1812370925,
+		453092731,
+		2181625025,
+		4111451223,
+		1706088902,
+		314042704,
+		2344532202,
+		4240017532,
+		1658658271,
+		366619977,
+		2362670323,
+		4224994405,
+		1303535960,
+		984961486,
+		2747007092,
+		3569037538,
+		1256170817,
+		1037604311,
+		2765210733,
+		3554079995,
+		1131014506,
+		879679996,
+		2909243462,
+		3663771856,
+		1141124467,
+		855842277,
+		2852801631,
+		3708648649,
+		1342533948,
+		654459306,
+		3188396048,
+		3373015174,
+		1466479909,
+		544179635,
+		3110523913,
+		3462522015,
+		1591671054,
+		702138776,
+		2966460450,
+		3352799412,
+		1504918807,
+		783551873,
+		3082640443,
+		3233442989,
+		3988292384,
+		2596254646,
+		62317068,
+		1957810842,
+		3939845945,
+		2647816111,
+		81470997,
+		1943803523,
+		3814918930,
+		2489596804,
+		225274430,
+		2053790376,
+		3826175755,
+		2466906013,
+		167816743,
+		2097651377,
+		4027552580,
+		2265490386,
+		503444072,
+		1762050814,
+		4150417245,
+		2154129355,
+		426522225,
+		1852507879,
+		4275313526,
+		2312317920,
+		282753626,
+		1742555852,
+		4189708143,
+		2394877945,
+		397917763,
+		1622183637,
+		3604390888,
+		2714866558,
+		953729732,
+		1340076626,
+		3518719985,
+		2797360999,
+		1068828381,
+		1219638859,
+		3624741850,
+		2936675148,
+		906185462,
+		1090812512,
+		3747672003,
+		2825379669,
+		829329135,
+		1181335161,
+		3412177804,
+		3160834842,
+		628085408,
+		1382605366,
+		3423369109,
+		3138078467,
+		570562233,
+		1426400815,
+		3317316542,
+		2998733608,
+		733239954,
+		1555261956,
+		3268935591,
+		3050360625,
+		752459403,
+		1541320221,
+		2607071920,
+		3965973030,
+		1969922972,
+		40735498,
+		2617837225,
+		3943577151,
+		1913087877,
+		83908371,
+		2512341634,
+		3803740692,
+		2075208622,
+		213261112,
+		2463272603,
+		3855990285,
+		2094854071,
+		198958881,
+		2262029012,
+		4057260610,
+		1759359992,
+		534414190,
+		2176718541,
+		4139329115,
+		1873836001,
+		414664567,
+		2282248934,
+		4279200368,
+		1711684554,
+		285281116,
+		2405801727,
+		4167216745,
+		1634467795,
+		376229701,
+		2685067896,
+		3608007406,
+		1308918612,
+		956543938,
+		2808555105,
+		3495958263,
+		1231636301,
+		1047427035,
+		2932959818,
+		3654703836,
+		1088359270,
+		936918e3,
+		2847714899,
+		3736837829,
+		1202900863,
+		817233897,
+		3183342108,
+		3401237130,
+		1404277552,
+		615818150,
+		3134207493,
+		3453421203,
+		1423857449,
+		601450431,
+		3009837614,
+		3294710456,
+		1567103746,
+		711928724,
+		3020668471,
+		3272380065,
+		1510334235,
+		755167117
+	];
+	initialCRC = 4294967295;
+	calculateBytes(bytes, accumulator) {
+		let crc = accumulator ?? this.initialCRC;
+		for (const byte of bytes) {
+			const tableIndex = (crc ^ byte) & 255;
+			const tableVal = this.lookupTable[tableIndex];
+			crc = crc >>> 8 ^ tableVal;
+		}
+		return crc;
+	}
+	crcToUint(crc) {
+		return this.toUint32(crc ^ 4294967295);
+	}
+	strToBytes(input) {
+		return new TextEncoder().encode(input);
+	}
+	toUint32(num) {
+		if (num >= 0) return num;
+		return 4294967295 - -num + 1;
+	}
+	calculate(input) {
+		return this.forString(input);
+	}
+	forString(input) {
+		const bytes = this.strToBytes(input);
+		return this.forBytes(bytes);
+	}
+	forBytes(bytes, accumulator) {
+		const crc = this.calculateBytes(bytes, accumulator);
+		return this.crcToUint(crc);
+	}
+};
+//#endregion
+export { CRC32 };

package/build/src/simple_auth.d.ts

@@ -1,11 +1,15 @@
-import { type HttpContext } from '@adonisjs/core/http';
-import { SimpleAuthException } from './errors.js';
-import { type ResolvedSimpleAuthConfig } from './types.js';
-export declare class SimpleAuth {
-    protected ctx: HttpContext;
-    protected config: ResolvedSimpleAuthConfig;
-    constructor(ctx: HttpContext, config: ResolvedSimpleAuthConfig);
-    protected authenticationFailed(): SimpleAuthException;
-    protected getApiKeyRequest(): string;
-    authenticate(): void;
+import { ResolvedSimpleAuthConfig } from "../types.js";
+import { SimpleAuthException } from "./errors.js";
+import { HttpContext } from "@adonisjs/core/http";
+
+//#region src/simple_auth.d.ts
+declare class SimpleAuth {
+  protected ctx: HttpContext;
+  protected config: ResolvedSimpleAuthConfig;
+  constructor(ctx: HttpContext, config: ResolvedSimpleAuthConfig);
+  protected authenticationFailed(): SimpleAuthException;
+  protected getApiKeyRequest(): string;
+  authenticate(): void;
 }
+//#endregion
+export { SimpleAuth };

package/build/src/simple_auth.js

@@ -0,0 +1,23 @@
+import { SimpleAuthException } from "./errors.js";
+//#region src/simple_auth.ts
+var SimpleAuth = class {
+	ctx;
+	config;
+	constructor(ctx, config) {
+		this.ctx = ctx;
+		this.config = config;
+	}
+	authenticationFailed() {
+		return new SimpleAuthException("Unauthorized access");
+	}
+	getApiKeyRequest() {
+		const apiKey = this.ctx.request.header(this.config.apiKeyHeader, "");
+		if (!apiKey.trim()) throw this.authenticationFailed();
+		return apiKey;
+	}
+	authenticate() {
+		if (this.getApiKeyRequest() !== this.config.apiKeyValue.release()) throw this.authenticationFailed();
+	}
+};
+//#endregion
+export { SimpleAuth };

package/build/stubs/main.d.ts

@@ -1,5 +1,4 @@
-/**
- * Path to the root directory where the stubs are stored. We use
- * this path within commands and the configure hook
- */
-export declare const stubsRoot: string;
+//#region stubs/main.d.ts
+declare const stubsRoot: string;
+//#endregion
+export { stubsRoot };

package/build/stubs/main.js

@@ -0,0 +1,4 @@
+//#region stubs/main.ts
+const stubsRoot = import.meta.dirname;
+//#endregion
+export { stubsRoot };

package/build/types.d.ts

@@ -0,0 +1,13 @@
+import { Secret } from "@adonisjs/core/helpers";
+
+//#region src/types.d.ts
+interface SimpleAuthConfig {
+  apiKeyHeader?: string;
+  apiKeyValue: string;
+}
+interface ResolvedSimpleAuthConfig {
+  apiKeyHeader: string;
+  apiKeyValue: Secret<string>;
+}
+//#endregion
+export { ResolvedSimpleAuthConfig, SimpleAuthConfig };

package/build/types.js

@@ -0,0 +1 @@
+export {};