Skip to content

humansecurityMalvDefense Rtd Provider: replacement for cleanioRtdProvider #13517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patmmccann merged 2 commits into from
Jul 4, 2025
Merged

humansecurityMalvDefense Rtd Provider: replacement for cleanioRtdProvider #13517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f2d990
Add humansecurityMalvDefenseRTDProvider as near 1:1 copy of cleanioRT…
avetihon Jul 3, 2025
2098838
cleanioRtdProvider imports all logic from humansecurityMalvDefenseRtd…
avetihon Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
215 changes: 5 additions & 210 deletions modules/cleanioRtdProvider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,219 +6,14 @@
* @requires module:modules/realTimeData
*/

import { submodule } from '../src/hook.js';
import { loadExternalScript } from '../src/adloader.js';
import { logError, generateUUID, insertElement } from '../src/utils.js';
import * as events from '../src/events.js';
import { EVENTS } from '../src/constants.js';
import { MODULE_TYPE_RTD } from '../src/activities/modules.js';
import { createRtdSubmodule } from './humansecurityMalvDefenseRtdProvider.js'; /* eslint prebid/validate-imports: "off" */

/**
* @typedef {import('../modules/rtdModule/index.js').RtdSubmodule} RtdSubmodule
*/

// ============================ MODULE STATE ===============================

/**
* @type {function(): void}
* Page-wide initialization step / strategy
*/
let onModuleInit = () => {};

/**
* @type {function(Object): void}
* Bid response mutation step / strategy.
*/
let onBidResponse = () => {};

/**
* @type {number}
* 0 for unknown, 1 for preloaded, -1 for error.
*/
let preloadStatus = 0;

// ============================ MODULE LOGIC ===============================

/**
* Page initialization step which just preloads the script, to be available whenever we start processing the bids.
* @param {string} scriptURL The script URL to preload
*/
function pageInitStepPreloadScript(scriptURL) {
// TODO: this bypasses adLoader
const linkElement = document.createElement('link');
linkElement.rel = 'preload';
linkElement.as = 'script';
linkElement.href = scriptURL;
linkElement.onload = () => { preloadStatus = 1; };
linkElement.onerror = () => { preloadStatus = -1; };
insertElement(linkElement);
}

/**
* Page initialization step which adds the protector script to the whole page. With that, there is no need wrapping bids, and the coverage is better.
* @param {string} scriptURL The script URL to add to the page for protection
*/
function pageInitStepProtectPage(scriptURL) {
loadExternalScript(scriptURL, MODULE_TYPE_RTD, 'clean.io');
}

/**
* Bid processing step which alters the ad HTML to contain bid-specific information, which can be used to identify the creative later.
* @param {Object} bidResponse Bid response data
*/
function bidWrapStepAugmentHtml(bidResponse) {
bidResponse.ad = `<!-- pbad://creativeId=${bidResponse.creativeId || ''}&bidderCode=${bidResponse.bidderCode || ''}&cpm=${bidResponse.cpm || ''} -->\n${bidResponse.ad}`;
}

/**
* Bid processing step which applies creative protection by wrapping the ad HTML.
* @param {string} scriptURL
* @param {number} requiredPreload
* @param {Object} bidResponse
*/
function bidWrapStepProtectByWrapping(scriptURL, requiredPreload, bidResponse) {
// Still prepend bid info, it's always helpful to have creative data in its payload
bidWrapStepAugmentHtml(bidResponse);

// If preloading failed, or if configuration requires us to finish preloading -
// we should not process this bid any further
if (preloadStatus < requiredPreload) {
return;
}

const sid = generateUUID();
bidResponse.ad = `
<script type="text/javascript"
src="${scriptURL}"
data-api-integration-mode="prebid"
data-api-session-uuid="${sid}">
</script>
<script type="text/javascript">
var ad = "${encodeURIComponent(bidResponse.ad)}";
var agent = window["${sid}"];
if (agent && typeof agent.put === "function") {
agent.put(ad);
}
else {
document.open();
document.write(decodeURIComponent(ad));
document.close();
}
</script>
`;
}

/**
* Custom error class to differentiate validation errors
*/
class ConfigError extends Error { }

/**
* The function to be called upon module init. Depending on the passed config, initializes properly init/bid steps or throws ConfigError.
* @param {Object} config
*/
function readConfig(config) {
if (!config.params) {
throw new ConfigError('Missing config parameters for clean.io RTD module provider.');
}

if (typeof config.params.cdnUrl !== 'string' || !/^https?:\/\//.test(config.params.cdnUrl)) {
throw new ConfigError('Parameter "cdnUrl" is a required string parameter, which should start with "http(s)://".');
}

if (typeof config.params.protectionMode !== 'string') {
throw new ConfigError('Parameter "protectionMode" is a required string parameter.');
}

const scriptURL = config.params.cdnUrl;

switch (config.params.protectionMode) {
case 'full':
onModuleInit = () => pageInitStepProtectPage(scriptURL);
onBidResponse = (bidResponse) => bidWrapStepAugmentHtml(bidResponse);
break;

case 'bids':
onModuleInit = () => pageInitStepPreloadScript(scriptURL);
onBidResponse = (bidResponse) => bidWrapStepProtectByWrapping(scriptURL, 0, bidResponse);
break;

case 'bids-nowait':
onModuleInit = () => pageInitStepPreloadScript(scriptURL);
onBidResponse = (bidResponse) => bidWrapStepProtectByWrapping(scriptURL, 1, bidResponse);
break;

default:
throw new ConfigError('Parameter "protectionMode" must be one of "full" | "bids" | "bids-nowait".');
}
}

/**
* The function to be called upon module init
* Defined as a variable to be able to reset it naturally
*/
let startBillableEvents = function() {
// Upon clean.io submodule initialization, every winner bid is considered to be protected
// and therefore, subjected to billing
events.on(EVENTS.BID_WON, winnerBidResponse => {
events.emit(EVENTS.BILLABLE_EVENT, {
vendor: 'clean.io',
billingId: generateUUID(),
type: 'impression',
auctionId: winnerBidResponse.auctionId,
transactionId: winnerBidResponse.transactionId,
bidId: winnerBidResponse.requestId,
});
});
}

// ============================ MODULE REGISTRATION ===============================

/**
* The function which performs submodule registration.
*/
function beforeInit() {
submodule('realTimeData', /** @type {RtdSubmodule} */ ({
name: 'clean.io',

init: (config, userConsent) => {
try {
readConfig(config);
onModuleInit();

// Subscribing once to ensure no duplicate events
// in case module initialization code runs multiple times
// This should have been a part of submodule definition, but well...
// The assumption here is that in production init() will be called exactly once
startBillableEvents();
startBillableEvents = () => {};
return true;
} catch (err) {
if (err instanceof ConfigError) {
logError(err.message);
}
return false;
}
},

onBidResponseEvent: (bidResponse, config, userConsent) => {
onBidResponse(bidResponse);
}
}));
}
const internals = createRtdSubmodule('clean.io');

/**
* Exporting local (and otherwise encapsulated to this module) functions
* Exporting encapsulated to this module functions
* for testing purposes
*/
export const __TEST__ = {
pageInitStepPreloadScript,
pageInitStepProtectPage,
bidWrapStepAugmentHtml,
bidWrapStepProtectByWrapping,
ConfigError,
readConfig,
beforeInit,
}
export const __CLEANIO_TEST__ = internals;

beforeInit();
internals.beforeInit();
6 changes: 6 additions & 0 deletions modules/cleanioRtdProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ Module Name: clean.io Rtd provider
Module Type: Rtd Provider
Maintainer: nick@clean.io
```
> **Warning!**
>
> The **cleanioRtdProvider** module has been renamed to [humansecurityMalvDefenseRtdProvider](humansecurityMalvDefenseRtdProvider.md) following HUMAN Security's acquisition of the Clean.io project in 2022.
> **cleanioRtdProvider** module is maintained for backward compatibility until the next major Prebid release.
>
> Please use humansecurityMalvDefenseRtdProvider instead of cleanioRtdProvider in your Prebid integration.

The clean.io Realtime module provides effective anti-malvertising solution for publishers, including, but not limited to,
blocking unwanted 0- and 1-click redirects, deceptive ads or those with malicious landing pages, and various types of affiliate fraud.
Expand Down
Loading
Loading