@xyo-network/url-safety-plugin 5.3.2 → 5.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/neutral/Plugin.d.ts +3 -0
- package/dist/neutral/Plugin.d.ts.map +1 -0
- package/dist/neutral/Witness/Config.d.ts +15 -0
- package/dist/neutral/Witness/Config.d.ts.map +1 -0
- package/dist/neutral/Witness/Params.d.ts +12 -0
- package/dist/neutral/Witness/Params.d.ts.map +1 -0
- package/dist/neutral/Witness/Witness.d.ts +27 -0
- package/dist/neutral/Witness/Witness.d.ts.map +1 -0
- package/dist/neutral/Witness/index.d.ts +4 -0
- package/dist/neutral/Witness/index.d.ts.map +1 -0
- package/dist/neutral/index.d.ts +3 -0
- package/dist/neutral/index.d.ts.map +1 -0
- package/dist/neutral/index.mjs +94 -0
- package/dist/neutral/index.mjs.map +1 -0
- package/package.json +12 -7
- package/src/Plugin.ts +0 -16
- package/src/Witness/Config.ts +0 -16
- package/src/Witness/Params.ts +0 -15
- package/src/Witness/Witness.ts +0 -106
- package/src/Witness/index.ts +0 -3
- package/src/index.ts +0 -2
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { UrlSafetyWitness } from './Witness/index.ts';
|
|
2
|
+
export declare const UrlSafetyPlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<UrlSafetyWitness<import("./Witness/Params.ts").UrlSafetyWitnessParams>>;
|
|
3
|
+
//# sourceMappingURL=Plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAErD,eAAO,MAAM,eAAe,gJASzB,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { WitnessConfig } from '@xyo-network/witness-model';
|
|
2
|
+
export declare const UrlSafetyWitnessConfigSchema: string & {
|
|
3
|
+
readonly __schema: true;
|
|
4
|
+
};
|
|
5
|
+
export type UrlSafetyWitnessConfigSchema = typeof UrlSafetyWitnessConfigSchema;
|
|
6
|
+
export type UrlSafetyWitnessConfig = WitnessConfig<{
|
|
7
|
+
google?: {
|
|
8
|
+
safeBrowsing?: {
|
|
9
|
+
endPoint?: string;
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
schema: UrlSafetyWitnessConfigSchema;
|
|
13
|
+
urls?: string[];
|
|
14
|
+
}>;
|
|
15
|
+
//# sourceMappingURL=Config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../../src/Witness/Config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,eAAO,MAAM,4BAA4B;;CAAsD,CAAA;AAC/F,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA;AAE9E,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC;IACjD,MAAM,CAAC,EAAE;QACP,YAAY,CAAC,EAAE;YACb,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAA;KACF,CAAA;IACD,MAAM,EAAE,4BAA4B,CAAA;IACpC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,CAAC,CAAA"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { AnyConfigSchema } from '@xyo-network/module-model';
|
|
2
|
+
import type { WitnessParams } from '@xyo-network/witness-model';
|
|
3
|
+
import type { UrlSafetyWitnessConfig } from './Config.ts';
|
|
4
|
+
export interface UrlSafetyWitnessParams extends WitnessParams<AnyConfigSchema<UrlSafetyWitnessConfig>> {
|
|
5
|
+
google?: {
|
|
6
|
+
safeBrowsing?: {
|
|
7
|
+
endPoint?: string;
|
|
8
|
+
key?: string;
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=Params.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../../src/Witness/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEzD,MAAM,WAAW,sBAAuB,SAAQ,aAAa,CAC3D,eAAe,CAAC,sBAAsB,CAAC,CAAC;IAExC,MAAM,CAAC,EAAE;QACP,YAAY,CAAC,EAAE;YACb,QAAQ,CAAC,EAAE,MAAM,CAAA;YACjB,GAAG,CAAC,EAAE,MAAM,CAAA;SACb,CAAA;KACF,CAAA;CACF"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { AbstractWitness } from '@xyo-network/abstract-witness';
|
|
2
|
+
import { type Payload, type Schema } from '@xyo-network/payload-model';
|
|
3
|
+
import type { UrlPayload } from '@xyo-network/url-payload-plugin';
|
|
4
|
+
import type { UrlSafetyPayload } from '@xyo-network/url-safety-payload-plugin';
|
|
5
|
+
import type { UrlSafetyWitnessParams } from './Params.ts';
|
|
6
|
+
export type GoogleSafeBrowsingMatchSchema = typeof GoogleSafeBrowsingMatchSchema;
|
|
7
|
+
export declare const GoogleSafeBrowsingMatchSchema: "com.google.safebrowsing.match" & {
|
|
8
|
+
readonly __schema: true;
|
|
9
|
+
};
|
|
10
|
+
export interface GoogleSafeBrowsingMatch {
|
|
11
|
+
cacheDuration: string;
|
|
12
|
+
platformType: string;
|
|
13
|
+
threat: {
|
|
14
|
+
url: string;
|
|
15
|
+
};
|
|
16
|
+
threatEntryType: string;
|
|
17
|
+
threatType: string;
|
|
18
|
+
}
|
|
19
|
+
export type GoogleSafeBrowsingMatchPayload = Payload<GoogleSafeBrowsingMatch, GoogleSafeBrowsingMatchSchema>;
|
|
20
|
+
export declare class UrlSafetyWitness<TParams extends UrlSafetyWitnessParams = UrlSafetyWitnessParams> extends AbstractWitness<TParams> {
|
|
21
|
+
static readonly configSchemas: Schema[];
|
|
22
|
+
static readonly defaultConfigSchema: Schema;
|
|
23
|
+
get key(): string | undefined;
|
|
24
|
+
get urls(): string[] | undefined;
|
|
25
|
+
protected observeHandler(payloads?: UrlPayload[]): Promise<UrlSafetyPayload[]>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=Witness.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../../src/Witness/Witness.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,EACK,KAAK,OAAO,EAAE,KAAK,MAAM,EACpC,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAEjE,OAAO,KAAK,EAAE,gBAAgB,EAAuB,MAAM,wCAAwC,CAAA;AAKnG,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEzD,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAA;AAChF,eAAO,MAAM,6BAA6B;;CAAkD,CAAA;AAE5F,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,MAAM,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,EAAE,6BAA6B,CAAC,CAAA;AAqC5G,qBAAa,gBAAgB,CAAC,OAAO,SAAS,sBAAsB,GAAG,sBAAsB,CAAE,SAAQ,eAAe,CAAC,OAAO,CAAC;IAC7H,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAyD;IACzG,gBAAyB,mBAAmB,EAAE,MAAM,CAA+B;IAEnF,IAAI,GAAG,uBAEN;IAED,IAAI,IAAI,yBAEP;cAEwB,cAAc,CAAC,QAAQ,GAAE,UAAU,EAAO,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;CA6BlG"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACzE,cAAc,oBAAoB,CAAA"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
// src/Plugin.ts
|
|
2
|
+
import { PayloadSetSchema } from "@xyo-network/payload-model";
|
|
3
|
+
import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
|
|
4
|
+
import { UrlSafetySchema as UrlSafetySchema3 } from "@xyo-network/url-safety-payload-plugin";
|
|
5
|
+
|
|
6
|
+
// src/Witness/Config.ts
|
|
7
|
+
import { asSchema } from "@xyo-network/payload-model";
|
|
8
|
+
import { UrlSafetySchema } from "@xyo-network/url-safety-payload-plugin";
|
|
9
|
+
var UrlSafetyWitnessConfigSchema = asSchema(`${UrlSafetySchema}.witness.config`, true);
|
|
10
|
+
|
|
11
|
+
// src/Witness/Witness.ts
|
|
12
|
+
import { axiosJsonConfig } from "@xylabs/sdk-js";
|
|
13
|
+
import { AbstractWitness } from "@xyo-network/abstract-witness";
|
|
14
|
+
import {
|
|
15
|
+
asSchema as asSchema2
|
|
16
|
+
} from "@xyo-network/payload-model";
|
|
17
|
+
import { UrlSchema } from "@xyo-network/url-payload-plugin";
|
|
18
|
+
import { UrlSafetySchema as UrlSafetySchema2 } from "@xyo-network/url-safety-payload-plugin";
|
|
19
|
+
import { Axios } from "axios";
|
|
20
|
+
var GoogleSafeBrowsingMatchSchema = asSchema2("com.google.safebrowsing.match", true);
|
|
21
|
+
var checkUrlSafety = async (urls, config) => {
|
|
22
|
+
const axios = new Axios(axiosJsonConfig());
|
|
23
|
+
const endPoint = config?.endPoint ?? "https://safebrowsing.googleapis.com/v4/threatMatches:find";
|
|
24
|
+
const key = config?.key;
|
|
25
|
+
const mutatedUrls = urls.map((url) => url.replace("ipfs://", "https://cloudflare-ipfs.com/"));
|
|
26
|
+
if (mutatedUrls.length === 0) {
|
|
27
|
+
return [];
|
|
28
|
+
}
|
|
29
|
+
const postData = {
|
|
30
|
+
client: {
|
|
31
|
+
clientId: "foreventory",
|
|
32
|
+
clientVersion: "1.0"
|
|
33
|
+
},
|
|
34
|
+
threatInfo: {
|
|
35
|
+
platformTypes: ["WINDOWS", "LINUX", "OSX"],
|
|
36
|
+
threatEntries: mutatedUrls.map((url) => ({ url })),
|
|
37
|
+
threatEntryTypes: ["URL"],
|
|
38
|
+
threatTypes: ["SOCIAL_ENGINEERING", "POTENTIALLY_HARMFUL_APPLICATION", "UNWANTED_SOFTWARE", "THREAT_TYPE_UNSPECIFIED"]
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
const result = (await axios.post(`${endPoint}?key=${key}`, postData, { headers: { referer: "http://localhost:3000" } })).data;
|
|
42
|
+
return result.matches?.map((match) => ({ ...match, schema: GoogleSafeBrowsingMatchSchema })) ?? [];
|
|
43
|
+
};
|
|
44
|
+
var UrlSafetyWitness = class extends AbstractWitness {
|
|
45
|
+
static configSchemas = [...super.configSchemas, UrlSafetyWitnessConfigSchema];
|
|
46
|
+
static defaultConfigSchema = UrlSafetyWitnessConfigSchema;
|
|
47
|
+
get key() {
|
|
48
|
+
return this.params.google?.safeBrowsing?.key;
|
|
49
|
+
}
|
|
50
|
+
get urls() {
|
|
51
|
+
return this.config?.urls;
|
|
52
|
+
}
|
|
53
|
+
async observeHandler(payloads = []) {
|
|
54
|
+
const urls = this.urls ?? payloads.filter((p) => p.schema === UrlSchema).map((p) => {
|
|
55
|
+
return p.url;
|
|
56
|
+
});
|
|
57
|
+
const matches = await checkUrlSafety(urls, { key: this.key });
|
|
58
|
+
return urls.map((url) => {
|
|
59
|
+
const payload = matches.reduce(
|
|
60
|
+
(prev, match) => {
|
|
61
|
+
if (match.threat.url === url) {
|
|
62
|
+
prev.threatTypes = prev.threatTypes ?? [];
|
|
63
|
+
if (!prev.threatTypes.includes(match.threatEntryType)) {
|
|
64
|
+
prev.threatTypes.push(match.threatEntryType);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
return prev;
|
|
68
|
+
},
|
|
69
|
+
{ schema: UrlSafetySchema2, url }
|
|
70
|
+
);
|
|
71
|
+
payload.threatTypes = payload.threatTypes?.toSorted();
|
|
72
|
+
return payload;
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
// src/Plugin.ts
|
|
78
|
+
var UrlSafetyPlugin = () => createPayloadSetWitnessPlugin(
|
|
79
|
+
{ required: { [UrlSafetySchema3]: 1 }, schema: PayloadSetSchema },
|
|
80
|
+
{
|
|
81
|
+
witness: async (params) => {
|
|
82
|
+
const result = await UrlSafetyWitness.create(params);
|
|
83
|
+
return result;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
);
|
|
87
|
+
export {
|
|
88
|
+
GoogleSafeBrowsingMatchSchema,
|
|
89
|
+
UrlSafetyPlugin,
|
|
90
|
+
UrlSafetyWitness,
|
|
91
|
+
UrlSafetyWitnessConfigSchema,
|
|
92
|
+
UrlSafetyPlugin as default
|
|
93
|
+
};
|
|
94
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../src/Plugin.ts","../../src/Witness/Config.ts","../../src/Witness/Witness.ts"],"sourcesContent":["import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\nimport { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'\n\nimport { UrlSafetyWitness } from './Witness/index.ts'\n\nexport const UrlSafetyPlugin = () =>\n createPayloadSetWitnessPlugin<UrlSafetyWitness>(\n { required: { [UrlSafetySchema]: 1 }, schema: PayloadSetSchema },\n {\n witness: async (params) => {\n const result = await UrlSafetyWitness.create(params)\n return result\n },\n },\n )\n","import { asSchema } from '@xyo-network/payload-model'\nimport { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'\nimport type { WitnessConfig } from '@xyo-network/witness-model'\n\nexport const UrlSafetyWitnessConfigSchema = asSchema(`${UrlSafetySchema}.witness.config`, true)\nexport type UrlSafetyWitnessConfigSchema = typeof UrlSafetyWitnessConfigSchema\n\nexport type UrlSafetyWitnessConfig = WitnessConfig<{\n google?: {\n safeBrowsing?: {\n endPoint?: string\n }\n }\n schema: UrlSafetyWitnessConfigSchema\n urls?: string[]\n}>\n","import { axiosJsonConfig } from '@xylabs/sdk-js'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport {\n asSchema, type Payload, type Schema,\n} from '@xyo-network/payload-model'\nimport type { UrlPayload } from '@xyo-network/url-payload-plugin'\nimport { UrlSchema } from '@xyo-network/url-payload-plugin'\nimport type { UrlSafetyPayload, UrlSafetyThreatType } from '@xyo-network/url-safety-payload-plugin'\nimport { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'\nimport { Axios } from 'axios'\n\nimport { UrlSafetyWitnessConfigSchema } from './Config.ts'\nimport type { UrlSafetyWitnessParams } from './Params.ts'\n\nexport type GoogleSafeBrowsingMatchSchema = typeof GoogleSafeBrowsingMatchSchema\nexport const GoogleSafeBrowsingMatchSchema = asSchema('com.google.safebrowsing.match', true)\n\nexport interface GoogleSafeBrowsingMatch {\n cacheDuration: string\n platformType: string\n threat: {\n url: string\n }\n threatEntryType: string\n threatType: string\n}\n\nexport type GoogleSafeBrowsingMatchPayload = Payload<GoogleSafeBrowsingMatch, GoogleSafeBrowsingMatchSchema>\n\ninterface GoogleSafeBrowsingResult {\n matches?: GoogleSafeBrowsingMatch[]\n}\n\nconst checkUrlSafety = async (\n urls: string[],\n config?: {\n endPoint?: string\n key?: string\n },\n): Promise<GoogleSafeBrowsingMatchPayload[]> => {\n const axios = new Axios(axiosJsonConfig())\n const endPoint = config?.endPoint ?? 'https://safebrowsing.googleapis.com/v4/threatMatches:find'\n const key = config?.key\n const mutatedUrls = urls.map(url => url.replace('ipfs://', 'https://cloudflare-ipfs.com/'))\n if (mutatedUrls.length === 0) {\n return []\n }\n const postData = {\n client: {\n clientId: 'foreventory',\n clientVersion: '1.0',\n },\n threatInfo: {\n platformTypes: ['WINDOWS', 'LINUX', 'OSX'],\n threatEntries: mutatedUrls.map(url => ({ url })),\n threatEntryTypes: ['URL'],\n threatTypes: ['SOCIAL_ENGINEERING', 'POTENTIALLY_HARMFUL_APPLICATION', 'UNWANTED_SOFTWARE', 'THREAT_TYPE_UNSPECIFIED'],\n },\n }\n const result = (await axios.post<GoogleSafeBrowsingResult>(`${endPoint}?key=${key}`, postData, { headers: { referer: 'http://localhost:3000' } }))\n .data\n return result.matches?.map<GoogleSafeBrowsingMatchPayload>(match => ({ ...match, schema: GoogleSafeBrowsingMatchSchema })) ?? []\n}\n\nexport class UrlSafetyWitness<TParams extends UrlSafetyWitnessParams = UrlSafetyWitnessParams> extends AbstractWitness<TParams> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, UrlSafetyWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = UrlSafetyWitnessConfigSchema\n\n get key() {\n return this.params.google?.safeBrowsing?.key\n }\n\n get urls() {\n return this.config?.urls\n }\n\n protected override async observeHandler(payloads: UrlPayload[] = []): Promise<UrlSafetyPayload[]> {\n const urls: string[]\n = this.urls\n ?? payloads\n .filter((p): p is UrlPayload => p.schema === UrlSchema)\n .map((p) => {\n return p.url\n })\n\n const matches = await checkUrlSafety(urls, { key: this.key })\n\n return urls.map((url) => {\n // eslint-disable-next-line unicorn/no-array-reduce\n const payload = matches.reduce<UrlSafetyPayload>(\n (prev, match) => {\n if (match.threat.url === url) {\n prev.threatTypes = prev.threatTypes ?? []\n if (!prev.threatTypes.includes(match.threatEntryType as UrlSafetyThreatType)) {\n prev.threatTypes.push(match.threatEntryType as UrlSafetyThreatType)\n }\n }\n return prev\n },\n { schema: UrlSafetySchema, url },\n )\n payload.threatTypes = payload.threatTypes?.toSorted()\n return payload\n })\n }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;AAC9C,SAAS,mBAAAA,wBAAuB;;;ACFhC,SAAS,gBAAgB;AACzB,SAAS,uBAAuB;AAGzB,IAAM,+BAA+B,SAAS,GAAG,eAAe,mBAAmB,IAAI;;;ACJ9F,SAAS,uBAAuB;AAChC,SAAS,uBAAuB;AAChC;AAAA,EACE,YAAAC;AAAA,OACK;AAEP,SAAS,iBAAiB;AAE1B,SAAS,mBAAAC,wBAAuB;AAChC,SAAS,aAAa;AAMf,IAAM,gCAAgCC,UAAS,iCAAiC,IAAI;AAkB3F,IAAM,iBAAiB,OACrB,MACA,WAI8C;AAC9C,QAAM,QAAQ,IAAI,MAAM,gBAAgB,CAAC;AACzC,QAAM,WAAW,QAAQ,YAAY;AACrC,QAAM,MAAM,QAAQ;AACpB,QAAM,cAAc,KAAK,IAAI,SAAO,IAAI,QAAQ,WAAW,8BAA8B,CAAC;AAC1F,MAAI,YAAY,WAAW,GAAG;AAC5B,WAAO,CAAC;AAAA,EACV;AACA,QAAM,WAAW;AAAA,IACf,QAAQ;AAAA,MACN,UAAU;AAAA,MACV,eAAe;AAAA,IACjB;AAAA,IACA,YAAY;AAAA,MACV,eAAe,CAAC,WAAW,SAAS,KAAK;AAAA,MACzC,eAAe,YAAY,IAAI,UAAQ,EAAE,IAAI,EAAE;AAAA,MAC/C,kBAAkB,CAAC,KAAK;AAAA,MACxB,aAAa,CAAC,sBAAsB,mCAAmC,qBAAqB,yBAAyB;AAAA,IACvH;AAAA,EACF;AACA,QAAM,UAAU,MAAM,MAAM,KAA+B,GAAG,QAAQ,QAAQ,GAAG,IAAI,UAAU,EAAE,SAAS,EAAE,SAAS,wBAAwB,EAAE,CAAC,GAC7I;AACH,SAAO,OAAO,SAAS,IAAoC,YAAU,EAAE,GAAG,OAAO,QAAQ,8BAA8B,EAAE,KAAK,CAAC;AACjI;AAEO,IAAM,mBAAN,cAAgG,gBAAyB;AAAA,EAC9H,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,4BAA4B;AAAA,EACxG,OAAyB,sBAA8B;AAAA,EAEvD,IAAI,MAAM;AACR,WAAO,KAAK,OAAO,QAAQ,cAAc;AAAA,EAC3C;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,QAAQ;AAAA,EACtB;AAAA,EAEA,MAAyB,eAAe,WAAyB,CAAC,GAAgC;AAChG,UAAM,OACF,KAAK,QACF,SACA,OAAO,CAAC,MAAuB,EAAE,WAAW,SAAS,EACrD,IAAI,CAAC,MAAM;AACV,aAAO,EAAE;AAAA,IACX,CAAC;AAEP,UAAM,UAAU,MAAM,eAAe,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;AAE5D,WAAO,KAAK,IAAI,CAAC,QAAQ;AAEvB,YAAM,UAAU,QAAQ;AAAA,QACtB,CAAC,MAAM,UAAU;AACf,cAAI,MAAM,OAAO,QAAQ,KAAK;AAC5B,iBAAK,cAAc,KAAK,eAAe,CAAC;AACxC,gBAAI,CAAC,KAAK,YAAY,SAAS,MAAM,eAAsC,GAAG;AAC5E,mBAAK,YAAY,KAAK,MAAM,eAAsC;AAAA,YACpE;AAAA,UACF;AACA,iBAAO;AAAA,QACT;AAAA,QACA,EAAE,QAAQC,kBAAiB,IAAI;AAAA,MACjC;AACA,cAAQ,cAAc,QAAQ,aAAa,SAAS;AACpD,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACF;;;AFnGO,IAAM,kBAAkB,MAC7B;AAAA,EACE,EAAE,UAAU,EAAE,CAACC,gBAAe,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EAC/D;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,iBAAiB,OAAO,MAAM;AACnD,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["UrlSafetySchema","asSchema","UrlSafetySchema","asSchema","UrlSafetySchema","UrlSafetySchema"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/url-safety-plugin",
|
|
3
|
-
"version": "5.3.
|
|
3
|
+
"version": "5.3.3",
|
|
4
4
|
"description": "Typescript/Javascript Plugins for XYO Platform",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -30,21 +30,21 @@
|
|
|
30
30
|
"types": "dist/neutral/index.d.ts",
|
|
31
31
|
"files": [
|
|
32
32
|
"dist",
|
|
33
|
-
"
|
|
34
|
-
"!**/*.bench.*",
|
|
35
|
-
"!**/*.spec.*",
|
|
36
|
-
"!**/*.test.*"
|
|
33
|
+
"README.md"
|
|
37
34
|
],
|
|
35
|
+
"dependencies": {
|
|
36
|
+
"@xyo-network/url-payload-plugin": "workspace:^",
|
|
37
|
+
"@xyo-network/url-safety-payload-plugin": "workspace:^"
|
|
38
|
+
},
|
|
38
39
|
"devDependencies": {
|
|
39
40
|
"@xylabs/sdk-js": "^5.0.90",
|
|
41
|
+
"@xylabs/ts-scripts-common": "~7.5.10",
|
|
40
42
|
"@xylabs/ts-scripts-yarn3": "~7.5.10",
|
|
41
43
|
"@xylabs/tsconfig": "~7.5.10",
|
|
42
44
|
"@xyo-network/abstract-witness": "~5.3.5",
|
|
43
45
|
"@xyo-network/module-model": "~5.3.5",
|
|
44
46
|
"@xyo-network/payload-model": "~5.3.5",
|
|
45
47
|
"@xyo-network/payloadset-plugin": "~5.3.5",
|
|
46
|
-
"@xyo-network/url-payload-plugin": "5.3.2",
|
|
47
|
-
"@xyo-network/url-safety-payload-plugin": "5.3.2",
|
|
48
48
|
"@xyo-network/witness-model": "~5.3.5",
|
|
49
49
|
"axios": "^1.13.5",
|
|
50
50
|
"typescript": "~5.9.3",
|
|
@@ -53,6 +53,11 @@
|
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
55
55
|
"@xylabs/sdk-js": "^5",
|
|
56
|
+
"@xyo-network/abstract-witness": "^5",
|
|
57
|
+
"@xyo-network/module-model": "^5",
|
|
58
|
+
"@xyo-network/payload-model": "^5",
|
|
59
|
+
"@xyo-network/payloadset-plugin": "^5",
|
|
60
|
+
"@xyo-network/witness-model": "^5",
|
|
56
61
|
"axios": "^1",
|
|
57
62
|
"zod": "^4"
|
|
58
63
|
},
|
package/src/Plugin.ts
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { PayloadSetSchema } from '@xyo-network/payload-model'
|
|
2
|
-
import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
|
|
3
|
-
import { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'
|
|
4
|
-
|
|
5
|
-
import { UrlSafetyWitness } from './Witness/index.ts'
|
|
6
|
-
|
|
7
|
-
export const UrlSafetyPlugin = () =>
|
|
8
|
-
createPayloadSetWitnessPlugin<UrlSafetyWitness>(
|
|
9
|
-
{ required: { [UrlSafetySchema]: 1 }, schema: PayloadSetSchema },
|
|
10
|
-
{
|
|
11
|
-
witness: async (params) => {
|
|
12
|
-
const result = await UrlSafetyWitness.create(params)
|
|
13
|
-
return result
|
|
14
|
-
},
|
|
15
|
-
},
|
|
16
|
-
)
|
package/src/Witness/Config.ts
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
import { asSchema } from '@xyo-network/payload-model'
|
|
2
|
-
import { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'
|
|
3
|
-
import type { WitnessConfig } from '@xyo-network/witness-model'
|
|
4
|
-
|
|
5
|
-
export const UrlSafetyWitnessConfigSchema = asSchema(`${UrlSafetySchema}.witness.config`, true)
|
|
6
|
-
export type UrlSafetyWitnessConfigSchema = typeof UrlSafetyWitnessConfigSchema
|
|
7
|
-
|
|
8
|
-
export type UrlSafetyWitnessConfig = WitnessConfig<{
|
|
9
|
-
google?: {
|
|
10
|
-
safeBrowsing?: {
|
|
11
|
-
endPoint?: string
|
|
12
|
-
}
|
|
13
|
-
}
|
|
14
|
-
schema: UrlSafetyWitnessConfigSchema
|
|
15
|
-
urls?: string[]
|
|
16
|
-
}>
|
package/src/Witness/Params.ts
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
import type { AnyConfigSchema } from '@xyo-network/module-model'
|
|
2
|
-
import type { WitnessParams } from '@xyo-network/witness-model'
|
|
3
|
-
|
|
4
|
-
import type { UrlSafetyWitnessConfig } from './Config.ts'
|
|
5
|
-
|
|
6
|
-
export interface UrlSafetyWitnessParams extends WitnessParams<
|
|
7
|
-
AnyConfigSchema<UrlSafetyWitnessConfig>>
|
|
8
|
-
{
|
|
9
|
-
google?: {
|
|
10
|
-
safeBrowsing?: {
|
|
11
|
-
endPoint?: string
|
|
12
|
-
key?: string
|
|
13
|
-
}
|
|
14
|
-
}
|
|
15
|
-
}
|
package/src/Witness/Witness.ts
DELETED
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
import { axiosJsonConfig } from '@xylabs/sdk-js'
|
|
2
|
-
import { AbstractWitness } from '@xyo-network/abstract-witness'
|
|
3
|
-
import {
|
|
4
|
-
asSchema, type Payload, type Schema,
|
|
5
|
-
} from '@xyo-network/payload-model'
|
|
6
|
-
import type { UrlPayload } from '@xyo-network/url-payload-plugin'
|
|
7
|
-
import { UrlSchema } from '@xyo-network/url-payload-plugin'
|
|
8
|
-
import type { UrlSafetyPayload, UrlSafetyThreatType } from '@xyo-network/url-safety-payload-plugin'
|
|
9
|
-
import { UrlSafetySchema } from '@xyo-network/url-safety-payload-plugin'
|
|
10
|
-
import { Axios } from 'axios'
|
|
11
|
-
|
|
12
|
-
import { UrlSafetyWitnessConfigSchema } from './Config.ts'
|
|
13
|
-
import type { UrlSafetyWitnessParams } from './Params.ts'
|
|
14
|
-
|
|
15
|
-
export type GoogleSafeBrowsingMatchSchema = typeof GoogleSafeBrowsingMatchSchema
|
|
16
|
-
export const GoogleSafeBrowsingMatchSchema = asSchema('com.google.safebrowsing.match', true)
|
|
17
|
-
|
|
18
|
-
export interface GoogleSafeBrowsingMatch {
|
|
19
|
-
cacheDuration: string
|
|
20
|
-
platformType: string
|
|
21
|
-
threat: {
|
|
22
|
-
url: string
|
|
23
|
-
}
|
|
24
|
-
threatEntryType: string
|
|
25
|
-
threatType: string
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
export type GoogleSafeBrowsingMatchPayload = Payload<GoogleSafeBrowsingMatch, GoogleSafeBrowsingMatchSchema>
|
|
29
|
-
|
|
30
|
-
interface GoogleSafeBrowsingResult {
|
|
31
|
-
matches?: GoogleSafeBrowsingMatch[]
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
const checkUrlSafety = async (
|
|
35
|
-
urls: string[],
|
|
36
|
-
config?: {
|
|
37
|
-
endPoint?: string
|
|
38
|
-
key?: string
|
|
39
|
-
},
|
|
40
|
-
): Promise<GoogleSafeBrowsingMatchPayload[]> => {
|
|
41
|
-
const axios = new Axios(axiosJsonConfig())
|
|
42
|
-
const endPoint = config?.endPoint ?? 'https://safebrowsing.googleapis.com/v4/threatMatches:find'
|
|
43
|
-
const key = config?.key
|
|
44
|
-
const mutatedUrls = urls.map(url => url.replace('ipfs://', 'https://cloudflare-ipfs.com/'))
|
|
45
|
-
if (mutatedUrls.length === 0) {
|
|
46
|
-
return []
|
|
47
|
-
}
|
|
48
|
-
const postData = {
|
|
49
|
-
client: {
|
|
50
|
-
clientId: 'foreventory',
|
|
51
|
-
clientVersion: '1.0',
|
|
52
|
-
},
|
|
53
|
-
threatInfo: {
|
|
54
|
-
platformTypes: ['WINDOWS', 'LINUX', 'OSX'],
|
|
55
|
-
threatEntries: mutatedUrls.map(url => ({ url })),
|
|
56
|
-
threatEntryTypes: ['URL'],
|
|
57
|
-
threatTypes: ['SOCIAL_ENGINEERING', 'POTENTIALLY_HARMFUL_APPLICATION', 'UNWANTED_SOFTWARE', 'THREAT_TYPE_UNSPECIFIED'],
|
|
58
|
-
},
|
|
59
|
-
}
|
|
60
|
-
const result = (await axios.post<GoogleSafeBrowsingResult>(`${endPoint}?key=${key}`, postData, { headers: { referer: 'http://localhost:3000' } }))
|
|
61
|
-
.data
|
|
62
|
-
return result.matches?.map<GoogleSafeBrowsingMatchPayload>(match => ({ ...match, schema: GoogleSafeBrowsingMatchSchema })) ?? []
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
export class UrlSafetyWitness<TParams extends UrlSafetyWitnessParams = UrlSafetyWitnessParams> extends AbstractWitness<TParams> {
|
|
66
|
-
static override readonly configSchemas: Schema[] = [...super.configSchemas, UrlSafetyWitnessConfigSchema]
|
|
67
|
-
static override readonly defaultConfigSchema: Schema = UrlSafetyWitnessConfigSchema
|
|
68
|
-
|
|
69
|
-
get key() {
|
|
70
|
-
return this.params.google?.safeBrowsing?.key
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
get urls() {
|
|
74
|
-
return this.config?.urls
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
protected override async observeHandler(payloads: UrlPayload[] = []): Promise<UrlSafetyPayload[]> {
|
|
78
|
-
const urls: string[]
|
|
79
|
-
= this.urls
|
|
80
|
-
?? payloads
|
|
81
|
-
.filter((p): p is UrlPayload => p.schema === UrlSchema)
|
|
82
|
-
.map((p) => {
|
|
83
|
-
return p.url
|
|
84
|
-
})
|
|
85
|
-
|
|
86
|
-
const matches = await checkUrlSafety(urls, { key: this.key })
|
|
87
|
-
|
|
88
|
-
return urls.map((url) => {
|
|
89
|
-
// eslint-disable-next-line unicorn/no-array-reduce
|
|
90
|
-
const payload = matches.reduce<UrlSafetyPayload>(
|
|
91
|
-
(prev, match) => {
|
|
92
|
-
if (match.threat.url === url) {
|
|
93
|
-
prev.threatTypes = prev.threatTypes ?? []
|
|
94
|
-
if (!prev.threatTypes.includes(match.threatEntryType as UrlSafetyThreatType)) {
|
|
95
|
-
prev.threatTypes.push(match.threatEntryType as UrlSafetyThreatType)
|
|
96
|
-
}
|
|
97
|
-
}
|
|
98
|
-
return prev
|
|
99
|
-
},
|
|
100
|
-
{ schema: UrlSafetySchema, url },
|
|
101
|
-
)
|
|
102
|
-
payload.threatTypes = payload.threatTypes?.toSorted()
|
|
103
|
-
return payload
|
|
104
|
-
})
|
|
105
|
-
}
|
|
106
|
-
}
|
package/src/Witness/index.ts
DELETED
package/src/index.ts
DELETED