leonarski_fandClaude Fable 5.1
7f884f67c7
jfjoch_broker: /start takes an optional `tokens` list (any number, all equivalent; writeOnly in the
API). While the current dataset has any, the endpoints that expose it - /statistics/data_collection,
/result/scan, /image_buffer/{start.cbor,image.cbor,image.jpeg,image.tiff}, /preview/plot{,.bin} -
answer 401 unless the request carries `Authorization: Bearer <token>`; /statistics keeps serving
the instrument view and only omits its `measurement` block. Enforcement is one pre-routing hook
over a named path set (the same set carries `bearerAuth` in jfjoch_api.yaml); tokens are compared
in constant time and never read back or logged. The tokens are replaced only by an accepted start,
and atomically with clearing the previous run's status, plots and image buffer, in this order:
clear, swap, import the new settings - so no moment serves the old run under the new tokens or the
new run's name under the old ones. Settings are validated on a copy first so a refused start
changes nothing.
jfjoch_viewer: a Token field (password echo) next to the http/https scheme in Open HTTP Connection,
JUNGFRAUJOCH_HTTP_TOKEN, and D-Bus LoadFile(..., token) / SetHttpToken; the dialog overrides the
others, nothing is persisted. A 401 clears the display, stops following and puts a line on the
status bar - no dialog, since a dataset changing hands is the normal cause.
Web frontend: key button in the top bar (token in sessionStorage, applied to the bearerAuth
operations by the generated client, and to the raw preview fetch), a tokens field in the start
form, and a "token required" hint on the plots. Python client: Configuration(access_token=...)
after regeneration.
Viewer: reference dataset accepts a structure-factor mmCIF (already read by content; the dialog
now offers it) and a model file can be chosen next to it (ProcessConfig::model_path, as
rugnux --model); the job also carries the reference's free-R flags, cell and setting, and the
copied command line states -z / --reference-column / --model. A grid scan keeps its own preferred
dataset-info plot and "Spots + background" means the spot count there. Dark theme: the navy hero
buttons, checked segments, warning texts and chart guide lines follow the theme instead of their
light-theme colours.
Docs: SECURITY.md section 3 is now the implemented scheme; a guided tour with four screenshots
in JFJOCH_VIEWER.md; broker, OpenAPI, Python client and frontend pages mention the token.
Tests: BearerTokens unit test and an HTTP round trip over the real broker HTTP layer (jfjoch_test
now compiles JFJochBrokerHttp.cpp and links httplib).
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
1.3 KiB
1.3 KiB
OpenAPI Python client
The broker's REST API has a generated Python client, published on PyPI as
jfjoch-client and regenerated from
broker/jfjoch_api.yaml by update_version.sh — the YAML is the single source of truth
(see OpenAPI).
- Client README — installation, quick start, and the index of every endpoint and model.
- DefaultApi — the full endpoint reference, with a generated example per call.
A protected dataset (one started with tokens) is read with the token as the client's bearer
credential:
import jfjoch_client
api = jfjoch_client.DefaultApi(jfjoch_client.ApiClient(
jfjoch_client.Configuration(host="http://localhost:5232", access_token="<token>")))
api.post_start(jfjoch_client.DatasetSettings(..., tokens=["<token>"]))
api.get_statistics_data_collection() # sends Authorization: Bearer <token>
The per-model pages are generated as well and are linked from the two pages above. They are built with the site but kept out of the navigation sidebar on purpose — sixty generated reference pages would otherwise be most of it.
:hidden:
:glob:
python_client/README
python_client/docs/*