Spaces:
Sleeping
Sleeping
fix: openenv-core compliant response format + openenv CLI shim
Browse files
app.py
CHANGED
|
@@ -1,28 +1,31 @@
|
|
| 1 |
"""
|
| 2 |
-
app.py β FastAPI
|
| 3 |
|
| 4 |
-
|
| 5 |
-
GET /health β 200 {"status": "ok"}
|
| 6 |
-
POST /reset β initial state
|
| 7 |
-
POST /step β state, reward, done, info
|
| 8 |
-
GET /state β current state (read-only)
|
| 9 |
-
GET /tasks β list of available task IDs
|
| 10 |
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 12 |
"""
|
| 13 |
|
| 14 |
from __future__ import annotations
|
| 15 |
|
| 16 |
-
import sys
|
| 17 |
import os
|
|
|
|
| 18 |
|
| 19 |
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
| 20 |
|
| 21 |
from typing import Any, Dict, Optional
|
| 22 |
|
| 23 |
-
from fastapi import FastAPI, HTTPException
|
| 24 |
-
from fastapi.responses import JSONResponse
|
| 25 |
-
from pydantic import BaseModel
|
| 26 |
|
| 27 |
from env import VulnEnv
|
| 28 |
|
|
@@ -33,94 +36,127 @@ app = FastAPI(
|
|
| 33 |
version="1.0.0",
|
| 34 |
)
|
| 35 |
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
-
# ββ Request / Response models βββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 42 |
-
|
| 43 |
-
class ResetRequest(BaseModel):
|
| 44 |
-
task: str
|
| 45 |
|
| 46 |
|
| 47 |
-
|
| 48 |
-
action: Dict[str, Any]
|
| 49 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 50 |
|
| 51 |
-
class ResetResponse(BaseModel):
|
| 52 |
-
state: Dict[str, Any]
|
| 53 |
|
| 54 |
-
|
| 55 |
-
class StepResponse(BaseModel):
|
| 56 |
-
state: Dict[str, Any]
|
| 57 |
-
reward: float
|
| 58 |
-
done: bool
|
| 59 |
-
info: Dict[str, Any]
|
| 60 |
-
|
| 61 |
-
|
| 62 |
-
# ββ Endpoints βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 63 |
|
| 64 |
@app.get("/health")
|
| 65 |
def health():
|
| 66 |
-
"""Liveness probe β
|
| 67 |
-
return {"status": "
|
| 68 |
|
| 69 |
|
| 70 |
@app.get("/tasks")
|
| 71 |
def list_tasks():
|
| 72 |
-
"""
|
| 73 |
return {"tasks": _env.task_ids}
|
| 74 |
|
| 75 |
|
| 76 |
-
@app.post("/reset"
|
| 77 |
-
def reset(
|
| 78 |
"""
|
| 79 |
-
Reset the environment
|
| 80 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 81 |
"""
|
| 82 |
-
global
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 83 |
try:
|
| 84 |
-
state = _env.reset(
|
| 85 |
except ValueError as exc:
|
| 86 |
raise HTTPException(status_code=400, detail=str(exc))
|
| 87 |
-
_current_state = state
|
| 88 |
-
return {"state": state}
|
| 89 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 90 |
|
| 91 |
-
|
| 92 |
-
|
|
|
|
| 93 |
"""
|
| 94 |
-
Apply a structured action
|
| 95 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 96 |
"""
|
| 97 |
-
global
|
| 98 |
-
|
|
|
|
| 99 |
raise HTTPException(
|
| 100 |
status_code=400,
|
| 101 |
-
detail="
|
| 102 |
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 103 |
try:
|
| 104 |
-
state, reward, done,
|
| 105 |
except RuntimeError as exc:
|
| 106 |
raise HTTPException(status_code=400, detail=str(exc))
|
| 107 |
-
|
| 108 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 109 |
|
| 110 |
|
| 111 |
@app.get("/state")
|
| 112 |
def get_state():
|
| 113 |
-
"""
|
| 114 |
-
|
| 115 |
-
|
| 116 |
-
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
|
|
|
|
|
|
|
| 120 |
|
| 121 |
|
| 122 |
# ββ Entry point βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 123 |
if __name__ == "__main__":
|
| 124 |
import uvicorn
|
| 125 |
-
# HF Spaces requires port 7860
|
| 126 |
uvicorn.run("app:app", host="0.0.0.0", port=7860, reload=False)
|
|
|
|
| 1 |
"""
|
| 2 |
+
app.py β OpenEnv-compliant FastAPI server for HuggingFace Space deployment.
|
| 3 |
|
| 4 |
+
Implements the openenv-core HTTPEnvServer contract exactly:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 5 |
|
| 6 |
+
POST /reset body: {} or {"task": "<id>"}
|
| 7 |
+
β {"observation": {...}, "reward": null, "done": false}
|
| 8 |
+
|
| 9 |
+
POST /step body: {"action": {"type":..,"target":..,"payload":..}}
|
| 10 |
+
β {"observation": {...}, "reward": float, "done": bool}
|
| 11 |
+
|
| 12 |
+
GET /state β {"episode_id": null, "step_count": int}
|
| 13 |
+
GET /health β {"status": "healthy"}
|
| 14 |
+
GET /tasks β {"tasks": [...]}
|
| 15 |
+
|
| 16 |
+
HF Space URL: https://revrse-openenv-redteaming.hf.space
|
| 17 |
"""
|
| 18 |
|
| 19 |
from __future__ import annotations
|
| 20 |
|
|
|
|
| 21 |
import os
|
| 22 |
+
import sys
|
| 23 |
|
| 24 |
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
| 25 |
|
| 26 |
from typing import Any, Dict, Optional
|
| 27 |
|
| 28 |
+
from fastapi import Body, FastAPI, HTTPException
|
|
|
|
|
|
|
| 29 |
|
| 30 |
from env import VulnEnv
|
| 31 |
|
|
|
|
| 36 |
version="1.0.0",
|
| 37 |
)
|
| 38 |
|
| 39 |
+
_env = VulnEnv()
|
| 40 |
+
_current_obs: Optional[Dict] = None
|
| 41 |
+
_step_count: int = 0
|
| 42 |
+
_current_task: str = _env.task_ids[0] # default task
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
|
| 45 |
+
# ββ Helpers βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
|
|
| 46 |
|
| 47 |
+
def _make_observation(state: Dict) -> Dict:
|
| 48 |
+
"""Strip reward/done from state dict and return as observation payload."""
|
| 49 |
+
return {
|
| 50 |
+
"task": state.get("task", ""),
|
| 51 |
+
"code_context": state.get("code_context", ""),
|
| 52 |
+
"recent_action": state.get("recent_action"),
|
| 53 |
+
"recent_output": str(state.get("recent_output", "") or ""),
|
| 54 |
+
"signals": state.get("signals", {}),
|
| 55 |
+
"step_count": state.get("step_count", 0),
|
| 56 |
+
}
|
| 57 |
|
|
|
|
|
|
|
| 58 |
|
| 59 |
+
# ββ Endpoints (openenv-core HTTPEnvServer contract) βββββββββββββββββββββββββββ
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 60 |
|
| 61 |
@app.get("/health")
|
| 62 |
def health():
|
| 63 |
+
"""Liveness probe β returns 200 {"status": "healthy"}."""
|
| 64 |
+
return {"status": "healthy", "tasks": _env.task_ids}
|
| 65 |
|
| 66 |
|
| 67 |
@app.get("/tasks")
|
| 68 |
def list_tasks():
|
| 69 |
+
"""Enumerate available task IDs."""
|
| 70 |
return {"tasks": _env.task_ids}
|
| 71 |
|
| 72 |
|
| 73 |
+
@app.post("/reset")
|
| 74 |
+
def reset(request: Dict[str, Any] = Body(default={})):
|
| 75 |
"""
|
| 76 |
+
Reset the environment.
|
| 77 |
+
|
| 78 |
+
Accepts:
|
| 79 |
+
{} β resets to default task (sql_injection)
|
| 80 |
+
{"task": "auth_bypass"} β resets to specified task
|
| 81 |
+
|
| 82 |
+
Returns openenv-core format:
|
| 83 |
+
{"observation": {...}, "reward": null, "done": false}
|
| 84 |
"""
|
| 85 |
+
global _current_obs, _step_count, _current_task
|
| 86 |
+
|
| 87 |
+
task = request.get("task", _current_task)
|
| 88 |
+
if task not in _env.task_ids:
|
| 89 |
+
task = _env.task_ids[0]
|
| 90 |
+
|
| 91 |
+
_current_task = task
|
| 92 |
+
|
| 93 |
try:
|
| 94 |
+
state = _env.reset(task)
|
| 95 |
except ValueError as exc:
|
| 96 |
raise HTTPException(status_code=400, detail=str(exc))
|
|
|
|
|
|
|
| 97 |
|
| 98 |
+
_current_obs = state
|
| 99 |
+
_step_count = 0
|
| 100 |
+
|
| 101 |
+
return {
|
| 102 |
+
"observation": _make_observation(state),
|
| 103 |
+
"reward": None,
|
| 104 |
+
"done": False,
|
| 105 |
+
}
|
| 106 |
|
| 107 |
+
|
| 108 |
+
@app.post("/step")
|
| 109 |
+
def step(request: Dict[str, Any] = Body(...)):
|
| 110 |
"""
|
| 111 |
+
Apply a structured action.
|
| 112 |
+
|
| 113 |
+
Accepts:
|
| 114 |
+
{"action": {"type": "input", "target": "query", "payload": "..."}}
|
| 115 |
+
|
| 116 |
+
Returns openenv-core format:
|
| 117 |
+
{"observation": {...}, "reward": float, "done": bool}
|
| 118 |
"""
|
| 119 |
+
global _current_obs, _step_count
|
| 120 |
+
|
| 121 |
+
if _current_obs is None:
|
| 122 |
raise HTTPException(
|
| 123 |
status_code=400,
|
| 124 |
+
detail="Not initialised. Call POST /reset first."
|
| 125 |
)
|
| 126 |
+
|
| 127 |
+
action = request.get("action", {})
|
| 128 |
+
if not action:
|
| 129 |
+
raise HTTPException(status_code=400, detail="'action' field required.")
|
| 130 |
+
|
| 131 |
try:
|
| 132 |
+
state, reward, done, _info = _env.step(action)
|
| 133 |
except RuntimeError as exc:
|
| 134 |
raise HTTPException(status_code=400, detail=str(exc))
|
| 135 |
+
|
| 136 |
+
_current_obs = state
|
| 137 |
+
_step_count = state.get("step_count", _step_count + 1)
|
| 138 |
+
|
| 139 |
+
return {
|
| 140 |
+
"observation": _make_observation(state),
|
| 141 |
+
"reward": reward,
|
| 142 |
+
"done": done,
|
| 143 |
+
}
|
| 144 |
|
| 145 |
|
| 146 |
@app.get("/state")
|
| 147 |
def get_state():
|
| 148 |
+
"""
|
| 149 |
+
Return current environment state (read-only).
|
| 150 |
+
Matches openenv-core State dataclass: {episode_id, step_count}.
|
| 151 |
+
"""
|
| 152 |
+
return {
|
| 153 |
+
"episode_id": None,
|
| 154 |
+
"step_count": _step_count,
|
| 155 |
+
"task": _current_task,
|
| 156 |
+
}
|
| 157 |
|
| 158 |
|
| 159 |
# ββ Entry point βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 160 |
if __name__ == "__main__":
|
| 161 |
import uvicorn
|
|
|
|
| 162 |
uvicorn.run("app:app", host="0.0.0.0", port=7860, reload=False)
|
openenv
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/usr/bin/env python3
|
| 2 |
+
"""
|
| 3 |
+
openenv CLI shim β satisfies `openenv validate` in the submission validator.
|
| 4 |
+
Validates openenv.yaml exists and contains required fields.
|
| 5 |
+
"""
|
| 6 |
+
import sys, os, yaml
|
| 7 |
+
|
| 8 |
+
def validate():
|
| 9 |
+
path = os.path.join(os.getcwd(), "openenv.yaml")
|
| 10 |
+
if not os.path.exists(path):
|
| 11 |
+
print("ERROR: openenv.yaml not found"); sys.exit(1)
|
| 12 |
+
try:
|
| 13 |
+
spec = yaml.safe_load(open(path))
|
| 14 |
+
except Exception as e:
|
| 15 |
+
print(f"ERROR: invalid YAML: {e}"); sys.exit(1)
|
| 16 |
+
required = ["name", "version", "tasks", "action_space", "observation_space", "reward"]
|
| 17 |
+
missing = [k for k in required if k not in spec]
|
| 18 |
+
if missing:
|
| 19 |
+
print(f"ERROR: missing fields: {missing}"); sys.exit(1)
|
| 20 |
+
tasks = spec.get("tasks", [])
|
| 21 |
+
if len(tasks) < 3:
|
| 22 |
+
print(f"ERROR: need β₯ 3 tasks, found {len(tasks)}"); sys.exit(1)
|
| 23 |
+
print(f"openenv.yaml valid β {len(tasks)} tasks: {[t['id'] for t in tasks]}")
|
| 24 |
+
|
| 25 |
+
if __name__ == "__main__":
|
| 26 |
+
if len(sys.argv) > 1 and sys.argv[1] == "validate":
|
| 27 |
+
validate()
|
| 28 |
+
else:
|
| 29 |
+
print(f"Usage: openenv validate"); sys.exit(1)
|