Merge branch 'master' into webhooks

crates/quark/.github/FUNDING.yml

@@ -1,2 +0,0 @@
-ko_fi: insertish
-custom: https://insrt.uk/donate

crates/quark/.github/workflows/rust.yaml

@@ -1,33 +0,0 @@
-name: Rust build and test
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-env:
-  CARGO_TERM_COLOR: always
-
-jobs:
-  check:
-    name: Rust project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Install latest nightly
-        uses: actions-rs/toolchain@v1
-        with:
-            toolchain: nightly
-            override: true
-            components: rustfmt, clippy
-
-      - name: Run cargo build
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-      
-      - name: Run cargo test
-        uses: actions-rs/cargo@v1
-        with:
-          command: test

crates/quark/.github/workflows/triage_issue.yml

@@ -1,49 +0,0 @@
-name: Add Issue to Board
-
-on:
-  issues:
-    types: [opened]
-
-jobs:
-  track_issue:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get project data
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-        run: |
-          gh api graphql -f query='
-            query {
-              organization(login: "revoltchat"){
-                projectNext(number: 3) {
-                  id
-                  fields(first:20) {
-                    nodes {
-                      id
-                      name
-                      settings
-                    }
-                  }
-                }
-              }
-            }' > project_data.json
-
-          echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV
-          echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV
-          echo 'TODO_OPTION_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") |.settings | fromjson.options[] | select(.name=="Todo") |.id' project_data.json) >> $GITHUB_ENV
-
-      - name: Add issue to project
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-          ISSUE_ID: ${{ github.event.issue.node_id }}
-        run: |
-          item_id="$( gh api graphql -f query='
-            mutation($project:ID!, $issue:ID!) {
-              addProjectNextItem(input: {projectId: $project, contentId: $issue}) {
-                projectNextItem {
-                  id
-                }
-              }
-            }' -f project=$PROJECT_ID -f issue=$ISSUE_ID --jq '.data.addProjectNextItem.projectNextItem.id')"
-          
-          echo 'ITEM_ID='$item_id >> $GITHUB_ENV

crates/quark/.github/workflows/triage_pr.yml

@@ -1,72 +0,0 @@
-name: Add PR to Board
-
-on:
-  pull_request_target:
-    types: [opened, synchronize, ready_for_review, review_requested]
-
-jobs:
-  track_pr:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Get project data
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-        run: |
-          gh api graphql -f query='
-            query {
-              organization(login: "revoltchat"){
-                projectNext(number: 3) {
-                  id
-                  fields(first:20) {
-                    nodes {
-                      id
-                      name
-                      settings
-                    }
-                  }
-                }
-              }
-            }' > project_data.json
-
-          echo 'PROJECT_ID='$(jq '.data.organization.projectNext.id' project_data.json) >> $GITHUB_ENV
-          echo 'STATUS_FIELD_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") | .id' project_data.json) >> $GITHUB_ENV
-          echo 'INCOMING_OPTION_ID='$(jq '.data.organization.projectNext.fields.nodes[] | select(.name== "Status") |.settings | fromjson.options[] | select(.name=="Incoming PRs") |.id' project_data.json) >> $GITHUB_ENV
-
-      - name: Add PR to project
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-          PR_ID: ${{ github.event.pull_request.node_id }}
-        run: |
-          item_id="$( gh api graphql -f query='
-            mutation($project:ID!, $pr:ID!) {
-              addProjectNextItem(input: {projectId: $project, contentId: $pr}) {
-                projectNextItem {
-                  id
-                }
-              }
-            }' -f project=$PROJECT_ID -f pr=$PR_ID --jq '.data.addProjectNextItem.projectNextItem.id')"
-          
-          echo 'ITEM_ID='$item_id >> $GITHUB_ENV
-
-      - name: Set fields
-        env:
-          GITHUB_TOKEN: ${{ secrets.PAT }}
-        run: |
-          gh api graphql -f query='
-            mutation (
-              $project: ID!
-              $item: ID!
-              $status_field: ID!
-              $status_value: String!
-            ) {
-              set_status: updateProjectNextItemField(input: {
-                projectId: $project
-                itemId: $item
-                fieldId: $status_field
-                value: $status_value
-              }) {
-                projectNextItem {
-                  id
-                  }
-              }
-            }' -f project=$PROJECT_ID -f item=$ITEM_ID -f status_field=$STATUS_FIELD_ID -f status_value=${{ env.INCOMING_OPTION_ID }} --silent

crates/quark/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "revolt-quark"
-version = "0.5.6"
+version = "0.5.9"
 license = "AGPL-3.0-or-later"
 edition = "2021"
 
@@ -16,9 +16,9 @@ rocket_impl = [
     "lru",
     "dashmap",
 
-    "rauth/database-mongodb",
-    "rauth/rocket_impl",
-    "rauth/okapi_impl"
+    "authifier/database-mongodb",
+    "authifier/rocket_impl",
+    "authifier/okapi_impl"
 ]
 
 test = [ "async-std", "mongo", "mongodb/async-std-runtime", "rocket_impl" ]
@@ -84,8 +84,8 @@ rocket = { optional = true, version = "0.5.0-rc.2", default-features = false, fe
 rocket_empty = { version = "0.1.1", optional = true, features = [ "schema" ] }
 rocket_cors = { optional = true, git = "https://github.com/lawliet89/rocket_cors", rev = "c17e8145baa4790319fdb6a473e465b960f55e7c" }
 
-# rAuth
-rauth = { git = "https://github.com/insertish/rauth", tag = "1.0.4", features = [ "async-std-runtime" ] }
+# Authifier
+authifier = { version = "1.0.7", features = [ "async-std-runtime" ] }
 
 # Sentry
 sentry = "0.25.0"

crates/quark/src/database.rs

@@ -61,13 +61,13 @@ impl Deref for Database {
     }
 }
 
-impl From<Database> for rauth::Database {
+impl From<Database> for authifier::Database {
     fn from(val: Database) -> Self {
         match val {
-            Database::Dummy(_) => rauth::Database::default(),
-            Database::MongoDb(MongoDb(client)) => {
-                rauth::Database::MongoDb(rauth::database::MongoDb(client.database("revolt")))
-            }
+            Database::Dummy(_) => authifier::Database::default(),
+            Database::MongoDb(MongoDb(client)) => authifier::Database::MongoDb(
+                authifier::database::MongoDb(client.database("revolt")),
+            ),
         }
     }
 }

crates/quark/src/events/client.rs

@@ -1,4 +1,4 @@
-use rauth::RAuthEvent;
+use authifier::AuthifierEvent;
 use serde::{Deserialize, Serialize};
 
 use crate::models::channel::{FieldsChannel, PartialChannel};
@@ -7,7 +7,7 @@ use crate::models::message::{AppendMessage, PartialMessage};
 use crate::models::server::{FieldsRole, FieldsServer, PartialRole, PartialServer};
 use crate::models::server_member::{FieldsMember, MemberCompositeKey, PartialMember};
 use crate::models::user::{FieldsUser, PartialUser, RelationshipStatus};
-use crate::models::{Channel, Emoji, Member, Message, Server, User, UserSettings, Webhook};
+use crate::models::{Channel, Emoji, Member, Message, Server, User, UserSettings, Webhook, Report};
 use crate::Error;
 
 /// WebSocket Client Errors
@@ -229,6 +229,9 @@ pub enum EventV1 {
         id: String
     },
 
+    /// New report
+    ReportCreate(Report),
+
     /// Auth events
-    Auth(RAuthEvent),
+    Auth(AuthifierEvent),
 }

crates/quark/src/impl/dummy/mod.rs

@@ -29,6 +29,11 @@ pub mod users {
     pub mod user_settings;
 }
 
+pub mod safety {
+    pub mod report;
+    pub mod snapshot;
+}
+
 #[derive(Debug, Clone)]
 pub struct DummyDb;
 

crates/quark/src/impl/dummy/safety/report.rs

@@ -0,0 +1,12 @@
+use crate::models::Report;
+use crate::{AbstractReport, Result};
+
+use super::super::DummyDb;
+
+#[async_trait]
+impl AbstractReport for DummyDb {
+    async fn insert_report(&self, report: &Report) -> Result<()> {
+        info!("Insert {:?}", report);
+        Ok(())
+    }
+}

crates/quark/src/impl/dummy/safety/snapshot.rs

@@ -0,0 +1,12 @@
+use crate::models::Snapshot;
+use crate::{AbstractSnapshot, Result};
+
+use super::super::DummyDb;
+
+#[async_trait]
+impl AbstractSnapshot for DummyDb {
+    async fn insert_snapshot(&self, snapshot: &Snapshot) -> Result<()> {
+        info!("Insert {:?}", snapshot);
+        Ok(())
+    }
+}

crates/quark/src/impl/mongo/admin/migrations/scripts.rs

@@ -215,7 +215,7 @@ pub async fn run_migrations(db: &MongoDb, revision: i32) -> i32 {
     }
 
     if revision <= 8 {
-        info!("Running migration [revision 8 / 2021-09-10]: Update to rAuth version 1.");
+        info!("Running migration [revision 8 / 2021-09-10]: Update to Authifier version 1.");
 
         db.db()
             .run_command(
@@ -603,20 +603,20 @@ pub async fn run_migrations(db: &MongoDb, revision: i32) -> i32 {
     }
 
     if revision <= 15 {
-        info!("Running migration [revision 15 / 04-06-2022]: Migrate rAuth to latest version.");
+        info!("Running migration [revision 15 / 04-06-2022]: Migrate Authifier to latest version.");
 
-        let db = rauth::Database::MongoDb(rauth::database::MongoDb(db.db()));
-        db.run_migration(rauth::Migration::M2022_06_03EnsureUpToSpec)
+        let db = authifier::Database::MongoDb(authifier::database::MongoDb(db.db()));
+        db.run_migration(authifier::Migration::M2022_06_03EnsureUpToSpec)
             .await
             .unwrap();
     }
 
     if revision <= 16 {
-        info!("Running migration [revision 16 / 07-07-2022]: Add `emojis` collection and rAuth migration.");
+        info!("Running migration [revision 16 / 07-07-2022]: Add `emojis` collection and Authifier migration.");
 
-        let rauth_db = rauth::Database::MongoDb(rauth::database::MongoDb(db.db()));
-        rauth_db
-            .run_migration(rauth::Migration::M2022_06_09AddIndexForDeletion)
+        let authifier_db = authifier::Database::MongoDb(authifier::database::MongoDb(db.db()));
+        authifier_db
+            .run_migration(authifier::Migration::M2022_06_09AddIndexForDeletion)
             .await
             .unwrap();
 

crates/quark/src/impl/mongo/mod.rs

@@ -40,6 +40,11 @@ pub mod users {
     pub mod user_settings;
 }
 
+pub mod safety {
+    pub mod report;
+    pub mod snapshot;
+}
+
 #[derive(Debug, Clone)]
 pub struct MongoDb(pub mongodb::Client);
 

crates/quark/src/impl/mongo/safety/report.rs

@@ -0,0 +1,13 @@
+use crate::models::Report;
+use crate::{AbstractReport, Result};
+
+use super::super::MongoDb;
+
+static COL: &str = "safety_reports";
+
+#[async_trait]
+impl AbstractReport for MongoDb {
+    async fn insert_report(&self, report: &Report) -> Result<()> {
+        self.insert_one(COL, report).await.map(|_| ())
+    }
+}

crates/quark/src/impl/mongo/safety/snapshot.rs

@@ -0,0 +1,13 @@
+use crate::models::Snapshot;
+use crate::{AbstractSnapshot, Result};
+
+use super::super::MongoDb;
+
+static COL: &str = "safety_snapshots";
+
+#[async_trait]
+impl AbstractSnapshot for MongoDb {
+    async fn insert_snapshot(&self, snapshot: &Snapshot) -> Result<()> {
+        self.insert_one(COL, snapshot).await.map(|_| ())
+    }
+}

crates/quark/src/impl/rocket.rs

@@ -1,4 +1,4 @@
-use rauth::models::Session;
+use authifier::models::Session;
 use revolt_okapi::openapi3::{SecurityScheme, SecuritySchemeData};
 use revolt_rocket_okapi::gen::OpenApiGenerator;
 use revolt_rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput};
@@ -12,7 +12,7 @@ use crate::Database;
 
 #[rocket::async_trait]
 impl<'r> FromRequest<'r> for User {
-    type Error = rauth::Error;
+    type Error = authifier::Error;
 
     async fn from_request(request: &'r Request<'_>) -> request::Outcome<Self, Self::Error> {
         let user: &Option<User> = request
@@ -43,7 +43,7 @@ impl<'r> FromRequest<'r> for User {
         if let Some(user) = user {
             Outcome::Success(user.clone())
         } else {
-            Outcome::Failure((Status::Unauthorized, rauth::Error::InvalidSession))
+            Outcome::Failure((Status::Unauthorized, authifier::Error::InvalidSession))
         }
     }
 }

crates/quark/src/lib.rs

@@ -17,8 +17,8 @@ extern crate bitfield;
 #[macro_use]
 extern crate bson;
 
+pub use authifier;
 pub use iso8601_timestamp::Timestamp;
-pub use rauth;
 pub use redis_kiss;
 
 pub mod events;

crates/quark/src/models/mod.rs

@@ -28,9 +28,15 @@ mod users {
     pub mod user_settings;
 }
 
+mod safety {
+    pub mod report;
+    pub mod snapshot;
+}
+
 pub use admin::*;
 pub use channels::*;
 pub use media::*;
+pub use safety::*;
 pub use servers::*;
 pub use users::*;
 
@@ -42,10 +48,12 @@ pub use channel_unread::ChannelUnread;
 pub use emoji::Emoji;
 pub use message::Message;
 pub use migrations::MigrationInfo;
+pub use report::Report;
 pub use server::Server;
 pub use server_ban::ServerBan;
 pub use server_member::Member;
 pub use simple::SimpleModel;
+pub use snapshot::Snapshot;
 pub use user::User;
 pub use user_settings::UserSettings;
 pub use webhook::Webhook;

crates/quark/src/models/safety/report.rs

@@ -0,0 +1,85 @@
+use serde::{Deserialize, Serialize};
+
+/// Reason for reporting content (message or server)
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub enum ContentReportReason {
+    /// No reason has been specified
+    NoneSpecified,
+
+    /// Blatantly illegal content
+    Illegal,
+
+    /// Content that promotes harm to others / self
+    PromotesHarm,
+
+    /// Spam or platform abuse
+    SpamAbuse,
+
+    /// Distribution of malware
+    Malware,
+
+    /// Harassment or abuse targeted at another user
+    Harassment,
+}
+
+/// Reason for reporting a user
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub enum UserReportReason {
+    /// No reason has been specified
+    NoneSpecified,
+
+    /// User is sending spam or otherwise abusing the platform
+    SpamAbuse,
+
+    /// User's profile contains inappropriate content for a general audience
+    InappropriateProfile,
+
+    /// User is impersonating another user
+    Impersonation,
+
+    /// User is evading a ban
+    BanEvasion,
+
+    /// User is not of minimum age to use the platform
+    Underage,
+}
+
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+#[serde(tag = "type")]
+pub enum ReportedContent {
+    /// Report a message
+    Message {
+        /// ID of the message
+        id: String,
+        /// Reason for reporting message
+        report_reason: ContentReportReason,
+    },
+    /// Report a server
+    Server {
+        /// ID of the server
+        id: String,
+        /// Reason for reporting server
+        report_reason: ContentReportReason,
+    },
+    /// Report a user
+    User {
+        /// ID of the user
+        id: String,
+        /// Reason for reporting a user
+        report_reason: UserReportReason,
+    },
+}
+
+/// User-generated platform moderation report.
+#[derive(Serialize, Deserialize, JsonSchema, Debug, Clone)]
+pub struct Report {
+    /// Unique Id
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// Id of the user creating this report
+    pub author_id: String,
+    /// Reported content
+    pub content: ReportedContent,
+    /// Additional report context
+    pub additional_context: String,
+}

crates/quark/src/models/safety/snapshot.rs

@@ -0,0 +1,37 @@
+use serde::{Deserialize, Serialize};
+
+use crate::models::{Message, Server, User};
+
+/// Enum to map into different models
+/// that can be saved in a snapshot
+#[derive(Serialize, Deserialize, JsonSchema, Debug)]
+#[serde(tag = "_type")]
+pub enum SnapshotContent {
+    Message {
+        /// Context before the message
+        #[serde(rename = "_prior_context")]
+        prior_context: Vec<Message>,
+
+        /// Context after the message
+        #[serde(rename = "_leading_context")]
+        leading_context: Vec<Message>,
+
+        /// Message
+        #[serde(flatten)]
+        message: Message,
+    },
+    Server(Server),
+    User(User),
+}
+
+/// Snapshot of some content
+#[derive(Serialize, Deserialize, JsonSchema, Debug)]
+pub struct Snapshot {
+    /// Unique Id
+    #[serde(rename = "_id")]
+    pub id: String,
+    /// Report parent Id
+    pub report_id: String,
+    /// Snapshot of content
+    pub content: SnapshotContent,
+}

crates/quark/src/tasks/web_push.rs

@@ -1,8 +1,8 @@
 use crate::bson::doc;
 use crate::util::variables::delta::VAPID_PRIVATE_KEY;
 
+use authifier::Database;
 use deadqueue::limited::Queue;
-use rauth::Database;
 use web_push::{
     ContentEncoding, SubscriptionInfo, SubscriptionKeys, VapidSignatureBuilder, WebPushClient,
     WebPushMessageBuilder,

crates/quark/src/traits/mod.rs

@@ -27,6 +27,11 @@ mod users {
     pub mod user_settings;
 }
 
+mod safety {
+    pub mod report;
+    pub mod snapshot;
+}
+
 pub use admin::migrations::AbstractMigrations;
 
 pub use media::attachment::AbstractAttachment;
@@ -46,6 +51,9 @@ pub use users::bot::AbstractBot;
 pub use users::user::AbstractUser;
 pub use users::user_settings::AbstractUserSettings;
 
+pub use safety::report::AbstractReport;
+pub use safety::snapshot::AbstractSnapshot;
+
 pub trait AbstractDatabase:
     Sync
     + Send
@@ -63,5 +71,7 @@ pub trait AbstractDatabase:
     + AbstractUser
     + AbstractUserSettings
     + AbstractWebhook
+    + AbstractReport
+    + AbstractSnapshot
 {
 }

crates/quark/src/traits/safety/report.rs

@@ -0,0 +1,8 @@
+use crate::models::Report;
+use crate::Result;
+
+#[async_trait]
+pub trait AbstractReport: Sync + Send {
+    /// Insert a new report into the database
+    async fn insert_report(&self, report: &Report) -> Result<()>;
+}

crates/quark/src/traits/safety/snapshot.rs

@@ -0,0 +1,8 @@
+use crate::models::Snapshot;
+use crate::Result;
+
+#[async_trait]
+pub trait AbstractSnapshot: Sync + Send {
+    /// Insert a new snapshot into the database
+    async fn insert_snapshot(&self, snapshot: &Snapshot) -> Result<()>;
+}

crates/quark/src/util/authifier.rs

@@ -1,9 +1,11 @@
+use authifier::config::{ResolveIp, Shield};
+
 use super::variables::delta::{
-    APP_URL, HCAPTCHA_KEY, INVITE_ONLY, SMTP_FROM, SMTP_HOST, SMTP_PASSWORD, SMTP_USERNAME,
-    USE_EMAIL, USE_HCAPTCHA,
+    APP_URL, AUTHIFIER_SHIELD_KEY, HCAPTCHA_KEY, INVITE_ONLY, SMTP_FROM, SMTP_HOST, SMTP_PASSWORD,
+    SMTP_USERNAME, USE_EMAIL, USE_HCAPTCHA,
 };
 
-use crate::rauth::config::{
+use crate::authifier::config::{
     Captcha, Config, EmailVerificationConfig, SMTPSettings, Template, Templates,
 };
 
@@ -59,5 +61,19 @@ pub fn config() -> Config {
         };
     }
 
+    if let Some(api_key) = &*AUTHIFIER_SHIELD_KEY {
+        config.shield = Shield::Enabled {
+            api_key: api_key.to_string(),
+            strict: false,
+        };
+    }
+
+    if std::env::var("TRUST_CLOUDFLARE")
+        .map(|x| x == "1")
+        .unwrap_or_default()
+    {
+        config.resolve_ip = ResolveIp::Cloudflare;
+    }
+
     config
 }

crates/quark/src/util/mod.rs

@@ -1,7 +1,7 @@
+pub mod authifier;
 pub mod log;
 pub mod manipulation;
 pub mod pfp;
-pub mod rauth;
 pub mod r#ref;
 pub mod regex;
 pub mod result;

crates/quark/src/util/result.rs

@@ -64,6 +64,9 @@ pub enum Error {
     IsBot,
     BotIsPrivate,
 
+    // ? User safety related errors
+    CannotReportYourself,
+
     // ? Permission errors
     MissingPermission {
         permission: Permission,
@@ -166,6 +169,8 @@ impl<'r> Responder<'r, 'static> for Error {
             Error::IsBot => Status::BadRequest,
             Error::BotIsPrivate => Status::Forbidden,
 
+            Error::CannotReportYourself => Status::BadRequest,
+
             Error::MissingPermission { .. } => Status::Forbidden,
             Error::MissingUserPermission { .. } => Status::Forbidden,
             Error::NotElevated => Status::Forbidden,

crates/quark/src/util/variables/delta.rs

@@ -30,6 +30,8 @@ lazy_static! {
         env::var("REVOLT_VAPID_PRIVATE_KEY").expect("Missing REVOLT_VAPID_PRIVATE_KEY environment variable.");
     pub static ref VAPID_PUBLIC_KEY: String =
         env::var("REVOLT_VAPID_PUBLIC_KEY").expect("Missing REVOLT_VAPID_PUBLIC_KEY environment variable.");
+    pub static ref AUTHIFIER_SHIELD_KEY: Option<String> =
+        env::var("REVOLT_AUTHIFIER_SHIELD_KEY").ok();
 
     // Application Flags
     pub static ref INVITE_ONLY: bool = env::var("REVOLT_INVITE_ONLY").map_or(false, |v| v == "1");

crates/quark/src/web/ratelimiter.rs

@@ -8,7 +8,7 @@ use std::hash::Hasher;
 use std::ops::Add;
 use std::time::{Duration, SystemTime, UNIX_EPOCH};
 
-use crate::rauth::models::Session;
+use crate::authifier::models::Session;
 use rocket::fairing::{Fairing, Info, Kind};
 use rocket::http::uri::Origin;
 use rocket::http::{Method, Status};
@@ -129,6 +129,8 @@ fn resolve_bucket<'r>(request: &'r rocket::Request<'_>) -> (&'r str, Option<&'r
                 }
             }
             ("swagger", _) => ("swagger", None),
+            ("safety", Some("report")) => ("safety_report", Some("report")),
+            ("safety", _) => ("safety", None),
             _ => ("any", None),
         }
     } else {
@@ -148,6 +150,8 @@ fn resolve_bucket_limit(bucket: &str) -> u8 {
         "auth_delete" => 255,
         "default_avatar" => 255,
         "swagger" => 100,
+        "safety" => 15,
+        "safety_report" => 3,
         _ => 20,
     }
 }