capture
Documentation of capture proto files.
ostorlab.agent.message.proto.v3.capture.artifact
Message
| Field | Type | Label | Description |
|---|---|---|---|
| content | bytes | optional | The content of the artifact. |
| description | string | optional | A description of the artifact. |
| type | string | optional | The type of the artifact. |
| update_if_exist | bool | optional | Indicates whether to update the artifact if it exists. Default is false. |
ostorlab.agent.message.proto.v3.capture.filesystem
Enum: Event
| Name | Value | Description |
|---|---|---|
| ACCESS | 1 | File accessed. |
| OPEN | 2 | File opened. |
| OPEN_EXEC | 3 | File opened for execution. |
| ATTRIB | 4 | File attributes changed. |
| CREATE | 5 | File created. |
| DELETE | 6 | File deleted. |
| DELETE_SELF | 7 | File deleted by itself. |
| MOVED_FROM | 8 | File moved from. |
| MOVED_TO | 9 | File moved to. |
| MOVE_SELF | 10 | File self-moved. |
| CLOSE_WRITE | 11 | File closed for writing. |
| CLOSE_NOWRITE | 12 | File closed for reading. |
| Q_OVERFLOW | 13 | Event queue overflowed. |
| ACCESS_PERM | 14 | Access permissions changed. |
| OPEN_PERM | 15 | Open permissions changed. |
| OPEN_EXEC_PERM | 16 | Execute permissions changed. |
| CLOSE | 17 | File closed. |
| MOVE | 18 | File moved. |
| ONDIR | 19 | Event occurred on directory. |
Message
| Field | Type | Label | Description |
|---|---|---|---|
| event | Event | optional | The type of filesystem event. |
| filename | string | optional | The name of the file associated with event. |
| pid | int32 | optional | Process ID associated with the event. |
| uid | int32 | optional | User ID associated with the event. |
| gid | int32 | optional | Group ID associated with the event. |
| mode | int32 | optional | File mode associated with the event. |
| ppid | int32 | optional | Parent Process ID associated with the event. |
| proc | string | optional | The name of the process associated with the event. |
ostorlab.agent.message.proto.v3.capture.http.request
header
| Field | Type | Label | Description |
|---|---|---|---|
| name | bytes | optional | The name of the HTTP header. |
| value | bytes | optional | The value of the HTTP header. |
Message
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | optional | The ID of the HTTP request. |
| method | string | optional | The HTTP method (GET, POST, etc.). |
| headers | header | repeated | The headers of the HTTP request. |
| content | bytes | optional | The content of the HTTP request. |
| host | string | optional | The host of the HTTP request. |
| port | uint32 | optional | The port of the HTTP request. |
| http_version | bytes | optional | The version of the HTTP protocol. |
| scheme | bytes | optional | The scheme (http or https) of the request. |
| path | bytes | optional | The path of the HTTP request. |
| time_start | float | optional | The start time of the HTTP request. |
| time_end | float | optional | The end time of the HTTP request. |
ostorlab.agent.message.proto.v3.capture.http.response
header
| Field | Type | Label | Description |
|---|---|---|---|
| name | bytes | optional | The name of the HTTP header. |
| value | bytes | optional | The value of the HTTP header. |
Message
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | optional | The ID of the HTTP response. |
| status_code | int32 | optional | The HTTP status code of the response. |
| headers | header | repeated | The headers of the HTTP response. |
| content | bytes | optional | The content of the HTTP response. |
| http_version | bytes | optional | The version of the HTTP protocol. |
| reason | string | optional | The reason phrase of the HTTP response. |
| time_start | float | optional | The start time of the HTTP response. |
| time_end | float | optional | The end time of the HTTP response. |
ostorlab.agent.message.proto.v3.capture.logs
Message
| Field | Type | Label | Description |
|---|---|---|---|
| timestamp | float | optional | The timestamp of the log entry. |
| level | string | optional | The log level (e.g., INFO, ERROR). |
| message | string | optional | The message content of the log. |
ostorlab.agent.message.proto.v3.capture.request_response
header
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | optional | The name of the header. |
| value | string | optional | The value of the header. |
request
| Field | Type | Label | Description |
|---|---|---|---|
| method | string | optional | The HTTP method of the request. |
| url | string | optional | The URL of the request. |
| headers | header | repeated | The headers of the request. |
| body | bytes | optional | The body content of the request. |
response
| Field | Type | Label | Description |
|---|---|---|---|
| url | string | optional | The URL of the response. |
| status | int32 | optional | The status code of the response. |
| status_text | string | optional | The status text of the response. |
| headers | header | repeated | The headers of the response. |
| remote_ip | string | optional | The remote IP address of the response. |
| remote_port | int32 | optional | The remote port of the response. |
| protocol | string | optional | The protocol used for the response. |
| body | bytes | optional | The body content of the response. |
Message
| Field | Type | Label | Description |
|---|---|---|---|
| request | request | optional | The request message. |
| response | response | optional | The response message. |
ostorlab.agent.message.proto.v3.capture.ui_call
Message
| Field | Type | Label | Description |
|---|---|---|---|
| path | string | optional | The path of the UI call. |
| dna | string | optional | The DNA (Digital Networking Architecture) identifier associated with the UI call. |
| screenshot | bytes | optional | The screenshot captured during the UI call, encoded as bytes. |
| parent_dna | string | optional | The parent DNA identifier, if applicable. |