Działa wszystko poza kodem QR
Zgłoszenie przychodzi bez żadnych przydatnych szczegółów, bo nie ma czego podać. Ktoś otwiera Buzz na komputerze, wybiera opcję dodania telefonu i od razu pojawia się kod QR. Skanuje go. Kilka sekund później komputer zgłasza błąd parowania, a w jego treści widać 404.
To dezorientuje, bo przekaźnik jest ewidentnie zdrowy. Wiadomości dochodzą, pliki się wgrywają, zaproszenia działają, a komputer, któremu nie udaje się sparować, sam jest w tej chwili połączony z przekaźnikiem. Zepsute jest tylko parowanie, a powód jest taki, że parowanie to jedyna rzecz, która nie rozmawia ze skonfigurowanym przez Ciebie przekaźnikiem.
Niesparowany telefon nie zapuka do frontowych drzwi
Przekaźnik, który egzekwuje członkostwo, pilnuje już samego połączenia WebSocket: najpierw udowadniasz, kim jesteś, dopiero potem dostajesz gniazdo. Właśnie po to się to włącza. Ale telefon, który nigdy nie był sparowany, nie ma tożsamości, którą przekaźnik by rozpoznał. Nie może połączyć się z głównym przekaźnikiem, żeby odebrać handshake parowania, bo to właśnie z handshake'u dostaje klucz potrzebny do połączenia. Kura i jajko.
Dlatego handshake parowania odbywa się gdzie indziej, kanałem, który przyjmuje każdego: to malutki przekaźnik, który przenosi jeden rodzaj zdarzeń, nie trzyma historii i zapomina o Tobie po dwóch minutach. Na otwartym przekaźniku bez kontroli członkostwa nic z tego nie jest potrzebne, bo telefon może po prostu połączyć się z głównym przekaźnikiem jak każdy inny nieznajomy. Kanał poza pasmem istnieje dokładnie dlatego, że zamknąłeś frontowe drzwi.
Kanał to drugi proces i chowa się na widoku
Tym kanałem jest buzz-pair-relay, osobna binarka w drzewie Buzz. Jest celowo mała: bez trwałości, bez uwierzytelniania, bez historii, jeden rodzaj zdarzeń, sprawdzanie podpisów, deduplikacja, okno świeżości, limit 128 połączeń, limit ramki 4 KiB i twardy, 120-sekundowy czas życia każdego połączenia. To komponent, który da się przeczytać za jednym posiedzeniem, a potem przestać o nim myśleć.
Jego notatka wdrożeniowa to cała historia tego artykułu. Nasłuchuje wyłącznie na pętli zwrotnej, domyślnie 127.0.0.1:5000, a dokumentacja mówi, że wymaga przed sobą reverse proxy, które kieruje do niego /pair, terminuje TLS i egzekwuje timeouty odczytu. Sam nie ogranicza ścieżek ani połączeń przed uaktualnieniem, celowo, bo to zadanie proxy. Proces nasłuchujący na 127.0.0.1, do którego nic nie kieruje ruchu, to proces, który nie robi zupełnie nic, po cichu, w nieskończoność.
I tu jest haczyk, który czyni sprawę śliską: binarka jest dostarczana w standardowym obrazie przekaźnika. Dockerfile buduje ją razem z przekaźnikiem i kopiuje do /usr/local/bin/buzz-pair-relay. Jeśli więc zaczniesz szukać, znajdziesz ją w kontenerze. Wygląda na zainstalowaną, bo jest zainstalowana. Po prostu nikt jej nie uruchomił i nikt nie skierował do niej ruchu.
Jak klient decyduje, gdzie parować
Zanim komputer narysuje kod QR, pyta przekaźnik, gdzie odbywa się parowanie. Pytanie to zwykły HTTP GET na origin przekaźnika z nagłówkiem Accept: application/nostr+json, czyli standardowy dokument informacyjny NIP-11, a odpowiedź rozstrzyga wszystko, co dzieje się dalej.
Możliwe są trzy wyniki. Jeśli dokument zawiera pairing_relay_url, który parsuje się jako URL ws albo wss, komputer używa go i nic innego nie ma znaczenia. W przeciwnym razie, jeśli supported_nips zawiera 43, przekaźnik deklaruje, że egzekwuje członkostwo, a komputer wraca do starej konwencji: bierze własny URL przekaźnika i dopisuje /pair. Gdy nie zachodzi ani jedno, ani drugie, używa bezpośrednio głównego przekaźnika, co jest dobrą odpowiedzią dla otwartego przekaźnika.
Pułapką jest druga gałąź. Wybiera się ją na podstawie deklaracji, a nie sprawdzenia. Nic nie weryfikuje, czy /pair istnieje, zanim kod QR pojawi się na ekranie, bo kod QR jest budowany z URL-a, a nie z udanego połączenia z nim. Przekaźnik, który egzekwuje członkostwo, a więc uczciwie ogłasza NIP-43, kieruje zatem każdą próbę parowania na ścieżkę, która może zwracać 404, a dowiaduje się o tym klient.
Jedno żądanie i już wiesz
Do sprawdzenia tego nie potrzebujesz telefonu, kodu QR ani drugiego urządzenia. Zapytaj publiczną nazwę hosta przekaźnika o /pair curlem, skądkolwiek.
404 oznacza, że parowanie na tym przekaźniku jest zepsute, dziś, dla wszystkich. Warto znać odpowiedź zdrową, bo ona też wygląda jak porażka: poprawnie podpięty sidecar odpowiada 400 Bad Request. Curl nie wysyła uaktualnienia do WebSocket, a sidecar odrzuca wszystko, co nie jest poprawnie sformułowanym uaktualnieniem, kodem 400, zanim zrobi cokolwiek innego. 400 to więc dobra wiadomość, 404 to zła, a dzieli je jedna cyfra w miejscu, na które nikt nie patrzy uważnie.
Potem przeczytaj, co przekaźnik deklaruje, bo od tego zależy, czy /pair w ogóle warto testować. Jeśli ustawiony jest pairing_relay_url, klienci idą tam, a ten sam test 400 kontra 404 stosuje się do tamtego hosta. Jeśli go nie ma, a NIP-43 jest na liście, stara ścieżka jest aktywna i /pair to dokładnie miejsce, do którego trafi każdy klient.
Jeśli pairing_relay_url zwróci wartość, to właśnie ten adres należy sprawdzić, a /pair nie jest w ogóle używany. Jeśli zwróci null, a sprawdzenie NIP-43 odda indeks zamiast null, to /pair na tym hoście jest dokładnie tym miejscem, do którego trafi każdy klient.
Trzy poprawki, a wystarczy jedna
Uruchom go i skieruj do niego ruch. Binarka jest już w Twoim obrazie, więc to druga usługa i reguła proxy, a nie przebudowa: uruchom buzz-pair-relay obok przekaźnika, a potem dodaj z przodu trasę /pair, która przekazuje do niego uaktualnienie WebSocket na porcie 5000. Kieruj tylko /pair, a TLS i timeouty odczytu zostaw na proxy, bo właśnie takie założenie przyjmuje sidecar.
Albo daj mu własną nazwę hosta. Ustaw na przekaźniku BUZZ_PAIRING_RELAY_URL, a zacznie on ogłaszać pairing_relay_url w dokumencie NIP-11, więc klienci całkowicie pominą starą konwencję i połączą się prosto z dedykowanym endpointem. W charcie Helm to pairingRelay.enabled i pairingRelay.url, które uruchamiają sidecar jako osobny Deployment i Service na porcie 5000. Chart celowo nie tworzy dla niego ingressu, więc skierowanie ruchu na tę nazwę hosta nadal należy do Ciebie.
Albo przestań ogłaszać to, czego nie robisz. Jeśli Twój przekaźnik w rzeczywistości nie egzekwuje członkostwa, nie powinien w ogóle ogłaszać NIP-43, a wtedy klient nigdy nie wybierze starej gałęzi. Upstream właśnie z tego powodu trzyma NIP-43 poza statyczną listą obsługiwanych NIP-ów i utrwala tę decyzję testem, którego komentarz mówi wprost, że ogłaszanie go na otwartych przekaźnikach kieruje parujące urządzenia do nieistniejącego sidecara /pair.
My też wydaliśmy tę lukę
Nasi własni zarządzani najemcy uruchamiali obraz przekaźnika, nigdy nie startując sidecara, a binarka przez cały ten czas leżała w kontenerze. Znaleźliśmy to tak, jak znajduje to każdy: skanując kod QR. Trzy rzeczy zmawiają się, żeby to ukryć, i żadna z nich nie jest niczyim niedbalstwem. Sidecar nasłuchuje na pętli zwrotnej, więc nigdy nie zawodzi głośno. Jest w obrazie, więc wygląda na obecny. A klient wybiera starą ścieżkę na podstawie deklaracji, a nie sprawdzenia, więc kod QR renderuje się bez zarzutu aż do chwili próby połączenia. To tryb awarii, który warto sprawdzić, zamiast zakładać, że Cię nie dotyczy: jeśli prowadzisz przekaźnik Buzz egzekwujący członkostwo, wyślij to jedno żądanie z góry tej strony, zanim ktoś zeskanuje kod.