Spaces:
Sleeping
Sleeping
File size: 2,819 Bytes
4440ec1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | # Copyright (c) Meta Platforms, Inc. and affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
"""
FastAPI application for the Network Forensics Environment.
This module creates an HTTP server that exposes the NetworkForensicsEnvironment
over HTTP and WebSocket endpoints, compatible with EnvClient.
Endpoints:
- POST /reset: Reset the environment
- POST /step: Execute an action
- GET /state: Get current environment state
- GET /schema: Get action/observation schemas
- WS /ws: WebSocket endpoint for persistent sessions
Usage:
# Development (with auto-reload):
uvicorn server.app:app --reload --host 0.0.0.0 --port 8000
# Production:
uvicorn server.app:app --host 0.0.0.0 --port 8000 --workers 4
# Or run directly:
python -m server.app
"""
try:
from openenv.core.env_server.http_server import create_app
except Exception as e: # pragma: no cover
raise ImportError(
"openenv is required for the web interface. Install dependencies with '\n uv sync\n'"
) from e
try:
from ..models import NetworkForensicsAction, NetworkForensicsObservation
from .network_forensics_environment import NetworkForensicsEnvironment
except ImportError:
from models import NetworkForensicsAction, NetworkForensicsObservation
from server.network_forensics_environment import NetworkForensicsEnvironment
# Create the app with web interface and README integration
app = create_app(
NetworkForensicsEnvironment,
NetworkForensicsAction,
NetworkForensicsObservation,
env_name="network_forensics",
max_concurrent_envs=1, # increase this number to allow more concurrent WebSocket sessions
)
def serve(host: str = "0.0.0.0", port: int = 8000):
"""
Entry point for direct execution via uv run or python -m.
This function enables running the server without Docker:
uv run --project . server
uv run --project . server --port 8001
python -m network_forensics.server.app
Args:
host: Host address to bind to (default: "0.0.0.0")
port: Port number to listen on (default: 8000)
For production deployments, consider using uvicorn directly with
multiple workers:
uvicorn network_forensics.server.app:app --workers 4
"""
import uvicorn
uvicorn.run(app, host=host, port=port)
def main() -> None:
"""Validator-friendly entrypoint for direct execution."""
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--host", default="0.0.0.0")
parser.add_argument("--port", type=int, default=8000)
args = parser.parse_args()
serve(host=args.host, port=args.port)
if __name__ == "__main__":
main()
|