@boxyhq/saml-jackson 1.1.5 → 1.1.6

package/dist/controller/oauth.js

@@ -161,6 +161,10 @@ class OAuthController {
                     state,
                     tenant,
                     product,
+                    access_type,
+                    resource,
+                    scope,
+                    nonce,
                     code_challenge,
                     code_challenge_method,
                     provider,
@@ -206,6 +210,10 @@ class OAuthController {
                         state,
                         tenant,
                         product,
+                        access_type,
+                        resource,
+                        scope,
+                        nonce,
                         code_challenge,
                         code_challenge_method,
                         provider,

package/dist/controller/sp-config.d.ts

@@ -0,0 +1,21 @@
+import type { JacksonOption } from '../typings';
+export declare class SPSAMLConfig {
+    private opts;
+    constructor(opts: JacksonOption);
+    private get acsUrl();
+    private get entityId();
+    private get responseSigned();
+    private get assertionSignature();
+    private get signatureAlgorithm();
+    private get assertionEncryption();
+    get(): {
+        acsUrl: string;
+        entityId: string;
+        response: string;
+        assertionSignature: string;
+        signatureAlgorithm: string;
+        assertionEncryption: string;
+    };
+    toMarkdown(): string;
+    toHTML(): string;
+}

package/dist/controller/sp-config.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SPSAMLConfig = void 0;
+const marked_1 = require("marked");
+// Service Provider SAML Configuration
+class SPSAMLConfig {
+    constructor(opts) {
+        this.opts = opts;
+    }
+    get acsUrl() {
+        return `${this.opts.externalUrl}${this.opts.samlPath}`;
+    }
+    get entityId() {
+        return `${this.opts.samlAudience}`;
+    }
+    get responseSigned() {
+        return 'Signed';
+    }
+    get assertionSignature() {
+        return 'Signed';
+    }
+    get signatureAlgorithm() {
+        return 'RSA-SHA256';
+    }
+    get assertionEncryption() {
+        return 'Unencrypted';
+    }
+    get() {
+        return {
+            acsUrl: this.acsUrl,
+            entityId: this.entityId,
+            response: this.responseSigned,
+            assertionSignature: this.assertionSignature,
+            signatureAlgorithm: this.signatureAlgorithm,
+            assertionEncryption: this.assertionEncryption,
+        };
+    }
+    toMarkdown() {
+        return markdownTemplate
+            .replace('{{acsUrl}}', this.acsUrl)
+            .replace('{{entityId}}', this.entityId)
+            .replace('{{responseSigned}}', this.responseSigned)
+            .replace('{{assertionSignature}}', this.assertionSignature)
+            .replace('{{signatureAlgorithm}}', this.signatureAlgorithm)
+            .replace('{{assertionEncryption}}', this.assertionEncryption);
+    }
+    toHTML() {
+        return marked_1.marked.parse(this.toMarkdown());
+    }
+}
+exports.SPSAMLConfig = SPSAMLConfig;
+const markdownTemplate = `
+## Service Provider (SP) SAML Configuration
+
+Your Identity Provider (IdP) will ask for the following information while configuring the SAML application. Share this information with your IT administrator.
+
+**ACS (Assertion Consumer Service) URL / Single Sign-On URL / Destination URL** <br />
+{{acsUrl}}
+
+**SP Entity ID / Identifier / Audience URI / Audience Restriction** <br />
+{{entityId}}
+
+**Response** <br />
+{{responseSigned}}
+
+**Assertion Signature** <br />
+{{assertionSignature}}
+
+**Signature Algorithm** <br />
+{{signatureAlgorithm}}
+
+**Assertion Encryption** <br />
+{{assertionEncryption}}
+`;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { OAuthController } from './controller/oauth';
 import { HealthCheckController } from './controller/health-check';
 import { LogoutController } from './controller/logout';
 import { OidcDiscoveryController } from './controller/oidc-discovery';
+import { SPSAMLConfig } from './controller/sp-config';
 import { JacksonOption } from './typings';
 export declare const controllers: (opts: JacksonOption) => Promise<{
     apiController: APIController;
@@ -12,6 +13,7 @@ export declare const controllers: (opts: JacksonOption) => Promise<{
     logoutController: LogoutController;
     healthCheckController: HealthCheckController;
     oidcDiscoveryController: OidcDiscoveryController;
+    spConfig: SPSAMLConfig;
 }>;
 export default controllers;
 export * from './typings';

package/dist/index.js

@@ -33,6 +33,7 @@ const oauth_1 = require("./controller/oauth");
 const health_check_1 = require("./controller/health-check");
 const logout_1 = require("./controller/logout");
 const oidc_discovery_1 = require("./controller/oidc-discovery");
+const sp_config_1 = require("./controller/sp-config");
 const db_1 = __importDefault(require("./db/db"));
 const defaultDb_1 = __importDefault(require("./db/defaultDb"));
 const read_config_1 = __importDefault(require("./read-config"));
@@ -79,6 +80,7 @@ const controllers = (opts) => __awaiter(void 0, void 0, void 0, function* () {
         opts,
     });
     const oidcDiscoveryController = new oidc_discovery_1.OidcDiscoveryController({ opts });
+    const spConfig = new sp_config_1.SPSAMLConfig(opts);
     // write pre-loaded config if present
     if (opts.preLoadedConfig && opts.preLoadedConfig.length > 0) {
         const configs = yield (0, read_config_1.default)(opts.preLoadedConfig);
@@ -90,6 +92,7 @@ const controllers = (opts) => __awaiter(void 0, void 0, void 0, function* () {
     const type = opts.db.engine === 'sql' && opts.db.type ? ' Type: ' + opts.db.type : '';
     console.log(`Using engine: ${opts.db.engine}.${type}`);
     return {
+        spConfig,
         apiController,
         oauthController,
         adminController,

package/dist/typings.d.ts

@@ -199,4 +199,16 @@ export interface OAuthErrorHandlerParams {
     redirect_uri: string;
     state?: string;
 }
+export interface ISPSAMLConfig {
+    get(): {
+        acsUrl: string;
+        entityId: string;
+        response: string;
+        assertionSignature: string;
+        signatureAlgorithm: string;
+        assertionEncryption: string;
+    };
+    toMarkdown(): string;
+    toHTML(): string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxyhq/saml-jackson",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "SAML Jackson library",
   "keywords": [
     "SAML 2.0"
@@ -39,36 +39,37 @@
   },
   "dependencies": {
     "@boxyhq/saml20": "1.0.6",
-    "@opentelemetry/api-metrics": "0.27.0",
     "@opentelemetry/api": "1.0.4",
+    "@opentelemetry/api-metrics": "0.27.0",
     "@peculiar/webcrypto": "1.4.0",
-    "@peculiar/x509": "1.8.1",
-    "jose": "4.8.3",
-    "mongodb": "4.8.1",
+    "@peculiar/x509": "1.8.3",
+    "jose": "4.9.2",
+    "marked": "4.1.0",
+    "mongodb": "4.9.1",
     "mysql2": "2.3.3",
-    "pg": "8.7.3",
-    "redis": "4.0.6",
+    "pg": "8.8.0",
+    "redis": "4.3.1",
     "reflect-metadata": "0.1.13",
     "ripemd160": "2.0.2",
-    "typeorm": "0.3.7",
+    "typeorm": "0.3.9",
     "xml2js": "0.4.23",
     "xmlbuilder": "15.1.1"
   },
   "devDependencies": {
-    "@types/node": "18.6.3",
+    "@types/node": "18.7.16",
     "@types/sinon": "10.0.13",
     "@types/tap": "15.0.7",
-    "@typescript-eslint/eslint-plugin": "5.31.0",
-    "@typescript-eslint/parser": "5.31.0",
+    "@typescript-eslint/eslint-plugin": "5.36.2",
+    "@typescript-eslint/parser": "5.36.2",
     "cross-env": "7.0.3",
-    "eslint": "8.21.0",
+    "eslint": "8.23.0",
     "eslint-config-prettier": "8.5.0",
     "prettier": "2.7.1",
     "sinon": "14.0.0",
     "tap": "16.3.0",
     "ts-node": "10.9.1",
-    "tsconfig-paths": "4.0.0",
-    "typescript": "4.7.4"
+    "tsconfig-paths": "4.1.0",
+    "typescript": "4.8.2"
   },
   "engines": {
     "node": ">=14.18.1 <=16.x"