@riao/authn-password 1.0.0

package/CHANGELOG.md

@@ -0,0 +1 @@
+# authn-password - Changelog

package/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2022 authn-password and others
+
+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,145 @@
+# @riao/authn-password
+
+A TypeScript library that provides password-based authentication for the RIAO Identity and Access Management (IAM) framework. This driver implements secure password hashing and verification using bcrypt.
+
+## Features
+
+- **Secure Password Hashing**: Uses bcrypt for secure password hashing with configurable salt rounds
+- **Principal Management**: Create and manage user principals with associated passwords
+- **Authentication**: Authenticate users with login credentials and passwords
+- **Flexible Hash Implementation**: Supports custom hash implementations via the `Hash` interface
+- **Database Agnostic**: Works with any database supported by the RIAO DBAL (Database Abstraction Layer)
+- **TypeScript Support**: Full TypeScript support with type safety
+
+## Installation
+
+```bash
+npm install @riao/authn-password @riao/iam @riao/dbal
+npm install --save-dev @riao/cli
+```
+
+## Database Migrations
+
+This driver requires the IAM password table to be created in your database. You can use the provided migrations:
+
+```bash
+npx riao migration:create import-iam-tables
+```
+
+Then, add the `AuthenticationPasswordMigrations` to your migration runner:
+
+`database/main/migrations/1234567890-import-iam-tables.ts`
+```typescript
+import { AuthenticationPasswordMigrations } from 'authn-password';
+
+export default AuthenticationPasswordMigrations;
+```
+
+## Quick Start
+
+### Basic Usage
+
+```typescript
+import { PasswordAuthentication } from '@riao/authn-password';
+import { Principal } from '@riao/iam/auth';
+import { Database } from '@riao/dbal';
+
+// Define your user interface
+interface User extends Principal {
+  login: string;
+}
+
+// Create an authentication service class
+class UserAuthentication extends PasswordAuthentication<User> {}
+
+// Initialize with your database
+const db = new YourDatabase();
+await db.init();
+await db.connect();
+
+const authService = new UserAuthentication({ db });
+
+// Create a new user with a password
+const userId = await authService.createPrincipal({
+  login: 'john.doe',
+  type: 'user',
+  name: 'John Doe',
+  password: 'securePassword123',
+});
+
+// Authenticate a user
+const user = await authService.authenticate({
+  login: 'john.doe',
+  password: 'securePassword123',
+});
+
+if (user) {
+  console.log(`Welcome ${user.name}!`);
+}
+else {
+  console.log('Authentication failed');
+}
+```
+
+## API Reference
+
+### PasswordAuthentication<TPrincipal>
+
+Abstract class that extends `Authentication<TPrincipal>` and adds password-based authentication.
+
+#### Constructor Options
+
+```typescript
+interface PasswordAuthenticationOptions extends AuthOptions {
+  hash?: Hash; // Optional custom hash implementation (defaults to bcrypt)
+}
+```
+
+#### Methods
+
+- **createPrincipal(principal)**: Creates a new principal with a hashed password
+  - Parameters: Principal data with `password` field
+  - Returns: Principal ID
+
+- **authenticate(credentials)**: Authenticates a user with login and password
+  - Parameters: Object with `login` and `password` fields
+  - Returns: Principal object if successful, null if authentication fails
+
+- **passwordsRepo**: Query repository for accessing password records directly
+
+### Password Record Schema
+
+Passwords are stored in the `iam_passwords` table:
+
+```typescript
+interface Password {
+  id?: string;
+  principal_id: string;      // Foreign key to principal
+  password_hash: string;      // Bcrypt hashed password
+  deactivate_timestamp?: string;
+  create_timestamp?: string;
+}
+```
+
+## Configuration
+
+### Custom Hash Implementation
+
+You can provide a custom hash implementation:
+
+```typescript
+import { Hash } from '@riao/iam/hash';
+
+class CustomHash extends Hash {
+  // Implement your custom hashing logic
+}
+
+const authService = new UserAuthentication({
+  db,
+  hash: new CustomHash(),
+});
+```
+
+## Contributing & Development
+
+See [contributing.md](docs/contributing/contributing.md) for information on how to develop or contribute to this project!

package/authentication-password-migrations.d.ts

@@ -0,0 +1,5 @@
+import { Migration } from '@riao/dbal';
+import { AuthMigrations } from '@riao/iam/auth/auth-migrations';
+export declare class AuthenticationPasswordMigrations extends AuthMigrations {
+    getMigrations(): Promise<Record<string, typeof Migration<any>>>;
+}

package/authentication-password-migrations.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationPasswordMigrations = void 0;
+const auth_migrations_1 = require("@riao/iam/auth/auth-migrations");
+const _001_create_passwords_table_1 = require("./migrations/001-create-passwords-table");
+class AuthenticationPasswordMigrations extends auth_migrations_1.AuthMigrations {
+    async getMigrations() {
+        return {
+            ...(await super.getMigrations()),
+            'create-passwords-table': _001_create_passwords_table_1.CreatePasswordsTable,
+        };
+    }
+}
+exports.AuthenticationPasswordMigrations = AuthenticationPasswordMigrations;
+//# sourceMappingURL=authentication-password-migrations.js.map

package/authentication-password-migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authentication-password-migrations.js","sourceRoot":"","sources":["../../src/authentication-password-migrations.ts"],"names":[],"mappings":";;;AACA,oEAAgE;AAChE,yFAA+E;AAE/E,MAAa,gCAAiC,SAAQ,gCAAc;IAC1D,KAAK,CAAC,aAAa;QAI3B,OAAO;YACN,GAAG,CAAC,MAAM,KAAK,CAAC,aAAa,EAAE,CAAC;YAChC,wBAAwB,EAAE,kDAAoB;SAC9C,CAAC;IACH,CAAC;CACD;AAVD,4EAUC"}

package/authentication-password.d.ts

@@ -0,0 +1,20 @@
+import { DatabaseRecordId, QueryRepository } from '@riao/dbal';
+import { Hash } from '@riao/iam/hash';
+import { Principal } from '@riao/iam/auth';
+import { Authentication } from '@riao/iam/authentication';
+import { AuthOptions } from '@riao/iam/auth/auth';
+import { Password } from './password';
+export interface PasswordAuthenticationOptions extends AuthOptions {
+    hash?: Hash;
+}
+export declare abstract class PasswordAuthentication<TPrincipal extends Principal> extends Authentication<TPrincipal> {
+    passwordsRepo: QueryRepository<Password>;
+    protected hash: Hash;
+    constructor(options: PasswordAuthenticationOptions);
+    createPrincipal(principal: Omit<TPrincipal, 'id' | 'create_timestamp'> & {
+        password: string;
+    }): Promise<DatabaseRecordId>;
+    authenticate(credentials: Partial<TPrincipal & {
+        password: string;
+    }>): Promise<TPrincipal | null>;
+}

package/authentication-password.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PasswordAuthentication = void 0;
+const hash_1 = require("@riao/iam/hash");
+const authentication_1 = require("@riao/iam/authentication");
+class PasswordAuthentication extends authentication_1.Authentication {
+    passwordsRepo;
+    hash;
+    constructor(options) {
+        super(options);
+        this.hash = options.hash ?? new hash_1.Hash();
+        this.passwordsRepo = options.db.getQueryRepository({
+            table: 'iam_passwords',
+            identifiedBy: 'id',
+        });
+    }
+    async createPrincipal(principal) {
+        const hash = await this.hash.make(principal.password);
+        delete principal.password;
+        const principalId = await super.createPrincipal(principal);
+        await this.passwordsRepo.insertOne({
+            record: {
+                principal_id: principalId,
+                password_hash: hash,
+            },
+        });
+        return principalId;
+    }
+    async authenticate(credentials) {
+        const principal = await this.findActivePrincipal({
+            where: {
+                login: credentials.login,
+            },
+        });
+        if (!principal) {
+            return null;
+        }
+        const passwordRecord = await this.passwordsRepo.findOne({
+            where: { principal_id: principal.id, deactivate_timestamp: null },
+            orderBy: { create_timestamp: 'DESC' },
+        });
+        if (!passwordRecord) {
+            return null;
+        }
+        const isValid = await this.hash.check(credentials.password, passwordRecord?.password_hash);
+        return isValid ? principal : null;
+    }
+}
+exports.PasswordAuthentication = PasswordAuthentication;
+//# sourceMappingURL=authentication-password.js.map

package/authentication-password.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authentication-password.js","sourceRoot":"","sources":["../../src/authentication-password.ts"],"names":[],"mappings":";;;AACA,yCAAsC;AAEtC,6DAA0D;AAQ1D,MAAsB,sBAEpB,SAAQ,+BAA0B;IAC5B,aAAa,CAA4B;IAEtC,IAAI,CAAO;IAErB,YAAmB,OAAsC;QACxD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,IAAI,WAAI,EAAE,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,EAAE,CAAC,kBAAkB,CAAW;YAC5D,KAAK,EAAE,eAAe;YACtB,YAAY,EAAE,IAAI;SAClB,CAAC,CAAC;IACJ,CAAC;IAEe,KAAK,CAAC,eAAe,CACpC,SAEC;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAQ,SAAmC,CAAC,QAAQ,CAAC;QAErD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAE3D,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;YAClC,MAAM,EAAE;gBACP,YAAY,EAAE,WAAqB;gBACnC,aAAa,EAAE,IAAI;aACnB;SACD,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,YAAY,CACxB,WAAuD;QAEvD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC;YAChD,KAAK,EAAc;gBAClB,KAAK,EAAE,WAAW,CAAC,KAAK;aACxB;SACD,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC;YACvD,KAAK,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE;YACjE,OAAO,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CACpC,WAAW,CAAC,QAAkB,EAC9B,cAAc,EAAE,aAAuB,CACvC,CAAC;QAEF,OAAO,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;IACnC,CAAC;CACD;AAjED,wDAiEC"}

package/index.d.ts

@@ -0,0 +1 @@
+export { PasswordAuthentication } from './authentication-password';

package/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PasswordAuthentication = void 0;
+var authentication_password_1 = require("./authentication-password");
+Object.defineProperty(exports, "PasswordAuthentication", { enumerable: true, get: function () { return authentication_password_1.PasswordAuthentication; } });
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,qEAAmE;AAA1D,iIAAA,sBAAsB,OAAA"}

package/migrations/001-create-passwords-table.d.ts

@@ -0,0 +1,5 @@
+import { Migration } from '@riao/dbal';
+export declare class CreatePasswordsTable extends Migration {
+    up(): Promise<void>;
+    down(): Promise<void>;
+}

package/migrations/001-create-passwords-table.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreatePasswordsTable = void 0;
+const column_pack_1 = require("@riao/dbal/column-pack");
+const dbal_1 = require("@riao/dbal");
+class CreatePasswordsTable extends dbal_1.Migration {
+    async up() {
+        await this.ddl.createTable({
+            name: 'iam_passwords',
+            columns: [
+                column_pack_1.UUIDKeyColumn,
+                {
+                    name: 'principal_id',
+                    type: dbal_1.ColumnType.UUID,
+                    fk: {
+                        referencesTable: 'iam_principals',
+                        referencesColumn: 'id',
+                        onDelete: 'CASCADE',
+                    },
+                },
+                { ...column_pack_1.PasswordColumn, name: 'password_hash' },
+                column_pack_1.CreateTimestampColumn,
+                {
+                    name: 'deactivate_timestamp',
+                    type: dbal_1.ColumnType.TIMESTAMP,
+                    required: false,
+                },
+            ],
+        });
+    }
+    async down() {
+        await this.ddl.dropTable({
+            tables: 'iam_passwords',
+        });
+    }
+}
+exports.CreatePasswordsTable = CreatePasswordsTable;
+//# sourceMappingURL=001-create-passwords-table.js.map

package/migrations/001-create-passwords-table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"001-create-passwords-table.js","sourceRoot":"","sources":["../../../src/migrations/001-create-passwords-table.ts"],"names":[],"mappings":";;;AAAA,wDAIgC;AAChC,qCAAmD;AAEnD,MAAa,oBAAqB,SAAQ,gBAAS;IACzC,KAAK,CAAC,EAAE;QAChB,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC;YAC1B,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE;gBACR,2BAAa;gBACb;oBACC,IAAI,EAAE,cAAc;oBACpB,IAAI,EAAE,iBAAU,CAAC,IAAI;oBACrB,EAAE,EAAE;wBACH,eAAe,EAAE,gBAAgB;wBACjC,gBAAgB,EAAE,IAAI;wBACtB,QAAQ,EAAE,SAAS;qBACnB;iBACD;gBACD,EAAE,GAAG,4BAAc,EAAE,IAAI,EAAE,eAAe,EAAE;gBAC5C,mCAAqB;gBACrB;oBACC,IAAI,EAAE,sBAAsB;oBAC5B,IAAI,EAAE,iBAAU,CAAC,SAAS;oBAC1B,QAAQ,EAAE,KAAK;iBACf;aACD;SACD,CAAC,CAAC;IACJ,CAAC;IAEQ,KAAK,CAAC,IAAI;QAClB,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC;YACxB,MAAM,EAAE,eAAe;SACvB,CAAC,CAAC;IACJ,CAAC;CACD;AA/BD,oDA+BC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@riao/authn-password",
+	"version": "1.0.0",
+	"description": "Password driver for Riao",
+	"typescript-template": {
+		"base": "1.0.1",
+		"jasmine": "1.0.0",
+		"library": "1.0.0"
+	},
+	"scripts": {},
+	"dependencies": {
+		"@riao/dbal": "^3.8.0",
+		"@riao/iam": "^3.0.0",
+		"bcrypt": "^6.0.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/authn-password/authn-password.git"
+	},
+	"author": "authn-password",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/authn-password/authn-password/issues"
+	},
+	"homepage": "https://github.com/authn-password/authn-password#readme",
+	"keywords": [
+		"authn",
+		"authentication",
+		"password",
+		"riao",
+		"bcrypt",
+		"riao-driver",
+		"riao-authn",
+		"riao-authn-driver",
+		"authentication-driver",
+		"authn-driver",
+		"authn-password",
+		"authn-password-driver"
+	],
+	"main": "index.js",
+	"types": "index.d.ts"
+}

package/password.d.ts

@@ -0,0 +1,7 @@
+export interface Password {
+    id: string;
+    principal_id: string;
+    password_hash: string;
+    create_timestamp: Date;
+    deactivate_timestamp?: Date | null;
+}

package/password.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=password.js.map

package/password.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"password.js","sourceRoot":"","sources":["../../src/password.ts"],"names":[],"mappings":""}