Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions docs/api-reference/spec/firework-v4-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,9 @@
{
"$ref": "#/components/schemas/ForumPostEvent"
},
{
"$ref": "#/components/schemas/DockerImageEvent"
},
{
"$ref": "#/components/schemas/InvalidCredentialEvent"
},
Expand Down Expand Up @@ -461,6 +464,7 @@
"bucket": "#/components/schemas/BucketEvent",
"chat_message": "#/components/schemas/ChatMessageEvent",
"cc": "#/components/schemas/FinancialEvent",
"docker_image": "#/components/schemas/DockerImageEvent",
"docker_repository": "#/components/schemas/DockerRepositoryEvent",
"forum_post": "#/components/schemas/ForumPostEvent",
"invalid_credential": "#/components/schemas/InvalidCredentialEvent",
Expand Down Expand Up @@ -4629,6 +4633,117 @@
],
"title": "CredentialsQueryPayload"
},
"DockerImageEvent": {
"properties": {
"event_type": {
"type": "string",
"const": "docker_image",
"title": "Event Type",
"default": "docker_image"
},
"data": {
"$ref": "#/components/schemas/DockerImageEventData"
},
"metadata": {
"$ref": "#/components/schemas/EventMetadata"
}
},
"type": "object",
"required": [
"data",
"metadata"
],
"title": "Docker Image"
},
"DockerImageEventData": {
"properties": {
"content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content"
},
"digest": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Digest"
},
"architecture": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Architecture"
},
"os": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Os"
},
"last_pushed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Pushed At"
},
"last_pulled_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Pulled At"
},
"tags": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Tag"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"default": []
}
},
"type": "object",
"title": "DockerImageEventData"
},
"DockerRepositoryEvent": {
"properties": {
"event_type": {
Expand Down
1 change: 1 addition & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@
"event-types-v2/forum-post",
"event-types-v2/invalid-credential",
"event-types-v2/leaked-credential",
"event-types-v2/docker-image",
"event-types-v2/docker-repository",
"event-types-v2/listing",
"event-types-v2/mitigated-credential",
Expand Down
16 changes: 16 additions & 0 deletions docs/event-types-v2/docker-image.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Docker Image"
---

import DockerImageExample from '/snippets/event_model_examples/docker_image.mdx'

The `docker_image` type represents a Docker image discovered on Docker Hub that has been recently created or updated. Image manifests are scanned for identifiers and secrets.

Each record corresponds to a single image and may include:
- The image digest and the tags it is published under, with their repository names.
- Platform details (architecture and operating system).
- When the image was last pushed and last pulled.
- The raw image manifest content.


<DockerImageExample />

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: it would be nice to add

Each record corresponds to a single image and may include:

  • The image digest and the tags it is published under, with their repository names.
  • Platform details (architecture and operating system).
  • When the image was last pushed and last pulled.
  • The raw image manifest content.

1 change: 1 addition & 0 deletions docs/event-types-v2/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Currently these event type models are supported on the
| `credit_card` | [Chat Message <Icon icon="book" size={16} />](/event-types-v2/chat-message) |
| `docker_repository`| [Docker Repository <Icon icon="book" size={16} />](/event-types-v2/docker-repository) |
| `document` | [Ransomleak (document) <Icon icon="book" size={16} />](/event-types-v2/ransom-leak) |
| `docker Image` | [Docker Image <Icon icon="book" size={16} />](/event-types-v2/docker-image) |
| `domain` | [Lookalike Domain (domain) <Icon icon="book" size={16} />](/event-types-v2/domain) |
| `forum_post` | [Forum Post & Topic <Icon icon="book" size={16} />](/event-types-v2/forum-post) |
| `invalid_credential` | [Invalid Credential <Icon icon="book" size={16} />](/event-types-v2/invalid-credential) |
Expand Down
36 changes: 36 additions & 0 deletions docs/snippets/event_model_examples/docker_image.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{/*
If you are in pyro:
- If this file changes, you should also modify the API docs.
- https://github.com/flared/docs-api/

If you are in mintlify:
- Don't edit this directly, edit the generator in pyro.
- pyro/pyro/mintlify/test_firework_event_models.py
*/}

```json Docker Image
{
"event_type": "docker_image",
"data": {
"content": "Docker image description",
"digest": "sha256:e4b991038fd226016a60046db2109bf634f7f4b4ea9a2c548b559d3652e4cc38",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a random sha256 ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's the actual hash of one of our flared/docker releases.

"architecture": "amd64",
"os": "linux",
"last_pushed_at": "2025-01-01T00:00:00",
"last_pulled_at": "2025-01-01T00:00:00",
"tags": [
{
"name": "latest",
"repository_name": "flared/docker"
}
]
},
"metadata": {
"estimated_created_at": "2025-01-01T00:00:00",
"flare_url": "https://app.flare.io/#/uid",
"matched_at": null,
"severity": "info",
"uid": "index/source/id"
}
}
```
2 changes: 2 additions & 0 deletions docs/snippets/event_model_examples/events_overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import ChatMessage from '/snippets/event_model_examples/chat_message.mdx'

import CreditCard from '/snippets/event_model_examples/credit_card.mdx'

import DockerImage from '/snippets/event_model_examples/docker_image.mdx'

import DockerRepository from '/snippets/event_model_examples/docker_repository.mdx'

Expand All @@ -38,6 +39,7 @@ import StealerLog from '/snippets/event_model_examples/stealer_log.mdx'
<Bucket />
<ChatMessage />
<CreditCard />
<DockerImage />
<DockerRepository />
<ForumPost />
<Listing />
Expand Down
Loading