@boxyhq/saml-jackson 0.2.3 → 0.3.0-beta.247

package/src/env.js

@@ -1,39 +0,0 @@
-const hostUrl = process.env.HOST_URL || 'localhost';
-const hostPort = (process.env.HOST_PORT || '5000') * 1;
-const externalUrl =
-  process.env.EXTERNAL_URL || 'http://' + hostUrl + ':' + hostPort;
-const samlPath = process.env.SAML_PATH || '/oauth/saml';
-
-const internalHostUrl = process.env.INTERNAL_HOST_URL || 'localhost';
-const internalHostPort = (process.env.INTERNAL_HOST_PORT || '6000') * 1;
-
-const apiKeys = (process.env.JACKSON_API_KEYS || '').split(',');
-
-const samlAudience = process.env.SAML_AUDIENCE;
-const preLoadedConfig = process.env.PRE_LOADED_CONFIG;
-
-const idpEnabled = process.env.IDP_ENABLED;
-const db = {
-  engine: process.env.DB_ENGINE,
-  url: process.env.DB_URL,
-  type: process.env.DB_TYPE,
-  ttl: process.env.DB_TTL,
-  encryptionKey: process.env.DB_ENCRYPTION_KEY,
-};
-
-module.exports = {
-  hostUrl,
-  hostPort,
-  externalUrl,
-  samlPath,
-  samlAudience,
-  preLoadedConfig,
-  internalHostUrl,
-  internalHostPort,
-  apiKeys,
-  idpEnabled,
-  db,
-  useInternalServer: !(
-    hostUrl === internalHostUrl && hostPort === internalHostPort
-  ),
-};

package/src/index.js

@@ -1,67 +0,0 @@
-const DB = require('./db/db.js');
-const readConfig = require('./read-config.js');
-
-const defaultOpts = (opts) => {
-  const newOpts = {
-    ...opts,
-  };
-
-  if (!newOpts.externalUrl) {
-    throw new Error('externalUrl is required');
-  }
-  if (!newOpts.samlPath) {
-    throw new Error('samlPath is required');
-  }
-
-  newOpts.samlAudience = newOpts.samlAudience || 'https://saml.boxyhq.com';
-  newOpts.preLoadedConfig = newOpts.preLoadedConfig || ''; // path to folder containing static SAML config that will be preloaded. This is useful for self-hosted deployments that only have to support a single tenant (or small number of known tenants).
-  newOpts.idpEnabled = newOpts.idpEnabled === true;
-  newOpts.db = newOpts.db || {};
-  newOpts.db.engine = newOpts.db.engine || 'sql'; // Supported values: redis, sql, mongo, mem. Keep comment in sync with db.js
-  newOpts.db.url =
-    newOpts.db.url || 'postgresql://postgres:postgres@localhost:5432/postgres';
-  newOpts.db.type = newOpts.db.type || 'postgres'; // Only needed if DB_ENGINE is sql. Supported values: postgres, cockroachdb, mysql, mariadb
-  newOpts.db.ttl = (newOpts.db.ttl || 300) * 1; // TTL for the code, session and token stores (in seconds)
-  newOpts.db.cleanupLimit = (newOpts.db.cleanupLimit || 1000) * 1; // Limit cleanup of TTL entries to this many items at a time
-
-  return newOpts;
-};
-
-module.exports = async function (opts) {
-  opts = defaultOpts(opts);
-
-  const db = await DB.new(opts.db);
-  const configStore = db.store('saml:config');
-  const sessionStore = db.store('oauth:session', opts.db.ttl);
-  const codeStore = db.store('oauth:code', opts.db.ttl);
-  const tokenStore = db.store('oauth:token', opts.db.ttl);
-
-  const apiController = require('./controller/api.js')({ configStore });
-  const oauthController = require('./controller/oauth.js')({
-    configStore,
-    sessionStore,
-    codeStore,
-    tokenStore,
-    opts,
-  });
-  // write pre-loaded config if present
-  if (opts.preLoadedConfig && opts.preLoadedConfig.length > 0) {
-    const configs = await readConfig(opts.preLoadedConfig);
-
-    for (const config of configs) {
-      await apiController.config(config);
-      console.log(
-        `loaded config for tenant "${config.tenant}" and product "${config.product}"`
-      );
-    }
-  }
-
-  const type =
-    opts.db.engine === 'sql' && opts.db.type ? ' Type: ' + opts.db.type : '';
-  console.log(`Using engine: ${opts.db.engine}.${type}`);
-
-  return {
-    apiController,
-    oauthController,
-  };
-};

package/src/jackson.js

@@ -1,161 +0,0 @@
-const express = require('express');
-const cors = require('cors');
-
-const env = require('./env.js');
-const { extractAuthToken } = require('./controller/utils.js');
-
-let apiController;
-let oauthController;
-
-const oauthPath = '/oauth';
-const apiPath = '/api/v1/saml';
-
-const app = express();
-
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-
-app.get(oauthPath + '/authorize', async (req, res) => {
-  try {
-    const { redirect_url } = await oauthController.authorize(req.query);
-
-    res.redirect(redirect_url);
-  } catch (err) {
-    const { message, statusCode = 500 } = err;
-
-    res.status(statusCode).send(message);
-  }
-});
-
-app.post(env.samlPath, async (req, res) => {
-  try {
-    const { redirect_url } = await oauthController.samlResponse(req.body);
-
-    res.redirect(redirect_url);
-  } catch (err) {
-    const { message, statusCode = 500 } = err;
-
-    res.status(statusCode).send(message);
-  }
-});
-
-app.post(oauthPath + '/token', cors(), async (req, res) => {
-  try {
-    const result = await oauthController.token(req.body);
-
-    res.json(result);
-  } catch (err) {
-    const { message, statusCode = 500 } = err;
-
-    res.status(statusCode).send(message);
-  }
-});
-
-app.get(oauthPath + '/userinfo', async (req, res) => {
-  try {
-    let token = extractAuthToken(req);
-
-    // check for query param
-    if (!token) {
-      token = req.query.access_token;
-    }
-
-    if (!token) {
-      res.status(401).json({ message: 'Unauthorized' });
-    }
-
-    const profile = await oauthController.userInfo(token);
-
-    res.json(profile);
-  } catch (err) {
-    const { message, statusCode = 500 } = err;
-
-    res.status(statusCode).json({ message });
-  }
-});
-
-const server = app.listen(env.hostPort, async () => {
-  console.log(
-    `🚀 The path of the righteous server: http://${env.hostUrl}:${env.hostPort}`
-  );
-
-  const ret = await require('./index.js')(env);
-  apiController = ret.apiController;
-  oauthController = ret.oauthController;
-});
-
-// Internal routes, recommended not to expose this to the public interface though it would be guarded by API key(s)
-let internalApp = app;
-
-if (env.useInternalServer) {
-  internalApp = express();
-
-  internalApp.use(express.json());
-  internalApp.use(express.urlencoded({ extended: true }));
-}
-
-const validateApiKey = (token) => {
-  return env.apiKeys.includes(token);
-};
-
-internalApp.post(apiPath + '/config', async (req, res) => {
-  try {
-    const apiKey = extractAuthToken(req);
-    if (!validateApiKey(apiKey)) {
-      res.status(401).send('Unauthorized');
-      return;
-    }
-
-    res.json(await apiController.config(req.body));
-  } catch (err) {
-    res.status(500).json({
-      error: err.message,
-    });
-  }
-});
-
-internalApp.get(apiPath + '/config', async (req, res) => {
-  try {
-    const apiKey = extractAuthToken(req);
-    if (!validateApiKey(apiKey)) {
-      res.status(401).send('Unauthorized');
-      return;
-    }
-
-    res.json(await apiController.getConfig(req.query));
-  } catch (err) {
-    res.status(500).json({
-      error: err.message,
-    });
-  }
-});
-
-internalApp.delete(apiPath + '/config', async (req, res) => {
-  try {
-    const apiKey = extractAuthToken(req);
-    if (!validateApiKey(apiKey)) {
-      res.status(401).send('Unauthorized');
-      return;
-    }
-    await apiController.deleteConfig(req.body);
-    res.status(200).end();
-  } catch (err) {
-    res.status(500).json({
-      error: err.message,
-    });
-  }
-});
-
-let internalServer = server;
-if (env.useInternalServer) {
-  internalServer = internalApp.listen(env.internalHostPort, async () => {
-    console.log(
-      `🚀 The path of the righteous internal server: http://${env.internalHostUrl}:${env.internalHostPort}`
-    );
-  });
-}
-
-module.exports = {
-  server,
-  internalServer,
-};

package/src/read-config.js

@@ -1,24 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-module.exports = async function (preLoadedConfig) {
-  if (preLoadedConfig.startsWith('./')) {
-    preLoadedConfig = path.resolve(process.cwd(), preLoadedConfig);
-  }
-  const files = await fs.promises.readdir(preLoadedConfig);
-  const configs = [];
-  for (let idx in files) {
-    const file = files[idx];
-    if (file.endsWith('.js')) {
-      const config = require(path.join(preLoadedConfig, file));
-      const rawMetadata = await fs.promises.readFile(
-        path.join(preLoadedConfig, path.parse(file).name + '.xml'),
-        'utf8'
-      );
-      config.rawMetadata = rawMetadata;
-      configs.push(config);
-    }
-  }
-
-  return configs;
-};

package/src/saml/claims.js

@@ -1,40 +0,0 @@
-const mapping = [
-  {
-    attribute: 'id',
-    schema:
-      'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier',
-  },
-  {
-    attribute: 'email',
-    schema:
-      'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
-  },
-  {
-    attribute: 'firstName',
-    schema: 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname',
-  },
-  {
-    attribute: 'lastName',
-    schema: 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname',
-  },
-];
-
-const map = (claims) => {
-  const profile = {
-    raw: claims,
-  };
-
-  mapping.forEach((m) => {
-    if (claims[m.attribute]) {
-      profile[m.attribute] = claims[m.attribute];
-    } else if (claims[m.schema]) {
-      profile[m.attribute] = claims[m.schema];
-    }
-  });
-
-  return profile;
-};
-
-module.exports = {
-  map,
-};

package/src/saml/saml.js

@@ -1,223 +0,0 @@
-const saml = require('@boxyhq/saml20');
-const xml2js = require('xml2js');
-const rambda = require('rambda');
-const thumbprint = require('thumbprint');
-const xmlbuilder = require('xmlbuilder');
-const crypto = require('crypto');
-const xmlcrypto = require('xml-crypto');
-const claims = require('./claims');
-
-const idPrefix = '_';
-const authnXPath =
-  '/*[local-name(.)="AuthnRequest" and namespace-uri(.)="urn:oasis:names:tc:SAML:2.0:protocol"]';
-const issuerXPath =
-  '/*[local-name(.)="Issuer" and namespace-uri(.)="urn:oasis:names:tc:SAML:2.0:assertion"]';
-
-const signRequest = (xml, signingKey) => {
-  if (!xml) {
-    throw new Error('Please specify xml');
-  }
-  if (!signingKey) {
-    throw new Error('Please specify signingKey');
-  }
-
-  const sig = new xmlcrypto.SignedXml();
-  sig.signatureAlgorithm = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256';
-  sig.signingKey = signingKey;
-  sig.addReference(
-    authnXPath,
-    [
-      'http://www.w3.org/2000/09/xmldsig#enveloped-signature',
-      'http://www.w3.org/2001/10/xml-exc-c14n#',
-    ],
-    'http://www.w3.org/2001/04/xmlenc#sha256'
-  );
-  sig.computeSignature(xml, {
-    location: { reference: authnXPath + issuerXPath, action: 'after' },
-  });
-
-  return sig.getSignedXml();
-};
-
-module.exports = {
-  request: ({
-    ssoUrl,
-    entityID,
-    callbackUrl,
-    isPassive = false,
-    forceAuthn = false,
-    identifierFormat = 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
-    providerName = 'BoxyHQ',
-    signingKey,
-  }) => {
-    const id = idPrefix + crypto.randomBytes(10).toString('hex');
-    const date = new Date().toISOString();
-
-    const samlReq = {
-      'samlp:AuthnRequest': {
-        '@xmlns:samlp': 'urn:oasis:names:tc:SAML:2.0:protocol',
-        '@ID': id,
-        '@Version': '2.0',
-        '@IssueInstant': date,
-        '@ProtocolBinding': 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
-        '@Destination': ssoUrl,
-        'saml:Issuer': {
-          '@xmlns:saml': 'urn:oasis:names:tc:SAML:2.0:assertion',
-          '#text': entityID,
-        },
-      },
-    };
-
-    if (isPassive) samlReq['samlp:AuthnRequest']['@IsPassive'] = true;
-
-    if (forceAuthn) {
-      samlReq['samlp:AuthnRequest']['@ForceAuthn'] = true;
-    }
-
-    samlReq['samlp:AuthnRequest']['@AssertionConsumerServiceURL'] = callbackUrl;
-
-    samlReq['samlp:AuthnRequest']['samlp:NameIDPolicy'] = {
-      '@xmlns:samlp': 'urn:oasis:names:tc:SAML:2.0:protocol',
-      '@Format': identifierFormat,
-      '@AllowCreate': 'true',
-    };
-
-    if (providerName != null) {
-      samlReq['samlp:AuthnRequest']['@ProviderName'] = providerName;
-    }
-
-    let xml = xmlbuilder.create(samlReq).end({});
-    if (signingKey) {
-      xml = signRequest(xml, signingKey);
-    }
-
-    return {
-      id,
-      request: xml,
-    };
-  },
-
-  parseAsync: async (rawAssertion) => {
-    return new Promise((resolve, reject) => {
-      saml.parse(rawAssertion, function onParseAsync(err, profile) {
-        if (err) {
-          reject(err);
-          return;
-        }
-
-        resolve(profile);
-      });
-    });
-  },
-
-  validateAsync: async (rawAssertion, options) => {
-    return new Promise((resolve, reject) => {
-      saml.validate(
-        rawAssertion,
-        options,
-        function onValidateAsync(err, profile) {
-          if (err) {
-            reject(err);
-            return;
-          }
-
-          if (profile && profile.claims) {
-            // we map claims to our attributes id, email, firstName, lastName where possible. We also map original claims to raw
-            profile.claims = claims.map(profile.claims);
-
-            // some providers don't return the id in the assertion, we set it to a sha256 hash of the email
-            if (!profile.claims.id) {
-              profile.claims.id = crypto
-                .createHash('sha256')
-                .update(profile.claims.email)
-                .digest('hex');
-            }
-          }
-
-          resolve(profile);
-        }
-      );
-    });
-  },
-
-  parseMetadataAsync: async (idpMeta) => {
-    return new Promise((resolve, reject) => {
-      xml2js.parseString(
-        idpMeta,
-        { tagNameProcessors: [xml2js.processors.stripPrefix] },
-        (err, res) => {
-          if (err) {
-            reject(err);
-            return;
-          }
-
-          const entityID = rambda.path('EntityDescriptor.$.entityID', res);
-          let X509Certificate = null;
-          let ssoPostUrl = null;
-          let ssoRedirectUrl = null;
-          let loginType = 'idp';
-
-          let ssoDes = rambda.pathOr(
-            null,
-            'EntityDescriptor.IDPSSODescriptor',
-            res
-          );
-          if (!ssoDes) {
-            ssoDes = rambda.pathOr([], 'EntityDescriptor.SPSSODescriptor', res);
-            if (!ssoDes) {
-              loginType = 'sp';
-            }
-          }
-
-          for (const ssoDesRec of ssoDes) {
-            const keyDes = ssoDesRec['KeyDescriptor'];
-            for (const keyDesRec of keyDes) {
-              if (keyDesRec['$'] && keyDesRec['$'].use === 'signing') {
-                const ki = keyDesRec['KeyInfo'][0];
-                const cd = ki['X509Data'][0];
-                X509Certificate = cd['X509Certificate'][0];
-              }
-            }
-
-            const ssoSvc =
-              ssoDesRec['SingleSignOnService'] ||
-              ssoDesRec['AssertionConsumerService'] ||
-              [];
-            for (const ssoSvcRec of ssoSvc) {
-              if (
-                rambda.pathOr('', '$.Binding', ssoSvcRec).endsWith('HTTP-POST')
-              ) {
-                ssoPostUrl = rambda.path('$.Location', ssoSvcRec);
-              } else if (
-                rambda
-                  .pathOr('', '$.Binding', ssoSvcRec)
-                  .endsWith('HTTP-Redirect')
-              ) {
-                ssoRedirectUrl = rambda.path('$.Location', ssoSvcRec);
-              }
-            }
-          }
-
-          const ret = {
-            sso: {},
-          };
-          if (entityID) {
-            ret.entityID = entityID;
-          }
-          if (X509Certificate) {
-            ret.thumbprint = thumbprint.calculate(X509Certificate);
-          }
-          if (ssoPostUrl) {
-            ret.sso.postUrl = ssoPostUrl;
-          }
-          if (ssoRedirectUrl) {
-            ret.sso.redirectUrl = ssoRedirectUrl;
-          }
-          ret.loginType = loginType;
-
-          resolve(ret);
-        }
-      );
-    });
-  },
-};

package/src/saml/x509.js

@@ -1,48 +0,0 @@
-const x509 = require('@peculiar/x509');
-const { Crypto } = require('@peculiar/webcrypto');
-
-const crypto = new Crypto();
-x509.cryptoProvider.set(crypto);
-
-const alg = {
-  name: 'RSASSA-PKCS1-v1_5',
-  hash: 'SHA-256',
-  publicExponent: new Uint8Array([1, 0, 1]),
-  modulusLength: 2048,
-};
-
-const generate = async () => {
-  const keys = await crypto.subtle.generateKey(alg, true, ['sign', 'verify']);
-
-  const extensions = [
-    new x509.BasicConstraintsExtension(false, undefined, true),
-  ];
-
-  extensions.push(
-    new x509.KeyUsagesExtension(x509.KeyUsageFlags.digitalSignature, true)
-  );
-  extensions.push(
-    await x509.SubjectKeyIdentifierExtension.create(keys.publicKey)
-  );
-
-  const cert = await x509.X509CertificateGenerator.createSelfSigned({
-    serialNumber: '01',
-    name: 'CN=BoxyHQ Jackson',
-    notBefore: new Date(),
-    notAfter: new Date('3021/01/01'), // TODO: set shorter expiry and rotate ceritifcates
-    signingAlgorithm: alg,
-    keys: keys,
-    extensions,
-  });
-
-  const pkcs8 = await crypto.subtle.exportKey('pkcs8', keys.privateKey);
-
-  return {
-    publicKey: cert.toString('pem'),
-    privateKey: x509.PemConverter.encode(pkcs8, 'private key'),
-  };
-};
-
-module.exports = {
-  generate,
-};