├── .github └── workflows │ └── build.yml ├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── INSTALL-UBUNTU.md ├── LICENSE ├── README.md ├── config.yaml ├── flake.lock ├── flake.nix ├── nixos-module.nix ├── renovate.json ├── src ├── activitypub.rs ├── actor.rs ├── actor_cache.rs ├── config.rs ├── db.rs ├── digest.rs ├── endpoint.rs ├── error.rs ├── fetch.rs ├── main.rs ├── relay.rs ├── send.rs ├── state.rs └── stream.rs └── static ├── index.html ├── style.css └── urlgen.js /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Rust build 2 | 3 | on: 4 | push: 5 | branches: [ "main" ] 6 | pull_request: 7 | branches: [ "main" ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Dependencies 19 | run: sudo apt-get install -y libsystemd-dev 20 | - uses: actions/checkout@v4 21 | - name: Build 22 | run: cargo build --verbose 23 | - name: Run tests 24 | run: cargo test --verbose 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /result 3 | /private-key.pem 4 | /public-key.pem 5 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "buzzrelay" 3 | version = "0.1.0" 4 | edition = "2021" 5 | repository = "https://github.com/astro/buzzrelay" 6 | homepage = "https://relay.fedi.buzz" 7 | 8 | [dependencies] 9 | axum = "0.8" 10 | tower-http = { version = "0.6", features = ["fs"] } 11 | tokio = { version = "1", features = ["full", "time"] } 12 | tracing = "*" 13 | tracing-subscriber = { version = "0.3", features = ["env-filter"] } 14 | serde = { version = "1", features = ["derive"] } 15 | serde_json = "1" 16 | serde_yaml = "0.9" 17 | reqwest = { version = "0.12", features = ["json", "stream", "hickory-dns", "rustls-tls"] } 18 | sigh = "1.0" 19 | http_digest_headers = { version = "0.1.0", default-features = false, features = ["use_openssl"] } 20 | thiserror = "2" 21 | http = "1" 22 | chrono = "0.4" 23 | eventsource-stream = "0.2" 24 | futures = "0.3" 25 | tokio-postgres = "0.7" 26 | systemd = "0.10" 27 | metrics = "0.24" 28 | metrics-util = "0.19" 29 | metrics-exporter-prometheus = "0.16" 30 | deunicode = "1.4" 31 | urlencoding = "2" 32 | httpdate = "1" 33 | redis = { version = "0.29", features = ["tokio-comp", "connection-manager"] } 34 | lru = "0.14" 35 | 36 | [profile.release] 37 | lto = true 38 | -------------------------------------------------------------------------------- /INSTALL-UBUNTU.md: -------------------------------------------------------------------------------- 1 | # Objective 2 | This guide will provide you with a working relay to test and configure to your liking. 3 | 4 | If you are familiar with NixOS/Flakes, then [installing the NixOS module](https://github.com/astro/buzzrelay?tab=readme-ov-file#build) is by far the easier route! 5 | 6 | If you're not ready to take the NixOS plunge, here's another option to install the FediBuzz relay on server with a recent release of Ubuntu. 7 | 8 | ## Hardware 9 | The official buzzrelay is attached to hundreds of instances and has thousands of followers with a configuration similar to the requirements listed below. 10 | 11 | * 1 Core 12 | * 1 GB RAM 13 | 14 | If you're connecting to the fedi.buzz relay and perhaps one or two others on your own relay, this should be more than enough. 15 | 16 | One caveat here. FediBuzz has an option for individual users to utilize relays as well by "following" a relay actor, like `@tag-dogsofmastodon@relay.com`. 17 | 18 | If you promote this alternative route and many individuals start connecting to your relay, it will cause more outgoing traffic and queue processing, therefore increasing your hardware requirements. 19 | 20 | # Domain Name 21 | You'll need a domain or subdomain to run this application. For example, a subdomain of `https://relay.{yourdomain}`. 22 | 23 | # SSL Certificate 24 | An SSL certificate associated to your relay's domain name is required. This certificate should be added to your reverse proxy. 25 | 26 | Additionally, ensure the TLS configuration is properly set up to facilitate secure connections. 27 | 28 | Please refer to your reverse proxy's documentation for the specific steps required to complete this process. 29 | 30 | # Initial Server Installs 31 | These packages are required for rust / cargo to work. 32 | ``` 33 | sudo apt-get update 34 | sudo apt-get install pkg-config libssl-dev libsystemd-dev git cargo curl 35 | ``` 36 | 37 | ## Rust and related tooling install 38 | Ensure Rust is installed on your server. Ubuntu has a rustc installation included by default, but it is likely not the latest version. In addition, you may prefer to use rustup to manage your install. Check out [the official installation guide](https://www.rust-lang.org/tools/install). 39 | 40 | 41 | ## PostgreSQL 42 | A PostgreSQL database is needed for this application. This [installation guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04) will assist with the initial install. 43 | 44 | Create the relay user for the database. This command creates a user named relay and then prompts for a password. 45 | 46 | ``` 47 | sudo -u postgres createuser -P relay 48 | ``` 49 | 50 | Then create the database and grant all privileges to the relay user. 51 | 52 | ``` 53 | sudo -u postgres psql 54 | createdb -O relay buzzrelay 55 | 56 | \c buzzrelay 57 | 58 | GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO relay; 59 | GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public TO relay; 60 | GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA public TO relay; 61 | 62 | ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT ALL PRIVILEGES ON TABLES TO relay; 63 | ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT ALL PRIVILEGES ON SEQUENCES TO relay; 64 | ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT ALL PRIVILEGES ON FUNCTIONS TO relay; 65 | ``` 66 | 67 | ## Querying the database 68 | A cheat sheet for getting to the database. 69 | 70 | ``` 71 | psql -U relay -h localhost -d buzzrelay 72 | \c buzzrelay 73 | ``` 74 | 75 | # Redis 76 | It's not necessary to install this, it is not used by the core relay. Just comment out the associated lines in the YAML file. 77 | 78 | This was used if you are going to host the page shown at [https://fedi.buzz](https://fedi.buzz) which doesn't come with this relay configuration. 79 | 80 | ## Pull GitHub Repo 81 | ``` 82 | git clone https://github.com/astro/buzzrelay.git 83 | ``` 84 | 85 | # Update config.yaml 86 | 87 | Move into the project folder and open the config.yaml 88 | 89 | ```shell 90 | sudo vim config.yaml 91 | ``` 92 | 93 | ## Streams 94 | * Leave the fedibuzz stream as is. 95 | * Comment out the first example. 96 | * Change the last example to your instance's url and token. 97 | * Add as many others as desired. 98 | 99 | ## Additional filters for streams 100 | If you have a token for an instance that you are using to connect to a mastodon public stream, you're not limited to just the federated stream of all posts. If you want to get more granular, these [streaming timelines](https://docs.joinmastodon.org/methods/streaming/) work, too. 101 | 102 |
View additional filter details 103 | All of the items listed below have a /local/ version as well if you want to get REALLY granular and only pick up posts from the local instance. 104 | 105 | > This does not work for the default fedibuzz relay stream, only for mastodon servers for which you have an access token. 106 | 107 | **Public remote posts only - federated posts excluding local ones** 108 | 109 | You can also pass a "only_media" parameter in the querystring and get back only posts with some type of attachment (audio, image, or video) Cool! 110 | 111 | ```http 112 | GET /api/v1/streaming/public/remote?only_media={true|false}&access_token={yourAccessToken} HTTP/1.1 113 | ``` 114 | 115 | **Public posts with a specific hashtag** 116 | 117 | >This one does not has the only_media parameter unfortunately. 118 | 119 | ```http 120 | GET /api/v1/streaming/hashtag?tag={yourTag}&access_token={yourAccessToken} HTTP/1.1 121 | ``` 122 | 123 | **Watch a list for posts** 124 | For the user with the associated token, you can create a list of accounts and pass the list_id to this query. It will return only posts from those accounts. 125 | 126 | ```http 127 | GET /api/v1/streaming/list?list={yourListId}&access_token={yourAccessToken} HTTP/1.1 128 | ``` 129 |
130 | 131 | ### Hostname 132 | Set it to your domain. I used the sub-domain format of "relay.{yourdomain}" 133 | 134 | ### Listen Port 135 | Update if necessary for your proxy configuration. 136 | 137 | ### Private Key File 138 | Generate a new RSA key pair for signing ActivityPub messages. Note using this command also sets the appropriate permissions values. 139 | 140 | Run these commands from the root of the project. 141 | 142 | ```bash 143 | openssl genrsa -out private-key.pem 4096 144 | openssl rsa -in private-key.pem -pubout -out public-key.pem 145 | ``` 146 | 147 | ## PostgreSQL Password 148 | I used the default user and dbname listed in the config file. Update the password as needed. 149 | 150 | # Build it 151 | From the root of the buzzrelay project, with the config.yaml finalized, run the following. 152 | 153 | ``` 154 | cargo build --release 155 | ``` 156 | 157 | This creates a compiled version in the target/release folder. 158 | 159 | From the root of the project, you can run this command to start up the app: 160 | 161 | ``` 162 | cargo run --release config.yaml 163 | ``` 164 | 165 | If you see redis errors, be sure to comment out those lines in the config.yaml - it is NOT needed. 166 | 167 | With the fedi relay public stream enabled, I did see the following error stream quite often, showing that the uri is missing, which it is. 168 | 169 | ``` 170 | 2024-03-23T03:39:34.773184Z TRACE buzzrelay::relay: data: {"created_at":"2024-03-23T03:39:33.020Z","url":"https://some.instance/notes/9r73vj18yk","content":"

@some.user Some Content​

","account":{"username":"some.user","display_name:":"some.display.name","url":"https://some.instance/@some.user","bot":true},"tags":[],"sensitive":false,"mentions":[],"language":"ja","media_attachments":[],"reblog":null} 171 | 2024-03-23T03:39:48.745870Z ERROR buzzrelay::relay: parse error: missing field `uri` at line 1 column 746 172 | ``` 173 | 174 | However, even with that error, plenty of content is getting pushed to my instance. 175 | 176 | # Try it out 177 | Check the homepage of your new relay for instructions on how to add your desired entries to a fediverse server and start pulling in posts. 178 | 179 | You should see entries being added to your federated timeline. 180 | 181 | You've got a basic working relay to test with. Congratulations! 🎉 -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # buzzrelay 2 | 3 | A follow-only ActivityPub relay that connects to Mastodon's [Streaming 4 | API](https://docs.joinmastodon.org/methods/streaming/#public). 5 | 6 | You don't need to run this yourself, just use the instance at 7 | [relay.fedi.buzz](https://relay.fedi.buzz/). 8 | 9 | ## Setup 10 | 11 | See also: [Notes on an setting up a fediverse relay with FediBuzz on an Ubuntu server.](https://box464.com/posts/fediverse-relays/) 12 | 13 | ### Build 14 | 15 | NixOS/Flakes users are in luck: not only does this build, it also 16 | comes with a NixOS module! 17 | 18 | Anyone else installs a Rust toolchain to build with: 19 | 20 | ```bash 21 | cargo build --release 22 | ``` 23 | 24 | ### Generate signing keypair 25 | 26 | ActivityPub messages are signed using RSA keys. Generate a keypair 27 | first: 28 | 29 | ```bash 30 | openssl genrsa -out private-key.pem 4096 31 | openssl rsa -in private-key.pem -pubout -out public-key.pem 32 | ``` 33 | 34 | Let your `config.yaml` point there. 35 | 36 | ### Database 37 | 38 | Create a PostgreSQL database and user, set them in your `config.yaml`. 39 | 40 | The program will create its schema on start. 41 | 42 | ## Ethics 43 | 44 | *Should everyone connect to the streaming API of the big popular 45 | Mastodon instances?* 46 | 47 | Once these connections become a problem, they may become disallowed, 48 | resulting in problems for everyone. That's why **fedi.buzz** serves 49 | the firehose feed through the streaming API, too. 50 | 51 | You can let this service use **fedi.buzz** as listed in the default 52 | `config.yaml`. 53 | -------------------------------------------------------------------------------- /config.yaml: -------------------------------------------------------------------------------- 1 | # Sources 2 | streams: 3 | # The fedi.buzz firehose stream 4 | - "https://fedi.buzz/api/v1/streaming/public" 5 | # You may list the streaming API of other instances here 6 | - "https://example.org/api/v1/streaming/public" 7 | # Starting with Mastodon v4.2.0 this API requires 8 | # an access_token that must be obtained from 9 | # https://example.com/settings/applications/new 10 | # with permission `read:statuses` 11 | - "https://example.com/api/v1/streaming/public?access_token=EfDOWQkbWFfWsZB-4Xv0axfraMTRzSV0GhB1FVAleBs" 12 | # external https hostname 13 | hostname: relay.fedi.buzz 14 | # where your reverse proxy will connect to 15 | listen_port: 3000 16 | # ActivityPub signing keypair 17 | priv_key_file: private-key.pem 18 | pub_key_file: public-key.pem 19 | # PostgreSQL 20 | db: "host=localhost user=relay password=xyz dbname=buzzrelay" 21 | # Optional Redis 22 | redis: 23 | connection: "redis://127.0.0.1:6378/" 24 | password_file: "redis_password.txt" 25 | in_topic: "relay-in" 26 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "nixpkgs": { 4 | "locked": { 5 | "lastModified": 1744536153, 6 | "narHash": "sha256-awS2zRgF4uTwrOKwwiJcByDzDOdo3Q1rPZbiHQg/N38=", 7 | "owner": "NixOS", 8 | "repo": "nixpkgs", 9 | "rev": "18dd725c29603f582cf1900e0d25f9f1063dbf11", 10 | "type": "github" 11 | }, 12 | "original": { 13 | "owner": "NixOS", 14 | "ref": "nixpkgs-unstable", 15 | "repo": "nixpkgs", 16 | "type": "github" 17 | } 18 | }, 19 | "root": { 20 | "inputs": { 21 | "nixpkgs": "nixpkgs", 22 | "utils": "utils" 23 | } 24 | }, 25 | "systems": { 26 | "locked": { 27 | "lastModified": 1681028828, 28 | "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", 29 | "owner": "nix-systems", 30 | "repo": "default", 31 | "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", 32 | "type": "github" 33 | }, 34 | "original": { 35 | "owner": "nix-systems", 36 | "repo": "default", 37 | "type": "github" 38 | } 39 | }, 40 | "utils": { 41 | "inputs": { 42 | "systems": "systems" 43 | }, 44 | "locked": { 45 | "lastModified": 1731533236, 46 | "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", 47 | "owner": "numtide", 48 | "repo": "flake-utils", 49 | "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", 50 | "type": "github" 51 | }, 52 | "original": { 53 | "owner": "numtide", 54 | "repo": "flake-utils", 55 | "type": "github" 56 | } 57 | } 58 | }, 59 | "root": "root", 60 | "version": 7 61 | } 62 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | inputs = { 3 | nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; 4 | utils.url = "github:numtide/flake-utils"; 5 | }; 6 | 7 | outputs = { self, nixpkgs, utils }: 8 | let 9 | makeBuzzrelay = pkgs: 10 | pkgs.rustPlatform.buildRustPackage rec { 11 | pname = "buzzrelay"; 12 | version = ( 13 | pkgs.lib.importTOML ./Cargo.toml 14 | ).package.version + "-${toString (self.sourceInfo.revCount or 0)}-${self.sourceInfo.shortRev or "dirty"}"; 15 | src = pkgs.runCommand "${pname}-${version}-src" { 16 | preferLocalBuild = true; 17 | } '' 18 | mkdir $out 19 | cd ${self} 20 | cp -ar Cargo.{toml,lock} static src $out/ 21 | ''; 22 | cargoLock.lockFile = ./Cargo.lock; 23 | nativeBuildInputs = with pkgs; [ pkg-config rustPackages.clippy ]; 24 | buildInputs = with pkgs; [ openssl systemd ]; 25 | postInstall = '' 26 | mkdir -p $out/share/buzzrelay 27 | cp -r static $out/share/buzzrelay/ 28 | ''; 29 | postCheck = '' 30 | cargo clippy --all --all-features --tests -- \ 31 | -D warnings 32 | ''; 33 | meta = { 34 | description = "The buzzing ActivityPub relay"; 35 | mainProgram = "buzzrelay"; 36 | }; 37 | }; 38 | in 39 | utils.lib.eachDefaultSystem 40 | (system: 41 | let 42 | pkgs = nixpkgs.legacyPackages.${system}; 43 | in 44 | { 45 | packages = { 46 | default = self.packages."${system}".buzzrelay; 47 | buzzrelay = makeBuzzrelay pkgs; 48 | }; 49 | 50 | apps.default = utils.lib.mkApp { 51 | drv = self.packages."${system}".default; 52 | }; 53 | 54 | devShells.default = with pkgs; mkShell { 55 | nativeBuildInputs = [ 56 | pkg-config 57 | openssl systemd 58 | cargo rustc rustfmt rustPackages.clippy rust-analyzer cargo-outdated 59 | ]; 60 | RUST_SRC_PATH = rustPlatform.rustLibSrc; 61 | }; 62 | }) 63 | // { 64 | overlays.default = (_: prev: { 65 | buzzrelay = makeBuzzrelay prev; 66 | }); 67 | 68 | nixosModules.default = import ./nixos-module.nix { inherit self; }; 69 | }; 70 | } 71 | -------------------------------------------------------------------------------- /nixos-module.nix: -------------------------------------------------------------------------------- 1 | { self }: 2 | { config, lib, pkgs, ... }: { 3 | options.services.buzzrelay = with lib; { 4 | enable = mkEnableOption "Enable Fedi.buzz relay"; 5 | package = mkOption { 6 | type = types.package; 7 | default = self.packages.${pkgs.stdenv.system}.buzzrelay; 8 | }; 9 | streams = mkOption { 10 | type = with types; listOf str; 11 | default = [ 12 | "https://fedi.buzz/api/v1/streaming/public" 13 | ]; 14 | }; 15 | listenPort = mkOption { 16 | type = types.int; 17 | default = 8000; 18 | }; 19 | hostName = mkOption { 20 | type = types.str; 21 | }; 22 | privKeyFile = mkOption { 23 | type = types.str; 24 | }; 25 | pubKeyFile = mkOption { 26 | type = types.str; 27 | }; 28 | database = mkOption { 29 | type = types.str; 30 | default = "buzzrelay"; 31 | }; 32 | user = mkOption { 33 | type = types.str; 34 | default = "buzzrelay"; 35 | }; 36 | group = mkOption { 37 | type = types.str; 38 | default = "buzzrelay"; 39 | }; 40 | logLevel = mkOption { 41 | type = types.enum [ "ERROR" "WARN" "INFO" "DEBUG" "TRACE" ]; 42 | default = "INFO"; 43 | }; 44 | 45 | redis = { 46 | connection = mkOption { 47 | type = with types; nullOr str; 48 | default = null; 49 | }; 50 | passwordFile = mkOption { 51 | type = with types; nullOr path; 52 | default = null; 53 | }; 54 | inTopic = mkOption { 55 | type = types.str; 56 | default = "relay-in"; 57 | }; 58 | }; 59 | }; 60 | 61 | config = 62 | let 63 | cfg = config.services.buzzrelay; 64 | configFile = builtins.toFile "buzzrelay.yaml" ( 65 | lib.generators.toYAML {} { 66 | streams = cfg.streams; 67 | hostname = cfg.hostName; 68 | listen_port = cfg.listenPort; 69 | priv_key_file = cfg.privKeyFile; 70 | pub_key_file = cfg.pubKeyFile; 71 | db = "host=/var/run/postgresql user=${cfg.user} dbname=${cfg.database}"; 72 | redis = if cfg.redis.connection != null 73 | then { 74 | connection = cfg.redis.connection; 75 | password_file = cfg.redis.passwordFile; 76 | in_topic = cfg.redis.inTopic; 77 | } 78 | else null; 79 | }); 80 | buzzrelay = cfg.package; 81 | in 82 | lib.mkIf cfg.enable { 83 | users.users.${cfg.user} = { 84 | inherit (cfg) group; 85 | isSystemUser = true; 86 | }; 87 | users.groups.${cfg.group} = {}; 88 | 89 | services.postgresql = { 90 | enable = true; 91 | ensureDatabases = [ cfg.database ]; 92 | ensureUsers = [ { 93 | name = cfg.user; 94 | ensureDBOwnership = true; 95 | } ]; 96 | }; 97 | 98 | systemd.services.buzzrelay = { 99 | wantedBy = [ "multi-user.target" ]; 100 | after = [ "postgresql.service" "network-online.target" ]; 101 | wants = [ "network-online.target" ]; 102 | environment.RUST_LOG = "buzzrelay=${cfg.logLevel}"; 103 | serviceConfig = { 104 | Type = "notify"; 105 | WorkingDirectory = "${buzzrelay}/share/buzzrelay"; 106 | ExecStart = "${lib.getExe buzzrelay} ${lib.escapeShellArg configFile}"; 107 | User = cfg.user; 108 | Group = cfg.group; 109 | ProtectSystem = "full"; 110 | Restart = "always"; 111 | RestartSec = "1s"; 112 | WatchdogSec = "1800s"; 113 | LimitNOFile = 40000; 114 | }; 115 | }; 116 | }; 117 | } 118 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /src/activitypub.rs: -------------------------------------------------------------------------------- 1 | use axum::{response::IntoResponse, Json}; 2 | use serde::{Deserialize, Serialize}; 3 | 4 | #[derive(Debug, Clone, Serialize, Deserialize)] 5 | pub struct Actor { 6 | #[serde(rename = "@context")] 7 | pub jsonld_context: serde_json::Value, 8 | #[serde(rename = "type")] 9 | pub actor_type: String, 10 | pub id: String, 11 | pub name: Option, 12 | pub icon: Option, 13 | pub inbox: String, 14 | pub outbox: Option, 15 | pub endpoints: Option, 16 | #[serde(rename = "publicKey")] 17 | pub public_key: ActorPublicKey, 18 | #[serde(rename = "preferredUsername")] 19 | pub preferred_username: Option, 20 | } 21 | 22 | #[derive(Debug, Clone, Serialize, Deserialize)] 23 | pub struct ActorEndpoints { 24 | #[serde(rename = "sharedInbox")] 25 | pub shared_inbox: String, 26 | } 27 | 28 | #[derive(Debug, Clone, Serialize, Deserialize)] 29 | pub struct ActorPublicKey { 30 | pub id: String, 31 | pub owner: Option, 32 | #[serde(rename = "publicKeyPem")] 33 | pub pem: String, 34 | } 35 | 36 | /// `ActivityPub` "activity" 37 | #[derive(Debug, Clone, Serialize, Deserialize)] 38 | pub struct Action { 39 | #[serde(rename = "@context")] 40 | pub jsonld_context: serde_json::Value, 41 | #[serde(rename = "type")] 42 | pub action_type: String, 43 | pub id: String, 44 | pub actor: String, 45 | pub to: Option, 46 | pub object: Option, 47 | } 48 | 49 | impl IntoResponse for Actor { 50 | fn into_response(self) -> axum::response::Response { 51 | ([("content-type", "application/activity+json")], 52 | Json(self)).into_response() 53 | } 54 | } 55 | 56 | #[derive(Debug, Clone, Serialize, Deserialize)] 57 | pub struct Media { 58 | #[serde(rename = "type")] 59 | pub media_type: Option, 60 | #[serde(rename = "mediaType")] 61 | pub content_type: Option, 62 | pub url: String, 63 | } 64 | -------------------------------------------------------------------------------- /src/actor.rs: -------------------------------------------------------------------------------- 1 | use std::sync::Arc; 2 | use deunicode::deunicode; 3 | use serde_json::json; 4 | use sigh::{PublicKey, Key}; 5 | 6 | use crate::activitypub; 7 | 8 | #[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)] 9 | #[allow(clippy::enum_variant_names)] 10 | pub enum ActorKind { 11 | TagRelay(String), 12 | InstanceRelay(String), 13 | LanguageRelay(String), 14 | } 15 | 16 | impl ActorKind { 17 | pub fn from_tag(tag: &str) -> Self { 18 | let tag = deunicode(tag) 19 | .to_lowercase() 20 | .replace(char::is_whitespace, "") 21 | .replace('-', ""); 22 | ActorKind::TagRelay(tag) 23 | } 24 | 25 | pub fn from_language(language: &str) -> Option { 26 | let language = language.to_lowercase() 27 | .chars() 28 | .take_while(|c| c.is_alphabetic()) 29 | .collect::(); 30 | if language.is_empty() { 31 | None 32 | } else { 33 | Some(ActorKind::LanguageRelay(language)) 34 | } 35 | } 36 | } 37 | 38 | #[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)] 39 | pub struct Actor { 40 | pub host: Arc, 41 | pub kind: ActorKind, 42 | } 43 | 44 | impl Actor { 45 | pub fn from_uri(mut uri: &str) -> Option { 46 | let kind; 47 | let host; 48 | if uri.starts_with("acct:tag-") { 49 | let off = "acct:tag-".len(); 50 | let at = uri.find('@')?; 51 | kind = ActorKind::from_tag(&uri[off..at]); 52 | host = Arc::new(uri[at + 1..].to_string()); 53 | } else if uri.starts_with("acct:instance-") { 54 | let off = "acct:instance-".len(); 55 | let at = uri.find('@')?; 56 | kind = ActorKind::InstanceRelay(uri[off..at].to_lowercase()); 57 | host = Arc::new(uri[at + 1..].to_string()); 58 | } else if uri.starts_with("acct:language-") { 59 | let off = "acct:language-".len(); 60 | let at = uri.find('@')?; 61 | kind = ActorKind::from_language(&uri[off..at])?; 62 | host = Arc::new(uri[at + 1..].to_string()); 63 | } else if uri.starts_with("https://") { 64 | uri = &uri[8..]; 65 | 66 | let parts = uri.split('/').collect::>(); 67 | if parts.len() != 3 { 68 | return None; 69 | } 70 | 71 | let Ok(topic) = urlencoding::decode(parts[2]) else { return None; }; 72 | kind = match parts[1] { 73 | "tag" => 74 | ActorKind::TagRelay(topic.to_string()), 75 | "instance" => 76 | ActorKind::InstanceRelay(topic.to_string()), 77 | "language" => 78 | ActorKind::LanguageRelay(topic.to_string()), 79 | _ => 80 | return None, 81 | }; 82 | host = Arc::new(parts[0].to_string()); 83 | } else { 84 | return None; 85 | } 86 | Some(Actor { host, kind }) 87 | } 88 | 89 | pub fn from_object(object: &serde_json::Value) -> Option { 90 | let mut target: Option = None; 91 | if let Some(object) = object.as_str() { 92 | target = Some(object.to_string()); 93 | } 94 | if let Some(object_0) = object.as_array() 95 | .and_then(|object| { 96 | if object.len() == 1 { 97 | object.first() 98 | } else { 99 | None 100 | } 101 | }).and_then(|object_0| object_0.as_str()) 102 | { 103 | target = Some(object_0.to_string()); 104 | } 105 | 106 | target.and_then(|target| Self::from_uri(&target)) 107 | } 108 | 109 | pub fn uri(&self) -> String { 110 | match &self.kind { 111 | ActorKind::TagRelay(tag) => 112 | format!("https://{}/tag/{}", self.host, tag), 113 | ActorKind::InstanceRelay(instance) => 114 | format!("https://{}/instance/{}", self.host, instance), 115 | ActorKind::LanguageRelay(language) => 116 | format!("https://{}/language/{}", self.host, language), 117 | } 118 | } 119 | 120 | pub fn key_id(&self) -> String { 121 | format!("{}#key", self.uri()) 122 | } 123 | 124 | pub fn as_activitypub(&self, pub_key: &PublicKey) -> activitypub::Actor { 125 | activitypub::Actor { 126 | jsonld_context: json!([ 127 | "https://www.w3.org/ns/activitystreams", 128 | "https://w3id.org/security/v1" 129 | ]), 130 | actor_type: "Service".to_string(), 131 | id: self.uri(), 132 | name: Some(match &self.kind { 133 | ActorKind::TagRelay(tag) => 134 | format!("#{tag}"), 135 | ActorKind::InstanceRelay(instance) => 136 | instance.to_string(), 137 | ActorKind::LanguageRelay(language) => 138 | format!("in {language}"), 139 | }), 140 | icon: Some(activitypub::Media { 141 | media_type: Some("Image".to_string()), 142 | content_type: Some("image/jpeg".to_string()), 143 | url: "https://fedi.buzz/assets/favicon48.png".to_string(), 144 | }), 145 | inbox: self.uri(), 146 | endpoints: Some(activitypub::ActorEndpoints { 147 | shared_inbox: format!("https://{}/instance/{}", self.host, self.host), 148 | }), 149 | outbox: Some(format!("{}/outbox", self.uri())), 150 | public_key: activitypub::ActorPublicKey { 151 | id: self.key_id(), 152 | owner: Some(self.uri()), 153 | pem: pub_key.to_pem().unwrap(), 154 | }, 155 | preferred_username: Some(match &self.kind { 156 | ActorKind::TagRelay(tag) => 157 | format!("tag-{tag}"), 158 | ActorKind::InstanceRelay(instance) => 159 | format!("instance-{instance}"), 160 | ActorKind::LanguageRelay(language) => 161 | format!("language-{language}"), 162 | }), 163 | } 164 | } 165 | } 166 | -------------------------------------------------------------------------------- /src/actor_cache.rs: -------------------------------------------------------------------------------- 1 | use std::{ 2 | collections::HashMap, 3 | sync::Arc, 4 | time::Instant, 5 | }; 6 | 7 | use futures::Future; 8 | use lru::LruCache; 9 | use tokio::sync::{Mutex, oneshot}; 10 | 11 | use crate::activitypub::Actor; 12 | use crate::error::Error; 13 | 14 | 15 | #[allow(clippy::type_complexity)] 16 | #[derive(Clone)] 17 | pub struct ActorCache { 18 | cache: Arc, Error>>>>, 19 | queues: Arc, Error>>>>>>, 20 | } 21 | 22 | impl Default for ActorCache { 23 | fn default() -> Self { 24 | ActorCache { 25 | cache: Arc::new(Mutex::new( 26 | LruCache::new(std::num::NonZeroUsize::new(64).unwrap()) 27 | )), 28 | queues: Arc::new(Mutex::new(HashMap::new())), 29 | } 30 | } 31 | } 32 | 33 | impl ActorCache { 34 | pub async fn get(&self, k: &str, f: F) -> Result, Error> 35 | where 36 | F: (FnOnce() -> R) + Send + 'static, 37 | R: Future> + Send, 38 | { 39 | let begin = Instant::now(); 40 | 41 | let mut lru = self.cache.lock().await; 42 | if let Some(v) = lru.get(k) { 43 | return v.clone(); 44 | } 45 | drop(lru); 46 | 47 | let (tx, rx) = oneshot::channel(); 48 | let mut new = false; 49 | let mut queues = self.queues.lock().await; 50 | let queue = queues.entry(k.to_string()) 51 | .or_insert_with(|| { 52 | new = true; 53 | Vec::with_capacity(1) 54 | }); 55 | queue.push(tx); 56 | drop(queues); 57 | 58 | if new { 59 | let k = k.to_string(); 60 | let cache = self.cache.clone(); 61 | let queues = self.queues.clone(); 62 | tokio::spawn(async move { 63 | let result = f().await 64 | .map(Arc::new); 65 | 66 | let mut lru = cache.lock().await; 67 | lru.put(k.clone(), result.clone()); 68 | drop(lru); 69 | 70 | let mut queues = queues.lock().await; 71 | let queue = queues.remove(&k) 72 | .expect("queues.remove"); 73 | let queue_len = queue.len(); 74 | let mut notified = 0usize; 75 | for tx in queue { 76 | if let Ok(()) = tx.send(result.clone()) { 77 | notified += 1; 78 | } 79 | } 80 | 81 | let end = Instant::now(); 82 | tracing::info!("Notified {notified}/{queue_len} endpoint verifications for actor {k} in {:?}", end - begin); 83 | }); 84 | } 85 | 86 | rx.await.unwrap() 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /src/config.rs: -------------------------------------------------------------------------------- 1 | use serde::Deserialize; 2 | use sigh::{PrivateKey, PublicKey, Key}; 3 | 4 | #[derive(Clone, Deserialize)] 5 | pub struct RedisConfig { 6 | pub connection: String, 7 | pub password_file: String, 8 | pub in_topic: String, 9 | } 10 | 11 | #[derive(Clone, Deserialize)] 12 | pub struct Config { 13 | pub streams: Vec, 14 | pub db: String, 15 | pub hostname: String, 16 | pub listen_port: u16, 17 | pub redis: Option, 18 | priv_key_file: String, 19 | pub_key_file: String, 20 | } 21 | 22 | impl Config { 23 | pub fn load(config_file: &str) -> Config { 24 | let data = std::fs::read_to_string(config_file) 25 | .expect("read config"); 26 | serde_yaml::from_str(&data) 27 | .expect("parse config") 28 | } 29 | 30 | pub fn priv_key(&self) -> PrivateKey { 31 | let data = std::fs::read_to_string(&self.priv_key_file) 32 | .expect("read priv_key_file"); 33 | PrivateKey::from_pem(data.as_bytes()) 34 | .expect("priv_key") 35 | } 36 | 37 | pub fn pub_key(&self) -> PublicKey { 38 | let data = std::fs::read_to_string(&self.pub_key_file) 39 | .expect("read pub_key_file"); 40 | PublicKey::from_pem(data.as_bytes()) 41 | .expect("pub_key") 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/db.rs: -------------------------------------------------------------------------------- 1 | use std::{sync::Arc, time::Instant}; 2 | use metrics::histogram; 3 | use tokio_postgres::{Client, Error, NoTls, Statement}; 4 | 5 | 6 | const CREATE_SCHEMA_COMMANDS: &[&str] = &[ 7 | "CREATE TABLE IF NOT EXISTS follows (id TEXT NOT NULL, inbox TEXT NOT NULL, actor TEXT NOT NULL, UNIQUE (inbox, actor))", 8 | "CREATE INDEX IF NOT EXISTS follows_actor ON follows (actor) INCLUDE (inbox)", 9 | ]; 10 | 11 | #[derive(Clone)] 12 | pub struct Database { 13 | inner: Arc, 14 | } 15 | 16 | struct DatabaseInner { 17 | client: Client, 18 | add_follow: Statement, 19 | del_follow: Statement, 20 | get_following_inboxes: Statement, 21 | get_follows_count: Statement, 22 | get_followers_count: Statement, 23 | } 24 | 25 | impl Database { 26 | pub async fn connect(conn_str: &str) -> Self { 27 | let (client, connection) = tokio_postgres::connect(conn_str, NoTls) 28 | .await 29 | .unwrap(); 30 | 31 | tokio::spawn(async move { 32 | if let Err(e) = connection.await { 33 | tracing::error!("postgresql: {}", e); 34 | } 35 | }); 36 | 37 | for command in CREATE_SCHEMA_COMMANDS { 38 | client.execute(*command, &[]) 39 | .await 40 | .unwrap(); 41 | } 42 | let add_follow = client.prepare("INSERT INTO follows (id, inbox, actor) VALUES ($1, $2, $3)") 43 | .await 44 | .unwrap(); 45 | let del_follow = client.prepare("DELETE FROM follows WHERE id=$1 AND actor=$2") 46 | .await 47 | .unwrap(); 48 | let get_following_inboxes = client.prepare("SELECT DISTINCT inbox FROM follows WHERE actor=$1") 49 | .await 50 | .unwrap(); 51 | let get_follows_count = client.prepare("SELECT COUNT(id) FROM follows") 52 | .await 53 | .unwrap(); 54 | let get_followers_count = client.prepare("SELECT COUNT(DISTINCT id) FROM follows") 55 | .await 56 | .unwrap(); 57 | 58 | Database { 59 | inner: Arc::new(DatabaseInner { 60 | client, 61 | add_follow, 62 | del_follow, 63 | get_following_inboxes, 64 | get_follows_count, 65 | get_followers_count, 66 | }), 67 | } 68 | } 69 | 70 | pub async fn add_follow(&self, id: &str, inbox: &str, actor: &str) -> Result<(), Error> { 71 | let t1 = Instant::now(); 72 | self.inner.client.execute(&self.inner.add_follow, &[&id, &inbox, &actor]) 73 | .await?; 74 | let t2 = Instant::now(); 75 | histogram!("postgres_query_duration", "query" => "add_follow") 76 | .record(t2 - t1); 77 | Ok(()) 78 | } 79 | 80 | pub async fn del_follow(&self, id: &str, actor: &str) -> Result<(), Error> { 81 | let t1 = Instant::now(); 82 | self.inner.client.execute(&self.inner.del_follow, &[&id, &actor]) 83 | .await?; 84 | let t2 = Instant::now(); 85 | histogram!("postgres_query_duration", "query" => "del_follow") 86 | .record(t2 - t1); 87 | Ok(()) 88 | } 89 | 90 | pub async fn get_following_inboxes(&self, actor: &str) -> Result, Error> { 91 | let t1 = Instant::now(); 92 | let rows = self.inner.client.query(&self.inner.get_following_inboxes, &[&actor]) 93 | .await?; 94 | let t2 = Instant::now(); 95 | histogram!("postgres_query_duration", "query" => "get_following_inboxes") 96 | .record(t2 - t1); 97 | Ok(rows.into_iter() 98 | .map(|row| row.get(0)) 99 | ) 100 | } 101 | 102 | pub async fn get_follows_count(&self) -> Result { 103 | let row = self.inner.client.query_one(&self.inner.get_follows_count, &[]) 104 | .await?; 105 | Ok(row.get(0)) 106 | } 107 | 108 | pub async fn get_followers_count(&self) -> Result { 109 | let row = self.inner.client.query_one(&self.inner.get_followers_count, &[]) 110 | .await?; 111 | Ok(row.get(0)) 112 | } 113 | } 114 | -------------------------------------------------------------------------------- /src/digest.rs: -------------------------------------------------------------------------------- 1 | use http_digest_headers::{DigestHeader, DigestMethod}; 2 | 3 | pub fn generate_header(body: &[u8]) -> Result { 4 | let mut digest_header = DigestHeader::new() 5 | .with_method(DigestMethod::SHA256, body) 6 | .map(|h| format!("{h}")) 7 | .map_err(|_| ())?; 8 | 9 | // mastodon expects uppercase algo name 10 | if digest_header.starts_with("sha-") { 11 | digest_header.replace_range(..4, "SHA-"); 12 | } 13 | // mastodon uses base64::alphabet::STANDARD, not base64::alphabet::URL_SAFE 14 | digest_header.replace_range( 15 | 7.., 16 | &digest_header[7..].replace('-', "+").replace('_', "/") 17 | ); 18 | 19 | Ok(digest_header) 20 | } 21 | -------------------------------------------------------------------------------- /src/endpoint.rs: -------------------------------------------------------------------------------- 1 | use std::sync::Arc; 2 | 3 | use axum::{ 4 | body::{Bytes, Body}, 5 | extract::{FromRef, FromRequest}, 6 | http::{header::CONTENT_TYPE, Request, StatusCode}, 7 | }; 8 | use http_digest_headers::DigestHeader; 9 | use sigh::{Signature, PublicKey, Key, PrivateKey}; 10 | 11 | use crate::fetch::authorized_fetch; 12 | use crate::activitypub::Actor; 13 | use crate::error::Error; 14 | use crate::actor_cache::ActorCache; 15 | 16 | 17 | const SIGNATURE_HEADERS_REQUIRED: &[&str] = &[ 18 | "(request-target)", 19 | "host", "date", 20 | "digest", 21 | ]; 22 | 23 | pub struct Endpoint<'a> { 24 | pub payload: serde_json::Value, 25 | signature: Signature<'a>, 26 | pub remote_actor_uri: String, 27 | } 28 | 29 | impl FromRequest for Endpoint<'_> 30 | where 31 | S: Send + Sync, 32 | Arc: FromRef, 33 | { 34 | type Rejection = (StatusCode, String); 35 | 36 | async fn from_request(req: Request, state: &S) -> Result { 37 | // validate content-type 38 | let Some(content_type) = req.headers() 39 | .get(CONTENT_TYPE) 40 | .and_then(|value| value.to_str().ok()) 41 | .and_then(|value| value.split(';').next()) else { 42 | return Err((StatusCode::UNSUPPORTED_MEDIA_TYPE, "No content-type".to_string())); 43 | }; 44 | if ! (content_type.starts_with("application/json") || 45 | (content_type.starts_with("application/") && content_type.ends_with("+json"))) 46 | { 47 | return Err((StatusCode::UNSUPPORTED_MEDIA_TYPE, "Invalid content-type".to_string())); 48 | } 49 | // get signature before consuming req 50 | let signature = Signature::from(&req); 51 | // check signature fields 52 | let signature_headers = signature.headers() 53 | .ok_or((StatusCode::BAD_REQUEST, "No signed headers".to_string()))?; 54 | for header in SIGNATURE_HEADERS_REQUIRED { 55 | if !signature_headers.iter().any(|h| h == header) { 56 | return Err((StatusCode::BAD_REQUEST, format!("Header {header:?} not signed"))); 57 | } 58 | } 59 | 60 | // parse digest 61 | let mut digest_header: String = req.headers().get("digest") 62 | .ok_or((StatusCode::BAD_REQUEST, "Missing Digest: header".to_string()))? 63 | .to_str() 64 | .map_err(|_| (StatusCode::BAD_REQUEST, "Digest: header contained invalid characters".to_string()))? 65 | .to_string(); 66 | // fixup digest header 67 | if digest_header.starts_with("SHA-") { 68 | digest_header.replace_range(..4, "sha-"); 69 | } 70 | // mastodon uses base64::alphabet::STANDARD, not base64::alphabet::URL_SAFE 71 | digest_header = digest_header.replace('+', "-") 72 | .replace('/', "_"); 73 | let digest: DigestHeader = digest_header.parse() 74 | .map_err(|e| (StatusCode::BAD_REQUEST, format!("Cannot parse Digest: header: {e}")))?; 75 | // read body 76 | let bytes = Bytes::from_request(req, state).await 77 | .map_err(|e| (StatusCode::BAD_REQUEST, format!("Body: {e}")))?; 78 | // validate digest 79 | if ! digest.verify(&bytes).unwrap_or(false) { 80 | return Err((StatusCode::BAD_REQUEST, "Digest didn't match".to_string())); 81 | } 82 | // parse body 83 | let payload: serde_json::Value = serde_json::from_slice(&bytes) 84 | .map_err(|_| (StatusCode::BAD_REQUEST, "Error parsing JSON".to_string()))?; 85 | let remote_actor_uri = if let Some(serde_json::Value::String(actor_uri)) = payload.get("actor") { 86 | actor_uri.to_string() 87 | } else { 88 | return Err((StatusCode::BAD_REQUEST, "Actor missing".to_string())); 89 | }; 90 | 91 | Ok(Endpoint { payload, signature, remote_actor_uri }) 92 | } 93 | } 94 | 95 | impl Endpoint<'_> { 96 | /// Validates the requesting actor 97 | pub async fn remote_actor( 98 | &self, 99 | client: &reqwest::Client, 100 | cache: &ActorCache, 101 | key_id: String, 102 | private_key: Arc, 103 | ) -> Result, Error> { 104 | let client = client.clone(); 105 | let url = self.remote_actor_uri.clone(); 106 | let remote_actor = cache.get(&self.remote_actor_uri, || async move { 107 | tracing::info!("GET actor {}", url); 108 | let actor: Actor = serde_json::from_value( 109 | authorized_fetch(&client, &url, &key_id, &private_key).await? 110 | )?; 111 | Ok(actor) 112 | }).await?; 113 | 114 | let public_key = PublicKey::from_pem(remote_actor.public_key.pem.as_bytes())?; 115 | if ! (self.signature.verify(&public_key)?) { 116 | tracing::error!("Cannot verify signature for {}: {:?}", self.remote_actor_uri, self.payload); 117 | return Err(Error::SignatureFail(self.remote_actor_uri.clone())); 118 | } 119 | 120 | Ok(remote_actor) 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /src/error.rs: -------------------------------------------------------------------------------- 1 | use std::sync::Arc; 2 | 3 | #[derive(Clone, Debug, thiserror::Error)] 4 | pub enum Error { 5 | #[error("HTTP Digest generation error")] 6 | Digest, 7 | #[error("JSON encoding error")] 8 | Json(#[from] Arc), 9 | #[error("Signature error")] 10 | Signature(#[from] Arc), 11 | #[error("Signature verification failure")] 12 | SignatureFail(String), 13 | #[error("HTTP request error")] 14 | HttpReq(#[from] Arc), 15 | #[error("HTTP client error")] 16 | Http(#[from] Arc), 17 | #[error("Invalid URI")] 18 | InvalidUri, 19 | #[error("Error response from remote")] 20 | Response(String), 21 | } 22 | 23 | impl From for Error { 24 | fn from(e: serde_json::Error) -> Self { 25 | Error::Json(Arc::new(e)) 26 | } 27 | } 28 | 29 | impl From for Error { 30 | fn from(e: reqwest::Error) -> Self { 31 | Error::Http(Arc::new(e)) 32 | } 33 | } 34 | 35 | impl From for Error { 36 | fn from(e: sigh::Error) -> Self { 37 | Error::Signature(Arc::new(e)) 38 | } 39 | } 40 | 41 | impl From for Error { 42 | fn from(e: http::Error) -> Self { 43 | Error::HttpReq(Arc::new(e)) 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /src/fetch.rs: -------------------------------------------------------------------------------- 1 | use std::time::SystemTime; 2 | use http::StatusCode; 3 | use serde::de::DeserializeOwned; 4 | use sigh::{PrivateKey, SigningConfig, alg::RsaSha256}; 5 | use tokio::task::spawn_blocking; 6 | use crate::{digest, error::Error}; 7 | 8 | pub async fn authorized_fetch( 9 | client: &reqwest::Client, 10 | uri: &str, 11 | key_id: &str, 12 | private_key: &PrivateKey, 13 | ) -> Result 14 | where 15 | T: DeserializeOwned, 16 | { 17 | let url = reqwest::Url::parse(uri) 18 | .map_err(|_| Error::InvalidUri)?; 19 | let host = format!("{}", url.host().ok_or(Error::InvalidUri)?); 20 | let digest_header = digest::generate_header(&[]) 21 | .expect("digest::generate_header"); 22 | let mut req = http::Request::builder() 23 | .uri(uri) 24 | .header("host", &host) 25 | .header("content-type", "application/activity+json") 26 | .header("date", httpdate::fmt_http_date(SystemTime::now())) 27 | .header("accept", "application/activity+json") 28 | .header("digest", digest_header) 29 | .body(vec![])?; 30 | let private_key = private_key.clone(); 31 | let key_id = key_id.to_string(); 32 | let req = spawn_blocking(move || { 33 | SigningConfig::new(RsaSha256, &private_key, &key_id).sign(&mut req)?; 34 | Ok(req) 35 | }) 36 | .await 37 | .map_err(|e| Error::Response(format!("{e}")))? 38 | .map_err(|e: sigh::Error| Error::Response(format!("{e}")))?; 39 | let req: reqwest::Request = req.try_into()?; 40 | let res = client.execute(req).await?; 41 | if res.status() >= StatusCode::OK && res.status() < StatusCode::MULTIPLE_CHOICES { 42 | Ok(res.json().await?) 43 | } else { 44 | Err(Error::Response(res.text().await?)) 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | use axum::{ 2 | extract::{Path, Query}, 3 | http::StatusCode, 4 | response::{IntoResponse, Response}, 5 | routing::get, Json, Router, 6 | }; 7 | use tower_http::services::ServeDir; 8 | use metrics::counter; 9 | use metrics_util::MetricKindMask; 10 | use metrics_exporter_prometheus::PrometheusBuilder; 11 | use serde_json::json; 12 | use std::{net::SocketAddr, time::Duration, collections::HashMap}; 13 | use std::{panic, process}; 14 | use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt}; 15 | use reqwest::Url; 16 | 17 | mod error; 18 | mod config; 19 | mod state; 20 | mod actor; 21 | mod db; 22 | mod digest; 23 | mod fetch; 24 | mod send; 25 | mod stream; 26 | mod relay; 27 | mod activitypub; 28 | mod actor_cache; 29 | mod endpoint; 30 | 31 | use actor::Actor; 32 | use state::State; 33 | 34 | 35 | fn track_request(method: &'static str, controller: &'static str, result: &'static str) { 36 | counter!("api_http_requests_total", "controller" => controller, "method" => method, "result" => result) 37 | .increment(1); 38 | } 39 | 40 | async fn webfinger( 41 | Query(params): Query>, 42 | ) -> Response { 43 | let Some(resource) = params.get("resource") else { 44 | track_request("GET", "webfinger", "invalid"); 45 | return StatusCode::NOT_FOUND.into_response(); 46 | }; 47 | let Some(target) = Actor::from_uri(resource) else { 48 | track_request("GET", "webfinger", "not_found"); 49 | return StatusCode::NOT_FOUND.into_response(); 50 | }; 51 | track_request("GET", "webfinger", "found"); 52 | Json(json!({ 53 | "subject": &resource, 54 | "aliases": &[ 55 | target.uri(), 56 | ], 57 | "links": &[json!({ 58 | "rel": "self", 59 | "type": "application/activity+json", 60 | "href": target.uri(), 61 | })], 62 | })).into_response() 63 | } 64 | 65 | async fn get_tag_actor( 66 | axum::extract::State(state): axum::extract::State, 67 | Path(tag): Path 68 | ) -> Response { 69 | track_request("GET", "actor", "tag"); 70 | let target = actor::Actor { 71 | host: state.hostname.clone(), 72 | kind: actor::ActorKind::from_tag(&tag), 73 | }; 74 | target.as_activitypub(&state.pub_key) 75 | .into_response() 76 | } 77 | 78 | async fn get_instance_actor( 79 | axum::extract::State(state): axum::extract::State, 80 | Path(instance): Path 81 | ) -> Response { 82 | track_request("GET", "actor", "instance"); 83 | let target = actor::Actor { 84 | host: state.hostname.clone(), 85 | kind: actor::ActorKind::InstanceRelay(instance.to_lowercase()), 86 | }; 87 | target.as_activitypub(&state.pub_key) 88 | .into_response() 89 | } 90 | 91 | async fn get_language_actor( 92 | axum::extract::State(state): axum::extract::State, 93 | Path(language): Path 94 | ) -> Response { 95 | track_request("GET", "actor", "language"); 96 | let Some(kind) = actor::ActorKind::from_language(&language) else { 97 | return StatusCode::NOT_FOUND.into_response(); 98 | }; 99 | let target = actor::Actor { 100 | host: state.hostname.clone(), 101 | kind, 102 | }; 103 | target.as_activitypub(&state.pub_key) 104 | .into_response() 105 | } 106 | 107 | async fn post_tag_relay( 108 | axum::extract::State(state): axum::extract::State, 109 | Path(tag): Path, 110 | endpoint: endpoint::Endpoint<'_> 111 | ) -> Response { 112 | let target = actor::Actor { 113 | host: state.hostname.clone(), 114 | kind: actor::ActorKind::from_tag(&tag), 115 | }; 116 | post_relay(state, endpoint, target).await 117 | } 118 | 119 | async fn post_instance_relay( 120 | axum::extract::State(state): axum::extract::State, 121 | Path(instance): Path, 122 | endpoint: endpoint::Endpoint<'_> 123 | ) -> Response { 124 | let target = actor::Actor { 125 | host: state.hostname.clone(), 126 | kind: actor::ActorKind::InstanceRelay(instance.to_lowercase()), 127 | }; 128 | post_relay(state, endpoint, target).await 129 | } 130 | 131 | async fn post_language_relay( 132 | axum::extract::State(state): axum::extract::State, 133 | Path(language): Path, 134 | endpoint: endpoint::Endpoint<'_> 135 | ) -> Response { 136 | let Some(kind) = actor::ActorKind::from_language(&language) else { 137 | return StatusCode::NOT_FOUND.into_response(); 138 | }; 139 | let target = actor::Actor { 140 | host: state.hostname.clone(), 141 | kind, 142 | }; 143 | post_relay(state, endpoint, target).await 144 | } 145 | 146 | async fn post_relay( 147 | state: State, 148 | endpoint: endpoint::Endpoint<'_>, 149 | mut target: actor::Actor 150 | ) -> Response { 151 | if let Some((redis, in_topic)) = &state.redis { 152 | if let Ok(data) = serde_json::to_vec(&endpoint.payload) { 153 | if let Err(e) = redis::Cmd::publish(in_topic.as_ref(), data) 154 | .query_async::(&mut redis.clone()) 155 | .await 156 | { 157 | tracing::error!("redis publish: {}", e); 158 | } 159 | } 160 | } 161 | 162 | let remote_actor = endpoint.remote_actor(&state.client, &state.actor_cache, target.key_id(), state.priv_key.clone()) 163 | .await 164 | .map_err(|e| { 165 | track_request("POST", "relay", "bad_actor"); 166 | tracing::error!("post_relay bad actor: {e:?}"); 167 | e 168 | }); 169 | 170 | let action = match serde_json::from_value::>(endpoint.payload.clone()) { 171 | Ok(action) => action, 172 | Err(e) => { 173 | track_request("POST", "relay", "bad_action"); 174 | tracing::error!("post_relay bad action: {e:?}"); 175 | return ( 176 | StatusCode::BAD_REQUEST, 177 | format!("Bad action: {e:?}") 178 | ).into_response(); 179 | } 180 | }; 181 | let object_type = action.object.as_ref() 182 | .and_then(|object| object.get("type").cloned()) 183 | .and_then(|object_type| object_type.as_str().map(std::string::ToString::to_string)); 184 | 185 | if action.action_type == "Follow" { 186 | let Ok(remote_actor) = remote_actor else { 187 | return (StatusCode::BAD_REQUEST, "Invalid actor").into_response(); 188 | }; 189 | if let Some(action_target) = action.object.and_then(|object| Actor::from_object(&object)) { 190 | if action_target.host == state.hostname { 191 | // A sharedInbox receives the actual follow target in the 192 | // `object` field. 193 | target = action_target; 194 | } 195 | } 196 | let priv_key = state.priv_key.clone(); 197 | let client = state.client.clone(); 198 | tokio::spawn(async move { 199 | let accept_id = format!( 200 | "https://{}/activity/accept/{}/{}", 201 | state.hostname, 202 | urlencoding::encode(&target.uri()), 203 | urlencoding::encode(&remote_actor.inbox), 204 | ); 205 | let accept = activitypub::Action { 206 | jsonld_context: serde_json::Value::String("https://www.w3.org/ns/activitystreams".to_string()), 207 | action_type: "Accept".to_string(), 208 | actor: target.uri(), 209 | to: Some(json!(remote_actor.id.clone())), 210 | id: accept_id, 211 | object: Some(endpoint.payload), 212 | }; 213 | let result = send::send( 214 | client.as_ref(), &remote_actor.inbox, 215 | &target.key_id(), 216 | &priv_key, 217 | &accept, 218 | ).await; 219 | match result { 220 | Ok(()) => { 221 | match state.database.add_follow( 222 | &remote_actor.id, 223 | &remote_actor.inbox, 224 | &target.uri(), 225 | ).await { 226 | Ok(()) => { 227 | track_request("POST", "relay", "follow"); 228 | } 229 | Err(e) => { 230 | // duplicate key constraint 231 | tracing::error!("add_follow: {}", e); 232 | track_request("POST", "relay", "follow_error"); 233 | } 234 | } 235 | } 236 | Err(e) => { 237 | tracing::error!("post accept: {}", e); 238 | track_request("POST", "relay", "follow_accept_error"); 239 | } 240 | } 241 | }); 242 | 243 | (StatusCode::ACCEPTED, 244 | [("content-type", "application/activity+json")], 245 | "{}" 246 | ).into_response() 247 | } else if action.action_type == "Undo" && object_type == Some("Follow".to_string()) { 248 | let Ok(remote_actor) = remote_actor else { 249 | return (StatusCode::BAD_REQUEST, "Invalid actor").into_response(); 250 | }; 251 | if let Some(action_target) = action.object 252 | .and_then(|object| object.get("object") 253 | .and_then(Actor::from_object)) 254 | { 255 | if action_target.host == state.hostname { 256 | // A sharedInbox receives the actual follow target in the 257 | // `object` field. 258 | target = action_target; 259 | } 260 | } 261 | match state.database.del_follow( 262 | &remote_actor.id, 263 | &target.uri(), 264 | ).await { 265 | Ok(()) => { 266 | track_request("POST", "relay", "unfollow"); 267 | (StatusCode::ACCEPTED, 268 | [("content-type", "application/activity+json")], 269 | "{}" 270 | ).into_response() 271 | } 272 | Err(e) => { 273 | tracing::error!("del_follow: {}", e); 274 | track_request("POST", "relay", "unfollow_error"); 275 | (StatusCode::INTERNAL_SERVER_ERROR, 276 | format!("{e}") 277 | ).into_response() 278 | } 279 | } 280 | } else { 281 | track_request("POST", "relay", "unrecognized"); 282 | (StatusCode::ACCEPTED, 283 | [("content-type", "application/activity+json")], 284 | "{}" 285 | ).into_response() 286 | } 287 | } 288 | 289 | /// An empty `ActivityStreams` outbox just to satisfy the spec 290 | async fn outbox() -> Response { 291 | Json(json!({ 292 | "@context": "https://www.w3.org/ns/activitystreams", 293 | "summary": "buzzrelay stub outbox", 294 | "type": "OrderedCollection", 295 | "totalItems": 0, 296 | "orderedItems": [] 297 | })).into_response() 298 | } 299 | 300 | async fn nodeinfo(axum::extract::State(state): axum::extract::State) -> Response { 301 | let follows_count = state.database.get_follows_count() 302 | .await 303 | .unwrap_or(0); 304 | let followers_count = state.database.get_followers_count() 305 | .await 306 | .unwrap_or(0); 307 | 308 | Json(json!({ 309 | "version": "2.1", 310 | "software": { 311 | "name": env!("CARGO_PKG_NAME"), 312 | "version": env!("CARGO_PKG_VERSION"), 313 | "repository": env!("CARGO_PKG_REPOSITORY"), 314 | "homepage": env!("CARGO_PKG_HOMEPAGE"), 315 | }, 316 | "protocols": ["activitypub"], 317 | "services": { 318 | "inbound": [], 319 | "outbound": [] 320 | }, 321 | "openRegistrations": false, 322 | "usage": { 323 | "users": { 324 | "total": 0, 325 | "activeHalfyear": followers_count, 326 | "activeMonth": 0, 327 | }, 328 | "localPosts": follows_count, 329 | "localComments": 0 330 | }, 331 | "metadata": { 332 | "rust_version": env!("CARGO_PKG_RUST_VERSION"), 333 | }, 334 | "links": vec![ 335 | json!({ 336 | "rel": "http://nodeinfo.diaspora.software/ns/schema/2.1", 337 | "href": format!("https://{}/.well-known/nodeinfo", state.hostname), 338 | }), 339 | ], 340 | })).into_response() 341 | } 342 | 343 | /// Expected by `AodeRelay` 344 | async fn instanceinfo() -> Response { 345 | Json(json!({ 346 | "title": env!("CARGO_PKG_NAME"), 347 | "description": "#FediBuzz Relay", 348 | "version": env!("CARGO_PKG_VERSION"), 349 | "registrations": false, 350 | "default_approval": false, 351 | })).into_response() 352 | } 353 | 354 | 355 | #[tokio::main] 356 | async fn main() { 357 | exit_on_panic(); 358 | 359 | tracing_subscriber::registry() 360 | .with( 361 | tracing_subscriber::EnvFilter::try_from_default_env().unwrap_or_else(|_| { 362 | "buzzrelay=trace,tower_http=trace,axum=trace".into() 363 | }), 364 | ) 365 | .with(tracing_subscriber::fmt::layer()) 366 | .init(); 367 | 368 | let recorder = PrometheusBuilder::new() 369 | .add_global_label("application", env!("CARGO_PKG_NAME")) 370 | .idle_timeout(MetricKindMask::ALL, Some(Duration::from_secs(600))) 371 | .install_recorder() 372 | .unwrap(); 373 | 374 | let config = config::Config::load( 375 | &std::env::args().nth(1) 376 | .expect("Call with config.yaml") 377 | ); 378 | let database = db::Database::connect(&config.db).await; 379 | let mut redis = None; 380 | if let Some(redis_config) = config.redis.clone() { 381 | let mut redis_url = Url::parse(&redis_config.connection) 382 | .expect("redis.connection"); 383 | let redis_password = std::fs::read_to_string(redis_config.password_file) 384 | .expect("redis.password_file"); 385 | redis_url.set_password(Some(&redis_password)).unwrap(); 386 | let client = redis::Client::open(redis_url) 387 | .expect("redis::Client"); 388 | let manager = redis::aio::ConnectionManager::new(client) 389 | .await 390 | .expect("redis::Client"); 391 | redis = Some((manager, redis_config.in_topic)); 392 | } 393 | let client = reqwest::Client::builder() 394 | .timeout(Duration::from_secs(5)) 395 | .user_agent(format!( 396 | "{}/{} (+https://{})", 397 | env!("CARGO_PKG_NAME"), 398 | env!("CARGO_PKG_VERSION"), 399 | config.hostname, 400 | )) 401 | .pool_max_idle_per_host(1) 402 | .pool_idle_timeout(Some(Duration::from_secs(5))) 403 | .build() 404 | .unwrap(); 405 | let state = State::new(config.clone(), database, redis, client); 406 | 407 | let stream_rx = stream::spawn(config.streams.clone().into_iter()); 408 | relay::spawn(state.clone(), stream_rx); 409 | 410 | let app = Router::new() 411 | .route("/tag/{tag}", get(get_tag_actor).post(post_tag_relay)) 412 | .route("/instance/{instance}", get(get_instance_actor).post(post_instance_relay)) 413 | .route("/language/{language}", get(get_language_actor).post(post_language_relay)) 414 | .route("/tag/{tag}/outbox", get(outbox)) 415 | .route("/instance/{instance}/outbox", get(outbox)) 416 | .route("/language/{language}/outbox", get(outbox)) 417 | .route("/.well-known/webfinger", get(webfinger)) 418 | .route("/.well-known/nodeinfo", get(nodeinfo)) 419 | .route("/api/v1/instance", get(instanceinfo)) 420 | .route("/metrics", get(|| async move { 421 | recorder.render().into_response() 422 | })) 423 | .with_state(state) 424 | .fallback_service(ServeDir::new("static")); 425 | 426 | let addr = SocketAddr::from(([127, 0, 0, 1], config.listen_port)); 427 | let listener = tokio::net::TcpListener::bind(addr).await.unwrap(); 428 | let server = axum::serve(listener, app.into_make_service()); 429 | 430 | tracing::info!("serving on {}", addr); 431 | systemd::daemon::notify(false, [(systemd::daemon::STATE_READY, "1")].iter()) 432 | .unwrap(); 433 | server.await 434 | .unwrap(); 435 | } 436 | 437 | fn exit_on_panic() { 438 | let orig_hook = panic::take_hook(); 439 | panic::set_hook(Box::new(move |panic_info| { 440 | // invoke the default handler and exit the process 441 | orig_hook(panic_info); 442 | process::exit(1); 443 | })); 444 | } 445 | -------------------------------------------------------------------------------- /src/relay.rs: -------------------------------------------------------------------------------- 1 | use std::{sync::Arc, collections::{HashSet, HashMap}, time::{Duration, Instant}}; 2 | use futures::{channel::mpsc::{channel, Sender}, StreamExt}; 3 | use metrics::{counter, histogram}; 4 | use serde::Deserialize; 5 | use serde_json::json; 6 | use sigh::PrivateKey; 7 | use tokio::sync::mpsc::Receiver; 8 | use crate::{send, actor, state::State}; 9 | 10 | #[derive(Deserialize)] 11 | struct Post<'a> { 12 | pub url: Option<&'a str>, 13 | pub uri: &'a str, 14 | pub tags: Option>>, 15 | pub language: Option<&'a str>, 16 | } 17 | 18 | impl Post<'_> { 19 | pub fn host(&self) -> Option { 20 | reqwest::Url::parse(self.url?) 21 | .ok() 22 | .and_then(|url| url.domain() 23 | .map(str::to_lowercase) 24 | ) 25 | } 26 | 27 | pub fn tags(&self) -> Vec { 28 | match &self.tags { 29 | None => 30 | vec![], 31 | Some(tags) => 32 | tags.iter() 33 | .map(|tag| tag.name.to_string()) 34 | .collect() 35 | } 36 | } 37 | 38 | fn relay_target_kinds(&self) -> impl Iterator { 39 | self.host() 40 | .into_iter() 41 | .map(actor::ActorKind::InstanceRelay) 42 | .chain( 43 | self.tags() 44 | .into_iter() 45 | .flat_map(|ref s| { 46 | // Don't handle the empty hashtag `#` 47 | if s.is_empty() { 48 | return vec![]; 49 | } 50 | 51 | let actor1 = actor::ActorKind::from_tag(s); 52 | 53 | // Distribute hashtags that end in a date to 54 | // followers of the hashtag with the date 55 | // stripped. Example: #dd1302 -> #dd 56 | let mut first_trailing_digit = 0; 57 | let mut scanning_digits = false; 58 | for (pos, c) in s.char_indices() { 59 | if char::is_digit(c, 10) { 60 | if ! scanning_digits { 61 | first_trailing_digit = pos; 62 | scanning_digits = true; 63 | } 64 | } else { 65 | scanning_digits = false; 66 | } 67 | } 68 | if scanning_digits && first_trailing_digit > 0 { 69 | let tag = &s[..first_trailing_digit]; 70 | let actor2 = actor::ActorKind::from_tag(tag); 71 | vec![actor1, actor2] 72 | } else { 73 | vec![actor1] 74 | } 75 | }) 76 | ) 77 | .chain( 78 | self.language 79 | .and_then(actor::ActorKind::from_language) 80 | ) 81 | } 82 | 83 | pub fn relay_targets(&self, hostname: Arc) -> impl Iterator { 84 | self.relay_target_kinds() 85 | .map(move |kind| actor::Actor { 86 | host: hostname.clone(), 87 | kind, 88 | }) 89 | } 90 | } 91 | 92 | #[derive(Deserialize)] 93 | struct Tag<'a> { 94 | pub name: &'a str, 95 | } 96 | 97 | struct Job { 98 | post_url: Arc, 99 | actor_id: Arc, 100 | body: Arc>, 101 | key_id: String, 102 | private_key: Arc, 103 | inbox_url: reqwest::Url, 104 | } 105 | 106 | fn spawn_worker(client: Arc) -> Sender { 107 | let (tx, mut rx) = channel(512); 108 | 109 | tokio::spawn(async move { 110 | let mut errors = 0u32; 111 | let mut last_request = None; 112 | 113 | while let Some(Job { post_url, actor_id, key_id, private_key, body, inbox_url }) = rx.next().await { 114 | if errors > 0 && last_request.is_some_and(|last_request: Instant| 115 | last_request.elapsed() < Duration::from_secs(10) * errors 116 | ) { 117 | // there have been errors, skip for time proportional 118 | // to the number of subsequent errors 119 | tracing::trace!("skip {} from {} to {}", post_url, actor_id, inbox_url); 120 | continue; 121 | } 122 | 123 | tracing::debug!("relay {} from {} to {}", post_url, actor_id, inbox_url); 124 | last_request = Some(Instant::now()); 125 | if let Err(e) = send::send_raw( 126 | &client, inbox_url.as_str(), 127 | &key_id, &private_key, body 128 | ).await { 129 | tracing::error!("relay::send {:?}", e); 130 | errors = errors.saturating_add(1); 131 | } else { 132 | // success 133 | errors = 0; 134 | systemd::daemon::notify( 135 | false, [ 136 | (systemd::daemon::STATE_WATCHDOG, "1") 137 | ].iter() 138 | ).unwrap(); 139 | } 140 | } 141 | 142 | panic!("Worker dead"); 143 | }); 144 | 145 | tx 146 | } 147 | 148 | pub fn spawn( 149 | state: State, 150 | mut stream_rx: Receiver 151 | ) { 152 | tokio::spawn(async move { 153 | let mut workers = HashMap::new(); 154 | 155 | while let Some(data) = stream_rx.recv().await { 156 | let t1 = Instant::now(); 157 | let post: Post = match serde_json::from_str(&data) { 158 | Ok(post) => post, 159 | Err(e) => { 160 | tracing::error!("parse error: {}", e); 161 | tracing::trace!("data: {}", data); 162 | continue; 163 | } 164 | }; 165 | let post_url = if let Some(url) = post.url { 166 | Arc::new(url.to_string()) 167 | } else { 168 | // skip reposts 169 | counter!("relay_posts_total", "action" => "skip") 170 | .increment(1); 171 | continue; 172 | }; 173 | let mut seen_actors = HashSet::new(); 174 | let mut seen_inboxes = HashSet::new(); 175 | let published = chrono::Utc::now().to_rfc3339_opts(chrono::SecondsFormat::Secs, true); 176 | for actor in post.relay_targets(state.hostname.clone()) { 177 | if seen_actors.contains(&actor) { 178 | continue; 179 | } 180 | 181 | let actor_id = Arc::new(actor.uri()); 182 | let announce_id = format!("https://{}/announce/{}", state.hostname, urlencoding::encode(&post_url)); 183 | let body = json!({ 184 | "@context": "https://www.w3.org/ns/activitystreams", 185 | "type": "Announce", 186 | "actor": *actor_id, 187 | "published": &published, 188 | "to": ["https://www.w3.org/ns/activitystreams#Public"], 189 | "object": &post.uri, 190 | "id": announce_id, 191 | }); 192 | let Ok(post_url_url) = reqwest::Url::parse(&post_url) else { continue; }; 193 | let body = Arc::new( 194 | serde_json::to_vec(&body) 195 | .unwrap() 196 | ); 197 | for inbox in state.database.get_following_inboxes(&actor_id).await.unwrap() { 198 | let Ok(inbox_url) = reqwest::Url::parse(&inbox) else { continue; }; 199 | 200 | // Avoid duplicate processing. 201 | if seen_inboxes.contains(&inbox) { 202 | continue; 203 | } 204 | seen_inboxes.insert(inbox); 205 | 206 | // Prevent relaying back to the originating instance. 207 | if inbox_url.host_str() == post_url_url.host_str() { 208 | continue; 209 | } 210 | 211 | // Lookup/create worker queue per inbox. 212 | let tx = workers.entry(inbox_url.host_str().unwrap_or("").to_string()) 213 | .or_insert_with(|| spawn_worker(state.client.clone())); 214 | // Create queue item. 215 | let job = Job { 216 | post_url: post_url.clone(), 217 | actor_id: actor_id.clone(), 218 | body: body.clone(), 219 | key_id: actor.key_id(), 220 | private_key: state.priv_key.clone(), 221 | inbox_url, 222 | }; 223 | // Enqueue job for worker. 224 | let _ = tx.try_send(job); 225 | } 226 | 227 | seen_actors.insert(actor); 228 | } 229 | if seen_inboxes.is_empty() { 230 | counter!("relay_posts_total", "action" => "no_relay") 231 | .increment(1); 232 | } else { 233 | counter!("relay_posts_total", "action" => "relay") 234 | .increment(1); 235 | } 236 | let t2 = Instant::now(); 237 | histogram!("relay_post_duration").record(t2 - t1); 238 | } 239 | }); 240 | } 241 | 242 | #[cfg(test)] 243 | mod test { 244 | use super::*; 245 | use actor::ActorKind; 246 | 247 | #[test] 248 | fn post_relay_kind() { 249 | let post = Post { 250 | url: Some("http://example.com/post/1"), 251 | uri: "http://example.com/post/1", 252 | tags: Some(vec![Tag { 253 | name: "foo", 254 | }]), 255 | language: Some("en"), 256 | }; 257 | let mut kinds = post.relay_target_kinds(); 258 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 259 | assert_eq!(kinds.next(), Some(ActorKind::TagRelay("foo".to_string()))); 260 | assert_eq!(kinds.next(), Some(ActorKind::LanguageRelay("en".to_string()))); 261 | assert_eq!(kinds.next(), None); 262 | } 263 | 264 | #[test] 265 | fn post_relay_kind_empty() { 266 | let post = Post { 267 | url: Some("http://example.com/post/1"), 268 | uri: "http://example.com/post/1", 269 | tags: Some(vec![Tag { 270 | name: "", 271 | }]), 272 | language: None, 273 | }; 274 | let mut kinds = post.relay_target_kinds(); 275 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 276 | assert_eq!(kinds.next(), None); 277 | } 278 | 279 | #[test] 280 | fn post_relay_kind_numeric() { 281 | let post = Post { 282 | url: Some("http://example.com/post/1"), 283 | uri: "http://example.com/post/1", 284 | tags: Some(vec![Tag { 285 | name: "23", 286 | }]), 287 | language: None, 288 | }; 289 | let mut kinds = post.relay_target_kinds(); 290 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 291 | assert_eq!(kinds.next(), Some(ActorKind::TagRelay("23".to_string()))); 292 | assert_eq!(kinds.next(), None); 293 | } 294 | 295 | #[test] 296 | fn post_relay_kind_date() { 297 | let post = Post { 298 | url: Some("http://example.com/post/1"), 299 | uri: "http://example.com/post/1", 300 | tags: Some(vec![Tag { 301 | name: "dd1302", 302 | }]), 303 | language: None, 304 | }; 305 | let mut kinds = post.relay_target_kinds(); 306 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 307 | assert_eq!(kinds.next(), Some(ActorKind::TagRelay("dd1302".to_string()))); 308 | assert_eq!(kinds.next(), Some(ActorKind::TagRelay("dd".to_string()))); 309 | assert_eq!(kinds.next(), None); 310 | } 311 | 312 | #[test] 313 | fn post_relay_kind_ja() { 314 | let post = Post { 315 | url: Some("http://example.com/post/1"), 316 | uri: "http://example.com/post/1", 317 | tags: Some(vec![Tag { 318 | name: "スコティッシュ・フォールド・ロングヘアー", 319 | }]), 320 | language: Some("ja"), 321 | }; 322 | let mut kinds = post.relay_target_kinds(); 323 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 324 | assert_eq!(kinds.next(), Some(ActorKind::TagRelay("sukoteitusiyuhuorudoronguhea".to_string()))); 325 | assert_eq!(kinds.next(), Some(ActorKind::LanguageRelay("ja".to_string()))); 326 | assert_eq!(kinds.next(), None); 327 | } 328 | 329 | #[test] 330 | fn post_relay_language_long() { 331 | let post = Post { 332 | url: Some("http://example.com/post/1"), 333 | uri: "http://example.com/post/1", 334 | tags: None, 335 | language: Some("de_CH"), 336 | }; 337 | let mut kinds = post.relay_target_kinds(); 338 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 339 | assert_eq!(kinds.next(), Some(ActorKind::LanguageRelay("de".to_string()))); 340 | assert_eq!(kinds.next(), None); 341 | } 342 | 343 | #[test] 344 | fn post_relay_language_invalid() { 345 | let post = Post { 346 | url: Some("http://example.com/post/1"), 347 | uri: "http://example.com/post/1", 348 | tags: None, 349 | language: Some("23q"), 350 | }; 351 | let mut kinds = post.relay_target_kinds(); 352 | assert_eq!(kinds.next(), Some(ActorKind::InstanceRelay("example.com".to_string()))); 353 | assert_eq!(kinds.next(), None); 354 | } 355 | } 356 | -------------------------------------------------------------------------------- /src/send.rs: -------------------------------------------------------------------------------- 1 | use std::{ 2 | sync::Arc, 3 | time::{Instant, SystemTime}, 4 | }; 5 | use http::StatusCode; 6 | use metrics::histogram; 7 | use serde::Serialize; 8 | use sigh::{PrivateKey, SigningConfig, alg::RsaSha256}; 9 | use tokio::task::spawn_blocking; 10 | use crate::{digest, error::Error}; 11 | 12 | pub async fn send( 13 | client: &reqwest::Client, 14 | uri: &str, 15 | key_id: &str, 16 | private_key: &PrivateKey, 17 | body: &T, 18 | ) -> Result<(), Error> { 19 | let body = Arc::new( 20 | serde_json::to_vec(body)? 21 | ); 22 | send_raw(client, uri, key_id, private_key, body).await 23 | } 24 | 25 | pub async fn send_raw( 26 | client: &reqwest::Client, 27 | uri: &str, 28 | key_id: &str, 29 | private_key: &PrivateKey, 30 | body: Arc>, 31 | ) -> Result<(), Error> { 32 | let url = reqwest::Url::parse(uri) 33 | .map_err(|_| Error::InvalidUri)?; 34 | let host = format!("{}", url.host().ok_or(Error::InvalidUri)?); 35 | let digest_header = digest::generate_header(&body) 36 | .map_err(|()| Error::Digest)?; 37 | let mut req = http::Request::builder() 38 | .method("POST") 39 | .uri(uri) 40 | .header("host", &host) 41 | .header("content-type", "application/activity+json") 42 | .header("date", httpdate::fmt_http_date(SystemTime::now())) 43 | .header("digest", digest_header) 44 | .body(body.as_ref().clone())?; 45 | let t1 = Instant::now(); 46 | let private_key = private_key.clone(); 47 | let key_id = key_id.to_string(); 48 | let req = spawn_blocking(move || { 49 | SigningConfig::new(RsaSha256, &private_key, &key_id).sign(&mut req)?; 50 | Ok(req) 51 | }) 52 | .await 53 | .map_err(|e| Error::Response(format!("{e}")))? 54 | .map_err(|e: sigh::Error| Error::Response(format!("{e}")))?; 55 | let t2 = Instant::now(); 56 | let req: reqwest::Request = req.try_into()?; 57 | let res = client.execute(req).await?; 58 | let t3 = Instant::now(); 59 | histogram!("relay_http_request_duration") 60 | .record(t2 - t1); 61 | if res.status() >= StatusCode::OK && res.status() < StatusCode::MULTIPLE_CHOICES { 62 | histogram!("relay_http_response_duration", "res" => "ok") 63 | .record(t3 - t2); 64 | Ok(()) 65 | } else { 66 | histogram!("relay_http_response_duration", "res" => "err") 67 | .record(t3 - t2); 68 | let response = res.text().await?; 69 | Err(Error::Response(response)) 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /src/state.rs: -------------------------------------------------------------------------------- 1 | use axum::{ 2 | extract::FromRef, 3 | }; 4 | use sigh::{PrivateKey, PublicKey}; 5 | use std::sync::Arc; 6 | use crate::{config::Config, db::Database, actor_cache::ActorCache}; 7 | 8 | #[derive(Clone)] 9 | pub struct State { 10 | pub database: Database, 11 | pub redis: Option<(redis::aio::ConnectionManager, Arc)>, 12 | pub client: Arc, 13 | pub actor_cache: ActorCache, 14 | pub hostname: Arc, 15 | pub priv_key: Arc, 16 | pub pub_key: Arc, 17 | } 18 | 19 | 20 | impl FromRef for Arc { 21 | fn from_ref(state: &State) -> Arc { 22 | state.client.clone() 23 | } 24 | } 25 | 26 | impl State { 27 | pub fn new(config: Config, database: Database, redis: Option<(redis::aio::ConnectionManager, String)>, client: reqwest::Client) -> Self { 28 | let priv_key = Arc::new(config.priv_key()); 29 | let pub_key = Arc::new(config.pub_key()); 30 | State { 31 | database, 32 | redis: redis.map(|(connection, in_topic)| (connection, Arc::new(in_topic))), 33 | client: Arc::new(client), 34 | actor_cache: ActorCache::default(), 35 | hostname: Arc::new(config.hostname), 36 | priv_key, 37 | pub_key, 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/stream.rs: -------------------------------------------------------------------------------- 1 | use std::time::Duration; 2 | use futures::{Stream, StreamExt}; 3 | use eventsource_stream::Eventsource; 4 | use tokio::{ 5 | sync::mpsc::{channel, Receiver}, 6 | time::sleep, 7 | }; 8 | 9 | #[derive(Debug)] 10 | pub enum StreamError { 11 | Http(reqwest::Error), 12 | HttpStatus(reqwest::StatusCode), 13 | InvalidContentType, 14 | } 15 | 16 | async fn run(url: &str) -> Result, StreamError> { 17 | let client = reqwest::Client::new(); 18 | let res = client.get(url) 19 | .timeout(Duration::MAX) 20 | .send() 21 | .await 22 | .map_err(StreamError::Http)?; 23 | if res.status() != 200 { 24 | return Err(StreamError::HttpStatus(res.status())); 25 | } 26 | let ct = res.headers().get("content-type") 27 | .and_then(|c| c.to_str().ok()); 28 | if ct != Some("text/event-stream") { 29 | return Err(StreamError::InvalidContentType); 30 | } 31 | 32 | let src = res.bytes_stream() 33 | .eventsource() 34 | .filter_map(|result| async { 35 | let result = result.ok()?; 36 | if result.event == "update" { 37 | Some(result) 38 | } else { 39 | None 40 | } 41 | }) 42 | .map(|event| event.data); 43 | Ok(src) 44 | } 45 | 46 | pub fn spawn(hosts: impl Iterator>) -> Receiver { 47 | let (tx, rx) = channel(1024); 48 | for host in hosts { 49 | let host = host.into(); 50 | let tx = tx.clone(); 51 | tokio::spawn(async move { 52 | loop { 53 | match run(&host).await { 54 | Ok(stream) => 55 | stream.for_each(|post| async { 56 | tx.send(post).await.unwrap(); 57 | }).await, 58 | Err(StreamError::Http(e)) => 59 | tracing::error!("stream http error: {:?}", e), 60 | Err(StreamError::HttpStatus(status)) => 61 | tracing::error!("stream http status: {:?}", status), 62 | Err(StreamError::InvalidContentType) => 63 | tracing::error!("stream invalid content-type"), 64 | } 65 | 66 | sleep(Duration::from_secs(1)).await; 67 | } 68 | }); 69 | } 70 | rx 71 | } 72 | -------------------------------------------------------------------------------- /static/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | #FediBuzz Relay 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 |
17 |

#FediBuzz Relay

18 |

The customizable ActivityPub relay service

19 |
20 | 21 |
22 |

23 | Mastodon and many other ActivityPub-compatible services live 24 | and breathe decentralization. Yet it can get lonely on a small 25 | instance. Mastoadmins can bring the global buzz of toots into 26 | the Federated Timeline of their small server by 27 | following ActivityPub relays. 28 |

29 |

30 | With this service #FediBuzz 31 | provides relay endpoints for you to customize. 32 |

33 |
    34 |
  1. In Mastodon: click Preferences in the navigation sidebar
    2. 35 |
  2. Navigate to Administration
    3. 36 |
  3. Navigate to Relays /admin/relays
    4. 37 |
  4. Click the Add new relay button /admin/relays/new
    5. 38 |
  5. Generate a relay address below
    6. 39 |
  6. Copy & paste into Mastodon's preferences
    7. 40 |
  7. Hit the Save and enable button
    8. 41 |
42 |
43 | 44 |
45 | 50 |
51 |

Follow posts by #tag

52 |
53 | 54 |
55 | 
 56 |
57 |
58 |
59 |

Follow posts by instance

60 |
61 | 62 |
63 | 
 64 |
65 |
66 |
67 | 68 |
69 |

Can I follow all my city's hashtags for all dates in the year?

70 |

71 | Putting dates in hashtags is popular. We are aware, and our 72 | solution is very simple: posts with hashtags that end in 73 | digits are additionally delivered to all followers that follow 74 | the hashtag without the trailing digits. 75 |

76 |

77 | That means, if you follow #dd on this relay, 78 | you'll also get #dd1302, #dd1402, 79 | #dd1502, and many more! 80 |

81 | 82 |

Will this service get me undesirable content?

83 |

84 | To steer free of the worst, #FediBuzz ignores anyone from 85 | instances that appear in 86 | the Garden 87 | Fence blocklist, which we pull regularly. However, because 88 | we relay links to content in real-time, this service will 89 | never do any manual filtering itself. 90 |

91 | 92 |

Is it cool to follow a few thousand tags/instances to build my own firehose?

93 |

94 | Please don't, it's inefficient. Take a look at #FediBuzz' 95 | federated 96 | timeline API instead: 97 |

98 | 
https://fedi.buzz/api/v1/streaming/public
99 |
100 | 101 | 108 | 109 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /static/style.css: -------------------------------------------------------------------------------- 1 | body { 2 | background-color: #EFDFFF; 3 | color: #0F1F2F; 4 | font-family: sans-serif; 5 | margin: 0 auto; 6 | max-width: 70rem; 7 | } 8 | a { 9 | text-decoration: none; 10 | font-weight: bold; 11 | color: #9F2F1F; 12 | } 13 | h1 { 14 | text-align: center; 15 | font-size: 600%; 16 | text-shadow: 0 0.2rem 0.2rem #9FAFBF; 17 | letter-spacing: 0.1rem; 18 | margin: 1rem 0 0; 19 | } 20 | header p { 21 | margin: 0 auto 1rem; 22 | text-align: center; 23 | font-style: italic; 24 | } 25 | h2 { 26 | margin: 3rem auto 1rem; 27 | max-width: 38rem; 28 | } 29 | p, ol, pre { 30 | margin: 2rem auto; 31 | max-width: 30rem; 32 | padding: 0; 33 | line-height: 2em; 34 | } 35 | ol > li { 36 | position: relative; 37 | margin: 0.5rem; 38 | padding: 0; 39 | } 40 | ol > li > code { 41 | padding-left: 2rem; 42 | color: #888; 43 | position: absolute; 44 | right: 0; 45 | } 46 | ol > li > code::before { 47 | content: "https://…"; 48 | } 49 | 50 | .boxes { 51 | display: flex; 52 | flex-direction: row; 53 | justify-content: space-around; 54 | flex-wrap: wrap; 55 | } 56 | .boxes article { 57 | background-color: #EFDFFF; 58 | padding: 0.5rem 1rem; 59 | text-align: center; 60 | margin: 1rem 0.5rem; 61 | min-width: 25rem; 62 | } 63 | .boxes article pre { 64 | margin: 1rem auto; 65 | padding: 0.5rem; 66 | background-color: #DFCFEF; 67 | } 68 | 69 | .faq { 70 | margin: 4rem; 71 | } 72 | 73 | footer { 74 | margin-top: 8rem; 75 | text-align: center; 76 | } 77 | -------------------------------------------------------------------------------- /static/urlgen.js: -------------------------------------------------------------------------------- 1 | (function() { 2 | function setup(id) { 3 | var inputEl = document.getElementById(id); 4 | var preEl = document.getElementById(id + "-url"); 5 | function onChange(ev) { 6 | setTimeout(function() { 7 | var value = encodeURIComponent(inputEl.value.replace(/^#/, "")); 8 | preEl.innerText = value ? 9 | "https://" + document.location.host + "/" + id + "/" + value : 10 | "\n"; 11 | }, 10); 12 | } 13 | inputEl.addEventListener('change', onChange); 14 | inputEl.addEventListener('keyup', onChange); 15 | } 16 | 17 | setup("tag"); 18 | setup("instance"); 19 | })() 20 | --------------------------------------------------------------------------------