@vantagesec/socc 0.1.13 → 0.1.15
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/README.md +8 -8
- package/dist/cli.mjs +10734 -10807
- package/package.json +7 -8
- package/scripts/bootstrap-socc-soul.mjs +23 -1
- package/socc-canonical/.agents/generated/socc-agent-manifest.json +0 -231
- package/socc-canonical/.agents/generated/socc-agent.md +0 -256
- package/socc-canonical/.agents/rules/AGENT.md +0 -109
- package/socc-canonical/.agents/rules/AQL_REFERENCE.md +0 -40
- package/socc-canonical/.agents/rules/MEMORY.md +0 -19
- package/socc-canonical/.agents/rules/TOOLS.md +0 -48
- package/socc-canonical/.agents/soc-copilot/AGENTS.md +0 -28
- package/socc-canonical/.agents/soc-copilot/MEMORY.md +0 -20
- package/socc-canonical/.agents/soc-copilot/SKILL.md +0 -51
- package/socc-canonical/.agents/soc-copilot/SOUL.md +0 -31
- package/socc-canonical/.agents/soc-copilot/TOOLS.md +0 -33
- package/socc-canonical/.agents/soc-copilot/USER.md +0 -31
- package/socc-canonical/.agents/soc-copilot/identity.md +0 -7
- package/socc-canonical/.agents/soc-copilot/references/evidence-rules.md +0 -30
- package/socc-canonical/.agents/soc-copilot/references/intelligence-source-registry.md +0 -32
- package/socc-canonical/.agents/soc-copilot/references/ioc-extraction.md +0 -25
- package/socc-canonical/.agents/soc-copilot/references/knowledge-ingestion-policy.md +0 -34
- package/socc-canonical/.agents/soc-copilot/references/mitre-guidance.md +0 -21
- package/socc-canonical/.agents/soc-copilot/references/output-contract.md +0 -31
- package/socc-canonical/.agents/soc-copilot/references/security-json-patterns.md +0 -129
- package/socc-canonical/.agents/soc-copilot/references/telemetry-investigation-patterns.md +0 -39
- package/socc-canonical/.agents/soc-copilot/schemas/analysis_response.json +0 -119
- package/socc-canonical/.agents/soc-copilot/skills/code-review-excellence/SKILL.md +0 -538
- package/socc-canonical/.agents/soc-copilot/skills/cybersecurity-analyst/QUICK_REFERENCE.md +0 -263
- package/socc-canonical/.agents/soc-copilot/skills/cybersecurity-analyst/README.md +0 -243
- package/socc-canonical/.agents/soc-copilot/skills/cybersecurity-analyst/SKILL.md +0 -1707
- package/socc-canonical/.agents/soc-copilot/skills/cybersecurity-analyst/tests/quiz.md +0 -472
- package/socc-canonical/.agents/soc-copilot/skills/data-visualization/SKILL.md +0 -304
- package/socc-canonical/.agents/soc-copilot/skills/deep-research/SKILL.md +0 -192
- package/socc-canonical/.agents/soc-copilot/skills/excel-analysis/SKILL.md +0 -247
- package/socc-canonical/.agents/soc-copilot/skills/find-skills/SKILL.md +0 -133
- package/socc-canonical/.agents/soc-copilot/skills/humanizer/README.md +0 -120
- package/socc-canonical/.agents/soc-copilot/skills/humanizer/SKILL.md +0 -439
- package/socc-canonical/.agents/soc-copilot/skills/malware-behavior/SKILL.md +0 -54
- package/socc-canonical/.agents/soc-copilot/skills/mitre/SKILL.md +0 -200
- package/socc-canonical/.agents/soc-copilot/skills/observability-logs-search/SKILL.md +0 -237
- package/socc-canonical/.agents/soc-copilot/skills/observability-logs-search/references/log-search-reference.md +0 -76
- package/socc-canonical/.agents/soc-copilot/skills/payload-triage/SKILL.md +0 -53
- package/socc-canonical/.agents/soc-copilot/skills/phishing-analysis/SKILL.md +0 -51
- package/socc-canonical/.agents/soc-copilot/skills/prd/SKILL.md +0 -143
- package/socc-canonical/.agents/soc-copilot/skills/remembering-conversations/MCP-TOOLS.md +0 -137
- package/socc-canonical/.agents/soc-copilot/skills/remembering-conversations/SKILL.md +0 -65
- package/socc-canonical/.agents/soc-copilot/skills/sequential-thinking/README.md +0 -118
- package/socc-canonical/.agents/soc-copilot/skills/sequential-thinking/SKILL.md +0 -93
- package/socc-canonical/.agents/soc-copilot/skills/sequential-thinking/references/advanced.md +0 -122
- package/socc-canonical/.agents/soc-copilot/skills/sequential-thinking/references/examples.md +0 -274
- package/socc-canonical/.agents/soc-copilot/skills/soc-generalist/SKILL.md +0 -53
- package/socc-canonical/.agents/soc-copilot/skills/suspicious-url/SKILL.md +0 -51
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/CREATION-LOG.md +0 -119
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/SKILL.md +0 -296
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/condition-based-waiting-example.ts +0 -158
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/condition-based-waiting.md +0 -115
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/defense-in-depth.md +0 -122
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/find-polluter.sh +0 -63
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/root-cause-tracing.md +0 -169
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/test-academic.md +0 -14
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/test-pressure-1.md +0 -58
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/test-pressure-2.md +0 -68
- package/socc-canonical/.agents/soc-copilot/skills/systematic-debugging/test-pressure-3.md +0 -69
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/SKILL.md +0 -284
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/chinese-traditional.md +0 -535
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/english.md +0 -372
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/japanese.md +0 -515
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/tools-resources.md +0 -527
- package/socc-canonical/.agents/soc-copilot/skills/translation-expertise/translation-challenges.md +0 -603
- package/socc-canonical/.agents/soc-copilot/skills/web-search/SKILL.md +0 -322
- package/socc-canonical/.agents/soc-copilot/skills.md +0 -21
- package/socc-canonical/.agents/workflows/SOP.md +0 -137
- package/socc-canonical/README.md +0 -10
- /package/{.claude → .socc}/agents/socc.md +0 -0
- /package/{.claude → .socc}/references/evidence-rules.md +0 -0
- /package/{.claude → .socc}/references/intelligence-source-registry.md +0 -0
- /package/{.claude → .socc}/references/ioc-extraction.md +0 -0
- /package/{.claude → .socc}/references/knowledge-ingestion-policy.md +0 -0
- /package/{.claude → .socc}/references/mitre-guidance.md +0 -0
- /package/{.claude → .socc}/references/output-contract.md +0 -0
- /package/{.claude → .socc}/references/security-json-patterns.md +0 -0
- /package/{.claude → .socc}/references/telemetry-investigation-patterns.md +0 -0
- /package/{.claude → .socc}/rules/socc-business-rules.md +0 -0
- /package/{.claude → .socc}/skills/code-review-excellence/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/cybersecurity-analyst/QUICK_REFERENCE.md +0 -0
- /package/{.claude → .socc}/skills/cybersecurity-analyst/README.md +0 -0
- /package/{.claude → .socc}/skills/cybersecurity-analyst/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/cybersecurity-analyst/tests/quiz.md +0 -0
- /package/{.claude → .socc}/skills/data-visualization/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/deep-research/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/excel-analysis/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/find-skills/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/humanizer/README.md +0 -0
- /package/{.claude → .socc}/skills/humanizer/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/malware-behavior/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/mitre/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/observability-logs-search/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/observability-logs-search/references/log-search-reference.md +0 -0
- /package/{.claude → .socc}/skills/payload-triage/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/phishing-analysis/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/prd/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/remembering-conversations/MCP-TOOLS.md +0 -0
- /package/{.claude → .socc}/skills/remembering-conversations/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/sequential-thinking/README.md +0 -0
- /package/{.claude → .socc}/skills/sequential-thinking/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/sequential-thinking/references/advanced.md +0 -0
- /package/{.claude → .socc}/skills/sequential-thinking/references/examples.md +0 -0
- /package/{.claude → .socc}/skills/soc-generalist/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/suspicious-url/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/CREATION-LOG.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/condition-based-waiting-example.ts +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/condition-based-waiting.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/defense-in-depth.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/find-polluter.sh +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/root-cause-tracing.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/test-academic.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/test-pressure-1.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/test-pressure-2.md +0 -0
- /package/{.claude → .socc}/skills/systematic-debugging/test-pressure-3.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/SKILL.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/chinese-traditional.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/english.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/japanese.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/tools-resources.md +0 -0
- /package/{.claude → .socc}/skills/translation-expertise/translation-challenges.md +0 -0
- /package/{.claude → .socc}/skills/web-search/SKILL.md +0 -0
|
@@ -1,322 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: web-search
|
|
3
|
-
description: USE FOR web search. Returns ranked results with snippets, URLs, thumbnails. Supports freshness filters, SafeSearch, Goggles for custom ranking, pagination. Primary search endpoint.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Web Search
|
|
7
|
-
|
|
8
|
-
> **Requires API Key**: Get one at https://api.search.brave.com
|
|
9
|
-
>
|
|
10
|
-
> **Plan**: Included in the **Search** plan. See https://api-dashboard.search.brave.com/app/subscriptions/subscribe
|
|
11
|
-
|
|
12
|
-
## Quick Start (cURL)
|
|
13
|
-
|
|
14
|
-
### Basic Search
|
|
15
|
-
```bash
|
|
16
|
-
curl -s "https://api.search.brave.com/res/v1/web/search?q=python+web+frameworks" \
|
|
17
|
-
-H "Accept: application/json" \
|
|
18
|
-
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
### With Parameters
|
|
22
|
-
```bash
|
|
23
|
-
curl -s "https://api.search.brave.com/res/v1/web/search" \
|
|
24
|
-
-H "Accept: application/json" \
|
|
25
|
-
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
|
|
26
|
-
-G \
|
|
27
|
-
--data-urlencode "q=rust programming tutorials" \
|
|
28
|
-
--data-urlencode "country=US" \
|
|
29
|
-
--data-urlencode "search_lang=en" \
|
|
30
|
-
--data-urlencode "count=10" \
|
|
31
|
-
--data-urlencode "safesearch=moderate" \
|
|
32
|
-
--data-urlencode "freshness=pm"
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Endpoint
|
|
36
|
-
|
|
37
|
-
```http
|
|
38
|
-
GET https://api.search.brave.com/res/v1/web/search
|
|
39
|
-
POST https://api.search.brave.com/res/v1/web/search
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
**Note**: Both GET and POST methods are supported. POST is useful for long queries or complex Goggles.
|
|
43
|
-
|
|
44
|
-
**Authentication**: `X-Subscription-Token: <API_KEY>` header
|
|
45
|
-
|
|
46
|
-
**Optional Headers**:
|
|
47
|
-
- `Accept-Encoding: gzip` — Enable gzip compression
|
|
48
|
-
|
|
49
|
-
## When to Use Web Search
|
|
50
|
-
|
|
51
|
-
| Feature | Web Search (this) | LLM Context (`llm-context`) | Answers (`answers`) |
|
|
52
|
-
|--|--|--|--|
|
|
53
|
-
| Output | Structured results (links, snippets, metadata) | Pre-extracted page content for LLMs | End-to-end AI answers with citations |
|
|
54
|
-
| Result types | Web, news, videos, discussions, FAQ, infobox, locations, rich | Extracted text chunks, tables, code | Synthesized answer + source list |
|
|
55
|
-
| Unique features | Goggles, structured data (`schemas`), rich callbacks | Token budget control, threshold modes | Multi-iteration search, streaming, OpenAI SDK compatible |
|
|
56
|
-
| Speed | Fast (~0.5-1s) | Fast (<1s) | Slower (~30-180s) |
|
|
57
|
-
| Best for | Search UIs, data extraction, custom ranking | RAG pipelines, AI agents, grounding | Chat interfaces, thorough research |
|
|
58
|
-
|
|
59
|
-
## Parameters
|
|
60
|
-
|
|
61
|
-
| Parameter | Type | Required | Default | Description |
|
|
62
|
-
|--|--|--|--|--|
|
|
63
|
-
| `q` | string | **Yes** | - | Search query (1-400 chars, max 50 words) |
|
|
64
|
-
| `country` | string | No | `US` | Search country (2-letter country code or `ALL`) |
|
|
65
|
-
| `search_lang` | string | No | `en` | Language preference (2+ char language code) |
|
|
66
|
-
| `ui_lang` | string | No | `en-US` | UI language (e.g., "en-US") |
|
|
67
|
-
| `count` | int | No | `20` | Max results per page (1-20) |
|
|
68
|
-
| `offset` | int | No | `0` | Page offset for pagination (0-9) |
|
|
69
|
-
| `safesearch` | string | No | `moderate` | Adult content filter (`off`/`moderate`/`strict`) |
|
|
70
|
-
| `freshness` | string | No | - | Time filter (`pd`/`pw`/`pm`/`py` or date range) |
|
|
71
|
-
| `text_decorations` | bool | No | `true` | Include highlight markers |
|
|
72
|
-
| `spellcheck` | bool | No | `true` | Auto-correct query |
|
|
73
|
-
| `result_filter` | string | No | - | Filter result types (comma-separated) |
|
|
74
|
-
| `goggles` | string | No | - | Custom ranking filter (URL or inline) |
|
|
75
|
-
| `extra_snippets` | bool | No | - | Get up to 5 extra snippets per result |
|
|
76
|
-
| `operators` | bool | No | `true` | Apply search operators |
|
|
77
|
-
| `units` | string | No | - | Measurement units (`metric`/`imperial`) |
|
|
78
|
-
| `enable_rich_callback` | bool | No | `false` | Enable rich 3rd party data callback |
|
|
79
|
-
| `include_fetch_metadata` | bool | No | `false` | Include `fetched_content_timestamp` on results |
|
|
80
|
-
|
|
81
|
-
### Freshness Values
|
|
82
|
-
|
|
83
|
-
| Value | Description |
|
|
84
|
-
|--|--|
|
|
85
|
-
| `pd` | Past day (24 hours) |
|
|
86
|
-
| `pw` | Past week (7 days) |
|
|
87
|
-
| `pm` | Past month (31 days) |
|
|
88
|
-
| `py` | Past year (365 days) |
|
|
89
|
-
| `YYYY-MM-DDtoYYYY-MM-DD` | Custom date range |
|
|
90
|
-
|
|
91
|
-
### Result Filter Values
|
|
92
|
-
|
|
93
|
-
Filter types: `discussions`, `faq`, `infobox`, `news`, `query`, `videos`, `web`, `locations`
|
|
94
|
-
|
|
95
|
-
```bash
|
|
96
|
-
# Only web and video results
|
|
97
|
-
curl "...&result_filter=web,videos"
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
### Location Headers (Optional)
|
|
101
|
-
|
|
102
|
-
For location-aware results, add these headers. **Lat/Long is sufficient** when coordinates are known — the other headers are only needed as a fallback when coordinates are unavailable.
|
|
103
|
-
|
|
104
|
-
| Header | Type | Description |
|
|
105
|
-
|--|--|--|
|
|
106
|
-
| `X-Loc-Lat` | float | User latitude (-90.0 to 90.0) |
|
|
107
|
-
| `X-Loc-Long` | float | User longitude (-180.0 to 180.0) |
|
|
108
|
-
| `X-Loc-Timezone` | string | IANA timezone (e.g., "America/San_Francisco") |
|
|
109
|
-
| `X-Loc-City` | string | City name |
|
|
110
|
-
| `X-Loc-State` | string | State/region code (ISO 3166-2) |
|
|
111
|
-
| `X-Loc-State-Name` | string | State/region full name (e.g., "California") |
|
|
112
|
-
| `X-Loc-Country` | string | 2-letter country code |
|
|
113
|
-
| `X-Loc-Postal-Code` | string | Postal code (e.g., "94105") |
|
|
114
|
-
|
|
115
|
-
> **Priority**: `X-Loc-Lat` + `X-Loc-Long` take precedence. When provided, downstream services resolve the location directly from coordinates and the text-based headers (City, State, Country, Postal-Code) are not used for location resolution. Provide text-based headers **only** when you don't have coordinates. Sending both won't break anything — lat/long simply wins.
|
|
116
|
-
|
|
117
|
-
## Response Format
|
|
118
|
-
|
|
119
|
-
### Response Fields
|
|
120
|
-
|
|
121
|
-
| Field | Type | Description |
|
|
122
|
-
|--|--|--|
|
|
123
|
-
| `type` | string | Always `"search"` |
|
|
124
|
-
| `query.original` | string | The original search query |
|
|
125
|
-
| `query.altered` | string? | Spellcheck-corrected query (if changed) |
|
|
126
|
-
| `query.cleaned` | string? | Cleaned/normalized query |
|
|
127
|
-
| `query.spellcheck_off` | bool? | Whether spellcheck was disabled |
|
|
128
|
-
| `query.more_results_available` | bool | Whether more pages exist |
|
|
129
|
-
| `query.show_strict_warning` | bool? | True if strict safesearch blocked adult results |
|
|
130
|
-
| `query.search_operators` | object? | Applied search operators (`applied`, `cleaned_query`, `sites`) |
|
|
131
|
-
| `web.type` | string | Always `"search"` |
|
|
132
|
-
| `web.results[].title` | string | Page title |
|
|
133
|
-
| `web.results[].url` | string | Page URL |
|
|
134
|
-
| `web.results[].description` | string? | Snippet/description text |
|
|
135
|
-
| `web.results[].age` | string? | Human-readable age (e.g., "2 days ago") |
|
|
136
|
-
| `web.results[].language` | string? | Content language code |
|
|
137
|
-
| `web.results[].meta_url` | object | URL components (`scheme`, `netloc`, `hostname`, `path`) |
|
|
138
|
-
| `web.results[].thumbnail` | object? | Thumbnail (`src`, `original`) |
|
|
139
|
-
| `web.results[].thumbnail.original` | string? | Original full-size image URL |
|
|
140
|
-
| `web.results[].thumbnail.logo` | bool? | Whether the thumbnail is a logo |
|
|
141
|
-
| `web.results[].profile` | object? | Publisher identity (`name`, `url`, `long_name`, `img`) |
|
|
142
|
-
| `web.results[].page_age` | string? | ISO datetime of publication (e.g., `"2025-04-12T14:22:41"`) |
|
|
143
|
-
| `web.results[].extra_snippets` | list[str]? | Up to 5 additional excerpts |
|
|
144
|
-
| `web.results[].deep_results` | object? | Additional links (`buttons`, `links`) from the page |
|
|
145
|
-
| `web.results[].schemas` | list? | Raw schema.org structured data |
|
|
146
|
-
| `web.results[].product` | object? | Product info and reviews |
|
|
147
|
-
| `web.results[].recipe` | object? | Recipe details (ingredients, time, ratings) |
|
|
148
|
-
| `web.results[].article` | object? | Article metadata (author, publisher, date) |
|
|
149
|
-
| `web.results[].book` | object? | Book info (author, ISBN, rating) |
|
|
150
|
-
| `web.results[].software` | object? | Software product info |
|
|
151
|
-
| `web.results[].rating` | object? | Aggregate ratings |
|
|
152
|
-
| `web.results[].faq` | object? | FAQ found on the page |
|
|
153
|
-
| `web.results[].movie` | object? | Movie info (directors, actors, genre) |
|
|
154
|
-
| `web.results[].video` | object? | Video metadata (duration, views, creator) |
|
|
155
|
-
| `web.results[].location` | object? | Location/restaurant details |
|
|
156
|
-
| `web.results[].qa` | object? | Question/answer info |
|
|
157
|
-
| `web.results[].creative_work` | object? | Creative work data |
|
|
158
|
-
| `web.results[].music_recording` | object? | Music/song data |
|
|
159
|
-
| `web.results[].organization` | object? | Organization info |
|
|
160
|
-
| `web.results[].review` | object? | Review data |
|
|
161
|
-
| `web.results[].content_type` | string? | Content type classification |
|
|
162
|
-
| `web.results[].fetched_content_timestamp` | int? | Fetch timestamp (with `include_fetch_metadata=true`) |
|
|
163
|
-
| `web.mutated_by_goggles` | bool | Whether results were re-ranked by Goggles |
|
|
164
|
-
| `web.family_friendly` | bool | Whether results are family-friendly |
|
|
165
|
-
| `mixed` | object? | Preferred display order (see Mixed Response below) |
|
|
166
|
-
| `discussions.results[]` | array? | Forum discussion clusters |
|
|
167
|
-
| `discussions.results[].data.forum_name` | string? | Forum/community name |
|
|
168
|
-
| `discussions.results[].data.num_answers` | int? | Number of answers/replies |
|
|
169
|
-
| `discussions.results[].data.question` | string? | Discussion question |
|
|
170
|
-
| `discussions.results[].data.top_comment` | string? | Top-voted comment excerpt |
|
|
171
|
-
| `faq.results[]` | array? | FAQ entries |
|
|
172
|
-
| `news.results[]` | array? | News articles |
|
|
173
|
-
| `videos.results[]` | array? | Video results |
|
|
174
|
-
| `infobox.results[]` | array? | Knowledge graph entries |
|
|
175
|
-
| `locations.results[]` | array? | Local POI results |
|
|
176
|
-
| `rich.hint.vertical` | string? | Rich result type |
|
|
177
|
-
| `rich.hint.callback_key` | string? | Callback key for rich data |
|
|
178
|
-
|
|
179
|
-
### JSON Example
|
|
180
|
-
|
|
181
|
-
```json
|
|
182
|
-
{
|
|
183
|
-
"type": "search",
|
|
184
|
-
"query": {
|
|
185
|
-
"original": "python frameworks",
|
|
186
|
-
"altered": "python web frameworks",
|
|
187
|
-
"spellcheck_off": false,
|
|
188
|
-
"more_results_available": true
|
|
189
|
-
},
|
|
190
|
-
"web": {
|
|
191
|
-
"type": "search",
|
|
192
|
-
"results": [
|
|
193
|
-
{
|
|
194
|
-
"title": "Top Python Web Frameworks",
|
|
195
|
-
"url": "https://example.com/python-frameworks",
|
|
196
|
-
"description": "A comprehensive guide to Python web frameworks...",
|
|
197
|
-
"age": "2 days ago",
|
|
198
|
-
"language": "en",
|
|
199
|
-
"meta_url": {
|
|
200
|
-
"scheme": "https",
|
|
201
|
-
"netloc": "example.com",
|
|
202
|
-
"hostname": "example.com",
|
|
203
|
-
"path": "/python-frameworks"
|
|
204
|
-
},
|
|
205
|
-
"thumbnail": {
|
|
206
|
-
"src": "https://...",
|
|
207
|
-
"original": "https://original-image-url.com/img.jpg"
|
|
208
|
-
},
|
|
209
|
-
"extra_snippets": ["Additional excerpt 1...", "Additional excerpt 2..."]
|
|
210
|
-
}
|
|
211
|
-
],
|
|
212
|
-
"family_friendly": true
|
|
213
|
-
},
|
|
214
|
-
"mixed": {
|
|
215
|
-
"type": "mixed",
|
|
216
|
-
"main": [
|
|
217
|
-
{"type": "web", "index": 0, "all": false},
|
|
218
|
-
{"type": "web", "index": 1, "all": false},
|
|
219
|
-
{"type": "videos", "all": true}
|
|
220
|
-
],
|
|
221
|
-
"top": [],
|
|
222
|
-
"side": []
|
|
223
|
-
},
|
|
224
|
-
"videos": { "...": "..." },
|
|
225
|
-
"news": { "...": "..." },
|
|
226
|
-
"rich": {
|
|
227
|
-
"type": "rich",
|
|
228
|
-
"hint": {
|
|
229
|
-
"vertical": "weather",
|
|
230
|
-
"callback_key": "<callback_key_hex>"
|
|
231
|
-
}
|
|
232
|
-
}
|
|
233
|
-
}
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
### Mixed Response
|
|
237
|
-
|
|
238
|
-
The `mixed` object defines the preferred display order of results across types. It contains three arrays:
|
|
239
|
-
|
|
240
|
-
| Array | Purpose |
|
|
241
|
-
|--|--|
|
|
242
|
-
| `main` | Primary result list (ordered sequence of results to display) |
|
|
243
|
-
| `top` | Results to display above main results |
|
|
244
|
-
| `side` | Results to display alongside main results (e.g., infobox) |
|
|
245
|
-
|
|
246
|
-
Each entry is a `ResultReference` with `type` (e.g., `"web"`, `"videos"`), `index` (into the corresponding result array), and `all` (`true` to include all results of that type at this position).
|
|
247
|
-
|
|
248
|
-
## Search Operators
|
|
249
|
-
|
|
250
|
-
| Operator | Syntax | Description |
|
|
251
|
-
|--|--|--|
|
|
252
|
-
| Site | `site:example.com` | Limit results to a specific domain |
|
|
253
|
-
| File extension | `ext:pdf` | Results with a specific file extension |
|
|
254
|
-
| File type | `filetype:pdf` | Results created in a specific file type |
|
|
255
|
-
| In title | `intitle:python` | Pages with term in the title |
|
|
256
|
-
| In body | `inbody:tutorial` | Pages with term in the body |
|
|
257
|
-
| In page | `inpage:guide` | Pages with term in title or body |
|
|
258
|
-
| Language | `lang:es` | Pages in a specific language (ISO 639-1) |
|
|
259
|
-
| Location | `loc:us` | Pages from a specific country (ISO 3166-1 alpha-2) |
|
|
260
|
-
| Include | `+term` | Force inclusion of a term |
|
|
261
|
-
| Exclude | `-term` | Exclude pages containing the term |
|
|
262
|
-
| Exact match | `"exact phrase"` | Match the exact phrase in order |
|
|
263
|
-
| AND | `term1 AND term2` | Both terms required (uppercase) |
|
|
264
|
-
| OR / NOT | `term1 OR term2`, `NOT term` | Logical operators (uppercase) |
|
|
265
|
-
|
|
266
|
-
Set `operators=false` to disable operator parsing.
|
|
267
|
-
|
|
268
|
-
## Goggles (Custom Ranking) — Unique to Brave
|
|
269
|
-
|
|
270
|
-
Goggles let you **re-rank search results** — boost trusted sources, suppress SEO spam, or build focused search scopes.
|
|
271
|
-
|
|
272
|
-
| Method | Example |
|
|
273
|
-
|--|--|
|
|
274
|
-
| **Hosted** | `--data-urlencode "goggles=https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/rust_programming.goggle"` |
|
|
275
|
-
| **Inline** | `--data-urlencode 'goggles=$discard\n$site=example.com'` |
|
|
276
|
-
|
|
277
|
-
> **Hosted** goggles must be on GitHub/GitLab, include `! name:`, `! description:`, `! author:` headers, and be registered at https://search.brave.com/goggles/create. **Inline** rules need no registration.
|
|
278
|
-
|
|
279
|
-
**Syntax**: `$boost=N` / `$downrank=N` (1–10), `$discard`, `$site=example.com`. Combine with commas: `$site=example.com,boost=3`. Separate rules with `\n` (`%0A`).
|
|
280
|
-
|
|
281
|
-
**Allow list**: `$discard\n$site=docs.python.org\n$site=developer.mozilla.org` — **Block list**: `$discard,site=pinterest.com\n$discard,site=quora.com`
|
|
282
|
-
|
|
283
|
-
**Resources**: [Discover](https://search.brave.com/goggles/discover) · [Syntax](https://search.brave.com/help/goggles) · [Quickstart](https://github.com/brave/goggles-quickstart)
|
|
284
|
-
|
|
285
|
-
## Rich Data Enrichments
|
|
286
|
-
|
|
287
|
-
For queries about weather, stocks, sports, currency, etc., use the rich callback workflow:
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
# 1. Search with rich callback enabled
|
|
291
|
-
curl -s "https://api.search.brave.com/res/v1/web/search?q=weather+san+francisco&enable_rich_callback=true" \
|
|
292
|
-
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
|
|
293
|
-
|
|
294
|
-
# Response includes: "rich": {"hint": {"callback_key": "abc123...", "vertical": "weather"}}
|
|
295
|
-
|
|
296
|
-
# 2. Get rich data with the callback key
|
|
297
|
-
curl -s "https://api.search.brave.com/res/v1/web/rich?callback_key=abc123..." \
|
|
298
|
-
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
**Supported Rich Types**: Calculator, Definitions, Unit Conversion, Unix Timestamp, Package Tracker, Stock, Currency, Cryptocurrency, Weather, American Football, Baseball, Basketball, Cricket, Football/Soccer, Ice Hockey, Web3, Translator
|
|
302
|
-
|
|
303
|
-
### Rich Callback Endpoint
|
|
304
|
-
|
|
305
|
-
```http
|
|
306
|
-
GET https://api.search.brave.com/res/v1/web/rich
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
| Parameter | Type | Required | Description |
|
|
310
|
-
|--|--|--|--|
|
|
311
|
-
| `callback_key` | string | Yes | Callback key from the web search `rich.hint.callback_key` field |
|
|
312
|
-
|
|
313
|
-
## Use Cases
|
|
314
|
-
|
|
315
|
-
- **General-purpose search integration**: Richest result set (web, news, videos, discussions, FAQ, infobox, locations) in one call. For RAG/LLM grounding, prefer `llm-context`.
|
|
316
|
-
- **Structured data extraction**: Products, recipes, ratings, articles via `schemas` and typed fields on results.
|
|
317
|
-
- **Custom search with Goggles**: Unique to Brave. Boost/discard sites with inline rules or hosted Goggles for fully customized ranking.
|
|
318
|
-
|
|
319
|
-
## Notes
|
|
320
|
-
|
|
321
|
-
- **Pagination**: Use `offset` (0-9) with `count` to page through results
|
|
322
|
-
- **Count**: Max 20 for web search; actual results may be less than requested
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# skills
|
|
2
|
-
|
|
3
|
-
## Active playbooks
|
|
4
|
-
|
|
5
|
-
- `soc-generalist`: default workflow for day-to-day SOC conversation, investigative questions, IOC/CVE/hash lookups, detection reasoning, and natural-language guidance
|
|
6
|
-
- `payload-triage`: default workflow for generic payloads, logs, and suspicious artifacts
|
|
7
|
-
- `phishing-analysis`: specialized workflow for email and social engineering artifacts
|
|
8
|
-
- `malware-behavior`: specialized workflow for process execution, persistence, and malware behavior clues
|
|
9
|
-
- `suspicious-url`: specialized workflow for URLs, domains, redirects, and web indicators
|
|
10
|
-
|
|
11
|
-
## Selection guidance
|
|
12
|
-
|
|
13
|
-
- Use `soc-generalist` when the analyst is asking an open-ended operational question, wants help investigating, or references CVE, hash, IOC, ATT&CK, hunting, detection, behavior, correlation, or prioritization without a clearly structured artifact.
|
|
14
|
-
- Use `suspicious-url` when the primary artifact is a URL, domain, or redirect chain.
|
|
15
|
-
- Use `phishing-analysis` when the input contains sender, recipient, message body, subject, headers, or attachment context.
|
|
16
|
-
- Use `malware-behavior` when the input contains command lines, process trees, registry changes, persistence, or execution chains.
|
|
17
|
-
- Use `payload-triage` when the input is clearly a payload, alert, or structured log/event body.
|
|
18
|
-
|
|
19
|
-
## Structure
|
|
20
|
-
|
|
21
|
-
Each skill lives in its own folder under `skills/<skill-name>/SKILL.md`, following the same modular pattern used by the shared workspace skills. Shared guidance stays under `references/` to keep each skill concise.
|
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Procedimento obrigatório para classificar, validar e redigir alertas
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# SOP de Análise e Redação de Alertas
|
|
6
|
-
|
|
7
|
-
## 1. Objetivo
|
|
8
|
-
|
|
9
|
-
Este arquivo define a sequência obrigatória de trabalho. O agente deve seguir as etapas abaixo na ordem apresentada.
|
|
10
|
-
|
|
11
|
-
## 2. Fluxo obrigatório
|
|
12
|
-
|
|
13
|
-
### Etapa 1 - Entender a regra
|
|
14
|
-
|
|
15
|
-
1. Leia `all_rules_content.md` para entender a lógica da regra que gerou a ofensa.
|
|
16
|
-
2. Identifique qual comportamento a regra tenta detectar e quais evidências mínimas deveriam existir.
|
|
17
|
-
|
|
18
|
-
### Etapa 2 - Encontrar modelo aderente
|
|
19
|
-
|
|
20
|
-
1. Procure um modelo equivalente em `Modelos\`.
|
|
21
|
-
2. Se houver mais de um modelo parecido, escolha o mais próximo pelo tipo de ofensa, fonte de log e narrativa.
|
|
22
|
-
3. Se não houver modelo aderente, siga o formato padrão deste SOP sem inventar uma estrutura nova.
|
|
23
|
-
|
|
24
|
-
### Etapa 3 - Coletar contexto completo
|
|
25
|
-
|
|
26
|
-
1. Analise o arquivo, export ou payload por inteiro.
|
|
27
|
-
2. Não baseie a conclusão em trechos isolados quando houver mais contexto disponível.
|
|
28
|
-
3. Se houver horários, normalize a leitura para São Paulo.
|
|
29
|
-
4. Use apenas comandos compatíveis com Windows.
|
|
30
|
-
5. Evite comandos que possam gerar eventos desnecessários no ambiente monitorado.
|
|
31
|
-
|
|
32
|
-
### Etapa 4 - Validar IOCs e evidências externas
|
|
33
|
-
|
|
34
|
-
1. Siga `rules/TOOLS.md` para consultar IPs públicos, domínios e hashes externos.
|
|
35
|
-
2. Classifique IPs internos como internos antes de tentar reputação externa, salvo necessidade técnica do caso.
|
|
36
|
-
3. Se houver apenas um IOC, use somente a consulta individual.
|
|
37
|
-
4. Só use `batch.py` quando houver mais de um IOC e a consulta for realmente em lote.
|
|
38
|
-
|
|
39
|
-
### Etapa 5 - Classificar o caso
|
|
40
|
-
|
|
41
|
-
Escolha exatamente uma classificação:
|
|
42
|
-
|
|
43
|
-
- `True Positive`: atividade maliciosa ou fortemente suspeita com evidência suficiente.
|
|
44
|
-
- `Benign True Positive`: atividade confirmada como legítima, mas corretamente detectada pela regra.
|
|
45
|
-
- `False Positive`: a regra disparou por lógica inadequada, dado incorreto ou contexto que descaracteriza o risco esperado.
|
|
46
|
-
- `True Negative`: a evidência analisada não sustenta evento real de segurança.
|
|
47
|
-
- `Log Transmission Failure`: o problema principal está na coleta, transmissão ou integridade do log.
|
|
48
|
-
|
|
49
|
-
Regra de decisão:
|
|
50
|
-
|
|
51
|
-
1. `True Positive` permite alerta completo.
|
|
52
|
-
2. `Benign True Positive` exige nota de encerramento, sem alerta completo.
|
|
53
|
-
3. `False Positive`, `True Negative` e `Log Transmission Failure` encerram a tarefa sem alerta completo.
|
|
54
|
-
|
|
55
|
-
### Etapa 6 - Documentar o Racional Técnico
|
|
56
|
-
|
|
57
|
-
1. Após finalizar o alerta ou a nota de encerramento, crie obrigatoriamente um arquivo em `Training\Pensamento_Ofensa_[ID].md`.
|
|
58
|
-
2. A estrutura do arquivo deve seguir rigorosamente este modelo:
|
|
59
|
-
- **Título:** `# Fluxo de Pensamento e Execução - Ofensa [ID] ([Cliente])`
|
|
60
|
-
- **Metadados:** Data e Analista (Antigravity).
|
|
61
|
-
- **Seção 1:** `## 1. Identificação Inicial da Demanda` (O quê, Quando, Onde, Objetivo).
|
|
62
|
-
- **Seção 2:** `## 2. Análise do Evento Base` (Syslog/JSON/etc).
|
|
63
|
-
- **Seção 3:** `## 3. Investigação e Contextualização` (CSV/TI/etc).
|
|
64
|
-
- **Seção 4:** `## 4. Detalhamento de Raciocínio (Interno)` (Transcrição INTEGRAL dos thoughts. Documente todos os pensamentos).
|
|
65
|
-
- **Seção 5:** `## 5. Próximos Passos (Execução Atual)`.
|
|
66
|
-
- **Rodapé:** Divisor `---` e nota de auditoria da IA.
|
|
67
|
-
|
|
68
|
-
## 3. Formato de saída
|
|
69
|
-
|
|
70
|
-
### Exceção de cliente
|
|
71
|
-
|
|
72
|
-
Para o cliente `Icatu`, quando a operação exigir encaminhamento ao time interno de Segurança do cliente, o agente deve gerar alerta de repasse técnico mesmo que a classificação final não seja `True Positive`.
|
|
73
|
-
|
|
74
|
-
Nesse caso:
|
|
75
|
-
|
|
76
|
-
1. mantenha a classificação técnica real do caso
|
|
77
|
-
2. não trate o envio como encerramento automático
|
|
78
|
-
3. deixe explícito que a continuidade da apuração cabe ao time do cliente
|
|
79
|
-
4. use tom objetivo, sem afirmar confirmação de exfiltração ou comprometimento quando a evidência não sustentar isso
|
|
80
|
-
|
|
81
|
-
### Quando a classificação for `Benign True Positive`
|
|
82
|
-
|
|
83
|
-
Entregue uma nota de encerramento com:
|
|
84
|
-
|
|
85
|
-
1. `Classificação Final: Benign True Positive`
|
|
86
|
-
2. `Justificativa da benignidade de forma breve e direta, com no máximo 3 a 4 frases, em um parágrafo:`
|
|
87
|
-
|
|
88
|
-
Não gere saudação, alerta completo, referência MITRE ou recomendação ao cliente.
|
|
89
|
-
|
|
90
|
-
### Quando a classificação for `False Positive`, `True Negative` ou `Log Transmission Failure`
|
|
91
|
-
|
|
92
|
-
Entregue apenas:
|
|
93
|
-
|
|
94
|
-
1. `Classificação Final:`
|
|
95
|
-
2. `Justificativa da benignidade de forma breve e direta, com no máximo 3 a 4 frases, em um parágrafo:`
|
|
96
|
-
|
|
97
|
-
Não gere saudação, narrativa completa, referência MITRE ou recomendação ao cliente.
|
|
98
|
-
|
|
99
|
-
### Quando a classificação for `True Positive`
|
|
100
|
-
|
|
101
|
-
Se existir modelo aderente, siga o modelo.
|
|
102
|
-
|
|
103
|
-
Se não existir modelo aderente, use a seguinte estrutura exata:
|
|
104
|
-
|
|
105
|
-
- Introdução: `Prezados,` seguida de uma linha em branco.
|
|
106
|
-
- Título: identificação clara do comportamento no primeiro parágrafo, como nos modelos existentes.
|
|
107
|
-
- Narrativa do Evento: segundo parágrafo com o quê, quem, quando e onde.
|
|
108
|
-
- Detalhes do Evento: campos técnicos (APENAS SE HOUVER) com uma linha em branco entre eles:
|
|
109
|
-
- `Usuário:`
|
|
110
|
-
- `IP de Origem:`
|
|
111
|
-
- `Destino:` ou `Arquivo/Porta:` conforme o caso
|
|
112
|
-
- `Diretório/Caminho:` quando aplicável
|
|
113
|
-
- `Log Source:`
|
|
114
|
-
- `Análise do IP:` bloco dedicado quando houver IOC de rede relevante para a conclusão.
|
|
115
|
-
- `Análise Técnica:` parágrafo técnico objetivo.
|
|
116
|
-
- Anexos: `Em anexo o Payload.`
|
|
117
|
-
- `Referência:` primeiro parágrafo da técnica do MITRE na íntegra em Português. NÃO INTERPRETE NEM ALTERE
|
|
118
|
-
- `Referência MITRE:` link direto da técnica.
|
|
119
|
-
- `Recomendação:` parágrafo final fluido, anônimo e reaproveitável, preferencialmente iniciado por `Recomendamos ...`.
|
|
120
|
-
|
|
121
|
-
Não inclua nada após a recomendação.
|
|
122
|
-
|
|
123
|
-
## 4. Regras de redação
|
|
124
|
-
|
|
125
|
-
1. Não use asteriscos, negrito, itálico ou listas no corpo final do alerta.
|
|
126
|
-
2. Não use subtítulos fora dos rótulos previstos neste arquivo ou no modelo escolhido.
|
|
127
|
-
3. Os rótulos `Análise do IP:`, `Análise Técnica:` e `Referência MITRE:` devem ser preservados quando fizerem parte do modelo aderente ou da estrutura padrão deste SOP.
|
|
128
|
-
4. O bloco final de recomendação deve ser mantido no alerta completo, preferencialmente iniciado por `Recomendamos ...`.
|
|
129
|
-
5. Se algum campo estiver ausente, não inclua nada.
|
|
130
|
-
6. Mantenha a recomendação genérica o suficiente para reuso.
|
|
131
|
-
7. Não exponha nenhum dado do cliente na recomendação (nomes de serviços, máquinas, usuários ou programas).
|
|
132
|
-
8. Todo alerta e toda nota de encerramento devem ser entregues com acentuação e cedilha corretas em português. Texto sem acentuação é erro de saída.
|
|
133
|
-
9. Faça uma revisão final de idioma antes da entrega, verificando especialmente palavras como `não`, `análise`, `ação`, `segurança`, `técnica`, `usuário`, `informações` e `referência`.
|
|
134
|
-
|
|
135
|
-
## 5. Aprendizado operacional
|
|
136
|
-
|
|
137
|
-
Se durante a execução houver erro recorrente, ambiguidade relevante ou ajuste de processo que mereça ser lembrado depois, registre em `rules/MEMORY.md` com nota curta e objetiva.
|
package/socc-canonical/README.md
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
# SOCC Canonical Assets
|
|
2
|
-
|
|
3
|
-
This directory contains the canonical source files for the SOCC agent soul.
|
|
4
|
-
|
|
5
|
-
- `.agents/soc-copilot/` holds the source identity and behavior contract
|
|
6
|
-
- `.agents/rules/` holds always-on business rules and tooling conventions
|
|
7
|
-
- `.agents/workflows/` holds declarative SOC operating procedures used as guidance
|
|
8
|
-
- `.agents/generated/` holds generated artifacts produced by `bootstrap-socc-soul.mjs`
|
|
9
|
-
|
|
10
|
-
Nothing here should be treated as runtime, harness, or command source code.
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/{.claude → .socc}/skills/observability-logs-search/references/log-search-reference.md
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|