bump conduwuit version to 0.3.2

Signed-off-by: strawberry <strawberry@puppygock.gay>

.dockerignore

@@ -4,7 +4,6 @@ tests
 
 # Docker files
 Dockerfile*
-docker-compose*
 
 # IDE files
 .vscode

.git-blame-ignore-revs

@@ -1,3 +1,7 @@
 # .git-blame-ignore-revs
 # adds a proper rustfmt.toml and formats the entire codebase
 1d1ac065141181438e744e7d8abd0e45f75a2f91
+f419c64aca300a338096b4e0db4c73ace54f23d0
+# use chain_width 60
+162948313c212193965dece50b816ef0903172ba
+5998a0d883d31b866f7c8c46433a8857eae51a89

.github/workflows/ci.yml

@@ -1,250 +1,323 @@
 name: CI and Artifacts
 
 on:
-  pull_request:
-  push:
-    branches:
-      - main
+    pull_request:
+    push:
+        # documentation workflow deals with this or is not relevant for this workflow
+        paths-ignore:
+          - '*.md'
+          - 'conduwuit-example.toml'
+          - 'book.toml'
+          - '.gitlab-ci.yml'
+          - '.gitignore'
+          - 'renovate.json'
+          - 'docs/**'
+          - 'debian/**'
+          - 'docker/**'
+          - 'test_results/**'
+        branches:
+            - main
+            - dev
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.head_ref || github.ref_name }}
+    cancel-in-progress: true
 
 env:
-  # Required to make some things output color
-  TERM: ansi
-  ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
-  CARGO_INCREMENTAL: 0
-  ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
-  ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+    # Required to make some things output color
+    TERM: ansi
+    # Publishing to my nix binary cache
+    ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+    # Just in case incremental is still being set to true, speeds up CI
+    CARGO_INCREMENTAL: 0
+    # Custom nix binary cache if fork is being used
+    ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
+    ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
 
 permissions:
-  packages: write
+    packages: write
+    contents: read
 
 jobs:
-  ci:
-    name: CI and Artifacts
+    tests:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
 
-    runs-on: ubuntu-latest
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
 
-    steps:
-      - name: Sync repository
-        uses: actions/checkout@v4
+            - name: Enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
 
-      - name: Install Nix (with flakes and nix-command enabled)
-        uses: cachix/install-nix-action@v26
-        with:
-          nix_path: nixpkgs=channel:nixos-unstable
+            - name: Configure Magic Nix Cache
+              uses: DeterminateSystems/magic-nix-cache-action@main
 
-          # Add `nix-community`, Crane, upstream Conduit, and conduwuit binary caches
-          extra_nix_config: |
-            experimental-features = nix-command flakes
-            extra-substituters = https://nix-community.cachix.org
-            extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
-            extra-substituters = https://crane.cachix.org
-            extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=
-            extra-substituters = https://nix.computer.surgery/conduit
-            extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=
-            extra-substituters = https://attic.kennel.juneis.dog/conduit
-            extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
-            extra-substituters = https://attic.kennel.juneis.dog/conduwuit
-            extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
+                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+                  EOF
 
-      - name: Add alternative Nix binary caches if specified
-        if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
-        run: |
-          echo "extra-substituters = ${{ env.ATTIC_ENDPOINT }}" >> /etc/nix/nix.conf
-          echo "extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}" >> /etc/nix/nix.conf
+            - name: Use alternative Nix binary caches if specified
+              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
 
-      - name: Pop/push Magic Nix Cache
-        uses: DeterminateSystems/magic-nix-cache-action@main
+            - name: Prepare build environment
+              run: |
+                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  direnv allow
+                  nix develop --command true
 
-      - name: Configure `nix-direnv`
-        run: |
-          echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+            - name: Run CI tests
+              run: |
+                  direnv exec . engage > >(tee -a test_output.log)
 
-      - name: Install `direnv` and `nix-direnv`
-        run: nix-env -f "<nixpkgs>" -iA direnv -iA nix-direnv
+            - name: Sync Complement repository
+              uses: actions/checkout@v4
+              with:
+                repository: 'matrix-org/complement'
+                path: complement_src
 
-      - name: Pop/push downloaded crate cache
-        uses: actions/cache@v4
-        with:
-          key: downloaded-crates
-          path: ~/.cargo
+            - name: Run Complement tests
+              run: |
+                  direnv exec . bin/complement 'complement_src' 'complement_test_logs.jsonl' 'complement_test_results.jsonl'
 
-      - name: Pop/push compiled crate cache
-        uses: actions/cache@v4
-        with:
-          key: compiled-crates-${{runner.os}}
-          path: target
+            - name: Upload Complement logs
+              uses: actions/upload-artifact@v4
+              with:
+                name: complement_test_logs.jsonl
+                path: complement_test_logs.jsonl
+                if-no-files-found: error
 
-      # Do this to shorten the logs for the real CI step
-      - name: Populate `/nix/store`
-        run: nix develop --command true
+            - name: Upload Complement results
+              uses: actions/upload-artifact@v4
+              with:
+                name: complement_test_results.jsonl
+                path: complement_test_results.jsonl
+                if-no-files-found: error
 
-      - name: Allow direnv
-        run: direnv allow
+            - name: Diff Complement results with checked-in repo results
+            # TODO: figure out why our complement results are not 100% consistent so we don't need to allow failures
+              continue-on-error: true
+              run: |
+                  diff -u --color=always complement_test_results.jsonl tests/test_results/complement/test_results.jsonl > >(tee -a complement_test_output.log)
 
-      - name: Cache x86_64 inputs for devShell
-        run: |
-          ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation
+            - name: Add Complement diff result to Job Summary
+              run: |
+                  echo '# Complement diff results' >> $GITHUB_STEP_SUMMARY
+                  echo '```diff' >> $GITHUB_STEP_SUMMARY
+                  tail -n 50 complement_test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                  echo '```' >> $GITHUB_STEP_SUMMARY
 
+            - name: Update Job Summary
+              if: success() || failure()
+              run: |
+                  if [ ${{ job.status }} == 'success' ]; then
+                      echo '# ✅ completed suwuccessfully' >> $GITHUB_STEP_SUMMARY
+                  else
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                      tail -n 20 test_output.log | sed 's/\x1b\[[0-9;]*m//g' >> $GITHUB_STEP_SUMMARY
+                      echo '```' >> $GITHUB_STEP_SUMMARY
+                  fi
 
-      - name: Perform continuous integration
-        run: direnv exec . engage
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        needs: tests
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'
+        strategy:
+            matrix:
+                include:
+                    - target: aarch64-unknown-linux-musl
+                    - target: aarch64-unknown-linux-musl-jemalloc
+                    - target: x86_64-unknown-linux-musl
+                    - target: x86_64-unknown-linux-musl-jemalloc
+        steps:
+            - name: Sync repository
+              uses: actions/checkout@v4
 
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
 
-      - name: Build static-x86_64-unknown-linux-musl and Create static deb-x86_64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#static-x86_64-unknown-linux-musl
-          mkdir -p target/release
-          cp -v -f result/bin/conduit target/release
-          direnv exec . cargo deb --no-build
+            - name: Install and enable Cachix binary cache
+              run: |
+                  nix profile install nixpkgs#cachix
+                  cachix use crane
+                  cachix use nix-community
 
-      - name: Upload artifact static-x86_64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: static-x86_64-unknown-linux-musl
-          path: result/bin/conduit
-          if-no-files-found: error
+            - name: Configure Magic Nix Cache
+              uses: DeterminateSystems/magic-nix-cache-action@main
 
-      - name: Upload artifact deb-x86_64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: x86_64-unknown-linux-musl.deb
-          path: target/debian/*.deb
-          if-no-files-found: error
+            - name: Apply Nix binary cache configuration
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = https://attic.kennel.juneis.dog/conduit https://attic.kennel.juneis.dog/conduwuit
+                  extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg= conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+                  EOF
 
+            - name: Use alternative Nix binary caches if specified
+              if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+              run: |
+                  sudo tee -a /etc/nix/nix.conf > /dev/null <<EOF
+                  extra-substituters = ${{ env.ATTIC_ENDPOINT }}
+                  extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}
+                  EOF
 
-      - name: Build static-aarch64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#static-aarch64-unknown-linux-musl
+            - name: Prepare build environment
+              run: |
+                  echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+                  nix profile install --impure --inputs-from . nixpkgs#direnv nixpkgs#nix-direnv
+                  direnv allow
+                  nix develop --command true
 
-      - name: Upload artifact static-aarch64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: static-aarch64-unknown-linux-musl
-          path: result/bin/conduit
-          if-no-files-found: error
+            - name: Build static ${{ matrix.target }}
+              run: |
+                  bin/nix-build-and-cache just .#static-${{ matrix.target }}
+                  mkdir -p target/release
+                  cp -v -f result/bin/conduit target/release/
+                  direnv exec . cargo deb --no-build --no-strip --output target/debian/${{ matrix.target }}.deb
+                  mv target/release/conduit static-${{ matrix.target }}
 
+            - name: Upload static-${{ matrix.target }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: static-${{ matrix.target }}
+                  path: static-${{ matrix.target }}
+                  if-no-files-found: error
 
-      - name: Build oci-image-x86_64-unknown-linux-gnu
-        run: |
-          ./bin/nix-build-and-cache .#oci-image
-          cp -v -f result oci-image-amd64.tar.gz
+            - name: Upload deb ${{ matrix.target }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: deb-${{ matrix.target }}
+                  path: target/debian/${{ matrix.target }}.deb
+                  if-no-files-found: error
 
-      - name: Upload artifact oci-image-x86_64-unknown-linux-gnu
-        uses: actions/upload-artifact@v4
-        with:
-          name: oci-image-x86_64-unknown-linux-gnu
-          path: oci-image-amd64.tar.gz
-          if-no-files-found: error
-          # don't compress again
-          compression-level: 0
+            - name: Build OCI image ${{ matrix.target }}
+              run: |
+                  bin/nix-build-and-cache just .#oci-image-${{ matrix.target }}
+                  cp -v -f result oci-image-${{ matrix.target }}.tar.gz
 
+            - name: Upload OCI image ${{ matrix.target }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: oci-image-${{ matrix.target }}
+                  path: oci-image-${{ matrix.target }}.tar.gz
+                  if-no-files-found: error
+                  compression-level: 0
 
-      - name: Build oci-image-aarch64-unknown-linux-musl
-        run: |
-          ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
-          cp -v -f result oci-image-arm64v8.tar.gz
-
-      - name: Upload artifact oci-image-aarch64-unknown-linux-musl
-        uses: actions/upload-artifact@v4
-        with:
-          name: oci-image-aarch64-unknown-linux-musl
-          path: oci-image-arm64v8.tar.gz
-          if-no-files-found: error
-          # don't compress again
-          compression-level: 0
-
-
-      - name: Extract metadata for Dockerhub
+    docker:
+        name: Docker publish
+        runs-on: ubuntu-latest
+        needs: build
+        if: (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name != 'pull_request'
         env:
-          REGISTRY: registry.hub.docker.com
-          IMAGE_NAME: ${{ github.repository }}
-        id: meta-dockerhub
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            DOCKER_ARM64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
+            DOCKER_AMD64: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
+            DOCKER_TAG: docker.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
+            DOCKER_BRANCH: docker.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
+            GHCR_ARM64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
+            GHCR_AMD64: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
+            GHCR_TAG: ghcr.io/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
+            GHCR_BRANCH: ghcr.io/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
+            GLCR_ARM64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-arm64v8
+            GLCR_AMD64: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}-amd64
+            GLCR_TAG: registry.gitlab.com/${{ github.repository }}:${{ github.ref_name }}-${{ github.sha }}
+            GLCR_BRANCH: registry.gitlab.com/${{ github.repository }}:${{ (github.ref == 'refs/heads/main' && 'latest') || github.ref_name }}
+            DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
+            GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }}
+        steps:
+            - name: Login to GitHub Container Registry
+              uses: docker/login-action@v3
+              with:
+                  registry: ghcr.io
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata for GitHub Container Registry
-        env:
-          REGISTRY: ghcr.io
-          IMAGE_NAME: ${{ github.repository }}
-        id: meta-ghcr
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            - name: Login to Docker Hub
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              uses: docker/login-action@v3
+              with:
+                  registry: docker.io
+                  username: ${{ vars.DOCKER_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+            - name: Login to GitLab Container Registry
+              if: ${{ (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') }}
+              uses: docker/login-action@v3
+              with:
+                  registry: registry.gitlab.com
+                  username: ${{ vars.GITLAB_USERNAME }}
+                  password: ${{ secrets.GITLAB_TOKEN }}
 
-      - name: Login to Dockerhub
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        with:
-          username: girlbossceo
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+            - name: Download artifacts
+              uses: actions/download-artifact@v4
 
-      - name: Login to GitHub Container Registry
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
-        env:
-          REGISTRY: ghcr.io
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: girlbossceo
-          password: ${{ secrets.GITHUB_TOKEN }}
+            - name: Move OCI images into position
+              run: |
+                  mv oci-image-x86_64-*-jemalloc/*.tar.gz oci-image-amd64.tar.gz
+                  mv oci-image-aarch64-*-jemalloc/*.tar.gz oci-image-arm64v8.tar.gz
 
+            - name: Load and push amd64 image
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker load -i oci-image-amd64.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_AMD64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_AMD64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_AMD64 }}
+                  docker push ${{ env.DOCKER_AMD64 }}
+                  docker push ${{ env.GHCR_AMD64 }}
+                  docker push ${{ env.GLCR_AMD64 }}
 
-      - name: Publish to Dockerhub
-        if: github.event_name != 'pull_request'
-        env:
-          IMAGE_NAME: docker.io/${{ github.repository }}
-          IMAGE_SUFFIX_AMD64: amd64
-          IMAGE_SUFFIX_ARM64V8: arm64v8
-        run: |
-          docker load -i oci-image-amd64.tar.gz
-          IMAGE_ID_AMD64=$(docker images -q conduit:main)
-          docker load -i oci-image-arm64v8.tar.gz
-          IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
+            - name: Load and push arm64 image
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker load -i oci-image-arm64v8.tar.gz
+                  docker tag $(docker images -q conduit:main) ${{ env.DOCKER_ARM64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GHCR_ARM64 }}
+                  docker tag $(docker images -q conduit:main) ${{ env.GLCR_ARM64 }}
+                  docker push ${{ env.DOCKER_ARM64 }}
+                  docker push ${{ env.GHCR_ARM64 }}
+                  docker push ${{ env.GLCR_ARM64 }}
 
-          # Tag and push the architecture specific images
-          docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-          docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-          docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          # Tag the multi-arch image
-          docker manifest create $IMAGE_NAME:$GITHUB_SHA --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:$GITHUB_SHA
-          # Tag and push the git ref
-          docker manifest create $IMAGE_NAME:$GITHUB_REF_NAME --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:$GITHUB_REF_NAME
-          # Tag git tags as 'latest'
-          if [[ -n "$GITHUB_REF_NAME" ]]; then
-            docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-            docker manifest push $IMAGE_NAME:latest
-          fi
+            - name: Create Docker combined manifests
+              run: |
+                  # Dockerhub Container Registry
+                  docker manifest create ${{ env.DOCKER_TAG }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
+                  docker manifest create ${{ env.DOCKER_BRANCH }} --amend ${{ env.DOCKER_ARM64 }} --amend ${{ env.DOCKER_AMD64 }}
+                  # GitHub Container Registry
+                  docker manifest create ${{ env.GHCR_TAG }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
+                  docker manifest create ${{ env.GHCR_BRANCH }} --amend ${{ env.GHCR_ARM64 }} --amend ${{ env.GHCR_AMD64 }}
+                  # GitLab Container Registry
+                  docker manifest create ${{ env.GLCR_TAG }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GCCR_AMD64 }}
+                  docker manifest create ${{ env.GLCR_BRANCH }} --amend ${{ env.GLCR_ARM64 }} --amend ${{ env.GLCR_AMD64 }}
 
-      - name: Publish to GitHub Container Registry
-        if: github.event_name != 'pull_request'
-        env:
-          IMAGE_NAME: ghcr.io/${{ github.repository }}
-          IMAGE_SUFFIX_AMD64: amd64
-          IMAGE_SUFFIX_ARM64V8: arm64v8
-        run: |
-          docker load -i oci-image-amd64.tar.gz
-          IMAGE_ID_AMD64=$(docker images -q conduit:main)
-          docker load -i oci-image-arm64v8.tar.gz
-          IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
+            - name: Push manifests to Docker registries
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  docker manifest push ${{ env.DOCKER_TAG }}
+                  docker manifest push ${{ env.DOCKER_BRANCH }}
+                  docker manifest push ${{ env.GHCR_TAG }}
+                  docker manifest push ${{ env.GHCR_BRANCH }}
+                  docker manifest push ${{ env.GLCR_TAG }}
+                  docker manifest push ${{ env.GLCR_BRANCH }}
 
-          # Tag and push the architecture specific images
-          docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-          docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64
-          docker push $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          # Tag the multi-arch image
-          docker manifest create $IMAGE_NAME:$GITHUB_SHA --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:$GITHUB_SHA
-          # Tag and push the git ref
-          docker manifest create $IMAGE_NAME:$GITHUB_REF_NAME --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-          docker manifest push $IMAGE_NAME:$GITHUB_REF_NAME
-          # Tag git tags as 'latest'
-          if [[ -n "$GITHUB_REF_NAME" ]]; then
-            docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$GITHUB_SHA-$IMAGE_SUFFIX_ARM64V8
-            docker manifest push $IMAGE_NAME:latest
-          fi
+            - name: Add Image Links to Job Summary
+              if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }}
+              run: |
+                  echo "- \`docker pull ${{ env.DOCKER_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GHCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY
+                  echo "- \`docker pull ${{ env.GLCR_TAG }}\`" >> $GITHUB_STEP_SUMMARY

.github/workflows/documentation.yml

@@ -0,0 +1,115 @@
+name: Documentation and GitHub Pages
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  # Required to make some things output color
+  TERM: ansi
+  # Publishing to my nix binary cache
+  ATTIC_TOKEN: ${{ secrets.ATTIC_TOKEN }}
+  # Custom nix binary cache if fork is being used
+  ATTIC_ENDPOINT: ${{ vars.ATTIC_ENDPOINT }}
+  ATTIC_PUBLIC_KEY: ${{ vars.ATTIC_PUBLIC_KEY }}
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    name: Documentation and GitHub Pages
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Sync repository
+        uses: actions/checkout@v4
+
+      - name: Setup GitHub Pages
+        if: github.event_name != 'pull_request'
+        uses: actions/configure-pages@v5
+
+      - name: Install Nix (with flakes and nix-command enabled)
+        uses: cachix/install-nix-action@v26
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+
+          # Add `nix-community`, Crane, upstream Conduit, and conduwuit binary caches
+          extra_nix_config: |
+            experimental-features = nix-command flakes
+            extra-substituters = https://nix-community.cachix.org
+            extra-trusted-public-keys = nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs=
+            extra-substituters = https://crane.cachix.org
+            extra-trusted-public-keys = crane.cachix.org-1:8Scfpmn9w+hGdXH/Q9tTLiYAE/2dnJYRJP7kl80GuRk=
+            extra-substituters = https://attic.kennel.juneis.dog/conduit
+            extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+            extra-substituters = https://attic.kennel.juneis.dog/conduwuit
+            extra-trusted-public-keys = conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+
+      - name: Add alternative Nix binary caches if specified
+        if: ${{ (env.ATTIC_ENDPOINT != '') && (env.ATTIC_PUBLIC_KEY != '') }}
+        run: |
+          echo "extra-substituters = ${{ env.ATTIC_ENDPOINT }}" >> /etc/nix/nix.conf
+          echo "extra-trusted-public-keys = ${{ env.ATTIC_PUBLIC_KEY }}" >> /etc/nix/nix.conf
+
+      - name: Pop/push Magic Nix Cache
+        uses: DeterminateSystems/magic-nix-cache-action@main
+
+      - name: Configure `nix-direnv`
+        run: |
+          echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' > "$HOME/.direnvrc"
+
+      - name: Install `direnv` and `nix-direnv`
+        run: nix-env -f "<nixpkgs>" -iA direnv -iA nix-direnv
+
+      # Do this to shorten the logs for the real CI step
+      - name: Populate `/nix/store`
+        run: nix develop --command true
+
+      - name: Allow direnv
+        run: direnv allow
+
+      - name: Cache CI dependencies
+        run: |
+          ./bin/nix-build-and-cache ci
+
+      - name: Build documentation (book)
+        run: |
+          ./bin/nix-build-and-cache just .#book
+          cp -r --dereference result public
+      - name: Upload generated documentation (book) as normal artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: public
+          path: public
+          if-no-files-found: error
+          # don't compress again
+          compression-level: 0
+
+      - name: Upload generated documentation (book) as GitHub Pages artifact
+        if: github.event_name != 'pull_request'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: public
+
+      - name: Deploy to GitHub Pages
+        if: github.event_name != 'pull_request'
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/trivy.yml

@@ -24,7 +24,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run Trivy code and vulnerability scanner on repo
-        uses: aquasecurity/trivy-action@0.18.0
+        uses: aquasecurity/trivy-action@0.19.0
         with:
           scan-type: repo
           format: sarif
@@ -32,7 +32,7 @@ jobs:
           severity: CRITICAL,HIGH,MEDIUM,LOW
 
       - name: Run Trivy code and vulnerability scanner on filesystem
-        uses: aquasecurity/trivy-action@0.18.0
+        uses: aquasecurity/trivy-action@0.19.0
         with:
           scan-type: fs
           format: sarif

.gitignore

@@ -75,5 +75,20 @@ test-conduit.toml
 # Gitlab CI cache
 /.gitlab-ci.d
 
+# mdbook output
+public/
+
 # macOS
 .DS_Store
+
+# VS Code
+.vscode/
+
+# Zed
+.zed/
+
+# idk where you're coming from, but i'm tired of you
+rustc-ice-*
+
+# complement test logs are huge
+tests/test_results/complement/test_logs.jsonl

.gitlab-ci.yml

@@ -6,6 +6,10 @@ stages:
 variables:
   # Makes some things print in color
   TERM: ansi
+  # Faster cache and artifact compression / decompression
+  FF_USE_FASTZIP: true
+  # Print progress reports for cache and artifact transfers
+  TRANSFER_METER_FREQUENCY: 5s
 
 # Avoid duplicate pipelines
 # See: https://docs.gitlab.com/ee/ci/yaml/workflow.html#switch-between-branch-pipelines-and-merge-request-pipelines
@@ -27,10 +31,6 @@ before_script:
   - if command -v nix > /dev/null; then echo "extra-substituters = https://attic.kennel.juneis.dog/conduit" >> /etc/nix/nix.conf; fi
   - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=" >> /etc/nix/nix.conf; fi
 
-  # Add upstream Conduit binary cache
-  - if command -v nix > /dev/null; then echo "extra-substituters = https://nix.computer.surgery/conduit" >> /etc/nix/nix.conf; fi
-  - if command -v nix > /dev/null; then echo "extra-trusted-public-keys = conduit:ZGAf6P6LhNvnoJJ3Me3PRg7tlLSrPxcQ2RiE5LIppjo=" >> /etc/nix/nix.conf; fi
-  
   # Add alternate binary cache
   - if command -v nix > /dev/null && [ -n "$ATTIC_ENDPOINT" ]; then echo "extra-substituters = $ATTIC_ENDPOINT" >> /etc/nix/nix.conf; fi
   - if command -v nix > /dev/null && [ -n "$ATTIC_PUBLIC_KEY" ]; then echo "extra-trusted-public-keys = $ATTIC_PUBLIC_KEY" >> /etc/nix/nix.conf; fi
@@ -54,10 +54,10 @@ before_script:
 
 ci:
   stage: ci
-  image: nixos/nix:2.21.0
+  image: nixos/nix:2.22.0
   script:
-    # Cache the inputs required for the devShell
-    - ./bin/nix-build-and-cache .#devShells.x86_64-linux.default.inputDerivation
+    # Cache CI dependencies
+    - ./bin/nix-build-and-cache ci
 
     - direnv exec . engage
   cache:
@@ -79,14 +79,14 @@ ci:
 
 artifacts:
   stage: artifacts
-  image: nixos/nix:2.21.0
+  image: nixos/nix:2.22.0
   script:
-    - ./bin/nix-build-and-cache .#static-x86_64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-x86_64-unknown-linux-musl
     - cp result/bin/conduit x86_64-unknown-linux-musl
 
     - mkdir -p target/release
     - cp result/bin/conduit target/release
-    - direnv exec . cargo deb --no-build
+    - direnv exec . cargo deb --no-build --no-strip
     - mv target/debian/*.deb x86_64-unknown-linux-musl.deb
 
     # Since the OCI image package is based on the binary package, this has the
@@ -97,14 +97,18 @@ artifacts:
     # Note that although we have an `oci-image-x86_64-unknown-linux-musl`
     # output, we don't build it because it would be largely redundant to this
     # one since it's all containerized anyway.
-    - ./bin/nix-build-and-cache .#oci-image
+    - ./bin/nix-build-and-cache just .#oci-image
     - cp result oci-image-amd64.tar.gz
 
-    - ./bin/nix-build-and-cache .#static-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#static-aarch64-unknown-linux-musl
     - cp result/bin/conduit aarch64-unknown-linux-musl
 
-    - ./bin/nix-build-and-cache .#oci-image-aarch64-unknown-linux-musl
+    - ./bin/nix-build-and-cache just .#oci-image-aarch64-unknown-linux-musl
     - cp result oci-image-arm64v8.tar.gz
+
+    - ./bin/nix-build-and-cache just .#book
+    # We can't just copy the symlink, we need to dereference it https://gitlab.com/gitlab-org/gitlab/-/issues/19746
+    - cp -r --dereference result public
   artifacts:
     paths:
       - x86_64-unknown-linux-musl
@@ -112,6 +116,7 @@ artifacts:
       - x86_64-unknown-linux-musl.deb
       - oci-image-amd64.tar.gz
       - oci-image-arm64v8.tar.gz
+      - public
   rules:
     # CI required for all MRs
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
@@ -122,45 +127,14 @@ artifacts:
     - if: $CI
   interruptible: true
 
-.push-oci-image:
+pages:
   stage: publish
-  image: docker:25.0.4
-  services:
-    - docker:25.0.4-dind
-  variables:
-    IMAGE_SUFFIX_AMD64: amd64
-    IMAGE_SUFFIX_ARM64V8: arm64v8
-  script:
-    - docker load -i oci-image-amd64.tar.gz
-    - IMAGE_ID_AMD64=$(docker images -q conduit:main)
-    - docker load -i oci-image-arm64v8.tar.gz
-    - IMAGE_ID_ARM64V8=$(docker images -q conduit:main)
-    # Tag and push the architecture specific images
-    - docker tag $IMAGE_ID_AMD64 $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64
-    - docker tag $IMAGE_ID_ARM64V8 $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker push $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64
-    - docker push $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    # Tag the multi-arch image
-    - docker manifest create $IMAGE_NAME:$CI_COMMIT_SHA --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker manifest push $IMAGE_NAME:$CI_COMMIT_SHA
-    # Tag and push the git ref
-    - docker manifest create $IMAGE_NAME:$CI_COMMIT_REF_NAME --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-    - docker manifest push $IMAGE_NAME:$CI_COMMIT_REF_NAME
-    # Tag git tags as 'latest'
-    - |
-      if [[ -n "$CI_COMMIT_TAG" ]]; then
-        docker manifest create $IMAGE_NAME:latest --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_AMD64 --amend $IMAGE_NAME:$CI_COMMIT_SHA-$IMAGE_SUFFIX_ARM64V8
-        docker manifest push $IMAGE_NAME:latest
-      fi
   dependencies:
     - artifacts
   only:
-    - main
-    - tags
-
-oci-image:push-gitlab:
-  extends: .push-oci-image
-  variables:
-    IMAGE_NAME: $CI_REGISTRY_IMAGE/conduwuit
-  before_script:
-    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - next
+  script:
+    - "true"
+  artifacts:
+    paths:
+      - public

.gitlab/route-map.yml

@@ -0,0 +1,3 @@
+# Docs: Map markdown to html files
+- source: /docs/(.+)\.md/
+  public: '\1.html'

.vscode/extensions.json

@@ -1,10 +0,0 @@
-{
-    "recommendations": [
-        "rust-lang.rust-analyzer",
-        "ms-azuretools.vscode-docker",
-        "eamodio.gitlens",
-        "serayuzgur.crates",
-        "vadimcn.vscode-lldb",
-        "timonwong.shellcheck"
-    ]
-}

.vscode/launch.json

@@ -1,35 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "lldb",
-            "request": "launch",
-            "name": "Debug conduit",
-            "sourceLanguages": ["rust"],
-            "cargo": {
-                "args": [
-                    "build",
-                    "--bin=conduit",
-                    "--package=conduit"
-                ],
-                "filter": {
-                    "name": "conduit",
-                    "kind": "bin"
-                }
-            },
-            "args": [],
-            "env": {
-                "RUST_BACKTRACE": "1",
-                "CONDUIT_CONFIG": "",
-                "CONDUIT_SERVER_NAME": "localhost",
-                "CONDUIT_DATABASE_PATH": "/tmp",
-                "CONDUIT_ADDRESS": "0.0.0.0",
-                "CONDUIT_PORT": "6167"
-            },
-            "cwd": "${workspaceFolder}"
-        }
-    ]
-}

Cargo.toml

@@ -1,61 +1,61 @@
 [package]
+# TODO: when can we rename to conduwuit?
 name = "conduit"
-description = "a cool fork of Conduit, a Matrix homeserver written in Rust"
+description = "a very cool fork of Conduit, a Matrix homeserver written in Rust"
 license = "Apache-2.0"
-authors = ["strawberry <strawberry@puppygock.gay>", "timokoesters <timo@koesters.xyz>"]
-homepage = "https://puppygock.gay/conduwuit"
-repository = "https://gitlab.com/girlbossceo/conduwuit"
+authors = [
+    "strawberry <strawberry@puppygock.gay>",
+    "timokoesters <timo@koesters.xyz>",
+]
+homepage = "https://conduwuit.puppyirl.gay/"
+repository = "https://github.com/girlbossceo/conduwuit"
 readme = "README.md"
-version = "0.7.0-alpha+conduwuit-0.1.7"
+version = "0.3.2"
 edition = "2021"
 
 # See also `rust-toolchain.toml`
-rust-version = "1.75.0"
-
+rust-version = "1.76.0"
 
 [dependencies]
+console-subscriber = { version = "0.2", optional = true }
+
+# for hot lib reload
+hot-lib-reloader = { version = "^0.7", optional = true }
+
 # Used for secure identifiers
 rand = "0.8.5"
 
 # Used for conduit::Error type
-thiserror = "1.0.58"
+thiserror = "1.0.59"
 
 # Used to encode server public key
-base64 = "0.22.0"
+base64 = "0.22.1"
 
 # Used when hashing the state
 ring = "0.17.8"
 
-# Used when querying the SRV record of other servers
-trust-dns-resolver = "0.23.2"
-
 # Used to find matching events for appservices
-regex = "1.10.3"
+regex = "1.10.4"
 
 # Used to load forbidden room/user regex from config
 serde_regex = "1.1.0"
+
+# Used to make working with iterators easier, was already a transitive depdendency
 itertools = "0.12.1"
 
 # jwt jsonwebtokens
-jsonwebtoken = "9.2.0"
-
-lru-cache = "0.1.2"
+jsonwebtoken = "9.3.0"
 
 # Used for ruma wrapper
-serde_html_form = "0.2.5"
+serde_html_form = "0.2.6"
 
 # used for TURN server authentication
 hmac = "0.12.1"
 sha-1 = "0.10.1"
 
-async-trait = "0.1.77"
-
 # used for checking if an IP is in specific subnets / CIDR ranges easier
 ipaddress = "0.1.3"
 
-# to encode/decode percent URIs when conduwuit is running without a reverse proxy
-#urlencoding = "2.1.3"
-
 # to get the client IP address of requests
 #axum-client-ip = "0.4.2"
 
@@ -64,18 +64,39 @@ cyborgtime = "2.1.1"
 
 # all the web/HTTP dependencies
 # Used for the http request / response body type for Ruma endpoints used with reqwest
-bytes = "1.5.0"
-http = "0.2.12"
+bytes = "1.6.0"
+http = "1.1.0"
+http-body-util = "0.1.1"
+
+# used to replace the channels of the tokio runtime
+loole = "0.3.0"
+
+# Validating urls in config, was already a transitive dependency
+url = { version = "2.5.0", features = ["serde"] }
+
+async-trait = "0.1.80"
+
+lru-cache = "0.1.2"
+
+# standard date and time tools
+[dependencies.chrono]
+version = "0.4.38"
+features = ["alloc"]
+default-features = false
 
 # Web framework
 [dependencies.axum]
-version = "0.6.20"
+version = "0.7.5"
 default-features = false
-features = ["form", "headers", "http1", "http2", "json", "matched-path"]
-optional = true
+features = ["form", "http1", "http2", "json", "matched-path"]
+
+[dependencies.axum-extra]
+version = "0.9.3"
+default-features = false
+features = ["typed-header"]
 
 [dependencies.axum-server]
-version = "0.5.1"
+version = "0.6.0"
 features = ["tls-rustls"]
 
 [dependencies.tower]
@@ -83,66 +104,58 @@ version = "0.4.13"
 features = ["util"]
 
 [dependencies.tower-http]
-version = "0.4.4"
+version = "0.5.2"
 features = [
-  "add-extension",
-  "cors",
-  "sensitive-headers",
-  "trace",
-  "util",
+    "add-extension",
+    "cors",
+    "sensitive-headers",
+    "trace",
+    "util",
+    "catch-panic",
 ]
 
 [dependencies.hyper]
-version = "0.14"
-features = [
-  "server",
-  "http1",
-  "http2",
-]
+version = "1.3.1"
+features = ["server", "http1", "http2"]
+
+[dependencies.hyper-util]
+version = "0.1.3"
 
 [dependencies.reqwest]
-version = "0.11.26"
+version = "0.12.4"
 default-features = false
-features = [
-  "rustls-tls-native-roots",
-  "socks",
-]
+features = ["rustls-tls-native-roots", "socks", "hickory-dns"]
 
 # all the serde stuff
 # Used for pdu definition
 [dependencies.serde]
-version = "1.0.197"
+version = "1.0.200"
 features = ["rc"]
 # Used for appservice registration files
 [dependencies.serde_yaml]
-version = "0.9.32"
+version = "0.9.34"
 # Used for ruma wrapper
 [dependencies.serde_json]
-version = "1.0.114"
+version = "1.0.116"
 features = ["raw_value"]
 
 
 # Used for password hashing
 [dependencies.argon2]
 version = "0.5.3"
-features = [
-  "alloc",
-  "rand",
-]
+features = ["alloc", "rand"]
 default-features = false
 
 # Used to generate thumbnails for images
 [dependencies.image]
-version = "0.25.0"
+version = "0.25.1"
 default-features = false
-features = [
-  "jpeg",
-  "png",
-  "gif",
-  "webp",
-]
+features = ["jpeg", "png", "gif", "webp"]
 
 # logging
+[dependencies.log]
+version = "0.4.21"
+default-features = false
 [dependencies.tracing]
 version = "0.1.40"
 default-features = false
@@ -174,12 +187,41 @@ version = "0.20.0"
 optional = true
 features = ["rt-tokio"]
 
+# optional sentry metrics for crash/panic reporting
+[dependencies.sentry]
+version = "0.32.3"
+optional = true
+default-features = false
+features = [
+    "backtrace",
+    "contexts",
+    "debug-images",
+    "panic",
+    "rustls",
+    "tower",
+    "tower-http",
+    "tracing",
+    "reqwest",
+    "log",
+]
+[dependencies.sentry-tracing]
+version = "0.32.3"
+optional = true
+[dependencies.sentry-tower]
+version = "0.32.3"
+optional = true
+
 # optional jemalloc usage
+[dependencies.tikv-jemalloc-sys]
+version = "0.5.4"
+optional = true
+default-features = false
+features = ["stats", "unprefixed_malloc_on_supported_platforms"]
 [dependencies.tikv-jemallocator]
 version = "0.5.4"
 optional = true
 default-features = false
-features = ["unprefixed_malloc_on_supported_platforms"]
+features = ["stats", "unprefixed_malloc_on_supported_platforms"]
 [dependencies.tikv-jemalloc-ctl]
 version = "0.5.4"
 optional = true
@@ -193,85 +235,81 @@ default-features = false
 
 # to support multiple variations of setting a config option
 [dependencies.either]
-version = "1.10.0"
+version = "1.11.0"
 features = ["serde"]
 
 # to listen on both HTTP and HTTPS if listening on TLS dierctly from conduwuit for complement or sytest
 [dependencies.axum-server-dual-protocol]
-version = "0.5.2"
+version = "0.6"
 optional = true
 
 # used for conduit's CLI and admin room command parsing
 [dependencies.clap]
-version = "4.5.3"
+version = "4.5.4"
 default-features = false
-features = [
-  "std",
-  "derive",
-  "help",
-  "usage",
-  "error-context",
-]
+features = ["std", "derive", "help", "usage", "error-context", "string"]
 
 [dependencies.futures-util]
 version = "0.3.30"
 default-features = false
 
-# Used for reading the configuration from conduit.toml & environment variables
+# Used for reading the configuration from conduwuit.toml & environment variables
 [dependencies.figment]
-version = "0.10.15"
-features = [
-  "env",
-  "toml",
-]
+version = "0.10.18"
+features = ["env", "toml"]
 
 # Used for matrix spec type definitions and helpers
-#ruma = { version = "0.4.0", features = ["compat", "rand", "appservice-api-c", "client-api", "federation-api", "push-gateway-api-c", "state-res", "unstable-pre-spec", "unstable-exhaustive-types"] }
-#ruma = { git = "https://github.com/ruma/ruma", rev = "4d9f754657a099df8e61533787b8eebd12946435", features = ["compat", "rand", "appservice-api-c", "client-api", "federation-api", "push-gateway-api-c", "state-res", "unstable-msc2448", "unstable-msc3575", "unstable-exhaustive-types", "ring-compat", "unstable-unspecified", "unstable-msc2870", "unstable-msc3061", "unstable-msc2867", "unstable-extensible-events"] }
-#ruma = { path = "../ruma/crates/ruma", features = ["compat", "rand", "appservice-api-c", "client-api", "federation-api", "push-gateway-api-c", "state-res", "unstable-msc2448", "unstable-msc3575", "unstable-exhaustive-types", "ring-compat", "unstable-unspecified" ] }
 [dependencies.ruma]
 git = "https://github.com/girlbossceo/ruma"
 branch = "conduwuit-changes"
 features = [
-  "compat",
-  "rand",
-  "appservice-api-c",
-  "client-api",
-  "federation-api",
-  "push-gateway-api-c",
-  "state-res",
-  "unstable-msc2448",
-  "unstable-msc3575",
-  "unstable-exhaustive-types",
-  "ring-compat",
-  "unstable-unspecified",
-  "unstable-msc2870",
-  "unstable-msc3061",
-  "unstable-msc2867",
-  "unstable-extensible-events",
+    "compat",
+    "rand",
+    "appservice-api-c",
+    "client-api",
+    "federation-api",
+    "push-gateway-api-c",
+    "state-res",
+    "unstable-exhaustive-types",
+    "ring-compat",
+    "unstable-unspecified",
+    "unstable-msc2448",
+    "unstable-msc2666",
+    "unstable-msc2867",
+    "unstable-msc2870",
+    "unstable-msc3026",
+    "unstable-msc3061",
+    "unstable-msc3575",
+    "unstable-msc4121",
+    "unstable-msc4125",
+    "unstable-extensible-events",
 ]
 
+[dependencies.ruma-identifiers-validation]
+git = "https://github.com/girlbossceo/ruma"
+branch = "conduwuit-changes"
+
+[dependencies.hickory-resolver]
+version = "0.24.1"
+default-features = false
+
 [dependencies.rust-rocksdb]
 git = "https://github.com/zaidoon1/rust-rocksdb"
-#branch = "master"
-rev = "3e4a0f632a8c0c2839c7d183725c53895110d907"
+branch = "master"
 optional = true
 default-features = true
-features = [
-    "multi-threaded-cf",
-    "zstd",
-]
+features = ["multi-threaded-cf", "zstd"]
 
 [dependencies.rusqlite]
 git = "https://github.com/rusqlite/rusqlite"
-branch = "master"
-#rev = "def8e9460d8376a5c0c9f4f9846d413a9cd4581a"
+#branch = "master"
+rev = "e00b626e2b1c67347d789fb7f600281705c89381"
 optional = true
 features = ["bundled"]
 
 # used only by rusqlite
 [dependencies.parking_lot]
-version = "0.12.1"
+version = "0.12.2"
 optional = true
 
 # used only by rusqlite
@@ -282,86 +320,150 @@ optional = true
 # used only by rusqlite and rust-rocksdb
 [dependencies.num_cpus]
 version = "1.16.0"
-optional = true
 
 [dependencies.tokio]
-version = "1.36.0"
-features = [
-  "fs",
-  "macros",
-  "sync",
-  "signal",
-]
+version = "1.37.0"
+features = ["fs", "macros", "sync", "signal"]
 
 # *nix-specific dependencies
 [target.'cfg(unix)'.dependencies]
 nix = { version = "0.28.0", features = ["resource"] }
-sd-notify = { version = "0.4.1", optional = true } # systemd is only available/relevant on *nix platforms
-hyperlocal = { git = "https://github.com/softprops/hyperlocal", rev = "2ee4d149644600d326559af0d2b235c945b05c04", features = ["server"] } # unix socket support
+sd-notify = { version = "0.4.1", optional = true }    # systemd is only available/relevant on *nix platforms
 
 
+[target.'cfg(all(not(target_env = "msvc"), target_os = "linux"))'.dependencies]
+hardened_malloc-rs = { version = "0.1.2", optional = true, features = [
+    "static",
+    "gcc",
+    "light",
+], default-features = false }
+#hardened_malloc-rs = { optional = true, features = ["static","clang","light"], path = "../hardened_malloc-rs", default-features = false }
+
+
+# backport of [https://github.com/tokio-rs/tracing/pull/2956] to the 0.1.x branch of tracing.
+# we can switch back to upstream if #2956 is merged and backported in the upstream repo.
+[patch.crates-io.tracing-subscriber]
+git = "https://github.com/girlbossceo/tracing"
+branch = "tracing-subscriber/env-filter-clone-0.1.x-backport"
+[patch.crates-io.tracing]
+git = "https://github.com/girlbossceo/tracing"
+branch = "tracing-subscriber/env-filter-clone-0.1.x-backport"
+[patch.crates-io.tracing-core]
+git = "https://github.com/girlbossceo/tracing"
+branch = "tracing-subscriber/env-filter-clone-0.1.x-backport"
 
 [features]
-default = ["conduit_bin", "backend_rocksdb", "systemd"]
-conduit_bin = ["axum"]
+default = [
+    "backend_rocksdb",
+    "systemd",
+    "element_hacks",
+    "sentry_telemetry",
+    "gzip_compression",
+    "brotli_compression",
+    "zstd_compression",
+    "release_max_log_level",
+]
 backend_sqlite = ["sqlite"]
 backend_rocksdb = ["rocksdb"]
-rocksdb = ["rust-rocksdb", "num_cpus"]
-jemalloc = ["tikv-jemalloc-ctl", "tikv-jemallocator"]
-sqlite = ["rusqlite", "parking_lot", "thread_local", "num_cpus"]
+rocksdb = ["rust-rocksdb"]
+jemalloc = [
+    "tikv-jemalloc-sys",
+    "tikv-jemalloc-ctl",
+    "tikv-jemallocator",
+    "rust-rocksdb/jemalloc",
+]
+jemalloc_prof = ["tikv-jemalloc-sys/profiling"]
+sqlite = ["rusqlite", "parking_lot", "thread_local"]
 systemd = ["sd-notify"]
+sentry_telemetry = ["sentry", "sentry-tracing", "sentry-tower"]
 
-#gzip_compression = ["tower-http/compression-gzip"]
+gzip_compression = ["tower-http/compression-gzip", "reqwest/gzip"]
 zstd_compression = ["tower-http/compression-zstd"]
-#brotli_compression = ["tower-http/compression-br"]
-#all_compression = ["tower-http/compression-full"] # all compression algos
+brotli_compression = ["tower-http/compression-br", "reqwest/brotli"]
 
 sha256_media = ["sha2"]
 io_uring = ["rust-rocksdb/io-uring"]
 axum_dual_protocol = ["axum-server-dual-protocol"]
 
-perf_measurements = ["opentelemetry", "tracing-flame", "tracing-opentelemetry", "opentelemetry_sdk", "opentelemetry-jaeger"]
+perf_measurements = [
+    "opentelemetry",
+    "tracing-flame",
+    "tracing-opentelemetry",
+    "opentelemetry_sdk",
+    "opentelemetry-jaeger",
+]
 
+# enable the tokio_console server
+# incompatible with release_max_log_level
+tokio_console = ["console-subscriber", "tokio/tracing"]
 
+hot_reload = ["dep:hot-lib-reloader"]
 
-[[bin]]
-name = "conduit"
-path = "src/main.rs"
-required-features = ["conduit_bin"]
+hardened_malloc = ["hardened_malloc-rs"]
+
+# increases performance, reduces build times, and reduces binary size by not compiling or
+# genreating code for log level filters that users will generally not use (debug and trace) only in release builds
+#
+# the expense is obviously losing those log level filters for usage at runtime. debug builds will still have all log levels
+release_max_log_level = [
+    "tracing/max_level_trace",
+    "tracing/release_max_level_info",
+    "log/max_level_trace",
+    "log/release_max_level_info",
+]
+
+# developer feature useful only in debug builds.
+dev_release_log_level = []
+
+# client/server interopability hacks
+#
+## element has various non-spec compliant behaviour
+element_hacks = []
 
-[lib]
-name = "conduit"
-path = "src/lib.rs"
 
 [package.metadata.deb]
-name = "matrix-conduit"
+name = "conduwuit"
 maintainer = "strawberry <strawberry@puppygock.gay>"
-copyright = "2024, Timo Kösters <timo@koesters.xyz>"
+copyright = "2024, strawberry <strawberry@puppygock.gay>"
 license-file = ["LICENSE", "3"]
 depends = "$auto, ca-certificates"
 extended-description = """\
-a cool fork of Conduit, a Matrix homeserver written in Rust"""
+a cool hard fork of Conduit, a Matrix homeserver written in Rust"""
 section = "net"
 priority = "optional"
 assets = [
-  ["debian/README.md", "usr/share/doc/matrix-conduit/README.Debian", "644"],
-  ["README.md", "usr/share/doc/matrix-conduit/", "644"],
-  ["target/release/conduit", "usr/sbin/matrix-conduit", "755"],
-  ["conduwuit-example.toml", "etc/matrix-conduit/conduit.toml", "640"],
-]
-conf-files = [
-  "/etc/matrix-conduit/conduit.toml"
+    [
+        "debian/README.md",
+        "usr/share/doc/conduwuit/README.Debian",
+        "644",
+    ],
+    [
+        "README.md",
+        "usr/share/doc/conduwuit/",
+        "644",
+    ],
+    [
+        "target/release/conduit",
+        "usr/sbin/conduwuit",
+        "755",
+    ],
+    [
+        "conduwuit-example.toml",
+        "etc/conduwuit/conduwuit.toml",
+        "640",
+    ],
 ]
+conf-files = ["/etc/conduwuit/conduwuit.toml"]
 maintainer-scripts = "debian/"
-systemd-units = { unit-name = "matrix-conduit" }
-
+systemd-units = { unit-name = "conduwuit" }
 
 
 [profile.dev]
-debug = 0
 lto = 'off'
 codegen-units = 512
 incremental = true
+#panic = "abort"
+
 # seems to speed up continuous debug compilations
 [profile.dev.build-override]
 opt-level = 3
@@ -375,17 +477,23 @@ opt-level = 3
 lto = 'thin'
 incremental = false
 opt-level = 3
-overflow-checks = true
 strip = "symbols"
-panic = "abort"
 control-flow-guard = true # Windows only
 debug = 0
 
+# release profile with debug symbols
+[profile.release-debuginfo]
+inherits = "release"
+strip = "none"
+debug = "full"
+
+
 # high performance release profile which uses fat LTO across all crates, 1 codegen unit, max opt-level, and optimises across all crates
 [profile.release-high-perf]
 inherits = "release"
 lto = 'fat'
 codegen-units = 1
+panic = "abort"
 
 # For releases also try to max optimizations for dependencies:
 [profile.release-high-perf.build-override]
@@ -399,17 +507,14 @@ opt-level = 3
 codegen-units = 1
 
 
-
 [lints]
 workspace = true
 
 [workspace.lints.rust]
 missing_abi = "warn"
-# missing_docs = "warn"
 noop_method_call = "warn"
 pointer_structural_match = "warn"
 explicit_outlives_requirements = "warn"
-# unreachable_pub = "warn"
 unused_extern_crates = "warn"
 unused_import_braces = "warn"
 unused_lifetimes = "warn"
@@ -420,18 +525,20 @@ elided_lifetimes_in_paths = "warn"
 macro_use_extern_crate = "warn"
 single_use_lifetimes = "warn"
 unsafe_op_in_unsafe_fn = "warn"
-
-# not in rust 1.75.0 (doesn't break CI but won't check for it)
-unit_bindings = "warn"
+unreachable_pub = "warn"
 
 # this seems to suggest broken code and is not working correctly
 unused_braces = "allow"
 
+# some sadness
+missing_docs = "allow"
+
+
 [workspace.lints.clippy]
 # pedantic = "warn"
 
 suspicious = "warn" # assume deny in practice
-perf = "warn" # assume deny in practice
+perf = "warn"       # assume deny in practice
 
 redundant_clone = "warn"
 cloned_instead_of_copied = "warn"
@@ -444,51 +551,35 @@ char_lit_as_u8 = "warn"
 dbg_macro = "warn"
 empty_structs_with_brackets = "warn"
 get_unwrap = "warn"
-# if_then_some_else_none = "warn"
-# let_underscore_must_use = "warn"
-# map_err_ignore = "warn"
-# missing_docs_in_private_items = "warn"
 negative_feature_names = "warn"
 pub_without_shorthand = "warn"
 rc_buffer = "warn"
 rc_mutex = "warn"
 redundant_feature_names = "warn"
 redundant_type_annotations = "warn"
-# ref_patterns = "warn"
 rest_pat_in_fully_bound_structs = "warn"
 str_to_string = "warn"
-# string_add = "warn"
-# string_slice = "warn"
 string_to_string = "warn"
 tests_outside_test_module = "warn"
 undocumented_unsafe_blocks = "warn"
 unneeded_field_pattern = "warn"
 unseparated_literal_suffix = "warn"
-# unwrap_used = "warn"
-# expect_used = "warn"
 wildcard_dependencies = "warn"
 or_fun_call = "warn"
 unnecessary_lazy_evaluations = "warn"
-# as_conversions = "warn"
 assertions_on_result_states = "warn"
 default_union_representation = "warn"
 deref_by_slicing = "warn"
 empty_drop = "warn"
-# error_impl_error = "warn"
 exit = "warn"
 filetype_is_file = "warn"
 float_cmp_const = "warn"
 format_push_string = "warn"
 impl_trait_in_params = "warn"
-ref_to_mut = "warn"
-# let_underscore_untyped = "warn"
 lossy_float_literal = "warn"
 mem_forget = "warn"
 missing_assert_message = "warn"
-# mod_module_files = "warn"
-# multiple_inherent_impl = "warn"
 mutex_atomic = "warn"
-# same_name_method = "warn"
 semicolon_outside_block = "warn"
 fn_to_numeric_cast = "warn"
 fn_to_numeric_cast_with_truncation = "warn"
@@ -499,11 +590,59 @@ unnecessary_safety_comment = "warn"
 unnecessary_safety_doc = "warn"
 unnecessary_self_imports = "warn"
 verbose_file_reads = "warn"
-# cast_precision_loss = "warn"
 cast_possible_wrap = "warn"
-# cast_possible_truncation = "warn"
 redundant_closure_for_method_calls = "warn"
 large_futures = "warn"
+semicolon_if_nothing_returned = "warn"
+match_bool = "warn"
+struct_excessive_bools = "warn"
+must_use_candidate = "warn"
+collapsible_else_if = "warn"
+inconsistent_struct_constructor = "warn"
+manual_string_new = "warn"
+zero_sized_map_values = "warn"
+unnecessary_box_returns = "warn"
+map_unwrap_or = "warn"
+implicit_clone = "warn"
+match_wildcard_for_single_variants = "warn"
+unnecessary_wraps = "warn"
+match_same_arms = "warn"
+ignored_unit_patterns = "warn"
+redundant_else = "warn"
+explicit_into_iter_loop = "warn"
+used_underscore_binding = "warn"
+needless_pass_by_value = "warn"
+too_many_lines = "warn"
+let_underscore_untyped = "warn"
+single_match = "warn"
+single_match_else = "warn"
+explicit_deref_methods = "warn"
+explicit_iter_loop = "warn"
+manual_let_else = "warn"
+trivially_copy_pass_by_ref = "warn"
+wildcard_imports = "warn"
+checked_conversions = "warn"
 
-# not in rust 1.75.0 (breaks CI)
-# infinite_loop = "warn"
+# some sadness
+missing_errors_doc = "allow"
+missing_panics_doc = "allow"
+module_name_repetitions = "allow"
+if_not_else = "allow"
+doc_markdown = "allow"
+cast_possible_truncation = "allow"
+cast_precision_loss = "allow"
+cast_sign_loss = "allow"
+same_name_method = "allow"
+mod_module_files = "allow"
+unwrap_used = "allow"
+expect_used = "allow"
+if_then_some_else_none = "allow"
+let_underscore_must_use = "allow"
+map_err_ignore = "allow"
+missing_docs_in_private_items = "allow"
+multiple_inherent_impl = "allow"
+error_impl_error = "allow"
+as_conversions = "allow"
+string_add = "allow"
+string_slice = "allow"
+ref_patterns = "allow"

DEPLOY.md

@@ -1,307 +0,0 @@
-# Deploying Conduit
-
-### Please note that this documentation is not fully representative of conduwuit at the moment. Assume majority of it is outdated.
-
-> ## Getting help
->
-> If you run into any problems while setting up conduwuit, ask us
-> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
-
-## Installing conduwuit
-
-You may simply download the binary that fits your machine. Run `uname -m` to see what you need.
-
-Prebuilt binaries can be downloaded from the latest successful CI workflow on the main branch here: https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml?query=branch%3Amain+actor%3Agirlbossceo
-
-```bash
-$ sudo wget -O /usr/local/bin/matrix-conduit <url>
-$ sudo chmod +x /usr/local/bin/matrix-conduit
-```
-
-Alternatively, you may compile the binary yourself. First, install any dependencies:
-
-```bash
-# Debian
-$ sudo apt install libclang-dev build-essential
-
-# RHEL
-$ sudo dnf install clang
-```
-Then, `cd` into the source tree of conduit-next and run:
-```bash
-$ cargo build --release
-```
-
-If you want to cross compile Conduit to another architecture, read the guide below.
-
-<details>
-<summary>Cross compilation</summary>
-
-As easiest way to compile conduit for another platform [cross-rs](https://github.com/cross-rs/cross) is recommended, so install it first.
-
-In order to use RockDB as storage backend append `-latomic` to linker flags.
-
-For example, to build a binary for Raspberry Pi Zero W (ARMv6) you need `arm-unknown-linux-gnueabihf` as compilation
-target.
-
-```bash
-git clone https://gitlab.com/famedly/conduit.git
-cd conduit
-export RUSTFLAGS='-C link-arg=-lgcc -Clink-arg=-latomic -Clink-arg=-static-libgcc'
-cross build --release --no-default-features --features conduit_bin,backend_rocksdb --target=arm-unknown-linux-gnueabihf
-```
-</details>
-
-## Adding a Conduit user
-
-While Conduit can run as any user it is usually better to use dedicated users for different services. This also allows
-you to make sure that the file permissions are correctly set up.
-
-In Debian or RHEL, you can use this command to create a Conduit user:
-
-```bash
-sudo adduser --system conduit --group --disabled-login --no-create-home
-```
-
-## Forwarding ports in the firewall or the router
-
-Conduit uses the ports 443 and 8448 both of which need to be open in the firewall.
-
-If Conduit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
-
-## Optional: Avoid port 8448
-
-If Conduit runs behind Cloudflare reverse proxy, which doesn't support port 8448 on free plans, [delegation](https://matrix-org.github.io/synapse/latest/delegate.html) can be set up to have federation traffic routed to port 443:
-```apache
-# .well-known delegation on Apache
-<Files "/.well-known/matrix/server">
-    ErrorDocument 200 '{"m.server": "your.server.name:443"}'
-    Header always set Content-Type application/json
-    Header always set Access-Control-Allow-Origin *
-</Files>
-```
-[SRV DNS record](https://spec.matrix.org/latest/server-server-api/#resolving-server-names) delegation is also [possible](https://www.cloudflare.com/en-gb/learning/dns/dns-records/dns-srv-record/).
-
-## Setting up a systemd service
-
-Now we'll set up a systemd service for Conduit, so it's easy to start/stop Conduit and set it to autostart when your
-server reboots. Simply paste the default systemd service you can find below into
-`/etc/systemd/system/conduit.service`.
-
-```systemd
-[Unit]
-Description=Conduit Matrix Server
-After=network.target
-
-[Service]
-Environment="CONDUIT_CONFIG=/etc/matrix-conduit/conduit.toml"
-User=conduit
-Group=conduit
-RuntimeDirectory=conduit
-RuntimeDirectoryMode=0750
-Restart=always
-ExecStart=/usr/local/bin/matrix-conduit
-
-[Install]
-WantedBy=multi-user.target
-```
-
-Finally, run
-
-```bash
-$ sudo systemctl daemon-reload
-```
-
-## Creating the Conduit configuration file
-
-Now we need to create the Conduit's config file in `/etc/conduwuit/conduwuit.toml`. Paste this in **and take a moment
-to read it. You need to change at least the server name.**  
-You can also choose to use a different database backend, but right now only `rocksdb` and `sqlite` are recommended.
-
-See the following example config at [conduwuit-example.toml](conduwuit-example.toml)
-
-## Setting the correct file permissions
-
-As we are using a Conduit specific user we need to allow it to read the config. To do that you can run this command on
-Debian or RHEL:
-
-```bash
-sudo chown -R root:root /etc/matrix-conduit
-sudo chmod 755 /etc/matrix-conduit
-```
-
-If you use the default database path you also need to run this:
-
-```bash
-sudo mkdir -p /var/lib/matrix-conduit/
-sudo chown -R conduit:conduit /var/lib/matrix-conduit/
-sudo chmod 700 /var/lib/matrix-conduit/
-```
-
-## Setting up the Reverse Proxy
-
-This depends on whether you use Apache, Caddy, Nginx or another web server.
-
-### Apache
-
-Create `/etc/apache2/sites-enabled/050-conduit.conf` and copy-and-paste this:
-
-```apache
-# Requires mod_proxy and mod_proxy_http
-#
-# On Apache instance compiled from source,
-# paste into httpd-ssl.conf or httpd.conf
-
-Listen 8448
-
-<VirtualHost *:443 *:8448>
-
-ServerName your.server.name # EDIT THIS
-
-AllowEncodedSlashes NoDecode
-
-# TCP
-ProxyPass /_matrix/ http://127.0.0.1:6167/_matrix/ timeout=300 nocanon
-ProxyPassReverse /_matrix/ http://127.0.0.1:6167/_matrix/
-
-# UNIX socket
-#ProxyPass /_matrix/ unix:/run/conduit/conduit.sock|http://127.0.0.1:6167/_matrix/ nocanon
-#ProxyPassReverse /_matrix/ unix:/run/conduit/conduit.sock|http://127.0.0.1:6167/_matrix/
-
-</VirtualHost>
-```
-
-**You need to make some edits again.** When you are done, run
-
-```bash
-# Debian
-$ sudo systemctl reload apache2
-
-# Installed from source
-$ sudo apachectl -k graceful
-```
-
-### Caddy
-
-Create `/etc/caddy/conf.d/conduit_caddyfile` and enter this (substitute for your server name).
-
-```caddy
-your.server.name, your.server.name:8448 {
-        # TCP
-        reverse_proxy /_matrix/* 127.0.0.1:6167
-
-        # UNIX socket
-        #reverse_proxy /_matrix/* unix//run/conduit/conduit.sock
-}
-```
-
-That's it! Just start or enable the service and you're set.
-
-```bash
-$ sudo systemctl enable caddy
-```
-
-### Nginx
-
-If you use Nginx and not Apache, add the following server section inside the http section of `/etc/nginx/nginx.conf`
-
-```nginx
-server {
-    listen 443 ssl http2;
-    listen [::]:443 ssl http2;
-    listen 8448 ssl http2;
-    listen [::]:8448 ssl http2;
-    server_name your.server.name; # EDIT THIS
-    merge_slashes off;
-
-    # Nginx defaults to only allow 1MB uploads
-    # Increase this to allow posting large files such as videos
-    client_max_body_size 20M;
-
-    # UNIX socket
-    #upstream backend {
-    #    server unix:/run/conduit/conduit.sock;
-    #}
-
-    location /_matrix/ {
-        # TCP
-        proxy_pass http://127.0.0.1:6167;
-
-        # UNIX socket
-        #proxy_pass http://backend;
-
-        proxy_set_header Host $http_host;
-        proxy_buffering off;
-        proxy_read_timeout 5m;
-    }
-
-    ssl_certificate /etc/letsencrypt/live/your.server.name/fullchain.pem; # EDIT THIS
-    ssl_certificate_key /etc/letsencrypt/live/your.server.name/privkey.pem; # EDIT THIS
-    ssl_trusted_certificate /etc/letsencrypt/live/your.server.name/chain.pem; # EDIT THIS
-    include /etc/letsencrypt/options-ssl-nginx.conf;
-}
-```
-
-**You need to make some edits again.** When you are done, run
-
-```bash
-$ sudo systemctl reload nginx
-```
-
-## SSL Certificate
-
-If you chose Caddy as your web proxy SSL certificates are handled automatically and you can skip this step.
-
-The easiest way to get an SSL certificate, if you don't have one already, is to [install](https://certbot.eff.org/instructions) `certbot` and run this:
-
-```bash
-# To use ECC for the private key, 
-# paste into /etc/letsencrypt/cli.ini:
-# key-type = ecdsa
-# elliptic-curve = secp384r1
-
-$ sudo certbot -d your.server.name
-```
-[Automated renewal](https://eff-certbot.readthedocs.io/en/stable/using.html#automated-renewals) is usually preconfigured.
-
-If using Cloudflare, configure instead the edge and origin certificates in dashboard. In case you’re already running a website on the same Apache server, you can just copy-and-paste the SSL configuration from your main virtual host on port 443 into the above-mentioned vhost.
-
-## You're done!
-
-Now you can start Conduit with:
-
-```bash
-$ sudo systemctl start conduit
-```
-
-Set it to start automatically when your system boots with:
-
-```bash
-$ sudo systemctl enable conduit
-```
-
-## How do I know it works?
-
-You can open <https://app.element.io>, enter your homeserver and try to register.
-
-You can also use these commands as a quick health check.
-
-```bash
-$ curl https://your.server.name/_matrix/client/versions
-
-# If using port 8448
-$ curl https://your.server.name:8448/_matrix/client/versions
-```
-
-- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
-  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
-
-# What's next?
-
-## Audio/Video calls
-
-For Audio/Video call functionality see the [TURN Guide](TURN.md).
-
-## Appservices
-
-If you want to set up an appservice, take a look at the [Appservice Guide](APPSERVICES.md).

DIFFERENCES.md

@@ -1,84 +0,0 @@
-### list of features, bug fixes, etc that conduwuit does that upstream does not:
-
-- GitLab CI ported to GitHub Actions
-- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
-- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
-- Has Renovate and significantly updates all dependencies possible
-- Uses proper argon2 crate instead of questionable rust-argon2 crate
-- Improved and cleaned up logging (less noisy dead server logging, registration attempts, more useful troubleshooting logging, etc)
-- Attempts and interest in removing extreme and unnecessary panics/unwraps/expects that can lead to denial of service or such (upstream and upstream contributors want this unusual behaviour for some reason)
-- Merged and cleaned up upstream MRs that have been sitting for 6-12 months
-- Configurable RocksDB logging (`LOG` files) with proper defaults (rotate, max size, verbosity, etc) to stop LOG files from accumulating so much
-- Federated presence support and configurable local presence (via upstream MR)
-- Concurrency support for key fetching for faster remote room joins and room joins that will error less frequently (via upstream MR)
-- Room version 11 support (via upstream MR)
-- Config option to allow guest registrations
-- Explicit startup error/warning if your configuration allows open registration without a token or such like Synapse
-- Improved RocksDB defaults to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage.
-- Updated Ruma to latest commit where possible, and add some unstable MSCs (some still require an implementation though)
-- Revamped admin room infrastructure and commands (via upstream MR)
-- Admin room commands to delete room aliases and unpublish rooms from our room directory (via upstream MR)
-- Make spaces/hierarchy cache use cache_capacity_modifier instead of hardcoded small value
-- Add *optional* feature flag to use SHA256 key names for media instead of base64 to overcome filesystem file name length limitations (OS error file name too long) (via upstream MR) 
-- Add *optional* feature flag to enable zstd HTTP body compression
-- Add support for querying both Matrix SRV records, the deprecated `_matrix` record and `_matrix-fed` record if necessary
-- Add config option for device name federation with a privacy-friendly default (disabled)
-- Add config option for requiring authentication to the `/publicRooms` endpoint (room directory) with a default enabled for privacy
-- Add config option for federating `/publicRooms` endpoint (room directory) to other servers with a default disabled for privacy
-- Add support for listening on a UNIX socket for performance and host security with proper default permissions (660)
-- Add missing `destination` key to all `X-Matrix` `Authorization` requests (spec compliance issue)
-- Use aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
-- Raise various hardcoded timeouts in codebase that were way too short, making some things like room joins and client bugs error less or none at all than they should
-- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes) (`ForceDeviceListUpdates`)
-- Declare various missing Matrix versions and features at `/_matrix/client/versions`
-- Add support for serving server and client well-known files from conduwuit using `well_known_client` and `well_known_server` options
-- Add non-standard sliding sync proxy health check (?) endpoint at `/client/server.json` that some clients such as Element Web query using the `well_known_client` or `well_known_server` config options
-- Send a User-Agent on all of our requests (`conduwuit/0.7.0-alpha+conduwuit-0.1.1`) which strangely was not done upstream since forever. Some providers consider no User-Agent suspicious and block said requests.
-- Safer and cleaner shutdowns on both database side as we run cleanup on shutdown and exits database loop better (no potential hanging issues in database loop), overall cleaner shutdown logic
-- Allow HEAD HTTP requests in CORS for clients (despite not being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need to behave the same as GET requests, Synapse supports HEAD requests)
-- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy)
-- webp support for images
-- Support for suggesting servers to join at `/_matrix/client/v3/directory/room/{roomAlias}`
-- Prevent admin credential commands like reset password and deactivate user from modifying non-local users (https://gitlab.com/famedly/conduit/-/issues/377)
-- Fixed spec compliance issue with room version 8 - 11 joins (https://github.com/matrix-org/synapse/issues/16717 / https://github.com/matrix-org/matrix-spec/issues/1708)
-- Add basic cache eviction for true destinations when requests fail if we use a cached destination (e.g. a server has modified their well-known and we're still connecting to the old destination)
-- Only follow 6 redirects total in our default reqwest ClientBuilder
-- Generate passwords with 25 characters instead of 15
-- Add missing `reason` field to user ban events (`/ban`)
-- For all [`/report`](https://spec.matrix.org/v1.9/client-server-api/#post_matrixclientv3roomsroomidreporteventid) requests: check if the reported event ID belongs to the reported room ID, raise report reasoning character limit to 750, fix broken formatting, make a small delayed random response per spec suggestion on privacy, and check if the sender user is in the reported room.
-- Support blocking servers from downloading remote media from
-- Support sending `well_known` response to client logins if using config option `well_known_client`
-- Send `avatar_url` on invite room membership events/changes
-- Revamp example config, adding a lot of config options available (still some missing)
-- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
-- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
-- Config option `ip_range_denylist` to support refusing to send requests (typically federation) to specific IP ranges, typically RFC 1918, non-routable, testnet, etc addresses like Synapse for security (note: this is not a guaranteed protection, and you should be using a firewall with zones if you want guaranteed protection as doing this on the application level is prone to bypasses).
-- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
-- Assume well-knowns are broken if they exceed past 10000 characters.
-- Basic validation/checks on user-specified room aliases and custom room ID creations
-- Warn on unknown config options specified
-- Add support for preventing certain room alias names and usernames using regex (via upstream MR) and extended to custom room IDs
-- Revamp appservice registration to ruma's `Registration` type which fixes various appservice registration issues, including fixing crashing upon no URL specified (via upstream MR)
-- URL preview support (via upstream MR) with various improvements
-- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing, and ask systemd for more time to shutdown if needed to prevent systemd's default [`TimeoutStopSec=`](https://www.freedesktop.org/software/systemd/man/latest/systemd.service.html#TimeoutStopSec=) of 90 seconds from killing conduwuit
-- Bumped default max_concurrent_requests to 500
-- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on ` /_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see https://github.com/matrix-org/matrix-spec/issues/1047)
-- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
-- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
-- Replace the lightning bolt emoji option with support for setting any arbitrary text (e.g. another emoji) to suffix to all new user registrations
-- Add admin command to bulk delete media via a codeblock list of MXC URLs.
-- Add admin command to delete both the thumbnail and media MXC URLs from an event ID (e.g. from an abuse report)
-- Add `!admin` as a way to call the Conduit admin bot
-- Add support for listening on multiple TCP ports
-- Add admin command to list all the rooms a local user is joined in
-- Add admin command to delete all remote media in the past X minutes as a form of deleting media that you don't want on your server that a remote user posted in a room
-- Config option to block non-admin users from sending room invites or receiving remote room invites. Admin users are still allowed.
-- Startup check if conduwuit running in a container and is listening on 127.0.0.1
-- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
-- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa.
-- Implement database flush and cleanup Conduit operations when using RocksDB
-- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
-- Commandline argument to specify the path to a config file
-- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline
-- Update rusqlite/sqlite (not that you should be using it)
-- Disable update check by default as it's not useful for conduwuit

README.md

@@ -1,9 +1,18 @@
 # conduwuit
-### a well maintained fork of [Conduit](https://conduit.rs/)
 
-[![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+`main` / stable: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
 
+`dev`: [![CI and Artifacts](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/girlbossceo/conduwuit/actions/workflows/ci.yml)
+
+<!-- ANCHOR: catchphrase -->
+### a very cool, featureful fork of [Conduit](https://conduit.rs/)
+<!-- ANCHOR_END: catchphrase -->
+
+Visit the [Conduwuit documentation](https://conduwuit.puppyirl.gay/) for more information.
+
+<!-- ANCHOR: body -->
 #### What is Matrix?
+
 [Matrix](https://matrix.org) is an open network for secure and decentralized
 communication. Users from every Matrix homeserver can chat with users from all
 other Matrix servers. You can even use bridges (also called Matrix Appservices)
@@ -21,40 +30,13 @@ An official conduwuit server ran by me is available at transfem.dev ([element.tr
 
 #### What is the current status?
 
-conduwuit is a fork of Conduit which is in beta, meaning you can join and participate in most
+conduwuit is a hard fork of Conduit which is in beta, meaning you can join and participate in most
 Matrix rooms, but not all features are supported and you might run into bugs
 from time to time.
 
-There are still a few nice to have features missing that some users may notice:
-
-- Outgoing read receipts and typing indicators (receiving works)
-
-#### What's different about your fork than upstream Conduit?
-
-See [DIFFERENCES.md](DIFFERENCES.md)
-
-#### Why does this fork exist? Why don't you contribute back upstream?
-
-I now intend on contributing back as time and mental energy sees fit, but my fork still exists as a way to:
-- avoid unnecessary Matrix and general developer politics
-- avoid bikeshedding unnecessary or irrelevant things in upstream MRs
-- Fast tracked bug fixes, performance improvements, security improvements, and new features
-- Have early access to MRs that may not be suitable/acceptable for Conduit (e.g. too niche, too advanced for general users, only being blocked due to pending on contributor actions that we can fix ourselves downstream, pending Matrix spec stuff, etc)
-- Support unspecced or WIP features
-- Have official support for other OS's like Windows, macOS, and BSD.
-- Have a **stable** testing ground for some MRs or new features and bug fixes
-
-And various other reasons that may not be listed here.
-
-#### How can I deploy my own?
-
-conduwuit officially supports Linux, macOS, BSD, and Windows.
-
-- Simple install (this was tested the most): [DEPLOY.md](DEPLOY.md)
-- Nix/NixOS (and binary cache): [nix/README.md](nix/README.md)
-
-If you want to connect an Appservice to Conduit, take a look at [APPSERVICES.md](APPSERVICES.md).
+<!-- ANCHOR_END: body -->
 
+<!-- ANCHOR: footer -->
 #### How can I contribute?
 
 1. Look for an issue you would like to work on and make sure it's not assigned
@@ -72,22 +54,23 @@ If you run into any question, feel free to
 
 #### Donate
 
-Liberapay: <https://liberapay.com/girlbossceo>\
-Ko-fi: <https://ko-fi.com/puppygock>\
-GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
+- Liberapay: <https://liberapay.com/girlbossceo>
+- Ko-fi: <https://ko-fi.com/puppygock>
+- GitHub Sponsors: <https://github.com/sponsors/girlbossceo>
 
 #### Logo
 
-No official conduwuit logo exists. Repo and Matrix room picture is from bran (<3).
+Original repo and Matrix room picture was from bran (<3). Current banner image and logo is directly from [this cohost post](https://cohost.org/RatBaby/post/1028290-finally-a-flag-for).
 
 #### Is it conduwuit or Conduwuit?
 
-Both.
+Both, but I prefer conduwuit.
 
 #### Mirrors of conduwuit
 
-GitHub: <https://github.com/girlbossceo/conduwuit>\
-GitLab: <https://gitlab.com/girlbossceo/conduwuit>\
-git.gay: <https://git.gay/june/conduwuit>\
-Codeberg: <https://codeberg.org/girlbossceo/conduwuit>\
-sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit>
+- GitHub: <https://github.com/girlbossceo/conduwuit>
+- GitLab: <https://gitlab.com/girlbossceo/conduwuit>
+- git.gay: <https://git.gay/june/conduwuit>
+- Codeberg: <https://codeberg.org/girlbossceo/conduwuit>
+- sourcehut: <https://git.sr.ht/~girlbossceo/conduwuit>
+<!-- ANCHOR_END: footer -->

audit.toml

@@ -0,0 +1,2 @@
+[advisories]
+ignore = ["RUSTSEC-2020-0016"]

bin/complement

@@ -3,6 +3,10 @@
 set -euo pipefail
 
 # Path to Complement's source code
+#
+# The `COMPLEMENT_SRC` environment variable is set in the Nix dev shell, which
+# points to a store path containing the Complement source code. It's likely you
+# want to just pass that as the first argument to use it here.
 COMPLEMENT_SRC="$1"
 
 # A `.jsonl` file to write test logs to
@@ -13,25 +17,30 @@ RESULTS_FILE="$3"
 
 OCI_IMAGE="complement-conduit:dev"
 
-env \
-    -C "$(git rev-parse --show-toplevel)" \
-    docker build \
-        --tag "$OCI_IMAGE" \
-        --file complement/Dockerfile \
-        .
+toplevel="$(git rev-parse --show-toplevel)"
+
+pushd "$toplevel" > /dev/null
+# uses nix-output-monitor (nom) if available
+if command -v nom &> /dev/null; then
+    nom build .#complement
+else
+    nix build -L .#complement
+fi
+docker load < result
+popd > /dev/null
 
 # It's okay (likely, even) that `go test` exits nonzero
 set +o pipefail
 env \
     -C "$COMPLEMENT_SRC" \
     COMPLEMENT_BASE_IMAGE="$OCI_IMAGE" \
-    go test -json ./tests | tee "$LOG_FILE"
+    go test -vet=off -timeout 1h -json ./tests | tee "$LOG_FILE"
 set -o pipefail
 
-# Post-process the results into an easy-to-compare format
-cat "$LOG_FILE" | jq -c '
+# Post-process the results into an easy-to-compare format, sorted by Test name for reproducible results
+cat "$LOG_FILE" | jq -s -c 'sort_by(.Test)[]' | jq -c '
     select(
         (.Action == "pass" or .Action == "fail" or .Action == "skip")
         and .Test != null
     ) | {Action: .Action, Test: .Test}
-    ' | sort > "$RESULTS_FILE"
+    ' > "$RESULTS_FILE"

bin/nix-build-and-cache

@@ -1,41 +1,82 @@
 #!/usr/bin/env bash
 
-set -euo pipefail
+set -eo pipefail
 
-# The first argument must be the desired installable
-INSTALLABLE="$1"
+toplevel="$(git rev-parse --show-toplevel)"
 
-# Build the installable and forward any other arguments too
-nix build -L "$@"
+# Build just the single installable and forward any other arguments too
+just() {
+    # uses nix-output-monitor (nom) if available
+    if command -v nom &> /dev/null; then
+        nom build "$@"
+    else
+        nix build -L "$@"
+    fi
 
-if [ ! -z "$ATTIC_TOKEN" ]; then
-    nix run --inputs-from . attic -- \
-        login \
-        conduit \
-        "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduit}" \
-        "$ATTIC_TOKEN"
+    if [ ! -z "$ATTIC_TOKEN" ]; then
+        # historical "conduit" store for compatibility purposes, same as conduwuit
+        nix run --inputs-from "$toplevel" attic -- \
+            login \
+            conduit \
+            "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduit}" \
+            "$ATTIC_TOKEN"
 
-    # Push the target installable and its build dependencies
-    nix run --inputs-from . attic -- \
-        push \
-        conduit \
-        "$(nix path-info "$INSTALLABLE" --derivation)" \
-        "$(nix path-info "$INSTALLABLE")"
+        readarray -t outputs < <(nix path-info "$@")
+        readarray -t derivations < <(nix path-info "$@" --derivation)
+
+        # Push the target installable and its build dependencies
+        nix run --inputs-from "$toplevel" attic -- \
+            push \
+            conduit \
+            "${outputs[@]}" \
+            "${derivations[@]}"
+
+        # main "conduwuit" store
+        nix run --inputs-from "$toplevel" attic -- \
+            login \
+            conduwuit \
+            "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
+            "$ATTIC_TOKEN"
+
+        # Push the target installable and its build dependencies
+        nix run --inputs-from "$toplevel" attic -- \
+            push \
+            conduwuit \
+            "${outputs[@]}" \
+            "${derivations[@]}"
+    else
+        echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
+    fi
+
+}
+
+# Build and cache things needed for CI
+ci() {
+    cache=(
+        --inputs-from "$toplevel"
+
+        # Keep sorted
+        "$toplevel#devShells.x86_64-linux.default.inputDerivation"
+        attic#default
+        nixpkgs#direnv
+        nixpkgs#jq
+        nixpkgs#nix-direnv
+    )
+
+    just "${cache[@]}"
+}
+
+# Build and cache *all* the package outputs from the flake.nix
+packages() {
+    declare -a cache="($(
+        nix flake show --json 2> /dev/null |
+            nix run --inputs-from "$toplevel" nixpkgs#jq -- \
+            -r \
+            '.packages."x86_64-linux" | keys | map("'"$toplevel"'#" + .) | @sh'
+    ))"
+
+    just "${cache[@]}"
+}
 
 
-    # push to "conduwuit" too
-    nix run --inputs-from . attic -- \
-        login \
-        conduwuit \
-        "${ATTIC_ENDPOINT:-https://attic.kennel.juneis.dog/conduwuit}" \
-        "$ATTIC_TOKEN"
-
-    # Push the target installable and its build dependencies
-    nix run --inputs-from . attic -- \
-        push \
-        conduwuit \
-        "$(nix path-info "$INSTALLABLE" --derivation)" \
-        "$(nix path-info "$INSTALLABLE")"
-else
-    echo "\$ATTIC_TOKEN is unset, skipping uploading to the binary cache"
-fi
+eval "$@"

book.toml

@@ -0,0 +1,18 @@
+[book]
+title = "conduwuit"
+description = "conduwuit, which is a well-maintained fork of Conduit, is a simple, fast and reliable chat server for the Matrix protocol"
+language = "en"
+multilingual = false
+src = "docs"
+
+[build]
+build-dir = "public"
+create-missing = true
+
+[output.html]
+git-repository-url = "https://github.com/girlbossceo/conduwuit"
+edit-url-template = "https://github.com/girlbossceo/conduwuit/edit/main/{path}"
+git-repository-icon = "fa-github-square"
+
+[output.html.search]
+limit-results = 15

clippy.toml

@@ -0,0 +1 @@
+too-many-lines-threshold = 700

complement/Dockerfile

@@ -1,64 +0,0 @@
-FROM rust:1.75.0
-
-WORKDIR /workdir
-
-RUN apt-get update && apt-get install -y --no-install-recommends \
-    libclang-dev
-
-COPY Cargo.toml Cargo.toml
-COPY Cargo.lock Cargo.lock
-COPY src src
-RUN cargo build --release --features=axum_dual_protocol \
-    && mv target/release/conduit conduit \
-    && rm -rf target
-
-COPY conduwuit-example.toml conduit.toml
-
-ENV SERVER_NAME=localhost
-ENV CONDUIT_CONFIG=/workdir/conduit.toml
-
-RUN sed -i "s/port = 6167/port = [8448, 8008]/g" conduit.toml
-RUN sed -i "s/allow_registration = false/allow_registration = true/g" conduit.toml
-RUN sed -i "s/registration_token/#registration_token/g" conduit.toml
-RUN sed -i "s/allow_guest_registration = false/allow_guest_registration = true/g" conduit.toml
-RUN sed -i "s/allow_public_room_directory_over_federation = false/allow_public_room_directory_over_federation = true/g" conduit.toml
-RUN sed -i "s/allow_public_room_directory_without_auth = false/allow_public_room_directory_without_auth = true/g" conduit.toml
-RUN sed -i "s/allow_device_name_federation = false/allow_device_name_federation = true/g" conduit.toml
-RUN sed -i "/\"127.0.0.0/d" conduit.toml
-RUN sed -i "/\"10.0.0.0/d" conduit.toml
-RUN sed -i "/\"172.16.0.0/d" conduit.toml
-RUN sed -i "/\"::1/d" conduit.toml
-RUN sed -i "s/#log = \"warn\"/log = \"debug\"/g" conduit.toml
-RUN sed -i 's/#\strusted_servers\s=\s\["matrix.org"\]/trusted_servers = []/g' conduit.toml
-RUN sed -i 's/# `yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse` to/yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true/g' conduit.toml
-RUN sed -i "s/allow_outgoing_presence = false/allow_outgoing_presence = true/g" conduit.toml
-RUN sed -i "s/allow_incoming_presence = false/allow_incoming_presence = true/g" conduit.toml
-RUN sed -i "s/allow_local_presence = false/allow_local_presence = true/g" conduit.toml
-RUN sed -i "s/address = \"127.0.0.1\"/address = \"0.0.0.0\"/g" conduit.toml
-
-# https://stackoverflow.com/questions/76049656/unexpected-notvalidforname-with-rusts-tonic-with-tls
-RUN echo "authorityKeyIdentifier=keyid,issuer" >> extensions.ext
-RUN echo "basicConstraints=CA:FALSE" >> extensions.ext
-RUN echo 'subjectAltName = @alt_names' >> extensions.ext
-RUN echo '[alt_names]' >> extensions.ext
-RUN echo "DNS.1 = servername" >> extensions.ext
-RUN echo "IP.1 = ipaddress" >> extensions.ext
-
-
-EXPOSE 8008 8448
-
-CMD uname -a && \
-    cp -f -v /complement/ca/ca.crt /usr/local/share/ca-certificates/complement.crt && \
-    update-ca-certificates && \
-    sed -i "s/servername/${SERVER_NAME}/g" extensions.ext && \
-    sed -i "s/ipaddress/`hostname -i`/g" extensions.ext && \
-    openssl req -newkey rsa:2048 -noenc -subj "/C=US/ST=CA/O=MyOrg, Inc./CN=$SERVER_NAME" -keyout $SERVER_NAME.key -out $SERVER_NAME.csr && \
-    openssl x509 -signkey $SERVER_NAME.key -in $SERVER_NAME.csr -req -days 2 -out $SERVER_NAME.crt && \
-    openssl x509 -req -CA /complement/ca/ca.crt -CAkey /complement/ca/ca.key -in $SERVER_NAME.csr -out $SERVER_NAME.crt -days 2 -CAcreateserial -extfile extensions.ext && \
-    sed -i "s/#server_name = \"your.server.name\"/server_name = \"${SERVER_NAME}\"/g" conduit.toml && \
-    sed -i 's/#\s\[global.tls\]/\[global.tls\]/g' conduit.toml && \
-    sed -i "s/# certs = \"\/path\/to\/my\/certificate.crt\"/certs = \"${SERVER_NAME}.crt\"/g" conduit.toml && \
-    sed -i "s/# key = \"\/path\/to\/my\/private_key.key\"/key = \"${SERVER_NAME}.key\"/g" conduit.toml && \
-    sed -i "s/#dual_protocol = false/dual_protocol = true/g" conduit.toml && \
-    /workdir/conduit
-

complement/README.md

@@ -1,12 +0,0 @@
-# Complement
-
-## What's that?
-
-Have a look at [its repository](https://github.com/matrix-org/complement).
-
-## How do I use it with Conduit?
-
-The script at [`../bin/complement`](../bin/complement) has automation for this.
-It takes a few command line arguments, you can read the script to find out what
-those are.
-

conduwuit-example.toml

@@ -2,6 +2,8 @@
 #  This is the official example config for conduwuit.
 #  If you use it for your server, you will need to adjust it to your own needs.
 #  At the very least, change the server_name field!
+#
+#  This documentation can also be found at https://conduwuit.puppyirl.gay/configuration.html
 # =============================================================================
 
 [global]
@@ -32,6 +34,28 @@
 # Defaults to `matrix.org`
 # trusted_servers = ["matrix.org"]
 
+# Sentry.io crash/panic reporting, performance monitoring/metrics, etc. This is NOT enabled by default.
+# conduwuit's default Sentry reporting endpoint is o4506996327251968.ingest.us.sentry.io
+#
+# Defaults to *false*
+#sentry = false
+
+# Sentry reporting URL if a custom one is desired
+#
+# Defaults to conduwuit's default Sentry endpoint: "https://fe2eb4536aa04949e28eff3128d64757@o4506996327251968.ingest.us.sentry.io/4506996334657536"
+#sentry_endpoint = ""
+
+# Report your Conduwuit server_name in Sentry.io crash reports and metrics
+#
+# Defaults to false
+#sentry_send_server_name = false
+
+# Performance monitoring/tracing sample rate for Sentry.io
+#
+# Note that too high values may impact performance, and can be disabled by setting it to 0.0
+#
+# Defaults to 0.15
+#sentry_traces_sample_rate = 0.15
 
 
 ### Database configuration
@@ -45,7 +69,6 @@ database_path = "/var/lib/matrix-conduit/"
 database_backend = "rocksdb"
 
 
-
 ### Network
 
 # The port(s) conduwuit will be running on. You need to set up a reverse proxy such as
@@ -57,24 +80,9 @@ port = 6167
 
 # default address (IPv4 or IPv6) conduwuit will listen on. Generally you want this to be
 # localhost (127.0.0.1 / ::1). If you are using Docker or a container NAT networking setup, you
-# likely need this to be 0.0.0.0. 
+# likely need this to be 0.0.0.0.
 address = "127.0.0.1"
 
-# How many requests conduwuit sends to other servers at the same time concurrently. Default is 500
-# Note that because conduwuit is very fast unlike other homeserver implementations, setting this too
-# high could inadvertently result in ratelimits kicking in, or overloading lower-end homeservers out there.
-#
-# A valid use-case for enabling this is if you have a significant amount of overall federation activity
-# such as many rooms joined/tracked, and many servers in the true destination cache caused by that. Upon
-# rebooting conduwuit, depending on how fast your resources are, client and incoming federation requests
-# may timeout or be "stalled" for a period of time due to hitting the max concurrent requests limit from
-# refreshing federation/destination caches and such.
-#
-# If you have a lot of active users on your homeserver, you will definitely need to raise this.
-#
-# No this will not speed up room joins.
-#max_concurrent_requests = 500
-
 # Max request size for file uploads
 max_request_size = 20_000_000 # in bytes
 
@@ -86,11 +94,25 @@ max_request_size = 20_000_000 # in bytes
 
 # Set this to true for conduwuit to compress HTTP response bodies using zstd.
 # This option does nothing if conduwuit was not built with `zstd_compression` feature.
-# Please be aware that enabling HTTP compression may weaken or even defeat TLS.
+# Please be aware that enabling HTTP compression may weaken TLS.
 # Most users should not need to enable this.
 # See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
 zstd_compression = false
 
+# Set this to true for conduwuit to compress HTTP response bodies using gzip.
+# This option does nothing if conduwuit was not built with `gzip_compression` feature.
+# Please be aware that enabling HTTP compression may weaken TLS.
+# Most users should not need to enable this.
+# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
+gzip_compression = false
+
+# Set this to true for conduwuit to compress HTTP response bodies using brotli.
+# This option does nothing if conduwuit was not built with `brotli_compression` feature.
+# Please be aware that enabling HTTP compression may weaken TLS.
+# Most users should not need to enable this.
+# See https://breachattack.com/ and https://wikipedia.org/wiki/BREACH before deciding to enable this.
+brotli_compression = false
+
 # Vector list of IPv4 and IPv6 CIDR ranges / subnets *in quotes* that you do not want conduwuit to send outbound requests to.
 # Defaults to RFC1918, unroutable, loopback, multicast, and testnet addresses for security.
 #
@@ -121,13 +143,20 @@ ip_range_denylist = [
 ]
 
 
-
 ### Moderation / Privacy / Security
 
 # Set to true to allow user type "guest" registrations. Element attempts to register guest users automatically.
-# For private homeservers, this is best at false.
+# Defaults to false
 allow_guest_registration = false
 
+# Set to true to log guest registrations in the admin room.
+# Defaults to false as it may be noisy or unnecessary.
+log_guest_registrations = false
+
+# Set to true to allow guest registrations/users to auto join any rooms specified in `auto_join_rooms`
+# Defaults to false
+allow_guests_auto_join_rooms = false
+
 # Vector list of servers that conduwuit will refuse to download remote media from.
 # No default.
 # prevent_media_downloads_from = ["example.com", "example.local"]
@@ -161,7 +190,28 @@ registration_token = "change this token for something specific to your server"
 # controls whether non-admin local users are forbidden from sending room invites (local and remote),
 # and if non-admin users can receive remote room invites. admins are always allowed to send and receive all room invites.
 # defaults to false
-# block_non_admin_invites = falsse
+# block_non_admin_invites = false
+
+# List of forbidden username patterns/strings. Values in this list are matched as *contains*.
+# This is checked upon username availability check, registration, and startup as warnings if any local users in your database
+# have a forbidden username.
+# No default.
+# forbidden_usernames = []
+
+# List of forbidden room aliases and room IDs as patterns/strings. Values in this list are matched as *contains*.
+# This is checked upon room alias creation, custom room ID creation if used, and startup as warnings if any room aliases
+# in your database have a forbidden room alias/ID.
+# No default.
+# forbidden_alias_names = []
+
+# List of forbidden server names that we will block all client room joins, incoming federated room directory requests, incoming federated invites for, and incoming federated joins. This check is applied on the room ID, room alias, sender server name, and sender user's server name.
+# Basically "global" ACLs. For our user (client) checks, admin users are allowed.
+# No default.
+# forbidden_remote_server_names = []
+
+# List of forbidden server names that we will block all outgoing federated room directory requests for. Useful for preventing our users from wandering into bad servers or spaces.
+# No default.
+# forbidden_remote_room_directory_server_names = []
 
 # Set this to true to allow your server's public room directory to be federated.
 # Set this to false to protect against /publicRooms spiders, but will forbid external users
@@ -173,6 +223,12 @@ allow_public_room_directory_over_federation = false
 # authentication (access token) through the Client APIs. Set this to false to protect against /publicRooms spiders.
 allow_public_room_directory_without_auth = false
 
+# Set this to true to lock down your server's public room directory and only allow admins to publish rooms to the room directory.
+# Unpublishing is still allowed by all users with this enabled.
+#
+# Defaults to false
+lockdown_public_room_directory = false
+
 # Set this to true to allow federating device display names / allow external users to see your device display name.
 # If federation is disabled entirely (`allow_federation`), this is inherently false. For privacy, this is best disabled.
 allow_device_name_federation = false
@@ -183,7 +239,7 @@ allow_device_name_federation = false
 url_preview_domain_contains_allowlist = []
 
 # Vector list of explicit domains allowed to send requests to for URL previews. Defaults to none.
-# Note: This is an *explicit* match, not a ccontains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
+# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
 # Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
 url_preview_domain_explicit_allowlist = []
 
@@ -192,22 +248,38 @@ url_preview_domain_explicit_allowlist = []
 # Setting this to "*" will allow all URL previews. Please note that this opens up significant attack surface to your server, you are expected to be aware of the risks by doing so.
 url_preview_url_contains_allowlist = []
 
-# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 1MB (1_000_000 bytes)
-url_preview_max_spider_size = 1_000_000
+# Vector list of explicit domains not allowed to send requests to for URL previews. Defaults to none.
+# Note: This is an *explicit* match, not a contains match. Putting "google.com" will match "https://google.com", "http://google.com", but not "https://mymaliciousdomainexamplegoogle.com"
+# The denylist is checked first before allowlist. Setting this to "*" will not do anything.
+url_preview_domain_explicit_denylist = []
+
+# Maximum amount of bytes allowed in a URL preview body size when spidering. Defaults to 384KB (384_000 bytes)
+url_preview_max_spider_size = 384_000
 
 # Option to decide whether you would like to run the domain allowlist checks (contains and explicit) on the root domain or not. Does not apply to URL contains allowlist. Defaults to false.
 # Example: If this is enabled and you have "wikipedia.org" allowed in the explicit and/or contains domain allowlist, it will allow all subdomains under "wikipedia.org" such as "en.m.wikipedia.org" as the root domain is checked and matched.
 # Useful if the domain contains allowlist is still too broad for you but you still want to allow all the subdomains under a root domain.
 url_preview_check_root_domain = false
 
+# Config option to allow or disallow incoming federation requests that obtain the profiles
+# of our local users from `/_matrix/federation/v1/query/profile`
+#
+# This is inherently false if `allow_federation` is disabled
+#
+# Defaults to true
+allow_profile_lookup_federation_requests = true
 
 
 ### Misc
 
 # max log level for conduwuit. allows debug, info, warn, or error
 # see also: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
-# Defaults to "warn"
-#log = "warn"
+# **Caveat**:
+# For release builds, the tracing crate is configured to only implement levels higher than error to avoid unnecessary overhead in the compiled binary from trace macros.
+# For debug builds, this restriction is not applied.
+#
+# Defaults to "info"
+#log = "info"
 
 # controls whether encrypted rooms and events are allowed (default true)
 #allow_encryption = false
@@ -218,12 +290,6 @@ url_preview_check_root_domain = false
 # Defaults to false.
 #allow_check_for_updates = false
 
-# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
-# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
-#well_known_server = "matrix.example.com:443"
-#well_known_client = "https://matrix.example.com"
-# Note that whatever you put will show up in the well-known JSON values.
-
 # Set to false to disable users from joining or creating room versions that aren't 100% officially supported by conduwuit.
 # conduwuit officially supports room versions 6 - 10. conduwuit has experimental/unstable support for 3 - 5, and 11.
 # Defaults to true.
@@ -251,7 +317,37 @@ url_preview_check_root_domain = false
 # Defaults to true as this is the fastest option for federation.
 #query_trusted_key_servers_first = true
 
+# List/vector of room **IDs** that conduwuit will make newly registered users join.
+# The room IDs specified must be rooms that you have joined at least once on the server, and must be public.
+#
+# No default.
+#auto_join_rooms = []
 
+# Retry failed and incomplete messages to remote servers immediately upon startup. This is called bursting.
+# If this is disabled, said messages may not be delivered until more messages are queued for that server.
+# Do not change this option unless server resources are extremely limited or the scale of the server's
+# deployment is huge. Do not disable this unless you know what you are doing.
+#startup_netburst = true
+
+# Limit the startup netburst to the most recent (default: 50) messages queued for each remote server. All older
+# messages are dropped and not reattempted. The `startup_netburst` option must be enabled for this value to have
+# any effect. Do not change this value unless you know what you are doing. Set this value to -1 to reattempt
+# every message without trimming the queues; this may consume significant disk. Set this value to 0 to drop all
+# messages without any attempt at redelivery.
+#startup_netburst_keep = 50
+
+# If the 'perf_measurements' feature is enabled, enables collecting folded stack trace profile of tracing spans using
+# tracing_flame. The resulting profile can be visualized with inferno[1], speedscope[2], or a number of other tools.
+# [1]: https://github.com/jonhoo/inferno
+# [2]: www.speedscope.app
+# tracing_flame = false
+
+# If 'tracing_flame' is enabled, sets a filter for which events will be included in the profile.
+# Supported syntax is documented at https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives
+# tracing_flame_filter = "trace,h2=off"
+
+# If 'tracing_flame' is enabled, set the path to write the generated profile.
+# tracing_flame_output_path = "./tracing.folded"
 
 ### Generic database options
 
@@ -262,8 +358,8 @@ url_preview_check_root_domain = false
 
 # Set this to any float value in megabytes for conduwuit to tell the database engine that this much memory is available for database-related caches.
 # May be useful if you have significant memory to spare to increase performance.
-# Defaults to 300.0
-#db_cache_capacity_mb = 300.0
+# Defaults to 256.0
+#db_cache_capacity_mb = 256.0
 
 # Interval in seconds when conduwuit will run database cleanup operations.
 #
@@ -275,7 +371,6 @@ url_preview_check_root_domain = false
 #cleanup_second_interval = 1800
 
 
-
 ### RocksDB options
 
 # Set this to true to use RocksDB config options that are tailored to HDDs (slower device storage)
@@ -289,6 +384,10 @@ url_preview_check_root_domain = false
 # Defaults to false
 #rocksdb_optimize_for_spinning_disks = false
 
+# Enables direct-io to increase database performance. This is enabled by default. Set this option to false if the
+# database resides on a filesystem which does not support direct-io.
+#rocksdb_direct_io = true
+
 # RocksDB log level. This is not the same as conduwuit's log level. This is the log level for the RocksDB engine/library
 # which show up in your database folder/path as `LOG` files. Defaults to error. conduwuit will typically log RocksDB errors as normal.
 #rocksdb_log_level = "error"
@@ -299,22 +398,31 @@ url_preview_check_root_domain = false
 # Time in seconds before RocksDB will forcibly rotate logs. Defaults to 0.
 #rocksdb_log_time_to_roll = 0
 
-# Amount of threads that RocksDB will use for parallelism. Set to 0 to use all your physical cores.
-# Conduit eagerly spawns threads mainly for federation, so it may not be desirable to use all your cores / logical threads.
+# Amount of threads that RocksDB will use for parallelism on database operatons such as cleanup, sync, flush, compaction, etc. Set to 0 to use all your logical threads.
 #
-# Defaults to your CPU physical core count (not logical threads) count divided by 2 (half)
+# Defaults to your CPU logical thread count.
 #rocksdb_parallelism_threads = 0
 
+# Enables idle IO priority for compaction thread. This prevents any unexpected lag in the server's operation and
+# is usually a good idea. Enabled by default.
+#rocksdb_compaction_ioprio_idle = true
+
+# Enables idle CPU priority for compaction thread. This is not enabled by default to prevent compaction from
+# falling too far behind on busy systems.
+#rocksdb_compaction_prio_idle = false
+
 # Maximum number of LOG files RocksDB will keep. This must *not* be set to 0. It must be at least 1.
 # Defaults to 3 as these are not very useful.
 #rocksdb_max_log_files = 3
 
 # Type of RocksDB database compression to use.
-# Available options are "zstd", "zlib", "bz2" and "lz4"
+# Available options are "zstd", "zlib", "bz2", "lz4", or "none"
 # It is best to use ZSTD as an overall good balance between speed/performance, storage, IO amplification, and CPU usage.
 # For more performance but less compression (more storage used) and less CPU usage, use LZ4.
 # See https://github.com/facebook/rocksdb/wiki/Compression for more details.
 #
+# "none" will disable compression.
+#
 # Defaults to "zstd"
 #rocksdb_compression_algo = "zstd"
 
@@ -343,29 +451,220 @@ url_preview_check_root_domain = false
 # Defaults to false as this uses more CPU when compressing.
 #rocksdb_bottommost_compression = false
 
+# Database recovery mode (for RocksDB WAL corruption)
+#
+# Use this option when the server reports corruption and refuses to start. Set mode 2 (PointInTime)
+# to cleanly recover from this corruption. The server will continue from the last good state,
+# several seconds or minutes prior to the crash. Clients may have to run "clear-cache & reload" to
+# account for the rollback. Upon success, you may reset the mode back to default and restart again.
+# Please note in some cases the corruption error may not be cleared for at least 30 minutes of
+# operation in PointInTime mode.
+#
+# As a very last ditch effort, if PointInTime does not fix or resolve anything, you can try mode
+# 3 (SkipAnyCorruptedRecord) but this will leave the server in a potentially inconsistent state.
+#
+# The default mode 1 (TolerateCorruptedTailRecords) will automatically drop the last entry in the
+# database if corrupted during shutdown, but nothing more. It is extraordinarily unlikely this will
+# desynchronize clients. To disable any form of silent rollback set mode 0 (AbsoluteConsistency).
+#
+# The options are:
+# 0 = AbsoluteConsistency
+# 1 = TolerateCorruptedTailRecords (default)
+# 2 = PointInTime (use me if trying to recover)
+# 3 = SkipAnyCorruptedRecord (you now voided your Conduwuit warranty)
+#
+# See https://github.com/facebook/rocksdb/wiki/WAL-Recovery-Modes for more information
+#
+# Defaults to 1 (TolerateCorruptedTailRecords)
+#rocksdb_recovery_mode = 1
+
+# Controls whether memory buffers are written to storage at the fixed interval set by `cleanup_period_interval`
+# even when they are not full. Setting this will increase load on the storage backplane and is never advised
+# under normal circumstances.
+#rocksdb_periodic_cleanup = false
 
 
-### Presence
+### Domain Name Resolution and Caching
 
-# Config option to control local (your server only) presence updates/requests. Defaults to false.
+# Maximum entries stored in DNS memory-cache. The size of an entry may vary so please take care if
+# raising this value excessively. Only decrease this when using an external DNS cache. Please note
+# that systemd does *not* count as an external cache, even when configured to do so.
+#dns_cache_entries = 32768
+
+# Minimum time-to-live in seconds for entries in the DNS cache. The default may appear high to most
+# administrators; this is by design. Only decrease this if you are using an external DNS cache.
+#dns_min_ttl = 10800
+
+# Minimum time-to-live in seconds for NXDOMAIN entries in the DNS cache. This value is critical for
+# the server to federate efficiently. NXDOMAIN's are assumed to not be returning to the federation
+# and aggressively cached rather than constantly rechecked.
+#
+# Defaults to 3 days as these are *very rarely* false negatives.
+#dns_min_ttl_nxdomain = 259200
+
+# The number of seconds to wait for a reply to a DNS query. Please note that recursive queries can
+# take up to several seconds for some domains, so this value should not be too low.
+#dns_timeout = 10
+
+# Number of retries after a timeout.
+#dns_attempts = 10
+
+# Fallback to TCP on DNS errors. Set this to false if unsupported by nameserver.
+#dns_tcp_fallback = true
+
+# Enable to query all nameservers until the domain is found. Referred to as "trust_negative_responses" in hickory_resolver.
+# This can avoid useless DNS queries if the first nameserver responds with NXDOMAIN or an empty NOERROR response.
+#
+# The default is to query one nameserver and stop (false).
+#query_all_nameservers = true
+
+# Enables using *only* TCP for querying your specified nameservers instead of UDP.
+#
+# You very likely do *not* want this. hickory-resolver already falls back to TCP on UDP errors.
+# Defaults to false
+#query_over_tcp_only = false
+
+# DNS A/AAAA record lookup strategy
+#
+# Takes a number of one of the following options:
+# 1 - Ipv4Only (Only query for A records, no AAAA/IPv6)
+# 2 - Ipv6Only (Only query for AAAA records, no A/IPv4)
+# 3 - Ipv4AndIpv6 (Query for A and AAAA records in parallel, uses whatever returns a successful response first)
+# 4 - Ipv6thenIpv4 (Query for AAAA record, if that fails then query the A record)
+# 5 - Ipv4thenIpv6 (Query for A record, if that fails then query the AAAA record)
+#
+# If you don't have IPv6 networking, then for better performance it may be suitable to set this to Ipv4Only (1) as
+# you will never ever use the AAAA record contents even if the AAAA record is successful instead of the A record.
+#
+# Defaults to 5 - Ipv4ThenIpv6 as this is the most compatible and IPv4 networking is currently the most prevalent.
+#ip_lookup_strategy = 5
+
+
+### Request Timeouts, Connection Timeouts, and Connection Pooling
+
+## Request Timeouts are HTTP response timeouts
+## Connection Timeouts are TCP connection timeouts
+##
+## Connection Pooling Timeouts are timeouts for keeping an open idle connection alive.
+## Connection pooling and keepalive is very useful for federation or other places where for performance reasons,
+## we want to keep connections open that we will re-use frequently due to TCP and TLS 1.3 overhead/expensiveness.
+##
+## Generally these defaults are the best, but if you find a reason to need to change these they are here.
+
+# Default/base connection timeout.
+# This is used only by URL previews and update/news endpoint checks
+#
+# Defaults to 10 seconds
+#request_conn_timeout = 10
+
+# Default/base request timeout. The time waiting to receive more data from another server.
+# This is used only by URL previews, update/news, and misc endpoint checks
+#
+# Defaults to 35 seconds
+#request_timeout = 35
+
+# Default/base request total timeout. The time limit for a whole request. This is set very high to not
+# cancel healthy requests while serving as a backstop.
+# This is used only by URL previews and update/news endpoint checks
+#
+# Defaults to 320 seconds
+#request_total_timeout = 320
+
+# Default/base idle connection pool timeout
+# This is used only by URL previews and update/news endpoint checks
+#
+# Defaults to 5 seconds
+#request_idle_timeout = 5
+
+# Default/base max idle connections per host
+# This is used only by URL previews and update/news endpoint checks
+#
+# Defaults to 1 as generally the same open connection can be re-used
+#request_idle_per_host = 1
+
+# Federation well-known resolution connection timeout
+#
+# Defaults to 6 seconds
+#well_known_conn_timeout = 6
+
+# Federation HTTP well-known resolution request timeout
+#
+# Defaults to 10 seconds
+#well_known_timeout = 10
+
+# Federation client request timeout
+# You most definitely want this to be high to account for extremely large room joins, slow homeservers, your own resources etc.
+#
+# Defaults to 300 seconds
+#federation_timeout = 300
+
+# Federation client idle connection pool timeout
+#
+# Defaults to 25 seconds
+#federation_idle_timeout = 25
+
+# Federation client max idle connections per host
+#
+# Defaults to 1 as generally the same open connection can be re-used
+#federation_idle_per_host = 1
+
+# Federation sender request timeout
+# The time it takes for the remote server to process sent transactions can take a while.
+#
+# Defaults to 180 seconds
+#sender_timeout = 180
+
+# Federation sender idle connection pool timeout
+#
+# Defaults to 180 seconds
+#sender_idle_timeout = 180
+
+# Federation sender transaction retry backoff limit
+#
+# Defaults to 86400 seconds
+#sender_retry_backoff_limit = 86400
+
+# Appservice URL request connection timeout
+#
+# Defaults to 35 seconds as generally appservices are hosted within the same network
+#appservice_timeout = 35
+
+# Appservice URL idle connection pool timeout
+#
+# Defaults to 300 seconds
+#appservice_idle_timeout = 300
+
+# Notification gateway pusher idle connection pool timeout
+#
+# Defaults to 15 seconds
+#pusher_idle_timeout = 15
+
+
+### Presence / Typing Indicators / Read Receipts
+
+# Config option to control local (your server only) presence updates/requests. Defaults to true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
 # If using outgoing presence, this MUST be enabled.
-#allow_local_presence = false
+#
+#allow_local_presence = true
 
-# Config option to control incoming federated presence updates/requests. Defaults to false.
+# Config option to control incoming federated presence updates/requests. Defaults to true.
 # This option receives presence updates from other servers, but does not send any unless `allow_outgoing_presence` is true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
-#allow_incoming_presence = false
+#
+#allow_incoming_presence = true
 
-# Config option to control outgoing presence updates/requests. Defaults to false.
+# Config option to control outgoing presence updates/requests. Defaults to true.
 # This option sends presence updates to other servers, but does not receive any unless `allow_incoming_presence` is true.
 # Note that presence on conduwuit is very fast unlike Synapse's.
 # If using outgoing presence, you MUST enable `allow_local_presence` as well.
 #
-# Warning: Outgoing federated presence is not spec compliant due to relying on PDUs and EDUs combined.
-# Outgoing presence will not be very reliable due to this and any issues with federated outgoing presence are very likely attributed to this issue.
-# Incoming presence and local presence are unaffected.
-#allow_outgoing_presence = false
+#allow_outgoing_presence = true
+
+# Config option to enable the presence idle timer for remote users. Disabling is offered as an optimization for
+# servers participating in many large rooms or when resources are limited. Disabling it may cause incorrect
+# presence states (i.e. stuck online) to be seen for some remote users. Defaults to true.
+#presence_timeout_remote_users = true
 
 # Config option to control how many seconds before presence updates that you are idle. Defaults to 5 minutes.
 #presence_idle_timeout_s = 300
@@ -373,6 +672,29 @@ url_preview_check_root_domain = false
 # Config option to control how many seconds before presence updates that you are offline. Defaults to 30 minutes.
 #presence_offline_timeout_s = 1800
 
+# Config option to control whether we should receive remote incoming read receipts.
+# Defaults to true.
+#allow_incoming_read_receipts = true
+
+# Config option to control whether we should send read receipts to remote servers.
+# Defaults to true.
+#allow_outgoing_read_receipts = true
+
+# Config option to control outgoing typing updates to federation. Defaults to true.
+#allow_outgoing_typing = true
+
+# Config option to control incoming typing updates from federation. Defaults to true.
+#allow_incoming_typing = true
+
+# Config option to control maximum time federation user can indicate typing.
+#typing_federation_timeout_s = 30
+
+# Config option to control minimum time local client can indicate typing. This does not override
+# a client's request to stop typing. It only enforces a minimum value in case of no stop request.
+#typing_client_timeout_min_s = 15
+
+# Config option to control maximum time local client can indicate typing.
+#typing_client_timeout_max_s = 45
 
 
 # Other options not in [global]:
@@ -387,4 +709,21 @@ url_preview_check_root_domain = false
 # Whether to listen and allow for HTTP and HTTPS connections (insecure!)
 # This config option is only available if conduwuit was built with `axum_dual_protocol` feature (not default feature)
 # Defaults to false
-#dual_protocol = false
+#dual_protocol = false
+
+
+# If you are using delegation via well-known files and you cannot serve them from your reverse proxy, you can
+# uncomment these to serve them directly from conduwuit. This requires proxying all requests to conduwuit, not just `/_matrix` to work.
+#
+#[global.well_known]
+#server = "matrix.example.com:443"
+#client = "https://matrix.example.com"
+#
+# A single contact and/or support page for /.well-known/matrix/support
+# All options here are strings. Currently only supports 1 single contact.
+# No default.
+#
+#support_page = ""
+#support_role = ""
+#support_email = ""
+#support_mxid = ""

debian/README.md

@@ -5,7 +5,7 @@ Installation
 ------------
 
 Information about downloading, building and deploying the Debian package, see
-the "Installing Conduit" section in [DEPLOY.md](../DEPLOY.md).
+the "Installing conduwuit" section in the Deploying docs.
 All following sections until "Setting up the Reverse Proxy" be ignored because
 this is handled automatically by the packaging.
 
@@ -14,24 +14,21 @@ Configuration
 
 When installed, Debconf generates the configuration of the homeserver
 (host)name, the address and port it listens on. This configuration ends up in
-`/etc/matrix-conduit/conduit.toml`.
+`/etc/conduwuit/conduwuit.toml`.
 
 You can tweak more detailed settings by uncommenting and setting the variables
-in `/etc/matrix-conduit/conduit.toml`. This involves settings such as the maximum
+in `/etc/conduwuit/conduwuit.toml`. This involves settings such as the maximum
 file size for download/upload, enabling federation, etc.
 
 Running
 -------
 
-The package uses the `matrix-conduit.service` systemd unit file to start and
-stop Conduit. It loads the configuration file mentioned above to set up the
+The package uses the `conduwuit.service` systemd unit file to start and
+stop conduwuit. It loads the configuration file mentioned above to set up the
 environment before running the server.
 
-This package assumes by default that Conduit will be placed behind a reverse
-proxy such as Apache or nginx. This default deployment entails just listening
+This package assumes by default that conduwuit will be placed behind a reverse
+proxy. This default deployment entails just listening
 on `127.0.0.1` and the free port `6167` and is reachable via a client using the URL
-<http://localhost:6167>.
-
-At a later stage this packaging may support also setting up TLS and running
-stand-alone.  In this case, however, you need to set up some certificates and
-renewal, for it to work properly.
+<http://localhost:6167>. Matrix federation requires TLS, so you will need to set up
+some certificates and renewal, for it to work properly.

debian/conduwuit.service

@@ -4,8 +4,8 @@ After=network-online.target
 
 [Service]
 DynamicUser=yes
-User=_matrix-conduit
-Group=_matrix-conduit
+User=_conduwuit
+Group=_conduwuit
 Type=notify
 
 AmbientCapabilities=
@@ -36,17 +36,17 @@ RestrictNamespaces=yes
 RestrictRealtime=yes
 RestrictSUIDSGID=yes
 SystemCallArchitectures=native
-SystemCallFilter=@system-service
-SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @resources @privileged @keyring @ipc
+SystemCallFilter=@system-service @resources
+SystemCallFilter=~@clock @debug @module @mount @reboot @swap @cpu-emulation @obsolete @timer @chown @setuid @privileged @keyring @ipc
 SystemCallErrorNumber=EPERM
 StateDirectory=matrix-conduit
 
 RuntimeDirectory=conduit
 RuntimeDirectoryMode=0750
 
-Environment="CONDUIT_CONFIG=/etc/matrix-conduit/conduit.toml"
+Environment="CONDUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
 
-ExecStart=/usr/sbin/matrix-conduit
+ExecStart=/usr/sbin/conduwuit
 Restart=on-failure
 RestartSec=5
 

debian/config

@@ -5,13 +5,13 @@ set -e
 . /usr/share/debconf/confmodule
 
 # Ask for the Matrix homeserver name, address and port.
-db_input high matrix-conduit/hostname || true
+db_input high conduwuit/hostname || true
 db_go
 
-db_input low matrix-conduit/address || true
+db_input low conduwuit/address || true
 db_go
 
-db_input medium matrix-conduit/port || true
+db_input medium conduwuit/port || true
 db_go
 
 exit 0

debian/postinst

@@ -3,26 +3,26 @@ set -e
 
 . /usr/share/debconf/confmodule
 
-CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit/
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit/
 
 case "$1" in
   configure)
-    # Create the `_matrix-conduit` user if it does not exist yet.
-    if ! getent passwd _matrix-conduit > /dev/null ; then
-      echo 'Adding system user for the Conduwuit Matrix homeserver' 1>&2
+    # Create the `_conduwuit` user if it does not exist yet.
+    if ! getent passwd _conduwuit > /dev/null ; then
+      echo 'Adding system user for the conduwuit Matrix homeserver' 1>&2
       adduser --system --group --quiet \
-        --home "$CONDUIT_DATABASE_PATH" \
+        --home "$CONDUWUIT_DATABASE_PATH" \
         --disabled-login \
         --shell "/usr/sbin/nologin" \
         --force-badname \
-        _matrix-conduit
+        _conduwuit
     fi
 
     # Create the database path if it does not exist yet and fix up ownership
     # and permissions.
-    mkdir -p "$CONDUIT_DATABASE_PATH"
-    chown _matrix-conduit:_matrix-conduit -R "$CONDUIT_DATABASE_PATH"
-    chmod 700 "$CONDUIT_DATABASE_PATH"
+    mkdir -p "$CONDUWUIT_DATABASE_PATH"
+    chown _conduwuit:_conduwuit -R "$CONDUWUIT_DATABASE_PATH"
+    chmod 700 "$CONDUWUIT_DATABASE_PATH"
     ;;
 esac
 

debian/postrm

@@ -3,8 +3,8 @@ set -e
 
 . /usr/share/debconf/confmodule
 
-CONDUIT_CONFIG_PATH=/etc/matrix-conduit
-CONDUIT_DATABASE_PATH=/var/lib/matrix-conduit
+CONDUWUIT_CONFIG_PATH=/etc/conduwuit
+CONDUWUIT_DATABASE_PATH=/var/lib/conduwuit
 
 case $1 in
   purge)
@@ -14,12 +14,12 @@ case $1 in
     # Per https://www.debian.org/doc/debian-policy/ch-files.html#behavior
     # "configuration files must be preserved when the package is removed, and
     #  only deleted when the package is purged."
-    if [ -d "$CONDUIT_CONFIG_PATH" ]; then
-      rm -r "$CONDUIT_CONFIG_PATH"
+    if [ -d "$CONDUWUIT_CONFIG_PATH" ]; then
+      rm -r "$CONDUWUIT_CONFIG_PATH"
     fi
 
-    if [ -d "$CONDUIT_DATABASE_PATH" ]; then
-      rm -r "$CONDUIT_DATABASE_PATH"
+    if [ -d "$CONDUWUIT_DATABASE_PATH" ]; then
+      rm -r "$CONDUWUIT_DATABASE_PATH"
     fi
     ;;
 esac

debian/templates

@@ -1,4 +1,4 @@
-Template: matrix-conduit/hostname
+Template: conduwuit/hostname
 Type: string
 Default: localhost
 Description: The server (host)name of the Matrix homeserver
@@ -7,14 +7,14 @@ Description: The server (host)name of the Matrix homeserver
  If set to "localhost", you can connect with a client locally and clients
  from other hosts and also other homeservers will not be able to reach you!
 
-Template: matrix-conduit/address
+Template: conduwuit/address
 Type: string
 Default: 127.0.0.1
 Description: The listen address of the Matrix homeserver
  This is the address the homeserver will listen on. Leave it set to 127.0.0.1
  when using a reverse proxy.
 
-Template: matrix-conduit/port
+Template: conduwuit/port
 Type: string
 Default: 6167
 Description: The port of the Matrix homeserver

docker/healthcheck.sh

@@ -1,19 +0,0 @@
-#!/bin/sh
-
-# If the config file does not contain a default port and the CONDUIT_PORT env is not set, create
-# try to get port from process list
-if [ -z "${CONDUIT_PORT}" ]; then
-  CONDUIT_PORT=$(ss -tlpn | grep conduit | grep -m1 -o ':[0-9]*' | grep -m1 -o '[0-9]*')
-fi
-
-# If CONDUIT_ADDRESS is not set try to get the address from the process list
-if [ -z "${CONDUIT_ADDRESS}" ]; then
-  CONDUIT_ADDRESS=$(ss -tlpn | awk -F ' +|:' '/conduit/ { print $4 }')
-fi
-
-# The actual health check.
-# We try to first get a response on HTTP and when that fails on HTTPS and when that fails, we exit with code 1.
-# TODO: Change this to a single wget call. Do we have a config value that we can check for that?
-wget --no-verbose --tries=1 --spider "http://${CONDUIT_ADDRESS}:${CONDUIT_PORT}/_matrix/client/versions" || \
-    wget --no-verbose --tries=1 --spider "https://${CONDUIT_ADDRESS}:${CONDUIT_PORT}/_matrix/client/versions" || \
-    exit 1

docs/SUMMARY.md

@@ -0,0 +1,15 @@
+# Summary
+
+- [Introduction](introduction.md)
+- [Differences from upstream Conduit](differences.md)
+
+- [Example configuration](configuration.md)
+- [Deploying](deploying.md)
+    - [Generic](deploying/generic.md)
+    - [Debian](deploying/debian.md)
+    - [Docker](deploying/docker.md)
+    - [NixOS](deploying/nixos.md)
+- [TURN](turn.md)
+- [Appservices](appservices.md)
+- [Development](development.md)
+    - [Testing](development/testing.md)

docs/appservices.md

@@ -2,7 +2,7 @@
 
 ## Getting help
 
-If you run into any problems while setting up an Appservice, write an email to `timo@koesters.xyz`, ask us in [#conduit:fachschaften.org](https://matrix.to/#/#conduit:fachschaften.org) or [open an issue on GitLab](https://gitlab.com/famedly/conduit/-/issues/new).
+If you run into any problems while setting up an Appservice: ask us in [#conduwuit:puppygock.gay](https://matrix.to/#/#conduwuit:puppygock.gay) or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
 
 ## Set up the appservice - general instructions
 
@@ -31,9 +31,9 @@ the room like this:
     ```
 
 You can confirm it worked by sending a message like this:
-`@conduit:your.server.name: list-appservices`
+`@conduit:your.server.name: appservices list`
 
-The @conduit bot should answer with `Appservices (1): your-bridge`
+The `@conduit` bot should answer with `Appservices (1): your-bridge`
 
 Then you are done. Conduit will send messages to the appservices and the
 appservice can send requests to the homeserver. You don't need to restart
@@ -46,9 +46,9 @@ could help.
 
 To remove an appservice go to your admin room and execute
 
-`@conduit:your.server.name: unregister-appservice <name>`
+`@conduit:your.server.name: appservices unregister <name>`
 
-where `<name>` one of the output of `list-appservices`.
+where `<name>` one of the output of `appservices list`.
 
 ### Tested appservices
 

docs/configuration.md

@@ -0,0 +1,5 @@
+# Example configuration
+
+``` toml
+{{#include ../conduwuit-example.toml}}
+```

docs/deploying.md

@@ -0,0 +1,3 @@
+# Deploying
+
+This chapter describes various ways to deploy Conduwuit.

docs/deploying/debian.md

@@ -0,0 +1 @@
+{{#include ../../debian/README.md}}

docs/deploying/docker-compose.for-traefik.yml

@@ -7,8 +7,8 @@ services:
         ### then you are ready to go.
         image: girlbossceo/conduwuit:latest
         ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker-compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker-compose up -d
+        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
+        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
         # build:
         #     context: .
         #     args:
@@ -32,7 +32,6 @@ services:
             CONDUIT_ALLOW_FEDERATION: 'true'
             CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
             CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUIT_MAX_CONCURRENT_REQUESTS: 100
             #CONDUIT_LOG: warn,state_res=warn
             CONDUIT_ADDRESS: 0.0.0.0
             #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above
@@ -40,7 +39,7 @@ services:
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose override file.
+    # and in the docker compose override file.
     well-known:
         image: nginx:latest
         restart: unless-stopped

docs/deploying/docker-compose.override.yml

@@ -18,7 +18,7 @@ services:
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose file.
+    # and in the docker compose file.
     well-known:
         labels:
             - "traefik.enable=true"

docs/deploying/docker-compose.with-traefik.yml

@@ -7,8 +7,8 @@ services:
         ### then you are ready to go.
         image: girlbossceo/conduwuit:latest
         ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker-compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker-compose up -d
+        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
+        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
         # build:
         #     context: .
         #     args:
@@ -43,7 +43,7 @@ services:
 
     # We need some way to server the client and server .well-known json. The simplest way is to use a nginx container
     # to serve those two as static files. If you want to use a different way, delete or comment the below service, here
-    # and in the docker-compose override file.
+    # and in the docker compose override file.
     well-known:
         image: nginx:latest
         restart: unless-stopped
@@ -94,4 +94,4 @@ volumes:
     acme:
 
 networks:
-    proxy:
+    proxy:

docs/deploying/docker-compose.yml

@@ -7,8 +7,8 @@ services:
         ### then you are ready to go.
         image: girlbossceo/conduwuit:latest
         ### If you want to build a fresh image from the sources, then comment the image line and uncomment the
-        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker-compose like this:
-        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker-compose up -d
+        ### build lines. If you want meaningful labels in your built Conduit image, you should run docker compose like this:
+        ### CREATED=$(date -u +'%Y-%m-%dT%H:%M:%SZ') VERSION=$(grep -m1 -o '[0-9].[0-9].[0-9]' Cargo.toml) docker compose up -d
         # build:
         #     context: .
         #     args:
@@ -32,7 +32,6 @@ services:
             CONDUIT_ALLOW_FEDERATION: 'true'
             CONDUIT_ALLOW_CHECK_FOR_UPDATES: 'true'
             CONDUIT_TRUSTED_SERVERS: '["matrix.org"]'
-            #CONDUIT_MAX_CONCURRENT_REQUESTS: 400
             #CONDUIT_LOG: warn,state_res=warn
             CONDUIT_ADDRESS: 0.0.0.0
             #CONDUIT_CONFIG: './conduwuit.toml' # Uncomment if you mapped config toml above

docs/deploying/docker.md

@@ -1,6 +1,4 @@
-# Deploy using Docker
-
-> **Note:** To run and use Conduit you should probably use it with a Domain or Subdomain behind a reverse proxy (like Nginx, Traefik, Apache, ...) with a Lets Encrypt certificate.
+# conduwuit for Docker
 
 ## Docker
 
@@ -9,72 +7,60 @@ To run conduwuit with Docker you can either build the image yourself or pull it
 
 ### Use a registry
 
-OCI images for conduwuit are available in the registries listed below. We recommend using the image tagged as `latest` from GitLab's own registry.
+OCI images for conduwuit are available in the registries listed below.
 
 | Registry        | Image                                                           | Size                          | Notes                  |
 | --------------- | --------------------------------------------------------------- | ----------------------------- | ---------------------- |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable image.          |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable image.          |
-| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    | Development version.   |
-| Docker Hub      | [docker.io/girlbossceo/conduwuit:main][dh]               | ![Image Size][shield-main]    | Development version.   |
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:latest][gh] | ![Image Size][shield-latest]  | Stable tagged image.          |
+| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:latest][gl] | ![Image Size][shield-latest]  | Stable tagged image.          |
+| Docker Hub      | [docker.io/girlbossceo/conduwuit:latest][dh]             | ![Image Size][shield-latest]  | Stable tagged image.          |
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:main][gh]   | ![Image Size][shield-main]    | Stable main branch.   |
+| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:main][gl]   | ![Image Size][shield-main]    | Stable main branch.   |
+| Docker Hub      | [docker.io/girlbossceo/conduwuit:main][dh]               | ![Image Size][shield-main]    | Stable main branch.   |
+| GitHub Registry | [ghcr.io/girlbossceo/conduwuit:dev][gh]   | ![Image Size][shield-dev]    | Development version/branch.   |
+| GitLab Registry | [registry.gitlab.com/girlbossceo/conduwuit:dev][gl]   | ![Image Size][shield-dev]    | Development version/branch.   |
+| Docker Hub      | [docker.io/girlbossceo/conduwuit:dev][dh]               | ![Image Size][shield-dev]    | Development version/branch.   |
 
 
 [dh]: https://hub.docker.com/repository/docker/girlbossceo/conduwuit
 [gh]: https://github.com/girlbossceo/conduwuit/pkgs/container/conduwuit
+[gl]: https://gitlab.com/girlbossceo/conduwuit/container_registry/6351657
 [shield-latest]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/latest
 [shield-main]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/main
+[shield-dev]: https://img.shields.io/docker/image-size/girlbossceo/conduwuit/dev
 
 
-Use 
+Use
 ```bash
 docker image pull <link>
 ```
 to pull it to your machine.
 
 
-
-### Build using a dockerfile
-
-The Dockerfile provided by Conduit has two stages, each of which creates an image.
-
-1. **Builder:** Builds the binary from local context or by cloning a git revision from the official repository.
-2. **Runner:** Copies the built binary from **Builder** and sets up the runtime environment, like creating a volume to persist the database and applying the correct permissions.
-
-To build the image you can use the following command
-
-```bash
-docker build --tag girlbossceo/conduwuit:main .
-```
-
-which also will tag the resulting image as `girlbossceo/conduwuit:main`.
-
-
-
 ### Run
 
 When you have the image you can simply run it with
 
 ```bash
 docker run -d -p 8448:6167 \
-  -v db:/var/lib/matrix-conduit/ \
+  -v db:/var/lib/conduwuit/ \
   -e CONDUIT_SERVER_NAME="your.server.name" \
   -e CONDUIT_DATABASE_BACKEND="rocksdb" \
-  -e CONDUIT_ALLOW_REGISTRATION=true \
+  -e CONDUIT_ALLOW_REGISTRATION=false \
   -e CONDUIT_ALLOW_FEDERATION=true \
-  -e CONDUIT_MAX_REQUEST_SIZE="20000000" \
+  -e CONDUIT_MAX_REQUEST_SIZE="40000000" \
   -e CONDUIT_TRUSTED_SERVERS="[\"matrix.org\"]" \
-  -e CONDUIT_MAX_CONCURRENT_REQUESTS="500" \
   -e CONDUIT_LOG="warn,ruma_state_res=warn" \
   --name conduit <link>
 ```
 
-or you can use [docker-compose](#docker-compose).
+or you can use [docker compose](#docker-compose).
 
-The `-d` flag lets the container run in detached mode. You now need to supply a `conduit.toml` config file, an example can be found [here](../conduwuit-example.toml).
-You can pass in different env vars to change config values on the fly. You can even configure Conduit completely by using env vars, but for that you need
-to pass `-e CONDUIT_CONFIG=""` into your container. For an overview of possible values, please take a look at the `docker-compose.yml` file.
+The `-d` flag lets the container run in detached mode. You may supply an optional `conduwuit.toml` config file, an example can be found [here](../configuration.md).
+You can pass in different env vars to change config values on the fly. You can even configure conduwuit completely by using env vars. For an overview of possible
+values, please take a look at the `docker-compose.yml` file.
 
-If you just want to test Conduit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
+If you just want to test conduwuit for a short time, you can use the `--rm` flag, which will clean up everything related to your container after you stop it.
 
 ### Docker-compose
 
@@ -89,14 +75,14 @@ When picking the traefik-related compose file, rename it so it matches `docker-c
 rename the override file to `docker-compose.override.yml`. Edit the latter with the values you want
 for your server.
 
-Additional info about deploying Conduit can be found [here](../DEPLOY.md).
+Additional info about deploying conduwuit can be found [here](generic.md).
 
 ### Build
 
-To build the Conduit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker-compose with:
+To build the conduwuit image with docker-compose, you first need to open and modify the `docker-compose.yml` file. There you need to comment the `image:` option and uncomment the `build:` option. Then call docker compose with:
 
 ```bash
-docker-compose up
+docker compose up
 ```
 
 This will also start the container right afterwards, so if want it to run in detached mode, you also should use the `-d` flag.
@@ -106,7 +92,7 @@ This will also start the container right afterwards, so if want it to run in det
 If you already have built the image or want to use one from the registries, you can just start the container and everything else in the compose file in detached mode with:
 
 ```bash
-docker-compose up -d
+docker compose up -d
 ```
 
 > **Note:** Don't forget to modify and adjust the compose file to your needs.
@@ -118,9 +104,9 @@ containerized app and services available through the web. With the two provided
 [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and
 [`docker-compose.override.yml`](docker-compose.override.yml), it is equally easy to deploy
-and use Conduit, with a little caveat. If you already took a look at the files, then you should have
+and use conduwuit, with a little caveat. If you already took a look at the files, then you should have
 seen the `well-known` service, and that is the little caveat. Traefik is simply a proxy and
-loadbalancer and is not able to serve any kind of content, but for Conduit to federate, we need to
+loadbalancer and is not able to serve any kind of content, but for conduwuit to federate, we need to
 either expose ports `443` and `8448` or serve two endpoints `.well-known/matrix/client` and
 `.well-known/matrix/server`.
 
@@ -131,7 +117,7 @@ So...step by step:
 1. Copy [`docker-compose.for-traefik.yml`](docker-compose.for-traefik.yml) (or
 [`docker-compose.with-traefik.yml`](docker-compose.with-traefik.yml)) and [`docker-compose.override.yml`](docker-compose.override.yml) from the repository and remove `.for-traefik` (or `.with-traefik`) from the filename.
 2. Open both files and modify/adjust them to your needs. Meaning, change the `CONDUIT_SERVER_NAME` and the volume host mappings according to your needs.
-3. Create the `conduit.toml` config file, an example can be found [here](../conduwuit-example.toml), or set `CONDUIT_CONFIG=""` and configure Conduit per env vars.
+3. Create the `conduwuit.toml` config file, an example can be found [here](../configuration.md), or set `CONDUIT_CONFIG=""` and configure conduwuit per env vars.
 4. Uncomment the `element-web` service if you want to host your own Element Web Client and create a `element_config.json`.
 5. Create the files needed by the `well-known` service.
 
@@ -159,7 +145,7 @@ So...step by step:
      }
      ```
 
-6. Run `docker-compose up -d`
+6. Run `docker compose up -d`
 7. Connect to your homeserver with your preferred client and create a user. You should do this immediately after starting Conduit, because the first created user is the admin.
 
 
@@ -167,7 +153,7 @@ So...step by step:
 
 ## Voice communication
 
-In order to make or receive calls, a TURN server is required. Conduit suggests using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also available as a Docker image. Before proceeding with the software installation, it is essential to have the necessary configurations in place.
+In order to make or receive calls, a TURN server is required. conduwuit suggests using [Coturn](https://github.com/coturn/coturn) for this purpose, which is also available as a Docker image. Before proceeding with the software installation, it is essential to have the necessary configurations in place.
 
 ### Configuration
 
@@ -180,7 +166,7 @@ realm=<your server domain>
 ```
 A common way to generate a suitable alphanumeric secret key is by using `pwgen -s 64 1`.
 
-These same values need to be set in conduit. You can either modify conduit.toml to include these lines:
+These same values need to be set in conduwuit. You can either modify conduwuit.toml to include these lines:
 ```
 turn_uris = ["turn:<your server domain>?transport=udp", "turn:<your server domain>?transport=tcp"]
 turn_secret = "<secret key from coturn configuration>"
@@ -193,13 +179,13 @@ CONDUIT_TURN_SECRET: "<secret key from coturn configuration>"
 Restart Conduit to apply these changes.
 
 ### Run
-Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using 
+Run the [Coturn](https://hub.docker.com/r/coturn/coturn) image using
 ```bash
 docker run -d --network=host -v $(pwd)/coturn.conf:/etc/coturn/turnserver.conf coturn/coturn
 ```
 
 or docker-compose. For the latter, paste the following section into a file called `docker-compose.yml`
-and run `docker-compose up -d` in the same directory.
+and run `docker compose up -d` in the same directory.
 
 ```yml
 version: 3
@@ -215,4 +201,3 @@ services:
 
 To understand why the host networking mode is used and explore alternative configuration options, please visit the following link: https://github.com/coturn/coturn/blob/master/docker/coturn/README.md.
 For security recommendations see Synapse's [Coturn documentation](https://github.com/matrix-org/synapse/blob/develop/docs/setup/turn/coturn.md#configuration).
-

docs/deploying/generic.md

@@ -0,0 +1,165 @@
+# Generic deployment documentation
+
+### Please note that this documentation is not fully representative of conduwuit at the moment. Assume majority of it is outdated.
+
+> ## Getting help
+>
+> If you run into any problems while setting up conduwuit, ask us
+> in `#conduwuit:puppygock.gay` or [open an issue on GitHub](https://github.com/girlbossceo/conduwuit/issues/new).
+
+## Installing conduwuit
+
+You may simply download the binary that fits your machine. Run `uname -m` to see what you need.
+
+Prebuilt binaries can be downloaded from the latest tagged release [here](https://github.com/girlbossceo/conduwuit/releases/latest).
+
+Alternatively, you may compile the binary yourself. First, install any dependencies:
+
+```bash
+# Debian
+$ sudo apt install libclang-dev build-essential
+
+# RHEL
+$ sudo dnf install clang
+```
+Then, `cd` into the source tree of conduwuit and run:
+```bash
+$ cargo build --release
+```
+
+## Adding a conduwuit user
+
+While conduwuit can run as any user it is usually better to use dedicated users for different services. This also allows
+you to make sure that the file permissions are correctly set up.
+
+In Debian or RHEL, you can use this command to create a conduwuit user:
+
+```bash
+sudo adduser --system conduwuit --group --disabled-login --no-create-home
+```
+
+## Forwarding ports in the firewall or the router
+
+conduwuit uses the ports 443 and 8448 both of which need to be open in the firewall.
+
+If conduwuit runs behind a router or in a container and has a different public IP address than the host system these public ports need to be forwarded directly or indirectly to the port mentioned in the config.
+
+## Setting up a systemd service
+
+Now we'll set up a systemd service for conduwuit, so it's easy to start/stop conduwuit and set it to autostart when your
+server reboots. Simply paste the default systemd service you can find below into
+`/etc/systemd/system/conduwuit.service`.
+
+```systemd
+[Unit]
+Description=conduwuit Matrix Server
+After=network.target
+
+[Service]
+Environment="CONDUWUIT_CONFIG=/etc/conduwuit/conduwuit.toml"
+User=conduwuit
+Group=conduwuit
+RuntimeDirectory=conduwuit
+RuntimeDirectoryMode=0750
+Restart=always
+ExecStart=/usr/local/bin/conduwuit
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Finally, run
+
+```bash
+$ sudo systemctl daemon-reload
+```
+
+## Creating the conduwuit configuration file
+
+Now we need to create the conduwuit's config file in `/etc/conduwuit/conduwuit.toml`. Paste this in **and take a moment
+to read it. You need to change at least the server name.**
+RocksDB (`rocksdb`) is the only supported database backend. SQLite only exists for historical reasons and is not recommended. Any performance issues, storage issues, database issues, etc will not be assisted if using SQLite and you will be asked to migrate to RocksDB first.
+
+See the following example config at [conduwuit-example.toml](../configuration.md)
+
+## Setting the correct file permissions
+
+As we are using a conduwuit specific user we need to allow it to read the config. To do that you can run this command on
+Debian or RHEL:
+
+```bash
+sudo chown -R root:root /etc/conduwuit
+sudo chmod 755 /etc/conduwuit
+```
+
+If you use the default database path you also need to run this:
+
+```bash
+sudo mkdir -p /var/lib/conduwuit/
+sudo chown -R conduwuit:conduwuit /var/lib/conduwuit/
+sudo chmod 700 /var/lib/conduwuit/
+```
+
+## Setting up the Reverse Proxy
+
+Refer to the documentation or various guides online of your chosen reverse proxy software. A Caddy example will be provided as this is the recommended reverse proxy for new users and is very trivial.
+
+### Caddy
+
+Create `/etc/caddy/conf.d/conduwuit_caddyfile` and enter this (substitute for your server name).
+
+```caddy
+your.server.name, your.server.name:8448 {
+        # TCP
+        reverse_proxy 127.0.0.1:6167
+
+        # UNIX socket
+        #reverse_proxy unix//run/conduwuit/conduwuit.sock
+}
+```
+
+That's it! Just start or enable the service and you're set.
+
+```bash
+$ sudo systemctl enable caddy
+```
+
+## You're done!
+
+Now you can start conduwuit with:
+
+```bash
+$ sudo systemctl start conduwuit
+```
+
+Set it to start automatically when your system boots with:
+
+```bash
+$ sudo systemctl enable conduwuit
+```
+
+## How do I know it works?
+
+You can open [a Matrix client](https://matrix.org/ecosystem/clients), enter your homeserver and try to register.
+
+You can also use these commands as a quick health check.
+
+```bash
+$ curl https://your.server.name/_conduwuit/server_version
+
+# If using port 8448
+$ curl https://your.server.name:8448/_conduwuit/server_version
+```
+
+- To check if your server can talk with other homeservers, you can use the [Matrix Federation Tester](https://federationtester.matrix.org/).
+  If you can register but cannot join federated rooms check your config again and also check if the port 8448 is open and forwarded correctly.
+
+# What's next?
+
+## Audio/Video calls
+
+For Audio/Video call functionality see the [TURN Guide](../turn.md).
+
+## Appservices
+
+If you want to set up an appservice, take a look at the [Appservice Guide](../appservices.md).

docs/deploying/nixos.md

@@ -0,0 +1,30 @@
+# conduwuit for NixOS
+
+conduwuit can be acquired by Nix from various places:
+
+* The `flake.nix` at the root of the repo
+* The `default.nix` at the root of the repo
+* From conduwuit's binary cache
+
+A binary cache for conduwuit that the CI/CD publishes to is available at the
+following places (both are the same just different names):
+```
+https://attic.kennel.juneis.dog/conduit
+conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
+
+https://attic.kennel.juneis.dog/conduwuit
+conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
+```
+
+If specifying a URL in your flake, please use the GitHub remote: `github:girlbossceo/conduwuit`
+
+The `flake.nix` and `default.nix` do not (currently) provide a NixOS module, so
+(for now) [`services.matrix-conduit`][module] from Nixpkgs should be used to
+configure conduwuit.
+
+If you want to run the latest code, you should get Conduwuit from the `flake.nix`
+or `default.nix` and set [`services.matrix-conduit.package`][package]
+appropriately.
+
+[module]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit
+[package]: https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit.package

docs/development.md

@@ -0,0 +1,22 @@
+# Development
+
+Information about developing the project. If you are only interested in using
+it, you can safely ignore this section.
+
+## Debugging with `tokio-console`
+
+[`tokio-console`][1] can be a useful tool for debugging and profiling. To make
+a `tokio-console`-enabled build of Conduwuit, enable the `tokio_console` feature,
+disable the default `release_max_log_level` feature, and set the
+`--cfg tokio_unstable` flag to enable experimental tokio APIs. A build might
+look like this:
+
+```bash
+RUSTFLAGS="--cfg tokio_unstable" cargo build \
+    --release \
+    --no-default-features \
+    --features
+    backend_rocksdb,systemd,element_hacks,sentry_telemetry,gzip_compression,brotli_compression,zstd_compression,tokio_console
+```
+
+[1]: https://docs.rs/tokio-console/latest/tokio_console/

docs/development/testing.md

@@ -0,0 +1,17 @@
+# Testing
+
+## Complement
+
+Have a look at [Complement's repository][complement] for an explanation of what
+it is.
+
+To test against Complement, with Nix and direnv installed and set up, you can
+either:
+
+* Run `./bin/complement "$COMPLEMENT_SRC" ./path/to/logs.jsonl ./path/to/results.jsonl`
+  to build a Complement image, run the tests, and output the logs and results
+  to the specified paths
+* Run `nix build .#complement` from the root of the repository to just build a
+  Complement image
+
+[complement]: https://github.com/matrix-org/complement

docs/differences.md

@@ -0,0 +1,152 @@
+#### **Note: This list may not up to date. There are rapidly more and more improvements, fixes, changes, etc being made that it is becoming more difficult to maintain this list. I recommend that you give conduwuit a try and see the differences for yourself. If you have any concerns, feel free to join the conduwuit Matrix room and ask any pre-usage questions.**
+
+### list of features, bug fixes, etc that conduwuit does that Conduit does not:
+
+Outgoing typing indicators, outgoing read receipts, **and** outgoing presence!
+
+## Performance:
+- Concurrency support for key fetching for faster remote room joins and room joins that will error less frequently
+- Send `Cache-Control` response header with `immutable` and 1 year cache length for all media requests to instruct clients to cache media, and reduce server load from media requests that could be otherwise cached
+- Add feature flags and config options to enable/build with zstd, brotli, and/or gzip HTTP body compression (response and request)
+- Eliminate all usage of the thread-blocking `getaddrinfo(3)` call upon DNS queries, significantly improving federation latency/ping and cache DNS results (NXDOMAINs, successful queries, etc) using hickory-dns / hickory-resolver
+- Vastly improve RocksDB default settings to use new features that help with performance significantly, uses settings tailored to SSDs, various ways to tweak RocksDB, and a conduwuit setting to tell RocksDB to use settings that are tailored to HDDs or slow spinning rust storage or buggy filesystems.
+- Add a Cargo build profile for aggressive build-time performance optimisations for release builds (1 codegen unit, no debug, fat LTO, etc, and optimise all crates with same)
+- Implement database flush and cleanup conduwuit operations when using RocksDB
+- Implement RocksDB write buffer corking and coalescing in database write-heavy areas
+- Perform connection pooling and keepalives where necessary to significantly improve federation performance and latency
+- Various config options to tweak connection pooling, request timeouts, connection timeouts, DNS timeouts and settings, etc with good defaults which also help huge with performance via reusing connections and retrying where needed
+- Implement building conduwuit with jemalloc (which extends to the RocksDB jemalloc feature for maximum gains) or hardened_malloc light variant, and produce CI builds with jemalloc for performance (Nix doesn't seem to build [hardened_malloc-rs](https://github.com/girlbossceo/hardened_malloc-rs) properly)
+- Add support for caching DNS results with hickory-dns / hickory-resolver in conduwuit (not a replacement for a proper resolver cache, but still far better than nothing)
+- Add config option for using DNS over TCP, and config option for controlling A/AAAA record lookup strategy (e.g. don't query AAAA records if you don't have IPv6 connectivity)
+- Overall significant database, Client-Server, and federation performance and latency improvements (check out the ping room leaderboards if you don't believe me :>)
+- Add config options for RocksDB compression and bottommost compression, including choosing the algorithm and compression level
+- Use [loole](https://github.com/mahdi-shojaee/loole) MPSC channels instead of tokio MPSC channels for huge performance boosts in sending channels (mainly relevant for federation) and presence channels
+- Use `tracing`/`log`'s `release_max_level_info` feature to improve performance, build speeds, binary size, and CPU usage in release builds by avoid compiling debug/trace log level macros that users will generally never use (can be disabled with a build-time feature flag)
+
+
+## General Fixes:
+- Raise and improve all the various request timeouts making some things like room joins and client bugs error less or none at all than they should, and make them all user configurable
+- Add missing `reason` field to user ban events (`/ban`)
+- Fixed spec compliance issue with room version 8 - 11 joins (https://github.com/matrix-org/synapse/issues/16717 / https://github.com/matrix-org/matrix-spec/issues/1708)
+- Safer and cleaner shutdowns on both database side as we run cleanup on shutdown and exits database loop better (no potential hanging issues in database loop), overall cleaner shutdown logic
+- Stop sending `make_join` requests on room joins if 15 servers respond with `M_UNSUPPORTED_ROOM_VERSION` or `M_INVALID_ROOM_VERSION`
+- Stop sending `make_join` requests if 50 servers cannot provide `make_join` for us
+- Respect *most* client parameters for `/media/` requests (`allow_redirect` still needs work)
+- Increased graceful shutdown timeout from a low 60 seconds to 180 seconds to avoid killing connections and let the remaining ones finish processing
+- Return joined member count of rooms for push rules/conditions instead of a hardcoded value of 10
+- Make `CONDUIT_CONFIG` optional, relevant for container users that configure only by environment variables and no longer need to set `CONDUIT_CONFIG` to an empty string.
+- Allow HEAD HTTP requests in CORS for clients (despite not being explicity mentioned in Matrix spec, HTTP spec says all HEAD requests need to behave the same as GET requests, Synapse supports HEAD requests)
+- Resolve and remove some "features" from upstream that result in concurrency hazards, exponential backoff issues, or arbitrary performance limiters
+- Find more servers for outbound federation `/hierarchy` requests instead of just the room ID server name
+- Support for suggesting servers to join through at `/_matrix/client/v3/directory/room/{roomAlias}`
+- Support for suggesting servers to join through us at `/_matrix/federation/v1/query/directory`
+- Add workaround for [Out Of Your Element](https://gitdab.com/cadence/out-of-your-element) appservice bridge to make it functional on conduwuit (bug has already been reported)
+
+
+## Moderation:
+- (Also see [Admin Room](#admin-room) for all the admin commands pertaining to moderation, there's a lot!)
+- Add support for room banning/blocking by ID using admin command
+- Add support for serving `support` well-known from `[well_known.support]` (MSC1929)
+- Config option to forbid publishing rooms to the room directory (`lockdown_public_room_directory`) except for admins
+- Admin commands to delete room aliases and unpublish rooms from our room directory
+- For all [`/report`](https://spec.matrix.org/v1.9/client-server-api/#post_matrixclientv3roomsroomidreporteventid) requests: check if the reported event ID belongs to the reported room ID, raise report reasoning character limit to 750, fix broken formatting, make a small delayed random response per spec suggestion on privacy, and check if the sender user is in the reported room.
+- Support blocking servers from downloading remote media from, returning a 404
+- Don't allow `m.call.invite` events to be sent in public rooms (prevents calling the entire room)
+- On new public room creations, only allow moderators to send `m.call.invite`, `org.matrix.msc3401.call`, and `org.matrix.msc3401.call.member` events
+- Add support for a "global ACLs" feature (`forbidden_remote_server_names`) that blocks inbound remote room invites, room joins by room ID on server name, room joins by room alias on server name, incoming federated joins, and incoming federated room directory requests. This is very helpful for blocking servers that are purely toxic/bad and serve no value in allowing our users to suffer from things like room invite spam or such. Please note that this is not a substitute for room ACLs.
+- Add support for a config option to forbid our local users from sending federated room directory requests for (`forbidden_remote_room_directory_server_names`). Similar to above, useful for blocking servers that help prevent our users from wandering into bad areas of Matrix via room directories of those malicious servers.
+
+
+## Privacy/Security:
+- Add config option for device name federation with a privacy-friendly default (disabled)
+- Add config option for requiring authentication to the `/publicRooms` endpoint (room directory) with a default enabled for privacy
+- Add config option for federating `/publicRooms` endpoint (room directory) to other servers with a default disabled for privacy
+- Uses proper `argon2` crate by RustCrypto instead of questionable `rust-argon2` crate
+- Generate passwords with 25 characters instead of 15
+- Config option `ip_range_denylist` to support refusing to send requests (typically federation) to specific IP ranges, typically RFC 1918, non-routable, testnet, etc addresses like Synapse for security (note: this is not a guaranteed protection, and you should be using a firewall with zones if you want guaranteed protection as doing this on the application level is prone to bypasses).
+- Config option to block non-admin users from sending room invites or receiving remote room invites. Admin users are still allowed.
+- Config option to disable incoming and/or outgoing remote read receipts
+- Config option to disable incoming and/or outgoing remote typing indicators
+- Config option to disable incoming, outgoing, and/or local presence
+
+
+## Administration/Logging:
+- Commandline argument to specify the path to a config file instead of relying on `CONDUIT_CONFIG`
+- Revamped admin room infrastructure and commands
+- Substantially clean up, improve, and fix logging (less noisy dead server logging, registration attempts, more useful troubleshooting logging, proper error propagation, etc)
+- Configurable RocksDB logging (`LOG` files) with proper defaults (rotate, max size, verbosity, etc) to stop LOG files from accumulating so much
+- Explicit startup error if your configuration allows open registration without a token or such like Synapse with a way to bypass it if needed
+- Replace the lightning bolt emoji option with support for setting any arbitrary text (e.g. another emoji) to suffix to all new user registrations, with a conduwuit default of 🏳️‍⚧️
+- Implement config option to auto join rooms upon registration
+- Warn on unknown config options specified
+- Add `/_conduwuit/server_version` route to return the version of conduwuit without relying on the federation API `/_matrix/federation/v1/version`
+- Add configurable RocksDB recovery modes to aid in recovering corrupted RocksDB databases
+- Support config options via `CONDUWUIT_` prefix
+- Add support for listening on multiple TCP ports
+- Disable update check by default as it's not useful for conduwuit
+- **Opt-in** Sentry.io telemetry and metrics, mainly used for crash reporting
+
+
+## Maintenance/Stability:
+- GitLab CI ported to GitHub Actions
+- Repo is mirrored to GitHub, GitLab, git.gay, sourcehut, and Codeberg (see README.md for their links)
+- Extensively revamp the example config to be extremely helpful and useful to both new users and power users
+- Fixed every single clippy (default lints) and rustc warnings, including some that were performance related or potential safety issues / unsoundness
+- Add a **lot** of other clippy and rustc lints and a rustfmt.toml file
+- Has [Renovate](https://docs.renovatebot.com/), [Trivy](https://github.com/aquasecurity/trivy-action), and keeps ALL dependencies as up to date as possible
+- Attempts and interest in removing extreme and unnecessary panics/unwraps/expects that can lead to denial of service or such (upstream and upstream contributors want this unusual behaviour for some reason)
+- Purge unmaintained/irrelevant/broken database backends (heed, sled, persy) and other unnecessary code or overhead
+- webp support for images
+- Add cargo audit support to CI
+- CI tests with all features
+- Add timestamp by commit date support to building OCI images for keeping image build reproducibility and still have a meaningful "last modified date" for OCI image metadata
+- Update rusqlite/sqlite (not that you should be using it)
+- Startup check if conduwuit running in a container and is listening on 127.0.0.1 (generally containers are using NAT networking and 0.0.0.0 is the intended listening address)
+
+
+## Admin Room:
+- Fix admin room handler to not panic/crash if the admin room command response fails (e.g. too large message)
+- Add command to dynamically change conduwuit's tracing log level filter on the fly
+- Add admin command to fetch a server's `/.well-known/matrix/support` file
+- Add debug admin command to force update user device lists (could potentially resolve some E2EE flukes)
+- Implement **RocksDB online backups**, listing RocksDB backups, and listing database file counts all via admin commands
+- Add various database visibility commands such as being able to query the getters and iterators used in conduwuit, a very helpful online debugging utility
+- Forbid the admin room from being made public or world readable history
+- Add `!admin` as a way to call the admin bot
+- Extend clear cache admin command to support clearing more caches such as DNS and TLS name overrides
+- Admin debug command to send a federation request/ping to a server's `/_matrix/federation/v1/version` endpoint and measures the latency it took
+- Add admin command to bulk delete media via a codeblock list of MXC URLs.
+- Add admin command to delete both the thumbnail and media MXC URLs from an event ID (e.g. from an abuse report)
+- Add admin command to list all the rooms a local user is joined in
+- Add admin command to delete all remote media in the past X minutes as a form of deleting media that you don't want on your server that a remote user posted in a room
+- Add admin command to return a room's state
+- Admin debug command to fetch a PDU from a remote server and inserts it into our database/timeline as backfill
+- Add admin command to delete media via a specific MXC. This deletes the MXC from our database, and the file locally.
+- Add admin commands for banning (blocking) room IDs from our local users joining (admins are always allowed) and evicts all our local users from that room, in addition to bulk room banning support, and blocks room invites (remote and local) to the banned room, as a moderation feature
+- Add admin commands to output jemalloc memory stats and memory usage
+- Add admin command to get conduwuit's uptime
+- Add admin command to get rooms a *remote* user shares with us
+
+
+## Misc:
+- Support for creating rooms with custom room IDs like Maunium Synapse (`room_id` request body field to `/createRoom`)
+- Query parameter `?format=event|content` for returning either the room state event's content (default) for the full room state event on ` /_matrix/client/v3/rooms/{roomId}/state/{eventType}[/{stateKey}]` requests (see https://github.com/matrix-org/matrix-spec/issues/1047)
+- Add **optional** feature flag to use SHA256 key names for media instead of base64 to overcome filesystem file name length limitations (OS error file name too long)
+- Send a User-Agent on all of our requests
+- Send `avatar_url` on invite room membership events/changes
+- Support sending [`well_known` response to client login responses](https://spec.matrix.org/v1.10/client-server-api/#post_matrixclientv3login) if using config option `[well_known.client]`
+- Implement `include_state` search criteria support for `/search` requests (response now can include room states)
+- Declare various missing Matrix versions and features at `/_matrix/client/versions`
+- Implement legacy Matrix `/v1/` media endpoints that some clients and servers may still call
+- Config option to change Conduit's behaviour of homeserver key fetching (`query_trusted_key_servers_first`). This option sets whether conduwuit will query trusted notary key servers first before the individual homeserver(s), or vice versa which may help in joining certain rooms.
+- Implement unstable MSC2666 support for querying mutual rooms with a user
+- Assume well-knowns are broken if they exceed past 10000 characters.
+- Add support for the Matrix spec compliance test suite [Complement](https://github.com/matrix-org/complement/) via the Nix flake and various other fixes for it
+- Add support for listening on both HTTP and HTTPS if using direct TLS with conduwuit for usecases such as Complement
+- Implement running and diff'ing Complement results in CI
+- Interest in supporting other operating systems such as macOS, BSDs, and Windows, and getting them added into CI and doing builds for them
+- Add config option for disabling RocksDB Direct IO if needed
+- (Developers): Add support for tokio-console
+- (Developers): Add support for tracing flame graphs
+- Add `release-debuginfo` Cargo build profile
+- No cryptocurrency donations allowed, conduwuit is fully maintained by independent queer maintainers, and with a strong priority on inclusitivity and comfort for protected groups 🏳️‍⚧️

docs/introduction.md

@@ -0,0 +1,17 @@
+# Conduwuit
+
+{{#include ../README.md:catchphrase}}
+
+{{#include ../README.md:body}}
+
+#### What's different about your fork than upstream Conduit?
+
+See [differences.md](differences.md)
+
+#### How can I deploy my own?
+
+- [Deployment options](deploying.md)
+
+If you want to connect an Appservice to Conduwuit, take a look at the [appservices documentation](appservices.md).
+
+{{#include ../README.md:footer}}

engage.toml

@@ -50,10 +50,15 @@ name = "cargo-deb"
 group = "versions"
 script = "cargo deb --version"
 
+[[task]]
+name = "lychee"
+group = "versions"
+script = "lychee --version"
+
 [[task]]
 name = "cargo-audit"
 group = "security"
-script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked"
+script = "cargo audit -D warnings -D unmaintained -D unsound -D yanked --ignore RUSTSEC-2020-0016"
 
 [[task]]
 name = "cargo-fmt"
@@ -73,9 +78,60 @@ RUSTDOCFLAGS="-D warnings" cargo doc \
 """
 
 [[task]]
-name = "cargo-clippy"
+name = "clippy/default"
 group = "lints"
-script = "cargo clippy --workspace --all-targets --all-features --color=always -- -D warnings"
+script = """
+cargo clippy \
+    --workspace \
+    --all-targets \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "clippy/all"
+group = "lints"
+script = """
+cargo clippy \
+    --workspace \
+    --all-targets \
+    --all-features \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "clippy/jemalloc"
+group = "lints"
+script = """
+cargo clippy \
+    --workspace \
+    --features jemalloc \
+    --all-targets \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "clippy/hardened_malloc"
+group = "lints"
+script = """
+cargo clippy \
+    --workspace \
+    --features hardened_malloc \
+    --all-targets \
+    --color=always \
+    -- \
+    -D warnings
+"""
+
+[[task]]
+name = "lychee"
+group = "lints"
+script = "lychee --offline docs"
 
 [[task]]
 name = "cargo"

flake.lock

@@ -9,11 +9,11 @@
         "nixpkgs-stable": "nixpkgs-stable"
       },
       "locked": {
-        "lastModified": 1707922053,
-        "narHash": "sha256-wSZjK+rOXn+UQiP1NbdNn5/UW6UcBxjvlqr2wh++MbM=",
+        "lastModified": 1711742460,
+        "narHash": "sha256-0O4v6e4a1toxXZ2gf5INhg4WPE5C5T+SVvsBt+45Mcc=",
         "owner": "zhaofengli",
         "repo": "attic",
-        "rev": "6eabc3f02fae3683bffab483e614bebfcd476b21",
+        "rev": "4dbdbee45728d8ce5788db6461aaaa89d98081f0",
         "type": "github"
       },
       "original": {
@@ -23,6 +23,23 @@
         "type": "github"
       }
     },
+    "complement": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1714472853,
+        "narHash": "sha256-CNRHSZe3TE+3tFj2dHNyxTMjDqL0MKY3P/3jqUgA7YE=",
+        "owner": "matrix-org",
+        "repo": "complement",
+        "rev": "891d18872c153d39a9ce63b545045efddb845738",
+        "type": "github"
+      },
+      "original": {
+        "owner": "matrix-org",
+        "ref": "main",
+        "repo": "complement",
+        "type": "github"
+      }
+    },
     "crane": {
       "inputs": {
         "nixpkgs": [
@@ -51,17 +68,17 @@
         ]
       },
       "locked": {
-        "lastModified": 1707685877,
-        "narHash": "sha256-XoXRS+5whotelr1rHiZle5t5hDg9kpguS5yk8c8qzOc=",
+        "lastModified": 1713738183,
+        "narHash": "sha256-qd/MuLm7OfKQKyd4FAMqV4H6zYyOfef5lLzRrmXwKJM=",
         "owner": "ipetkov",
         "repo": "crane",
-        "rev": "2c653e4478476a52c6aa3ac0495e4dea7449ea0e",
+        "rev": "f6c6a2fb1b8bd9b65d65ca9342dd0eb180a63f11",
         "type": "github"
       },
       "original": {
         "owner": "ipetkov",
+        "ref": "master",
         "repo": "crane",
-        "rev": "2c653e4478476a52c6aa3ac0495e4dea7449ea0e",
         "type": "github"
       }
     },
@@ -73,15 +90,16 @@
         "rust-analyzer-src": "rust-analyzer-src"
       },
       "locked": {
-        "lastModified": 1709619709,
-        "narHash": "sha256-l6EPVJfwfelWST7qWQeP6t/TDK3HHv5uUB1b2vw4mOQ=",
+        "lastModified": 1714544767,
+        "narHash": "sha256-kF1bX+YFMedf1g0PAJYwGUkzh22JmULtj8Rm4IXAQKs=",
         "owner": "nix-community",
         "repo": "fenix",
-        "rev": "c8943ea9e98d41325ff57d4ec14736d330b321b2",
+        "rev": "73124e1356bde9411b163d636b39fe4804b7ca45",
         "type": "github"
       },
       "original": {
         "owner": "nix-community",
+        "ref": "main",
         "repo": "fenix",
         "type": "github"
       }
@@ -114,6 +132,7 @@
       },
       "original": {
         "owner": "edolstra",
+        "ref": "master",
         "repo": "flake-compat",
         "type": "github"
       }
@@ -138,41 +157,43 @@
         "systems": "systems"
       },
       "locked": {
-        "lastModified": 1709126324,
-        "narHash": "sha256-q6EQdSeUZOG26WelxqkmR7kArjgWCdw5sfJVHPH/7j8=",
+        "lastModified": 1710146030,
+        "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
         "owner": "numtide",
         "repo": "flake-utils",
-        "rev": "d465f4819400de7c8d874d50b982301f28a84605",
+        "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
         "type": "github"
       },
       "original": {
         "owner": "numtide",
+        "ref": "main",
         "repo": "flake-utils",
         "type": "github"
       }
     },
     "nix-filter": {
       "locked": {
-        "lastModified": 1705332318,
-        "narHash": "sha256-kcw1yFeJe9N4PjQji9ZeX47jg0p9A0DuU4djKvg1a7I=",
+        "lastModified": 1710156097,
+        "narHash": "sha256-1Wvk8UP7PXdf8bCCaEoMnOT1qe5/Duqgj+rL8sRQsSM=",
         "owner": "numtide",
         "repo": "nix-filter",
-        "rev": "3449dc925982ad46246cfc36469baf66e1b64f17",
+        "rev": "3342559a24e85fc164b295c3444e8a139924675b",
         "type": "github"
       },
       "original": {
         "owner": "numtide",
+        "ref": "main",
         "repo": "nix-filter",
         "type": "github"
       }
     },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1702539185,
-        "narHash": "sha256-KnIRG5NMdLIpEkZTnN5zovNYc0hhXjAgv6pfd5Z4c7U=",
+        "lastModified": 1711401922,
+        "narHash": "sha256-QoQqXoj8ClGo0sqD/qWKFWezgEwUL0SUh37/vY2jNhc=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "aa9d4729cbc99dabacb50e3994dcefb3ea0f7447",
+        "rev": "07262b18b97000d16a4bdb003418bd2fb067a932",
         "type": "github"
       },
       "original": {
@@ -184,11 +205,11 @@
     },
     "nixpkgs-stable": {
       "locked": {
-        "lastModified": 1702780907,
-        "narHash": "sha256-blbrBBXjjZt6OKTcYX1jpe9SRof2P9ZYWPzq22tzXAA=",
+        "lastModified": 1711460390,
+        "narHash": "sha256-akSgjDZL6pVHEfSE6sz1DNSXuYX6hq+P/1Z5IoYWs7E=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "1e2e384c5b7c50dbf8e9c441a9e58d85f408b01f",
+        "rev": "44733514b72e732bd49f5511bd0203dea9b9a434",
         "type": "github"
       },
       "original": {
@@ -200,11 +221,11 @@
     },
     "nixpkgs_2": {
       "locked": {
-        "lastModified": 1709479366,
-        "narHash": "sha256-n6F0n8UV6lnTZbYPl1A9q1BS0p4hduAv1mGAP17CVd0=",
+        "lastModified": 1713537308,
+        "narHash": "sha256-XtTSSIB2DA6tOv+l0FhvfDMiyCmhoRbNB+0SeInZkbk=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "b8697e57f10292a6165a20f03d2f42920dfaf973",
+        "rev": "5c24cf2f0a12ad855f444c30b2421d044120c66f",
         "type": "github"
       },
       "original": {
@@ -214,25 +235,44 @@
         "type": "github"
       }
     },
+    "rocksdb": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1713810944,
+        "narHash": "sha256-/Xf0bzNJPclH9IP80QNaABfhj4IAR5LycYET18VFCXc=",
+        "owner": "facebook",
+        "repo": "rocksdb",
+        "rev": "6f7cabeac80a3a6150be2c8a8369fcecb107bf43",
+        "type": "github"
+      },
+      "original": {
+        "owner": "facebook",
+        "ref": "v9.1.1",
+        "repo": "rocksdb",
+        "type": "github"
+      }
+    },
     "root": {
       "inputs": {
         "attic": "attic",
+        "complement": "complement",
         "crane": "crane_2",
         "fenix": "fenix",
         "flake-compat": "flake-compat_2",
         "flake-utils": "flake-utils_2",
         "nix-filter": "nix-filter",
-        "nixpkgs": "nixpkgs_2"
+        "nixpkgs": "nixpkgs_2",
+        "rocksdb": "rocksdb"
       }
     },
     "rust-analyzer-src": {
       "flake": false,
       "locked": {
-        "lastModified": 1709571018,
-        "narHash": "sha256-ISFrxHxE0J5g7lDAscbK88hwaT5uewvWoma9TlFmRzM=",
+        "lastModified": 1713628977,
+        "narHash": "sha256-iN5QUlUq527lswmBC+RopfXdu6Xx7mmTaBSH2l59FtM=",
         "owner": "rust-lang",
         "repo": "rust-analyzer",
-        "rev": "9f14343f9ee24f53f17492c5f9b653427e2ad15e",
+        "rev": "55d9a533b309119c8acd13061581b43ae8840823",
         "type": "github"
       },
       "original": {

flake.nix

@@ -1,213 +1,68 @@
 {
   inputs = {
-    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
-    flake-utils.url = "github:numtide/flake-utils";
-    nix-filter.url = "github:numtide/nix-filter";
-    flake-compat = {
-      url = "github:edolstra/flake-compat";
-      flake = false;
-    };
-
-    fenix = {
-      url = "github:nix-community/fenix";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
-    crane = {
-      # Pin latest crane that's not affected by the following bugs:
-      #
-      # * <https://github.com/ipetkov/crane/issues/527#issuecomment-1978079140>
-      # * <https://github.com/toml-rs/toml/issues/691>
-      # * <https://github.com/toml-rs/toml/issues/267>
-      url = "github:ipetkov/crane?rev=2c653e4478476a52c6aa3ac0495e4dea7449ea0e";
-      inputs.nixpkgs.follows = "nixpkgs";
-    };
     attic.url = "github:zhaofengli/attic?ref=main";
+    complement = { url = "github:matrix-org/complement?ref=main"; flake = false; };
+    crane = { url = "github:ipetkov/crane?ref=master"; inputs.nixpkgs.follows = "nixpkgs"; };
+    fenix = { url = "github:nix-community/fenix?ref=main"; inputs.nixpkgs.follows = "nixpkgs"; };
+    flake-compat = { url = "github:edolstra/flake-compat?ref=master"; flake = false; };
+    flake-utils.url = "github:numtide/flake-utils?ref=main";
+    nix-filter.url = "github:numtide/nix-filter?ref=main";
+    nixpkgs.url = "github:NixOS/nixpkgs?ref=nixos-unstable";
+    rocksdb = { url = "github:facebook/rocksdb?ref=v9.1.1"; flake = false; };
   };
 
-  outputs =
-    { self
-    , nixpkgs
-    , flake-utils
-    , nix-filter
-
-    , fenix
-    , crane
-    , ...
-    }: flake-utils.lib.eachDefaultSystem (system:
+  outputs = inputs:
+    inputs.flake-utils.lib.eachDefaultSystem (system:
     let
-      pkgsHost = nixpkgs.legacyPackages.${system};
-
-      rocksdb' = pkgs:
-        let
-          version = "8.11.3";
-        in
-        pkgs.rocksdb.overrideAttrs (old: {
-          inherit version;
-          src = pkgs.fetchFromGitHub {
-            owner = "facebook";
-            repo = "rocksdb";
-            rev = "v${version}";
-            hash = "sha256-OpEiMwGxZuxb9o3RQuSrwZMQGLhe9xLT1aa3HpI4KPs=";
-          };
-        });
-
-      # Nix-accessible `Cargo.toml`
-      cargoToml = builtins.fromTOML (builtins.readFile ./Cargo.toml);
+      pkgsHost = inputs.nixpkgs.legacyPackages.${system};
 
       # The Rust toolchain to use
-      toolchain = fenix.packages.${system}.fromToolchainFile {
+      toolchain = inputs.fenix.packages.${system}.fromToolchainFile {
         file = ./rust-toolchain.toml;
 
         # See also `rust-toolchain.toml`
-        sha256 = "sha256-SXRtAuO4IqNOQq+nLbrsDFbVk+3aVA8NNpSZsKlVH/8=";
+        sha256 = "sha256-e4mlaJehWBymYxJGgnbuCObVlqMlQSilZ8FljG9zPHY=";
       };
 
-      builder = pkgs:
-        ((crane.mkLib pkgs).overrideToolchain toolchain).buildPackage;
+      scope = pkgs: pkgs.lib.makeScope pkgs.newScope (self: {
+        book = self.callPackage ./nix/pkgs/book {};
+        complement = self.callPackage ./nix/pkgs/complement {};
+        craneLib = ((inputs.crane.mkLib pkgs).overrideToolchain toolchain);
+        inherit inputs;
+        main = self.callPackage ./nix/pkgs/main {};
+        oci-image = self.callPackage ./nix/pkgs/oci-image {};
+        rocksdb = pkgs.rocksdb.overrideAttrs (old: {
+          src = inputs.rocksdb;
+          version = pkgs.lib.removePrefix
+            "v"
+            (builtins.fromJSON (builtins.readFile ./flake.lock))
+              .nodes.rocksdb.original.ref;
+        });
+      });
 
-      nativeBuildInputs = pkgs: [
-        # bindgen needs the build platform's libclang. Apparently due to
-        # "splicing weirdness", pkgs.rustPlatform.bindgenHook on its own doesn't
-        # quite do the right thing here.
-        pkgs.pkgsBuildHost.rustPlatform.bindgenHook
-      ];
-
-      env = pkgs: {
-        ROCKSDB_INCLUDE_DIR = "${rocksdb' pkgs}/include";
-        ROCKSDB_LIB_DIR = "${rocksdb' pkgs}/lib";
-      }
-      // pkgs.lib.optionalAttrs pkgs.stdenv.hostPlatform.isStatic {
-        ROCKSDB_STATIC = "";
-      }
-      // {
-        CARGO_BUILD_RUSTFLAGS = let inherit (pkgs) lib stdenv; in
-          lib.concatStringsSep " " ([ ]
-            ++ lib.optionals
-            # This disables PIE for static builds, which isn't great in terms
-            # of security. Unfortunately, my hand is forced because nixpkgs'
-            # `libstdc++.a` is built without `-fPIE`, which precludes us from
-            # leaving PIE enabled.
-            stdenv.hostPlatform.isStatic
-            [ "-C" "relocation-model=static" ]
-            ++ lib.optionals
-            (stdenv.buildPlatform.config != stdenv.hostPlatform.config)
-            [ "-l" "c" ]
-            ++ lib.optionals
-            # This check has to match the one [here][0]. We only need to set
-            # these flags when using a different linker. Don't ask me why,
-            # though, because I don't know. All I know is it breaks otherwise.
-            #
-            # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L37-L40
-            (
-              # Nixpkgs doesn't check for x86_64 here but we do, because I
-              # observed a failure building statically for x86_64 without
-              # including it here. Linkers are weird.
-              (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
-                && stdenv.hostPlatform.isStatic
-                && !stdenv.isDarwin
-                && !stdenv.cc.bintools.isLLVM
-            )
-            [
-              "-l"
-              "stdc++"
-              "-L"
-              "${stdenv.cc.cc.lib}/${stdenv.hostPlatform.config}/lib"
-            ]
-          );
-      }
-
-      # What follows is stolen from [here][0]. Its purpose is to properly
-      # configure compilers and linkers for various stages of the build, and
-      # even covers the case of build scripts that need native code compiled and
-      # run on the build platform (I think).
-      #
-      # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
-      // (
-        let
-          inherit (pkgs.rust.lib) envVars;
-        in
-        pkgs.lib.optionalAttrs
-          (pkgs.stdenv.targetPlatform.rust.rustcTarget
-            != pkgs.stdenv.hostPlatform.rust.rustcTarget)
-          (
-            let
-              inherit (pkgs.stdenv.targetPlatform.rust) cargoEnvVarTarget;
-            in
-            {
-              "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
-              "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
-              "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
-                envVars.linkerForTarget;
-            }
-          )
-        // (
-          let
-            inherit (pkgs.stdenv.hostPlatform.rust) cargoEnvVarTarget rustcTarget;
-          in
-          {
-            "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
-            "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
-            "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
-            CARGO_BUILD_TARGET = rustcTarget;
-          }
-        )
-        // (
-          let
-            inherit (pkgs.stdenv.buildPlatform.rust) cargoEnvVarTarget;
-          in
-          {
-            "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
-            "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
-            "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
-            HOST_CC = "${pkgs.pkgsBuildHost.stdenv.cc}/bin/cc";
-            HOST_CXX = "${pkgs.pkgsBuildHost.stdenv.cc}/bin/c++";
-          }
-        )
-      );
-
-      package = pkgs: builder pkgs {
-        src = nix-filter {
-          root = ./.;
-          include = [
-            "src"
-            "Cargo.toml"
-            "Cargo.lock"
-          ];
-        };
-
-        # This is redundant with CI
-        doCheck = false;
-
-        env = env pkgs;
-        nativeBuildInputs = nativeBuildInputs pkgs;
-
-        meta.mainProgram = cargoToml.package.name;
-      };
-
-      mkOciImage = pkgs: package:
-        pkgs.dockerTools.buildImage {
-          name = package.pname;
-          tag = "main";
-          copyToRoot = [
-            pkgs.dockerTools.caCertificates
-          ];
-          config = {
-            # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
-            # are handled as expected
-            Entrypoint = [
-              "${pkgs.lib.getExe' pkgs.tini "tini"}"
-              "--"
-            ];
-            Cmd = [
-              "${pkgs.lib.getExe package}"
-            ];
-          };
-        };
+      scopeHost = (scope pkgsHost);
     in
     {
       packages = {
-        default = package pkgsHost;
-        oci-image = mkOciImage pkgsHost self.packages.${system}.default;
+        default = scopeHost.main;
+        jemalloc = scopeHost.main.override { features = ["jemalloc"]; };
+        hmalloc = scopeHost.main.override { features = ["hardened_malloc"]; };
+
+        oci-image = scopeHost.oci-image;
+        oci-image-jemalloc = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            features = ["jemalloc"];
+          };
+        };
+        oci-image-hmalloc = scopeHost.oci-image.override {
+          main = scopeHost.main.override {
+            features = ["hardened_malloc"];
+          };
+        };
+
+        book = scopeHost.book;
+
+        complement = scopeHost.complement;
       }
       //
       builtins.listToAttrs
@@ -217,26 +72,61 @@
               let
                 binaryName = "static-${crossSystem}";
                 pkgsCrossStatic =
-                  (import nixpkgs {
+                  (import inputs.nixpkgs {
                     inherit system;
                     crossSystem = {
                       config = crossSystem;
                     };
                   }).pkgsStatic;
+                scopeCrossStatic = scope pkgsCrossStatic;
               in
               [
                 # An output for a statically-linked binary
                 {
                   name = binaryName;
-                  value = package pkgsCrossStatic;
+                  value = scopeCrossStatic.main;
+                }
+
+                # An output for a statically-linked binary with jemalloc
+                {
+                  name = "${binaryName}-jemalloc";
+                  value = scopeCrossStatic.main.override {
+                    features = ["jemalloc"];
+                  };
+                }
+
+                # An output for a statically-linked binary with hardened_malloc
+                {
+                  name = "${binaryName}-hmalloc";
+                  value = scopeCrossStatic.main.override {
+                    features = ["hardened_malloc"];
+                  };
                 }
 
                 # An output for an OCI image based on that binary
                 {
                   name = "oci-image-${crossSystem}";
-                  value = mkOciImage
-                    pkgsCrossStatic
-                    self.packages.${system}.${binaryName};
+                  value = scopeCrossStatic.oci-image;
+                }
+
+                # An output for an OCI image based on that binary with jemalloc
+                {
+                  name = "oci-image-${crossSystem}-jemalloc";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      features = ["jemalloc"];
+                    };
+                  };
+                }
+
+                # An output for an OCI image based on that binary with hardened_malloc
+                {
+                  name = "oci-image-${crossSystem}-hmalloc";
+                  value = scopeCrossStatic.oci-image.override {
+                    main = scopeCrossStatic.main.override {
+                      features = ["hardened_malloc"];
+                    };
+                  };
                 }
               ]
             )
@@ -248,24 +138,30 @@
         );
 
       devShells.default = pkgsHost.mkShell {
-        env = env pkgsHost // {
+        env = scopeHost.main.env // {
           # Rust Analyzer needs to be able to find the path to default crate
           # sources, and it can read this environment variable to do so. The
           # `rust-src` component is required in order for this to work.
           RUST_SRC_PATH = "${toolchain}/lib/rustlib/src/rust/library";
+
+          # Convenient way to access a pinned version of Complement's source
+          # code.
+          COMPLEMENT_SRC = inputs.complement.outPath;
         };
 
         # Development tools
-        nativeBuildInputs = nativeBuildInputs pkgsHost ++ [
+        packages = [
           # Always use nightly rustfmt because most of its options are unstable
           #
           # This needs to come before `toolchain` in this list, otherwise
           # `$PATH` will have stable rustfmt instead.
-          fenix.packages.${system}.latest.rustfmt
+          inputs.fenix.packages.${system}.latest.rustfmt
 
           toolchain
-        ] ++ (with pkgsHost; [
+        ]
+        ++ (with pkgsHost; [
           engage
+          cargo-audit
 
           # Needed for producing Debian packages
           cargo-deb
@@ -276,7 +172,15 @@
 
           # Needed for our script for Complement
           jq
-        ]);
+
+          # Needed for finding broken markdown links
+          lychee
+
+          # Useful for editing the book locally
+          mdbook
+        ])
+        ++
+        scopeHost.main.nativeBuildInputs;
       };
     });
 }

nix/README.md

@@ -1,208 +0,0 @@
-# Conduit for Nix/NixOS
-
-This guide assumes you have a recent version of Nix (^2.4) installed.
-
-Since Conduit ships as a Nix flake, you'll first need to [enable
-flakes][enable_flakes].
-
-A binary cache for conduwuit that the CI/CD publishes to is available at the
-following places (both are the same just different names):
-```
-https://attic.kennel.juneis.dog/conduit
-conduit:Isq8FGyEC6FOXH6nD+BOeAA+bKp6X6UIbupSlGEPuOg=
-
-https://attic.kennel.juneis.dog/conduwuit
-conduwuit:lYPVh7o1hLu1idH4Xt2QHaRa49WRGSAqzcfFd94aOTw=
-```
-
-You can now use the usual Nix commands to interact with conduwuit's flake. For
-example, `nix run github:girlbossceo/conduwuit` will run conduwuit (though you'll need
-to provide configuration and such manually as usual).
-
-If your NixOS configuration is defined as a flake, you can depend on this flake
-to provide a more up-to-date version than provided by `nixpkgs`. In your flake,
-add the following to your `inputs`:
-
-```nix
-conduit = {
-    url = "github:girlbossceo/conduwuit";
-
-    # Assuming you have an input for nixpkgs called `nixpkgs`. If you experience
-    # build failures while using this, try commenting/deleting this line. This
-    # will probably also require you to always build from source.
-    inputs.nixpkgs.follows = "nixpkgs";
-};
-```
-
-Next, make sure you're passing your flake inputs to the `specialArgs` argument
-of `nixpkgs.lib.nixosSystem` [as explained here][specialargs]. This guide will
-assume you've named the group `flake-inputs`.
-
-Now you can configure conduwuit and a reverse proxy for it. Add the following to
-a new Nix file and include it in your configuration:
-
-```nix
-{ config
-, pkgs
-, flake-inputs
-, ...
-}:
-
-let
-  # You'll need to edit these values
-
-  # The hostname that will appear in your user and room IDs
-  server_name = "example.com";
-
-  # The hostname that Conduit actually runs on
-  #
-  # This can be the same as `server_name` if you want. This is only necessary
-  # when Conduit is running on a different machine than the one hosting your
-  # root domain. This configuration also assumes this is all running on a single
-  # machine, some tweaks will need to be made if this is not the case.
-  matrix_hostname = "matrix.${server_name}";
-
-  # An admin email for TLS certificate notifications
-  admin_email = "admin@${server_name}";
-
-  # These ones you can leave alone
-
-  # Build a dervation that stores the content of `${server_name}/.well-known/matrix/server`
-  well_known_server = pkgs.writeText "well-known-matrix-server" ''
-    {
-      "m.server": "${matrix_hostname}"
-    }
-  '';
-
-  # Build a dervation that stores the content of `${server_name}/.well-known/matrix/client`
-  well_known_client = pkgs.writeText "well-known-matrix-client" ''
-    {
-      "m.homeserver": {
-        "base_url": "https://${matrix_hostname}"
-      }
-    }
-  '';
-in
-
-{
-  # Configure Conduit itself
-  services.matrix-conduit = {
-    enable = true;
-
-    # This causes NixOS to use the flake defined in this repository instead of
-    # the build of Conduit built into nixpkgs.
-    package = flake-inputs.conduit.packages.${pkgs.system}.default;
-
-    settings.global = {
-      inherit server_name;
-    };
-  };
-
-  # Configure automated TLS acquisition/renewal
-  security.acme = {
-    acceptTerms = true;
-    defaults = {
-      email = admin_email;
-    };
-  };
-
-  # ACME data must be readable by the NGINX user
-  users.users.nginx.extraGroups = [
-    "acme"
-  ];
-
-  # Configure NGINX as a reverse proxy
-  services.nginx = {
-    enable = true;
-    recommendedProxySettings = true;
-
-    virtualHosts = {
-      "${matrix_hostname}" = {
-        forceSSL = true;
-        enableACME = true;
-
-        listen = [
-          {
-            addr = "0.0.0.0";
-            port = 443;
-            ssl = true;
-          }
-          {
-            addr = "[::]";
-            port = 443;
-            ssl = true;
-          }          {
-            addr = "0.0.0.0";
-            port = 8448;
-            ssl = true;
-          }
-          {
-            addr = "[::]";
-            port = 8448;
-            ssl = true;
-          }
-        ];
-
-        locations."/_matrix/" = {
-          proxyPass = "http://backend_conduit";
-          proxyWebsockets = true;
-          extraConfig = ''
-            proxy_set_header Host $host;
-            proxy_buffering off;
-          '';
-        };
-
-        extraConfig = ''
-          merge_slashes off;
-        '';
-      };
-
-      "${server_name}" = {
-        forceSSL = true;
-        enableACME = true;
-
-        locations."=/.well-known/matrix/server" = {
-          # Use the contents of the derivation built previously
-          alias = "${well_known_server}";
-
-          extraConfig = ''
-            # Set the header since by default NGINX thinks it's just bytes
-            default_type application/json;
-          '';
-        };
-
-        locations."=/.well-known/matrix/client" = {
-          # Use the contents of the derivation built previously
-          alias = "${well_known_client}";
-
-          extraConfig = ''
-            # Set the header since by default NGINX thinks it's just bytes
-            default_type application/json;
-
-            # https://matrix.org/docs/spec/client_server/r0.4.0#web-browser-clients
-            add_header Access-Control-Allow-Origin "*";
-          '';
-        };
-      };
-    };
-
-    upstreams = {
-      "backend_conduit" = {
-        servers = {
-          "[::1]:${toString config.services.matrix-conduit.settings.global.port}" = { };
-        };
-      };
-    };
-  };
-
-  # Open firewall ports for HTTP, HTTPS, and Matrix federation
-  networking.firewall.allowedTCPPorts = [ 80 443 8448 ];
-  networking.firewall.allowedUDPPorts = [ 80 443 8448 ];
-}
-```
-
-Now you can rebuild your system configuration and you should be good to go!
-
-[enable_flakes]: https://nixos.wiki/wiki/Flakes#Enable_flakes
-
-[specialargs]: https://nixos.wiki/wiki/Flakes#Using_nix_flakes_with_NixOS

nix/pkgs/book/default.nix

@@ -0,0 +1,31 @@
+{ inputs
+
+# Dependencies
+, main
+, mdbook
+, stdenv
+}:
+
+stdenv.mkDerivation {
+  inherit (main) pname version;
+
+  src = inputs.nix-filter {
+    root = inputs.self;
+    include = [
+      "book.toml"
+      "conduwuit-example.toml"
+      "README.md"
+      "debian/README.md"
+      "docs"
+    ];
+  };
+
+  nativeBuildInputs = [
+    mdbook
+  ];
+
+  buildPhase = ''
+    mdbook build
+    mv public $out
+  '';
+}

nix/pkgs/complement/config.toml

@@ -0,0 +1,19 @@
+[global]
+address = "0.0.0.0"
+allow_device_name_federation = true
+allow_guest_registration = true
+allow_public_room_directory_over_federation = true
+allow_public_room_directory_without_auth = true
+allow_registration = true
+allow_unstable_room_versions = true
+database_backend = "rocksdb"
+database_path = "/database"
+log = "trace"
+port = [8008, 8448]
+trusted_servers = []
+yes_i_am_very_very_sure_i_want_an_open_registration_server_prone_to_abuse = true
+
+[global.tls]
+certs = "/certificate.crt"
+dual_protocol = true
+key = "/private_key.key"

nix/pkgs/complement/default.nix

@@ -0,0 +1,92 @@
+# Dependencies
+{ bashInteractive
+, buildEnv
+, coreutils
+, dockerTools
+, gawk
+, lib
+, main
+, openssl
+, stdenv
+, tini
+, writeShellScriptBin
+}:
+
+let
+  main' = main.override {
+    profile = "dev";
+    features = ["axum_dual_protocol"];
+  };
+
+  start = writeShellScriptBin "start" ''
+    set -euxo pipefail
+
+    ${lib.getExe openssl} genrsa -out private_key.key 2048
+    ${lib.getExe openssl} req \
+      -new \
+      -sha256 \
+      -key private_key.key \
+      -subj "/C=US/ST=CA/O=MyOrg, Inc./CN=$SERVER_NAME" \
+      -out signing_request.csr
+    cp ${./v3.ext} v3.ext
+    echo "DNS.1 = $SERVER_NAME" >> v3.ext
+    echo "IP.1 = $(${lib.getExe gawk} 'END{print $1}' /etc/hosts)" \
+      >> v3.ext
+    ${lib.getExe openssl} x509 \
+      -req \
+      -extfile v3.ext \
+      -in signing_request.csr \
+      -CA /complement/ca/ca.crt \
+      -CAkey /complement/ca/ca.key \
+      -CAcreateserial \
+      -out certificate.crt \
+      -days 1 \
+      -sha256
+
+    ${lib.getExe' coreutils "env"} \
+      CONDUIT_SERVER_NAME="$SERVER_NAME" \
+      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8448" \
+      CONDUIT_WELL_KNOWN_SERVER="$SERVER_NAME:8008" \
+      ${lib.getExe main'}
+  '';
+in
+
+dockerTools.buildImage {
+  name = "complement-${main.pname}";
+  tag = "dev";
+
+  copyToRoot = buildEnv {
+    name = "root";
+    pathsToLink = [
+      "/bin"
+    ];
+    paths = [
+      bashInteractive
+      coreutils
+      main'
+      start
+    ];
+  };
+
+  config = {
+    Cmd = [
+      "${lib.getExe start}"
+    ];
+
+    Entrypoint = if !stdenv.isDarwin
+      # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
+      # are handled as expected
+      then [ "${lib.getExe' tini "tini"}" "--" ]
+      else [];
+
+    Env = [
+      "SSL_CERT_FILE=/complement/ca/ca.crt"
+      "CONDUIT_CONFIG=${./config.toml}"
+    ];
+
+    ExposedPorts = {
+      "8008/tcp" = {};
+      "8448/tcp" = {};
+    };
+  };
+}

nix/pkgs/complement/v3.ext

@@ -0,0 +1,6 @@
+authorityKeyIdentifier=keyid,issuer
+basicConstraints=CA:FALSE
+keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
+subjectAltName = @alt_names
+
+[alt_names]

nix/pkgs/main/cross-compilation-env.nix

@@ -0,0 +1,100 @@
+{ lib
+, pkgsBuildHost
+, rust
+, stdenv
+}:
+
+lib.optionalAttrs stdenv.hostPlatform.isStatic {
+  ROCKSDB_STATIC = "";
+}
+//
+{
+  CARGO_BUILD_RUSTFLAGS =
+    lib.concatStringsSep
+      " "
+      ([]
+        # This disables PIE for static builds, which isn't great in terms
+        # of security. Unfortunately, my hand is forced because nixpkgs'
+        # `libstdc++.a` is built without `-fPIE`, which precludes us from
+        # leaving PIE enabled.
+        ++ lib.optionals
+          stdenv.hostPlatform.isStatic
+          [ "-C" "relocation-model=static" ]
+        ++ lib.optionals
+          (stdenv.buildPlatform.config != stdenv.hostPlatform.config)
+          [ "-l" "c" ]
+        ++ lib.optionals
+          # This check has to match the one [here][0]. We only need to set
+          # these flags when using a different linker. Don't ask me why,
+          # though, because I don't know. All I know is it breaks otherwise.
+          #
+          # [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L37-L40
+          (
+            # Nixpkgs doesn't check for x86_64 here but we do, because I
+            # observed a failure building statically for x86_64 without
+            # including it here. Linkers are weird.
+            (stdenv.hostPlatform.isAarch64 || stdenv.hostPlatform.isx86_64)
+              && stdenv.hostPlatform.isStatic
+              && !stdenv.isDarwin
+              && !stdenv.cc.bintools.isLLVM
+          )
+          [
+            "-l"
+            "stdc++"
+            "-L"
+            "${stdenv.cc.cc.lib}/${stdenv.hostPlatform.config}/lib"
+          ]
+      );
+}
+
+# What follows is stolen from [here][0]. Its purpose is to properly
+# configure compilers and linkers for various stages of the build, and
+# even covers the case of build scripts that need native code compiled and
+# run on the build platform (I think).
+#
+# [0]: https://github.com/NixOS/nixpkgs/blob/5cdb38bb16c6d0a38779db14fcc766bc1b2394d6/pkgs/build-support/rust/lib/default.nix#L57-L80
+//
+(
+  let
+    inherit (rust.lib) envVars;
+  in
+  lib.optionalAttrs
+    (stdenv.targetPlatform.rust.rustcTarget
+      != stdenv.hostPlatform.rust.rustcTarget)
+    (
+      let
+        inherit (stdenv.targetPlatform.rust) cargoEnvVarTarget;
+      in
+      {
+        "CC_${cargoEnvVarTarget}" = envVars.ccForTarget;
+        "CXX_${cargoEnvVarTarget}" = envVars.cxxForTarget;
+        "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" =
+          envVars.linkerForTarget;
+      }
+    )
+  //
+  (
+    let
+      inherit (stdenv.hostPlatform.rust) cargoEnvVarTarget rustcTarget;
+    in
+    {
+      "CC_${cargoEnvVarTarget}" = envVars.ccForHost;
+      "CXX_${cargoEnvVarTarget}" = envVars.cxxForHost;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForHost;
+      CARGO_BUILD_TARGET = rustcTarget;
+    }
+  )
+  //
+  (
+    let
+      inherit (stdenv.buildPlatform.rust) cargoEnvVarTarget;
+    in
+    {
+      "CC_${cargoEnvVarTarget}" = envVars.ccForBuild;
+      "CXX_${cargoEnvVarTarget}" = envVars.cxxForBuild;
+      "CARGO_TARGET_${cargoEnvVarTarget}_LINKER" = envVars.linkerForBuild;
+      HOST_CC = "${pkgsBuildHost.stdenv.cc}/bin/cc";
+      HOST_CXX = "${pkgsBuildHost.stdenv.cc}/bin/c++";
+    }
+  )
+)

nix/pkgs/main/default.nix

@@ -0,0 +1,96 @@
+# Dependencies (keep sorted)
+{ craneLib
+, inputs
+, lib
+, libiconv
+, pkgsBuildHost
+, rocksdb
+, rust
+, stdenv
+
+# Options (keep sorted)
+, default_features ? true
+, features ? []
+, profile ? "release"
+}:
+
+let
+buildDepsOnlyEnv =
+  let
+    rocksdb' = rocksdb.override {
+      enableJemalloc = builtins.elem "jemalloc" features;
+    };
+  in
+  {
+    CARGO_PROFILE = profile;
+    ROCKSDB_INCLUDE_DIR = "${rocksdb'}/include";
+    ROCKSDB_LIB_DIR = "${rocksdb'}/lib";
+  }
+  //
+  (import ./cross-compilation-env.nix {
+    # Keep sorted
+    inherit
+      lib
+      pkgsBuildHost
+      rust
+      stdenv;
+  });
+
+buildPackageEnv = {
+  CONDUWUIT_VERSION_EXTRA = inputs.self.shortRev or inputs.self.dirtyShortRev;
+} // buildDepsOnlyEnv;
+
+commonAttrs = {
+  inherit
+    (craneLib.crateNameFromCargoToml {
+      cargoToml = "${inputs.self}/Cargo.toml";
+    })
+    pname
+    version;
+
+    src = let filter = inputs.nix-filter.lib; in filter {
+      root = inputs.self;
+
+      # Keep sorted
+      include = [
+        "Cargo.lock"
+        "Cargo.toml"
+        "hot_lib"
+        "src"
+      ];
+    };
+
+    nativeBuildInputs = [
+      # bindgen needs the build platform's libclang. Apparently due to "splicing
+      # weirdness", pkgs.rustPlatform.bindgenHook on its own doesn't quite do the
+      # right thing here.
+      pkgsBuildHost.rustPlatform.bindgenHook
+  ]
+  ++ lib.optionals stdenv.isDarwin [ libiconv ];
+ };
+in
+
+craneLib.buildPackage ( commonAttrs // {
+  cargoArtifacts = craneLib.buildDepsOnly (commonAttrs // {
+    env = buildDepsOnlyEnv;
+  });
+
+  cargoExtraArgs = ""
+    + lib.optionalString
+      (!default_features)
+      "--no-default-features "
+    + lib.optionalString
+      (features != [])
+      "--features " + (builtins.concatStringsSep "," features);
+
+  # This is redundant with CI
+  doCheck = false;
+
+  env = buildPackageEnv;
+
+  passthru = {
+    env = buildPackageEnv;
+  };
+
+  meta.mainProgram = commonAttrs.pname;
+})

nix/pkgs/oci-image/default.nix

@@ -0,0 +1,28 @@
+{ inputs
+
+# Dependencies
+, dockerTools
+, lib
+, main
+, stdenv
+, tini
+}:
+
+dockerTools.buildLayeredImage {
+  name = main.pname;
+  tag = "main";
+  created = "@${toString inputs.self.lastModified}";
+  contents = [
+    dockerTools.caCertificates
+  ];
+  config = {
+    Entrypoint = if !stdenv.isDarwin
+      # Use the `tini` init system so that signals (e.g. ctrl+c/SIGINT)
+      # are handled as expected
+      then [ "${lib.getExe' tini "tini"}" "--" ]
+      else [];
+    Cmd = [
+      "${lib.getExe main}"
+    ];
+  };
+}

renovate.json

@@ -11,6 +11,5 @@
   },
   "nix": {
     "enabled": true
-  },
-  "ignoreDeps": ["tower-http", "axum-server", "hyper", "axum", "http"]
+  }
 }

rust-toolchain.toml

@@ -11,7 +11,7 @@
 # If you're having trouble making the relevant changes, bug a maintainer.
 
 [toolchain]
-channel = "1.75.0"
+channel = "1.76.0"
 components = [
     # For rust-analyzer
     "rust-src",
@@ -20,4 +20,4 @@ targets = [
     "x86_64-unknown-linux-gnu",
     "x86_64-unknown-linux-musl",
     "aarch64-unknown-linux-musl",
-]
+]

rustfmt.toml

@@ -24,4 +24,5 @@ group_imports = "StdExternalCrate"
 newline_style = "Unix"
 use_field_init_shorthand = true
 use_small_heuristics = "Off"
-use_try_shorthand = true
+use_try_shorthand = true
+chain_width = 60

src/alloc/default.rs

@@ -0,0 +1,7 @@
+//! Default allocator with no special features
+
+/// Always returns the empty string
+pub(crate) fn memory_stats() -> String { Default::default() }
+
+/// Always returns the empty string
+pub(crate) fn memory_usage() -> String { Default::default() }

src/alloc/hardened.rs

@@ -0,0 +1,8 @@
+#[global_allocator]
+static HMALLOC: hardened_malloc_rs::HardenedMalloc = hardened_malloc_rs::HardenedMalloc;
+
+pub(crate) fn memory_usage() -> String {
+	String::default() //TODO: get usage
+}
+
+pub(crate) fn memory_stats() -> String { "Extended statistics are not available from hardened_malloc.".to_owned() }

src/alloc/je.rs

@@ -0,0 +1,50 @@
+use std::ffi::{c_char, c_void};
+
+use tikv_jemalloc_ctl as mallctl;
+use tikv_jemalloc_sys as ffi;
+use tikv_jemallocator as jemalloc;
+
+#[global_allocator]
+static JEMALLOC: jemalloc::Jemalloc = jemalloc::Jemalloc;
+
+pub(crate) fn memory_usage() -> String {
+	use mallctl::stats;
+	let allocated = stats::allocated::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	let active = stats::active::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	let mapped = stats::mapped::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	let metadata = stats::metadata::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	let resident = stats::resident::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	let retained = stats::retained::read().unwrap_or_default() as f64 / 1024.0 / 1024.0;
+	format!(
+		" allocated: {allocated:.2} MiB\n active: {active:.2} MiB\n mapped: {mapped:.2} MiB\n metadata: {metadata:.2} \
+		 MiB\n resident: {resident:.2} MiB\n retained: {retained:.2} MiB\n "
+	)
+}
+
+pub(crate) fn memory_stats() -> String {
+	const MAX_LENGTH: usize = 65536 - 4096;
+
+	let opts_s = "d";
+	let mut str = String::new();
+
+	let opaque = std::ptr::from_mut(&mut str).cast::<c_void>();
+	let opts_p: *const c_char = std::ffi::CString::new(opts_s).expect("cstring").into_raw() as *const c_char;
+
+	// SAFETY: calls malloc_stats_print() with our string instance which must remain
+	// in this frame. https://docs.rs/tikv-jemalloc-sys/latest/tikv_jemalloc_sys/fn.malloc_stats_print.html
+	unsafe { ffi::malloc_stats_print(Some(malloc_stats_cb), opaque, opts_p) };
+
+	str.truncate(MAX_LENGTH);
+	format!("<pre><code>{str}</code></pre>")
+}
+
+extern "C" fn malloc_stats_cb(opaque: *mut c_void, msg: *const c_char) {
+	// SAFETY: we have to trust the opaque points to our String
+	let res: &mut String = unsafe { opaque.cast::<String>().as_mut().unwrap() };
+
+	// SAFETY: we have to trust the string is null terminated.
+	let msg = unsafe { std::ffi::CStr::from_ptr(msg) };
+
+	let msg = String::from_utf8_lossy(msg.to_bytes());
+	res.push_str(msg.as_ref());
+}

src/alloc/mod.rs

@@ -0,0 +1,25 @@
+//! Integration with allocators
+
+// jemalloc
+#[cfg(all(not(target_env = "msvc"), feature = "jemalloc", not(feature = "hardened_malloc")))]
+mod je;
+#[cfg(all(not(target_env = "msvc"), feature = "jemalloc", not(feature = "hardened_malloc")))]
+pub(crate) use je::{memory_stats, memory_usage};
+
+// hardened_malloc
+#[cfg(all(not(target_env = "msvc"), feature = "hardened_malloc", target_os = "linux", not(feature = "jemalloc")))]
+mod hardened;
+#[cfg(all(not(target_env = "msvc"), feature = "hardened_malloc", target_os = "linux", not(feature = "jemalloc")))]
+pub(crate) use hardened::{memory_stats, memory_usage};
+
+// default, enabled when none or multiple of the above are enabled
+#[cfg(any(
+	not(any(feature = "jemalloc", feature = "hardened_malloc")),
+	all(feature = "jemalloc", feature = "hardened_malloc"),
+))]
+mod default;
+#[cfg(any(
+	not(any(feature = "jemalloc", feature = "hardened_malloc")),
+	all(feature = "jemalloc", feature = "hardened_malloc"),
+))]
+pub(crate) use default::{memory_stats, memory_usage};

src/api/appservice_server.rs

@@ -1,94 +0,0 @@
-use std::{fmt::Debug, mem, time::Duration};
-
-use bytes::BytesMut;
-use ruma::api::{appservice::Registration, IncomingResponse, MatrixVersion, OutgoingRequest, SendAccessToken};
-use tracing::warn;
-
-use crate::{services, utils, Error, Result};
-
-/// Sends a request to an appservice
-///
-/// Only returns None if there is no url specified in the appservice
-/// registration file
-pub(crate) async fn send_request<T>(registration: Registration, request: T) -> Option<Result<T::IncomingResponse>>
-where
-	T: OutgoingRequest + Debug,
-{
-	if let Some(destination) = registration.url {
-		let hs_token = registration.hs_token.as_str();
-
-		let mut http_request = request
-			.try_into_http_request::<BytesMut>(
-				&destination,
-				SendAccessToken::IfRequired(hs_token),
-				&[MatrixVersion::V1_0],
-			)
-			.map_err(|e| {
-				warn!("Failed to find destination {}: {}", destination, e);
-				Error::BadServerResponse("Invalid destination")
-			})
-			.unwrap()
-			.map(BytesMut::freeze);
-
-		let mut parts = http_request.uri().clone().into_parts();
-		let old_path_and_query = parts.path_and_query.unwrap().as_str().to_owned();
-		let symbol = if old_path_and_query.contains('?') {
-			"&"
-		} else {
-			"?"
-		};
-
-		parts.path_and_query = Some((old_path_and_query + symbol + "access_token=" + hs_token).parse().unwrap());
-		*http_request.uri_mut() = parts.try_into().expect("our manipulation is always valid");
-
-		let mut reqwest_request =
-			reqwest::Request::try_from(http_request).expect("all http requests are valid reqwest requests");
-
-		*reqwest_request.timeout_mut() = Some(Duration::from_secs(120));
-
-		let url = reqwest_request.url().clone();
-		let mut response = match services().globals.default_client().execute(reqwest_request).await {
-			Ok(r) => r,
-			Err(e) => {
-				warn!(
-					"Could not send request to appservice {} at {}: {}",
-					registration.id, destination, e
-				);
-				return Some(Err(e.into()));
-			},
-		};
-
-		// reqwest::Response -> http::Response conversion
-		let status = response.status();
-		let mut http_response_builder = http::Response::builder().status(status).version(response.version());
-		mem::swap(
-			response.headers_mut(),
-			http_response_builder.headers_mut().expect("http::response::Builder is usable"),
-		);
-
-		let body = response.bytes().await.unwrap_or_else(|e| {
-			warn!("server error: {}", e);
-			Vec::new().into()
-		}); // TODO: handle timeout
-
-		if !status.is_success() {
-			warn!(
-				"Appservice returned bad response {} {}\n{}\n{:?}",
-				destination,
-				status,
-				url,
-				utils::string_from_bytes(&body)
-			);
-		}
-
-		let response = T::IncomingResponse::try_from_http_response(
-			http_response_builder.body(body).expect("reqwest body is valid http body"),
-		);
-		Some(response.map_err(|_| {
-			warn!("Appservice returned invalid response bytes {}\n{}", destination, url);
-			Error::BadServerResponse("Server returned bad response.")
-		}))
-	} else {
-		None
-	}
-}

src/api/client_server/account.rs

@@ -2,7 +2,8 @@ use register::RegistrationKind;
 use ruma::{
 	api::client::{
 		account::{
-			change_password, deactivate, get_3pids, get_username_availability, register,
+			change_password, deactivate, get_3pids, get_username_availability,
+			register::{self, LoginType},
 			request_3pid_management_token_via_email, request_3pid_management_token_via_msisdn, whoami,
 			ThirdPartyIdRemovalStatus,
 		},
@@ -12,10 +13,15 @@ use ruma::{
 	events::{room::message::RoomMessageEventContent, GlobalAccountDataEventType},
 	push, UserId,
 };
-use tracing::{info, warn};
+use tracing::{error, info, warn};
 
 use super::{DEVICE_ID_LENGTH, SESSION_ID_LENGTH, TOKEN_LENGTH};
-use crate::{api::client_server, services, utils, Error, Result, Ruma};
+use crate::{
+	api::client_server::{self, join_room_by_id_helper},
+	service, services,
+	utils::{self, user_id::user_is_local},
+	Error, Result, Ruma,
+};
 
 const RANDOM_USER_ID_LENGTH: usize = 10;
 
@@ -30,13 +36,13 @@ const RANDOM_USER_ID_LENGTH: usize = 10;
 ///
 /// Note: This will not reserve the username, so the username might become
 /// invalid when trying to register
-pub async fn get_register_available_route(
+pub(crate) async fn get_register_available_route(
 	body: Ruma<get_username_availability::v3::Request>,
 ) -> Result<get_username_availability::v3::Response> {
 	// Validate user id
 	let user_id = UserId::parse_with_server_name(body.username.to_lowercase(), services().globals.server_name())
 		.ok()
-		.filter(|user_id| !user_id.is_historical() && user_id.server_name() == services().globals.server_name())
+		.filter(|user_id| !user_id.is_historical() && user_is_local(user_id))
 		.ok_or(Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid."))?;
 
 	// Check if username is creative enough
@@ -44,7 +50,11 @@ pub async fn get_register_available_route(
 		return Err(Error::BadRequest(ErrorKind::UserInUse, "Desired user ID is already taken."));
 	}
 
-	if services().globals.forbidden_usernames().is_match(user_id.localpart()) {
+	if services()
+		.globals
+		.forbidden_usernames()
+		.is_match(user_id.localpart())
+	{
 		return Err(Error::BadRequest(ErrorKind::Unknown, "Username is forbidden."));
 	}
 
@@ -73,14 +83,15 @@ pub async fn get_register_available_route(
 /// - Creates a new account and populates it with default account data
 /// - If `inhibit_login` is false: Creates a device and returns device id and
 ///   access_token
-pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<register::v3::Response> {
-	if !services().globals.allow_registration() && !body.from_appservice {
+#[allow(clippy::doc_markdown)]
+pub(crate) async fn register_route(body: Ruma<register::v3::Request>) -> Result<register::v3::Response> {
+	if !services().globals.allow_registration() && body.appservice_info.is_none() {
 		info!(
 			"Registration disabled and request not from known appservice, rejecting registration attempt for username \
 			 {:?}",
 			body.username
 		);
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Registration has been disabled."));
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Registration has been disabled."));
 	}
 
 	let is_guest = body.kind == RegistrationKind::Guest;
@@ -108,7 +119,7 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 			 registration. Guest's initial device name: {:?}",
 			body.initial_device_display_name
 		);
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Registration temporarily disabled."));
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Registration temporarily disabled."));
 	}
 
 	let user_id = match (&body.username, is_guest) {
@@ -116,16 +127,18 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 			let proposed_user_id =
 				UserId::parse_with_server_name(username.to_lowercase(), services().globals.server_name())
 					.ok()
-					.filter(|user_id| {
-						!user_id.is_historical() && user_id.server_name() == services().globals.server_name()
-					})
+					.filter(|user_id| !user_id.is_historical() && user_is_local(user_id))
 					.ok_or(Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid."))?;
 
 			if services().users.exists(&proposed_user_id)? {
 				return Err(Error::BadRequest(ErrorKind::UserInUse, "Desired user ID is already taken."));
 			}
 
-			if services().globals.forbidden_usernames().is_match(proposed_user_id.localpart()) {
+			if services()
+				.globals
+				.forbidden_usernames()
+				.is_match(proposed_user_id.localpart())
+			{
 				return Err(Error::BadRequest(ErrorKind::Unknown, "Username is forbidden."));
 			}
 
@@ -143,6 +156,18 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 		},
 	};
 
+	if body.body.login_type == Some(LoginType::ApplicationService) {
+		if let Some(ref info) = body.appservice_info {
+			if !info.is_user_match(&user_id) {
+				return Err(Error::BadRequest(ErrorKind::Exclusive, "User is not in namespace."));
+			}
+		} else {
+			return Err(Error::BadRequest(ErrorKind::MissingToken, "Missing appservice token."));
+		}
+	} else if services().appservice.is_exclusive_user_id(&user_id).await {
+		return Err(Error::BadRequest(ErrorKind::Exclusive, "User ID reserved by appservice."));
+	}
+
 	// UIAA
 	let mut uiaainfo;
 	let skip_auth;
@@ -157,7 +182,7 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 			session: None,
 			auth_error: None,
 		};
-		skip_auth = body.from_appservice;
+		skip_auth = body.appservice_info.is_some();
 	} else {
 		// No registration token necessary, but clients must still go through the flow
 		uiaainfo = UiaaInfo {
@@ -169,7 +194,7 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 			session: None,
 			auth_error: None,
 		};
-		skip_auth = body.from_appservice || is_guest;
+		skip_auth = body.appservice_info.is_some() || is_guest;
 	}
 
 	if !skip_auth {
@@ -216,7 +241,10 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 		displayname.push_str(&(" ".to_owned() + services().globals.new_user_displayname_suffix()));
 	}
 
-	services().users.set_displayname(&user_id, Some(displayname.clone())).await?;
+	services()
+		.users
+		.set_displayname(&user_id, Some(displayname.clone()))
+		.await?;
 
 	// Initial account data
 	services().account_data.update(
@@ -254,31 +282,106 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 	let token = utils::random_string(TOKEN_LENGTH);
 
 	// Create device for this account
-	services().users.create_device(&user_id, &device_id, &token, body.initial_device_display_name.clone())?;
+	services()
+		.users
+		.create_device(&user_id, &device_id, &token, body.initial_device_display_name.clone())?;
 
 	info!("New user \"{}\" registered on this server.", user_id);
 
 	// log in conduit admin channel if a non-guest user registered
-	if !body.from_appservice && !is_guest {
-		services().admin.send_message(RoomMessageEventContent::notice_plain(format!(
-			"New user \"{user_id}\" registered on this server."
-		)));
+	if body.appservice_info.is_none() && !is_guest {
+		services()
+			.admin
+			.send_message(RoomMessageEventContent::notice_plain(format!(
+				"New user \"{user_id}\" registered on this server."
+			)))
+			.await;
 	}
 
 	// log in conduit admin channel if a guest registered
-	if !body.from_appservice && is_guest {
-		services().admin.send_message(RoomMessageEventContent::notice_plain(format!(
-			"Guest user \"{user_id}\" with device display name `{:?}` registered on this server.",
-			body.initial_device_display_name
-		)));
+	if body.appservice_info.is_none() && is_guest && services().globals.log_guest_registrations() {
+		if let Some(device_display_name) = &body.initial_device_display_name {
+			if body
+				.initial_device_display_name
+				.as_ref()
+				.is_some_and(|device_display_name| !device_display_name.is_empty())
+			{
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::notice_plain(format!(
+						"Guest user \"{user_id}\" with device display name `{device_display_name}` registered on this \
+						 server."
+					)))
+					.await;
+			} else {
+				services()
+					.admin
+					.send_message(RoomMessageEventContent::notice_plain(format!(
+						"Guest user \"{user_id}\" with no device display name registered on this server.",
+					)))
+					.await;
+			}
+		} else {
+			services()
+				.admin
+				.send_message(RoomMessageEventContent::notice_plain(format!(
+					"Guest user \"{user_id}\" with no device display name registered on this server.",
+				)))
+				.await;
+		}
 	}
 
 	// If this is the first real user, grant them admin privileges except for guest
 	// users Note: the server user, @conduit:servername, is generated first
-	if services().users.count()? == 2 && !is_guest {
-		services().admin.make_user_admin(&user_id, displayname).await?;
+	if !is_guest {
+		if let Some(admin_room) = service::admin::Service::get_admin_room().await? {
+			if services()
+				.rooms
+				.state_cache
+				.room_joined_count(&admin_room)?
+				== Some(1)
+			{
+				services()
+					.admin
+					.make_user_admin(&user_id, displayname)
+					.await?;
 
-		warn!("Granting {} admin privileges as the first user", user_id);
+				warn!("Granting {} admin privileges as the first user", user_id);
+			}
+		}
+	}
+
+	if body.appservice_info.is_none()
+		&& !services().globals.config.auto_join_rooms.is_empty()
+		&& (services().globals.allow_guests_auto_join_rooms() || !is_guest)
+	{
+		for room in &services().globals.config.auto_join_rooms {
+			if !services()
+				.rooms
+				.state_cache
+				.server_in_room(services().globals.server_name(), room)?
+			{
+				warn!("Skipping room {room} to automatically join as we have never joined before.");
+				continue;
+			}
+
+			if let Some(room_id_server_name) = room.server_name() {
+				if let Err(e) = join_room_by_id_helper(
+					Some(&user_id),
+					room,
+					Some("Automatically joining this room upon registration".to_owned()),
+					&[room_id_server_name.to_owned(), services().globals.server_name().to_owned()],
+					None,
+				)
+				.await
+				{
+					// don't return this error so we don't fail registrations
+					error!("Failed to automatically join room {room} for user {user_id}: {e}");
+				} else {
+					info!("Automatically joined room {room} for user {user_id}");
+				};
+			}
+		}
 	}
 
 	Ok(register::v3::Response {
@@ -307,7 +410,9 @@ pub async fn register_route(body: Ruma<register::v3::Request>) -> Result<registe
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn change_password_route(body: Ruma<change_password::v3::Request>) -> Result<change_password::v3::Response> {
+pub(crate) async fn change_password_route(
+	body: Ruma<change_password::v3::Request>,
+) -> Result<change_password::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -322,27 +427,33 @@ pub async fn change_password_route(body: Ruma<change_password::v3::Request>) ->
 	};
 
 	if let Some(auth) = &body.auth {
-		let (worked, uiaainfo) = services().uiaa.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
+		let (worked, uiaainfo) = services()
+			.uiaa
+			.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
 		if !worked {
 			return Err(Error::Uiaa(uiaainfo));
 		}
 	// Success!
 	} else if let Some(json) = body.json_body {
 		uiaainfo.session = Some(utils::random_string(SESSION_ID_LENGTH));
-		services().uiaa.create(sender_user, sender_device, &uiaainfo, &json)?;
+		services()
+			.uiaa
+			.create(sender_user, sender_device, &uiaainfo, &json)?;
 		return Err(Error::Uiaa(uiaainfo));
 	} else {
 		return Err(Error::BadRequest(ErrorKind::NotJson, "Not json."));
 	}
 
-	services().users.set_password(sender_user, Some(&body.new_password))?;
+	services()
+		.users
+		.set_password(sender_user, Some(&body.new_password))?;
 
 	if body.logout_devices {
 		// Logout all devices except the current one
 		for id in services()
 			.users
 			.all_device_ids(sender_user)
-			.filter_map(std::result::Result::ok)
+			.filter_map(Result::ok)
 			.filter(|id| id != sender_device)
 		{
 			services().users.remove_device(sender_user, &id)?;
@@ -350,26 +461,29 @@ pub async fn change_password_route(body: Ruma<change_password::v3::Request>) ->
 	}
 
 	info!("User {} changed their password.", sender_user);
-	services().admin.send_message(RoomMessageEventContent::notice_plain(format!(
-		"User {sender_user} changed their password."
-	)));
+	services()
+		.admin
+		.send_message(RoomMessageEventContent::notice_plain(format!(
+			"User {sender_user} changed their password."
+		)))
+		.await;
 
 	Ok(change_password::v3::Response {})
 }
 
 /// # `GET _matrix/client/r0/account/whoami`
 ///
-/// Get user_id of the sender user.
+/// Get `user_id` of the sender user.
 ///
 /// Note: Also works for Application Services
-pub async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3::Response> {
+pub(crate) async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let device_id = body.sender_device.clone();
 
 	Ok(whoami::v3::Response {
 		user_id: sender_user.clone(),
 		device_id,
-		is_guest: services().users.is_deactivated(sender_user)? && !body.from_appservice,
+		is_guest: services().users.is_deactivated(sender_user)? && body.appservice_info.is_none(),
 	})
 }
 
@@ -384,7 +498,7 @@ pub async fn whoami_route(body: Ruma<whoami::v3::Request>) -> Result<whoami::v3:
 /// - Forgets all to-device events
 /// - Triggers device list updates
 /// - Removes ability to log in again
-pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<deactivate::v3::Response> {
+pub(crate) async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<deactivate::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -399,14 +513,18 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 	};
 
 	if let Some(auth) = &body.auth {
-		let (worked, uiaainfo) = services().uiaa.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
+		let (worked, uiaainfo) = services()
+			.uiaa
+			.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
 		if !worked {
 			return Err(Error::Uiaa(uiaainfo));
 		}
 	// Success!
 	} else if let Some(json) = body.json_body {
 		uiaainfo.session = Some(utils::random_string(SESSION_ID_LENGTH));
-		services().uiaa.create(sender_user, sender_device, &uiaainfo, &json)?;
+		services()
+			.uiaa
+			.create(sender_user, sender_device, &uiaainfo, &json)?;
 		return Err(Error::Uiaa(uiaainfo));
 	} else {
 		return Err(Error::BadRequest(ErrorKind::NotJson, "Not json."));
@@ -419,9 +537,12 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 	services().users.deactivate_account(sender_user)?;
 
 	info!("User {} deactivated their account.", sender_user);
-	services().admin.send_message(RoomMessageEventContent::notice_plain(format!(
-		"User {sender_user} deactivated their account."
-	)));
+	services()
+		.admin
+		.send_message(RoomMessageEventContent::notice_plain(format!(
+			"User {sender_user} deactivated their account."
+		)))
+		.await;
 
 	Ok(deactivate::v3::Response {
 		id_server_unbind_result: ThirdPartyIdRemovalStatus::NoSupport,
@@ -433,7 +554,7 @@ pub async fn deactivate_route(body: Ruma<deactivate::v3::Request>) -> Result<dea
 /// Get a list of third party identifiers associated with this account.
 ///
 /// - Currently always returns empty list
-pub async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get_3pids::v3::Response> {
+pub(crate) async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get_3pids::v3::Response> {
 	let _sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	Ok(get_3pids::v3::Response::new(Vec::new()))
@@ -446,7 +567,7 @@ pub async fn third_party_route(body: Ruma<get_3pids::v3::Request>) -> Result<get
 ///
 /// - 403 signals that The homeserver does not allow the third party identifier
 ///   as a contact option.
-pub async fn request_3pid_management_token_via_email_route(
+pub(crate) async fn request_3pid_management_token_via_email_route(
 	_body: Ruma<request_3pid_management_token_via_email::v3::Request>,
 ) -> Result<request_3pid_management_token_via_email::v3::Response> {
 	Err(Error::BadRequest(
@@ -462,7 +583,7 @@ pub async fn request_3pid_management_token_via_email_route(
 ///
 /// - 403 signals that The homeserver does not allow the third party identifier
 ///   as a contact option.
-pub async fn request_3pid_management_token_via_msisdn_route(
+pub(crate) async fn request_3pid_management_token_via_msisdn_route(
 	_body: Ruma<request_3pid_management_token_via_msisdn::v3::Request>,
 ) -> Result<request_3pid_management_token_via_msisdn::v3::Response> {
 	Err(Error::BadRequest(

src/api/client_server/alias.rs

@@ -8,28 +8,46 @@ use ruma::{
 		},
 		federation,
 	},
-	OwnedRoomAliasId, OwnedServerName,
+	OwnedRoomAliasId, OwnedRoomId, OwnedServerName,
 };
+use tracing::debug;
 
-use crate::{services, Error, Result, Ruma};
+use crate::{
+	debug_info, debug_warn, service::appservice::RegistrationInfo, services, utils::server_name::server_is_ours, Error,
+	Result, Ruma,
+};
 
 /// # `PUT /_matrix/client/v3/directory/room/{roomAlias}`
 ///
 /// Creates a new room alias on this server.
-pub async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result<create_alias::v3::Response> {
-	if body.room_alias.server_name() != services().globals.server_name() {
-		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
+pub(crate) async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result<create_alias::v3::Response> {
+	alias_checks(&body.room_alias, &body.appservice_info).await?;
+
+	// this isn't apart of alias_checks or delete alias route because we should
+	// allow removing forbidden room aliases
+	if services()
+		.globals
+		.forbidden_alias_names()
+		.is_match(body.room_alias.alias())
+	{
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Room alias is forbidden."));
 	}
 
-	if services().globals.forbidden_room_names().is_match(body.room_alias.alias()) {
-		return Err(Error::BadRequest(ErrorKind::Unknown, "Room alias is forbidden."));
-	}
-
-	if services().rooms.alias.resolve_local_alias(&body.room_alias)?.is_some() {
+	if services()
+		.rooms
+		.alias
+		.resolve_local_alias(&body.room_alias)?
+		.is_some()
+	{
 		return Err(Error::Conflict("Alias already exists."));
 	}
 
-	if services().rooms.alias.set_alias(&body.room_alias, &body.room_id).is_err() {
+	if services()
+		.rooms
+		.alias
+		.set_alias(&body.room_alias, &body.room_id)
+		.is_err()
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::InvalidParam,
 			"Invalid room alias. Alias must be in the form of '#localpart:server_name'",
@@ -45,16 +63,24 @@ pub async fn create_alias_route(body: Ruma<create_alias::v3::Request>) -> Result
 ///
 /// - TODO: additional access control checks
 /// - TODO: Update canonical alias event
-pub async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result<delete_alias::v3::Response> {
-	if body.room_alias.server_name() != services().globals.server_name() {
-		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
-	}
+pub(crate) async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result<delete_alias::v3::Response> {
+	alias_checks(&body.room_alias, &body.appservice_info).await?;
 
-	if services().rooms.alias.resolve_local_alias(&body.room_alias)?.is_none() {
+	if services()
+		.rooms
+		.alias
+		.resolve_local_alias(&body.room_alias)?
+		.is_none()
+	{
 		return Err(Error::BadRequest(ErrorKind::NotFound, "Alias does not exist."));
 	}
 
-	if services().rooms.alias.remove_alias(&body.room_alias).is_err() {
+	if services()
+		.rooms
+		.alias
+		.remove_alias(&body.room_alias)
+		.is_err()
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::InvalidParam,
 			"Invalid room alias. Alias must be in the form of '#localpart:server_name'",
@@ -69,13 +95,21 @@ pub async fn delete_alias_route(body: Ruma<delete_alias::v3::Request>) -> Result
 /// # `GET /_matrix/client/v3/directory/room/{roomAlias}`
 ///
 /// Resolve an alias locally or over federation.
-pub async fn get_alias_route(body: Ruma<get_alias::v3::Request>) -> Result<get_alias::v3::Response> {
-	get_alias_helper(body.body.room_alias).await
+pub(crate) async fn get_alias_route(body: Ruma<get_alias::v3::Request>) -> Result<get_alias::v3::Response> {
+	get_alias_helper(body.body.room_alias, None).await
 }
 
-pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get_alias::v3::Response> {
-	if room_alias.server_name() != services().globals.server_name() {
-		let response = services()
+pub(crate) async fn get_alias_helper(
+	room_alias: OwnedRoomAliasId, servers: Option<Vec<OwnedServerName>>,
+) -> Result<get_alias::v3::Response> {
+	debug!("get_alias_helper servers: {servers:?}");
+	if !server_is_ours(room_alias.server_name())
+		&& (!servers
+			.as_ref()
+			.is_some_and(|servers| servers.contains(&services().globals.server_name().to_owned()))
+			|| servers.as_ref().is_none())
+	{
+		let mut response = services()
 			.sending
 			.send_federation_request(
 				room_alias.server_name(),
@@ -83,54 +117,83 @@ pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get
 					room_alias: room_alias.clone(),
 				},
 			)
-			.await?;
+			.await;
 
-		let room_id = response.room_id;
+		debug_info!("room alias server_name get_alias_helper response: {response:?}");
 
-		let mut servers = response.servers;
-
-		// find active servers in room state cache to suggest
-		for extra_servers in services().rooms.state_cache.room_servers(&room_id).filter_map(std::result::Result::ok) {
-			servers.push(extra_servers);
+		if let Err(ref e) = response {
+			debug_info!(
+				"Server {} of the original room alias failed to assist in resolving room alias: {e}",
+				room_alias.server_name()
+			);
 		}
 
-		// insert our server as the very first choice if in list
-		if let Some(server_index) =
-			servers.clone().into_iter().position(|server| server == services().globals.server_name())
-		{
-			servers.remove(server_index);
-			servers.insert(0, services().globals.server_name().to_owned());
+		if response.as_ref().is_ok_and(|resp| resp.servers.is_empty()) || response.as_ref().is_err() {
+			if let Some(servers) = servers {
+				for server in servers {
+					response = services()
+						.sending
+						.send_federation_request(
+							&server,
+							federation::query::get_room_information::v1::Request {
+								room_alias: room_alias.clone(),
+							},
+						)
+						.await;
+					debug_info!("Got response from server {server} for room aliases: {response:?}");
+
+					if let Ok(ref response) = response {
+						if !response.servers.is_empty() {
+							break;
+						}
+						debug_warn!(
+							"Server {server} responded with room aliases, but was empty? Response: {response:?}"
+						);
+					}
+				}
+			}
 		}
 
-		servers.sort_unstable();
-		servers.dedup();
+		if let Ok(response) = response {
+			let room_id = response.room_id;
 
-		// shuffle list of servers randomly after sort and dedupe
-		servers.shuffle(&mut rand::thread_rng());
+			let mut pre_servers = response.servers;
+			// since the room alis server responded, insert it into the list
+			pre_servers.push(room_alias.server_name().into());
 
-		return Ok(get_alias::v3::Response::new(room_id, servers));
+			let servers = room_available_servers(&room_id, &room_alias, &Some(pre_servers));
+			debug_warn!(
+				"room alias servers from federation response for room ID {room_id} and room alias {room_alias}: \
+				 {servers:?}"
+			);
+
+			return Ok(get_alias::v3::Response::new(room_id, servers));
+		}
+
+		return Err(Error::BadRequest(
+			ErrorKind::NotFound,
+			"No servers could assist in resolving the room alias",
+		));
 	}
 
 	let mut room_id = None;
 	match services().rooms.alias.resolve_local_alias(&room_alias)? {
 		Some(r) => room_id = Some(r),
 		None => {
-			for appservice in services().appservice.registration_info.read().await.values() {
+			for appservice in services().appservice.read().await.values() {
 				if appservice.aliases.is_match(room_alias.as_str())
-					&& if let Some(opt_result) = services()
-						.sending
-						.send_appservice_request(
-							appservice.registration.clone(),
-							appservice::query::query_room_alias::v1::Request {
-								room_alias: room_alias.clone(),
-							},
-						)
-						.await
-					{
-						opt_result.is_ok()
-					} else {
-						false
-					} {
+					&& matches!(
+						services()
+							.sending
+							.send_appservice_request(
+								appservice.registration.clone(),
+								appservice::query::query_room_alias::v1::Request {
+									room_alias: room_alias.clone(),
+								},
+							)
+							.await,
+						Ok(Some(_opt_result))
+					) {
 					room_id = Some(
 						services()
 							.rooms
@@ -144,25 +207,33 @@ pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get
 		},
 	};
 
-	let room_id = match room_id {
-		Some(room_id) => room_id,
-		None => return Err(Error::BadRequest(ErrorKind::NotFound, "Room with alias not found.")),
+	let Some(room_id) = room_id else {
+		return Err(Error::BadRequest(ErrorKind::NotFound, "Room with alias not found."));
 	};
 
-	let mut servers: Vec<OwnedServerName> = Vec::new();
+	let servers = room_available_servers(&room_id, &room_alias, &None);
 
+	debug_warn!("room alias servers for room ID {room_id} and room alias {room_alias}");
+
+	Ok(get_alias::v3::Response::new(room_id, servers))
+}
+
+fn room_available_servers(
+	room_id: &OwnedRoomId, room_alias: &OwnedRoomAliasId, pre_servers: &Option<Vec<OwnedServerName>>,
+) -> Vec<OwnedServerName> {
 	// find active servers in room state cache to suggest
-	for extra_servers in services().rooms.state_cache.room_servers(&room_id).filter_map(std::result::Result::ok) {
-		servers.push(extra_servers);
-	}
+	let mut servers: Vec<OwnedServerName> = services()
+		.rooms
+		.state_cache
+		.room_servers(room_id)
+		.filter_map(Result::ok)
+		.collect();
 
-	// insert our server as the very first choice if in list
-	if let Some(server_index) =
-		servers.clone().into_iter().position(|server| server == services().globals.server_name())
-	{
-		servers.remove(server_index);
-		servers.insert(0, services().globals.server_name().to_owned());
-	}
+	// push any servers we want in the list already (e.g. responded remote alias
+	// servers, room alias server itself)
+	if let Some(pre_servers) = pre_servers {
+		servers.extend(pre_servers.clone());
+	};
 
 	servers.sort_unstable();
 	servers.dedup();
@@ -170,5 +241,39 @@ pub(crate) async fn get_alias_helper(room_alias: OwnedRoomAliasId) -> Result<get
 	// shuffle list of servers randomly after sort and dedupe
 	servers.shuffle(&mut rand::thread_rng());
 
-	Ok(get_alias::v3::Response::new(room_id, servers))
+	// insert our server as the very first choice if in list, else check if we can
+	// prefer the room alias server first
+	if let Some(server_index) = servers
+		.iter()
+		.position(|server_name| server_is_ours(server_name))
+	{
+		servers.remove(server_index);
+		servers.insert(0, services().globals.server_name().to_owned());
+	} else if let Some(alias_server_index) = servers
+		.iter()
+		.position(|server| server == room_alias.server_name())
+	{
+		servers.remove(alias_server_index);
+		servers.insert(0, room_alias.server_name().into());
+	}
+
+	servers
+}
+
+async fn alias_checks(room_alias: &OwnedRoomAliasId, appservice_info: &Option<RegistrationInfo>) -> Result<()> {
+	if !server_is_ours(room_alias.server_name()) {
+		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Alias is from another server."));
+	}
+
+	if let Some(ref info) = appservice_info {
+		if !info.aliases.is_match(room_alias.as_str()) {
+			return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias is not in namespace."));
+		}
+	}
+
+	if services().appservice.is_exclusive_alias(room_alias).await {
+		return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias reserved by appservice."));
+	}
+
+	Ok(())
 }

src/api/client_server/backup.rs

@@ -13,11 +13,13 @@ use crate::{services, Error, Result, Ruma};
 /// # `POST /_matrix/client/r0/room_keys/version`
 ///
 /// Creates a new backup.
-pub async fn create_backup_version_route(
+pub(crate) async fn create_backup_version_route(
 	body: Ruma<create_backup_version::v3::Request>,
 ) -> Result<create_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-	let version = services().key_backups.create_backup(sender_user, &body.algorithm)?;
+	let version = services()
+		.key_backups
+		.create_backup(sender_user, &body.algorithm)?;
 
 	Ok(create_backup_version::v3::Response {
 		version,
@@ -28,11 +30,13 @@ pub async fn create_backup_version_route(
 ///
 /// Update information about an existing backup. Only `auth_data` can be
 /// modified.
-pub async fn update_backup_version_route(
+pub(crate) async fn update_backup_version_route(
 	body: Ruma<update_backup_version::v3::Request>,
 ) -> Result<update_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-	services().key_backups.update_backup(sender_user, &body.version, &body.algorithm)?;
+	services()
+		.key_backups
+		.update_backup(sender_user, &body.version, &body.algorithm)?;
 
 	Ok(update_backup_version::v3::Response {})
 }
@@ -40,7 +44,7 @@ pub async fn update_backup_version_route(
 /// # `GET /_matrix/client/r0/room_keys/version`
 ///
 /// Get information about the latest backup version.
-pub async fn get_latest_backup_info_route(
+pub(crate) async fn get_latest_backup_info_route(
 	body: Ruma<get_latest_backup_info::v3::Request>,
 ) -> Result<get_latest_backup_info::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -48,7 +52,7 @@ pub async fn get_latest_backup_info_route(
 	let (version, algorithm) = services()
 		.key_backups
 		.get_latest_backup(sender_user)?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
 
 	Ok(get_latest_backup_info::v3::Response {
 		algorithm,
@@ -58,20 +62,27 @@ pub async fn get_latest_backup_info_route(
 	})
 }
 
-/// # `GET /_matrix/client/r0/room_keys/version`
+/// # `GET /_matrix/client/v3/room_keys/version/{version}`
 ///
 /// Get information about an existing backup.
-pub async fn get_backup_info_route(body: Ruma<get_backup_info::v3::Request>) -> Result<get_backup_info::v3::Response> {
+pub(crate) async fn get_backup_info_route(
+	body: Ruma<get_backup_info::v3::Request>,
+) -> Result<get_backup_info::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let algorithm = services()
 		.key_backups
 		.get_backup(sender_user, &body.version)?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Key backup does not exist."))?;
 
 	Ok(get_backup_info::v3::Response {
 		algorithm,
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 		version: body.version.clone(),
 	})
 }
@@ -82,12 +93,14 @@ pub async fn get_backup_info_route(body: Ruma<get_backup_info::v3::Request>) ->
 ///
 /// - Deletes both information about the backup, as well as all key data related
 ///   to the backup
-pub async fn delete_backup_version_route(
+pub(crate) async fn delete_backup_version_route(
 	body: Ruma<delete_backup_version::v3::Request>,
 ) -> Result<delete_backup_version::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().key_backups.delete_backup(sender_user, &body.version)?;
+	services()
+		.key_backups
+		.delete_backup(sender_user, &body.version)?;
 
 	Ok(delete_backup_version::v3::Response {})
 }
@@ -100,10 +113,17 @@ pub async fn delete_backup_version_route(
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) -> Result<add_backup_keys::v3::Response> {
+pub(crate) async fn add_backup_keys_route(
+	body: Ruma<add_backup_keys::v3::Request>,
+) -> Result<add_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if Some(&body.version) != services().key_backups.get_latest_backup_version(sender_user)?.as_ref() {
+	if Some(&body.version)
+		!= services()
+			.key_backups
+			.get_latest_backup_version(sender_user)?
+			.as_ref()
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::InvalidParam,
 			"You may only manipulate the most recently created version of the backup.",
@@ -112,13 +132,20 @@ pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) ->
 
 	for (room_id, room) in &body.rooms {
 		for (session_id, key_data) in &room.sessions {
-			services().key_backups.add_key(sender_user, &body.version, room_id, session_id, key_data)?;
+			services()
+				.key_backups
+				.add_key(sender_user, &body.version, room_id, session_id, key_data)?;
 		}
 	}
 
 	Ok(add_backup_keys::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }
 
@@ -130,12 +157,17 @@ pub async fn add_backup_keys_route(body: Ruma<add_backup_keys::v3::Request>) ->
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_for_room_route(
+pub(crate) async fn add_backup_keys_for_room_route(
 	body: Ruma<add_backup_keys_for_room::v3::Request>,
 ) -> Result<add_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if Some(&body.version) != services().key_backups.get_latest_backup_version(sender_user)?.as_ref() {
+	if Some(&body.version)
+		!= services()
+			.key_backups
+			.get_latest_backup_version(sender_user)?
+			.as_ref()
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::InvalidParam,
 			"You may only manipulate the most recently created version of the backup.",
@@ -143,12 +175,19 @@ pub async fn add_backup_keys_for_room_route(
 	}
 
 	for (session_id, key_data) in &body.sessions {
-		services().key_backups.add_key(sender_user, &body.version, &body.room_id, session_id, key_data)?;
+		services()
+			.key_backups
+			.add_key(sender_user, &body.version, &body.room_id, session_id, key_data)?;
 	}
 
 	Ok(add_backup_keys_for_room::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }
 
@@ -160,30 +199,44 @@ pub async fn add_backup_keys_for_room_route(
 ///   allowed
 /// - Adds the keys to the backup
 /// - Returns the new number of keys in this backup and the etag
-pub async fn add_backup_keys_for_session_route(
+pub(crate) async fn add_backup_keys_for_session_route(
 	body: Ruma<add_backup_keys_for_session::v3::Request>,
 ) -> Result<add_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if Some(&body.version) != services().key_backups.get_latest_backup_version(sender_user)?.as_ref() {
+	if Some(&body.version)
+		!= services()
+			.key_backups
+			.get_latest_backup_version(sender_user)?
+			.as_ref()
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::InvalidParam,
 			"You may only manipulate the most recently created version of the backup.",
 		));
 	}
 
-	services().key_backups.add_key(sender_user, &body.version, &body.room_id, &body.session_id, &body.session_data)?;
+	services()
+		.key_backups
+		.add_key(sender_user, &body.version, &body.room_id, &body.session_id, &body.session_data)?;
 
 	Ok(add_backup_keys_for_session::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }
 
 /// # `GET /_matrix/client/r0/room_keys/keys`
 ///
 /// Retrieves all keys from the backup.
-pub async fn get_backup_keys_route(body: Ruma<get_backup_keys::v3::Request>) -> Result<get_backup_keys::v3::Response> {
+pub(crate) async fn get_backup_keys_route(
+	body: Ruma<get_backup_keys::v3::Request>,
+) -> Result<get_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let rooms = services().key_backups.get_all(sender_user, &body.version)?;
@@ -196,12 +249,14 @@ pub async fn get_backup_keys_route(body: Ruma<get_backup_keys::v3::Request>) ->
 /// # `GET /_matrix/client/r0/room_keys/keys/{roomId}`
 ///
 /// Retrieves all keys from the backup for a given room.
-pub async fn get_backup_keys_for_room_route(
+pub(crate) async fn get_backup_keys_for_room_route(
 	body: Ruma<get_backup_keys_for_room::v3::Request>,
 ) -> Result<get_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let sessions = services().key_backups.get_room(sender_user, &body.version, &body.room_id)?;
+	let sessions = services()
+		.key_backups
+		.get_room(sender_user, &body.version, &body.room_id)?;
 
 	Ok(get_backup_keys_for_room::v3::Response {
 		sessions,
@@ -211,15 +266,15 @@ pub async fn get_backup_keys_for_room_route(
 /// # `GET /_matrix/client/r0/room_keys/keys/{roomId}/{sessionId}`
 ///
 /// Retrieves a key from the backup.
-pub async fn get_backup_keys_for_session_route(
+pub(crate) async fn get_backup_keys_for_session_route(
 	body: Ruma<get_backup_keys_for_session::v3::Request>,
 ) -> Result<get_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let key_data =
-		services().key_backups.get_session(sender_user, &body.version, &body.room_id, &body.session_id)?.ok_or(
-			Error::BadRequest(ErrorKind::NotFound, "Backup key not found for this user's session."),
-		)?;
+	let key_data = services()
+		.key_backups
+		.get_session(sender_user, &body.version, &body.room_id, &body.session_id)?
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Backup key not found for this user's session."))?;
 
 	Ok(get_backup_keys_for_session::v3::Response {
 		key_data,
@@ -229,47 +284,68 @@ pub async fn get_backup_keys_for_session_route(
 /// # `DELETE /_matrix/client/r0/room_keys/keys`
 ///
 /// Delete the keys from the backup.
-pub async fn delete_backup_keys_route(
+pub(crate) async fn delete_backup_keys_route(
 	body: Ruma<delete_backup_keys::v3::Request>,
 ) -> Result<delete_backup_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().key_backups.delete_all_keys(sender_user, &body.version)?;
+	services()
+		.key_backups
+		.delete_all_keys(sender_user, &body.version)?;
 
 	Ok(delete_backup_keys::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }
 
 /// # `DELETE /_matrix/client/r0/room_keys/keys/{roomId}`
 ///
 /// Delete the keys from the backup for a given room.
-pub async fn delete_backup_keys_for_room_route(
+pub(crate) async fn delete_backup_keys_for_room_route(
 	body: Ruma<delete_backup_keys_for_room::v3::Request>,
 ) -> Result<delete_backup_keys_for_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().key_backups.delete_room_keys(sender_user, &body.version, &body.room_id)?;
+	services()
+		.key_backups
+		.delete_room_keys(sender_user, &body.version, &body.room_id)?;
 
 	Ok(delete_backup_keys_for_room::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }
 
 /// # `DELETE /_matrix/client/r0/room_keys/keys/{roomId}/{sessionId}`
 ///
 /// Delete a key from the backup.
-pub async fn delete_backup_keys_for_session_route(
+pub(crate) async fn delete_backup_keys_for_session_route(
 	body: Ruma<delete_backup_keys_for_session::v3::Request>,
 ) -> Result<delete_backup_keys_for_session::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().key_backups.delete_room_key(sender_user, &body.version, &body.room_id, &body.session_id)?;
+	services()
+		.key_backups
+		.delete_room_key(sender_user, &body.version, &body.room_id, &body.session_id)?;
 
 	Ok(delete_backup_keys_for_session::v3::Response {
-		count: (services().key_backups.count_keys(sender_user, &body.version)? as u32).into(),
-		etag: services().key_backups.get_etag(sender_user, &body.version)?,
+		count: (services()
+			.key_backups
+			.count_keys(sender_user, &body.version)? as u32)
+			.into(),
+		etag: services()
+			.key_backups
+			.get_etag(sender_user, &body.version)?,
 	})
 }

src/api/client_server/capabilities.rs

@@ -1,16 +1,16 @@
 use std::collections::BTreeMap;
 
 use ruma::api::client::discovery::get_capabilities::{
-	self, Capabilities, RoomVersionStability, RoomVersionsCapability,
+	self, Capabilities, RoomVersionStability, RoomVersionsCapability, ThirdPartyIdChangesCapability,
 };
 
 use crate::{services, Result, Ruma};
 
-/// # `GET /_matrix/client/r0/capabilities`
+/// # `GET /_matrix/client/v3/capabilities`
 ///
 /// Get information on the supported feature set and other relevent capabilities
 /// of this server.
-pub async fn get_capabilities_route(
+pub(crate) async fn get_capabilities_route(
 	_body: Ruma<get_capabilities::v3::Request>,
 ) -> Result<get_capabilities::v3::Response> {
 	let mut available = BTreeMap::new();
@@ -21,12 +21,17 @@ pub async fn get_capabilities_route(
 		available.insert(room_version.clone(), RoomVersionStability::Stable);
 	}
 
-	let mut capabilities = Capabilities::new();
+	let mut capabilities = Capabilities::default();
 	capabilities.room_versions = RoomVersionsCapability {
 		default: services().globals.default_room_version(),
 		available,
 	};
 
+	// conduit does not implement 3PID stuff
+	capabilities.thirdparty_id_changes = ThirdPartyIdChangesCapability {
+		enabled: false,
+	};
+
 	Ok(get_capabilities::v3::Response {
 		capabilities,
 	})

src/api/client_server/config.rs

@@ -5,6 +5,7 @@ use ruma::{
 	},
 	events::{AnyGlobalAccountDataEventContent, AnyRoomAccountDataEventContent},
 	serde::Raw,
+	OwnedUserId, RoomId,
 };
 use serde::Deserialize;
 use serde_json::{json, value::RawValue as RawJsonValue};
@@ -14,25 +15,10 @@ use crate::{services, Error, Result, Ruma};
 /// # `PUT /_matrix/client/r0/user/{userId}/account_data/{type}`
 ///
 /// Sets some account data for the sender user.
-pub async fn set_global_account_data_route(
+pub(crate) async fn set_global_account_data_route(
 	body: Ruma<set_global_account_data::v3::Request>,
 ) -> Result<set_global_account_data::v3::Response> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	let data: serde_json::Value = serde_json::from_str(body.data.json().get())
-		.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
-
-	let event_type = body.event_type.to_string();
-
-	services().account_data.update(
-		None,
-		sender_user,
-		event_type.clone().into(),
-		&json!({
-			"type": event_type,
-			"content": data,
-		}),
-	)?;
+	set_account_data(None, &body.sender_user, &body.event_type.to_string(), body.data.json())?;
 
 	Ok(set_global_account_data::v3::Response {})
 }
@@ -40,24 +26,14 @@ pub async fn set_global_account_data_route(
 /// # `PUT /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}`
 ///
 /// Sets some room account data for the sender user.
-pub async fn set_room_account_data_route(
+pub(crate) async fn set_room_account_data_route(
 	body: Ruma<set_room_account_data::v3::Request>,
 ) -> Result<set_room_account_data::v3::Response> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	let data: serde_json::Value = serde_json::from_str(body.data.json().get())
-		.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
-
-	let event_type = body.event_type.to_string();
-
-	services().account_data.update(
+	set_account_data(
 		Some(&body.room_id),
-		sender_user,
-		event_type.clone().into(),
-		&json!({
-			"type": event_type,
-			"content": data,
-		}),
+		&body.sender_user,
+		&body.event_type.to_string(),
+		body.data.json(),
 	)?;
 
 	Ok(set_room_account_data::v3::Response {})
@@ -66,7 +42,7 @@ pub async fn set_room_account_data_route(
 /// # `GET /_matrix/client/r0/user/{userId}/account_data/{type}`
 ///
 /// Gets some account data for the sender user.
-pub async fn get_global_account_data_route(
+pub(crate) async fn get_global_account_data_route(
 	body: Ruma<get_global_account_data::v3::Request>,
 ) -> Result<get_global_account_data::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -74,7 +50,7 @@ pub async fn get_global_account_data_route(
 	let event: Box<RawJsonValue> = services()
 		.account_data
 		.get(None, sender_user, body.event_type.to_string().into())?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
 
 	let account_data = serde_json::from_str::<ExtractGlobalEventContent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
@@ -88,7 +64,7 @@ pub async fn get_global_account_data_route(
 /// # `GET /_matrix/client/r0/user/{userId}/rooms/{roomId}/account_data/{type}`
 ///
 /// Gets some room account data for the sender user.
-pub async fn get_room_account_data_route(
+pub(crate) async fn get_room_account_data_route(
 	body: Ruma<get_room_account_data::v3::Request>,
 ) -> Result<get_room_account_data::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -96,7 +72,7 @@ pub async fn get_room_account_data_route(
 	let event: Box<RawJsonValue> = services()
 		.account_data
 		.get(Some(&body.room_id), sender_user, body.event_type.clone())?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
+		.ok_or_else(|| Error::BadRequest(ErrorKind::NotFound, "Data not found."))?;
 
 	let account_data = serde_json::from_str::<ExtractRoomEventContent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
@@ -107,6 +83,27 @@ pub async fn get_room_account_data_route(
 	})
 }
 
+fn set_account_data(
+	room_id: Option<&RoomId>, sender_user: &Option<OwnedUserId>, event_type: &str, data: &RawJsonValue,
+) -> Result<()> {
+	let sender_user = sender_user.as_ref().expect("user is authenticated");
+
+	let data: serde_json::Value =
+		serde_json::from_str(data.get()).map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Data is invalid."))?;
+
+	services().account_data.update(
+		room_id,
+		sender_user,
+		event_type.into(),
+		&json!({
+			"type": event_type,
+			"content": data,
+		}),
+	)?;
+
+	Ok(())
+}
+
 #[derive(Deserialize)]
 struct ExtractRoomEventContent {
 	content: Raw<AnyRoomAccountDataEventContent>,

src/api/client_server/context.rs

@@ -15,7 +15,7 @@ use crate::{services, Error, Result, Ruma};
 /// - Only works if the user is joined (TODO: always allow, but only show events
 ///   if the user was
 /// joined, depending on history_visibility)
-pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<get_context::v3::Response> {
+pub(crate) async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<get_context::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -42,9 +42,13 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 
 	let room_id = base_event.room_id.clone();
 
-	if !services().rooms.state_accessor.user_can_see_event(sender_user, &room_id, &body.event_id)? {
+	if !services()
+		.rooms
+		.state_accessor
+		.user_can_see_event(sender_user, &room_id, &body.event_id)?
+	{
 		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
+			ErrorKind::forbidden(),
 			"You don't have permission to view this event.",
 		));
 	}
@@ -69,7 +73,7 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		.timeline
 		.pdus_until(sender_user, &room_id, base_token)?
 		.take(limit / 2)
-		.filter_map(std::result::Result::ok) // Remove buggy events
+		.filter_map(Result::ok) // Remove buggy events
 		.filter(|(_, pdu)| {
 			services()
 				.rooms
@@ -91,17 +95,21 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		}
 	}
 
-	let start_token =
-		events_before.last().map(|(count, _)| count.stringify()).unwrap_or_else(|| base_token.stringify());
+	let start_token = events_before
+		.last()
+		.map_or_else(|| base_token.stringify(), |(count, _)| count.stringify());
 
-	let events_before: Vec<_> = events_before.into_iter().map(|(_, pdu)| pdu.to_room_event()).collect();
+	let events_before: Vec<_> = events_before
+		.into_iter()
+		.map(|(_, pdu)| pdu.to_room_event())
+		.collect();
 
 	let events_after: Vec<_> = services()
 		.rooms
 		.timeline
 		.pdus_after(sender_user, &room_id, base_token)?
 		.take(limit / 2)
-		.filter_map(std::result::Result::ok) // Remove buggy events
+		.filter_map(Result::ok) // Remove buggy events
 		.filter(|(_, pdu)| {
 			services()
 				.rooms
@@ -123,55 +131,69 @@ pub async fn get_context_route(body: Ruma<get_context::v3::Request>) -> Result<g
 		}
 	}
 
-	let shortstatehash = match services()
+	let shortstatehash = services()
 		.rooms
 		.state_accessor
-		.pdu_shortstatehash(events_after.last().map_or(&*body.event_id, |(_, e)| &*e.event_id))?
-	{
-		Some(s) => s,
-		None => services().rooms.state.get_room_shortstatehash(&room_id)?.expect("All rooms have state"),
-	};
+		.pdu_shortstatehash(
+			events_after
+				.last()
+				.map_or(&*body.event_id, |(_, e)| &*e.event_id),
+		)?
+		.map_or(
+			services()
+				.rooms
+				.state
+				.get_room_shortstatehash(&room_id)?
+				.expect("All rooms have state"),
+			|hash| hash,
+		);
 
-	let state_ids = services().rooms.state_accessor.state_full_ids(shortstatehash).await?;
+	let state_ids = services()
+		.rooms
+		.state_accessor
+		.state_full_ids(shortstatehash)
+		.await?;
 
-	let end_token = events_after.last().map(|(count, _)| count.stringify()).unwrap_or_else(|| base_token.stringify());
+	let end_token = events_after
+		.last()
+		.map_or_else(|| base_token.stringify(), |(count, _)| count.stringify());
 
-	let events_after: Vec<_> = events_after.into_iter().map(|(_, pdu)| pdu.to_room_event()).collect();
+	let events_after: Vec<_> = events_after
+		.into_iter()
+		.map(|(_, pdu)| pdu.to_room_event())
+		.collect();
 
 	let mut state = Vec::new();
 
 	for (shortstatekey, id) in state_ids {
-		let (event_type, state_key) = services().rooms.short.get_statekey_from_short(shortstatekey)?;
+		let (event_type, state_key) = services()
+			.rooms
+			.short
+			.get_statekey_from_short(shortstatekey)?;
 
 		if event_type != StateEventType::RoomMember {
-			let pdu = match services().rooms.timeline.get_pdu(&id)? {
-				Some(pdu) => pdu,
-				None => {
-					error!("Pdu in state not found: {}", id);
-					continue;
-				},
+			let Some(pdu) = services().rooms.timeline.get_pdu(&id)? else {
+				error!("Pdu in state not found: {}", id);
+				continue;
 			};
+
 			state.push(pdu.to_state_event());
 		} else if !lazy_load_enabled || lazy_loaded.contains(&state_key) {
-			let pdu = match services().rooms.timeline.get_pdu(&id)? {
-				Some(pdu) => pdu,
-				None => {
-					error!("Pdu in state not found: {}", id);
-					continue;
-				},
+			let Some(pdu) = services().rooms.timeline.get_pdu(&id)? else {
+				error!("Pdu in state not found: {}", id);
+				continue;
 			};
+
 			state.push(pdu.to_state_event());
 		}
 	}
 
-	let resp = get_context::v3::Response {
+	Ok(get_context::v3::Response {
 		start: Some(start_token),
 		end: Some(end_token),
 		events_before,
 		event: Some(base_event),
 		events_after,
 		state,
-	};
-
-	Ok(resp)
+	})
 }

src/api/client_server/device.rs

@@ -10,13 +10,13 @@ use crate::{services, utils, Error, Result, Ruma};
 /// # `GET /_matrix/client/r0/devices`
 ///
 /// Get metadata on all devices of the sender user.
-pub async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<get_devices::v3::Response> {
+pub(crate) async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<get_devices::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let devices: Vec<device::Device> = services()
 		.users
 		.all_devices_metadata(sender_user)
-		.filter_map(std::result::Result::ok) // Filter out buggy devices
+		.filter_map(Result::ok) // Filter out buggy devices
 		.collect();
 
 	Ok(get_devices::v3::Response {
@@ -27,7 +27,7 @@ pub async fn get_devices_route(body: Ruma<get_devices::v3::Request>) -> Result<g
 /// # `GET /_matrix/client/r0/devices/{deviceId}`
 ///
 /// Get metadata on a single device of the sender user.
-pub async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get_device::v3::Response> {
+pub(crate) async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let device = services()
@@ -43,7 +43,7 @@ pub async fn get_device_route(body: Ruma<get_device::v3::Request>) -> Result<get
 /// # `PUT /_matrix/client/r0/devices/{deviceId}`
 ///
 /// Updates the metadata on a given device of the sender user.
-pub async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Result<update_device::v3::Response> {
+pub(crate) async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Result<update_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let mut device = services()
@@ -53,7 +53,9 @@ pub async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Resu
 
 	device.display_name.clone_from(&body.display_name);
 
-	services().users.update_device_metadata(sender_user, &body.device_id, &device)?;
+	services()
+		.users
+		.update_device_metadata(sender_user, &body.device_id, &device)?;
 
 	Ok(update_device::v3::Response {})
 }
@@ -68,7 +70,7 @@ pub async fn update_device_route(body: Ruma<update_device::v3::Request>) -> Resu
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Result<delete_device::v3::Response> {
+pub(crate) async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Result<delete_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -84,20 +86,26 @@ pub async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Resu
 	};
 
 	if let Some(auth) = &body.auth {
-		let (worked, uiaainfo) = services().uiaa.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
+		let (worked, uiaainfo) = services()
+			.uiaa
+			.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
 		if !worked {
 			return Err(Error::Uiaa(uiaainfo));
 		}
 	// Success!
 	} else if let Some(json) = body.json_body {
 		uiaainfo.session = Some(utils::random_string(SESSION_ID_LENGTH));
-		services().uiaa.create(sender_user, sender_device, &uiaainfo, &json)?;
+		services()
+			.uiaa
+			.create(sender_user, sender_device, &uiaainfo, &json)?;
 		return Err(Error::Uiaa(uiaainfo));
 	} else {
 		return Err(Error::BadRequest(ErrorKind::NotJson, "Not json."));
 	}
 
-	services().users.remove_device(sender_user, &body.device_id)?;
+	services()
+		.users
+		.remove_device(sender_user, &body.device_id)?;
 
 	Ok(delete_device::v3::Response {})
 }
@@ -114,7 +122,9 @@ pub async fn delete_device_route(body: Ruma<delete_device::v3::Request>) -> Resu
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn delete_devices_route(body: Ruma<delete_devices::v3::Request>) -> Result<delete_devices::v3::Response> {
+pub(crate) async fn delete_devices_route(
+	body: Ruma<delete_devices::v3::Request>,
+) -> Result<delete_devices::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -130,14 +140,18 @@ pub async fn delete_devices_route(body: Ruma<delete_devices::v3::Request>) -> Re
 	};
 
 	if let Some(auth) = &body.auth {
-		let (worked, uiaainfo) = services().uiaa.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
+		let (worked, uiaainfo) = services()
+			.uiaa
+			.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
 		if !worked {
 			return Err(Error::Uiaa(uiaainfo));
 		}
 	// Success!
 	} else if let Some(json) = body.json_body {
 		uiaainfo.session = Some(utils::random_string(SESSION_ID_LENGTH));
-		services().uiaa.create(sender_user, sender_device, &uiaainfo, &json)?;
+		services()
+			.uiaa
+			.create(sender_user, sender_device, &uiaainfo, &json)?;
 		return Err(Error::Uiaa(uiaainfo));
 	} else {
 		return Err(Error::BadRequest(ErrorKind::NotJson, "Not json."));

src/api/client_server/directory.rs

@@ -24,21 +24,30 @@ use ruma::{
 };
 use tracing::{error, info, warn};
 
-use crate::{services, Error, Result, Ruma};
+use crate::{services, utils::server_name::server_is_ours, Error, Result, Ruma};
 
 /// # `POST /_matrix/client/v3/publicRooms`
 ///
 /// Lists the public rooms on this server.
 ///
 /// - Rooms are ordered by the number of joined members
-pub async fn get_public_rooms_filtered_route(
+pub(crate) async fn get_public_rooms_filtered_route(
 	body: Ruma<get_public_rooms_filtered::v3::Request>,
 ) -> Result<get_public_rooms_filtered::v3::Response> {
-	if !services().globals.config.allow_public_room_directory_without_auth {
-		let _sender_user = body.sender_user.as_ref().expect("user is authenticated");
+	if let Some(server) = &body.server {
+		if services()
+			.globals
+			.forbidden_remote_room_directory_server_names()
+			.contains(server)
+		{
+			return Err(Error::BadRequest(
+				ErrorKind::forbidden(),
+				"Server is banned on this homeserver.",
+			));
+		}
 	}
 
-	get_public_rooms_filtered_helper(
+	let response = get_public_rooms_filtered_helper(
 		body.server.as_deref(),
 		body.limit,
 		body.since.as_deref(),
@@ -46,6 +55,12 @@ pub async fn get_public_rooms_filtered_route(
 		&body.room_network,
 	)
 	.await
+	.map_err(|e| {
+		warn!("Failed to return our /publicRooms: {e}");
+		Error::BadRequest(ErrorKind::Unknown, "Failed to return this server's public room list.")
+	})?;
+
+	Ok(response)
 }
 
 /// # `GET /_matrix/client/v3/publicRooms`
@@ -53,11 +68,20 @@ pub async fn get_public_rooms_filtered_route(
 /// Lists the public rooms on this server.
 ///
 /// - Rooms are ordered by the number of joined members
-pub async fn get_public_rooms_route(
+pub(crate) async fn get_public_rooms_route(
 	body: Ruma<get_public_rooms::v3::Request>,
 ) -> Result<get_public_rooms::v3::Response> {
-	if !services().globals.config.allow_public_room_directory_without_auth {
-		let _sender_user = body.sender_user.as_ref().expect("user is authenticated");
+	if let Some(server) = &body.server {
+		if services()
+			.globals
+			.forbidden_remote_room_directory_server_names()
+			.contains(server)
+		{
+			return Err(Error::BadRequest(
+				ErrorKind::forbidden(),
+				"Server is banned on this homeserver.",
+			));
+		}
 	}
 
 	let response = get_public_rooms_filtered_helper(
@@ -67,7 +91,11 @@ pub async fn get_public_rooms_route(
 		&Filter::default(),
 		&RoomNetwork::Matrix,
 	)
-	.await?;
+	.await
+	.map_err(|e| {
+		warn!("Failed to return our /publicRooms: {e}");
+		Error::BadRequest(ErrorKind::Unknown, "Failed to return this server's public room list.")
+	})?;
 
 	Ok(get_public_rooms::v3::Response {
 		chunk: response.chunk,
@@ -82,7 +110,7 @@ pub async fn get_public_rooms_route(
 /// Sets the visibility of a given room in the room directory.
 ///
 /// - TODO: Access control checks
-pub async fn set_room_visibility_route(
+pub(crate) async fn set_room_visibility_route(
 	body: Ruma<set_room_visibility::v3::Request>,
 ) -> Result<set_room_visibility::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -94,8 +122,21 @@ pub async fn set_room_visibility_route(
 
 	match &body.visibility {
 		room::Visibility::Public => {
+			if services().globals.config.lockdown_public_room_directory && !services().users.is_admin(sender_user)? {
+				info!(
+					"Non-admin user {sender_user} tried to publish {0} to the room directory while \
+					 \"lockdown_public_room_directory\" is enabled",
+					body.room_id
+				);
+
+				return Err(Error::BadRequest(
+					ErrorKind::forbidden(),
+					"Publishing rooms to the room directory is not allowed",
+				));
+			}
+
 			services().rooms.directory.set_public(&body.room_id)?;
-			info!("{} made {} public", sender_user, body.room_id);
+			info!("{sender_user} made {0} public", body.room_id);
 		},
 		room::Visibility::Private => services().rooms.directory.set_not_public(&body.room_id)?,
 		_ => {
@@ -112,7 +153,7 @@ pub async fn set_room_visibility_route(
 /// # `GET /_matrix/client/r0/directory/list/room/{roomId}`
 ///
 /// Gets the visibility of a given room in the room directory.
-pub async fn get_room_visibility_route(
+pub(crate) async fn get_room_visibility_route(
 	body: Ruma<get_room_visibility::v3::Request>,
 ) -> Result<get_room_visibility::v3::Response> {
 	if !services().rooms.metadata.exists(&body.room_id)? {
@@ -132,7 +173,7 @@ pub async fn get_room_visibility_route(
 pub(crate) async fn get_public_rooms_filtered_helper(
 	server: Option<&ServerName>, limit: Option<UInt>, since: Option<&str>, filter: &Filter, _network: &RoomNetwork,
 ) -> Result<get_public_rooms_filtered::v3::Response> {
-	if let Some(other_server) = server.filter(|server| *server != services().globals.server_name().as_str()) {
+	if let Some(other_server) = server.filter(|server_name| !server_is_ours(server_name)) {
 		let response = services()
 			.sending
 			.send_federation_request(
@@ -213,8 +254,8 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 					.map_or(Ok(None), |s| {
 						serde_json::from_str(s.content.get())
 							.map(|c: RoomTopicEventContent| Some(c.topic))
-							.map_err(|_| {
-								error!("Invalid room topic event in database for room {}", room_id);
+							.map_err(|e| {
+								error!("Invalid room topic event in database for room {room_id}: {e}");
 								Error::bad_database("Invalid room topic event in database.")
 							})
 					})
@@ -228,8 +269,12 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 							.map(|c: RoomHistoryVisibilityEventContent| {
 								c.history_visibility == HistoryVisibility::WorldReadable
 							})
-							.map_err(|_| Error::bad_database("Invalid room history visibility event in database."))
-					})?,
+                            .map_err(|e| {
+                                error!(
+                                    "Invalid room history visibility event in database for room {room_id}, assuming is \"shared\": {e}",
+                                );
+                                Error::bad_database("Invalid room history visibility event in database.")
+                            })}).unwrap_or(false),
 				guest_can_join: services()
 					.rooms
 					.state_accessor
@@ -320,7 +365,11 @@ pub(crate) async fn get_public_rooms_filtered_helper(
 
 	let total_room_count_estimate = (all_rooms.len() as u32).into();
 
-	let chunk: Vec<_> = all_rooms.into_iter().skip(num_since as usize).take(limit as usize).collect();
+	let chunk: Vec<_> = all_rooms
+		.into_iter()
+		.skip(num_since as usize)
+		.take(limit as usize)
+		.collect();
 
 	let prev_batch = if num_since == 0 {
 		None

src/api/client_server/filter.rs

@@ -10,11 +10,10 @@ use crate::{services, Error, Result, Ruma};
 /// Loads a filter that was previously created.
 ///
 /// - A user can only access their own filters
-pub async fn get_filter_route(body: Ruma<get_filter::v3::Request>) -> Result<get_filter::v3::Response> {
+pub(crate) async fn get_filter_route(body: Ruma<get_filter::v3::Request>) -> Result<get_filter::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-	let filter = match services().users.get_filter(sender_user, &body.filter_id)? {
-		Some(filter) => filter,
-		None => return Err(Error::BadRequest(ErrorKind::NotFound, "Filter not found.")),
+	let Some(filter) = services().users.get_filter(sender_user, &body.filter_id)? else {
+		return Err(Error::BadRequest(ErrorKind::NotFound, "Filter not found."));
 	};
 
 	Ok(get_filter::v3::Response::new(filter))
@@ -23,7 +22,7 @@ pub async fn get_filter_route(body: Ruma<get_filter::v3::Request>) -> Result<get
 /// # `PUT /_matrix/client/r0/user/{userId}/filter`
 ///
 /// Creates a new filter to be used by other endpoints.
-pub async fn create_filter_route(body: Ruma<create_filter::v3::Request>) -> Result<create_filter::v3::Response> {
+pub(crate) async fn create_filter_route(body: Ruma<create_filter::v3::Request>) -> Result<create_filter::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	Ok(create_filter::v3::Response::new(
 		services().users.create_filter(sender_user, &body.filter)?,

src/api/client_server/keys.rs

@@ -17,10 +17,14 @@ use ruma::{
 	DeviceKeyAlgorithm, OwnedDeviceId, OwnedUserId, UserId,
 };
 use serde_json::json;
-use tracing::{debug, error};
+use tracing::debug;
 
 use super::SESSION_ID_LENGTH;
-use crate::{services, utils, Error, Result, Ruma};
+use crate::{
+	services,
+	utils::{self, user_id::user_is_local},
+	Error, Result, Ruma,
+};
 
 /// # `POST /_matrix/client/r0/keys/upload`
 ///
@@ -29,24 +33,34 @@ use crate::{services, utils, Error, Result, Ruma};
 /// - Adds one time keys
 /// - If there are no device keys yet: Adds device keys (TODO: merge with
 ///   existing keys?)
-pub async fn upload_keys_route(body: Ruma<upload_keys::v3::Request>) -> Result<upload_keys::v3::Response> {
+pub(crate) async fn upload_keys_route(body: Ruma<upload_keys::v3::Request>) -> Result<upload_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
 	for (key_key, key_value) in &body.one_time_keys {
-		services().users.add_one_time_key(sender_user, sender_device, key_key, key_value)?;
+		services()
+			.users
+			.add_one_time_key(sender_user, sender_device, key_key, key_value)?;
 	}
 
 	if let Some(device_keys) = &body.device_keys {
 		// TODO: merge this and the existing event?
 		// This check is needed to assure that signatures are kept
-		if services().users.get_device_keys(sender_user, sender_device)?.is_none() {
-			services().users.add_device_keys(sender_user, sender_device, device_keys)?;
+		if services()
+			.users
+			.get_device_keys(sender_user, sender_device)?
+			.is_none()
+		{
+			services()
+				.users
+				.add_device_keys(sender_user, sender_device, device_keys)?;
 		}
 	}
 
 	Ok(upload_keys::v3::Response {
-		one_time_key_counts: services().users.count_one_time_keys(sender_user, sender_device)?,
+		one_time_key_counts: services()
+			.users
+			.count_one_time_keys(sender_user, sender_device)?,
 	})
 }
 
@@ -58,27 +72,23 @@ pub async fn upload_keys_route(body: Ruma<upload_keys::v3::Request>) -> Result<u
 /// - Gets master keys, self-signing keys, user signing keys and device keys.
 /// - The master and self-signing keys contain signatures that the user is
 ///   allowed to see
-pub async fn get_keys_route(body: Ruma<get_keys::v3::Request>) -> Result<get_keys::v3::Response> {
+pub(crate) async fn get_keys_route(body: Ruma<get_keys::v3::Request>) -> Result<get_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let response = get_keys_helper(
+	get_keys_helper(
 		Some(sender_user),
 		&body.device_keys,
 		|u| u == sender_user,
 		true, // Always allow local users to see device names of other local users
 	)
-	.await?;
-
-	Ok(response)
+	.await
 }
 
 /// # `POST /_matrix/client/r0/keys/claim`
 ///
 /// Claims one-time keys
-pub async fn claim_keys_route(body: Ruma<claim_keys::v3::Request>) -> Result<claim_keys::v3::Response> {
-	let response = claim_keys_helper(&body.one_time_keys).await?;
-
-	Ok(response)
+pub(crate) async fn claim_keys_route(body: Ruma<claim_keys::v3::Request>) -> Result<claim_keys::v3::Response> {
+	claim_keys_helper(&body.one_time_keys).await
 }
 
 /// # `POST /_matrix/client/r0/keys/device_signing/upload`
@@ -86,7 +96,7 @@ pub async fn claim_keys_route(body: Ruma<claim_keys::v3::Request>) -> Result<cla
 /// Uploads end-to-end key information for the sender user.
 ///
 /// - Requires UIAA to verify password
-pub async fn upload_signing_keys_route(
+pub(crate) async fn upload_signing_keys_route(
 	body: Ruma<upload_signing_keys::v3::Request>,
 ) -> Result<upload_signing_keys::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -104,14 +114,18 @@ pub async fn upload_signing_keys_route(
 	};
 
 	if let Some(auth) = &body.auth {
-		let (worked, uiaainfo) = services().uiaa.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
+		let (worked, uiaainfo) = services()
+			.uiaa
+			.try_auth(sender_user, sender_device, auth, &uiaainfo)?;
 		if !worked {
 			return Err(Error::Uiaa(uiaainfo));
 		}
 	// Success!
 	} else if let Some(json) = body.json_body {
 		uiaainfo.session = Some(utils::random_string(SESSION_ID_LENGTH));
-		services().uiaa.create(sender_user, sender_device, &uiaainfo, &json)?;
+		services()
+			.uiaa
+			.create(sender_user, sender_device, &uiaainfo, &json)?;
 		return Err(Error::Uiaa(uiaainfo));
 	} else {
 		return Err(Error::BadRequest(ErrorKind::NotJson, "Not json."));
@@ -133,7 +147,7 @@ pub async fn upload_signing_keys_route(
 /// # `POST /_matrix/client/r0/keys/signatures/upload`
 ///
 /// Uploads end-to-end key signatures from the sender user.
-pub async fn upload_signatures_route(
+pub(crate) async fn upload_signatures_route(
 	body: Ruma<upload_signatures::v3::Request>,
 ) -> Result<upload_signatures::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -151,7 +165,6 @@ pub async fn upload_signatures_route(
 				.as_object()
 				.ok_or(Error::BadRequest(ErrorKind::InvalidParam, "Invalid signature."))?
 				.clone()
-				.into_iter()
 			{
 				// Signature validation?
 				let signature = (
@@ -162,7 +175,9 @@ pub async fn upload_signatures_route(
 						.ok_or(Error::BadRequest(ErrorKind::InvalidParam, "Invalid signature value."))?
 						.to_owned(),
 				);
-				services().users.sign_key(user_id, key_id, signature, sender_user)?;
+				services()
+					.users
+					.sign_key(user_id, key_id, signature, sender_user)?;
 			}
 		}
 	}
@@ -178,7 +193,9 @@ pub async fn upload_signatures_route(
 /// previous sync token.
 ///
 /// - TODO: left users
-pub async fn get_key_changes_route(body: Ruma<get_key_changes::v3::Request>) -> Result<get_key_changes::v3::Response> {
+pub(crate) async fn get_key_changes_route(
+	body: Ruma<get_key_changes::v3::Request>,
+) -> Result<get_key_changes::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let mut device_list_updates = HashSet::new();
@@ -188,22 +205,39 @@ pub async fn get_key_changes_route(body: Ruma<get_key_changes::v3::Request>) ->
 			.users
 			.keys_changed(
 				sender_user.as_str(),
-				body.from.parse().map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `from`."))?,
-				Some(body.to.parse().map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `to`."))?),
+				body.from
+					.parse()
+					.map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `from`."))?,
+				Some(
+					body.to
+						.parse()
+						.map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `to`."))?,
+				),
 			)
-			.filter_map(std::result::Result::ok),
+			.filter_map(Result::ok),
 	);
 
-	for room_id in services().rooms.state_cache.rooms_joined(sender_user).filter_map(std::result::Result::ok) {
+	for room_id in services()
+		.rooms
+		.state_cache
+		.rooms_joined(sender_user)
+		.filter_map(Result::ok)
+	{
 		device_list_updates.extend(
 			services()
 				.users
 				.keys_changed(
 					room_id.as_ref(),
-					body.from.parse().map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `from`."))?,
-					Some(body.to.parse().map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `to`."))?),
+					body.from
+						.parse()
+						.map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `from`."))?,
+					Some(
+						body.to
+							.parse()
+							.map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, "Invalid `to`."))?,
+					),
 				)
-				.filter_map(std::result::Result::ok),
+				.filter_map(Result::ok),
 		);
 	}
 	Ok(get_key_changes::v3::Response {
@@ -226,8 +260,11 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 	for (user_id, device_ids) in device_keys_input {
 		let user_id: &UserId = user_id;
 
-		if user_id.server_name() != services().globals.server_name() {
-			get_over_federation.entry(user_id.server_name()).or_insert_with(Vec::new).push((user_id, device_ids));
+		if !user_is_local(user_id) {
+			get_over_federation
+				.entry(user_id.server_name())
+				.or_insert_with(Vec::new)
+				.push((user_id, device_ids));
 			continue;
 		}
 
@@ -252,9 +289,13 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 			for device_id in device_ids {
 				let mut container = BTreeMap::new();
 				if let Some(mut keys) = services().users.get_device_keys(user_id, device_id)? {
-					let metadata = services().users.get_device_metadata(user_id, device_id)?.ok_or(
-						Error::BadRequest(ErrorKind::InvalidParam, "Tried to get keys for nonexistent device."),
-					)?;
+					let metadata = services()
+						.users
+						.get_device_metadata(user_id, device_id)?
+						.ok_or(Error::BadRequest(
+							ErrorKind::InvalidParam,
+							"Tried to get keys for nonexistent device.",
+						))?;
 
 					add_unsigned_device_display_name(&mut keys, metadata, include_display_names)
 						.map_err(|_| Error::bad_database("invalid device keys in database"))?;
@@ -264,11 +305,16 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 			}
 		}
 
-		if let Some(master_key) = services().users.get_master_key(sender_user, user_id, &allowed_signatures)? {
+		if let Some(master_key) = services()
+			.users
+			.get_master_key(sender_user, user_id, &allowed_signatures)?
+		{
 			master_keys.insert(user_id.to_owned(), master_key);
 		}
 		if let Some(self_signing_key) =
-			services().users.get_self_signing_key(sender_user, user_id, &allowed_signatures)?
+			services()
+				.users
+				.get_self_signing_key(sender_user, user_id, &allowed_signatures)?
 		{
 			self_signing_keys.insert(user_id.to_owned(), self_signing_key);
 		}
@@ -282,7 +328,13 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 	let mut failures = BTreeMap::new();
 
 	let back_off = |id| async {
-		match services().globals.bad_query_ratelimiter.write().await.entry(id) {
+		match services()
+			.globals
+			.bad_query_ratelimiter
+			.write()
+			.await
+			.entry(id)
+		{
 			hash_map::Entry::Vacant(e) => {
 				e.insert((Instant::now(), 1));
 			},
@@ -293,7 +345,13 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 	let mut futures: FuturesUnordered<_> = get_over_federation
 		.into_iter()
 		.map(|(server, vec)| async move {
-			if let Some((time, tries)) = services().globals.bad_query_ratelimiter.read().await.get(server) {
+			if let Some((time, tries)) = services()
+				.globals
+				.bad_query_ratelimiter
+				.read()
+				.await
+				.get(server)
+			{
 				// Exponential backoff
 				let mut min_elapsed_duration = Duration::from_secs(5 * 60) * (*tries) * (*tries);
 				if min_elapsed_duration > Duration::from_secs(60 * 60 * 24) {
@@ -310,64 +368,56 @@ pub(crate) async fn get_keys_helper<F: Fn(&UserId) -> bool>(
 			for (user_id, keys) in vec {
 				device_keys_input_fed.insert(user_id.to_owned(), keys.clone());
 			}
-			(
-				server,
-				tokio::time::timeout(
-					Duration::from_secs(50),
-					services().sending.send_federation_request(
-						server,
-						federation::keys::get_keys::v1::Request {
-							device_keys: device_keys_input_fed,
-						},
-					),
-				)
-				.await
-				.map_err(|e| {
-					error!("get_keys_helper query took too long: {}", e);
-					Error::BadServerResponse("get_keys_helper query took too long")
-				}),
-			)
+
+			let request = federation::keys::get_keys::v1::Request {
+				device_keys: device_keys_input_fed,
+			};
+			let response = services()
+				.sending
+				.send_federation_request(server, request)
+				.await;
+
+			(server, Ok(response))
 		})
 		.collect();
 
 	while let Some((server, response)) = futures.next().await {
-		match response {
-			Ok(Ok(response)) => {
-				for (user, masterkey) in response.master_keys {
-					let (master_key_id, mut master_key) = services().users.parse_master_key(&user, &masterkey)?;
+		if let Ok(Ok(response)) = response {
+			for (user, masterkey) in response.master_keys {
+				let (master_key_id, mut master_key) = services().users.parse_master_key(&user, &masterkey)?;
 
-					if let Some(our_master_key) =
-						services().users.get_key(&master_key_id, sender_user, &user, &allowed_signatures)?
-					{
-						let (_, our_master_key) = services().users.parse_master_key(&user, &our_master_key)?;
-						master_key.signatures.extend(our_master_key.signatures);
-					}
-					let json = serde_json::to_value(master_key).expect("to_value always works");
-					let raw = serde_json::from_value(json).expect("Raw::from_value always works");
-					services().users.add_cross_signing_keys(
-						&user, &raw, &None, &None,
-						false, /* Dont notify. A notification would trigger another key request resulting in an
-						       * endless loop */
-					)?;
-					master_keys.insert(user, raw);
+				if let Some(our_master_key) =
+					services()
+						.users
+						.get_key(&master_key_id, sender_user, &user, &allowed_signatures)?
+				{
+					let (_, our_master_key) = services().users.parse_master_key(&user, &our_master_key)?;
+					master_key.signatures.extend(our_master_key.signatures);
 				}
+				let json = serde_json::to_value(master_key).expect("to_value always works");
+				let raw = serde_json::from_value(json).expect("Raw::from_value always works");
+				services().users.add_cross_signing_keys(
+					&user, &raw, &None, &None,
+					false, /* Dont notify. A notification would trigger another key request resulting in an
+					       * endless loop */
+				)?;
+				master_keys.insert(user.clone(), raw);
+			}
 
-				self_signing_keys.extend(response.self_signing_keys);
-				device_keys.extend(response.device_keys);
-			},
-			_ => {
-				back_off(server.to_owned()).await;
-				failures.insert(server.to_string(), json!({}));
-			},
+			self_signing_keys.extend(response.self_signing_keys);
+			device_keys.extend(response.device_keys);
+		} else {
+			back_off(server.to_owned()).await;
+			failures.insert(server.to_string(), json!({}));
 		}
 	}
 
 	Ok(get_keys::v3::Response {
+		failures,
+		device_keys,
 		master_keys,
 		self_signing_keys,
 		user_signing_keys,
-		device_keys,
-		failures,
 	})
 }
 
@@ -404,13 +454,19 @@ pub(crate) async fn claim_keys_helper(
 	let mut get_over_federation = BTreeMap::new();
 
 	for (user_id, map) in one_time_keys_input {
-		if user_id.server_name() != services().globals.server_name() {
-			get_over_federation.entry(user_id.server_name()).or_insert_with(Vec::new).push((user_id, map));
+		if !user_is_local(user_id) {
+			get_over_federation
+				.entry(user_id.server_name())
+				.or_insert_with(Vec::new)
+				.push((user_id, map));
 		}
 
 		let mut container = BTreeMap::new();
 		for (device_id, key_algorithm) in map {
-			if let Some(one_time_keys) = services().users.take_one_time_key(user_id, device_id, key_algorithm)? {
+			if let Some(one_time_keys) = services()
+				.users
+				.take_one_time_key(user_id, device_id, key_algorithm)?
+			{
 				let mut c = BTreeMap::new();
 				c.insert(one_time_keys.0, one_time_keys.1);
 				container.insert(device_id.clone(), c);

src/api/client_server/message.rs

@@ -6,15 +6,17 @@ use std::{
 use ruma::{
 	api::client::{
 		error::ErrorKind,
+		filter::{RoomEventFilter, UrlFilter},
 		message::{get_message_events, send_message_event},
 	},
-	events::{StateEventType, TimelineEventType},
+	events::{MessageLikeEventType, StateEventType},
+	RoomId, UserId,
 };
-use serde_json::from_str;
+use serde_json::{from_str, Value};
 
 use crate::{
 	service::{pdu::PduBuilder, rooms::timeline::PduCount},
-	services, utils, Error, Result, Ruma,
+	services, utils, Error, PduEvent, Result, Ruma,
 };
 
 /// # `PUT /_matrix/client/v3/rooms/{roomId}/send/{eventType}/{txnId}`
@@ -26,71 +28,42 @@ use crate::{
 /// - The only requirement for the content is that it has to be valid json
 /// - Tries to send the event into the room, auth rules will determine if it is
 ///   allowed
-pub async fn send_message_event_route(
+pub(crate) async fn send_message_event_route(
 	body: Ruma<send_message_event::v3::Request>,
 ) -> Result<send_message_event::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_deref();
 
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(body.room_id.clone()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(body.room_id.clone())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
 	// Forbid m.room.encrypted if encryption is disabled
-	if TimelineEventType::RoomEncrypted == body.event_type.to_string().into() && !services().globals.allow_encryption()
-	{
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Encryption has been disabled"));
+	if MessageLikeEventType::RoomEncrypted == body.event_type && !services().globals.allow_encryption() {
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Encryption has been disabled"));
 	}
 
-	// certain event types require certain fields to be valid in request bodies.
-	// this helps prevent attempting to handle events that we can't deserialise
-	// later so don't waste resources on it.
-	//
-	// see https://spec.matrix.org/v1.9/client-server-api/#events-2 for what's required per event type.
-	match body.event_type.to_string().into() {
-		TimelineEventType::RoomMessage => {
-			let body_field = body.body.body.get_field::<String>("body");
-			let msgtype_field = body.body.body.get_field::<String>("msgtype");
-
-			if body_field.is_err() {
-				return Err(Error::BadRequest(
-					ErrorKind::InvalidParam,
-					"'body' field in JSON request is invalid",
-				));
-			}
-
-			if msgtype_field.is_err() {
-				return Err(Error::BadRequest(
-					ErrorKind::InvalidParam,
-					"'msgtype' field in JSON request is invalid",
-				));
-			}
-		},
-		TimelineEventType::RoomName => {
-			let name_field = body.body.body.get_field::<String>("name");
-
-			if name_field.is_err() {
-				return Err(Error::BadRequest(
-					ErrorKind::InvalidParam,
-					"'name' field in JSON request is invalid",
-				));
-			}
-		},
-		TimelineEventType::RoomTopic => {
-			let topic_field = body.body.body.get_field::<String>("topic");
-
-			if topic_field.is_err() {
-				return Err(Error::BadRequest(
-					ErrorKind::InvalidParam,
-					"'topic' field in JSON request is invalid",
-				));
-			}
-		},
-		_ => {}, // event may be custom/experimental or can be empty don't do anything with it
-	};
+	if body.event_type == MessageLikeEventType::CallInvite
+		&& services().rooms.directory.is_public_room(&body.room_id)?
+	{
+		return Err(Error::BadRequest(
+			ErrorKind::forbidden(),
+			"Room call invites are not allowed in public rooms",
+		));
+	}
 
 	// Check if this is a new transaction id
-	if let Some(response) = services().transaction_ids.existing_txnid(sender_user, sender_device, &body.txn_id)? {
+	if let Some(response) = services()
+		.transaction_ids
+		.existing_txnid(sender_user, sender_device, &body.txn_id)?
+	{
 		// The client might have sent a txnid of the /sendToDevice endpoint
 		// This txnid has no response associated with it
 		if response.is_empty() {
@@ -130,7 +103,9 @@ pub async fn send_message_event_route(
 		)
 		.await?;
 
-	services().transaction_ids.add_txnid(sender_user, sender_device, &body.txn_id, event_id.as_bytes())?;
+	services()
+		.transaction_ids
+		.add_txnid(sender_user, sender_device, &body.txn_id, event_id.as_bytes())?;
 
 	drop(state_lock);
 
@@ -143,8 +118,8 @@ pub async fn send_message_event_route(
 ///
 /// - Only works if the user is joined (TODO: always allow, but only show events
 ///   where the user was
-/// joined, depending on history_visibility)
-pub async fn get_message_events_route(
+/// joined, depending on `history_visibility`)
+pub(crate) async fn get_message_events_route(
 	body: Ruma<get_message_events::v3::Request>,
 ) -> Result<get_message_events::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -158,9 +133,16 @@ pub async fn get_message_events_route(
 		},
 	};
 
-	let to = body.to.as_ref().and_then(|t| PduCount::try_from_string(t).ok());
+	let to = body
+		.to
+		.as_ref()
+		.and_then(|t| PduCount::try_from_string(t).ok());
 
-	services().rooms.lazy_loading.lazy_load_confirm_delivery(sender_user, sender_device, &body.room_id, from).await?;
+	services()
+		.rooms
+		.lazy_loading
+		.lazy_load_confirm_delivery(sender_user, sender_device, &body.room_id, from)
+		.await?;
 
 	let limit = u64::from(body.limit).min(100) as usize;
 
@@ -176,79 +158,83 @@ pub async fn get_message_events_route(
 				.rooms
 				.timeline
 				.pdus_after(sender_user, &body.room_id, from)?
-				.take(limit)
-				.filter_map(std::result::Result::ok) // Filter out buggy events
-				.filter(|(_, pdu)| {
-					services()
-						.rooms
-						.state_accessor
-						.user_can_see_event(sender_user, &body.room_id, &pdu.event_id)
-						.unwrap_or(false)
-				})
+				.filter_map(Result::ok) // Filter out buggy events
+				.filter(|(_, pdu)| contains_url_filter(pdu, &body.filter))
+				.filter(|(_, pdu)| visibility_filter(pdu, sender_user, &body.room_id))
 				.take_while(|&(k, _)| Some(k) != to) // Stop at `to`
+				.take(limit)
 				.collect();
 
 			for (_, event) in &events_after {
-				/* TODO: Remove this when these are resolved:
+				/* TODO: Remove the not "element_hacks" check when these are resolved:
 				 * https://github.com/vector-im/element-android/issues/3417
 				 * https://github.com/vector-im/element-web/issues/21034
-				if !services().rooms.lazy_loading.lazy_load_was_sent_before(
-					sender_user,
-					sender_device,
-					&body.room_id,
-					&event.sender,
-				)? {
+				 */
+				if !cfg!(feature = "element_hacks")
+					&& !services().rooms.lazy_loading.lazy_load_was_sent_before(
+						sender_user,
+						sender_device,
+						&body.room_id,
+						&event.sender,
+					)? {
 					lazy_loaded.insert(event.sender.clone());
 				}
-				*/
+
 				lazy_loaded.insert(event.sender.clone());
 			}
 
 			next_token = events_after.last().map(|(count, _)| count).copied();
 
-			let events_after: Vec<_> = events_after.into_iter().map(|(_, pdu)| pdu.to_room_event()).collect();
+			let events_after: Vec<_> = events_after
+				.into_iter()
+				.map(|(_, pdu)| pdu.to_room_event())
+				.collect();
 
 			resp.start = from.stringify();
 			resp.end = next_token.map(|count| count.stringify());
 			resp.chunk = events_after;
 		},
 		ruma::api::Direction::Backward => {
-			services().rooms.timeline.backfill_if_required(&body.room_id, from).await?;
+			services()
+				.rooms
+				.timeline
+				.backfill_if_required(&body.room_id, from)
+				.await?;
 			let events_before: Vec<_> = services()
 				.rooms
 				.timeline
 				.pdus_until(sender_user, &body.room_id, from)?
-				.take(limit)
-				.filter_map(std::result::Result::ok) // Filter out buggy events
-				.filter(|(_, pdu)| {
-					services()
-						.rooms
-						.state_accessor
-						.user_can_see_event(sender_user, &body.room_id, &pdu.event_id)
-						.unwrap_or(false)
-				})
+				.filter_map(Result::ok) // Filter out buggy events
+				.filter(|(_, pdu)| contains_url_filter(pdu, &body.filter))
+				.filter(|(_, pdu)| visibility_filter(pdu, sender_user, &body.room_id))
 				.take_while(|&(k, _)| Some(k) != to) // Stop at `to`
+				.take(limit)
 				.collect();
 
 			for (_, event) in &events_before {
-				/* TODO: Remove this when these are resolved:
+				/* TODO: Remove the not "element_hacks" check when these are resolved:
 				 * https://github.com/vector-im/element-android/issues/3417
 				 * https://github.com/vector-im/element-web/issues/21034
-				if !services().rooms.lazy_loading.lazy_load_was_sent_before(
-					sender_user,
-					sender_device,
-					&body.room_id,
-					&event.sender,
-				)? {
+				 */
+				if !cfg!(feature = "element_hacks")
+					&& !services().rooms.lazy_loading.lazy_load_was_sent_before(
+						sender_user,
+						sender_device,
+						&body.room_id,
+						&event.sender,
+					)? {
 					lazy_loaded.insert(event.sender.clone());
 				}
-				*/
+
 				lazy_loaded.insert(event.sender.clone());
 			}
 
 			next_token = events_before.last().map(|(count, _)| count).copied();
 
-			let events_before: Vec<_> = events_before.into_iter().map(|(_, pdu)| pdu.to_room_event()).collect();
+			let events_before: Vec<_> = events_before
+				.into_iter()
+				.map(|(_, pdu)| pdu.to_room_event())
+				.collect();
 
 			resp.start = from.stringify();
 			resp.end = next_token.map(|count| count.stringify());
@@ -267,18 +253,37 @@ pub async fn get_message_events_route(
 		}
 	}
 
-	// TODO: enable again when we are sure clients can handle it
-	/*
-	if let Some(next_token) = next_token {
-		services().rooms.lazy_loading.lazy_load_mark_sent(
-			sender_user,
-			sender_device,
-			&body.room_id,
-			lazy_loaded,
-			next_token,
-		).await;
+	// remove the feature check when we are sure clients like element can handle it
+	if !cfg!(feature = "element_hacks") {
+		if let Some(next_token) = next_token {
+			services()
+				.rooms
+				.lazy_loading
+				.lazy_load_mark_sent(sender_user, sender_device, &body.room_id, lazy_loaded, next_token)
+				.await;
+		}
 	}
-	*/
 
 	Ok(resp)
 }
+
+fn visibility_filter(pdu: &PduEvent, user_id: &UserId, room_id: &RoomId) -> bool {
+	services()
+		.rooms
+		.state_accessor
+		.user_can_see_event(user_id, room_id, &pdu.event_id)
+		.unwrap_or(false)
+}
+
+fn contains_url_filter(pdu: &PduEvent, filter: &RoomEventFilter) -> bool {
+	if filter.url_filter.is_none() {
+		return true;
+	}
+
+	let content: Value = from_str(pdu.content.get()).unwrap();
+	match filter.url_filter {
+		Some(UrlFilter::EventsWithoutUrl) => !content["url"].is_string(),
+		Some(UrlFilter::EventsWithUrl) => content["url"].is_string(),
+		None => true,
+	}
+}

src/api/client_server/mod.rs

@@ -29,53 +29,55 @@ mod thirdparty;
 mod threads;
 mod to_device;
 mod typing;
+mod unstable;
 mod unversioned;
 mod user_directory;
 mod voip;
 
-pub use account::*;
-pub use alias::*;
-pub use backup::*;
-pub use capabilities::*;
-pub use config::*;
-pub use context::*;
-pub use device::*;
-pub use directory::*;
-pub use filter::*;
-pub use keys::*;
-pub use media::*;
-pub use membership::*;
-pub use message::*;
-pub use presence::*;
-pub use profile::*;
-pub use push::*;
-pub use read_marker::*;
-pub use redact::*;
-pub use relations::*;
-pub use report::*;
-pub use room::*;
-pub use search::*;
-pub use session::*;
-pub use space::*;
-pub use state::*;
-pub use sync::*;
-pub use tag::*;
-pub use thirdparty::*;
-pub use threads::*;
-pub use to_device::*;
-pub use typing::*;
-pub use unversioned::*;
-pub use user_directory::*;
-pub use voip::*;
+pub(crate) use account::*;
+pub(crate) use alias::*;
+pub(crate) use backup::*;
+pub(crate) use capabilities::*;
+pub(crate) use config::*;
+pub(crate) use context::*;
+pub(crate) use device::*;
+pub(crate) use directory::*;
+pub(crate) use filter::*;
+pub(crate) use keys::*;
+pub(crate) use media::*;
+pub(crate) use membership::*;
+pub(crate) use message::*;
+pub(crate) use presence::*;
+pub(crate) use profile::*;
+pub(crate) use push::*;
+pub(crate) use read_marker::*;
+pub(crate) use redact::*;
+pub(crate) use relations::*;
+pub(crate) use report::*;
+pub(crate) use room::*;
+pub(crate) use search::*;
+pub(crate) use session::*;
+pub(crate) use space::*;
+pub(crate) use state::*;
+pub(crate) use sync::*;
+pub(crate) use tag::*;
+pub(crate) use thirdparty::*;
+pub(crate) use threads::*;
+pub(crate) use to_device::*;
+pub(crate) use typing::*;
+pub(crate) use unstable::*;
+pub(crate) use unversioned::*;
+pub(crate) use user_directory::*;
+pub(crate) use voip::*;
 
 /// generated device ID length
-pub const DEVICE_ID_LENGTH: usize = 10;
+const DEVICE_ID_LENGTH: usize = 10;
 
 /// generated user access token length
-pub const TOKEN_LENGTH: usize = 32;
+const TOKEN_LENGTH: usize = 32;
 
 /// generated user session ID length
-pub const SESSION_ID_LENGTH: usize = 32;
+pub(crate) const SESSION_ID_LENGTH: usize = 32;
 
 /// auto-generated password length
-pub const AUTO_GEN_PASSWORD_LENGTH: usize = 25;
+pub(crate) const AUTO_GEN_PASSWORD_LENGTH: usize = 25;

src/api/client_server/presence.rs

@@ -10,24 +10,15 @@ use crate::{services, Error, Result, Ruma};
 /// # `PUT /_matrix/client/r0/presence/{userId}/status`
 ///
 /// Sets the presence state of the sender user.
-pub async fn set_presence_route(body: Ruma<set_presence::v3::Request>) -> Result<set_presence::v3::Response> {
+pub(crate) async fn set_presence_route(body: Ruma<set_presence::v3::Request>) -> Result<set_presence::v3::Response> {
 	if !services().globals.allow_local_presence() {
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Presence is disabled on this server"));
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Presence is disabled on this server"));
 	}
 
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-	for room_id in services().rooms.state_cache.rooms_joined(sender_user) {
-		let room_id = room_id?;
-
-		services().rooms.edus.presence.set_presence(
-			&room_id,
-			sender_user,
-			body.presence.clone(),
-			None,
-			None,
-			body.status_msg.clone(),
-		)?;
-	}
+	services()
+		.presence
+		.set_presence(sender_user, &body.presence, None, None, body.status_msg.clone())?;
 
 	Ok(set_presence::v3::Response {})
 }
@@ -37,19 +28,21 @@ pub async fn set_presence_route(body: Ruma<set_presence::v3::Request>) -> Result
 /// Gets the presence state of the given user.
 ///
 /// - Only works if you share a room with the user
-pub async fn get_presence_route(body: Ruma<get_presence::v3::Request>) -> Result<get_presence::v3::Response> {
+pub(crate) async fn get_presence_route(body: Ruma<get_presence::v3::Request>) -> Result<get_presence::v3::Response> {
 	if !services().globals.allow_local_presence() {
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Presence is disabled on this server"));
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Presence is disabled on this server"));
 	}
 
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let mut presence_event = None;
 
-	for room_id in services().rooms.user.get_shared_rooms(vec![sender_user.clone(), body.user_id.clone()])? {
-		let room_id = room_id?;
-
-		if let Some(presence) = services().rooms.edus.presence.get_presence(&room_id, sender_user)? {
+	for _room_id in services()
+		.rooms
+		.user
+		.get_shared_rooms(vec![sender_user.clone(), body.user_id.clone()])?
+	{
+		if let Some(presence) = services().presence.get_presence(&body.user_id)? {
 			presence_event = Some(presence);
 			break;
 		}
@@ -60,7 +53,10 @@ pub async fn get_presence_route(body: Ruma<get_presence::v3::Request>) -> Result
 			// TODO: Should ruma just use the presenceeventcontent type here?
 			status_msg: presence.content.status_msg,
 			currently_active: presence.content.currently_active,
-			last_active_ago: presence.content.last_active_ago.map(|millis| Duration::from_millis(millis.into())),
+			last_active_ago: presence
+				.content
+				.last_active_ago
+				.map(|millis| Duration::from_millis(millis.into())),
 			presence: presence.content.presence,
 		})
 	} else {

src/api/client_server/profile.rs

@@ -13,32 +13,36 @@ use ruma::{
 };
 use serde_json::value::to_raw_value;
 
-use crate::{service::pdu::PduBuilder, services, Error, Result, Ruma};
+use crate::{service::pdu::PduBuilder, services, utils::user_id::user_is_local, Error, Result, Ruma};
 
 /// # `PUT /_matrix/client/r0/profile/{userId}/displayname`
 ///
 /// Updates the displayname.
 ///
 /// - Also makes sure other users receive the update using presence EDUs
-pub async fn set_displayname_route(
+pub(crate) async fn set_displayname_route(
 	body: Ruma<set_display_name::v3::Request>,
 ) -> Result<set_display_name::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().users.set_displayname(sender_user, body.displayname.clone()).await?;
+	services()
+		.users
+		.set_displayname(sender_user, body.displayname.clone())
+		.await?;
 
 	// Send a new membership event and presence update into all joined rooms
 	let all_rooms_joined: Vec<_> = services()
 		.rooms
 		.state_cache
 		.rooms_joined(sender_user)
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.map(|room_id| {
 			Ok::<_, Error>((
 				PduBuilder {
 					event_type: TimelineEventType::RoomMember,
 					content: to_raw_value(&RoomMemberEventContent {
 						displayname: body.displayname.clone(),
+						join_authorized_via_users_server: None,
 						..serde_json::from_str(
 							services()
 								.rooms
@@ -60,20 +64,33 @@ pub async fn set_displayname_route(
 				room_id,
 			))
 		})
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.collect();
 
 	for (pdu_builder, room_id) in all_rooms_joined {
-		let mutex_state =
-			Arc::clone(services().globals.roomid_mutex_state.write().await.entry(room_id.clone()).or_default());
+		let mutex_state = Arc::clone(
+			services()
+				.globals
+				.roomid_mutex_state
+				.write()
+				.await
+				.entry(room_id.clone())
+				.or_default(),
+		);
 		let state_lock = mutex_state.lock().await;
 
-		let _ = services().rooms.timeline.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock).await;
+		_ = services()
+			.rooms
+			.timeline
+			.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock)
+			.await;
 	}
 
 	if services().globals.allow_local_presence() {
 		// Presence update
-		services().rooms.edus.presence.ping_presence(sender_user, PresenceState::Online)?;
+		services()
+			.presence
+			.ping_presence(sender_user, &PresenceState::Online)?;
 	}
 
 	Ok(set_display_name::v3::Response {})
@@ -85,10 +102,10 @@ pub async fn set_displayname_route(
 ///
 /// - If user is on another server and we do not have a local copy already
 /// fetch displayname over federation
-pub async fn get_displayname_route(
+pub(crate) async fn get_displayname_route(
 	body: Ruma<get_display_name::v3::Request>,
 ) -> Result<get_display_name::v3::Response> {
-	if body.user_id.server_name() != services().globals.server_name() {
+	if !user_is_local(&body.user_id) {
 		// Create and update our local copy of the user
 		if let Ok(response) = services()
 			.sending
@@ -105,9 +122,18 @@ pub async fn get_displayname_route(
 				services().users.create(&body.user_id, None)?;
 			}
 
-			services().users.set_displayname(&body.user_id, response.displayname.clone()).await?;
-			services().users.set_avatar_url(&body.user_id, response.avatar_url.clone()).await?;
-			services().users.set_blurhash(&body.user_id, response.blurhash.clone()).await?;
+			services()
+				.users
+				.set_displayname(&body.user_id, response.displayname.clone())
+				.await?;
+			services()
+				.users
+				.set_avatar_url(&body.user_id, response.avatar_url.clone())
+				.await?;
+			services()
+				.users
+				.set_blurhash(&body.user_id, response.blurhash.clone())
+				.await?;
 
 			return Ok(get_display_name::v3::Response {
 				displayname: response.displayname,
@@ -126,30 +152,39 @@ pub async fn get_displayname_route(
 	})
 }
 
-/// # `PUT /_matrix/client/r0/profile/{userId}/avatar_url`
+/// # `PUT /_matrix/client/v3/profile/{userId}/avatar_url`
 ///
-/// Updates the avatar_url and blurhash.
+/// Updates the `avatar_url` and `blurhash`.
 ///
 /// - Also makes sure other users receive the update using presence EDUs
-pub async fn set_avatar_url_route(body: Ruma<set_avatar_url::v3::Request>) -> Result<set_avatar_url::v3::Response> {
+pub(crate) async fn set_avatar_url_route(
+	body: Ruma<set_avatar_url::v3::Request>,
+) -> Result<set_avatar_url::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().users.set_avatar_url(sender_user, body.avatar_url.clone()).await?;
+	services()
+		.users
+		.set_avatar_url(sender_user, body.avatar_url.clone())
+		.await?;
 
-	services().users.set_blurhash(sender_user, body.blurhash.clone()).await?;
+	services()
+		.users
+		.set_blurhash(sender_user, body.blurhash.clone())
+		.await?;
 
 	// Send a new membership event and presence update into all joined rooms
 	let all_joined_rooms: Vec<_> = services()
 		.rooms
 		.state_cache
 		.rooms_joined(sender_user)
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.map(|room_id| {
 			Ok::<_, Error>((
 				PduBuilder {
 					event_type: TimelineEventType::RoomMember,
 					content: to_raw_value(&RoomMemberEventContent {
 						avatar_url: body.avatar_url.clone(),
+						join_authorized_via_users_server: None,
 						..serde_json::from_str(
 							services()
 								.rooms
@@ -171,20 +206,33 @@ pub async fn set_avatar_url_route(body: Ruma<set_avatar_url::v3::Request>) -> Re
 				room_id,
 			))
 		})
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.collect();
 
 	for (pdu_builder, room_id) in all_joined_rooms {
-		let mutex_state =
-			Arc::clone(services().globals.roomid_mutex_state.write().await.entry(room_id.clone()).or_default());
+		let mutex_state = Arc::clone(
+			services()
+				.globals
+				.roomid_mutex_state
+				.write()
+				.await
+				.entry(room_id.clone())
+				.or_default(),
+		);
 		let state_lock = mutex_state.lock().await;
 
-		let _ = services().rooms.timeline.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock).await;
+		_ = services()
+			.rooms
+			.timeline
+			.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock)
+			.await;
 	}
 
 	if services().globals.allow_local_presence() {
 		// Presence update
-		services().rooms.edus.presence.ping_presence(sender_user, PresenceState::Online)?;
+		services()
+			.presence
+			.ping_presence(sender_user, &PresenceState::Online)?;
 	}
 
 	Ok(set_avatar_url::v3::Response {})
@@ -192,12 +240,14 @@ pub async fn set_avatar_url_route(body: Ruma<set_avatar_url::v3::Request>) -> Re
 
 /// # `GET /_matrix/client/v3/profile/{userId}/avatar_url`
 ///
-/// Returns the avatar_url and blurhash of the user.
+/// Returns the `avatar_url` and `blurhash` of the user.
 ///
 /// - If user is on another server and we do not have a local copy already
-/// fetch avatar_url and blurhash over federation
-pub async fn get_avatar_url_route(body: Ruma<get_avatar_url::v3::Request>) -> Result<get_avatar_url::v3::Response> {
-	if body.user_id.server_name() != services().globals.server_name() {
+/// fetch `avatar_url` and blurhash over federation
+pub(crate) async fn get_avatar_url_route(
+	body: Ruma<get_avatar_url::v3::Request>,
+) -> Result<get_avatar_url::v3::Response> {
+	if !user_is_local(&body.user_id) {
 		// Create and update our local copy of the user
 		if let Ok(response) = services()
 			.sending
@@ -214,9 +264,18 @@ pub async fn get_avatar_url_route(body: Ruma<get_avatar_url::v3::Request>) -> Re
 				services().users.create(&body.user_id, None)?;
 			}
 
-			services().users.set_displayname(&body.user_id, response.displayname.clone()).await?;
-			services().users.set_avatar_url(&body.user_id, response.avatar_url.clone()).await?;
-			services().users.set_blurhash(&body.user_id, response.blurhash.clone()).await?;
+			services()
+				.users
+				.set_displayname(&body.user_id, response.displayname.clone())
+				.await?;
+			services()
+				.users
+				.set_avatar_url(&body.user_id, response.avatar_url.clone())
+				.await?;
+			services()
+				.users
+				.set_blurhash(&body.user_id, response.blurhash.clone())
+				.await?;
 
 			return Ok(get_avatar_url::v3::Response {
 				avatar_url: response.avatar_url,
@@ -243,8 +302,8 @@ pub async fn get_avatar_url_route(body: Ruma<get_avatar_url::v3::Request>) -> Re
 ///
 /// - If user is on another server and we do not have a local copy already,
 /// fetch profile over federation.
-pub async fn get_profile_route(body: Ruma<get_profile::v3::Request>) -> Result<get_profile::v3::Response> {
-	if body.user_id.server_name() != services().globals.server_name() {
+pub(crate) async fn get_profile_route(body: Ruma<get_profile::v3::Request>) -> Result<get_profile::v3::Response> {
+	if !user_is_local(&body.user_id) {
 		// Create and update our local copy of the user
 		if let Ok(response) = services()
 			.sending
@@ -261,9 +320,18 @@ pub async fn get_profile_route(body: Ruma<get_profile::v3::Request>) -> Result<g
 				services().users.create(&body.user_id, None)?;
 			}
 
-			services().users.set_displayname(&body.user_id, response.displayname.clone()).await?;
-			services().users.set_avatar_url(&body.user_id, response.avatar_url.clone()).await?;
-			services().users.set_blurhash(&body.user_id, response.blurhash.clone()).await?;
+			services()
+				.users
+				.set_displayname(&body.user_id, response.displayname.clone())
+				.await?;
+			services()
+				.users
+				.set_avatar_url(&body.user_id, response.avatar_url.clone())
+				.await?;
+			services()
+				.users
+				.set_blurhash(&body.user_id, response.blurhash.clone())
+				.await?;
 
 			return Ok(get_profile::v3::Response {
 				displayname: response.displayname,

src/api/client_server/push.rs

@@ -7,37 +7,55 @@ use ruma::{
 		},
 	},
 	events::{push_rules::PushRulesEvent, GlobalAccountDataEventType},
-	push::{InsertPushRuleError, RemovePushRuleError},
+	push::{InsertPushRuleError, RemovePushRuleError, Ruleset},
 };
 
 use crate::{services, Error, Result, Ruma};
 
-/// # `GET /_matrix/client/r0/pushrules`
+/// # `GET /_matrix/client/r0/pushrules/`
 ///
 /// Retrieves the push rules event for this user.
-pub async fn get_pushrules_all_route(
+pub(crate) async fn get_pushrules_all_route(
 	body: Ruma<get_pushrules_all::v3::Request>,
 ) -> Result<get_pushrules_all::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let event = services()
-		.account_data
-		.get(None, sender_user, GlobalAccountDataEventType::PushRules.to_string().into())?
-		.ok_or(Error::BadRequest(ErrorKind::NotFound, "PushRules event not found."))?;
+	let event =
+		services()
+			.account_data
+			.get(None, sender_user, GlobalAccountDataEventType::PushRules.to_string().into())?;
 
-	let account_data = serde_json::from_str::<PushRulesEvent>(event.get())
-		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
-		.content;
+	if let Some(event) = event {
+		let account_data = serde_json::from_str::<PushRulesEvent>(event.get())
+			.map_err(|_| Error::bad_database("Invalid account data event in db."))?
+			.content;
 
-	Ok(get_pushrules_all::v3::Response {
-		global: account_data.global,
-	})
+		Ok(get_pushrules_all::v3::Response {
+			global: account_data.global,
+		})
+	} else {
+		services().account_data.update(
+			None,
+			sender_user,
+			GlobalAccountDataEventType::PushRules.to_string().into(),
+			&serde_json::to_value(PushRulesEvent {
+				content: ruma::events::push_rules::PushRulesEventContent {
+					global: Ruleset::server_default(sender_user),
+				},
+			})
+			.expect("to json always works"),
+		)?;
+
+		Ok(get_pushrules_all::v3::Response {
+			global: Ruleset::server_default(sender_user),
+		})
+	}
 }
 
 /// # `GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}`
 ///
 /// Retrieves a single specified push rule for this user.
-pub async fn get_pushrule_route(body: Ruma<get_pushrule::v3::Request>) -> Result<get_pushrule::v3::Response> {
+pub(crate) async fn get_pushrule_route(body: Ruma<get_pushrule::v3::Request>) -> Result<get_pushrule::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let event = services()
@@ -49,7 +67,10 @@ pub async fn get_pushrule_route(body: Ruma<get_pushrule::v3::Request>) -> Result
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?
 		.content;
 
-	let rule = account_data.global.get(body.kind.clone(), &body.rule_id).map(Into::into);
+	let rule = account_data
+		.global
+		.get(body.kind.clone(), &body.rule_id)
+		.map(Into::into);
 
 	if let Some(rule) = rule {
 		Ok(get_pushrule::v3::Response {
@@ -63,7 +84,7 @@ pub async fn get_pushrule_route(body: Ruma<get_pushrule::v3::Request>) -> Result
 /// # `PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}`
 ///
 /// Creates a single specified push rule for this user.
-pub async fn set_pushrule_route(body: Ruma<set_pushrule::v3::Request>) -> Result<set_pushrule::v3::Response> {
+pub(crate) async fn set_pushrule_route(body: Ruma<set_pushrule::v3::Request>) -> Result<set_pushrule::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let body = body.body;
 
@@ -83,7 +104,10 @@ pub async fn set_pushrule_route(body: Ruma<set_pushrule::v3::Request>) -> Result
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?;
 
 	if let Err(error) =
-		account_data.content.global.insert(body.rule.clone(), body.after.as_deref(), body.before.as_deref())
+		account_data
+			.content
+			.global
+			.insert(body.rule.clone(), body.after.as_deref(), body.before.as_deref())
 	{
 		let err = match error {
 			InsertPushRuleError::ServerDefaultRuleId => Error::BadRequest(
@@ -123,7 +147,7 @@ pub async fn set_pushrule_route(body: Ruma<set_pushrule::v3::Request>) -> Result
 /// # `GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions`
 ///
 /// Gets the actions of a single specified push rule for this user.
-pub async fn get_pushrule_actions_route(
+pub(crate) async fn get_pushrule_actions_route(
 	body: Ruma<get_pushrule_actions::v3::Request>,
 ) -> Result<get_pushrule_actions::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -158,7 +182,7 @@ pub async fn get_pushrule_actions_route(
 /// # `PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/actions`
 ///
 /// Sets the actions of a single specified push rule for this user.
-pub async fn set_pushrule_actions_route(
+pub(crate) async fn set_pushrule_actions_route(
 	body: Ruma<set_pushrule_actions::v3::Request>,
 ) -> Result<set_pushrule_actions::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -178,7 +202,12 @@ pub async fn set_pushrule_actions_route(
 	let mut account_data = serde_json::from_str::<PushRulesEvent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?;
 
-	if account_data.content.global.set_actions(body.kind.clone(), &body.rule_id, body.actions.clone()).is_err() {
+	if account_data
+		.content
+		.global
+		.set_actions(body.kind.clone(), &body.rule_id, body.actions.clone())
+		.is_err()
+	{
 		return Err(Error::BadRequest(ErrorKind::NotFound, "Push rule not found."));
 	}
 
@@ -195,7 +224,7 @@ pub async fn set_pushrule_actions_route(
 /// # `GET /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled`
 ///
 /// Gets the enabled status of a single specified push rule for this user.
-pub async fn get_pushrule_enabled_route(
+pub(crate) async fn get_pushrule_enabled_route(
 	body: Ruma<get_pushrule_enabled::v3::Request>,
 ) -> Result<get_pushrule_enabled::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -229,7 +258,7 @@ pub async fn get_pushrule_enabled_route(
 /// # `PUT /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}/enabled`
 ///
 /// Sets the enabled status of a single specified push rule for this user.
-pub async fn set_pushrule_enabled_route(
+pub(crate) async fn set_pushrule_enabled_route(
 	body: Ruma<set_pushrule_enabled::v3::Request>,
 ) -> Result<set_pushrule_enabled::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -249,7 +278,12 @@ pub async fn set_pushrule_enabled_route(
 	let mut account_data = serde_json::from_str::<PushRulesEvent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?;
 
-	if account_data.content.global.set_enabled(body.kind.clone(), &body.rule_id, body.enabled).is_err() {
+	if account_data
+		.content
+		.global
+		.set_enabled(body.kind.clone(), &body.rule_id, body.enabled)
+		.is_err()
+	{
 		return Err(Error::BadRequest(ErrorKind::NotFound, "Push rule not found."));
 	}
 
@@ -266,7 +300,9 @@ pub async fn set_pushrule_enabled_route(
 /// # `DELETE /_matrix/client/r0/pushrules/{scope}/{kind}/{ruleId}`
 ///
 /// Deletes a single specified push rule for this user.
-pub async fn delete_pushrule_route(body: Ruma<delete_pushrule::v3::Request>) -> Result<delete_pushrule::v3::Response> {
+pub(crate) async fn delete_pushrule_route(
+	body: Ruma<delete_pushrule::v3::Request>,
+) -> Result<delete_pushrule::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	if body.scope != RuleScope::Global {
@@ -284,7 +320,11 @@ pub async fn delete_pushrule_route(body: Ruma<delete_pushrule::v3::Request>) ->
 	let mut account_data = serde_json::from_str::<PushRulesEvent>(event.get())
 		.map_err(|_| Error::bad_database("Invalid account data event in db."))?;
 
-	if let Err(error) = account_data.content.global.remove(body.kind.clone(), &body.rule_id) {
+	if let Err(error) = account_data
+		.content
+		.global
+		.remove(body.kind.clone(), &body.rule_id)
+	{
 		let err = match error {
 			RemovePushRuleError::ServerDefault => {
 				Error::BadRequest(ErrorKind::InvalidParam, "Cannot delete a server-default pushrule.")
@@ -309,7 +349,7 @@ pub async fn delete_pushrule_route(body: Ruma<delete_pushrule::v3::Request>) ->
 /// # `GET /_matrix/client/r0/pushers`
 ///
 /// Gets all currently active pushers for the sender user.
-pub async fn get_pushers_route(body: Ruma<get_pushers::v3::Request>) -> Result<get_pushers::v3::Response> {
+pub(crate) async fn get_pushers_route(body: Ruma<get_pushers::v3::Request>) -> Result<get_pushers::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	Ok(get_pushers::v3::Response {
@@ -322,10 +362,12 @@ pub async fn get_pushers_route(body: Ruma<get_pushers::v3::Request>) -> Result<g
 /// Adds a pusher for the sender user.
 ///
 /// - TODO: Handle `append`
-pub async fn set_pushers_route(body: Ruma<set_pusher::v3::Request>) -> Result<set_pusher::v3::Response> {
+pub(crate) async fn set_pushers_route(body: Ruma<set_pusher::v3::Request>) -> Result<set_pusher::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	services().pusher.set_pusher(sender_user, body.action.clone())?;
+	services()
+		.pusher
+		.set_pusher(sender_user, body.action.clone())?;
 
 	Ok(set_pusher::v3::Response::default())
 }

src/api/client_server/read_marker.rs

@@ -18,7 +18,9 @@ use crate::{service::rooms::timeline::PduCount, services, Error, Result, Ruma};
 /// - Updates fully-read account data event to `fully_read`
 /// - If `read_receipt` is set: Update private marker and public read receipt
 ///   EDU
-pub async fn set_read_marker_route(body: Ruma<set_read_marker::v3::Request>) -> Result<set_read_marker::v3::Response> {
+pub(crate) async fn set_read_marker_route(
+	body: Ruma<set_read_marker::v3::Request>,
+) -> Result<set_read_marker::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	if let Some(fully_read) = &body.fully_read {
@@ -36,7 +38,10 @@ pub async fn set_read_marker_route(body: Ruma<set_read_marker::v3::Request>) ->
 	}
 
 	if body.private_read_receipt.is_some() || body.read_receipt.is_some() {
-		services().rooms.user.reset_notification_counts(sender_user, &body.room_id)?;
+		services()
+			.rooms
+			.user
+			.reset_notification_counts(sender_user, &body.room_id)?;
 	}
 
 	if let Some(event) = &body.private_read_receipt {
@@ -54,7 +59,10 @@ pub async fn set_read_marker_route(body: Ruma<set_read_marker::v3::Request>) ->
 			},
 			PduCount::Normal(c) => c,
 		};
-		services().rooms.edus.read_receipt.private_read_set(&body.room_id, sender_user, count)?;
+		services()
+			.rooms
+			.read_receipt
+			.private_read_set(&body.room_id, sender_user, count)?;
 	}
 
 	if let Some(event) = &body.read_receipt {
@@ -73,7 +81,7 @@ pub async fn set_read_marker_route(body: Ruma<set_read_marker::v3::Request>) ->
 		let mut receipt_content = BTreeMap::new();
 		receipt_content.insert(event.to_owned(), receipts);
 
-		services().rooms.edus.read_receipt.readreceipt_update(
+		services().rooms.read_receipt.readreceipt_update(
 			sender_user,
 			&body.room_id,
 			ruma::events::receipt::ReceiptEvent {
@@ -89,14 +97,19 @@ pub async fn set_read_marker_route(body: Ruma<set_read_marker::v3::Request>) ->
 /// # `POST /_matrix/client/r0/rooms/{roomId}/receipt/{receiptType}/{eventId}`
 ///
 /// Sets private read marker and public read receipt EDU.
-pub async fn create_receipt_route(body: Ruma<create_receipt::v3::Request>) -> Result<create_receipt::v3::Response> {
+pub(crate) async fn create_receipt_route(
+	body: Ruma<create_receipt::v3::Request>,
+) -> Result<create_receipt::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	if matches!(
 		&body.receipt_type,
 		create_receipt::v3::ReceiptType::Read | create_receipt::v3::ReceiptType::ReadPrivate
 	) {
-		services().rooms.user.reset_notification_counts(sender_user, &body.room_id)?;
+		services()
+			.rooms
+			.user
+			.reset_notification_counts(sender_user, &body.room_id)?;
 	}
 
 	match body.receipt_type {
@@ -128,7 +141,7 @@ pub async fn create_receipt_route(body: Ruma<create_receipt::v3::Request>) -> Re
 			let mut receipt_content = BTreeMap::new();
 			receipt_content.insert(body.event_id.clone(), receipts);
 
-			services().rooms.edus.read_receipt.readreceipt_update(
+			services().rooms.read_receipt.readreceipt_update(
 				sender_user,
 				&body.room_id,
 				ruma::events::receipt::ReceiptEvent {
@@ -152,7 +165,10 @@ pub async fn create_receipt_route(body: Ruma<create_receipt::v3::Request>) -> Re
 				},
 				PduCount::Normal(c) => c,
 			};
-			services().rooms.edus.read_receipt.private_read_set(&body.room_id, sender_user, count)?;
+			services()
+				.rooms
+				.read_receipt
+				.private_read_set(&body.room_id, sender_user, count)?;
 		},
 		_ => return Err(Error::bad_database("Unsupported receipt type")),
 	}

src/api/client_server/redact.rs

@@ -13,12 +13,19 @@ use crate::{service::pdu::PduBuilder, services, Result, Ruma};
 /// Tries to send a redaction event into the room.
 ///
 /// - TODO: Handle txn id
-pub async fn redact_event_route(body: Ruma<redact_event::v3::Request>) -> Result<redact_event::v3::Response> {
+pub(crate) async fn redact_event_route(body: Ruma<redact_event::v3::Request>) -> Result<redact_event::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let body = body.body;
 
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(body.room_id.clone()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(body.room_id.clone())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
 	let event_id = services()

src/api/client_server/relations.rs

@@ -2,112 +2,87 @@ use ruma::api::client::relations::{
 	get_relating_events, get_relating_events_with_rel_type, get_relating_events_with_rel_type_and_event_type,
 };
 
-use crate::{service::rooms::timeline::PduCount, services, Result, Ruma};
+use crate::{services, Result, Ruma};
 
 /// # `GET /_matrix/client/r0/rooms/{roomId}/relations/{eventId}/{relType}/{eventType}`
-pub async fn get_relating_events_with_rel_type_and_event_type_route(
+pub(crate) async fn get_relating_events_with_rel_type_and_event_type_route(
 	body: Ruma<get_relating_events_with_rel_type_and_event_type::v1::Request>,
 ) -> Result<get_relating_events_with_rel_type_and_event_type::v1::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let from = match body.from.clone() {
-		Some(from) => PduCount::try_from_string(&from)?,
-		None => match ruma::api::Direction::Backward {
-			// TODO: fix ruma so `body.dir` exists
-			ruma::api::Direction::Forward => PduCount::min(),
-			ruma::api::Direction::Backward => PduCount::max(),
-		},
-	};
-
-	let to = body.to.as_ref().and_then(|t| PduCount::try_from_string(t).ok());
-
-	// Use limit or else 10, with maximum 100
-	let limit = body.limit.and_then(|u| u32::try_from(u).ok()).map_or(10_usize, |u| u as usize).min(100);
-
-	let res = services().rooms.pdu_metadata.paginate_relations_with_filter(
-		sender_user,
-		&body.room_id,
-		&body.event_id,
-		&Some(body.event_type.clone()),
-		&Some(body.rel_type.clone()),
-		from,
-		to,
-		limit,
-	)?;
+	let res = services()
+		.rooms
+		.pdu_metadata
+		.paginate_relations_with_filter(
+			sender_user,
+			&body.room_id,
+			&body.event_id,
+			&Some(body.event_type.clone()),
+			&Some(body.rel_type.clone()),
+			&body.from,
+			&body.to,
+			&body.limit,
+			body.recurse,
+			body.dir,
+		)?;
 
 	Ok(get_relating_events_with_rel_type_and_event_type::v1::Response {
 		chunk: res.chunk,
 		next_batch: res.next_batch,
 		prev_batch: res.prev_batch,
+		recursion_depth: res.recursion_depth,
 	})
 }
 
 /// # `GET /_matrix/client/r0/rooms/{roomId}/relations/{eventId}/{relType}`
-pub async fn get_relating_events_with_rel_type_route(
+pub(crate) async fn get_relating_events_with_rel_type_route(
 	body: Ruma<get_relating_events_with_rel_type::v1::Request>,
 ) -> Result<get_relating_events_with_rel_type::v1::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let from = match body.from.clone() {
-		Some(from) => PduCount::try_from_string(&from)?,
-		None => match ruma::api::Direction::Backward {
-			// TODO: fix ruma so `body.dir` exists
-			ruma::api::Direction::Forward => PduCount::min(),
-			ruma::api::Direction::Backward => PduCount::max(),
-		},
-	};
-
-	let to = body.to.as_ref().and_then(|t| PduCount::try_from_string(t).ok());
-
-	// Use limit or else 10, with maximum 100
-	let limit = body.limit.and_then(|u| u32::try_from(u).ok()).map_or(10_usize, |u| u as usize).min(100);
-
-	let res = services().rooms.pdu_metadata.paginate_relations_with_filter(
-		sender_user,
-		&body.room_id,
-		&body.event_id,
-		&None,
-		&Some(body.rel_type.clone()),
-		from,
-		to,
-		limit,
-	)?;
+	let res = services()
+		.rooms
+		.pdu_metadata
+		.paginate_relations_with_filter(
+			sender_user,
+			&body.room_id,
+			&body.event_id,
+			&None,
+			&Some(body.rel_type.clone()),
+			&body.from,
+			&body.to,
+			&body.limit,
+			body.recurse,
+			body.dir,
+		)?;
 
 	Ok(get_relating_events_with_rel_type::v1::Response {
 		chunk: res.chunk,
 		next_batch: res.next_batch,
 		prev_batch: res.prev_batch,
+		recursion_depth: res.recursion_depth,
 	})
 }
 
 /// # `GET /_matrix/client/r0/rooms/{roomId}/relations/{eventId}`
-pub async fn get_relating_events_route(
+pub(crate) async fn get_relating_events_route(
 	body: Ruma<get_relating_events::v1::Request>,
 ) -> Result<get_relating_events::v1::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let from = match body.from.clone() {
-		Some(from) => PduCount::try_from_string(&from)?,
-		None => match ruma::api::Direction::Backward {
-			// TODO: fix ruma so `body.dir` exists
-			ruma::api::Direction::Forward => PduCount::min(),
-			ruma::api::Direction::Backward => PduCount::max(),
-		},
-	};
-
-	let to = body.to.as_ref().and_then(|t| PduCount::try_from_string(t).ok());
-
-	// Use limit or else 10, with maximum 100
-	let limit = body.limit.and_then(|u| u32::try_from(u).ok()).map_or(10_usize, |u| u as usize).min(100);
-
-	services().rooms.pdu_metadata.paginate_relations_with_filter(
-		sender_user,
-		&body.room_id,
-		&body.event_id,
-		&None,
-		&None,
-		from,
-		to,
-		limit,
-	)
+	services()
+		.rooms
+		.pdu_metadata
+		.paginate_relations_with_filter(
+			sender_user,
+			&body.room_id,
+			&body.event_id,
+			&None,
+			&None,
+			&body.from,
+			&body.to,
+			&body.limit,
+			body.recurse,
+			body.dir,
+		)
 }

src/api/client_server/report.rs

@@ -4,85 +4,53 @@ use rand::Rng;
 use ruma::{
 	api::client::{error::ErrorKind, room::report_content},
 	events::room::message,
-	int,
+	int, EventId, RoomId, UserId,
 };
 use tokio::time::sleep;
-use tracing::{debug, info};
+use tracing::info;
 
-use crate::{services, utils::HtmlEscape, Error, Result, Ruma};
+use crate::{debug_info, service::pdu::PduEvent, services, utils::HtmlEscape, Error, Result, Ruma};
 
 /// # `POST /_matrix/client/v3/rooms/{roomId}/report/{eventId}`
 ///
 /// Reports an inappropriate event to homeserver admins
-pub async fn report_event_route(body: Ruma<report_content::v3::Request>) -> Result<report_content::v3::Response> {
+pub(crate) async fn report_event_route(
+	body: Ruma<report_content::v3::Request>,
+) -> Result<report_content::v3::Response> {
 	// user authentication
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	info!("Received /report request by user {}", sender_user);
+	info!(
+		"Received /report request by user {sender_user} for room {} and event ID {}",
+		body.room_id, body.event_id
+	);
 
 	// check if we know about the reported event ID or if it's invalid
-	let pdu = match services().rooms.timeline.get_pdu(&body.event_id)? {
-		Some(pdu) => pdu,
-		_ => {
-			return Err(Error::BadRequest(
-				ErrorKind::NotFound,
-				"Event ID is not known to us or Event ID is invalid",
-			))
-		},
-	};
-
-	// check if the room ID from the URI matches the PDU's room ID
-	if body.room_id != pdu.room_id {
+	let Some(pdu) = services().rooms.timeline.get_pdu(&body.event_id)? else {
 		return Err(Error::BadRequest(
 			ErrorKind::NotFound,
-			"Event ID does not belong to the reported room",
-		));
-	}
-
-	// check if reporting user is in the reporting room
-	if !services()
-		.rooms
-		.state_cache
-		.room_members(&pdu.room_id)
-		.filter_map(std::result::Result::ok)
-		.any(|user_id| user_id == *sender_user)
-	{
-		return Err(Error::BadRequest(
-			ErrorKind::NotFound,
-			"You are not in the room you are reporting.",
-		));
-	}
-
-	// check if score is in valid range
-	if let Some(true) = body.score.map(|s| s > int!(0) || s < int!(-100)) {
-		return Err(Error::BadRequest(
-			ErrorKind::InvalidParam,
-			"Invalid score, must be within 0 to -100",
+			"Event ID is not known to us or Event ID is invalid",
 		));
 	};
 
-	// check if report reasoning is less than or equal to 750 characters
-	if let Some(true) = body.reason.clone().map(|s| s.chars().count() >= 750) {
-		return Err(Error::BadRequest(
-			ErrorKind::InvalidParam,
-			"Reason too long, should be 750 characters or fewer",
-		));
-	};
+	is_report_valid(&pdu.event_id, &body.room_id, sender_user, &body.reason, body.score, &pdu)?;
 
 	// send admin room message that we received the report with an @room ping for
 	// urgency
-	services().admin.send_message(message::RoomMessageEventContent::text_html(
-		format!(
-			"@room Report received from: {}\n\nEvent ID: {}\nRoom ID: {}\nSent By: {}\n\nReport Score: {}\nReport \
-			 Reason: {}",
-			sender_user.to_owned(),
-			pdu.event_id,
-			pdu.room_id,
-			pdu.sender.clone(),
-			body.score.unwrap_or_else(|| ruma::Int::from(0)),
-			body.reason.as_deref().unwrap_or("")
-		),
-		format!(
+	services()
+		.admin
+		.send_message(message::RoomMessageEventContent::text_html(
+			format!(
+				"@room Report received from: {}\n\nEvent ID: {}\nRoom ID: {}\nSent By: {}\n\nReport Score: {}\nReport \
+				 Reason: {}",
+				sender_user.to_owned(),
+				pdu.event_id,
+				pdu.room_id,
+				pdu.sender.clone(),
+				body.score.unwrap_or_else(|| ruma::Int::from(0)),
+				body.reason.as_deref().unwrap_or("")
+			),
+			format!(
 				"<details><summary>@room Report received from: <a href=\"https://matrix.to/#/{0}\">{0}\
                 </a></summary><ul><li>Event Info<ul><li>Event ID: <code>{1}</code>\
                 <a href=\"https://matrix.to/#/{2}/{1}\">🔗</a></li><li>Room ID: <code>{2}</code>\
@@ -96,17 +64,70 @@ pub async fn report_event_route(body: Ruma<report_content::v3::Request>) -> Resu
 				body.score.unwrap_or_else(|| ruma::Int::from(0)),
 				HtmlEscape(body.reason.as_deref().unwrap_or(""))
 			),
-	));
+		))
+		.await;
 
-	// even though this is kinda security by obscurity, let's still make a small
-	// random delay sending a successful response per spec suggestion regarding
-	// enumerating for potential events existing in our server.
-	let time_to_wait = rand::thread_rng().gen_range(8..21);
-	debug!(
-		"Got successful /report request, waiting {} seconds before sending successful response.",
-		time_to_wait
-	);
-	sleep(Duration::from_secs(time_to_wait)).await;
+	delay_response().await?;
 
 	Ok(report_content::v3::Response {})
 }
+
+/// in the following order:
+///
+/// check if the room ID from the URI matches the PDU's room ID
+/// check if reporting user is in the reporting room
+/// check if score is in valid range
+/// check if report reasoning is less than or equal to 750 characters
+fn is_report_valid(
+	event_id: &EventId, room_id: &RoomId, sender_user: &UserId, reason: &Option<String>, score: Option<ruma::Int>,
+	pdu: &std::sync::Arc<PduEvent>,
+) -> Result<bool> {
+	debug_info!("Checking if report from user {sender_user} for event {event_id} in room {room_id} is valid");
+
+	if room_id != pdu.room_id {
+		return Err(Error::BadRequest(
+			ErrorKind::NotFound,
+			"Event ID does not belong to the reported room",
+		));
+	}
+
+	if services()
+		.rooms
+		.state_cache
+		.room_members(&pdu.room_id)
+		.filter_map(Result::ok)
+		.any(|user_id| user_id != *sender_user)
+	{
+		return Err(Error::BadRequest(
+			ErrorKind::NotFound,
+			"You are not in the room you are reporting.",
+		));
+	}
+
+	if let Some(true) = score.map(|s| s > int!(0) || s < int!(-100)) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Invalid score, must be within 0 to -100",
+		));
+	};
+
+	if let Some(true) = reason.clone().map(|s| s.len() >= 750) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Reason too long, should be 750 characters or fewer",
+		));
+	};
+
+	Ok(true)
+}
+
+/// even though this is kinda security by obscurity, let's still make a small
+/// random delay sending a successful response per spec suggestion regarding
+/// enumerating for potential events existing in our server.
+async fn delay_response() -> Result<()> {
+	let time_to_wait = rand::thread_rng().gen_range(8..21);
+	debug_info!("Got successful /report request, waiting {time_to_wait} seconds before sending successful response.");
+	sleep(Duration::from_secs(time_to_wait)).await;
+
+	Ok(())
+}

src/api/client_server/room.rs

@@ -21,20 +21,38 @@ use ruma::{
 		StateEventType, TimelineEventType,
 	},
 	int,
-	serde::JsonObject,
-	CanonicalJsonObject, CanonicalJsonValue, OwnedRoomAliasId, OwnedRoomId, RoomAliasId, RoomId, RoomVersionId,
+	serde::{JsonObject, Raw},
+	CanonicalJsonObject, Int, OwnedRoomAliasId, OwnedRoomId, OwnedUserId, RoomAliasId, RoomId, RoomVersionId,
 };
 use serde_json::{json, value::to_raw_value};
-use tracing::{debug, error, info, warn};
+use tracing::{error, info, warn};
 
-use crate::{api::client_server::invite_helper, service::pdu::PduBuilder, services, Error, Result, Ruma};
+use crate::{
+	api::client_server::invite_helper,
+	debug_info, debug_warn,
+	service::{appservice::RegistrationInfo, pdu::PduBuilder},
+	services, Error, Result, Ruma,
+};
+
+/// Recommended transferable state events list from the spec
+const TRANSFERABLE_STATE_EVENTS: &[StateEventType; 9] = &[
+	StateEventType::RoomServerAcl,
+	StateEventType::RoomEncryption,
+	StateEventType::RoomName,
+	StateEventType::RoomAvatar,
+	StateEventType::RoomTopic,
+	StateEventType::RoomGuestAccess,
+	StateEventType::RoomHistoryVisibility,
+	StateEventType::RoomJoinRules,
+	StateEventType::RoomPowerLevels,
+];
 
 /// # `POST /_matrix/client/v3/createRoom`
 ///
 /// Creates a new room.
 ///
 /// - Room ID is randomly generated
-/// - Create alias if room_alias_name is set
+/// - Create alias if `room_alias_name` is set
 /// - Send create event
 /// - Join sender user
 /// - Send power levels event
@@ -45,60 +63,23 @@ use crate::{api::client_server::invite_helper, service::pdu::PduBuilder, service
 /// - Send events listed in initial state
 /// - Send events implied by `name` and `topic`
 /// - Send invite events
-pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<create_room::v3::Response> {
+pub(crate) async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<create_room::v3::Response> {
 	use create_room::v3::RoomPreset;
 
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().globals.allow_room_creation() && !&body.from_appservice && !services().users.is_admin(sender_user)? {
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Room creation has been disabled."));
+	if !services().globals.allow_room_creation()
+		&& body.appservice_info.is_none()
+		&& !services().users.is_admin(sender_user)?
+	{
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "Room creation has been disabled."));
 	}
 
-	let room_id: OwnedRoomId;
-
-	// checks if the user specified an explicit (custom) room_id to be created with
-	// in request body. falls back to normal generated room ID if not specified.
-	if let Some(CanonicalJsonValue::Object(json_body)) = &body.json_body {
-		match json_body.get("room_id") {
-			Some(custom_room_id) => {
-				let custom_room_id_s = custom_room_id.to_string();
-
-				// do some checks on the custom room ID similar to room aliases
-				if custom_room_id_s.contains(':') {
-					return Err(Error::BadRequest(
-						ErrorKind::InvalidParam,
-						"Custom room ID contained `:` which is not allowed. Please note that this expects a \
-						 localpart, not the full room ID.",
-					));
-				} else if custom_room_id_s.contains(char::is_whitespace) {
-					return Err(Error::BadRequest(
-						ErrorKind::InvalidParam,
-						"Custom room ID contained spaces which is not valid.",
-					));
-				} else if custom_room_id_s.len() > 255 {
-					return Err(Error::BadRequest(ErrorKind::InvalidParam, "Custom room ID is too long."));
-				}
-
-				// apply forbidden room alias checks to custom room IDs too
-				if services().globals.forbidden_room_names().is_match(&custom_room_id_s) {
-					return Err(Error::BadRequest(ErrorKind::Unknown, "Custom room ID is forbidden."));
-				}
-
-				let full_room_id = "!".to_owned()
-					+ &custom_room_id_s.replace('"', "")
-					+ ":" + services().globals.server_name().as_ref();
-				debug!("Full room ID: {}", full_room_id);
-
-				room_id = RoomId::parse(full_room_id).map_err(|e| {
-					info!("User attempted to create room with custom room ID but failed parsing: {}", e);
-					Error::BadRequest(ErrorKind::InvalidParam, "Custom room ID could not be parsed")
-				})?;
-			},
-			None => room_id = RoomId::new(services().globals.server_name()),
-		}
+	let room_id: OwnedRoomId = if let Some(custom_room_id) = &body.room_id {
+		custom_room_id_check(custom_room_id)?
 	} else {
-		room_id = RoomId::new(services().globals.server_name());
-	}
+		RoomId::new(&services().globals.config.server_name)
+	};
 
 	// check if room ID doesn't already exist instead of erroring on auth check
 	if services().rooms.short.get_shortroomid(&room_id)?.is_some() {
@@ -110,60 +91,30 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 
 	services().rooms.short.get_or_create_shortroomid(&room_id)?;
 
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(room_id.clone()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(room_id.clone())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
-	let alias: Option<OwnedRoomAliasId> = body.room_alias_name.as_ref().map_or(Ok(None), |localpart| {
-		// Basic checks on the room alias validity
-		if localpart.contains(':') {
-			return Err(Error::BadRequest(
-				ErrorKind::InvalidParam,
-				"Room alias contained `:` which is not allowed. Please note that this expects a localpart, not the \
-				 full room alias.",
-			));
-		} else if localpart.contains(char::is_whitespace) {
-			return Err(Error::BadRequest(
-				ErrorKind::InvalidParam,
-				"Room alias contained spaces which is not a valid room alias.",
-			));
-		} else if localpart.len() > 255 {
-			// there is nothing spec-wise saying to check the limit of this,
-			// however absurdly long room aliases are guaranteed to be unreadable or done
-			// maliciously. there is no reason a room alias should even exceed 100
-			// characters as is. generally in spec, 255 is matrix's fav number
-			return Err(Error::BadRequest(
-				ErrorKind::InvalidParam,
-				"Room alias is excessively long, clients may not be able to handle this. Please shorten it.",
-			));
-		} else if localpart.contains('"') {
-			return Err(Error::BadRequest(
-				ErrorKind::InvalidParam,
-				"Room alias contained `\"` which is not allowed.",
-			));
-		}
-
-		// check if room alias is forbidden
-		if services().globals.forbidden_room_names().is_match(localpart) {
-			return Err(Error::BadRequest(ErrorKind::Unknown, "Room alias name is forbidden."));
-		}
-
-		let alias =
-			RoomAliasId::parse(format!("#{}:{}", localpart, services().globals.server_name())).map_err(|e| {
-				warn!("Failed to parse room alias for room ID {}: {e}", room_id);
-				Error::BadRequest(ErrorKind::InvalidParam, "Invalid room alias specified.")
-			})?;
-
-		if services().rooms.alias.resolve_local_alias(&alias)?.is_some() {
-			Err(Error::BadRequest(ErrorKind::RoomInUse, "Room alias already exists."))
-		} else {
-			Ok(Some(alias))
-		}
-	})?;
+	let alias: Option<OwnedRoomAliasId> = if let Some(alias) = &body.room_alias_name {
+		Some(room_alias_check(alias, &body.appservice_info).await?)
+	} else {
+		None
+	};
 
 	let room_version = match body.room_version.clone() {
 		Some(room_version) => {
-			if services().globals.supported_room_versions().contains(&room_version) {
+			if services()
+				.globals
+				.supported_room_versions()
+				.contains(&room_version)
+			{
 				room_version
 			} else {
 				return Err(Error::BadRequest(
@@ -177,10 +128,12 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 
 	let content = match &body.creation_content {
 		Some(content) => {
-			let mut content = content.deserialize_as::<CanonicalJsonObject>().map_err(|e| {
-				error!("Failed to deserialise content as canonical JSON: {}", e);
-				Error::bad_database("Failed to deserialise content as canonical JSON.")
-			})?;
+			let mut content = content
+				.deserialize_as::<CanonicalJsonObject>()
+				.map_err(|e| {
+					error!("Failed to deserialise content as canonical JSON: {}", e);
+					Error::bad_database("Failed to deserialise content as canonical JSON.")
+				})?;
 			match room_version {
 				RoomVersionId::V1
 				| RoomVersionId::V2
@@ -202,7 +155,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				},
 				RoomVersionId::V11 => {}, // V11 removed the "creator" key
 				_ => {
-					warn!("Unexpected or unsupported room version {}", room_version);
+					warn!("Unexpected or unsupported room version {room_version}");
 					return Err(Error::BadRequest(
 						ErrorKind::BadJson,
 						"Unexpected or unsupported room version found",
@@ -219,7 +172,6 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 			content
 		},
 		None => {
-			// TODO: Add correct value for v11
 			let content = match room_version {
 				RoomVersionId::V1
 				| RoomVersionId::V2
@@ -233,7 +185,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				| RoomVersionId::V10 => RoomCreateEventContent::new_v1(sender_user.clone()),
 				RoomVersionId::V11 => RoomCreateEventContent::new_v11(),
 				_ => {
-					warn!("Unexpected or unsupported room version {}", room_version);
+					warn!("Unexpected or unsupported room version {room_version}");
 					return Err(Error::BadRequest(
 						ErrorKind::BadJson,
 						"Unexpected or unsupported room version found",
@@ -242,7 +194,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 			};
 			let mut content = serde_json::from_str::<CanonicalJsonObject>(
 				to_raw_value(&content)
-					.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Invalid creation content"))?
+					.expect("we just created this as content was None")
 					.get(),
 			)
 			.unwrap();
@@ -250,20 +202,12 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				"room_version".into(),
 				json!(room_version.as_str())
 					.try_into()
-					.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Invalid creation content"))?,
+					.expect("we just created this as content was None"),
 			);
 			content
 		},
 	};
 
-	// Validate creation content
-	let de_result =
-		serde_json::from_str::<CanonicalJsonObject>(to_raw_value(&content).expect("Invalid creation content").get());
-
-	if de_result.is_err() {
-		return Err(Error::BadRequest(ErrorKind::BadJson, "Invalid creation content"));
-	}
-
 	// 1. The room create event
 	services()
 		.rooms
@@ -273,7 +217,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				event_type: TimelineEventType::RoomCreate,
 				content: to_raw_value(&content).expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -327,20 +271,8 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 		}
 	}
 
-	let mut power_levels_content = serde_json::to_value(RoomPowerLevelsEventContent {
-		users,
-		..Default::default()
-	})
-	.expect("event is valid, we just created it");
-
-	if let Some(power_level_content_override) = &body.power_level_content_override {
-		let json: JsonObject = serde_json::from_str(power_level_content_override.json().get())
-			.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Invalid power_level_content_override."))?;
-
-		for (key, value) in json {
-			power_levels_content[key] = value;
-		}
-	}
+	let power_levels_content =
+		default_power_levels_content(&body.power_level_content_override, &body.visibility, users)?;
 
 	services()
 		.rooms
@@ -350,7 +282,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				event_type: TimelineEventType::RoomPowerLevels,
 				content: to_raw_value(&power_levels_content).expect("to_raw_value always works on serde_json::Value"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -373,7 +305,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 					})
 					.expect("We checked that alias earlier, it must be fine"),
 					unsigned: None,
-					state_key: Some("".to_owned()),
+					state_key: Some(String::new()),
 					redacts: None,
 				},
 				sender_user,
@@ -399,7 +331,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				}))
 				.expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -418,7 +350,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				content: to_raw_value(&RoomHistoryVisibilityEventContent::new(HistoryVisibility::Shared))
 					.expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -440,7 +372,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 				}))
 				.expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -456,15 +388,30 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 			Error::BadRequest(ErrorKind::InvalidParam, "Invalid initial state event.")
 		})?;
 
+		debug_warn!("initial state event: {event:?}");
+
+		// client/appservice workaround: if a user sends an initial_state event with a
+		// state event in there with the content of literally `{}` (not null or empty
+		// string), let's just skip it over and warn.
+		if pdu_builder.content.get().eq("{}") {
+			info!("skipping empty initial state event with content of `{{}}`: {event:?}");
+			debug_warn!("content: {}", pdu_builder.content.get());
+			continue;
+		}
+
 		// Implicit state key defaults to ""
-		pdu_builder.state_key.get_or_insert_with(|| "".to_owned());
+		pdu_builder.state_key.get_or_insert_with(String::new);
 
 		// Silently skip encryption events if they are not allowed
 		if pdu_builder.event_type == TimelineEventType::RoomEncryption && !services().globals.allow_encryption() {
 			continue;
 		}
 
-		services().rooms.timeline.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock).await?;
+		services()
+			.rooms
+			.timeline
+			.build_and_append_pdu(pdu_builder, sender_user, &room_id, &state_lock)
+			.await?;
 	}
 
 	// 7. Events implied by name and topic
@@ -478,7 +425,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 					content: to_raw_value(&RoomNameEventContent::new(name.clone()))
 						.expect("event is valid, we just created it"),
 					unsigned: None,
-					state_key: Some("".to_owned()),
+					state_key: Some(String::new()),
 					redacts: None,
 				},
 				sender_user,
@@ -500,7 +447,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 					})
 					.expect("event is valid, we just created it"),
 					unsigned: None,
-					state_key: Some("".to_owned()),
+					state_key: Some(String::new()),
 					redacts: None,
 				},
 				sender_user,
@@ -513,7 +460,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 	// 8. Events implied by invite (and TODO: invite_3pid)
 	drop(state_lock);
 	for user_id in &body.invite {
-		let _ = invite_helper(sender_user, user_id, &room_id, None, body.is_direct).await;
+		_ = invite_helper(sender_user, user_id, &room_id, None, body.is_direct).await;
 	}
 
 	// Homeserver specific stuff
@@ -525,7 +472,7 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 		services().rooms.directory.set_public(&room_id)?;
 	}
 
-	info!("{} created a room", sender_user);
+	info!("{sender_user} created a room with room ID {room_id}");
 
 	Ok(create_room::v3::Response::new(room_id))
 }
@@ -536,17 +483,27 @@ pub async fn create_room_route(body: Ruma<create_room::v3::Request>) -> Result<c
 ///
 /// - You have to currently be joined to the room (TODO: Respect history
 ///   visibility)
-pub async fn get_room_event_route(body: Ruma<get_room_event::v3::Request>) -> Result<get_room_event::v3::Response> {
+pub(crate) async fn get_room_event_route(
+	body: Ruma<get_room_event::v3::Request>,
+) -> Result<get_room_event::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let event = services().rooms.timeline.get_pdu(&body.event_id)?.ok_or_else(|| {
-		warn!("Event not found, event ID: {:?}", &body.event_id);
-		Error::BadRequest(ErrorKind::NotFound, "Event not found.")
-	})?;
+	let event = services()
+		.rooms
+		.timeline
+		.get_pdu(&body.event_id)?
+		.ok_or_else(|| {
+			warn!("Event not found, event ID: {:?}", &body.event_id);
+			Error::BadRequest(ErrorKind::NotFound, "Event not found.")
+		})?;
 
-	if !services().rooms.state_accessor.user_can_see_event(sender_user, &event.room_id, &body.event_id)? {
+	if !services()
+		.rooms
+		.state_accessor
+		.user_can_see_event(sender_user, &event.room_id, &body.event_id)?
+	{
 		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
+			ErrorKind::forbidden(),
 			"You don't have permission to view this event.",
 		));
 	}
@@ -563,14 +520,18 @@ pub async fn get_room_event_route(body: Ruma<get_room_event::v3::Request>) -> Re
 ///
 /// Lists all aliases of the room.
 ///
-/// - Only users joined to the room are allowed to call this TODO: Allow any
-///   user to call it if history_visibility is world readable
-pub async fn get_room_aliases_route(body: Ruma<aliases::v3::Request>) -> Result<aliases::v3::Response> {
+/// - Only users joined to the room are allowed to call this, or if
+///   `history_visibility` is world readable in the room
+pub(crate) async fn get_room_aliases_route(body: Ruma<aliases::v3::Request>) -> Result<aliases::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().rooms.state_cache.is_joined(sender_user, &body.room_id)? {
+	if !services()
+		.rooms
+		.state_accessor
+		.user_can_see_state_events(sender_user, &body.room_id)?
+	{
 		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
+			ErrorKind::forbidden(),
 			"You don't have permission to view this room.",
 		));
 	}
@@ -580,7 +541,7 @@ pub async fn get_room_aliases_route(body: Ruma<aliases::v3::Request>) -> Result<
 			.rooms
 			.alias
 			.local_aliases_for_room(&body.room_id)
-			.filter_map(std::result::Result::ok)
+			.filter_map(Result::ok)
 			.collect(),
 	})
 }
@@ -595,10 +556,14 @@ pub async fn get_room_aliases_route(body: Ruma<aliases::v3::Request>) -> Result<
 /// - Transfers some state events
 /// - Moves local aliases
 /// - Modifies old room power levels to prevent users from speaking
-pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result<upgrade_room::v3::Response> {
+pub(crate) async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result<upgrade_room::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().globals.supported_room_versions().contains(&body.new_version) {
+	if !services()
+		.globals
+		.supported_room_versions()
+		.contains(&body.new_version)
+	{
 		return Err(Error::BadRequest(
 			ErrorKind::UnsupportedRoomVersion,
 			"This server does not support that room version.",
@@ -607,10 +572,20 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 
 	// Create a replacement room
 	let replacement_room = RoomId::new(services().globals.server_name());
-	services().rooms.short.get_or_create_shortroomid(&replacement_room)?;
+	services()
+		.rooms
+		.short
+		.get_or_create_shortroomid(&replacement_room)?;
 
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(body.room_id.clone()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(body.room_id.clone())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
 	// Send a m.room.tombstone event to the old room to indicate that it is not
@@ -628,7 +603,7 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 				})
 				.expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -639,8 +614,15 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 
 	// Change lock to replacement room
 	drop(state_lock);
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(replacement_room.clone()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(replacement_room.clone())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
 	// Get the old room creation event
@@ -709,11 +691,13 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 	);
 
 	// Validate creation event content
-	let de_result = serde_json::from_str::<CanonicalJsonObject>(
-		to_raw_value(&create_event_content).expect("Error forming creation event").get(),
-	);
-
-	if de_result.is_err() {
+	if serde_json::from_str::<CanonicalJsonObject>(
+		to_raw_value(&create_event_content)
+			.expect("Error forming creation event")
+			.get(),
+	)
+	.is_err()
+	{
 		return Err(Error::BadRequest(ErrorKind::BadJson, "Error forming creation event"));
 	}
 
@@ -725,7 +709,7 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 				event_type: TimelineEventType::RoomCreate,
 				content: to_raw_value(&create_event_content).expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -762,22 +746,13 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 		)
 		.await?;
 
-	// Recommended transferable state events list from the specs
-	let transferable_state_events = vec![
-		StateEventType::RoomServerAcl,
-		StateEventType::RoomEncryption,
-		StateEventType::RoomName,
-		StateEventType::RoomAvatar,
-		StateEventType::RoomTopic,
-		StateEventType::RoomGuestAccess,
-		StateEventType::RoomHistoryVisibility,
-		StateEventType::RoomJoinRules,
-		StateEventType::RoomPowerLevels,
-	];
-
 	// Replicate transferable state events to the new room
-	for event_type in transferable_state_events {
-		let event_content = match services().rooms.state_accessor.room_state_get(&body.room_id, &event_type, "")? {
+	for event_type in TRANSFERABLE_STATE_EVENTS {
+		let event_content = match services()
+			.rooms
+			.state_accessor
+			.room_state_get(&body.room_id, event_type, "")?
+		{
 			Some(v) => v.content.clone(),
 			None => continue, // Skipping missing events.
 		};
@@ -790,7 +765,7 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 					event_type: event_type.to_string().into(),
 					content: event_content,
 					unsigned: None,
-					state_key: Some("".to_owned()),
+					state_key: Some(String::new()),
 					redacts: None,
 				},
 				sender_user,
@@ -801,8 +776,16 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 	}
 
 	// Moves any local aliases to the new room
-	for alias in services().rooms.alias.local_aliases_for_room(&body.room_id).filter_map(std::result::Result::ok) {
-		services().rooms.alias.set_alias(&alias, &replacement_room)?;
+	for alias in services()
+		.rooms
+		.alias
+		.local_aliases_for_room(&body.room_id)
+		.filter_map(Result::ok)
+	{
+		services()
+			.rooms
+			.alias
+			.set_alias(&alias, &replacement_room)?;
 	}
 
 	// Get the old room power levels
@@ -824,7 +807,7 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 
 	// Modify the power levels in the old room to prevent sending of events and
 	// inviting new users
-	let _ = services()
+	_ = services()
 		.rooms
 		.timeline
 		.build_and_append_pdu(
@@ -832,7 +815,7 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 				event_type: TimelineEventType::RoomPowerLevels,
 				content: to_raw_value(&power_levels_event_content).expect("event is valid, we just created it"),
 				unsigned: None,
-				state_key: Some("".to_owned()),
+				state_key: Some(String::new()),
 				redacts: None,
 			},
 			sender_user,
@@ -848,3 +831,154 @@ pub async fn upgrade_room_route(body: Ruma<upgrade_room::v3::Request>) -> Result
 		replacement_room,
 	})
 }
+
+/// creates the power_levels_content for the PDU builder
+fn default_power_levels_content(
+	power_level_content_override: &Option<Raw<RoomPowerLevelsEventContent>>, visibility: &room::Visibility,
+	users: BTreeMap<OwnedUserId, Int>,
+) -> Result<serde_json::Value> {
+	let mut power_levels_content = serde_json::to_value(RoomPowerLevelsEventContent {
+		users,
+		..Default::default()
+	})
+	.expect("event is valid, we just created it");
+
+	// secure proper defaults of sensitive/dangerous permissions that moderators
+	// (power level 50) should not have easy access to
+	power_levels_content["events"]["m.room.power_levels"] = serde_json::to_value(100).expect("100 is valid Value");
+	power_levels_content["events"]["m.room.server_acl"] = serde_json::to_value(100).expect("100 is valid Value");
+	power_levels_content["events"]["m.room.tombstone"] = serde_json::to_value(100).expect("100 is valid Value");
+	power_levels_content["events"]["m.room.encryption"] = serde_json::to_value(100).expect("100 is valid Value");
+	power_levels_content["events"]["m.room.history_visibility"] =
+		serde_json::to_value(100).expect("100 is valid Value");
+
+	// synapse does this too. clients do not expose these permissions. it prevents
+	// default users from calling public rooms, for obvious reasons.
+	if *visibility == room::Visibility::Public {
+		power_levels_content["events"]["m.call.invite"] = serde_json::to_value(50).expect("50 is valid Value");
+		power_levels_content["events"]["org.matrix.msc3401.call"] =
+			serde_json::to_value(50).expect("50 is valid Value");
+		power_levels_content["events"]["org.matrix.msc3401.call.member"] =
+			serde_json::to_value(50).expect("50 is valid Value");
+	}
+
+	if let Some(power_level_content_override) = power_level_content_override {
+		let json: JsonObject = serde_json::from_str(power_level_content_override.json().get())
+			.map_err(|_| Error::BadRequest(ErrorKind::BadJson, "Invalid power_level_content_override."))?;
+
+		for (key, value) in json {
+			power_levels_content[key] = value;
+		}
+	}
+
+	Ok(power_levels_content)
+}
+
+/// if a room is being created with a room alias, run our checks
+async fn room_alias_check(
+	room_alias_name: &String, appservice_info: &Option<RegistrationInfo>,
+) -> Result<OwnedRoomAliasId> {
+	// Basic checks on the room alias validity
+	if room_alias_name.contains(':') {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Room alias contained `:` which is not allowed. Please note that this expects a localpart, not the full \
+			 room alias.",
+		));
+	} else if room_alias_name.contains(char::is_whitespace) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Room alias contained spaces which is not a valid room alias.",
+		));
+	} else if room_alias_name.len() > 255 {
+		// there is nothing spec-wise saying to check the limit of this,
+		// however absurdly long room aliases are guaranteed to be unreadable or done
+		// maliciously. there is no reason a room alias should even exceed 100
+		// characters as is. generally in spec, 255 is matrix's fav number
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Room alias is excessively long, clients may not be able to handle this. Please shorten it.",
+		));
+	} else if room_alias_name.contains('"') {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Room alias contained `\"` which is not allowed.",
+		));
+	}
+
+	// check if room alias is forbidden
+	if services()
+		.globals
+		.forbidden_alias_names()
+		.is_match(room_alias_name)
+	{
+		return Err(Error::BadRequest(ErrorKind::Unknown, "Room alias name is forbidden."));
+	}
+
+	let full_room_alias = RoomAliasId::parse(format!("#{}:{}", room_alias_name, services().globals.config.server_name))
+		.map_err(|e| {
+			info!("Failed to parse room alias {room_alias_name}: {e}");
+			Error::BadRequest(ErrorKind::InvalidParam, "Invalid room alias specified.")
+		})?;
+
+	if services()
+		.rooms
+		.alias
+		.resolve_local_alias(&full_room_alias)?
+		.is_some()
+	{
+		return Err(Error::BadRequest(ErrorKind::RoomInUse, "Room alias already exists."));
+	}
+
+	if let Some(ref info) = appservice_info {
+		if !info.aliases.is_match(full_room_alias.as_str()) {
+			return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias is not in namespace."));
+		}
+	} else if services()
+		.appservice
+		.is_exclusive_alias(&full_room_alias)
+		.await
+	{
+		return Err(Error::BadRequest(ErrorKind::Exclusive, "Room alias reserved by appservice."));
+	}
+
+	debug_info!("Full room alias: {full_room_alias}");
+
+	Ok(full_room_alias)
+}
+
+/// if a room is being created with a custom room ID, run our checks against it
+fn custom_room_id_check(custom_room_id: &String) -> Result<OwnedRoomId> {
+	// apply forbidden room alias checks to custom room IDs too
+	if services()
+		.globals
+		.forbidden_alias_names()
+		.is_match(custom_room_id)
+	{
+		return Err(Error::BadRequest(ErrorKind::Unknown, "Custom room ID is forbidden."));
+	}
+
+	if custom_room_id.contains(':') {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Custom room ID contained `:` which is not allowed. Please note that this expects a localpart, not the \
+			 full room ID.",
+		));
+	} else if custom_room_id.contains(char::is_whitespace) {
+		return Err(Error::BadRequest(
+			ErrorKind::InvalidParam,
+			"Custom room ID contained spaces which is not valid.",
+		));
+	} else if custom_room_id.len() > 255 {
+		return Err(Error::BadRequest(ErrorKind::InvalidParam, "Custom room ID is too long."));
+	}
+
+	let full_room_id = format!("!{}:{}", custom_room_id, services().globals.config.server_name);
+
+	debug_info!("Full custom room ID: {full_room_id}");
+
+	RoomId::parse(full_room_id).map_err(|e| {
+		info!("User attempted to create room with custom room ID {custom_room_id} but failed parsing: {e}");
+		Error::BadRequest(ErrorKind::InvalidParam, "Custom room ID could not be parsed")
+	})
+}

src/api/client_server/search.rs

@@ -1,12 +1,18 @@
 use std::collections::BTreeMap;
 
-use ruma::api::client::{
-	error::ErrorKind,
-	search::search_events::{
-		self,
-		v3::{EventContextResult, ResultCategories, ResultRoomEvents, SearchResult},
+use ruma::{
+	api::client::{
+		error::ErrorKind,
+		search::search_events::{
+			self,
+			v3::{EventContextResult, ResultCategories, ResultRoomEvents, SearchResult},
+		},
 	},
+	events::AnyStateEvent,
+	serde::Raw,
+	OwnedRoomId,
 };
+use tracing::debug;
 
 use crate::{services, Error, Result, Ruma};
 
@@ -16,30 +22,86 @@ use crate::{services, Error, Result, Ruma};
 ///
 /// - Only works if the user is currently joined to the room (TODO: Respect
 ///   history visibility)
-pub async fn search_events_route(body: Ruma<search_events::v3::Request>) -> Result<search_events::v3::Response> {
+pub(crate) async fn search_events_route(body: Ruma<search_events::v3::Request>) -> Result<search_events::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	let search_criteria = body.search_categories.room_events.as_ref().unwrap();
 	let filter = &search_criteria.filter;
+	let include_state = &search_criteria.include_state;
 
 	let room_ids = filter.rooms.clone().unwrap_or_else(|| {
-		services().rooms.state_cache.rooms_joined(sender_user).filter_map(std::result::Result::ok).collect()
+		services()
+			.rooms
+			.state_cache
+			.rooms_joined(sender_user)
+			.filter_map(Result::ok)
+			.collect()
 	});
 
 	// Use limit or else 10, with maximum 100
 	let limit = filter.limit.map_or(10, u64::from).min(100) as usize;
 
+	let mut room_states: BTreeMap<OwnedRoomId, Vec<Raw<AnyStateEvent>>> = BTreeMap::new();
+
+	if include_state.is_some_and(|include_state| include_state) {
+		for room_id in &room_ids {
+			if !services()
+				.rooms
+				.state_cache
+				.is_joined(sender_user, room_id)?
+			{
+				return Err(Error::BadRequest(
+					ErrorKind::forbidden(),
+					"You don't have permission to view this room.",
+				));
+			}
+
+			// check if sender_user can see state events
+			if services()
+				.rooms
+				.state_accessor
+				.user_can_see_state_events(sender_user, room_id)?
+			{
+				let room_state = services()
+					.rooms
+					.state_accessor
+					.room_state_full(room_id)
+					.await?
+					.values()
+					.map(|pdu| pdu.to_state_event())
+					.collect::<Vec<_>>();
+
+				debug!("Room state: {:?}", room_state);
+
+				room_states.insert(room_id.clone(), room_state);
+			} else {
+				return Err(Error::BadRequest(
+					ErrorKind::forbidden(),
+					"You don't have permission to view this room.",
+				));
+			}
+		}
+	}
+
 	let mut searches = Vec::new();
 
-	for room_id in room_ids {
-		if !services().rooms.state_cache.is_joined(sender_user, &room_id)? {
+	for room_id in &room_ids {
+		if !services()
+			.rooms
+			.state_cache
+			.is_joined(sender_user, room_id)?
+		{
 			return Err(Error::BadRequest(
-				ErrorKind::Forbidden,
+				ErrorKind::forbidden(),
 				"You don't have permission to view this room.",
 			));
 		}
 
-		if let Some(search) = services().rooms.search.search_pdus(&room_id, &search_criteria.search_term)? {
+		if let Some(search) = services()
+			.rooms
+			.search
+			.search_pdus(room_id, &search_criteria.search_term)?
+		{
 			searches.push(search.0.peekable());
 		}
 	}
@@ -92,7 +154,7 @@ pub async fn search_events_route(body: Ruma<search_events::v3::Request>) -> Resu
 				result: Some(result),
 			})
 		})
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.skip(skip)
 		.take(limit)
 		.collect();
@@ -105,11 +167,11 @@ pub async fn search_events_route(body: Ruma<search_events::v3::Request>) -> Resu
 
 	Ok(search_events::v3::Response::new(ResultCategories {
 		room_events: ResultRoomEvents {
-			count: Some((results.len() as u32).into()), // TODO: set this to none. Element shouldn't depend on it
-			groups: BTreeMap::new(),                    // TODO
+			count: Some((results.len() as u32).into()),
+			groups: BTreeMap::new(), // TODO
 			next_batch,
 			results,
-			state: BTreeMap::new(), // TODO
+			state: room_states,
 			highlights: search_criteria
 				.search_term
 				.split_terminator(|c: char| !c.is_alphanumeric())

src/api/client_server/session.rs

@@ -33,7 +33,9 @@ struct Claims {
 ///
 /// Get the supported login types of this server. One of these should be used as
 /// the `type` field when logging in.
-pub async fn get_login_types_route(_body: Ruma<get_login_types::v3::Request>) -> Result<get_login_types::v3::Response> {
+pub(crate) async fn get_login_types_route(
+	_body: Ruma<get_login_types::v3::Request>,
+) -> Result<get_login_types::v3::Response> {
 	Ok(get_login_types::v3::Response::new(vec![
 		get_login_types::v3::LoginType::Password(PasswordLoginType::default()),
 		get_login_types::v3::LoginType::ApplicationService(ApplicationServiceLoginType::default()),
@@ -54,7 +56,7 @@ pub async fn get_login_types_route(_body: Ruma<get_login_types::v3::Request>) ->
 /// Note: You can use [`GET
 /// /_matrix/client/r0/login`](fn.get_supported_versions_route.html) to see
 /// supported login types.
-pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Response> {
+pub(crate) async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Response> {
 	// Validate login method
 	// TODO: Other login methods
 	let user_id = match &body.login_info {
@@ -66,31 +68,27 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 			..
 		}) => {
 			debug!("Got password login type");
-			let username = if let Some(UserIdentifier::UserIdOrLocalpart(user_id)) = identifier {
-				debug!("Using username from identifier field");
-				user_id.to_lowercase()
-			} else if let Some(user_id) = user {
-				warn!(
-					"User \"{}\" is attempting to login with the deprecated \"user\" field at \
-					 \"/_matrix/client/v3/login\". conduwuit implements this deprecated behaviour, but this is \
-					 destined to be removed in a future Matrix release.",
-					user_id
-				);
-				user_id.to_lowercase()
+			let user_id = if let Some(UserIdentifier::UserIdOrLocalpart(user_id)) = identifier {
+				UserId::parse_with_server_name(user_id.to_lowercase(), services().globals.server_name())
+			} else if let Some(user) = user {
+				UserId::parse(user)
 			} else {
 				warn!("Bad login type: {:?}", &body.login_info);
-				return Err(Error::BadRequest(ErrorKind::Forbidden, "Bad login type."));
-			};
-
-			let user_id = UserId::parse_with_server_name(username, services().globals.server_name()).map_err(|e| {
-				warn!("Failed to parse username from user logging in: {}", e);
+				return Err(Error::BadRequest(ErrorKind::forbidden(), "Bad login type."));
+			}
+			.map_err(|e| {
+				warn!("Failed to parse username from user logging in: {e}");
 				Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid.")
 			})?;
 
+			if services().appservice.is_exclusive_user_id(&user_id).await {
+				return Err(Error::BadRequest(ErrorKind::Exclusive, "User ID reserved by appservice."));
+			}
+
 			let hash = services()
 				.users
 				.password_hash(&user_id)?
-				.ok_or(Error::BadRequest(ErrorKind::Forbidden, "Wrong username or password."))?;
+				.ok_or(Error::BadRequest(ErrorKind::forbidden(), "Wrong username or password."))?;
 
 			if hash.is_empty() {
 				return Err(Error::BadRequest(ErrorKind::UserDeactivated, "The user has been deactivated"));
@@ -101,10 +99,14 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 				return Err(Error::BadServerResponse("could not hash"));
 			};
 
-			let hash_matches = services().globals.argon.verify_password(password.as_bytes(), &parsed_hash).is_ok();
+			let hash_matches = services()
+				.globals
+				.argon
+				.verify_password(password.as_bytes(), &parsed_hash)
+				.is_ok();
 
 			if !hash_matches {
-				return Err(Error::BadRequest(ErrorKind::Forbidden, "Wrong username or password."));
+				return Err(Error::BadRequest(ErrorKind::forbidden(), "Wrong username or password."));
 			}
 
 			user_id
@@ -117,16 +119,23 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 				let token =
 					jsonwebtoken::decode::<Claims>(token, jwt_decoding_key, &jsonwebtoken::Validation::default())
 						.map_err(|e| {
-							warn!("Failed to parse JWT token from user logging in: {}", e);
+							warn!("Failed to parse JWT token from user logging in: {e}");
 							Error::BadRequest(ErrorKind::InvalidUsername, "Token is invalid.")
 						})?;
 
 				let username = token.claims.sub.to_lowercase();
 
-				UserId::parse_with_server_name(username, services().globals.server_name()).map_err(|e| {
-					warn!("Failed to parse username from user logging in: {}", e);
-					Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid.")
-				})?
+				let user_id =
+					UserId::parse_with_server_name(username, services().globals.server_name()).map_err(|e| {
+						warn!("Failed to parse username from user logging in: {e}");
+						Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid.")
+					})?;
+
+				if services().appservice.is_exclusive_user_id(&user_id).await {
+					return Err(Error::BadRequest(ErrorKind::Exclusive, "User ID reserved by appservice."));
+				}
+
+				user_id
 			} else {
 				return Err(Error::BadRequest(
 					ErrorKind::Unknown,
@@ -140,31 +149,28 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 			user,
 		}) => {
 			debug!("Got appservice login type");
-			if !body.from_appservice {
-				info!(
-					"User tried logging in as an appservice, but request body is not from a known/registered \
-					 appservice"
-				);
-				return Err(Error::BadRequest(ErrorKind::Forbidden, "Forbidden login type."));
-			};
-			let username = if let Some(UserIdentifier::UserIdOrLocalpart(user_id)) = identifier {
-				user_id.to_lowercase()
-			} else if let Some(user_id) = user {
-				warn!(
-					"Appservice \"{}\" is attempting to login with the deprecated \"user\" field at \
-					 \"/_matrix/client/v3/login\". conduwuit implements this deprecated behaviour, but this is \
-					 destined to be removed in a future Matrix release.",
-					user_id
-				);
-				user_id.to_lowercase()
+			let user_id = if let Some(UserIdentifier::UserIdOrLocalpart(user_id)) = identifier {
+				UserId::parse_with_server_name(user_id.to_lowercase(), services().globals.server_name())
+			} else if let Some(user) = user {
+				UserId::parse(user)
 			} else {
-				return Err(Error::BadRequest(ErrorKind::Forbidden, "Bad login type."));
-			};
-
-			UserId::parse_with_server_name(username, services().globals.server_name()).map_err(|e| {
-				warn!("Failed to parse username from appservice logging in: {}", e);
+				warn!("Bad login type: {:?}", &body.login_info);
+				return Err(Error::BadRequest(ErrorKind::forbidden(), "Bad login type."));
+			}
+			.map_err(|e| {
+				warn!("Failed to parse username from appservice logging in: {e}");
 				Error::BadRequest(ErrorKind::InvalidUsername, "Username is invalid.")
-			})?
+			})?;
+
+			if let Some(ref info) = body.appservice_info {
+				if !info.is_user_match(&user_id) {
+					return Err(Error::BadRequest(ErrorKind::Exclusive, "User is not in namespace."));
+				}
+			} else {
+				return Err(Error::BadRequest(ErrorKind::MissingToken, "Missing appservice token."));
+			}
+
+			user_id
 		},
 		_ => {
 			warn!("Unsupported or unknown login type: {:?}", &body.login_info);
@@ -174,28 +180,38 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 	};
 
 	// Generate new device id if the user didn't specify one
-	let device_id = body.device_id.clone().unwrap_or_else(|| utils::random_string(DEVICE_ID_LENGTH).into());
+	let device_id = body
+		.device_id
+		.clone()
+		.unwrap_or_else(|| utils::random_string(DEVICE_ID_LENGTH).into());
 
 	// Generate a new token for the device
 	let token = utils::random_string(TOKEN_LENGTH);
 
 	// Determine if device_id was provided and exists in the db for this user
 	let device_exists = body.device_id.as_ref().map_or(false, |device_id| {
-		services().users.all_device_ids(&user_id).any(|x| x.as_ref().map_or(false, |v| v == device_id))
+		services()
+			.users
+			.all_device_ids(&user_id)
+			.any(|x| x.as_ref().map_or(false, |v| v == device_id))
 	});
 
 	if device_exists {
 		services().users.set_token(&user_id, &device_id, &token)?;
 	} else {
-		services().users.create_device(&user_id, &device_id, &token, body.initial_device_display_name.clone())?;
+		services()
+			.users
+			.create_device(&user_id, &device_id, &token, body.initial_device_display_name.clone())?;
 	}
 
 	// send client well-known if specified so the client knows to reconfigure itself
-	let client_discovery_info = DiscoveryInfo::new(HomeserverInfo::new(
-		services().globals.well_known_client().to_owned().unwrap_or_else(|| "".to_owned()),
-	));
+	let client_discovery_info: Option<DiscoveryInfo> = services()
+		.globals
+		.well_known_client()
+		.as_ref()
+		.map(|server| DiscoveryInfo::new(HomeserverInfo::new(server.to_string())));
 
-	info!("{} logged in", user_id);
+	info!("{user_id} logged in");
 
 	// home_server is deprecated but apparently must still be sent despite it being
 	// deprecated over 6 years ago. initially i thought this macro was unnecessary,
@@ -205,13 +221,7 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 		user_id,
 		access_token: token,
 		device_id,
-		well_known: {
-			if client_discovery_info.homeserver.base_url.as_str() == "" {
-				None
-			} else {
-				Some(client_discovery_info)
-			}
-		},
+		well_known: client_discovery_info,
 		expires_in: None,
 		home_server: Some(services().globals.server_name().to_owned()),
 		refresh_token: None,
@@ -227,7 +237,7 @@ pub async fn login_route(body: Ruma<login::v3::Request>) -> Result<login::v3::Re
 ///   last seen ts)
 /// - Forgets to-device events
 /// - Triggers device list updates
-pub async fn logout_route(body: Ruma<logout::v3::Request>) -> Result<logout::v3::Response> {
+pub(crate) async fn logout_route(body: Ruma<logout::v3::Request>) -> Result<logout::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_ref().expect("user is authenticated");
 
@@ -252,7 +262,7 @@ pub async fn logout_route(body: Ruma<logout::v3::Request>) -> Result<logout::v3:
 /// Note: This is equivalent to calling [`GET
 /// /_matrix/client/r0/logout`](fn.logout_route.html) from each device of this
 /// user.
-pub async fn logout_all_route(body: Ruma<logout_all::v3::Request>) -> Result<logout_all::v3::Response> {
+pub(crate) async fn logout_all_route(body: Ruma<logout_all::v3::Request>) -> Result<logout_all::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	for device_id in services().users.all_device_ids(sender_user).flatten() {

src/api/client_server/space.rs

@@ -1,19 +1,54 @@
-use ruma::api::client::space::get_hierarchy;
+use std::str::FromStr;
 
-use crate::{services, Result, Ruma};
+use ruma::{
+	api::client::{error::ErrorKind, space::get_hierarchy},
+	UInt,
+};
 
-/// # `GET /_matrix/client/v1/rooms/{room_id}/hierarchy``
+use crate::{service::rooms::spaces::PagnationToken, services, Error, Result, Ruma};
+
+/// # `GET /_matrix/client/v1/rooms/{room_id}/hierarchy`
 ///
 /// Paginates over the space tree in a depth-first manner to locate child rooms
 /// of a given space.
-pub async fn get_hierarchy_route(body: Ruma<get_hierarchy::v1::Request>) -> Result<get_hierarchy::v1::Response> {
+pub(crate) async fn get_hierarchy_route(body: Ruma<get_hierarchy::v1::Request>) -> Result<get_hierarchy::v1::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let skip = body.from.as_ref().and_then(|s| s.parse::<usize>().ok()).unwrap_or(0);
+	let limit = body
+		.limit
+		.unwrap_or_else(|| UInt::from(10_u32))
+		.min(UInt::from(100_u32));
 
-	let limit = body.limit.map_or(10, u64::from).min(100) as usize;
+	let max_depth = body
+		.max_depth
+		.unwrap_or_else(|| UInt::from(3_u32))
+		.min(UInt::from(10_u32));
 
-	let max_depth = body.max_depth.map_or(3, u64::from).min(10) as usize + 1; // +1 to skip the space room itself
+	let key = body
+		.from
+		.as_ref()
+		.and_then(|s| PagnationToken::from_str(s).ok());
 
-	services().rooms.spaces.get_hierarchy(sender_user, &body.room_id, limit, skip, max_depth, body.suggested_only).await
+	// Should prevent unexpeded behaviour in (bad) clients
+	if let Some(ref token) = key {
+		if token.suggested_only != body.suggested_only || token.max_depth != max_depth {
+			return Err(Error::BadRequest(
+				ErrorKind::InvalidParam,
+				"suggested_only and max_depth cannot change on paginated requests",
+			));
+		}
+	}
+
+	services()
+		.rooms
+		.spaces
+		.get_client_hierarchy(
+			sender_user,
+			&body.room_id,
+			u64::from(limit) as usize,
+			key.map_or(0, |token| u64::from(token.skip) as usize),
+			u64::from(max_depth) as usize,
+			body.suggested_only,
+		)
+		.await
 }

src/api/client_server/state.rs

@@ -5,23 +5,35 @@ use ruma::{
 		error::ErrorKind,
 		state::{get_state_events, get_state_events_for_key, send_state_event},
 	},
-	events::{room::canonical_alias::RoomCanonicalAliasEventContent, AnyStateEventContent, StateEventType},
+	events::{
+		room::{
+			canonical_alias::RoomCanonicalAliasEventContent,
+			history_visibility::{HistoryVisibility, RoomHistoryVisibilityEventContent},
+			join_rules::{JoinRule, RoomJoinRulesEventContent},
+		},
+		AnyStateEventContent, StateEventType,
+	},
 	serde::Raw,
 	EventId, RoomId, UserId,
 };
 use tracing::{error, log::warn};
 
-use crate::{service::pdu::PduBuilder, services, Error, Result, Ruma, RumaResponse};
+use crate::{
+	service::{self, pdu::PduBuilder},
+	services,
+	utils::server_name::server_is_ours,
+	Error, Result, Ruma, RumaResponse,
+};
 
-/// # `PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}`
+/// # `PUT /_matrix/client/*/rooms/{roomId}/state/{eventType}/{stateKey}`
 ///
 /// Sends a state event into the room.
 ///
 /// - The only requirement for the content is that it has to be valid json
 /// - Tries to send the event into the room, auth rules will determine if it is
 ///   allowed
-/// - If event is new canonical_alias: Rejects if alias is incorrect
-pub async fn send_state_event_for_key_route(
+/// - If event is new `canonical_alias`: Rejects if alias is incorrect
+pub(crate) async fn send_state_event_for_key_route(
 	body: Ruma<send_state_event::v3::Request>,
 ) -> Result<send_state_event::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
@@ -30,7 +42,7 @@ pub async fn send_state_event_for_key_route(
 		sender_user,
 		&body.room_id,
 		&body.event_type,
-		&body.body.body, // Yes, I hate it too
+		&body.body.body,
 		body.state_key.clone(),
 	)
 	.await?;
@@ -41,54 +53,38 @@ pub async fn send_state_event_for_key_route(
 	})
 }
 
-/// # `PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}`
+/// # `PUT /_matrix/client/*/rooms/{roomId}/state/{eventType}`
 ///
 /// Sends a state event into the room.
 ///
 /// - The only requirement for the content is that it has to be valid json
 /// - Tries to send the event into the room, auth rules will determine if it is
 ///   allowed
-/// - If event is new canonical_alias: Rejects if alias is incorrect
-pub async fn send_state_event_for_empty_key_route(
+/// - If event is new `canonical_alias`: Rejects if alias is incorrect
+pub(crate) async fn send_state_event_for_empty_key_route(
 	body: Ruma<send_state_event::v3::Request>,
 ) -> Result<RumaResponse<send_state_event::v3::Response>> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	// Forbid m.room.encryption if encryption is disabled
-	if body.event_type == StateEventType::RoomEncryption && !services().globals.allow_encryption() {
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "Encryption has been disabled"));
-	}
-
-	let event_id = send_state_event_for_key_helper(
-		sender_user,
-		&body.room_id,
-		&body.event_type.to_string().into(),
-		&body.body.body,
-		body.state_key.clone(),
-	)
-	.await?;
-
-	let event_id = (*event_id).to_owned();
-	Ok(send_state_event::v3::Response {
-		event_id,
-	}
-	.into())
+	send_state_event_for_key_route(body).await.map(RumaResponse)
 }
 
-/// # `GET /_matrix/client/r0/rooms/{roomid}/state`
+/// # `GET /_matrix/client/v3/rooms/{roomid}/state`
 ///
 /// Get all state events for a room.
 ///
 /// - If not joined: Only works if current room history visibility is world
 ///   readable
-pub async fn get_state_events_route(
+pub(crate) async fn get_state_events_route(
 	body: Ruma<get_state_events::v3::Request>,
 ) -> Result<get_state_events::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().rooms.state_accessor.user_can_see_state_events(sender_user, &body.room_id)? {
+	if !services()
+		.rooms
+		.state_accessor
+		.user_can_see_state_events(sender_user, &body.room_id)?
+	{
 		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
+			ErrorKind::forbidden(),
 			"You don't have permission to view the room state.",
 		));
 	}
@@ -113,26 +109,35 @@ pub async fn get_state_events_route(
 ///
 /// - If not joined: Only works if current room history visibility is world
 ///   readable
-pub async fn get_state_events_for_key_route(
+pub(crate) async fn get_state_events_for_key_route(
 	body: Ruma<get_state_events_for_key::v3::Request>,
 ) -> Result<get_state_events_for_key::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().rooms.state_accessor.user_can_see_state_events(sender_user, &body.room_id)? {
+	if !services()
+		.rooms
+		.state_accessor
+		.user_can_see_state_events(sender_user, &body.room_id)?
+	{
 		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
+			ErrorKind::forbidden(),
 			"You don't have permission to view the room state.",
 		));
 	}
 
-	let event =
-		services().rooms.state_accessor.room_state_get(&body.room_id, &body.event_type, &body.state_key)?.ok_or_else(
-			|| {
-				warn!("State event {:?} not found in room {:?}", &body.event_type, &body.room_id);
-				Error::BadRequest(ErrorKind::NotFound, "State event not found.")
-			},
-		)?;
-	if body.format.as_ref().is_some_and(|f| f.to_lowercase().eq("event")) {
+	let event = services()
+		.rooms
+		.state_accessor
+		.room_state_get(&body.room_id, &body.event_type, &body.state_key)?
+		.ok_or_else(|| {
+			warn!("State event {:?} not found in room {:?}", &body.event_type, &body.room_id);
+			Error::BadRequest(ErrorKind::NotFound, "State event not found.")
+		})?;
+	if body
+		.format
+		.as_ref()
+		.is_some_and(|f| f.to_lowercase().eq("event"))
+	{
 		Ok(get_state_events_for_key::v3::Response {
 			content: None,
 			event: serde_json::from_str(event.to_state_event().json().get()).map_err(|e| {
@@ -159,78 +164,26 @@ pub async fn get_state_events_for_key_route(
 ///
 /// - If not joined: Only works if current room history visibility is world
 ///   readable
-pub async fn get_state_events_for_empty_key_route(
+pub(crate) async fn get_state_events_for_empty_key_route(
 	body: Ruma<get_state_events_for_key::v3::Request>,
 ) -> Result<RumaResponse<get_state_events_for_key::v3::Response>> {
-	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
-
-	if !services().rooms.state_accessor.user_can_see_state_events(sender_user, &body.room_id)? {
-		return Err(Error::BadRequest(
-			ErrorKind::Forbidden,
-			"You don't have permission to view the room state.",
-		));
-	}
-
-	let event =
-		services().rooms.state_accessor.room_state_get(&body.room_id, &body.event_type, "")?.ok_or_else(|| {
-			warn!("State event {:?} not found in room {:?}", &body.event_type, &body.room_id);
-			Error::BadRequest(ErrorKind::NotFound, "State event not found.")
-		})?;
-
-	if body.format.as_ref().is_some_and(|f| f.to_lowercase().eq("event")) {
-		Ok(get_state_events_for_key::v3::Response {
-			content: None,
-			event: serde_json::from_str(event.to_state_event().json().get()).map_err(|e| {
-				error!("Invalid room state event in database: {}", e);
-				Error::bad_database("Invalid room state event in database")
-			})?,
-		}
-		.into())
-	} else {
-		Ok(get_state_events_for_key::v3::Response {
-			content: Some(serde_json::from_str(event.content.get()).map_err(|e| {
-				error!("Invalid room state event content in database: {}", e);
-				Error::bad_database("Invalid room state event content in database")
-			})?),
-			event: None,
-		}
-		.into())
-	}
+	get_state_events_for_key_route(body).await.map(RumaResponse)
 }
 
 async fn send_state_event_for_key_helper(
 	sender: &UserId, room_id: &RoomId, event_type: &StateEventType, json: &Raw<AnyStateEventContent>, state_key: String,
 ) -> Result<Arc<EventId>> {
-	let sender_user = sender;
+	allowed_to_send_state_event(room_id, event_type, json).await?;
 
-	// TODO: Review this check, error if event is unparsable, use event type, allow
-	// alias if it previously existed
-	if let Ok(canonical_alias) = serde_json::from_str::<RoomCanonicalAliasEventContent>(json.json().get()) {
-		let mut aliases = canonical_alias.alt_aliases.clone();
-
-		if let Some(alias) = canonical_alias.alias {
-			aliases.push(alias);
-		}
-
-		for alias in aliases {
-			if alias.server_name() != services().globals.server_name()
-				|| services()
-					.rooms
-					.alias
-					.resolve_local_alias(&alias)?
-					.filter(|room| room == room_id) // Make sure it's the right room
-					.is_none()
-			{
-				return Err(Error::BadRequest(
-					ErrorKind::Forbidden,
-					"You are only allowed to send canonical_alias events when it's aliases already exists",
-				));
-			}
-		}
-	}
-
-	let mutex_state =
-		Arc::clone(services().globals.roomid_mutex_state.write().await.entry(room_id.to_owned()).or_default());
+	let mutex_state = Arc::clone(
+		services()
+			.globals
+			.roomid_mutex_state
+			.write()
+			.await
+			.entry(room_id.to_owned())
+			.or_default(),
+	);
 	let state_lock = mutex_state.lock().await;
 
 	let event_id = services()
@@ -244,7 +197,7 @@ async fn send_state_event_for_key_helper(
 				state_key: Some(state_key),
 				redacts: None,
 			},
-			sender_user,
+			sender,
 			room_id,
 			&state_lock,
 		)
@@ -252,3 +205,76 @@ async fn send_state_event_for_key_helper(
 
 	Ok(event_id)
 }
+
+async fn allowed_to_send_state_event(
+	room_id: &RoomId, event_type: &StateEventType, json: &Raw<AnyStateEventContent>,
+) -> Result<()> {
+	match event_type {
+		// Forbid m.room.encryption if encryption is disabled
+		StateEventType::RoomEncryption => {
+			if !services().globals.allow_encryption() {
+				return Err(Error::BadRequest(ErrorKind::forbidden(), "Encryption has been disabled"));
+			}
+		},
+		// admin room is a sensitive room, it should not ever be made public
+		StateEventType::RoomJoinRules => {
+			if let Some(admin_room_id) = service::admin::Service::get_admin_room().await? {
+				if admin_room_id == room_id {
+					if let Ok(join_rule) = serde_json::from_str::<RoomJoinRulesEventContent>(json.json().get()) {
+						if join_rule.join_rule == JoinRule::Public {
+							return Err(Error::BadRequest(
+								ErrorKind::forbidden(),
+								"Admin room is not allowed to be public.",
+							));
+						}
+					}
+				}
+			}
+		},
+		// admin room is a sensitive room, it should not ever be made world readable
+		StateEventType::RoomHistoryVisibility => {
+			if let Some(admin_room_id) = service::admin::Service::get_admin_room().await? {
+				if admin_room_id == room_id {
+					if let Ok(visibility_content) =
+						serde_json::from_str::<RoomHistoryVisibilityEventContent>(json.json().get())
+					{
+						if visibility_content.history_visibility == HistoryVisibility::WorldReadable {
+							return Err(Error::BadRequest(
+								ErrorKind::forbidden(),
+								"Admin room is not allowed to be made world readable (public room history).",
+							));
+						}
+					}
+				}
+			}
+		},
+		// TODO: allow alias if it previously existed
+		StateEventType::RoomCanonicalAlias => {
+			if let Ok(canonical_alias) = serde_json::from_str::<RoomCanonicalAliasEventContent>(json.json().get()) {
+				let mut aliases = canonical_alias.alt_aliases.clone();
+
+				if let Some(alias) = canonical_alias.alias {
+					aliases.push(alias);
+				}
+
+				for alias in aliases {
+					if !server_is_ours(alias.server_name())
+						|| services()
+                           .rooms
+                           .alias
+                           .resolve_local_alias(&alias)?
+                           .filter(|room| room == room_id) // Make sure it's the right room
+                           .is_none()
+					{
+						return Err(Error::BadRequest(
+							ErrorKind::forbidden(),
+							"You are only allowed to send canonical_alias events when its aliases already exist",
+						));
+					}
+				}
+			}
+		},
+		_ => (),
+	}
+	Ok(())
+}

src/api/client_server/tag.rs

@@ -15,22 +15,28 @@ use crate::{services, Error, Result, Ruma};
 /// Adds a tag to the room.
 ///
 /// - Inserts the tag into the tag event of the room account data.
-pub async fn update_tag_route(body: Ruma<create_tag::v3::Request>) -> Result<create_tag::v3::Response> {
+pub(crate) async fn update_tag_route(body: Ruma<create_tag::v3::Request>) -> Result<create_tag::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let event = services().account_data.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
+	let event = services()
+		.account_data
+		.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
 
-	let mut tags_event = event
-		.map(|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")))
-		.unwrap_or_else(|| {
+	let mut tags_event = event.map_or_else(
+		|| {
 			Ok(TagEvent {
 				content: TagEventContent {
 					tags: BTreeMap::new(),
 				},
 			})
-		})?;
+		},
+		|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")),
+	)?;
 
-	tags_event.content.tags.insert(body.tag.clone().into(), body.tag_info.clone());
+	tags_event
+		.content
+		.tags
+		.insert(body.tag.clone().into(), body.tag_info.clone());
 
 	services().account_data.update(
 		Some(&body.room_id),
@@ -47,20 +53,23 @@ pub async fn update_tag_route(body: Ruma<create_tag::v3::Request>) -> Result<cre
 /// Deletes a tag from the room.
 ///
 /// - Removes the tag from the tag event of the room account data.
-pub async fn delete_tag_route(body: Ruma<delete_tag::v3::Request>) -> Result<delete_tag::v3::Response> {
+pub(crate) async fn delete_tag_route(body: Ruma<delete_tag::v3::Request>) -> Result<delete_tag::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let event = services().account_data.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
+	let event = services()
+		.account_data
+		.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
 
-	let mut tags_event = event
-		.map(|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")))
-		.unwrap_or_else(|| {
+	let mut tags_event = event.map_or_else(
+		|| {
 			Ok(TagEvent {
 				content: TagEventContent {
 					tags: BTreeMap::new(),
 				},
 			})
-		})?;
+		},
+		|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")),
+	)?;
 
 	tags_event.content.tags.remove(&body.tag.clone().into());
 
@@ -79,20 +88,23 @@ pub async fn delete_tag_route(body: Ruma<delete_tag::v3::Request>) -> Result<del
 /// Returns tags on the room.
 ///
 /// - Gets the tag event of the room account data.
-pub async fn get_tags_route(body: Ruma<get_tags::v3::Request>) -> Result<get_tags::v3::Response> {
+pub(crate) async fn get_tags_route(body: Ruma<get_tags::v3::Request>) -> Result<get_tags::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	let event = services().account_data.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
+	let event = services()
+		.account_data
+		.get(Some(&body.room_id), sender_user, RoomAccountDataEventType::Tag)?;
 
-	let tags_event = event
-		.map(|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")))
-		.unwrap_or_else(|| {
+	let tags_event = event.map_or_else(
+		|| {
 			Ok(TagEvent {
 				content: TagEventContent {
 					tags: BTreeMap::new(),
 				},
 			})
-		})?;
+		},
+		|e| serde_json::from_str(e.get()).map_err(|_| Error::bad_database("Invalid account data event in db.")),
+	)?;
 
 	Ok(get_tags::v3::Response {
 		tags: tags_event.content.tags,

src/api/client_server/thirdparty.rs

@@ -7,7 +7,9 @@ use crate::{Result, Ruma};
 /// # `GET /_matrix/client/r0/thirdparty/protocols`
 ///
 /// TODO: Fetches all metadata about protocols supported by the homeserver.
-pub async fn get_protocols_route(_body: Ruma<get_protocols::v3::Request>) -> Result<get_protocols::v3::Response> {
+pub(crate) async fn get_protocols_route(
+	_body: Ruma<get_protocols::v3::Request>,
+) -> Result<get_protocols::v3::Response> {
 	// TODO
 	Ok(get_protocols::v3::Response {
 		protocols: BTreeMap::new(),

src/api/client_server/threads.rs

@@ -3,14 +3,19 @@ use ruma::api::client::{error::ErrorKind, threads::get_threads};
 use crate::{services, Error, Result, Ruma};
 
 /// # `GET /_matrix/client/r0/rooms/{roomId}/threads`
-pub async fn get_threads_route(body: Ruma<get_threads::v1::Request>) -> Result<get_threads::v1::Response> {
+pub(crate) async fn get_threads_route(body: Ruma<get_threads::v1::Request>) -> Result<get_threads::v1::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
 	// Use limit or else 10, with maximum 100
-	let limit = body.limit.and_then(|l| l.try_into().ok()).unwrap_or(10).min(100);
+	let limit = body
+		.limit
+		.and_then(|l| l.try_into().ok())
+		.unwrap_or(10)
+		.min(100);
 
 	let from = if let Some(from) = &body.from {
-		from.parse().map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, ""))?
+		from.parse()
+			.map_err(|_| Error::BadRequest(ErrorKind::InvalidParam, ""))?
 	} else {
 		u64::MAX
 	};
@@ -20,7 +25,7 @@ pub async fn get_threads_route(body: Ruma<get_threads::v1::Request>) -> Result<g
 		.threads
 		.threads_until(sender_user, &body.room_id, from, &body.include)?
 		.take(limit)
-		.filter_map(std::result::Result::ok)
+		.filter_map(Result::ok)
 		.filter(|(_, pdu)| {
 			services()
 				.rooms
@@ -33,7 +38,10 @@ pub async fn get_threads_route(body: Ruma<get_threads::v1::Request>) -> Result<g
 	let next_batch = threads.last().map(|(count, _)| count.to_string());
 
 	Ok(get_threads::v1::Response {
-		chunk: threads.into_iter().map(|(_, pdu)| pdu.to_room_event()).collect(),
+		chunk: threads
+			.into_iter()
+			.map(|(_, pdu)| pdu.to_room_event())
+			.collect(),
 		next_batch,
 	})
 }

src/api/client_server/to_device.rs

@@ -8,32 +8,36 @@ use ruma::{
 	to_device::DeviceIdOrAllDevices,
 };
 
-use crate::{services, Error, Result, Ruma};
+use crate::{services, utils::user_id::user_is_local, Error, Result, Ruma};
 
 /// # `PUT /_matrix/client/r0/sendToDevice/{eventType}/{txnId}`
 ///
 /// Send a to-device event to a set of client devices.
-pub async fn send_event_to_device_route(
+pub(crate) async fn send_event_to_device_route(
 	body: Ruma<send_event_to_device::v3::Request>,
 ) -> Result<send_event_to_device::v3::Response> {
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 	let sender_device = body.sender_device.as_deref();
 
 	// Check if this is a new transaction id
-	if services().transaction_ids.existing_txnid(sender_user, sender_device, &body.txn_id)?.is_some() {
+	if services()
+		.transaction_ids
+		.existing_txnid(sender_user, sender_device, &body.txn_id)?
+		.is_some()
+	{
 		return Ok(send_event_to_device::v3::Response {});
 	}
 
 	for (target_user_id, map) in &body.messages {
 		for (target_device_id_maybe, event) in map {
-			if target_user_id.server_name() != services().globals.server_name() {
+			if !user_is_local(target_user_id) {
 				let mut map = BTreeMap::new();
 				map.insert(target_device_id_maybe.clone(), event.clone());
 				let mut messages = BTreeMap::new();
 				messages.insert(target_user_id.clone(), map);
 				let count = services().globals.next_count()?;
 
-				services().sending.send_reliable_edu(
+				services().sending.send_edu_server(
 					target_user_id.server_name(),
 					serde_json::to_vec(&federation::transactions::edu::Edu::DirectToDevice(DirectDeviceContent {
 						sender: sender_user.clone(),
@@ -42,7 +46,6 @@ pub async fn send_event_to_device_route(
 						messages,
 					}))
 					.expect("DirectToDevice EDU can be serialized"),
-					count,
 				)?;
 
 				continue;
@@ -79,7 +82,9 @@ pub async fn send_event_to_device_route(
 	}
 
 	// Save transaction id with empty data
-	services().transaction_ids.add_txnid(sender_user, sender_device, &body.txn_id, &[])?;
+	services()
+		.transaction_ids
+		.add_txnid(sender_user, sender_device, &body.txn_id, &[])?;
 
 	Ok(send_event_to_device::v3::Response {})
 }

src/api/client_server/typing.rs

@@ -5,30 +5,38 @@ use crate::{services, utils, Error, Result, Ruma};
 /// # `PUT /_matrix/client/r0/rooms/{roomId}/typing/{userId}`
 ///
 /// Sets the typing state of the sender user.
-pub async fn create_typing_event_route(
+pub(crate) async fn create_typing_event_route(
 	body: Ruma<create_typing_event::v3::Request>,
 ) -> Result<create_typing_event::v3::Response> {
 	use create_typing_event::v3::Typing;
 
 	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
 
-	if !services().rooms.state_cache.is_joined(sender_user, &body.room_id)? {
-		return Err(Error::BadRequest(ErrorKind::Forbidden, "You are not in this room."));
+	if !services()
+		.rooms
+		.state_cache
+		.is_joined(sender_user, &body.room_id)?
+	{
+		return Err(Error::BadRequest(ErrorKind::forbidden(), "You are not in this room."));
 	}
 
 	if let Typing::Yes(duration) = body.state {
+		let duration = utils::clamp(
+			duration.as_millis() as u64,
+			services().globals.config.typing_client_timeout_min_s * 1000,
+			services().globals.config.typing_client_timeout_max_s * 1000,
+		);
 		services()
 			.rooms
-			.edus
 			.typing
-			.typing_add(
-				sender_user,
-				&body.room_id,
-				duration.as_millis() as u64 + utils::millis_since_unix_epoch(),
-			)
+			.typing_add(sender_user, &body.room_id, utils::millis_since_unix_epoch() + duration)
 			.await?;
 	} else {
-		services().rooms.edus.typing.typing_remove(sender_user, &body.room_id).await?;
+		services()
+			.rooms
+			.typing
+			.typing_remove(sender_user, &body.room_id)
+			.await?;
 	}
 
 	Ok(create_typing_event::v3::Response {})

src/api/client_server/unstable.rs

@@ -0,0 +1,45 @@
+use ruma::{
+	api::client::{error::ErrorKind, membership::mutual_rooms},
+	OwnedRoomId,
+};
+
+use crate::{services, Error, Result, Ruma};
+
+/// # `GET /_matrix/client/unstable/uk.half-shot.msc2666/user/mutual_rooms`
+///
+/// Gets all the rooms the sender shares with the specified user.
+///
+/// TODO: Implement pagination, currently this just returns everything
+///
+/// An implementation of [MSC2666](https://github.com/matrix-org/matrix-spec-proposals/pull/2666)
+pub(crate) async fn get_mutual_rooms_route(
+	body: Ruma<mutual_rooms::unstable::Request>,
+) -> Result<mutual_rooms::unstable::Response> {
+	let sender_user = body.sender_user.as_ref().expect("user is authenticated");
+
+	if sender_user == &body.user_id {
+		return Err(Error::BadRequest(
+			ErrorKind::Unknown,
+			"You cannot request rooms in common with yourself.",
+		));
+	}
+
+	if !services().users.exists(&body.user_id)? {
+		return Ok(mutual_rooms::unstable::Response {
+			joined: vec![],
+			next_batch_token: None,
+		});
+	}
+
+	let mutual_rooms: Vec<OwnedRoomId> = services()
+		.rooms
+		.user
+		.get_shared_rooms(vec![sender_user.clone(), body.user_id.clone()])?
+		.filter_map(Result::ok)
+		.collect();
+
+	Ok(mutual_rooms::unstable::Response {
+		joined: mutual_rooms,
+		next_batch_token: None,
+	})
+}

src/api/client_server/unversioned.rs

@@ -1,9 +1,16 @@
 use std::collections::BTreeMap;
 
 use axum::{response::IntoResponse, Json};
-use ruma::api::client::{discovery::get_supported_versions, error::ErrorKind};
+use ruma::api::client::{
+	discovery::{
+		discover_homeserver::{self, HomeserverInfo, SlidingSyncProxyInfo},
+		discover_support::{self, Contact},
+		get_supported_versions,
+	},
+	error::ErrorKind,
+};
 
-use crate::{services, Error, Result, Ruma};
+use crate::{services, utils::conduwuit_version, Error, Result, Ruma};
 
 /// # `GET /_matrix/client/versions`
 ///
@@ -17,7 +24,7 @@ use crate::{services, Error, Result, Ruma};
 ///
 /// Note: Unstable features are used while developing new features. Clients
 /// should avoid using unstable features in their stable releases
-pub async fn get_supported_versions_route(
+pub(crate) async fn get_supported_versions_route(
 	_body: Ruma<get_supported_versions::Request>,
 ) -> Result<get_supported_versions::Response> {
 	let resp = get_supported_versions::Response {
@@ -38,9 +45,12 @@ pub async fn get_supported_versions_route(
 		],
 		unstable_features: BTreeMap::from_iter([
 			("org.matrix.e2e_cross_signing".to_owned(), true),
+			("org.matrix.msc2285.stable".to_owned(), true),
+			("uk.half-shot.msc2666.query_mutual_rooms".to_owned(), true),
 			("org.matrix.msc2836".to_owned(), true),
-			("org.matrix.msc3827".to_owned(), true),
 			("org.matrix.msc2946".to_owned(), true),
+			("org.matrix.msc3026.busy_presence".to_owned(), true),
+			("org.matrix.msc3827".to_owned(), true),
 		]),
 	};
 
@@ -48,33 +58,103 @@ pub async fn get_supported_versions_route(
 }
 
 /// # `GET /.well-known/matrix/client`
-pub async fn well_known_client_route() -> Result<impl IntoResponse> {
+///
+/// Returns the .well-known URL if it is configured, otherwise returns 404.
+pub(crate) async fn well_known_client(
+	_body: Ruma<discover_homeserver::Request>,
+) -> Result<discover_homeserver::Response> {
 	let client_url = match services().globals.well_known_client() {
-		Some(url) => url.clone(),
+		Some(url) => url.to_string(),
 		None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
 	};
 
-	Ok(Json(serde_json::json!({
-		"m.homeserver": {"base_url": client_url},
-		"org.matrix.msc3575.proxy": {"url": client_url}
-	})))
+	Ok(discover_homeserver::Response {
+		homeserver: HomeserverInfo {
+			base_url: client_url.clone(),
+		},
+		identity_server: None,
+		sliding_sync_proxy: Some(SlidingSyncProxyInfo {
+			url: client_url,
+		}),
+		tile_server: None,
+	})
+}
+
+/// # `GET /.well-known/matrix/support`
+///
+/// Server support contact and support page of a homeserver's domain.
+pub(crate) async fn well_known_support(_body: Ruma<discover_support::Request>) -> Result<discover_support::Response> {
+	let support_page = services()
+		.globals
+		.well_known_support_page()
+		.as_ref()
+		.map(ToString::to_string);
+
+	let role = services().globals.well_known_support_role().clone();
+
+	// support page or role must be either defined for this to be valid
+	if support_page.is_none() && role.is_none() {
+		return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
+	}
+
+	let email_address = services().globals.well_known_support_email().clone();
+	let matrix_id = services().globals.well_known_support_mxid().clone();
+
+	// if a role is specified, an email address or matrix id is required
+	if role.is_some() && (email_address.is_none() && matrix_id.is_none()) {
+		return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
+	}
+
+	// TOOD: support defining multiple contacts in the config
+	let mut contacts: Vec<Contact> = vec![];
+
+	if let Some(role) = role {
+		let contact = Contact {
+			role,
+			email_address,
+			matrix_id,
+		};
+
+		contacts.push(contact);
+	}
+
+	// support page or role+contacts must be either defined for this to be valid
+	if contacts.is_empty() && support_page.is_none() {
+		return Err(Error::BadRequest(ErrorKind::NotFound, "Not found."));
+	}
+
+	Ok(discover_support::Response {
+		contacts,
+		support_page,
+	})
 }
 
 /// # `GET /client/server.json`
 ///
 /// Endpoint provided by sliding sync proxy used by some clients such as Element
 /// Web as a non-standard health check.
-pub async fn syncv3_client_server_json() -> Result<impl IntoResponse> {
+pub(crate) async fn syncv3_client_server_json() -> Result<impl IntoResponse> {
 	let server_url = match services().globals.well_known_client() {
-		Some(url) => url.clone(),
+		Some(url) => url.to_string(),
 		None => match services().globals.well_known_server() {
-			Some(url) => url.clone(),
+			Some(url) => url.to_string(),
 			None => return Err(Error::BadRequest(ErrorKind::NotFound, "Not found.")),
 		},
 	};
 
 	Ok(Json(serde_json::json!({
 		"server": server_url,
-		"version": format!("{} {}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"))
+		"version": conduwuit_version(),
+	})))
+}
+
+/// # `GET /_conduwuit/server_version`
+///
+/// Conduwuit-specific API to get the server version, results akin to
+/// `/_matrix/federation/v1/version`
+pub(crate) async fn conduwuit_server_version() -> Result<impl IntoResponse> {
+	Ok(Json(serde_json::json!({
+		"name": "Conduwuit",
+		"version": conduwuit_version(),
 	})))
 }