omniqa 0.7.0 → 0.8.0

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.
Files changed (63) hide show
  1. package/README.md +10 -1
  2. package/dist/.tsbuildinfo +1 -1
  3. package/dist/cli.js +5 -2
  4. package/dist/cli.js.map +1 -1
  5. package/dist/commands/doctor.d.ts +7 -0
  6. package/dist/commands/doctor.d.ts.map +1 -1
  7. package/dist/commands/doctor.js +30 -4
  8. package/dist/commands/doctor.js.map +1 -1
  9. package/dist/commands/init.d.ts +3 -1
  10. package/dist/commands/init.d.ts.map +1 -1
  11. package/dist/commands/init.js +91 -16
  12. package/dist/commands/init.js.map +1 -1
  13. package/dist/commands/plan.d.ts.map +1 -1
  14. package/dist/commands/plan.js +3 -2
  15. package/dist/commands/plan.js.map +1 -1
  16. package/dist/commands/security.d.ts +2 -2
  17. package/dist/commands/security.d.ts.map +1 -1
  18. package/dist/commands/security.js +13 -6
  19. package/dist/commands/security.js.map +1 -1
  20. package/dist/commands/test.d.ts +5 -0
  21. package/dist/commands/test.d.ts.map +1 -1
  22. package/dist/commands/test.js +52 -5
  23. package/dist/commands/test.js.map +1 -1
  24. package/dist/commands/write.d.ts.map +1 -1
  25. package/dist/commands/write.js +26 -0
  26. package/dist/commands/write.js.map +1 -1
  27. package/dist/mcp/tools.d.ts.map +1 -1
  28. package/dist/mcp/tools.js +2 -1
  29. package/dist/mcp/tools.js.map +1 -1
  30. package/dist/qa.d.ts.map +1 -1
  31. package/dist/qa.js +2 -1
  32. package/dist/qa.js.map +1 -1
  33. package/dist/security-gates.d.ts +14 -5
  34. package/dist/security-gates.d.ts.map +1 -1
  35. package/dist/security-gates.js +11 -5
  36. package/dist/security-gates.js.map +1 -1
  37. package/dist/security-mask.d.ts +35 -0
  38. package/dist/security-mask.d.ts.map +1 -0
  39. package/dist/security-mask.js +104 -0
  40. package/dist/security-mask.js.map +1 -0
  41. package/dist/security-report.d.ts +71 -2
  42. package/dist/security-report.d.ts.map +1 -1
  43. package/dist/security-report.js +135 -14
  44. package/dist/security-report.js.map +1 -1
  45. package/dist/security-research.d.ts +131 -0
  46. package/dist/security-research.d.ts.map +1 -0
  47. package/dist/security-research.js +581 -0
  48. package/dist/security-research.js.map +1 -0
  49. package/dist/security-scan.d.ts +98 -0
  50. package/dist/security-scan.d.ts.map +1 -0
  51. package/dist/security-scan.js +415 -0
  52. package/dist/security-scan.js.map +1 -0
  53. package/dist/security.d.ts +3 -1
  54. package/dist/security.d.ts.map +1 -1
  55. package/dist/security.js +1 -1
  56. package/dist/security.js.map +1 -1
  57. package/dist/test.d.ts +7 -0
  58. package/dist/test.d.ts.map +1 -1
  59. package/dist/test.js +10 -3
  60. package/dist/test.js.map +1 -1
  61. package/package.json +6 -6
  62. package/skills/security-research.md +57 -0
  63. package/skills/security-review.md +27 -0
@@ -0,0 +1,131 @@
1
+ import { renderHits, type AgentRun, type AgentTool, type Environment, type Models, type Product, type Project, type Transcript } from "@omniqa/core";
2
+ import { type BrowserLike, type Interceptor } from "@omniqa/web";
3
+ /**
4
+ * The research: what the two agents of a scan have in their hands. A security researcher reads the capture and sends requests
5
+ * of its own design through the sidecar's repeater; a security reviewer sends a claim's proof again and judges it. Both are
6
+ * models, and a page may carry text written for one, so everything that matters here is code: what an agent is shown has
7
+ * every credential masked (security-mask.ts), and what it sends passes the environment's gates (security-gates.ts) and its
8
+ * own budget before it leaves. A tool says why when it does not send; it never trusts a prompt to hold an agent back.
9
+ */
10
+ export type Severity = "critical" | "high" | "medium" | "low";
11
+ export declare const SEVERITIES: Severity[];
12
+ /** One request of a claim's proof, as it left and how it was answered. */
13
+ export interface ProofRequest {
14
+ /** Who it was sent as: `guest`, an account of product.yaml, `nobody` (no session at all), or `?` for a page's request nobody of the scan is known to have made. */
15
+ as: string;
16
+ /** The request as text, credentials masked: the request line with the whole url, the headers, a blank line, the body. What is sent again is made from it. */
17
+ request: string;
18
+ status: number;
19
+ /** Where a redirect pointed. */
20
+ location?: string;
21
+ }
22
+ /** A hole the researcher says it can prove, as its `claim` tool kept it. */
23
+ export interface Claimed {
24
+ title: string;
25
+ /** Its OWASP Top 10:2025 category, `A01`. */
26
+ category: string;
27
+ severity: Severity;
28
+ /** How to see it again, in the researcher's words. */
29
+ steps: string[];
30
+ impact: string;
31
+ fix: string;
32
+ proof: ProofRequest[];
33
+ }
34
+ /** What the reviewer answers a claim. */
35
+ export interface Verdict {
36
+ verdict: "confirmed" | "discarded";
37
+ /** The severity the reviewer stands behind. */
38
+ severity: Severity;
39
+ reason: string;
40
+ }
41
+ /** Who sends: the two agents, and the code that sends a known claim's proof again. Each has a budget of its own. */
42
+ export type Sender = "researcher" | "reviewer" | "recheck";
43
+ /** How a proof's request was answered when it was sent again; `refused` says why it did not leave. */
44
+ export interface Resent {
45
+ id?: string;
46
+ status?: number;
47
+ location?: string;
48
+ refused?: string;
49
+ }
50
+ export interface ScanOptions {
51
+ product: Product;
52
+ /** The environment the scan runs on, with its name. */
53
+ environment: Environment & {
54
+ name: string;
55
+ };
56
+ sidecar: Interceptor;
57
+ /** A browser behind the sidecar. */
58
+ browser: BrowserLike;
59
+ testIdAttribute: string;
60
+ /** The requests each sender may send. */
61
+ budgets: Record<Sender, number>;
62
+ /** Keeps every request an agent sent, by its route, with the reason the agent gave. */
63
+ transcript: Transcript;
64
+ }
65
+ export interface Scan {
66
+ /** The researcher's tools on the sidecar: browse, list_requests, read_request, send_request, compare, claim, done. */
67
+ researcher(): AgentTool[];
68
+ /** The reviewer's tools for one claim (read_request, resend, send_request once, compare, verdict), and the verdict once it gave one. */
69
+ reviewer(claim: Claimed): {
70
+ tools: AgentTool[];
71
+ verdict(): Verdict | undefined;
72
+ };
73
+ /** Sends a proof again, request by request, each as it was sent, with the sessions as they are now. */
74
+ resend(proof: ProofRequest[], by: Sender): Promise<Resent[]>;
75
+ /** The claims the researcher kept, in order. */
76
+ readonly claims: Claimed[];
77
+ /** What the researcher said it tried and found closed. */
78
+ readonly tried: string[];
79
+ /** Why a request did not leave, each reason once: a switch of the environment, a budget. */
80
+ readonly refused: string[];
81
+ spent(by: Sender): {
82
+ sent: number;
83
+ read: number;
84
+ };
85
+ /** The requests a sender composed and sent, in order, each by its route with how it was answered and the reason given: `GET /api/orders/{n} as free → 403: <why>`. */
86
+ sent(by: Sender): string[];
87
+ /** `text` as an agent may read it. */
88
+ shown(text: string): Promise<string>;
89
+ close(): Promise<void>;
90
+ }
91
+ export declare function openScan(o: ScanOptions): Scan;
92
+ /** The knowledge base as every agent reads it: a file, a search, the endpoint map. */
93
+ export declare function knowledgeTools(knowledgeDir: string, index: {
94
+ search(query: string, limit: number): Parameters<typeof renderHits>[0];
95
+ } | undefined): AgentTool[];
96
+ /** What both agents' runs share. */
97
+ export interface AgentOptions {
98
+ models: Models;
99
+ /** The role's shipped skill. */
100
+ skill: string;
101
+ transcript: Transcript;
102
+ product: Product;
103
+ projects?: Project[];
104
+ instructions?: string;
105
+ log?: (line: string) => void;
106
+ }
107
+ /**
108
+ * The security researcher: the role `security` on the kernel with its skill, the knowledge tools and the tools on the sidecar,
109
+ * within `calls` model calls. Each step's prompt says what is left of both budgets. It ends by calling done, or when a budget
110
+ * does; what it found is in `scan.claims` and `scan.tried` either way.
111
+ */
112
+ export declare function research(scan: Scan, o: AgentOptions & {
113
+ input: string;
114
+ calls: number;
115
+ requests: number;
116
+ knowledge: AgentTool[];
117
+ }): Promise<AgentRun>;
118
+ /** A claim as the reviewer is handed it: what is said, and the proof by request, each as it was sent and answered. */
119
+ export declare function claimText(claim: Claimed): string;
120
+ /**
121
+ * The security reviewer on one claim: the role `securityReviewer` with its skill and its own tools, within `calls` model calls.
122
+ * Its verdict is what its `verdict` tool recorded; a review that ends without one (a budget, a model that declined) gave none.
123
+ */
124
+ export declare function review(scan: Scan, claim: Claimed, o: AgentOptions & {
125
+ calls: number;
126
+ requests: number;
127
+ }): Promise<{
128
+ run: AgentRun;
129
+ verdict?: Verdict;
130
+ }>;
131
+ //# sourceMappingURL=security-research.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"security-research.d.ts","sourceRoot":"","sources":["../src/security-research.ts"],"names":[],"mappings":"AAEA,OAAO,EAAgB,UAAU,EAAY,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAmB,KAAK,MAAM,EAAE,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC9L,OAAO,EAAoD,KAAK,WAAW,EAAoB,KAAK,WAAW,EAAiB,MAAM,aAAa,CAAC;AAMpJ;;;;;;GAMG;AAEH,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AAC9D,eAAO,MAAM,UAAU,EAAE,QAAQ,EAA0C,CAAC;AAE5E,0EAA0E;AAC1E,MAAM,WAAW,YAAY;IAC3B,mKAAmK;IACnK,EAAE,EAAE,MAAM,CAAC;IACX,6JAA6J;IAC7J,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,4EAA4E;AAC5E,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,sDAAsD;IACtD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,yCAAyC;AACzC,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,WAAW,GAAG,WAAW,CAAC;IACnC,+CAA+C;IAC/C,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oHAAoH;AACpH,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,SAAS,CAAC;AAgB3D,sGAAsG;AACtG,MAAM,WAAW,MAAM;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAUD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,uDAAuD;IACvD,WAAW,EAAE,WAAW,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5C,OAAO,EAAE,WAAW,CAAC;IACrB,oCAAoC;IACpC,OAAO,EAAE,WAAW,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,uFAAuF;IACvF,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,IAAI;IACnB,sHAAsH;IACtH,UAAU,IAAI,SAAS,EAAE,CAAC;IAC1B,wIAAwI;IACxI,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG;QAAE,KAAK,EAAE,SAAS,EAAE,CAAC;QAAC,OAAO,IAAI,OAAO,GAAG,SAAS,CAAA;KAAE,CAAC;IACjF,uGAAuG;IACvG,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7D,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;IAC3B,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IACzB,4FAA4F;IAC5F,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAClD,sKAAsK;IACtK,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,sCAAsC;IACtC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAiBD,wBAAgB,QAAQ,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI,CA0a7C;AAKD,sFAAsF;AACtF,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,SAAS,GAAG,SAAS,EAAE,CAgC/J;AAED,oCAAoC;AACpC,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,UAAU,CAAC;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B;AAKD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,SAAS,EAAE,CAAA;CAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAgBpJ;AAED,sHAAsH;AACtH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAUhD;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC;IAAE,GAAG,EAAE,QAAQ,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAmB7J"}