Files
Jungfraujoch/tests/BrokerHttpAuthTest.cpp
leonarski_fandClaude Opus 5.5 9e09cd4b3d
Build Packages / Create release (push) Successful in 8s
Build Packages / build:portable:macos-arm64:nocuda (push) Successful in 4m52s
Build Packages / build:rugnux:linux-aarch64:cuda (push) Successful in 9m14s
Build Packages / build:portable:linux-x86_64:nocuda (push) Successful in 15m2s
Build Packages / build:portable:linux-x86_64:cuda (push) Successful in 20m44s
Build Packages / build:portable:windows-x86_64:nocuda (push) Successful in 21m49s
Build Packages / build:jfjoch:ubuntu2204:nocuda (push) Successful in 22m3s
Build Packages / build:portable:windows-x86_64:cuda (push) Successful in 26m5s
Build Packages / build:jfjoch:rocky8:nocuda (push) Successful in 26m45s
Build Packages / build:jfjoch:rocky9:nocuda (push) Successful in 27m15s
Build Packages / HDF5 consumer tests (DIALS, XDS) (push) Successful in 28m0s
Build Packages / build:jfjoch:ubuntu2404:nocuda (push) Successful in 22m22s
Build Packages / Generate python client (push) Successful in 24s
Build Packages / Build documentation (push) Successful in 1m16s
Build Packages / build:jfjoch:rocky8:cuda-sls9 (push) Successful in 23m36s
Build Packages / build:jfjoch:rocky9:cuda-sls9 (push) Successful in 27m10s
Build Packages / build:jfjoch:rocky8:cuda (push) Successful in 26m35s
Build Packages / build:jfjoch:ubuntu2204:cuda (push) Successful in 22m7s
Build Packages / build:jfjoch:ubuntu2404:cuda (push) Successful in 25m14s
Build Packages / build:jfjoch:rocky9:cuda (push) Successful in 26m56s
Build Packages / Unit tests (push) Successful in 1h33m16s
Build Packages / Validation Battery (push) Successful in 32m33s
broker: initialize drops the dataset's bearer tokens and everything they protected
Initialize is the fresh start between users. It already cleared the
images, plots, scan result and live rugnux status; it now also drops the
tokens, resets the dataset settings (name, file prefix, unit cell, ...)
to their defaults and forgets the last collection followed through
/live/events, so after it nothing of the previous dataset is readable,
with or without its token - the broker is as open and as empty as a
freshly started one.

The auth test checks that after /initialize the data-collection
statistics and the /statistics aggregate are open and no longer carry
the previous dataset's name. SECURITY.md also lists /rugnux/status
among the protected endpoints.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PXc1zD1yxHqaR1DGdCTHL4
2026-10-20 12:16:32 +02:00

156 lines
7.7 KiB
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include <catch2/catch_all.hpp>
#include <httplib.h>
#include <nlohmann/json.hpp>
#include <chrono>
#include <thread>
#include "../broker/JFJochBrokerHttp.h"
// The tokens given to /start guard the endpoints that expose the dataset, and nothing else, for as
// long as that dataset is the current one. Runs the real HTTP layer against a broker with no
// receiver: /start is then accepted and finishes at once with nothing to acquire.
TEST_CASE("JFJochBrokerHttp_BearerTokens", "[broker]") {
DiffractionExperiment experiment;
SpotFindingSettings spot_finding;
JFJochBrokerHttp broker(experiment, spot_finding);
broker.AddDetectorSetup(DetJF4M());
httplib::Server server;
broker.attach(server);
const int port = server.bind_to_any_port("127.0.0.1");
REQUIRE(port > 0);
// Stopped and joined however the test ends, so a failed REQUIRE does not abort on a joinable thread.
struct ServerThread {
httplib::Server &server;
std::thread thread;
explicit ServerThread(httplib::Server &s) : server(s), thread([&s] { s.listen_after_bind(); }) {}
~ServerThread() { server.stop(); thread.join(); }
} server_thread(server);
server.wait_until_ready();
httplib::Client client("127.0.0.1", port);
const httplib::Headers good{{"Authorization", "Bearer secret-1"}};
const httplib::Headers other{{"Authorization", "Bearer secret-2"}};
const httplib::Headers wrong{{"Authorization", "Bearer nope"}};
auto start = [&](const nlohmann::json &extra) {
nlohmann::json body = {{"beam_x_pxl", 1000}, {"beam_y_pxl", 1000},
{"detector_distance_mm", 100}, {"incident_energy_keV", 12.4},
{"images_per_trigger", 1}, {"ntrigger", 1},
{"file_prefix", "protected_run"}};
body.update(extra);
auto res = client.Post("/start", body.dump(), "application/json");
REQUIRE(res);
REQUIRE(res->status == 200);
// With no receiver the measurement thread idles for 30 s before the run ends; wait it out.
for (int i = 0; i < 120; i++) {
auto status = client.Get("/status");
REQUIRE(status);
if (nlohmann::json::parse(status->body).at("state") == "Idle")
return;
std::this_thread::sleep_for(std::chrono::milliseconds(500));
}
FAIL("broker did not return to Idle after the start");
};
REQUIRE(client.Post("/initialize")->status == 200);
// Nothing started yet: open, whatever the header says.
REQUIRE(client.Get("/statistics/data_collection")->status == 200);
REQUIRE(client.Get("/statistics/data_collection", wrong)->status == 200);
REQUIRE(client.Get("/statistics")->status == 200);
start({{"tokens", {"secret-1", "secret-2"}}});
SECTION("protected endpoints refuse without a token and say nothing about the dataset") {
for (const char *path: {"/statistics/data_collection", "/result/scan", "/image_buffer/start.cbor",
"/image_buffer/image.cbor?id=0", "/image_buffer/image.tiff?id=0",
"/image_buffer/image.jpeg?id=0", "/preview/plot?type=bkg_estimate",
"/preview/plot.bin?type=bkg_estimate", "/live/events",
"/rugnux/status"}) {
INFO(path);
auto res = client.Get(path);
REQUIRE(res);
REQUIRE(res->status == 401);
REQUIRE(res->get_header_value("WWW-Authenticate") == "Bearer");
REQUIRE(res->body.find("protected_run") == std::string::npos);
REQUIRE(client.Get(path, wrong)->status == 401);
}
// Live rugnux settings and its model prepare the next collection: open like the rest of the configuration.
REQUIRE(client.Get("/config/rugnux")->status == 200);
REQUIRE(client.Put("/config/rugnux", R"({"enable":false})", "application/json")->status == 200);
REQUIRE(client.Put("/config/rugnux/model", "", "application/octet-stream")->status == 400);
REQUIRE(client.Delete("/config/rugnux/model")->status == 200);
}
SECTION("either token opens them") {
auto res = client.Get("/statistics/data_collection", good);
REQUIRE(res->status == 200);
REQUIRE(res->body.find("protected_run") != std::string::npos);
REQUIRE(client.Get("/statistics/data_collection", other)->status == 200);
REQUIRE(client.Get("/preview/plot?type=bkg_estimate", good)->status == 200);
REQUIRE(client.Get("/rugnux/status", good)->status == 200);
}
SECTION("the aggregate statistics drop the measurement block instead of refusing") {
auto res = client.Get("/statistics");
REQUIRE(res->status == 200);
REQUIRE_FALSE(nlohmann::json::parse(res->body).contains("measurement"));
REQUIRE(res->body.find("protected_run") == std::string::npos);
auto with_token = client.Get("/statistics", good);
REQUIRE(with_token->status == 200);
REQUIRE(nlohmann::json::parse(with_token->body).contains("measurement"));
}
SECTION("with no receiver there is no collection to follow") {
REQUIRE(client.Get("/live/events", good)->status == 409);
}
SECTION("initialize drops the tokens and everything they protected") {
REQUIRE(client.Post("/initialize")->status == 200);
for (int i = 0; i < 120 && nlohmann::json::parse(client.Get("/status")->body).at("state") != "Idle"; i++)
std::this_thread::sleep_for(std::chrono::milliseconds(500));
auto res = client.Get("/statistics/data_collection");
REQUIRE(res->status == 200);
REQUIRE(res->body.find("protected_run") == std::string::npos);
auto stats = client.Get("/statistics");
REQUIRE(stats->status == 200);
REQUIRE(stats->body.find("protected_run") == std::string::npos);
REQUIRE(client.Get("/rugnux/status")->status == 200);
REQUIRE(client.Get("/result/scan")->status != 401);
}
SECTION("the control plane and the broker status stay open") {
REQUIRE(client.Get("/status")->status == 200);
REQUIRE(client.Get("/image_buffer/status")->status == 200);
REQUIRE(client.Get("/config/detector")->status == 200);
}
SECTION("a refused start keeps the current tokens, an accepted one replaces them") {
// Not idle: /start is refused, the dataset stays protected by its own tokens.
REQUIRE(client.Post("/deactivate")->status == 200);
nlohmann::json body = {{"beam_x_pxl", 1000}, {"beam_y_pxl", 1000},
{"detector_distance_mm", 100}, {"incident_energy_keV", 12.4}};
REQUIRE(client.Post("/start", body.dump(), "application/json")->status == 500);
REQUIRE(client.Get("/statistics/data_collection")->status == 401);
REQUIRE(client.Get("/statistics/data_collection", good)->status == 200);
// Back from Inactive; the next start without tokens leaves the dataset open.
REQUIRE(client.Post("/initialize")->status == 200);
start(nlohmann::json::object());
REQUIRE(client.Get("/statistics/data_collection")->status == 200);
REQUIRE(client.Get("/statistics/data_collection", wrong)->status == 200);
// And with new tokens, the old ones no longer open it.
start({{"tokens", {"secret-3"}}});
const httplib::Headers newer{{"Authorization", "Bearer secret-3"}};
REQUIRE(client.Get("/statistics/data_collection", good)->status == 401);
REQUIRE(client.Get("/statistics/data_collection", newer)->status == 200);
}
}