perimeterx-js-core 0.18.2 → 0.19.0

package/lib/esm/custom_parameters/CustomParametersUtils.js

@@ -4,7 +4,7 @@ export var CustomParametersUtils;
     CustomParametersUtils.createCustomParameters = async (config, context) => {
         if (config.enrichCustomParameters && typeof config.enrichCustomParameters === 'function') {
             try {
-                const parameters = await config.enrichCustomParameters(config.toParams(), context.requestData.request.getUnderlyingRequest());
+                const parameters = await config.enrichCustomParameters(config.getActiveConfig(), context.requestData.request.getUnderlyingRequest());
                 return CustomParametersUtils.normalizeCustomParams(parameters);
             }
             catch (e) {

package/lib/esm/telemetry/DefaultTelemetry.js

@@ -1,6 +1,6 @@
 import { AUTHORIZATION_HEADER_NAME, CONTENT_TYPE_HEADER_NAME, ContentType, HttpMethod, OutgoingRequestImpl, } from '../http';
 import { ActivityType } from '../activities';
-import { getAuthorizationHeader, removeSensitiveFields, transferExistingProperties, DefaultTimestampHmacHeaderValidator, } from '../utils';
+import { getAuthorizationHeader, removeSensitiveFields, transferExistingProperties, DefaultTimestampHmacHeaderValidator, telemetryConfigReplacer, } from '../utils';
 import { TELEMETRY_ENDPOINT, TELEMETRY_HEADER_NAME, TELEMETRY_UPDATE_REASON } from './constants';
 export class DefaultTelemetry {
     config;
@@ -49,16 +49,26 @@ export class DefaultTelemetry {
             [AUTHORIZATION_HEADER_NAME]: [getAuthorizationHeader(this.config.authToken)],
         };
         const activity = this.createTelemetryActivity(context);
-        return new OutgoingRequestImpl({ url: url, method: method, headers: headers, body: JSON.stringify(activity) });
+        context.logger.debug(`created telemetry activity config - ${JSON.stringify(activity.details.enforcer_configs, telemetryConfigReplacer)}`);
+        return new OutgoingRequestImpl({
+            url: url,
+            method: method,
+            headers: headers,
+            body: JSON.stringify(activity, telemetryConfigReplacer),
+        });
     }
     createTelemetryActivity(context) {
         const SENSITIVE_CONFIG_FIELDS = [
             'px_auth_token',
             'px_cookie_secret',
             'px_logger_auth_token',
+            'px_remote_config_auth_token',
         ];
-        let config = this.config.toParams();
-        config = removeSensitiveFields(config, SENSITIVE_CONFIG_FIELDS);
+        const telemetryConfig = {
+            active_config: removeSensitiveFields(this.config.getActiveConfig(), SENSITIVE_CONFIG_FIELDS),
+            static_config: removeSensitiveFields(this.config.getStaticConfig(), SENSITIVE_CONFIG_FIELDS),
+            remote_config: removeSensitiveFields(this.config.getRemoteConfig(), SENSITIVE_CONFIG_FIELDS),
+        };
         const activity = {
             type: ActivityType.ENFORCER_TELEMETRY,
             timestamp: Date.now(),
@@ -66,7 +76,7 @@ export class DefaultTelemetry {
             details: {
                 update_reason: TELEMETRY_UPDATE_REASON,
                 module_version: this.config.moduleVersion,
-                enforcer_configs: config,
+                enforcer_configs: telemetryConfig,
             },
         };
         transferExistingProperties(context.serverData, activity.details, {

package/lib/esm/utils/constants.js

@@ -10,4 +10,4 @@ export const PUSH_DATA_HMAC_HEADER_NAME = 'x-px-pushdata';
 export const PUSH_DATA_FEATURE_HEADER_NAME = 'x-px-feature';
 export const EMAIL_ADDRESS_REGEX = /^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$/;
 export const URL_REGEX = /^(https?\:)\/\/(([^@\s:]+):?([^@\s]*)@)?(([^:\/?#]*)(?:\:([0-9]+))?)([\/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/;
-export const CORE_MODULE_VERSION = 'JS Core 0.18.2';
+export const CORE_MODULE_VERSION = 'JS Core 0.19.0';

package/lib/esm/utils/utils.js

@@ -115,3 +115,26 @@ export const algoToCryptoString = (algo) => {
             return 'sha256';
     }
 };
+// Hash based on https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript
+const toHash = (string) => {
+    let hash = 0;
+    if (string.length === 0) {
+        return hash.toString();
+    }
+    for (let i = 0; i < string.length; i++) {
+        const char = string.charCodeAt(i);
+        hash = (hash << 5) - hash + char;
+        hash = hash & hash;
+    }
+    return hash.toString();
+};
+export const telemetryConfigReplacer = (key, value) => {
+    if (value instanceof RegExp) {
+        return '_REGEXP ' + value.toString();
+    }
+    if (value instanceof Function) {
+        return '_FUNCTION_HASH' + toHash(value.toString()); // NOTE: Do not log functions
+    }
+    else
+        return value;
+};

package/lib/types/config/ConfigurationBase.d.ts

@@ -8,7 +8,10 @@ import { ModuleMode } from '../utils';
 import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
 import { CustomRequestFunction } from './CustomRequestFunction';
 export declare abstract class ConfigurationBase<Req, Res, ParamsType extends ConfigurationParams<Req, Res> = ConfigurationParams<Req, Res>> implements IConfiguration<Req, Res, ParamsType> {
-    protected readonly configParams: ParamsType;
+    protected activeConfigParams: ParamsType;
+    protected readonly staticConfigParams: ParamsType;
+    protected remoteConfigParams: ParamsType;
+    protected readonly defaultConfigParams: ParamsType;
     protected internalLogger: ILogger;
     protected abstract getModuleVersion(): string;
     protected constructor(params: ParamsType, defaultParams?: Partial<ParamsType>);
@@ -18,7 +21,10 @@ export declare abstract class ConfigurationBase<Req, Res, ParamsType extends Con
     protected isValidConfigValue(params: ParamsType, defaultParams: ParamsType, key: keyof ParamsType): boolean;
     protected getDefaultConfigurationValue<K extends keyof ParamsType, V extends ParamsType[K]>(params: ParamsType, defaultParams: ParamsType, key: K): V;
     protected createInternalLogger(loggerSeverity: LoggerSeverity): ILogger;
-    toParams(): ParamsType;
+    addRemoteConfig(remoteConfigParams: ParamsType): void;
+    getActiveConfig(): ParamsType;
+    getStaticConfig(): ParamsType;
+    getRemoteConfig(): ParamsType;
     get moduleVersion(): string;
     get logger(): ILogger;
     get appId(): string;
@@ -97,7 +103,6 @@ export declare abstract class ConfigurationBase<Req, Res, ParamsType extends Con
     get ciDefaultLoginSuccessfulHeaderValue(): string;
     get ciDefaultLoginSuccessfulCustomCallback(): CustomLoginSuccessfulCallback<Res>;
     get remoteConfigAuthToken(): string;
-    get remoteConfigSecret(): string;
     get remoteConfigVersion(): number;
     get remoteConfigId(): string;
     get remoteConfigRetryIntervalMs(): number;

package/lib/types/config/IConfiguration.d.ts

@@ -2,7 +2,7 @@ import { ModuleMode } from '../utils';
 import { ILogger, LoggerSeverity } from '../logger';
 import { CustomParametersFunction } from '../custom_parameters';
 import { AdditionalActivityHandler } from '../additional_activity_handler';
-import { ConfigurationParams } from './params';
+import { ConfigurationParams, RemoteConfigurationParams } from './params';
 import { CustomPreflightHandler, CustomBlockResponseHeadersHandler } from '../cors';
 import { CredentialEndpointConfiguration, CredentialIntelligenceVersion, CustomLoginSuccessfulCallback, LoginSuccessfulReportingMethod } from '../products';
 import { CustomRequestFunction } from './CustomRequestFunction';
@@ -333,10 +333,6 @@ export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams
      * The authentication token for the remote configuration service.
      */
     readonly remoteConfigAuthToken: string;
-    /**
-     * The secret used for validating remote config update requests.
-     */
-    readonly remoteConfigSecret: string;
     /**
      * The ID of the remote configuration.
      */
@@ -364,5 +360,17 @@ export interface IConfiguration<Req, Res, ParamsType extends ConfigurationParams
     /**
      * Returns an object representation of the current configuration.
      */
-    toParams(): ParamsType;
+    getActiveConfig(): ParamsType;
+    /**
+     * Returns an object representation of the static configuration.
+     */
+    getStaticConfig(): ParamsType;
+    /**
+     * Returns an object representation of the remote configuration.
+     */
+    getRemoteConfig(): ParamsType;
+    /**
+     * Adds a remote configuration to the current configuration.
+     */
+    addRemoteConfig(remoteConfigurationParams: RemoteConfigurationParams): void;
 }

package/lib/types/config/params/StaticConfigurationParams.d.ts

@@ -3,6 +3,5 @@ export type StaticConfigurationParams = {
     px_cookie_secret: string;
     px_auth_token: string;
     px_logger_auth_token?: string;
-    px_remote_config_secret?: string;
     px_remote_config_auth_token?: string;
 };

package/lib/types/telemetry/model/TelemetryActivity.d.ts

@@ -1,7 +1,7 @@
 import { ActivityType } from '../../activities';
-import { ConfigurationParams } from '../../config';
+import { CommonConfigurationParams, ConfigurationParams, RemoteConfigurationParams, StaticConfigurationParams } from '../../config';
 export type TelemetryActivityDetails = {
-    enforcer_configs: ConfigurationParams<unknown, unknown>;
+    enforcer_configs: TelemetryEnforcerConfiguration;
     module_version: string;
     update_reason: 'command';
     node_name?: string;
@@ -13,3 +13,8 @@ export type TelemetryActivity = {
     px_app_id: string;
     details: TelemetryActivityDetails;
 };
+export type TelemetryEnforcerConfiguration = {
+    active_config: ConfigurationParams<unknown, unknown>;
+    static_config: StaticConfigurationParams & CommonConfigurationParams<unknown, unknown>;
+    remote_config: RemoteConfigurationParams & CommonConfigurationParams<unknown, unknown>;
+};

package/lib/types/utils/constants.d.ts

@@ -10,4 +10,4 @@ export declare const PUSH_DATA_HMAC_HEADER_NAME = "x-px-pushdata";
 export declare const PUSH_DATA_FEATURE_HEADER_NAME = "x-px-feature";
 export declare const EMAIL_ADDRESS_REGEX: RegExp;
 export declare const URL_REGEX: RegExp;
-export declare const CORE_MODULE_VERSION = "JS Core 0.18.2";
+export declare const CORE_MODULE_VERSION = "JS Core 0.19.0";

package/lib/types/utils/utils.d.ts

@@ -20,3 +20,4 @@ export declare const getPropertyFromObject: <T>(object: any, ...keys: Array<stri
 export declare const sleep: (ms: number) => Promise<void>;
 export declare const algoToSubtleCryptoString: (algo: Algorithm) => string;
 export declare const algoToCryptoString: (algo: Algorithm) => string;
+export declare const telemetryConfigReplacer: (key: string, value: any) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perimeterx-js-core",
-  "version": "0.18.2",
+  "version": "0.19.0",
   "description": "",
   "type": "module",
   "typesVersions": {