@boxyhq/saml-jackson 0.2.3-beta.219 → 0.2.3-beta.224

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxyhq/saml-jackson",
-  "version": "0.2.3-beta.219",
+  "version": "0.2.3-beta.224",
   "license": "Apache 2.0",
   "description": "SAML 2.0 service",
   "main": "dist/index.js",
@@ -17,12 +17,12 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
-    "start": "cross-env IDP_ENABLED=true node src/jackson.js",
-    "dev": "cross-env IDP_ENABLED=true nodemon src/jackson.js",
-    "mongo": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=mongo DB_URL=mongodb://localhost:27017/jackson DB_ENCRYPTION_KEY=RiVoTxDoLUUoIUOp224abMxK6PGGfFuF nodemon --config nodemon.json src/jackson.ts",
-    "sql": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=sql DB_TYPE=postgres DB_URL=postgres://postgres:postgres@localhost:5432/jackson DB_ENCRYPTION_KEY=RiVoTxDoLUUoIUOp224abMxK6PGGfFuF nodemon src/jackson.js",
-    "pre-loaded": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=mem PRE_LOADED_CONFIG='./_config' nodemon src/jackson.js",
-    "pre-loaded-db": "cross-env JACKSON_API_KEYS=secret PRE_LOADED_CONFIG='./_config' nodemon src/jackson.js",
+    "start": "cross-env IDP_ENABLED=true node dist/jackson.js",
+    "dev": "cross-env IDP_ENABLED=true nodemon --config nodemon.json src/jackson.ts",
+    "mongo": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=mongo DB_URL=mongodb://localhost:27017/jackson nodemon --config nodemon.json src/jackson.ts",
+    "sql": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=sql DB_TYPE=postgres DB_URL=postgres://postgres:postgres@localhost:5432/jackson nodemon --config nodemon.json src/jackson.ts",
+    "pre-loaded": "cross-env JACKSON_API_KEYS=secret DB_ENGINE=mem PRE_LOADED_CONFIG='./_config' nodemon --config nodemon.json src/jackson.ts",
+    "pre-loaded-db": "cross-env JACKSON_API_KEYS=secret PRE_LOADED_CONFIG='./_config' nodemon --config nodemon.json src/jackson.ts",
     "test": "tap --ts --timeout=100 src/**/*.test.ts",
     "dev-dbs": "docker-compose -f ./_dev/docker-compose.yml up -d",
     "dev-dbs-destroy": "docker-compose -f ./_dev/docker-compose.yml down --volumes --remove-orphans"

package/src/controller/api.ts

@@ -4,8 +4,7 @@ import * as dbutils from '../db/utils';
 import saml from '../saml/saml';
 import { JacksonError } from './error';
 import { IndexNames } from './utils';
-
-const x509 = require('../saml/x509.js');
+import x509 from '../saml/x509';
 
 export class SAMLConfig implements ISAMLConfig {
   private configStore: Storable;

package/src/controller/oauth.ts

@@ -1,21 +1,22 @@
 import crypto from 'crypto';
-import * as dbutils from '../db/utils';
 import {
   IOAuthController,
+  JacksonOption,
   OAuthReqBody,
   OAuthTokenReq,
   OAuthTokenRes,
   Profile,
   SAMLResponsePayload,
+  Storable,
 } from 'saml-jackson';
+import * as dbutils from '../db/utils';
+import saml from '../saml/saml';
 import { JacksonError } from './error';
 import * as allowed from './oauth/allowed';
 import * as codeVerifier from './oauth/code-verifier';
 import * as redirect from './oauth/redirect';
 import { IndexNames } from './utils';
 
-import saml from '../saml/saml';
-
 const relayStatePrefix = 'boxyhq_jackson_';
 
 function getEncodedClientId(
@@ -39,11 +40,11 @@ function getEncodedClientId(
 }
 
 export class OAuthController implements IOAuthController {
-  private configStore;
-  private sessionStore;
-  private codeStore;
-  private tokenStore;
-  private opts;
+  private configStore: Storable;
+  private sessionStore: Storable;
+  private codeStore: Storable;
+  private tokenStore: Storable;
+  private opts: JacksonOption;
 
   constructor({ configStore, sessionStore, codeStore, tokenStore, opts }) {
     this.configStore = configStore;
@@ -133,6 +134,7 @@ export class OAuthController implements IOAuthController {
     }
 
     const samlReq = saml.request({
+      // @ts-ignore
       entityID: this.opts.samlAudience,
       callbackUrl: this.opts.externalUrl + this.opts.samlPath,
       signingKey: samlConfig.certs.privateKey,
@@ -188,6 +190,8 @@ export class OAuthController implements IOAuthController {
 
     const samlConfigs = await this.configStore.getByIndex({
       name: IndexNames.EntityID,
+
+      // @ts-ignore
       value: parsedResp?.issuer,
     });
 

package/src/saml/{claims.js → claims.ts}

@@ -17,9 +17,12 @@ const mapping = [
     attribute: 'lastName',
     schema: 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname',
   },
-];
+] as const;
 
-const map = (claims) => {
+type attributes = typeof mapping[number]['attribute'];
+type schemas = typeof mapping[number]['schema'];
+
+const map = (claims: Record<attributes | schemas, unknown>) => {
   const profile = {
     raw: claims,
   };
@@ -35,6 +38,4 @@ const map = (claims) => {
   return profile;
 };
 
-module.exports = {
-  map,
-};
+export default { map };

package/src/saml/{x509.js → x509.ts}

@@ -1,5 +1,5 @@
-const x509 = require('@peculiar/x509');
-const { Crypto } = require('@peculiar/webcrypto');
+import * as x509 from '@peculiar/x509';
+import { Crypto } from '@peculiar/webcrypto';
 
 const crypto = new Crypto();
 x509.cryptoProvider.set(crypto);
@@ -14,16 +14,18 @@ const alg = {
 const generate = async () => {
   const keys = await crypto.subtle.generateKey(alg, true, ['sign', 'verify']);
 
-  const extensions = [
+  const extensions: x509.Extension[] = [
     new x509.BasicConstraintsExtension(false, undefined, true),
   ];
 
   extensions.push(
     new x509.KeyUsagesExtension(x509.KeyUsageFlags.digitalSignature, true)
   );
-  extensions.push(
-    await x509.SubjectKeyIdentifierExtension.create(keys.publicKey)
-  );
+  if (keys.publicKey) {
+    extensions.push(
+      await x509.SubjectKeyIdentifierExtension.create(keys.publicKey)
+    );
+  }
 
   const cert = await x509.X509CertificateGenerator.createSelfSigned({
     serialNumber: '01',
@@ -34,15 +36,16 @@ const generate = async () => {
     keys: keys,
     extensions,
   });
-
-  const pkcs8 = await crypto.subtle.exportKey('pkcs8', keys.privateKey);
-
-  return {
-    publicKey: cert.toString('pem'),
-    privateKey: x509.PemConverter.encode(pkcs8, 'private key'),
-  };
+  if (keys.privateKey) {
+    const pkcs8 = await crypto.subtle.exportKey('pkcs8', keys.privateKey);
+
+    return {
+      publicKey: cert.toString('pem'),
+      privateKey: x509.PemConverter.encode(pkcs8, 'private key'),
+    };
+  }
 };
 
-module.exports = {
+export default {
   generate,
 };

package/src/test/db.test.ts

@@ -25,17 +25,17 @@ const record2 = {
   city: 'London',
 };
 
-const memDbConfig: Partial<DatabaseOption> = {
+const memDbConfig = <DatabaseOption>{
   engine: 'mem',
   ttl: 1,
 };
 
-const redisDbConfig: Partial<DatabaseOption> = {
+const redisDbConfig = <DatabaseOption>{
   engine: 'redis',
   url: 'redis://localhost:6379',
 };
 
-const postgresDbConfig: Partial<DatabaseOption> = {
+const postgresDbConfig = <DatabaseOption>{
   engine: 'sql',
   url: 'postgresql://postgres:postgres@localhost:5432/postgres',
   type: 'postgres',
@@ -43,12 +43,12 @@ const postgresDbConfig: Partial<DatabaseOption> = {
   cleanupLimit: 1,
 };
 
-const mongoDbConfig: Partial<DatabaseOption> = {
+const mongoDbConfig = <DatabaseOption>{
   engine: 'mongo',
   url: 'mongodb://localhost:27017/jackson',
 };
 
-const mysqlDbConfig: Partial<DatabaseOption> = {
+const mysqlDbConfig = <DatabaseOption>{
   engine: 'sql',
   url: 'mysql://root:mysql@localhost:3307/mysql',
   type: 'mysql',
@@ -56,7 +56,7 @@ const mysqlDbConfig: Partial<DatabaseOption> = {
   cleanupLimit: 1,
 };
 
-const mariadbDbConfig: Partial<DatabaseOption> = {
+const mariadbDbConfig = <DatabaseOption>{
   engine: 'sql',
   url: 'mariadb://root@localhost:3306/mysql',
   type: 'mariadb',
@@ -111,7 +111,7 @@ const dbs = [
 
 tap.before(async () => {
   for (const idx in dbs) {
-    const opts = <DatabaseOption>dbs[idx];
+    const opts = dbs[idx];
     const db = await DB.new(opts);
 
     configStores.push(db.store('saml:config'));
@@ -130,8 +130,6 @@ tap.test('dbs', ({ end }) => {
     let dbEngine = dbs[idx].engine;
 
     if (dbs[idx].type) {
-      // TODO Fix it
-      // @ts-ignore
       dbEngine += ': ' + dbs[idx].type;
     }
 
@@ -277,10 +275,7 @@ tap.test('dbs', ({ end }) => {
     });
 
     tap.test('ttl expiry: ' + dbEngine, async (t) => {
-      console.log({ dbEngine });
-
       // mongo runs ttl task every 60 seconds
-      // @ts-ignore
       if (dbEngine.startsWith('mongo')) {
         t.end();
         return;
@@ -302,9 +297,9 @@ tap.test('dbs', ({ end }) => {
 
   tap.test('db.new() error', async (t) => {
     try {
-      await DB.new({
-        engine: 'somedb' as DatabaseEngine,
-      } as DatabaseOption);
+      await DB.new(<DatabaseOption>{
+        engine: <DatabaseEngine>'somedb',
+      });
 
       t.fail('expecting an unsupported db error');
     } catch (err) {