+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/cards/data.html b/paf-mvp-audit/src/html/cards/data.html
new file mode 100644
index 00000000..db6660df
--- /dev/null
+++ b/paf-mvp-audit/src/html/cards/data.html
@@ -0,0 +1,24 @@
+
+
+
+
+
+
+ + ${ _.advertImageTitle } + +
+
+
+
+
+
+ ${ _.advertHtml }
+
+
+
+
+
+
+ ${ _.advertHtml }
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ${ _.dataModifyPreferences }
+${ _.dataTitle }
+${ _.dataIntro}
++
+
+
+
+
+We don't use any of your personal data, we identify you with a string of characters, that's all + advertisers see.
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/cards/download.html b/paf-mvp-audit/src/html/cards/download.html
new file mode 100644
index 00000000..a7cc3b2a
--- /dev/null
+++ b/paf-mvp-audit/src/html/cards/download.html
@@ -0,0 +1,49 @@
+${ _.downloadTitle }
++ ${ _.downloadBodyHTML } +
++
+
+
+
+
+ ${ _.downloadBox1Title }
+${ _.downloadBox1Body }
+
+
+
+ ${ _.downloadBox2Title }
+${ _.downloadBox2Body }
+
+
+
+${ _.downloadBox3Title }
+${ _.downloadBox3Body }
+
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/cards/participants.html b/paf-mvp-audit/src/html/cards/participants.html
new file mode 100644
index 00000000..401373e3
--- /dev/null
+++ b/paf-mvp-audit/src/html/cards/participants.html
@@ -0,0 +1,22 @@
+${ _.participantsTitle }
+${ _.participantsIntroHTML }
++
+
+
+
+
+${ _.participantsThisContentIntro }
+
+
+${ _.participantsFooterHTML }
diff --git a/paf-mvp-audit/src/html/components/button.html b/paf-mvp-audit/src/html/components/button.html
index 2dbfa877..4c944680 100644
--- a/paf-mvp-audit/src/html/components/button.html
+++ b/paf-mvp-audit/src/html/components/button.html
@@ -1 +1,5 @@
-${ _.open }
\ No newline at end of file
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/data.html b/paf-mvp-audit/src/html/components/data.html
new file mode 100644
index 00000000..3d9c2ed3
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/data.html
@@ -0,0 +1,34 @@
+
+
+
+${ _.field }
+ +
+
+
+${ _.dataSetupDateField }
+ +
+
+
+ ${ _.dataTermsUsedField }
+
+
+
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/participantSuspicious.html b/paf-mvp-audit/src/html/components/participantSuspicious.html
new file mode 100644
index 00000000..a48ae91c
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/participantSuspicious.html
@@ -0,0 +1,8 @@
+
+ ${ _.statusHtml }
+
+
+
+ ${ _.name }
+ +
+
+
+
+
+ ${ _.participantSuspicious }
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/participantTrusted.html b/paf-mvp-audit/src/html/components/participantTrusted.html
new file mode 100644
index 00000000..6abb8b4d
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/participantTrusted.html
@@ -0,0 +1,8 @@
+
+ ${ _.participantTrusted }
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/participantViolating.html b/paf-mvp-audit/src/html/components/participantViolating.html
new file mode 100644
index 00000000..8dd1acd3
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/participantViolating.html
@@ -0,0 +1,9 @@
+
+ ${ _.participantViolating }
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/provider.html b/paf-mvp-audit/src/html/components/provider.html
deleted file mode 100644
index 7d02c491..00000000
--- a/paf-mvp-audit/src/html/components/provider.html
+++ /dev/null
@@ -1,18 +0,0 @@
-${ _.ResultSVG }
-${ _.Name }
- - \ No newline at end of file diff --git a/paf-mvp-audit/src/html/components/statusgood.html b/paf-mvp-audit/src/html/components/statusgood.html new file mode 100644 index 00000000..e21f9010 --- /dev/null +++ b/paf-mvp-audit/src/html/components/statusgood.html @@ -0,0 +1,10 @@ +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statusinprogress.html b/paf-mvp-audit/src/html/components/statusinprogress.html
new file mode 100644
index 00000000..5706921f
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statusinprogress.html
@@ -0,0 +1,5 @@
+${ _.advertGoodTitle }
+ ${ _.advertGoodBodyHTML } +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statussluggood.html b/paf-mvp-audit/src/html/components/statussluggood.html
new file mode 100644
index 00000000..f34eaca0
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statussluggood.html
@@ -0,0 +1,8 @@
+
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statusslugsuspicious.html b/paf-mvp-audit/src/html/components/statusslugsuspicious.html
new file mode 100644
index 00000000..1463ad4e
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statusslugsuspicious.html
@@ -0,0 +1,8 @@
+
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statusslugviolation.html b/paf-mvp-audit/src/html/components/statusslugviolation.html
new file mode 100644
index 00000000..f0382b09
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statusslugviolation.html
@@ -0,0 +1,9 @@
+
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statussuspicious.html b/paf-mvp-audit/src/html/components/statussuspicious.html
new file mode 100644
index 00000000..6ea0bda7
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statussuspicious.html
@@ -0,0 +1,22 @@
+${ _.advertInProgressTitle }
+ ${ _.advertInProgressBodyHTML } +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/statusviolation.html b/paf-mvp-audit/src/html/components/statusviolation.html
new file mode 100644
index 00000000..afcf9845
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/statusviolation.html
@@ -0,0 +1,23 @@
+${ _.advertSuspiciousTitle }
+ ${ _.advertSuspiciousBodyHTML } + +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/suspicious.html b/paf-mvp-audit/src/html/components/suspicious.html
new file mode 100644
index 00000000..6f5778f4
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/suspicious.html
@@ -0,0 +1,29 @@
+${ _.advertViolationTitle }
+ ${ _.advertViolationBodyHTML } + +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/components/tabs.html b/paf-mvp-audit/src/html/components/tabs.html
new file mode 100644
index 00000000..e69de29b
diff --git a/paf-mvp-audit/src/html/components/violation.html b/paf-mvp-audit/src/html/components/violation.html
new file mode 100644
index 00000000..bc78e402
--- /dev/null
+++ b/paf-mvp-audit/src/html/components/violation.html
@@ -0,0 +1,31 @@
+Suspicious transaction detected
+We detected one or more suspicious transaction in this advertisement's supply chain.
+ +
+
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/html/containers/audit.html b/paf-mvp-audit/src/html/containers/audit.html
index 52e7d63c..f3d2d0e8 100644
--- a/paf-mvp-audit/src/html/containers/audit.html
+++ b/paf-mvp-audit/src/html/containers/audit.html
@@ -1,32 +1,116 @@
-Violation detected
+We take your privacy seriously, we removed bad parties from our supply chain and we are reported to the + authorites. If you want to take steps yourself this is what you can do:
+ +
+
;
+}
+
+/**
+ * Returns the identity using a map of host keys to identities.
+ */
+export class IdentityResolverMap implements IdentityResolver {
+ public readonly map: Map;
+
+ /**
+ * New instance of the identity resolver backed with a map.
+ * @param millisecondDelay length of time to wait in milliseconds before responding
+ * @param map of prepared identities or empty of not available
+ */
+ constructor(private readonly millisecondDelay: number, map?: Map) {
+ this.map = map ?? new Map();
+ }
+
+ /**
+ * Waits for the time to pass before responding. Simulates network latency.
+ * @param milliseconds to wait before responding
+ * @returns
+ */
+ private delay(milliseconds: number): Promise {
+ return new Promise((resolve) => setTimeout(resolve, milliseconds));
+ }
+
+ /**
+ * Returns the identity for the host, or null if the host has no identity.
+ * @param host
+ */
+ public get(host: string): Promise {
+ if (this.millisecondDelay > 0) {
+ return this.delay(this.millisecondDelay).then(() => this.map.get(host));
+ }
+ return Promise.resolve(this.map.get(host));
+ }
+}
+
+/**
+ * Returns the identity using an HTTP request to the host.
+ */
+export class IdentityResolverHttp implements IdentityResolver {
+ /**
+ * Cache of responses found so far.
+ */
+ private readonly map = new Map();
+
+ /**
+ * Constructs a new HTTP identity resolver.
+ * @param log for recording HTTP response text when an error occurs
+ */
+ constructor(private readonly log: Log) {}
+
+ /**
+ * Returns the identity for the host, or null if the host has no identity.
+ * Uses a map to avoid requesting the same identity information from the network.
+ * @param host
+ */
+ public async get(host: string): Promise {
+ let identity = this.map.get(host);
+ if (identity === null) {
+ const response = await fetch(`https://${host}/paf/v1/identity`, {
+ method: 'GET',
+ mode: 'cors',
+ cache: 'default',
+ });
+ if (response) {
+ identity = await response.json();
+ this.map.set(host, identity);
+ } else {
+ this.log.Warn(response.statusText);
+ }
+ }
+ return identity;
+ }
+}
diff --git a/paf-mvp-audit/src/images/AdvertIcon.svg b/paf-mvp-audit/src/images/AdvertIcon.svg
new file mode 100644
index 00000000..94341a68
--- /dev/null
+++ b/paf-mvp-audit/src/images/AdvertIcon.svg
@@ -0,0 +1,3 @@
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/images/DownloadIcon.svg b/paf-mvp-audit/src/images/DownloadIcon.svg
new file mode 100644
index 00000000..f73fcd0b
--- /dev/null
+++ b/paf-mvp-audit/src/images/DownloadIcon.svg
@@ -0,0 +1,3 @@
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/images/IconCross.svg b/paf-mvp-audit/src/images/IconCross.svg
deleted file mode 100644
index 916fa0b3..00000000
--- a/paf-mvp-audit/src/images/IconCross.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
\ No newline at end of file
diff --git a/paf-mvp-audit/src/images/IconTick.svg b/paf-mvp-audit/src/images/IconTick.svg
deleted file mode 100644
index 66ea6bb4..00000000
--- a/paf-mvp-audit/src/images/IconTick.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
\ No newline at end of file
diff --git a/paf-mvp-audit/src/images/OneKeyIcon.svg b/paf-mvp-audit/src/images/OneKeyIcon.svg
new file mode 100644
index 00000000..ec0e7259
--- /dev/null
+++ b/paf-mvp-audit/src/images/OneKeyIcon.svg
@@ -0,0 +1,9 @@
+
diff --git a/paf-mvp-audit/src/images/ParticipantsIcon.svg b/paf-mvp-audit/src/images/ParticipantsIcon.svg
new file mode 100644
index 00000000..68f83034
--- /dev/null
+++ b/paf-mvp-audit/src/images/ParticipantsIcon.svg
@@ -0,0 +1,6 @@
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/images/YourDataIcon.svg b/paf-mvp-audit/src/images/YourDataIcon.svg
new file mode 100644
index 00000000..77bde98b
--- /dev/null
+++ b/paf-mvp-audit/src/images/YourDataIcon.svg
@@ -0,0 +1,3 @@
+
\ No newline at end of file
diff --git a/paf-mvp-audit/src/locale.ts b/paf-mvp-audit/src/locale.ts
deleted file mode 100644
index 3df2416f..00000000
--- a/paf-mvp-audit/src/locale.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import en_us from './locales/en-us.yaml';
-import en_gb from './locales/en-gb.yaml';
-
-export class Values {
- // Audit text
- auditHeading = 'NOT SET';
- auditBody: string[];
- auditFooter = 'NOT SET';
-
- // Button text
- download = 'NOT SET';
- cancel = 'NOT SET';
-}
-
-export class Locale extends Values {
- public readonly auditBodyHTML: string;
-
- /**
- * Logo to use with the templates.
- */
- public Logo = '';
-
- constructor(languages: readonly string[]) {
- super();
-
- // Use US english as the default locale.
- Object.assign(this, en_us);
-
- // Replace any values with the users chosen locale.
- Object.assign(this, this.getLocale(languages));
-
- // Extract the arrays into paragraph HTML element strings.
- this.auditBodyHTML = this.toHtml(this.auditBody);
- }
-
- private toHtml(list: string[]): string {
- return `en_gb;
- case 'en-US':
- return en_us;
- }
- }
- return en_us;
- }
-}
diff --git a/paf-mvp-audit/src/locales/en-gb.yaml b/paf-mvp-audit/src/locales/en-gb.yaml
deleted file mode 100644
index 62a05461..00000000
--- a/paf-mvp-audit/src/locales/en-gb.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-# Audit text
-auditHeading: Your ad-funded access (GB)
-auditBody:
- - The following OneKey participating providers funded your access to this site's content. These organizations do not directly identify you, but rely instead on your OneKey ID and preferences for this purpose. Your OneKey ID will automatically reset every 6 months or you can reset your ID or preference at any time by clicking here.
-auditFooter: If you believe an organization didn't honour your preferences, click the email icon to send them this audit for investigation. You may also download the same audit data to send to the appropriate government authority.
-
-# Button text
-download: Download text file
-cancel: Cancel
-open: Ad audit by OneKey
\ No newline at end of file
diff --git a/paf-mvp-audit/src/locales/en-us.yaml b/paf-mvp-audit/src/locales/en-us.yaml
index bd5eece6..aebfb155 100644
--- a/paf-mvp-audit/src/locales/en-us.yaml
+++ b/paf-mvp-audit/src/locales/en-us.yaml
@@ -1,10 +1,120 @@
-# Audit text
-auditHeading: Your ad-funded access (US)
-auditBody:
- - The following OneKey participating providers funded your access to this site's content. These organizations do not directly identify you, but rely instead on your OneKey ID and preferences for this purpose. Your OneKey ID will automatically reset every 6 months or you can reset your ID or preference at any time by clicking here.
-auditFooter: If you believe an organization didn't honour your preferences, click the email icon to send them this audit for investigation. You may also download the same audit data to send to the appropriate government authority.
+# Navigation text
+navAdvertAudit: Audit
+navAdvert: Content
+navYourChoices: Your choices
+navParticipants: Participants
+navDownload: Download
+
+# Advert text
+
+## Advert title text
+advertTitlePersonalized: This content was personalized for you
+advertTitleStandard: This content was not personalized for you
+
+## Advert image title
+advertImageTitle: Show the content image
+
+## Advert date of preferences
+advertDate: As you indicated on [Date]
+
+## Advert intro thank you
+advertThankYouPersonalized: Thank you for supporting our digital property by choosing personalized ads. ❤️
+advertThankYouStandard: Thank you for supporting our digital property by participating.
+
+## Advert statuses
+advertGoodTitle: No suspicious transactions found
+advertGoodBody:
+ - Everything is fine with the participants who helped display this content.
+advertSuspiciousTitle: Suspicious transactions detected
+advertSuspiciousBody:
+ - "[SuspiciousParticipants] participants who helped display this content couldn't be verified."
+advertSuspiciousButton: Check participants
+advertViolationTitle: Violations detected
+advertViolationBody:
+ - The terms and conditions for the use of data were violated by [ViolatingParticipants] . You can contact them directly.
+advertViolationButton: Contact violating participants
+advertInProgressTitle: Fetching the data…
+advertInProgressBody:
+ - Checking the participants involved in selecting this content.
+advertLearnMore: Learn more
+advertLearnMoreUrl: https://portal.onekey.network
+
+## Advert pause
+advertPauseTitle: Pause this Ad
+advertPauseInstruction: If you don’t like this advert, you can let the brand know.
+advertPauseButton: Pause this Ad
+
+# Data
+dataTitle: Data
+dataIntro: This is the data used to select this content.
+
+dataPreference: Marketing preference
+dataPreferenceStandard: Standard
+dataPreferencePersonalized: Personalized
+dataRandomIdField: Random browser ID
+dataSetupDateField: Setup date
+dataSetupDateText: Set up on [Date] by [Name]
+dataTermsUsedField: Terms used
+dataModifyPreferences: Modify preferences
+
+# Participant statuses
+participantTrusted: Trusted
+participantSuspicious: Suspicious
+participantViolating: Violation detected
+
+# Participants
+participantsTitle: Participants
+participantsIntro:
+ - The following OneKey participating providers funded your access to this site's content. These organizations do not directly identify you but rely instead on your OneKey ID and preferences for this purpose. Your OneKey ID will automatically reset every 6 months or you can reset your ID or preference at any time by clicking here.
+participantsFooter:
+ - If you believe an organization didn't honour your preferences, select the contact button to send them this audit for investigation. You may also download the same audit data to send to the appropriate government authority.
+participantsThisContent: This content
+participantsThisContentIntro: The following participants were specifically involved in showing you this content.
+participantsAll: All participants
+participantsAllIntro: The following participants were involved in the selection of this content.
+participantsSuspicious: Suspicious participants
+participantsSuspiciousIntro: The following participants either could not be verified, or failed validation. Click the contact button to send them this audit for investigation.
# Button text
-download: Download text file
-cancel: Cancel
-open: Ad audit by OneKey
\ No newline at end of file
+download: Download data (JSON)
+close: Close
+terms: See Terms
+contact: Contact
+
+# DPO email
+emailPreferencePersonalized: Personalized marketing
+emailPreferenceStandard: Standard marketing
+emailSubject: OneKey Data Protection Request
+emailBody:
+ - To whom it may concern,
+ -
+ - I believe [Name] used my personal information without a valid legal basis on [TimeStamp].
+ -
+ - On the [PreferenceDate] I consented to the use of my data for [PreferenceText].
+ -
+ - You cryptographically signed you received this information, shown at the bottom of this email. We therefore agree that you were in possession of this data.
+ -
+ - You are bound by the privacy policy here.
+ -
+ - "[PrivacyURL]"
+ -
+ - I would be grateful if you can respond by email to this address within 7 working days to explain why my preference was not honoured.
+ -
+ - Regards,
+ -
+ - INSERT YOUR NAME
+ -
+ - --- DO NOT CHANGE THE TEXT BELOW THIS LINE ---
+ - '[Proof]'
+ - --- DO NOT CHANGE THE TEXT ABOVE THIS LINE ---
+
+# Download
+downloadTitle: Download the full audit data
+downloadBody:
+ - Use this data to help keep advertising safe for everyone.
+downloadBox1Title: 3rd party plugins
+downloadBox1Body: Encourage 3rd parties to collect this data to help monitor online safety.
+downloadBox2Title: Report to authorities
+downloadBox2Body: Send to data protection authorities.
+downloadBox3Title: Keep records
+downloadBox3Body: Record all the advertising you've been exposed to.
diff --git a/paf-mvp-audit/src/main.ts b/paf-mvp-audit/src/main.ts
deleted file mode 100644
index 912064fb..00000000
--- a/paf-mvp-audit/src/main.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import { Locale } from './locale';
-import { Controller } from './controller';
-import { Log } from '@core/log';
-
-const log = new Log('audit', '#18a9e1');
-
-class MonitoredElement extends HTMLDivElement {
- public timer: NodeJS.Timer;
-}
-
-document.querySelectorAll('[auditLog]').forEach((e) => {
- if (e instanceof HTMLDivElement) {
- log.Message('register', e.id);
- const content = e.innerHTML;
- (e).timer = setInterval(() => {
- log.Message('check', e.id);
- if (content !== e.innerHTML) {
- log.Message('adding', e.id);
- clearInterval((e).timer);
- new Controller(new Locale(window.navigator.languages), e, log);
- }
- }, 1000);
- }
-});
diff --git a/paf-mvp-audit/src/model.ts b/paf-mvp-audit/src/model.ts
index b257c923..ef62374f 100644
--- a/paf-mvp-audit/src/model.ts
+++ b/paf-mvp-audit/src/model.ts
@@ -1,15 +1,319 @@
import { Field, IFieldBind, IModel } from '@core/ui/fields';
-import { AuditLog, TransmissionResult } from '@core/model/generated-model';
+import { AuditLog, Identifier, IdsAndPreferences, Seed, TransmissionResult } from '@core/model/generated-model';
+import { GetIdentityResponse } from '@core/model/generated-model';
+import { IdentityResolver } from './identity-resolver';
+import {
+ IdentifierDefinition,
+ IdsAndPreferencesDefinition,
+ IdsAndPreferencesVerifier,
+ SeedSignatureContainer,
+ Verifier,
+} from '@core/crypto';
+import { PublicKeyResolver } from './public-key-resolver';
+import { SeedDefinition, TransmissionContainer, TransmissionDefinition } from './signing-definitions';
+import { ILocale } from '@core/ui/ILocale';
+import { getDate } from '@core/timestamp';
+import { Log } from '@core/log';
/**
- * Field represents the transmission result from the audit log.
+ * The currently selected tab on the participants card.
*/
-export class FieldTransmissionResult extends Field implements IFieldBind {}
+export enum ParticipantsTabs {
+ This,
+ All,
+ Suspicious,
+}
+
+/**
+ * The currently selected tab on the your choices card.
+ */
+export enum DataTabs {
+ Identifiers,
+ Preferences,
+ SyncId, // Not used.
+}
+
+/**
+ * Different status associated with fields in the model.
+ */
+export enum VerifiedStatus {
+ IdentityNotFound = 'IdentityNotFound',
+ Valid = 'Valid',
+ NotValid = 'NotValid',
+ Processing = 'Processing', // model verification is not complete
+}
+
+/**
+ * Overall statuses that are used to determine what is communicated to the user.
+ */
+export enum OverallStatus {
+ Good = 'Good', // all good
+ Suspicious = 'Suspicious', // something suspicious but not a breach. i.e. 404 when fetching identity
+ Violation = 'Violation', // proof that something bad has happened
+ Processing = 'Processing', // model verification is not complete
+}
+
+/**
+ * Used to hold a list of all the verified fields in the model.
+ */
+export interface IVerifiedValue {
+ /**
+ * Identity information associated with the source which is populated when the promise completes.
+ * Returns undefined if the processing to establish identity is not complete.
+ * Returns null if the processing completed but failed.
+ */
+ get identity(): GetIdentityResponse;
+
+ /**
+ * Gets the verified status of the field after the promises have resolved.
+ * @returns the verified status of the field
+ */
+ get verifiedStatus(): VerifiedStatus;
+
+ /**
+ * Boolean field to indicate if the source signature is valid. Might be false if the source identity could not be
+ * found or if the signature is invalid.
+ * Returns undefined if the processing to establish validity is not complete.
+ */
+ get valid(): boolean;
+
+ /**
+ * Completes the verification process.
+ */
+ verify(): Promise;
+}
+
+/**
+ * Base class used by any value that can be signed. All signed values must have a source and therefore an identifier
+ * will need to be fetched. This class handles the fetching of identity that will be the same for all signed values and
+ * the subsequent request to verify the value.
+ * @type T with a source that will be used with the signed value.
+ */
+export abstract class VerifiedValue implements IVerifiedValue {
+ /**
+ * Identity information associated with the source which is populated when the promise completes.
+ * Returns undefined if the processing to establish identity is not complete.
+ * Returns null if the processing completed but failed.
+ */
+ public identity: GetIdentityResponse | null = undefined;
+
+ /**
+ * Boolean field to indicate if the source signature is valid. Might be false if the source identity could not be
+ * found or if the signature is invalid.
+ * Returns undefined if the processing to establish validity is not complete.
+ */
+ public valid: boolean = undefined;
+
+ /**
+ * Gets the verified status of the field after the promises have resolved.
+ * @returns the verified status of the field
+ */
+ public get verifiedStatus(): VerifiedStatus {
+ if (this.valid === undefined) {
+ return VerifiedStatus.Processing;
+ }
+ if (this.identity) {
+ return this.valid ? VerifiedStatus.Valid : VerifiedStatus.NotValid;
+ }
+ return VerifiedStatus.IdentityNotFound;
+ }
+
+ /**
+ * A new instance of a verified value that will have commenced the process of verification.
+ * @param log
+ * @param identityPromise that may not yet be resolved to fetch the identity information
+ * @param value the signed value that will be verified
+ */
+ constructor(
+ protected readonly log: Log,
+ private readonly identityPromise: Promise,
+ public readonly value: T
+ ) {}
+
+ /**
+ * Completes the verification process for the value.
+ */
+ public async verify() {
+ try {
+ this.identity = await this.identityPromise;
+ } catch (e) {
+ this.log.Message('identityPromise', e);
+ this.identity = null;
+ }
+ if (this.identity) {
+ try {
+ this.valid = await this.verifySignature();
+ } catch (e) {
+ this.log.Message('verifySignature', e);
+ this.valid = false;
+ }
+ } else {
+ this.valid = false;
+ }
+ }
+
+ /**
+ * Method called to start the verification process once the identity has been obtained.
+ */
+ protected abstract verifySignature(): Promise;
+}
+
+export class VerifiedSeed extends VerifiedValue {
+ /**
+ * Static instance of the ids and preferences definition for use with the verifier.
+ */
+ private static readonly definition = new SeedDefinition();
+
+ /**
+ * Constructs a new instance of the verified ids and preferences value.
+ * @param log
+ * @param identityResolver used to retrieve identities for host names.
+ * @param idsAndPreferences
+ * @param seed
+ */
+ constructor(
+ log: Log,
+ identityResolver: IdentityResolver,
+ private readonly idsAndPreferences: IdsAndPreferences,
+ seed: Seed
+ ) {
+ super(log, identityResolver.get(seed.source.domain), seed);
+ }
+
+ protected verifySignature(): Promise {
+ const verifier = new Verifier(
+ new PublicKeyResolver(this.log, this.identity, this.value.source.timestamp).provider,
+ VerifiedSeed.definition
+ );
+ return verifier.verifySignature({ seed: this.value, idsAndPreferences: this.idsAndPreferences });
+ }
+}
+
+export class VerifiedIdentifier extends VerifiedValue {
+ /**
+ * Static instance of the identifier definition for use with the verifier.
+ */
+ private static readonly definition = new IdentifierDefinition();
+
+ /**
+ * Constructs a new instance of the verified ids and preferences value.
+ * @param log
+ * @param identityResolver used to retrieve identities for host names.
+ * @param identifier
+ */
+ constructor(log: Log, identityResolver: IdentityResolver, identifier: Identifier) {
+ super(log, identityResolver.get(identifier.source.domain), identifier);
+ }
+
+ protected verifySignature(): Promise {
+ const verifier = new Verifier(
+ new PublicKeyResolver(this.log, this.identity, this.value.source.timestamp).provider,
+ VerifiedIdentifier.definition
+ );
+ return verifier.verifySignature(this.value);
+ }
+}
+
+export class VerifiedIdsAndPreferences extends VerifiedValue {
+ /**
+ * Static instance of the ids and preferences definition for use with the verifier.
+ */
+ private static readonly definition = new IdsAndPreferencesDefinition();
+
+ /**
+ * Constructs a new instance of the verified ids and preferences value.
+ * @param log
+ * @param identityResolver used to retrieve identities for host names.
+ * @param idsAndPreferences
+ */
+ constructor(log: Log, identityResolver: IdentityResolver, idsAndPreferences: IdsAndPreferences) {
+ super(log, identityResolver.get(idsAndPreferences.preferences.source.domain), idsAndPreferences);
+ }
+
+ protected verifySignature(): Promise {
+ const verifier = new IdsAndPreferencesVerifier(
+ new PublicKeyResolver(this.log, this.identity, this.value.preferences.source.timestamp).provider,
+ VerifiedIdsAndPreferences.definition
+ );
+ return verifier.verifySignature(this.value);
+ }
+}
+
+/**
+ * A verified transmission result from the audit log.
+ */
+export class VerifiedTransmissionResult extends VerifiedValue {
+ /**
+ * Static instance of the ids and preferences definition for use with the verifier.
+ */
+ private static readonly definition = new TransmissionDefinition();
+
+ /**
+ * Constructs a new instance of TransmissionResultNode for the audit log record provided.
+ * @param log
+ * @param identityResolver used to retrieve identities for host names.
+ * @param idsAndPreferences
+ * @param seed
+ * @param result returned in the audit log.
+ */
+ constructor(
+ log: Log,
+ identityResolver: IdentityResolver,
+ private readonly idsAndPreferences: IdsAndPreferences,
+ private readonly seed: Seed,
+ result: TransmissionResult
+ ) {
+ super(log, identityResolver.get(result.source.domain), result);
+ }
+
+ protected verifySignature(): Promise {
+ const verifier = new Verifier(
+ new PublicKeyResolver(this.log, this.identity, this.value.source.timestamp).provider,
+ VerifiedTransmissionResult.definition
+ );
+ return verifier.verifySignature({ idsAndPreferences: this.idsAndPreferences, seed: this.seed, result: this.value });
+ }
+
+ /**
+ * Builds the email hyperlink for the complaint method.
+ * @param locale the email to complain about the signer of the transmission result
+ * @returns a mail:>// URL to open an email message
+ */
+ public buildEmailUrl(locale: ILocale): string {
+ const body = encodeURIComponent(
+ (locale.emailBodyText)
+ .replace('[Name]', this.identity.name)
+ .replace('[TimeStamp]', getDate(this.value.source.timestamp).toLocaleString())
+ .replace('[PrivacyURL]', this.identity.privacy_policy_url)
+ .replace('[PreferenceDate]', getDate(this.idsAndPreferences.preferences.source.timestamp).toLocaleString())
+ .replace(
+ '[PreferenceText]',
+ this.idsAndPreferences.preferences.data.use_browsing_for_personalization
+ ? locale.emailPreferencePersonalized
+ : locale.emailPreferenceStandard
+ )
+ .replace('[Proof]', [JSON.stringify(this.seed)].join('\r\n'))
+ .trim()
+ );
+ const subject = encodeURIComponent(locale.emailSubject);
+ return `mailto:${this.identity.dpo_email}?subject=${subject}&body=${body}`;
+ }
+}
/**
* The model used in the module.
*/
export class Model implements IModel {
+ /**
+ * Current tab for the display of participants.
+ */
+ public participantsTab = new Field(this, ParticipantsTabs.This);
+
+ /**
+ * Current tab for the display of choices and data.
+ */
+ public dataTab = new Field(this, DataTabs.Preferences);
+
/**
* Set to true when model update operations are occurring. Results in the methods to update other properties being
* disabled.
@@ -19,7 +323,27 @@ export class Model implements IModel {
/**
* The data fields that relate to each transmission result to be displayed.
*/
- readonly results: FieldTransmissionResult[] = [];
+ readonly results: Field[] = [];
+
+ /**
+ * Verified field for the seed.
+ */
+ readonly seed: Field;
+
+ /**
+ * Verified field for the preferences which must also include the identifiers.
+ */
+ readonly idsAndPreferences: Field;
+
+ /**
+ * Array of identifier fields.
+ */
+ readonly identifiers: Field[];
+
+ /**
+ * All the fields that relate to verified values.
+ */
+ readonly allVerifiedFields: Field[] = [];
/**
* All the fields that need to be bound.
@@ -27,15 +351,101 @@ export class Model implements IModel {
readonly allFields: IFieldBind[] = [];
/**
- * Constructs the data model from the audit log.
- * @param audit
+ * Overall status of the model updated after verify.
*/
- constructor(audit: AuditLog) {
- audit.transmissions?.forEach((t) => {
- const field = new FieldTransmissionResult(this, t);
- this.results.push(field);
+ readonly overall = new Field(this, OverallStatus.Processing);
+
+ /**
+ * Constructs the data model from the audit log starting the promises to retrieve identity and then verify the values.
+ * @remarks The model must not be used until the promise returned from the verify() method resolves.
+ * @param log
+ * @param auditLog the original raw audit log.
+ * @param identityResolver used to retrieve identities for host names.
+ */
+ constructor(log: Log, identityResolver: IdentityResolver, private readonly auditLog: AuditLog) {
+ // Add the simple fields created before the constructor runs.
+ this.allFields.push(this.overall);
+ this.allFields.push(this.participantsTab);
+ this.allFields.push(this.dataTab);
+
+ // Add the identifier fields to the model.
+ this.identifiers = [];
+ auditLog.data.identifiers.forEach((i) => {
+ const field = new Field(this, new VerifiedIdentifier(log, identityResolver, i));
+ this.identifiers.push(field);
+ this.allVerifiedFields.push(field);
this.allFields.push(field);
});
+
+ // Create the field for the seed and add the value to the list of values being verified.
+ this.seed = new Field(
+ this,
+ new VerifiedSeed(log, identityResolver, auditLog.data, auditLog.seed)
+ );
+ this.allVerifiedFields.push(this.seed);
+ this.allFields.push(this.seed);
+
+ // Create the field for the ids and preferences and add the value to the list of values being verified.
+ this.idsAndPreferences = new Field(
+ this,
+ new VerifiedIdsAndPreferences(log, identityResolver, auditLog.data)
+ );
+ this.allVerifiedFields.push(this.idsAndPreferences);
+ this.allFields.push(this.idsAndPreferences);
+
+ // Loop through the transmission results adding fields to the model and adding the value to the values being
+ // verified.
+ auditLog.transmissions?.forEach((result) => {
+ this.AddTransmissionField(log, identityResolver, auditLog, result);
+ });
+ }
+
+ /**
+ * Should be called after the constructor to complete all verification processing.
+ * @remarks All identity and verification promises will have been settled once this promise resolves.
+ * @returns an instance of this model
+ */
+ public async verify(): Promise {
+ if (this.verifyComplete === false) {
+ for (let i = 0; i < this.allVerifiedFields.length; i++) {
+ await this.allVerifiedFields[i].value.verify();
+ }
+ this.overall.value = this.getOverall();
+ this.verifyComplete = true;
+ }
+ return this;
+ }
+ private verifyComplete = false;
+
+ /**
+ * Counts the number of fields with a given status.
+ * @returns
+ */
+ public count(match: VerifiedStatus): number {
+ let count = 0;
+ this.allVerifiedFields.forEach((field) => {
+ if (field.value.verifiedStatus === match) {
+ count++;
+ }
+ });
+ return count;
+ }
+
+ /**
+ * Checks all the verifiable fields and determines the overall status for the audit log.
+ * @returns the overall status for the audit log
+ */
+ public getOverall(): OverallStatus {
+ if (
+ this.allVerifiedFields.every((s) => s.value.verifiedStatus === VerifiedStatus.Valid) &&
+ this.results.every((s) => s.value.value.status === 'success')
+ ) {
+ return OverallStatus.Good;
+ }
+ if (this.allVerifiedFields.some((s) => s.value.verifiedStatus === VerifiedStatus.NotValid)) {
+ return OverallStatus.Violation;
+ }
+ return OverallStatus.Suspicious;
}
/**
@@ -44,4 +454,50 @@ export class Model implements IModel {
public updateUI() {
this.allFields?.forEach((f) => f.updateUI());
}
+
+ /**
+ * File name to use when downloading the audit log as JSON.
+ */
+ public get jsonFileName(): string {
+ return this.fileNameNoExtension + '.json';
+ }
+
+ /**
+ * File name to use when downloading the audit log.
+ * @remarks must replace the colon with hyphen as it is not a valid file character.
+ * Also replaces the dot in the domain name with hyphen to avoid problems with extension identification.
+ */
+ public get fileNameNoExtension(): string {
+ const date = getDate(this.auditLog.seed.source.timestamp).toISOString().replace(':', '-');
+ const publisher = this.auditLog.seed.publisher.replace('.', '-');
+ return `audit-log-${publisher}-${date}`;
+ }
+
+ /**
+ * The audit log as a JSON format string.
+ */
+ public get jsonContent(): string {
+ return JSON.stringify(this.auditLog);
+ }
+
+ /**
+ * Adds the transmission field to the model.
+ * @param identityResolver
+ * @param auditLog
+ * @param result
+ */
+ private AddTransmissionField(
+ log: Log,
+ identityResolver: IdentityResolver,
+ auditLog: AuditLog,
+ result: TransmissionResult
+ ) {
+ const field = new Field(
+ this,
+ new VerifiedTransmissionResult(log, identityResolver, auditLog.data, auditLog.seed, result)
+ );
+ this.results.push(field);
+ this.allFields.push(field);
+ this.allVerifiedFields.push(field);
+ }
}
diff --git a/paf-mvp-audit/src/public-key-resolver.ts b/paf-mvp-audit/src/public-key-resolver.ts
new file mode 100644
index 00000000..ad6e5add
--- /dev/null
+++ b/paf-mvp-audit/src/public-key-resolver.ts
@@ -0,0 +1,66 @@
+import { PublicKeyProvider } from '@core/crypto';
+import { isValidKey, publicKeyFromString } from '@core/crypto/keys';
+import { Log } from '@core/log';
+import { GetIdentityResponse } from '@core/model';
+import { IECDSA } from 'ecdsa-secp256r1';
+/**
+ * Utility class used to take an GetIdentityResponse response and turn it into a public key provider that can be used
+ * for verification.
+ */
+export class PublicKeyResolver {
+ /**
+ * Returns a public key resolver for the identity and time stamp provided.
+ * @param log
+ * @param identity to use for the public key, the domain parameter of the provider method is ignored
+ * @param requiredTimestamp the time stamp for the data that requires the public key
+ */
+ constructor(
+ private readonly log: Log,
+ private readonly identity: GetIdentityResponse,
+ private readonly requiredTimestamp: number
+ ) {}
+
+ /**
+ * Core crypto implementation of the public key provider function.
+ * @param domain is not used as the identity to return is passed to the constructor
+ * @returns
+ */
+ public readonly provider: PublicKeyProvider = async (domain: string) => {
+ let publicKey: IECDSA = null;
+ const publicKeyIndex = this.getValidPublicKeyIndex(this.identity);
+ if (publicKeyIndex >= 0) {
+ try {
+ publicKey = await publicKeyFromString(this.identity.keys[publicKeyIndex].key);
+ } catch (e) {
+ this.log.Warn('PublicKeyResolver', e);
+ }
+ } else {
+ const message = `No valid keys for '${domain}' at timestamp '${
+ this.requiredTimestamp
+ }' with identity '${JSON.stringify(this.identity)}'`;
+ this.log.Warn(message);
+ }
+ return publicKey;
+ };
+
+ /**
+ * The index in the keys array of the first valid entry.
+ * @param identity whose keys member is inspected
+ * @returns
+ */
+ private getValidPublicKeyIndex(identity: GetIdentityResponse): number {
+ for (let index = 0; index < identity.keys.length; index++) {
+ const key = identity.keys[index];
+ if (
+ isValidKey(key) &&
+ // The start of the public key must be the same or earlier than the time stamp being validated.
+ key.start <= this.requiredTimestamp &&
+ // Either the end time stamp is missing or the end is greater than the time stamp being validated.
+ (!key.end || key.end > this.requiredTimestamp)
+ ) {
+ return index;
+ }
+ }
+ return -1;
+ }
+}
diff --git a/paf-mvp-audit/src/signing-definitions.ts b/paf-mvp-audit/src/signing-definitions.ts
new file mode 100644
index 00000000..af69dfc6
--- /dev/null
+++ b/paf-mvp-audit/src/signing-definitions.ts
@@ -0,0 +1,47 @@
+import { SeedSignatureBuilder, SeedSignatureContainer, SigningDefinition } from '@core/crypto';
+import { IdsAndPreferences, Seed, TransmissionResponse, TransmissionResult } from '@core/model';
+
+export interface SignedSeedSignatureContainer extends SeedSignatureContainer {
+ seed: Seed;
+ idsAndPreferences: IdsAndPreferences;
+}
+
+export interface TransmissionContainer extends SignedSeedSignatureContainer {
+ result: TransmissionResult | TransmissionResponse | undefined;
+}
+
+export class SeedDefinition
+ extends SeedSignatureBuilder
+ implements SigningDefinition
+{
+ getSignature(data: SignedSeedSignatureContainer): string {
+ return data.seed.source.signature;
+ }
+ getSignerDomain(data: SignedSeedSignatureContainer): string {
+ return data.seed.source.domain;
+ }
+}
+
+export class TransmissionDefinition implements SigningDefinition {
+ private static readonly seedDefinition = new SeedDefinition();
+
+ getSignature(data: TransmissionContainer): string {
+ TransmissionDefinition.validateData(data);
+ return data.result.source.signature;
+ }
+
+ getSignerDomain(data: TransmissionContainer): string {
+ TransmissionDefinition.validateData(data);
+ return data.result.source.domain;
+ }
+
+ getInputString(data: TransmissionContainer): string {
+ return TransmissionDefinition.seedDefinition.getInputString(data);
+ }
+
+ private static validateData(data: TransmissionContainer) {
+ if (data.result === undefined) {
+ throw 'Data has not yet been signed';
+ }
+ }
+}
diff --git a/paf-mvp-audit/src/view.ts b/paf-mvp-audit/src/view.ts
index dd2993af..deda4ba2 100644
--- a/paf-mvp-audit/src/view.ts
+++ b/paf-mvp-audit/src/view.ts
@@ -1,53 +1,106 @@
/**
* Resources used by the controller for HTML views and CSS.
- * TODO: fix the warning associated with can't find module or type.
*/
-import logoSvg from './images/OneKey.svg';
import css from './css/ok-ui.css';
+import advertTemplate from './html/cards/advert.html';
+import dataTemplate from './html/cards/data.html';
+import downloadTemplate from './html/cards/download.html';
+import participantsTemplate from './html/cards/participants.html';
import auditTemplate from './html/containers/audit.html';
import buttonTemplate from './html/components/button.html';
-import { Locale } from './locale';
+import { ILocale } from '@core/ui/ILocale';
import { IView } from '@core/ui/binding';
import { Log } from '@core/log';
+import { Model } from './model';
export class View implements IView {
// The shadow root for the UI.
public root: ShadowRoot = null;
// The outer container for the UI.
- private outerContainer: HTMLElement = null;
+ private outerContainer: HTMLElement | null = null;
- // The element that contains the advert. Used to add the UI components to the DOM around the advert.
- private readonly advert: HTMLElement;
+ // The inner container under the root element.
+ private innerContainer: HTMLDivElement | null = null;
- // The container element for the UI, or null if the UI has not yet been added to the DOM.
- private auditContainer: HTMLDivElement | null = null;
+ // The child of the audit modal div container.
+ private popupContainer: HTMLDivElement | null = null;
- // Log used to output status messages.
- private readonly log: Log;
+ // The container for the cards within the modal dialog.
+ private cardContainer: HTMLDivElement | null = null;
- // The locale that the UI should adopt.
- public readonly locale: Locale;
+ // The container for the button that opens the audit modal dialog.
+ private buttonContainer: HTMLDivElement | null = null;
+
+ // The list of navigation elements.
+ private navigationList: HTMLUListElement | null = null;
+
+ // The width of the advert before any module changes.
+ private readonly advertWidth: number;
/**
* Constructs a new instance of View.
* @param advert element the module relates to
* @param locale the language file to use with the UI
+ * @param log
+ */
+ constructor(private readonly advert: HTMLElement, public readonly locale: ILocale, private readonly log: Log) {
+ this.advertWidth = advert.clientWidth;
+ }
+
+ /**
+ * Adds the initial CSS, javascript, and the container div for the UI elements.
*/
- constructor(advert: HTMLElement, locale: Locale, log: Log) {
- this.advert = advert;
- this.log = log;
+ public initView() {
+ // Create an outer container to add the shadow root and UI components to.
+ this.outerContainer = this.advert.appendChild(document.createElement('div'));
- // Setup the locale with the text and images to use.
- this.locale = locale;
- this.locale.Logo = logoSvg;
+ // Create the CSS style element.
+ const style = document.createElement('style');
+ // TODO: Fix CSS include to remove the magic character at the beginning of the CSS file.
+ style.innerHTML = (css).trim();
+
+ // Create the new container for the button and add the HTML.
+ this.buttonContainer = document.createElement('div');
+ this.buttonContainer.classList.add('ok-ui');
+ this.buttonContainer.innerHTML = buttonTemplate(this.locale);
+
+ // If the pop up is valid then append the container and store a reference to the pop up element.
+ this.root = this.outerContainer.attachShadow({ mode: 'closed' });
+ this.root.appendChild(style);
+ this.root.appendChild(this.buttonContainer);
}
/**
- * Displays the audit log card ready for the providers to be added.
+ * Displays the audit log card ready for the providers to be added. If the advert is wide then switch to landscape
+ * mode to display the advert card if present.
*/
public display(card: string) {
- this.setContainerCard(card);
+ this.initPopUp();
+ this.setCard(card);
+ this.setNavigation(card);
+ this.popupContainer.classList.add('ok-ui-popup--open');
+
+ // If this is the advert card and the width of the advert requires landscape layout then add the class name to the
+ // card content.
+ if (card === 'advert' && this.advertWidth > 320) {
+ const wrappers = this.cardContainer.getElementsByClassName('ok-ui-advert-wrapper');
+ for (let i = 0; i < wrappers.length; i++) {
+ (wrappers[i]).classList.add('ok-ui-advert-wrapper--landscape');
+ }
+ const images = this.cardContainer.getElementsByClassName('ok-ui-advert__image');
+ for (let i = 0; i < images.length; i++) {
+ (images[i]).style.width = `${this.advertWidth}px`;
+ }
+ }
+ }
+
+ /**
+ * Hides the audit log view container.
+ */
+ public hide() {
+ this.initPopUp();
+ this.popupContainer.classList.remove('ok-ui-popup--open');
}
/**
@@ -55,18 +108,34 @@ export class View implements IView {
* @returns array of HTMLElements that can have events added to them
*/
public getActionElements(): HTMLElement[] {
+ this.initPopUp();
const elements: HTMLElement[] = [];
- View.addElements(elements, this.auditContainer.getElementsByTagName('button'));
- View.addElements(elements, this.auditContainer.getElementsByTagName('a'));
+ View.addElements(elements, this.root.querySelectorAll('button'));
+ View.addElements(elements, this.root.querySelectorAll('a'));
+ View.addElements(elements, this.root.querySelectorAll('li.ok-ui-navigation__item'));
return elements;
}
+ /**
+ * Modifies the view temporarily to trigger the download of the audit log.
+ * @param model with the audit log to download.
+ */
+ public download(model: Model): void {
+ this.initPopUp();
+ const downloadAnchor = document.createElement('a');
+ downloadAnchor.setAttribute('href', 'data:text/json;charset=utf-8,' + encodeURIComponent(model.jsonContent));
+ downloadAnchor.setAttribute('download', model.jsonFileName);
+ this.innerContainer.appendChild(downloadAnchor); // required for firefox
+ downloadAnchor.click();
+ downloadAnchor.remove();
+ }
+
/**
* Adds element from the other collection to the array.
* @param array
* @param other
*/
- private static addElements(array: HTMLElement[], other: HTMLCollectionOf) {
+ private static addElements(array: HTMLElement[], other: NodeListOf) {
for (let i = 0; i < other.length; i++) {
array.push(other[i]);
}
@@ -75,51 +144,92 @@ export class View implements IView {
/**
* Sets the HTML in the container for the template.
*/
- private setContainerCard(card: string): void {
+ private setCard(card: string): void {
let template: Language;
switch (card) {
- case 'audit':
- template = auditTemplate;
+ case 'advert':
+ template = advertTemplate;
break;
- case 'button':
- template = buttonTemplate;
+ case 'data':
+ template = dataTemplate;
+ break;
+ case 'download':
+ template = downloadTemplate;
+ break;
+ case 'participants':
+ template = participantsTemplate;
break;
default:
throw `Card '${card}' is not known`;
}
- this.getContainer().innerHTML = template(this.locale);
+ this.cardContainer.innerHTML = template(this.locale).replace('[BrandName]', this.locale.brandName);
}
/**
- * Returns the container for the entire UI adding it if it does not already exist.
- * @returns
+ * Sets the navigation to the provided card.
+ * @remarks
+ * @param card that
*/
- private getContainer(): HTMLDivElement {
- if (this.auditContainer === null) {
- this.addContainer();
+ private setNavigation(card: string) {
+ const selectedClass = 'ok-ui-navigation__item--selected';
+ for (let index = 0; index < this.navigationList.children.length; index++) {
+ const child = this.navigationList.children[index];
+ if (child instanceof HTMLLIElement) {
+ if (child.getAttribute('data-card') === card) {
+ child.classList.add(selectedClass);
+ } else {
+ child.classList.remove(selectedClass);
+ }
+ }
}
- return this.auditContainer;
}
/**
- * Adds the CSS, javascript, and the container div for the UI elements.
+ * Ensures the popup has been initialized.
*/
- private addContainer() {
- // Create an outer container to add the shadow root and UI components to.
- this.outerContainer = this.advert.appendChild(document.createElement('div'));
+ private initPopUp() {
+ if (this.innerContainer === null) {
+ this.addPopUp();
+ }
+ }
- // Create the CSS style element.
- const style = document.createElement('style');
- // TODO: Fix CSS include to remove the magic character at the beginning of the CSS file.
- style.innerHTML = (css).trim();
+ /**
+ * Adds the popup container and sub containers to the DOM under the root.
+ */
+ private addPopUp() {
+ // Create the new container with the audit pop up template.
+ this.innerContainer = document.createElement('div');
+ this.innerContainer.classList.add('ok-ui');
+ this.innerContainer.innerHTML = auditTemplate(this.locale);
+
+ // Add the logos provided at construction to the controller to the header of the pop up.
+ if (this.locale.logoUrls) {
+ const logos = this.innerContainer.getElementsByClassName('ok-ui-card__header-logos');
+ for (let i = 0; i < logos.length; i++) {
+ (this.locale.logoUrls).forEach((u) => {
+ // TODO: Update pattern library to avoid the need to style the li element.
+ logos[i].innerHTML += `
`;
+ });
+ }
+ }
+ this.root.appendChild(this.innerContainer);
- // Create the new container with the pop up template.
- this.auditContainer = document.createElement('div');
- this.auditContainer.classList.add('ok-ui');
+ // Find the card body from the audit container which is where the cards will be set.
+ this.cardContainer = this.getAuditElementByClassName('ok-ui-card__body');
- // If the pop up is valid then append the container and store a reference to the pop up element.
- this.root = this.outerContainer.attachShadow({ mode: 'closed' });
- this.root.appendChild(style);
- this.root.appendChild(this.auditContainer);
+ // Find the navigation element within the audit container.
+ this.navigationList = this.getAuditElementByClassName('ok-ui-navigation__list');
+
+ // Find the popup container that is used to open and close the container.
+ this.popupContainer = this.getAuditElementByClassName('ok-ui-popup');
+ }
+
+ private getAuditElementByClassName(className: string): Element {
+ const elements = this.innerContainer.getElementsByClassName(className);
+ if (elements !== null && elements.length > 0) {
+ return elements[0];
+ } else {
+ throw `No element with class '${className}' could be found`;
+ }
}
}
diff --git a/paf-mvp-audit/tests/helpers/audit-log-mock.ts b/paf-mvp-audit/tests/helpers/audit-log-mock.ts
new file mode 100644
index 00000000..d0e62f8e
--- /dev/null
+++ b/paf-mvp-audit/tests/helpers/audit-log-mock.ts
@@ -0,0 +1,502 @@
+import { IdentifierDefinition } from '@core/crypto';
+import { PublicKeyInfo } from '@core/crypto/identity';
+import { PublicKeyStore } from '@core/crypto/key-store';
+import { privateKeyFromString } from '@core/crypto/keys';
+import { Signer } from '@core/crypto/signer';
+import { Config } from '@core/express';
+import { Log } from '@core/log';
+import {
+ AuditLog,
+ GetIdentityResponse,
+ IdBuilder,
+ Identifier,
+ IdsAndPreferences,
+ PreferencesData,
+ Seed,
+ Timestamp,
+ TransmissionContents,
+ TransmissionDetails,
+ TransmissionResponse,
+ TransmissionStatus,
+} from '@core/model';
+import { CurrentModelVersion } from '@core/model/model';
+import { getTimeStampInSec } from '@core/timestamp';
+import { OperatorClient } from '@operator-client/operator-client';
+import { v4 as uuidv4 } from 'uuid';
+import { IdentityResolverMap } from '../../src/identity-resolver';
+import { SeedDefinition, SignedSeedSignatureContainer } from '../../src/signing-definitions';
+import ECDSA from 'ecdsa-secp256r1';
+import { IECDSA } from 'ecdsa-secp256r1';
+
+/**
+ * See the documentation for logic details.
+ * https://github.com/prebid/addressability-framework/blob/main/mvp-spec/ad-auction.md
+ */
+
+/**
+ * Parameters passed to the method that builds a new configuration.
+ */
+export interface ConfigParams {
+ name: string; // Human readable name of the organization
+ host: string; // Domain name of the node
+ type: 'vendor' | 'operator'; // Type of the node
+ dpoEmailAddress?: string; // Optional email address. If not provided dpo@[host] will be used
+ privacyPolicyUrl?: URL; // Optional privacy url. If not provided https://[host]/privacy.html will be used
+}
+
+export interface OpenRTBNode extends ConfigParams {
+ children: OpenRTBNode[]; // The children of this node if any
+}
+
+export const AutomobileExample = {
+ name: 'automobiles',
+ host: 'automobiles.example',
+ type: 'operator',
+ children: [
+ {
+ name: 'United States',
+ host: 'united-states.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Ford',
+ host: 'ford.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Model T',
+ host: 'model-t.example',
+ type: 'vendor',
+ },
+ {
+ name: 'Mustang',
+ host: 'mustang.example',
+ type: 'vendor',
+ },
+ {
+ name: 'Model 18',
+ host: 'model-18.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Duesenberg',
+ host: 'duesenberg.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Model SJ',
+ host: 'model-sj.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Jeep',
+ host: 'jeep.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'MD',
+ host: 'mb.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Oldsmobile',
+ host: 'oldsmobile.example',
+ type: 'vendor',
+ children: [
+ {
+ name: '"Rocket 88"',
+ host: 'rocket-88.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Chevrolet',
+ host: 'chevrolet.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Corvette',
+ host: 'corvette.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Chrysler',
+ host: 'Chrysler.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Minivan',
+ host: 'minivan.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ {
+ name: 'Tesla',
+ host: 'tesla.example',
+ type: 'vendor',
+ children: [
+ {
+ name: 'Model S',
+ host: 'model-s.example',
+ type: 'vendor',
+ },
+ {
+ name: 'Model X',
+ host: 'model-x.example',
+ type: 'vendor',
+ },
+ {
+ name: 'Model 3',
+ host: 'model-3.example',
+ type: 'vendor',
+ },
+ {
+ name: 'Model Y',
+ host: 'model-y.example',
+ type: 'vendor',
+ },
+ ],
+ },
+ ],
+ },
+ ],
+};
+
+/**
+ * Used to build a mock audit log for testing and demo purposes.
+ */
+export class AuditLogMock {
+ /**
+ * Used to sign the transmission responses against the seed.
+ */
+ private static readonly seedDefinition = new SeedDefinition();
+
+ /**
+ * Public key store used for validation.
+ */
+ private readonly publicKeyStore = new PublicKeyStore();
+
+ /**
+ * Store of client and configuration information across the mock.
+ */
+ private readonly clientAndConfigStore: ConfigAndClientStore;
+
+ /**
+ * Constructs a new instance of the mock audit log.
+ * @param log
+ */
+ constructor(private readonly log: Log) {
+ this.clientAndConfigStore = new ConfigAndClientStore(log, this);
+ }
+
+ /**
+ *
+ * @returns an identity resolver that can be used for demos and testing
+ */
+ public GetIdentityResolverMap(): IdentityResolverMap {
+ return this.clientAndConfigStore.GetIdentityResolverMap();
+ }
+
+ /**
+ * Builds the config and the client in a single operation for the parameters provided.
+ * @param params instance of new client parameters
+ * @returns
+ */
+ public BuildConfigAndClient(params: ConfigParams): ConfigAndClient {
+ const config = AuditLogMock.BuildConfig(params);
+ const client = this.BuildOperatorClient(config);
+ return { config, client, params };
+ }
+
+ /**
+ * Builds a mock audit log for testing and demo purposes.
+ * @param rootNode for the tree of participants
+ * @param data preference data value for personalized marketing
+ * @returns a valid audit log
+ */
+ public BuildAuditLog(rootNode: OpenRTBNode, data: PreferencesData): AuditLog {
+ // Use a single content and transaction id for a mock audit log.
+ const contents = [{ content_id: uuidv4(), transaction_id: uuidv4() }];
+
+ // Get the root client and config.
+ const root = this.clientAndConfigStore.getOrAdd(rootNode);
+
+ // Build the ids and preferences.
+ const id = AuditLogMock.NewId(root.config);
+ const idsAndPreferences = AuditLogMock.SignIdentifiersAndPreferencesData(root.client, [id], data);
+
+ // Build the seed for the audit log from the transaction ids, and ids and preferences.
+ const seed = AuditLogMock.BuildSeed(root.client, [contents[0].transaction_id], idsAndPreferences);
+
+ // Get the responses for all the children of the root node.
+ const responseTrees: TransmissionResponse[] = [];
+ for (let i = 0; i < rootNode.children.length; i++) {
+ responseTrees.push(
+ this.BuildTransmissionResponses(idsAndPreferences, seed, contents, rootNode.children[i], rootNode)
+ );
+ }
+
+ // Turn them into a list.
+ // TODO: Remove when the audit log can support a hierarchy of responses.
+ const responseList: TransmissionResponse[] = [];
+ responseTrees.forEach((current) => this.AddToList(responseList, current));
+
+ // Finally build the audit log.
+ return {
+ version: CurrentModelVersion,
+ data: idsAndPreferences,
+ seed,
+ transaction_id: contents[0].transaction_id,
+ transmissions: responseList,
+ };
+ }
+
+ /**
+ *
+ * @param list that all the response results will be added to
+ * @param current the current node being added
+ * @returns
+ */
+ private AddToList(list: TransmissionResponse[], current: TransmissionResponse): TransmissionResponse[] {
+ list.push(current);
+ if (current.children?.length > 0) {
+ current.children.forEach((child) => this.AddToList(list, child));
+ }
+ return list;
+ }
+
+ /**
+ * Builds a transmission response for the current node and its parent.
+ * @param idsAndPreferences
+ * @param seed
+ * @param contents
+ * @param currentNode
+ * @param parentNode
+ * @returns
+ */
+ private BuildTransmissionResponses(
+ idsAndPreferences: IdsAndPreferences,
+ seed: Seed,
+ contents: TransmissionContents,
+ currentNode: OpenRTBNode,
+ parentNode: OpenRTBNode
+ ): TransmissionResponse {
+ const children: TransmissionResponse[] = [];
+ if (currentNode.children?.length > 0) {
+ for (let i = 0; i < currentNode.children.length; i++) {
+ children.push(
+ this.BuildTransmissionResponses(idsAndPreferences, seed, contents, currentNode.children[i], currentNode)
+ );
+ }
+ }
+ return AuditLogMock.BuildTransmissionResponse(
+ idsAndPreferences,
+ seed,
+ currentNode?.children?.length === 0
+ ? contents
+ : [
+ {
+ transaction_id: contents[0].transaction_id,
+ content_id: null,
+ },
+ ],
+ this.clientAndConfigStore.getOrAdd(currentNode),
+ this.clientAndConfigStore.getOrAdd(parentNode),
+ 'success',
+ 'mocked',
+ children
+ );
+ }
+
+ /**
+ * Creates a transmission response for inclusion in the audit log.
+ * @param idsAndPreferences
+ * @param seed
+ * @param contents ids
+ * @param sender used to provide the details
+ * @param receiver used to sign the transmission response
+ * @param status string
+ * @param details string
+ * @param children responses if any
+ * @returns a transmission response
+ */
+ private static BuildTransmissionResponse(
+ idsAndPreferences: IdsAndPreferences,
+ seed: Seed,
+ contents: TransmissionContents,
+ sender: ConfigAndClient,
+ receiver: ConfigAndClient,
+ status: TransmissionStatus,
+ details: TransmissionDetails,
+ children: TransmissionResponse[]
+ ): TransmissionResponse {
+ const currentPrivateKey = privateKeyFromString(sender.config.currentPrivateKey);
+ const signer = new Signer(currentPrivateKey, AuditLogMock.seedDefinition);
+ const response = {
+ version: CurrentModelVersion,
+ receiver: receiver.config.host,
+ contents,
+ status,
+ details,
+ source: {
+ timestamp: getTimeStampInSec(),
+ domain: sender.config.host,
+ signature: signer.sign({ idsAndPreferences, seed }),
+ },
+ children,
+ };
+ return response;
+ }
+
+ /**
+ * Builds a new seed from the client for the transaction ids, identifiers and preferences provided.
+ * @param client
+ * @param transaction_ids
+ * @param idsAndPreferences
+ * @returns
+ */
+ private static BuildSeed(
+ client: OperatorClient,
+ transaction_ids: string[],
+ idsAndPreferences: IdsAndPreferences
+ ): Seed {
+ const seed = client.buildSeed(transaction_ids, idsAndPreferences);
+ return seed;
+ }
+
+ /**
+ * Signs the preferences with the identifiers.
+ * @param client to perform the signing
+ * @param identifiers to combine with the preferences
+ * @param data boolean value for personalized marketing
+ * @returns signed identifiers and preferences
+ */
+ private static SignIdentifiersAndPreferencesData(
+ client: OperatorClient,
+ identifiers: Identifier[],
+ data: PreferencesData
+ ): IdsAndPreferences {
+ const preferences = client.buildPreferences(identifiers, data);
+ return { identifiers, preferences };
+ }
+
+ /**
+ * Creates a new Id for the configuration provided.
+ * @param config
+ * @returns
+ */
+ private static NewId(config: Config): Identifier {
+ const privateKey = privateKeyFromString(config.currentPrivateKey);
+ const signer = new Signer(privateKey, new IdentifierDefinition());
+ return new IdBuilder(config.host, config.currentPrivateKey, signer).generateNewId();
+ }
+
+ /**
+ * Builds a new operator client for the config provided.
+ * @param config
+ */
+ private BuildOperatorClient(config: Config): OperatorClient {
+ return new OperatorClient(config.host, config.host, config.currentPrivateKey, this.publicKeyStore);
+ }
+
+ /**
+ * Builds a new client config for the parameters provided.
+ * @param params instance of new client parameters
+ */
+ private static BuildConfig(params: ConfigParams): Config {
+ const privateKey = ECDSA.generateKey();
+ const currentPrivateKey = privateKey.toPEM();
+ const publicKey = privateKey.asPublic().toPEM();
+ return {
+ identity: {
+ name: params.name,
+ publicKeys: [
+ {
+ startTimestampInSec: getTimeStampInSec(),
+ publicKey,
+ },
+ ],
+ type: params.type,
+ dpoEmailAddress: params.dpoEmailAddress ?? `dpo@${params.host}`,
+ privacyPolicyUrl: params.privacyPolicyUrl ?? new URL(`https:\\\\${params.host}\\privacy.html`),
+ },
+ host: params.host,
+ currentPrivateKey,
+ };
+ }
+}
+
+interface ConfigAndClient {
+ config: Config; // The config used to create the client
+ client: OperatorClient; // The client created from the config
+ params: ConfigParams; // The parameters that formed the config and client
+}
+
+interface GetIdentityResponsePublicKey {
+ key: string;
+ start: Timestamp;
+ end?: Timestamp;
+}
+
+class ConfigAndClientStore {
+ // Map of hosts to config and clients.
+ private map = new Map();
+
+ /**
+ *
+ * @param log
+ * @param mock instance for use with the store
+ */
+ constructor(private readonly log: Log, private readonly mock: AuditLogMock) {}
+
+ /**
+ * Returns the exist config and client if available, or adds a new one and returns that
+ * @param params to be used to find the existing data or to add if does not exist
+ * @returns a unique config and client for the parameters across the instance of the store
+ */
+ public getOrAdd(params: ConfigParams): ConfigAndClient {
+ let result = this.map.get(params.host);
+ if (result === undefined) {
+ result = this.mock.BuildConfigAndClient(params);
+ this.map.set(params.host, result);
+ }
+ return result;
+ }
+
+ public GetIdentityResolverMap(): IdentityResolverMap {
+ const map = new Map();
+ this.map.forEach((v, k) =>
+ map.set(k, {
+ version: CurrentModelVersion,
+ name: v.params.name,
+ type: v.params.type,
+ dpo_email: v.config.identity.dpoEmailAddress,
+ privacy_policy_url: v.config.identity.privacyPolicyUrl.toString(),
+ keys: ConfigAndClientStore.TransformPublicKeys(v.config.identity.publicKeys),
+ })
+ );
+ return new IdentityResolverMap(0, map);
+ }
+
+ private static TransformPublicKeys(keys: PublicKeyInfo[]): GetIdentityResponsePublicKey[] {
+ const transformed: GetIdentityResponsePublicKey[] = [];
+ keys.forEach((k) =>
+ transformed.push({
+ key: k.publicKey,
+ start: k.startTimestampInSec,
+ end: k.endTimestampInSec,
+ })
+ );
+ return transformed;
+ }
+}
diff --git a/paf-mvp-audit/tests/test-cases/model.test.ts b/paf-mvp-audit/tests/test-cases/model.test.ts
new file mode 100644
index 00000000..9bac72b4
--- /dev/null
+++ b/paf-mvp-audit/tests/test-cases/model.test.ts
@@ -0,0 +1,148 @@
+import { AutomobileExample, AuditLogMock } from '../helpers/audit-log-mock';
+import { IdentityResolverMap } from '../../src/identity-resolver';
+import { Model, OverallStatus, VerifiedStatus } from '../../src/model';
+import { AuditLog } from '@core/model';
+import { Log } from '@core/log';
+import * as fs from 'fs';
+import path from 'path';
+
+describe('testing model', () => {
+ let mock: AuditLogMock;
+ let auditLog: AuditLog;
+ let resolver: IdentityResolverMap;
+ const log = new Log('audit model test');
+
+ beforeEach(() => {
+ // Create a mock audit log ensuring that the
+ mock = new AuditLogMock(log);
+ auditLog = mock.BuildAuditLog({ ...AutomobileExample }, { use_browsing_for_personalization: true });
+
+ // Check that the audit log appears valid.
+ expect(auditLog).toBeDefined();
+ expect(auditLog.seed.publisher).toBe(AutomobileExample.host);
+ expect(auditLog.data.preferences.data.use_browsing_for_personalization).toBe(true);
+
+ // Check that the resolver from the mock works for the root.
+ resolver = mock.GetIdentityResolverMap();
+ resolver.get(AutomobileExample.host).then((i) => expect(i.name).toBe(AutomobileExample.name));
+ });
+
+ test('check identity resolution works for all nodes', async () => {
+ const model = await new Model(log, resolver, auditLog).verify();
+
+ // Check the properties for all verified fields are as expected.
+ model.allVerifiedFields.forEach((i) => expect(i.value.verifiedStatus).toBe(VerifiedStatus.Valid));
+ model.allVerifiedFields.forEach((i) => expect(i.value.valid).toBe(true));
+ model.allVerifiedFields.forEach((i) => expect(i.value.identity).toBeDefined());
+
+ // Check that the overall status is good.
+ expect(model.overall.value).toBe(OverallStatus.Good);
+
+ saveAuditLog('all-good.json', auditLog, resolver);
+ });
+
+ test("check identity resolution fails when one identity can't be found", async () => {
+ // Remove the 'minivan.example' domain from the list of domains that can be resolved.
+ const toRemove = auditLog.transmissions.find((i) => i.source.domain === 'minivan.example');
+ expect(toRemove).toBeDefined();
+ resolver.map.delete(toRemove.source.domain);
+
+ // Create the model.
+ const model = await new Model(log, resolver, auditLog).verify();
+
+ // Check the seed and ids and preferences fields are valid.
+ expect(model.seed.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+ expect(model.idsAndPreferences.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+
+ // Find the result for the missing domain.
+ const failed = model.results.find((i) => i.value.value.source.domain === toRemove.source.domain);
+ expect(failed).toBeDefined();
+
+ // Get the verified result and check it's identity not found.
+ expect(failed.value.verifiedStatus).toBe(VerifiedStatus.IdentityNotFound);
+
+ // Check the statuses for all the other results are valid.
+ model.results.forEach((result) => {
+ if (result.value.value.source.domain !== toRemove.source.domain) {
+ expect(result.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+ }
+ });
+
+ // Check the count of identity not found status is one.
+ expect(model.count(VerifiedStatus.IdentityNotFound)).toBe(1);
+
+ // Check that the overall status is caution as the identity can't be found.
+ expect(model.overall.value).toBe(OverallStatus.Suspicious);
+
+ saveAuditLog('identity-not-found.json', auditLog, resolver);
+ });
+
+ test('check verification fails when one signature is corrupted', async () => {
+ // Corrupt the 'minivan.example' domain from the list of domains that can be resolved.
+ const toCorrupt = auditLog.transmissions.find((i) => i.source.domain === 'minivan.example');
+ toCorrupt.source.signature = '0' + toCorrupt.source.signature;
+
+ // Create the model.
+ const model = await new Model(log, resolver, auditLog).verify();
+
+ // Check the seed and ids and preferences fields are valid.
+ expect(model.seed.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+ expect(model.idsAndPreferences.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+
+ // Find the result for the missing domain.
+ const failed = model.results.find((i) => i.value.value.source.domain === toCorrupt.source.domain);
+ expect(failed).toBeDefined();
+
+ // Get the verified result and check it's identity not found.
+ expect(failed.value.verifiedStatus).toBe(VerifiedStatus.NotValid);
+
+ // Check the statuses for all the other results are valid.
+ model.results.forEach((result) => {
+ if (result.value.value.source.domain !== toCorrupt.source.domain) {
+ expect(result.value.verifiedStatus).toBe(VerifiedStatus.Valid);
+ }
+ });
+
+ // Check the count of not valid status is one.
+ expect(model.count(VerifiedStatus.NotValid)).toBe(1);
+
+ // Check that the overall status is bad as the signature is invalid.
+ expect(model.overall.value).toBe(OverallStatus.Violation);
+
+ saveAuditLog('corrupt-signature.json', auditLog, resolver);
+ });
+
+ test('check verification when response is not success for one result', async () => {
+ // Corrupt the 'minivan.example' in the list of results.
+ const toCorrupt = auditLog.transmissions.find((i) => i.source.domain === 'minivan.example');
+ toCorrupt.status = 'error_cannot_process';
+
+ // Create the model.
+ const model = await new Model(log, resolver, auditLog).verify();
+
+ // Check that the overall status is bad as the signature is invalid.
+ expect(model.overall.value).toBe(OverallStatus.Suspicious);
+
+ saveAuditLog('result-error.json', auditLog, resolver);
+ });
+});
+
+/**
+ * Saves the audit log and resolver in the name provided if there is a global variable 'mock-audit-log-path'.
+ * @param fileName
+ * @param auditLog
+ * @param resolver
+ */
+function saveAuditLog(fileName: string, auditLog: AuditLog, resolver: IdentityResolverMap) {
+ const mockAuditLogPath = globalThis['mock-audit-log-path'];
+ if (mockAuditLogPath) {
+ const fullPath = path.join(mockAuditLogPath, fileName);
+ fs.writeFileSync(
+ fullPath,
+ JSON.stringify({
+ auditLog: auditLog,
+ resolver: Array.from(resolver.map.entries()),
+ })
+ );
+ }
+}
diff --git a/paf-mvp-cmp/.npmignore b/paf-mvp-cmp/.npmignore
index 50a8e2a5..b78504e8 100644
--- a/paf-mvp-cmp/.npmignore
+++ b/paf-mvp-cmp/.npmignore
@@ -1,2 +1,2 @@
/src
-/test
\ No newline at end of file
+/tests
\ No newline at end of file
diff --git a/paf-mvp-cmp/README.md b/paf-mvp-cmp/README.md
index cdab30b8..192a6fbd 100644
--- a/paf-mvp-cmp/README.md
+++ b/paf-mvp-cmp/README.md
@@ -12,7 +12,7 @@ proxy-host-name domain. A list of CMP providers is available in the
page.
```HTML
-
```
@@ -127,14 +127,14 @@ particularly noticeable when HTTPS/2 is used.
For example to preload the loader the following then following would be used.
```html
-
+
```
If the server has already worked out the correct language bundle the following
would be used.
```html
-
+
```
If this link is not added, then the functionality will still be provided by page
diff --git a/paf-mvp-cmp/rollup.config.js b/paf-mvp-cmp/rollup.config.js
index 9e77d7c0..85375a3f 100644
--- a/paf-mvp-cmp/rollup.config.js
+++ b/paf-mvp-cmp/rollup.config.js
@@ -27,6 +27,9 @@ import * as yaml from 'js-yaml';
// Used to get the TCF core string from the environment.
import { env } from 'process';
+// File name prefix for the bundle files.
+const namePrefix = 'ok-ui-cmp';
+
const DEV = process.env.ROLLUP_WATCH;
// Options to pass to terser.
@@ -131,11 +134,12 @@ function getLocaleCodes() {
// Builds the loader working out from the locales directory the various options that will be available.
function buildLoader() {
+ const loader = '../paf-mvp-core-js/src/ui/loader.ts';
return {
- input: './src/loader.ts',
+ input: loader,
plugins: [
replace({
- include: './src/loader.ts',
+ include: loader,
preventAssignment: true,
__Locales__: '[' + getLocaleCodes().join(',') + ']'
}),
@@ -150,25 +154,25 @@ function buildLoader() {
treeshake: true,
output: [
{
- file: `./dist/ok-ui.js`,
- sourcemap: true,
+ file: `./dist/${namePrefix}.js`,
+ sourcemap: false,
format: 'iife'
},
{
- file: `./dist/ok-ui.min.js`,
+ file: `./dist/${namePrefix}.min.js`,
format: 'iife',
- sourcemap: true,
+ sourcemap: false,
plugins: [terser(terserOptions)]
},
{
- file: `../paf-mvp-demo-express/public/assets/cmp/ok-ui.js`,
- sourcemap: true,
+ file: `../paf-mvp-demo-express/public/assets/${namePrefix}.js`,
+ sourcemap: false,
format: 'iife'
},
{
- file: `../paf-mvp-demo-express/public/assets/cmp/ok-ui.min.js`,
+ file: `../paf-mvp-demo-express/public/assets/${namePrefix}.min.js`,
format: 'iife',
- sourcemap: true,
+ sourcemap: false,
plugins: [terser(terserOptions)]
},
]
@@ -193,10 +197,6 @@ function buildLocaleConfig(localeCode, localeContent, tcfCoreTemplate) {
preventAssignment: true,
'process.env.NODE_ENV': JSON.stringify(DEV ? 'development' : 'production')
}),
- replace({
- preventAssignment: true,
- 'process.env.NODE_ENV': JSON.stringify(DEV ? 'development' : 'production')
- }),
postHTML({ template: true }),
minifyHTML({
// Include string literals that contain the div or section element as well as the default check.
@@ -216,25 +216,25 @@ function buildLocaleConfig(localeCode, localeContent, tcfCoreTemplate) {
treeshake: true,
output: [
{
- file: `./dist/ok-ui-${localeCode}.js`,
- sourcemap: true,
+ file: `./dist/${namePrefix}-${localeCode}.js`,
+ sourcemap: false,
format: 'iife',
},
{
- file: `./dist/ok-ui-${localeCode}.min.js`,
+ file: `./dist/${namePrefix}-${localeCode}.min.js`,
format: 'iife',
- sourcemap: true,
+ sourcemap: false,
plugins: [terser(terserOptions)]
},
{
- file: `../paf-mvp-demo-express/public/assets/cmp/ok-ui-${localeCode}.js`,
- sourcemap: true,
+ file: `../paf-mvp-demo-express/public/assets/${namePrefix}-${localeCode}.js`,
+ sourcemap: false,
format: 'iife',
},
{
- file: `../paf-mvp-demo-express/public/assets/cmp/ok-ui-${localeCode}.min.js`,
+ file: `../paf-mvp-demo-express/public/assets/${namePrefix}-${localeCode}.min.js`,
format: 'iife',
- sourcemap: true,
+ sourcemap: false,
plugins: [terser(terserOptions)]
},
]
diff --git a/paf-mvp-cmp/src/bindings.ts b/paf-mvp-cmp/src/bindings.ts
index 8910b09c..a4691f36 100644
--- a/paf-mvp-cmp/src/bindings.ts
+++ b/paf-mvp-cmp/src/bindings.ts
@@ -1,7 +1,8 @@
import { Config } from './config';
import { BindingViewOnly } from '@core/ui/binding';
import { Identifier, PreferencesData } from '@core/model/generated-model';
-import { Marketing, Model } from './model';
+import { Model } from './model';
+import { Marketing } from '@core/model/marketing';
import { View } from './view';
/**
diff --git a/paf-mvp-cmp/src/controller.ts b/paf-mvp-cmp/src/controller.ts
index 55c6f333..16747aae 100644
--- a/paf-mvp-cmp/src/controller.ts
+++ b/paf-mvp-cmp/src/controller.ts
@@ -13,13 +13,14 @@ import {
updateIdsAndPreferences,
deleteIdsAndPreferences,
} from '@frontend/lib/paf-lib';
-import { Marketing, Model } from './model';
+import { Marketing } from '@core/model/marketing';
+import { Model } from './model';
import { PafStatus } from '@frontend/enums/status.enum';
import { View } from './view';
import { getCookieValue } from '@frontend/utils/cookie';
import { Cookies, getPrebidDataCacheExpiration } from '@core/cookies';
import { TcfCore } from './tcfcore';
-import { ILocale } from './ILocale';
+import { ILocale } from '@core/ui/ILocale';
/**
* Controller class used with the model and views. Uses paf-lib for data access services.
@@ -346,6 +347,7 @@ export class Controller {
this.display(card);
e.preventDefault();
});
+ element.removeAttribute('data-card');
}
const action = element.getAttribute('data-action');
if (action !== null) {
@@ -353,6 +355,7 @@ export class Controller {
this.processAction(action);
e.preventDefault();
});
+ element.removeAttribute('data-action');
}
}
}
diff --git a/paf-mvp-cmp/src/loader.ts b/paf-mvp-cmp/src/loader.ts
deleted file mode 100644
index da154887..00000000
--- a/paf-mvp-cmp/src/loader.ts
+++ /dev/null
@@ -1,55 +0,0 @@
-// The available language codes calculated at build time.
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore this value is populated at build time in rollup.config.js.
-const available = __Locales__;
-
-// The default language to use if the users preferences are not available.
-const defaultLang = 'en-us';
-
-// Record the current script so that the language script can be inserted.
-const thisScript = document.currentScript;
-
-// The base URL that should be used to find the language specific script.
-const baseUrl = thisScript.getAttribute('src');
-
-/**
- * Gets the URL for the language code provided.
- * @param language required
- * @returns URL for the language
- */
-const getUrlForLanguage = (language: string) => baseUrl.replace('ok-ui', `ok-ui-${language}`);
-
-/**
- * Insert the JavaScript at the provided URL into the document next to this loader script copying all the configuration
- * from the loader to the language specific script.
- * @param url
- */
-const insertScript = (url: string) => {
- const script = document.createElement('script');
- const attrNames = thisScript.getAttributeNames();
- for (let i = 0; i < attrNames.length; i++) {
- const qn = attrNames[i];
- script.setAttribute(qn, thisScript.getAttribute(qn));
- }
- script.setAttribute('src', url);
- thisScript.insertAdjacentElement('afterend', script);
-};
-
-/**
- * Checks if there is a bundle for the next language in the list. If so then this is inserted into the document,
- * otherwise if there are more languages remaining then these are loaded. If there are no more languages then use the
- * default.
- */
-const insertLanguage = () => {
- for (let i = 0; i < window.navigator.languages.length; i++) {
- const language = window.navigator.languages[i].toLowerCase();
- if (available.indexOf(language) >= 0) {
- insertScript(getUrlForLanguage(language));
- return;
- }
- }
- insertScript(getUrlForLanguage(defaultLang));
-};
-
-// Find the best language and insert it after this script.
-insertLanguage();
diff --git a/paf-mvp-cmp/src/model.ts b/paf-mvp-cmp/src/model.ts
index 9cf5a990..7a6468f8 100644
--- a/paf-mvp-cmp/src/model.ts
+++ b/paf-mvp-cmp/src/model.ts
@@ -8,46 +8,7 @@ import {
Source,
Version,
} from '@core/model/generated-model';
-
-/**
- * The different states for the marketing preferences field.
- * Can't be an enum as we need the values for the PreferencesData to be comparable.
- */
-
-export class Marketing {
- /**
- * Personalized marketing.
- */
- public static readonly personalized: PreferencesData = {
- use_browsing_for_personalization: true,
- };
-
- /**
- * Standard marketing.
- */
- public static readonly standard: PreferencesData = {
- use_browsing_for_personalization: false,
- };
-
- /**
- * Customized marketing where there is no data held in this field.
- */
- public static readonly custom: PreferencesData = null;
-
- /**
- * No marketing is yet defined. The user has not made a choice.
- */
- public static readonly notSet: PreferencesData = undefined;
-
- /**
- * Determines equality of two different instances of PreferencesData.
- * @remarks
- * Uses the JSON.stringify to compare by value.
- */
- public static equals(a: PreferencesData, b: PreferencesData) {
- return JSON.stringify(a) === JSON.stringify(b);
- }
-}
+import { Marketing } from '@core/model/marketing';
/**
* The source of the data that was used to populate the model.
diff --git a/paf-mvp-cmp/src/view.ts b/paf-mvp-cmp/src/view.ts
index f7fc8749..42f677b6 100644
--- a/paf-mvp-cmp/src/view.ts
+++ b/paf-mvp-cmp/src/view.ts
@@ -1,6 +1,5 @@
/**
* Resources used by the controller for HTML views and CSS.
- * TODO: fix the warning associated with can't find module or type.
*/
import css from './css/ok-ui.css';
import introTemplate from './html/cards/intro.html';
@@ -12,7 +11,7 @@ import snackbarTemplate from './html/cards/snackbar.html';
import popupTemplate from './html/containers/popup.html';
import { Config } from './config';
import { IView } from '@core/ui/binding';
-import { ILocale } from './ILocale';
+import { ILocale } from '@core/ui/ILocale';
import { Tooltip } from './tooltip';
export class View implements IView {
diff --git a/paf-mvp-cmp/tests/test-cases/model.test.ts b/paf-mvp-cmp/tests/test-cases/model.test.ts
index f09827c0..f60d325b 100644
--- a/paf-mvp-cmp/tests/test-cases/model.test.ts
+++ b/paf-mvp-cmp/tests/test-cases/model.test.ts
@@ -1,5 +1,6 @@
-import { FieldSingle, Marketing, Model } from '../../src/model';
+import { FieldSingle, Model } from '../../src/model';
import { Identifier, Preferences, PreferencesData } from '@core/model/generated-model';
+import { Marketing } from '@core/model/marketing';
let model: Model;
diff --git a/paf-mvp-core-js/@types/ec-key/index.d.ts b/paf-mvp-core-js/@types/ec-key/index.d.ts
index 87c88da5..de559adb 100644
--- a/paf-mvp-core-js/@types/ec-key/index.d.ts
+++ b/paf-mvp-core-js/@types/ec-key/index.d.ts
@@ -1,6 +1,12 @@
declare module 'ec-key' {
- declare class ECKey {
+ /**
+ * The only functionality used from the ec-key module is the conversion from PEM format keys to JWK. This type
+ * declaration is only concerned with this transformation.
+ */
+ export declare class ECKey {
constructor(public key: string) {}
+ toJSON: () => ECKey; // This is the only method used from ec-key. It converts PEM to JWK.
}
+ export const ECKey: ECKey = {};
export default ECKey;
}
diff --git a/paf-mvp-core-js/@types/ecdsa-secp256r1/index.d.ts b/paf-mvp-core-js/@types/ecdsa-secp256r1/index.d.ts
index 842112e3..468eda94 100644
--- a/paf-mvp-core-js/@types/ecdsa-secp256r1/index.d.ts
+++ b/paf-mvp-core-js/@types/ecdsa-secp256r1/index.d.ts
@@ -1,5 +1,10 @@
declare module 'ecdsa-secp256r1' {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- declare const ECDSA: any = {};
+ export declare interface IECDSA {
+ verify: (string, string) => boolean | Promise;
+ sign: (string) => string;
+ fromJWK: (ECKey) => IECDSA | Promise;
+ generateKey: () => IECDSA;
+ }
+ declare const ECDSA: IECDSA = {};
export default ECDSA;
}
diff --git a/paf-mvp-core-js/package.json b/paf-mvp-core-js/package.json
index 29ff4e6b..d89bc576 100644
--- a/paf-mvp-core-js/package.json
+++ b/paf-mvp-core-js/package.json
@@ -29,7 +29,6 @@
"cors": "^2.8.5",
"detect-browser": "^5.3.0",
"ec-key": "^0.0.4",
- "ecdsa-secp256r1": "^1.3.3",
"json-schema-to-ts": "^1.6.5",
"mock-fs": "^5.1.2",
"tld-extract": "^2.0.1",
diff --git a/paf-mvp-core-js/src/crypto/key-store.ts b/paf-mvp-core-js/src/crypto/key-store.ts
index 7154dbcd..27e496c7 100644
--- a/paf-mvp-core-js/src/crypto/key-store.ts
+++ b/paf-mvp-core-js/src/crypto/key-store.ts
@@ -1,11 +1,12 @@
import { fromIdentityResponse, PublicKeyInfo } from './identity';
-import { isValidKey, PublicKey, publicKeyFromString } from './keys';
+import { isValidKey, publicKeyFromString } from './keys';
import { GetIdentityRequestBuilder } from '@core/model/identity-request-builder';
import { GetIdentityResponse, Timestamp } from '@core/model/generated-model';
import { getTimeStampInSec } from '@core/timestamp';
import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { IECDSA } from 'ecdsa-secp256r1';
-export type PublicKeyWithObject = PublicKeyInfo & { publicKeyObj: PublicKey };
+export type PublicKeyWithObject = PublicKeyInfo & { publicKeyObj: IECDSA };
export class PublicKeyStore {
protected cache: { [domain: string]: PublicKeyWithObject } = {};
@@ -53,9 +54,10 @@ export class PublicKeyStore {
}
// Update cache
+ const fromIdentity = fromIdentityResponse(currentKey);
const keyInfo = {
- ...fromIdentityResponse(currentKey),
- publicKeyObj: publicKeyFromString(fromIdentityResponse(currentKey).publicKey),
+ ...fromIdentity,
+ publicKeyObj: await publicKeyFromString(fromIdentity.publicKey),
};
this.cache[domain] = keyInfo;
diff --git a/paf-mvp-core-js/src/crypto/keys.ts b/paf-mvp-core-js/src/crypto/keys.ts
index bb6f3e2e..2cd29901 100644
--- a/paf-mvp-core-js/src/crypto/keys.ts
+++ b/paf-mvp-core-js/src/crypto/keys.ts
@@ -1,23 +1,28 @@
import ECDSA from 'ecdsa-secp256r1';
-import ECKey from 'ec-key';
+import { IECDSA } from 'ecdsa-secp256r1';
+import ECKey from 'ec-key'; // Used to convert PEM keys to JWK format for use with ECDSA.
import { Timestamp } from '@core/model/generated-model';
import { getTimeStampInSec } from '@core/timestamp';
-// Not provided by ecdsa-secp256r1 unfortunately
-export interface PrivateKey {
- sign: (toSign: string) => string;
-}
-
-export interface PublicKey {
- verify: (toVerify: string, signature: string) => boolean;
-}
-
-export interface PublicKeys {
- [host: string]: PublicKey;
-}
+/**
+ * Needs to support promises for usage in the browser audit module.
+ * @param pem format public key
+ * @returns Promise for an IECDSA instance to use for verification
+ */
+export const publicKeyFromString = (pem: string): Promise => {
+ const result = ECDSA.fromJWK(new ECKey(pem).toJSON());
+ if (result instanceof Promise) {
+ return result;
+ }
+ return Promise.resolve(result);
+};
-export const publicKeyFromString = (keyString: string): PublicKey => ECDSA.fromJWK(new ECKey(keyString));
-export const privateKeyFromString = (keyString: string): PrivateKey => ECDSA.fromJWK(new ECKey(keyString));
+/**
+ * Only used in Node so no need to support promises.
+ * @param pem format private key
+ * @returns IECDSA instance ready for signing
+ */
+export const privateKeyFromString = (pem: string): IECDSA => ECDSA.fromJWK(new ECKey(pem).toJSON());
/**
* Return true if this key is valid according to start and end dates
diff --git a/paf-mvp-core-js/src/crypto/signer.ts b/paf-mvp-core-js/src/crypto/signer.ts
index 2211bb8d..0e726960 100644
--- a/paf-mvp-core-js/src/crypto/signer.ts
+++ b/paf-mvp-core-js/src/crypto/signer.ts
@@ -1,5 +1,5 @@
-import { PrivateKey } from '@core/crypto/keys';
import { Log } from '@core/log';
+import { IECDSA } from 'ecdsa-secp256r1';
export interface SignatureStringBuilder {
/**
@@ -24,11 +24,21 @@ export class Signer implements ISigner {
* @param ecdsaPrivateKey the private key that will be used to sign
* @param definition defines how to get input string for signing
*/
- constructor(private ecdsaPrivateKey: PrivateKey, protected definition: SignatureStringBuilder) {}
+ constructor(private ecdsaPrivateKey: IECDSA, protected definition: SignatureStringBuilder) {}
sign(inputData: U): string {
this.logger.Debug('Sign', inputData);
const toSign = this.definition.getInputString(inputData);
- return this.ecdsaPrivateKey.sign(toSign);
+
+ // TODO: There is a failure in the underlying crypto implementation that can return signatures that will
+ // subsequently fail validation. The change to resign the signature can be removed when the underlying bug is
+ // resolved.
+ let signature = this.ecdsaPrivateKey.sign(toSign);
+ if (this.ecdsaPrivateKey.verify) {
+ while (this.ecdsaPrivateKey.verify(toSign, signature) === false) {
+ signature = this.ecdsaPrivateKey.sign(toSign);
+ }
+ }
+ return signature;
}
}
diff --git a/paf-mvp-core-js/src/crypto/verifier.ts b/paf-mvp-core-js/src/crypto/verifier.ts
index e28fd246..833b5e37 100644
--- a/paf-mvp-core-js/src/crypto/verifier.ts
+++ b/paf-mvp-core-js/src/crypto/verifier.ts
@@ -1,4 +1,3 @@
-import { PublicKey } from '@core/crypto/keys';
import {
IdentifierDefinition,
IdsAndPreferencesDefinition,
@@ -10,9 +9,10 @@ import { Identifier, IdsAndPreferences, MessageBase } from '@core/model/generate
import { getTimeStampInSec } from '@core/timestamp';
import { Unsigned } from '@core/model/model';
import { Log } from '@core/log';
+import { IECDSA } from 'ecdsa-secp256r1';
export interface PublicKeyProvider {
- (domain: string): Promise;
+ (domain: string): Promise;
}
/**
@@ -34,7 +34,8 @@ export class Verifier {
const signature = this.definition.getSignature(signedData);
const toVerify = this.definition.getInputString(signedData);
- const result = publicKey.verify(toVerify, signature);
+ const verifyResult = publicKey.verify(toVerify, signature);
+ const result = verifyResult instanceof Promise ? await verifyResult : verifyResult;
if (result) this.logger.Debug('Verified', signedData);
else this.logger.Error('Verification failed for', signedData);
diff --git a/paf-mvp-core-js/src/model/marketing.ts b/paf-mvp-core-js/src/model/marketing.ts
new file mode 100644
index 00000000..a9db6631
--- /dev/null
+++ b/paf-mvp-core-js/src/model/marketing.ts
@@ -0,0 +1,41 @@
+import { PreferencesData } from './generated-model';
+
+/**
+ * The different states for the marketing preferences field.
+ * Can't be an enum as we need the values for the PreferencesData to be comparable.
+ */
+
+export class Marketing {
+ /**
+ * Personalized marketing.
+ */
+ public static readonly personalized: PreferencesData = {
+ use_browsing_for_personalization: true,
+ };
+
+ /**
+ * Standard marketing.
+ */
+ public static readonly standard: PreferencesData = {
+ use_browsing_for_personalization: false,
+ };
+
+ /**
+ * Customized marketing where there is no data held in this field.
+ */
+ public static readonly custom: PreferencesData = null;
+
+ /**
+ * No marketing is yet defined. The user has not made a choice.
+ */
+ public static readonly notSet: PreferencesData = undefined;
+
+ /**
+ * Determines equality of two different instances of PreferencesData.
+ * @remarks
+ * Uses the JSON.stringify to compare by value.
+ */
+ public static equals(a: PreferencesData, b: PreferencesData) {
+ return JSON.stringify(a) === JSON.stringify(b);
+ }
+}
diff --git a/paf-mvp-cmp/src/ILocale.ts b/paf-mvp-core-js/src/ui/ILocale.ts
similarity index 100%
rename from paf-mvp-cmp/src/ILocale.ts
rename to paf-mvp-core-js/src/ui/ILocale.ts
diff --git a/paf-mvp-core-js/src/ui/binding.ts b/paf-mvp-core-js/src/ui/binding.ts
index 3727f423..71e802cc 100644
--- a/paf-mvp-core-js/src/ui/binding.ts
+++ b/paf-mvp-core-js/src/ui/binding.ts
@@ -52,7 +52,7 @@ export abstract class BindingBase {
/**
* The view that will contain the element with the id.
*/
- private readonly view: IView;
+ protected readonly view: IView;
/**
* Id of the HTML elements that the field is bound to.
@@ -266,7 +266,7 @@ export class BindingElement
return element;
}
- private getString(key: T): string | null {
+ protected getString(key: T): string | null {
const keyJSON = JSON.stringify(key);
for (const item of this.pairs) {
if (JSON.stringify(item[0]) === keyJSON) {
diff --git a/paf-mvp-core-js/src/ui/loader.ts b/paf-mvp-core-js/src/ui/loader.ts
new file mode 100644
index 00000000..dca07adc
--- /dev/null
+++ b/paf-mvp-core-js/src/ui/loader.ts
@@ -0,0 +1,73 @@
+class Loader {
+ // The available language codes calculated at build time.
+ // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+ // @ts-ignore this value is populated at build time in rollup.config.js.
+ private readonly available = __Locales__;
+
+ // The default language to use if the users preferences are not available.
+ private readonly defaultLang = 'en-us';
+
+ // Record the current script so that the language script can be inserted.
+ private readonly currentScript: HTMLOrSVGScriptElement;
+
+ // The base URL that should be used to find the language specific script.
+ private readonly baseUrl: string;
+
+ // The first dot in the file name.
+ private readonly dot: number;
+
+ /**
+ * Constructs a new instance of the loader.
+ */
+ constructor(currentScript: HTMLOrSVGScriptElement) {
+ this.currentScript = currentScript;
+ this.baseUrl = this.currentScript.getAttribute('src');
+ const lastSlash = this.baseUrl.lastIndexOf('/');
+ this.dot = this.baseUrl.indexOf('.', lastSlash);
+ }
+
+ /**
+ * Gets the URL for the language code provided.
+ * @param language required
+ * @returns URL for the language
+ */
+ private getUrlForLanguage(language: string): string {
+ return this.baseUrl.substring(0, this.dot) + '-' + language + this.baseUrl.substring(this.dot);
+ }
+
+ /**
+ * Insert the JavaScript at the provided URL into the document next to this loader script copying all the configuration
+ * from the loader to the language specific script.
+ * @param url
+ */
+ private insertScript(url: string) {
+ const script = document.createElement('script');
+ const attrNames = this.currentScript.getAttributeNames();
+ for (let i = 0; i < attrNames.length; i++) {
+ const qn = attrNames[i];
+ script.setAttribute(qn, this.currentScript.getAttribute(qn));
+ }
+ script.setAttribute('src', url);
+ this.currentScript.insertAdjacentElement('afterend', script);
+ }
+
+ /**
+ * Checks if there is a bundle for the next language in the list. If so then this is inserted into the document,
+ * otherwise if there are more languages remaining then these are loaded. If there are no more languages then use the
+ * default.
+ */
+ public insertLanguage() {
+ for (let i = 0; i < window.navigator.languages.length; i++) {
+ const language = window.navigator.languages[i].toLowerCase();
+ if (this.available.indexOf(language) >= 0) {
+ const languageUrl = this.getUrlForLanguage(language);
+ this.insertScript(languageUrl);
+ return;
+ }
+ }
+ this.insertScript(this.getUrlForLanguage(this.defaultLang));
+ }
+}
+
+// Find the best language and insert it after this script.
+new Loader(document.currentScript).insertLanguage();
diff --git a/paf-mvp-core-js/tests/test-cases/key-store.test.ts b/paf-mvp-core-js/tests/test-cases/key-store.test.ts
index 52a8828f..794bd2bc 100644
--- a/paf-mvp-core-js/tests/test-cases/key-store.test.ts
+++ b/paf-mvp-core-js/tests/test-cases/key-store.test.ts
@@ -58,7 +58,7 @@ h4/WfMRMVh3HIqojt3LIsvUQig1rm9ZkcNx+IHZVhDM+hso2sXlGjF9xOQ==
startTimestampInSec: currentKey.start,
endTimestampInSec: currentKey.end,
publicKey: currentKey.key,
- publicKeyObj: publicKeyFromString(currentKey.key),
+ publicKeyObj: await publicKeyFromString(currentKey.key),
};
// Two consecutive calls
@@ -94,7 +94,7 @@ h4/WfMRMVh3HIqojt3LIsvUQig1rm9ZkcNx+IHZVhDM+hso2sXlGjF9xOQ==
startTimestampInSec: currentKey.start,
// No end date
publicKey: currentKey.key,
- publicKeyObj: publicKeyFromString(currentKey.key),
+ publicKeyObj: await publicKeyFromString(currentKey.key),
};
// Two consecutive calls
@@ -125,7 +125,7 @@ h4/WfMRMVh3HIqojt3LIsvUQig1rm9ZkcNx+IHZVhDM+hso2sXlGjF9xOQ==
startTimestampInSec: oldKey.start,
endTimestampInSec: oldKey.end,
publicKey: oldKey.key,
- publicKeyObj: publicKeyFromString(oldKey.key),
+ publicKeyObj: await publicKeyFromString(oldKey.key),
};
// First call will query it
@@ -139,7 +139,7 @@ h4/WfMRMVh3HIqojt3LIsvUQig1rm9ZkcNx+IHZVhDM+hso2sXlGjF9xOQ==
startTimestampInSec: currentKey.start,
endTimestampInSec: currentKey.end,
publicKey: currentKey.key,
- publicKeyObj: publicKeyFromString(currentKey.key),
+ publicKeyObj: await publicKeyFromString(currentKey.key),
};
expect(await keyStore.getPublicKey('domain.com')).toEqual(expectedNewKey);
diff --git a/paf-mvp-core-js/tests/test-cases/signer.test.ts b/paf-mvp-core-js/tests/test-cases/signer.test.ts
index ebe6add2..1e21d66c 100644
--- a/paf-mvp-core-js/tests/test-cases/signer.test.ts
+++ b/paf-mvp-core-js/tests/test-cases/signer.test.ts
@@ -1,10 +1,10 @@
import { Signer } from '@core/crypto/signer';
-import { PrivateKey } from '@core/crypto/keys';
import { FooSigningDefinition, FooType } from '../helpers/crypto.helper';
+import { IECDSA } from 'ecdsa-secp256r1';
describe('Signer', () => {
test('should sign based on definition', () => {
- const mockPrivateKey: PrivateKey = {
+ const mockPrivateKey: IECDSA = {
sign: (data: string) => `SIGNED[${data}]`,
};
diff --git a/paf-mvp-core-js/tests/test-cases/verifier.test.ts b/paf-mvp-core-js/tests/test-cases/verifier.test.ts
index f39962c2..4b1c9d2b 100644
--- a/paf-mvp-core-js/tests/test-cases/verifier.test.ts
+++ b/paf-mvp-core-js/tests/test-cases/verifier.test.ts
@@ -1,13 +1,13 @@
-import { PublicKey } from '@core/crypto/keys';
import { FooSigningDefinition, FooType } from '../helpers/crypto.helper';
import { PublicKeyProvider, Verifier } from '@core/crypto/verifier';
+import { IECDSA } from 'ecdsa-secp256r1';
import SpyInstance = jest.SpyInstance;
describe('Verifier', () => {
- const publicKeyA: PublicKey = {
+ const publicKeyA: IECDSA = {
verify: (toVerify: string, signature: string) => signature === `SIGNED[${toVerify}]`,
};
- const publicKeyB: PublicKey = {
+ const publicKeyB: IECDSA = {
verify: (toVerify: string, signature: string) => signature === `SIGNED_B[${toVerify}]`,
};
diff --git a/paf-mvp-demo-express/public/assets/cmp/.gitignore b/paf-mvp-demo-express/public/assets/cmp/.gitignore
deleted file mode 100644
index f49098ac..00000000
--- a/paf-mvp-demo-express/public/assets/cmp/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-ok-ui*.*
\ No newline at end of file
diff --git a/paf-mvp-demo-express/src/views/advertiser/index.hbs b/paf-mvp-demo-express/src/views/advertiser/index.hbs
index a1f0d69a..c1b5246b 100644
--- a/paf-mvp-demo-express/src/views/advertiser/index.hbs
+++ b/paf-mvp-demo-express/src/views/advertiser/index.hbs
@@ -5,7 +5,7 @@
{{#if useCmpUI}}
-
+
{{else}}
@@ -30,8 +30,8 @@
-
- --}}
+
-
-
\ No newline at end of file
diff --git a/paf-mvp-audit/src/identity-resolver.ts b/paf-mvp-audit/src/identity-resolver.ts
new file mode 100644
index 00000000..9531e0f5
--- /dev/null
+++ b/paf-mvp-audit/src/identity-resolver.ts
@@ -0,0 +1,88 @@
+import { Log } from '@core/log';
+import { GetIdentityResponse } from '@core/model';
+
+/**
+ * Service interface used to get identity information for the domain.
+ */
+export interface IdentityResolver {
+ /**
+ * Returns the identity for the domain, or null if the host has no identity.
+ * @param domain
+ */
+ get(domain: string): Promise${list.join('
')}
`; - } - - private getLocale(locales: readonly string[]): Values { - for (const locale of locales) { - switch (locale) { - case 'en-GB': - return