thesimplekid / manage-relay-users

gRPC plugin for nostr-rs-relay to mange admited users via API or nostr event

Manage relay users gRPC Server

gRPC Extensions for nostr-rs-relay

gRPC authz server for nostr-rs-rely. Admits events based on whether they have been allowed by the relay admin.

Build and Run

This package is an extension of nostr-rs-relay and the instructions here assume the relay exists in ./nostr-rs-relay/

1. Make sure you are running the latest version of Rust, if you installed with rustup:

rustup update

2. Clone and compile

git clone https://github.com/thesimplekid/manage-relay-users.git
cd manage-relay-users
cargo build -r

3. Edit the config file.

vim config.toml

Add a secret key. Categorized People Lists from this key will update the allowed and denied users. If the users are updated via http api this extension with publish an update list, this enables the extension to restore from the lists stored on configured relays.

Uncomment the grpc and db_path lines.

4. Edit the config of the relay

cd ../nostr-rs-relay
vim config.toml

Find the line with event_admission_server

[grpc]
# event_admission_server = "http://[::1]:50051" <---- this line

Uncomment this line and change it to reflect your local setup that matches the grpc config you used above. For example:

event_admission_server = "http://127.0.0.1:50001"

5. Run You will need to use screen or tmux or a different terminal tab so that you can run two processes. Start the relay manager first:

cd ../manage-relay-users
./target/release/manage_relay_users --config config.toml

In a different terminal on the same system:

cd ../nostr-rs-relay
RUST_LOG=warn,nostr_rs_relay=info ./target/release/nostr-rs-relay --config config.toml

Managing Users

Via Nostr

Allowed and Denied pubkeys are maintained in two Categorized People Lists. The nsec set in the config file is used by clients to publish list an allow list and a deny with the format set in NIP-51.

HTTP API

The users can be updated by sending a http `POST` to the  `/update` endpoint with a json body with the following format.
This extension with publish an updated Categorized People List with the updated users.

```json
{
    "allow":, [<32-bytes hex of a pubkey>,  <32-bytes hex of a pubkey>, ...],
    "deny": [<32-bytes hex of a pubkey>, <32-bytes hex of a pubkey>, ...],
}

There is also a GET endpoint with at /users that will return json of the same format with allowed and denied users.

If the relay has nip42 enabled it will use the authenticated pubkey if not the author pubkey of the note will be used.

License

Code is under the BSD 3-Clause License

Contact

I can be contacted for comments or questions on nostr at [email protected] (npub1qjgcmlpkeyl8mdkvp4s0xls4ytcux6my606tgfx9xttut907h0zs76lgjw) or via email [email protected].

manage-relay-users's Issues

Should this be 30_000 instead of 300_000?

https://github.com/thesimplekid/manage-relay-users/blob/0cd4b55f78e6f8f22dc382fe3e0700a45ff79d31/src/main.rs#L71C34-L71C37