├── .github ├── dependabot.yml └── workflows │ └── rust.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── Cargo.toml ├── LICENSE ├── README.md ├── SECURITY.md └── src ├── main.rs ├── modules ├── config.rs ├── crypto.rs ├── hashing.rs ├── mod.rs └── storage.rs ├── routes ├── api │ ├── mod.rs │ └── v1 │ │ ├── files.rs │ │ ├── mod.rs │ │ └── users.rs ├── mod.rs └── views │ ├── index.rs │ └── mod.rs ├── structs.rs └── templates └── index.html /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | # Cargo dependencies 9 | - package-ecosystem: "cargo" 10 | directory: "/" 11 | schedule: 12 | interval: "daily" 13 | assignees: 14 | - "checksumdev" 15 | reviewers: 16 | - "sargon64" 17 | labels: 18 | - "dependencies" 19 | - "cargo" 20 | versioning-strategy: "auto" 21 | target-branch: "main" 22 | 23 | # GitHub Actions dependencies 24 | - package-ecosystem: "github-actions" 25 | directory: "/" 26 | schedule: 27 | interval: "weekly" 28 | labels: 29 | - "dependencies" 30 | - "github-actions" 31 | assignees: 32 | - "checksumdev" 33 | -------------------------------------------------------------------------------- /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | --- 2 | jobs: 3 | build: 4 | runs-on: ubuntu-20.04 5 | steps: 6 | # Checkout the repository 7 | - uses: actions/checkout@v3 8 | 9 | # Run conventional commits and determine if the release requires building 10 | - id: changelog 11 | name: Conventional Changelog Action 12 | uses: TriPSs/conventional-changelog-action@v3 13 | with: 14 | git-message: "chore(release): {version}" 15 | git-pull-method: "--ff-only" 16 | github-token: ${{ secrets.GITHUB_TOKEN }} 17 | preset: angular 18 | release-count: "0" 19 | skip-commit: "false" 20 | skip-version-file: "false" 21 | tag-prefix: v 22 | version-file: Cargo.toml 23 | version-path: package.version 24 | 25 | # Load the rust toolchain 26 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 27 | uses: actions-rs/toolchain@v1 28 | with: 29 | profile: minimal 30 | toolchain: stable 31 | 32 | # Load any cache stored by rust-cache. 33 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 34 | uses: Swatinem/rust-cache@v1 35 | 36 | # Run cargo build (for release) 37 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 38 | uses: actions-rs/cargo@v1 39 | with: 40 | args: "--release" 41 | command: build 42 | 43 | # Run cargo test (for release) 44 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 45 | uses: actions-rs/cargo@v1 46 | with: 47 | args: "--release" 48 | command: test 49 | 50 | # Install our SSH key 51 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 52 | name: Install SSH Key 53 | uses: shimataro/ssh-key-action@v2 54 | with: 55 | key: ${{ secrets.SSH_PRIVATE_KEY }} 56 | known_hosts: "placeholder" 57 | 58 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 59 | run: mkdir magnesium-release/ 60 | 61 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 62 | run: cp -R src/templates/ magnesium-release/templates 63 | 64 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 65 | run: cp target/release/magnesium-oxide magnesium-release/magnesium-oxide 66 | 67 | # Tarball all the files in the release directory. 68 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 69 | run: tar -czvf magnesium-release.tar magnesium-release/* 70 | 71 | # Set known hosts 72 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 73 | name: Adding Known Hosts 74 | run: ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts 75 | 76 | # Stop the "magnesium" systemd service over ssh 77 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 78 | name: Stopping magnesium 79 | run: ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "sudo -S <<< ${{ secrets.SSH_PASS }} systemctl stop magnesium" 80 | 81 | # Deploy the release tarball to the remote server via rsync 82 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 83 | name: Deploying release 84 | run: rsync -avz magnesium-release.tar ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:/tmp/magnesium-release.tar 85 | 86 | # Remove the binary and templates directory from the remote server. 87 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 88 | name: Removing old release 89 | run: ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "sudo -S <<< ${{ secrets.SSH_PASS }} rm -rf /srv/magnesium-release/magnesium-oxide /srv/magnesium-release/templates" 90 | 91 | # Extract the release tarball on the remote server 92 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 93 | name: Extracting release 94 | run: ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "sudo -S <<< ${{ secrets.SSH_PASS }} tar -xvzf /tmp/magnesium-release.tar -C /srv/" 95 | 96 | # Start the "magnesium" systemd service over ssh. 97 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 98 | name: Starting magnesium 99 | run: ssh ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "sudo -S <<< ${{ secrets.SSH_PASS }} systemctl start magnesium" 100 | 101 | # Deploy the release artifacts to GitHub 102 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 103 | name: Upload artifacts 104 | uses: actions/upload-artifact@v3 105 | with: 106 | name: magnesium-oxide - ${{ steps.changelog.outputs.version }} 107 | path: magnesium-release.tar 108 | 109 | # Create a release on GitHub with the release notes 110 | - if: ${{ steps.changelog.outputs.skipped == 'false' }} 111 | name: Create Release 112 | uses: ncipollo/release-action@v1 113 | with: 114 | artifacts: magnesium-release.tar 115 | body: ${{ steps.changelog.outputs.clean_changelog }} 116 | draft: false 117 | name: ${{ steps.changelog.outputs.tag }} 118 | prerelease: false 119 | tag: ${{ steps.changelog.outputs.tag }} 120 | token: ${{ secrets.GITHUB_TOKEN }} 121 | 122 | name: Build and Deploy 123 | "on": 124 | push: 125 | branches: 126 | - main 127 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | debug/ 4 | target/ 5 | 6 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries 7 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html 8 | Cargo.lock 9 | 10 | # These are backup files generated by rustfmt 11 | **/*.rs.bk 12 | 13 | # MSVC Windows builds of rustc generate these, which store debugging information 14 | *.pdb 15 | 16 | 17 | # Added by cargo 18 | 19 | /target 20 | 21 | # Oxide 22 | data/ 23 | config.toml 24 | .vscode/launch.json 25 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | abuse@mgo.li. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | . 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | . Translations are available at 128 | . 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | Thank you for your interest in contributing to Magnesium Oxide! We are a community-driven project, and we welcome contributions from everyone following the [Contributor Covenant](CODE_OF_CONDUCT.md). 4 | 5 | Before you begin contributing, please take a read over the following sections to familiarize yourself with our contribution guidelines. 6 | 7 | ## License 8 | 9 | Magnesium Oxide is licensed under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html), submitting your code to our repository will result in your code being under the same license, and will be subject to the same terms of use. 10 | 11 | ## Code Style 12 | 13 | We highly encourage you to use the built-in formatting tools provided by [Rust Analyzer](https://rust-analyzer.github.io/) in your IDE, alternatively you can run `cargo fmt` in your terminal to format your code before submitting. 14 | 15 | ## Version Bumping 16 | 17 | Please do not bump the version number manually, if you follow our commit guidelines the version number will be bumped automatically using the [Semantic Versioning](https://semver.org/) standard. 18 | 19 | ## Commit Guidelines 20 | 21 | * Name your commits meaningful and concisely, not just "fix everything" commits. 22 | * Ensure that your commits are well-formed and follow the [Conventional Commit Format](https://conventionalcommits.org/). 23 | 24 | ## Pull Request Guidelines 25 | 26 | When submitting a pull request, please ensure you have a **detailed description** of the changes you are making, this is a critical part of the process to ensure that the pull request is accepted. 27 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "magnesium-oxide" 3 | version = "0.6.7" 4 | edition = "2021" 5 | 6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 7 | [dependencies] 8 | actix-multipart = "0.4.0" 9 | actix-web = { version = "4.1.0", features = ["rustls"] } 10 | aes-gcm-siv = "0.10.3" 11 | base64 = "0.13.0" 12 | bitflags = "1.3.2" 13 | bson = { version = "2.3.0", features = ["serde_with", "chrono-0_4"] } 14 | bytes = { version = "1.1.0", features = ["serde"] } 15 | chrono = { version = "0.4.19", features = ["serde"] } 16 | env_logger = "0.10.0" 17 | futures-util = { version = "0.3.21", features = ["tokio-io"] } 18 | rust-s3 = { version = "0.31.0", features = ["tokio-rustls-tls", "no-verify-ssl"], default-features = false } 19 | lazy_static = "1.4.0" 20 | log = "0.4.17" 21 | mongodb = "2.2.2" 22 | rand = { version = "0.8.5", features = ["serde"] } 23 | serde = { version = "1.0.138", features = ["derive"] } 24 | serde_json = "1.0.82" 25 | sha3 = "0.10.1" 26 | tera = "1.16.0" 27 | tokio = { version = "1.19.2", features = ["full"] } 28 | toml = "0.5.9" 29 | uuid = { version = "1.1.2", features = ["v4", "serde"] } 30 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | > # DEPRECATED! ⚠️ 2 | > This messy codebase has been put to rest and has been superseded by [Lumen](https://github.com/ChecksumDev/lumen), go check it out! 3 | 4 | # Magnesium Oxide 5 | 6 | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/ChecksumDev/magnesium-oxide?label=Release) [![Build and Deploy](https://github.com/ChecksumDev/magnesium-oxide/actions/workflows/rust.yml/badge.svg)](https://github.com/ChecksumDev/magnesium-oxide/actions/workflows/rust.yml) ![Discord](https://img.shields.io/discord/984852897051312159?label=Discord&logo=DISCORD) ![coffee](https://img.shields.io/badge/Made%20with-Coffee-a27250?logo=CoffeeScript) 7 | 8 | ## ❔ What is this? 9 | 10 | Magnesium-Oxide (MGO) is a secure file uploader for ShareX. 11 | 12 | ## 🌠 Features 13 | 14 | * 🔥 Blazingly fast uploads and encryption. 15 | * 💾 All files are encrypted with a random, secure key, and the key is never saved on the database. 16 | * 🔒 Encryption on all files uploaded using [AES256-GCM-SIV](https://eprint.iacr.org/2017/168.pdf). 17 | * 🦄 All code is written in Rust, no external linkages! 18 | * ✨ Completely memory-safe, no need to worry about memory leaks using a global **`#![forbid(unsafe_code)]`** in [`src/main.rs`](https://github.com/magnesium-uploader/magnesium-oxide/blob/main/src/main.rs#L5). 19 | 20 | ## 🌌 Roadmap 21 | 22 | Think of any features you'd like to see in the future? Let us know by opening an issue or creating a pull request! 23 | 24 | * [ ] 📦 Compressed uploads 25 | * [ ] 📦 Upload encrypted files to S3 26 | * [ ] 💀 Zero-width-encoding for file names 27 | * [ ] 🪢 Support for other databases other than MongoDB (e.g. PostgreSQL) 28 | * [ ] ☢️ Support for other ShareX like software 29 | 30 | ## ➕ Contributing 31 | 32 | Contributions, issues, and feature requests are welcome, 33 | 34 | Ensure you read [CONTRIBUTING](CONTRIBUTING.md) before submitting a pull request. 35 | 36 | ## 🤝 Support 37 | 38 | **Don't hesitate to give us a ⭐️ if you like what you see, it motivates us to keep working hard on it!** 39 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | Our policy is to support any activly maintained major version. 6 | 7 | We will **NOT** provide security fixes to older versions under the major spec. 8 | 9 | | Version | Supported | 10 | | ------- | ------------------ | 11 | | 0.x.x | :white_check_mark: | 12 | 13 | ## Reporting a Vulnerability 14 | 15 | Please send us an email at security@mgo.li with a detailed description of the vulnerability 16 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | //! # Magnesium Oxide 2 | //! A Rust ShareX uploader made from the ground up with security in mind, providing millitary-grade encryption and a high-level API for uploading files to the server. 3 | 4 | #![forbid(unsafe_code)] 5 | #![warn(unreachable_pub, unused_qualifications)] 6 | 7 | pub mod modules; 8 | pub mod routes; 9 | pub mod structs; 10 | 11 | use actix_web::{ 12 | web::{self, ServiceConfig}, 13 | App, HttpServer, 14 | }; 15 | 16 | use log::{debug, error, info}; 17 | use modules::{config::Config, storage::Storage}; 18 | use mongodb::{options::ClientOptions, Client, Database}; 19 | use routes::{api::v1::files::*, api::v1::users::*, views::index::*}; 20 | use tera::Tera; 21 | 22 | lazy_static::lazy_static! { 23 | pub static ref TEMPLATES: Tera = { 24 | let tera = match Tera::new("templates/**/*") { 25 | Ok(t) => t, 26 | Err(e) => { 27 | println!("Parsing error(s): {}", e); 28 | ::std::process::exit(1); 29 | } 30 | }; 31 | tera 32 | }; 33 | } 34 | 35 | #[derive(Clone)] 36 | pub struct AppState { 37 | pub config: Config, 38 | pub database: Database, 39 | pub storage: Storage, 40 | pub tera: Tera, 41 | } 42 | 43 | fn routes(cfg: &mut ServiceConfig) { 44 | cfg.route("/", web::get().to(index)) 45 | .route("/api/v1/files", web::post().to(upload_file)) 46 | .route("/api/v1/files/delete", web::get().to(delete_file)) 47 | .route("/{hash}", web::get().to(get_file)) 48 | .route("/api/v1/users", web::post().to(create_user)); 49 | } 50 | 51 | #[tokio::main] 52 | async fn main() { 53 | env_logger::init_from_env(env_logger::Env::new().default_filter_or("info")); 54 | let _config = Config::get_or_create("config.toml").unwrap(); 55 | let config = _config.clone(); //TODO: remove the need for cloning the config struct 56 | 57 | let client_options = match ClientOptions::parse(&config.database.uri).await { 58 | Ok(opt) => { 59 | debug!("Connecting to database..."); 60 | opt 61 | } 62 | Err(_) => { 63 | error!("Failed to parse MongoDB URI"); 64 | std::process::exit(1); 65 | } 66 | }; 67 | 68 | let client = match Client::with_options(client_options) { 69 | Ok(client) => { 70 | info!("Connection established to MongoDB"); 71 | client 72 | } 73 | Err(_) => { 74 | error!("Failed to connect to MongoDB"); 75 | std::process::exit(1); 76 | } 77 | }; 78 | 79 | let database = client.database(&config.database.db_name); 80 | 81 | //? This is very hacky, but it works for now. 82 | let storage; 83 | if config.storage.local.enabled { 84 | info!("Using local storage module"); 85 | storage = Storage::Local(config.storage.local.path.clone()); 86 | } else { 87 | info!("Using S3 storage module"); 88 | storage = Storage::S3(config.storage.s3.clone()); 89 | } 90 | 91 | let state = AppState { 92 | config, 93 | database, 94 | storage, 95 | tera: TEMPLATES.clone(), 96 | }; 97 | 98 | info!( 99 | "Starting server on http://{}:{} ...", 100 | _config.server.host, _config.server.port 101 | ); 102 | 103 | HttpServer::new(move || App::new().app_data(state.clone()).configure(routes)) 104 | .bind(format!("{}:{}", _config.server.host, _config.server.port)) 105 | .unwrap() 106 | .run() 107 | .await 108 | .unwrap(); 109 | } 110 | -------------------------------------------------------------------------------- /src/modules/config.rs: -------------------------------------------------------------------------------- 1 | use serde::{Deserialize, Serialize}; 2 | use std::io::Read; 3 | use std::io::Write; 4 | use toml; 5 | 6 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 7 | pub struct DatabaseConfig { 8 | pub uri: String, 9 | pub db_name: String, 10 | } 11 | 12 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 13 | pub struct ServerConfig { 14 | pub host: String, 15 | pub port: u16, 16 | } 17 | 18 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 19 | pub struct LocalStorageConfig { 20 | pub enabled: bool, 21 | pub path: String, 22 | } 23 | 24 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 25 | pub struct S3StorageConfig { 26 | pub enabled: bool, 27 | pub bucket: String, 28 | pub endpoint: String, 29 | pub region: String, 30 | pub access_key: String, 31 | pub secret_key: String, 32 | } 33 | 34 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 35 | pub struct StorageConfig { 36 | pub local: LocalStorageConfig, 37 | pub s3: S3StorageConfig, 38 | } 39 | 40 | #[derive(Debug, Default, Deserialize, Serialize, Clone)] 41 | pub struct Config { 42 | pub server: ServerConfig, 43 | pub storage: StorageConfig, 44 | pub database: DatabaseConfig, 45 | } 46 | 47 | impl Config { 48 | pub fn new(server: ServerConfig, storage: StorageConfig, database: DatabaseConfig) -> Config { 49 | Config { 50 | server, 51 | storage, 52 | database, 53 | } 54 | } 55 | 56 | fn from_toml(toml: &str) -> Result { 57 | let config = toml::from_str::(toml)?; 58 | Ok(config) 59 | } 60 | 61 | fn to_toml(&self) -> String { 62 | toml::to_string(&self).unwrap() 63 | } 64 | 65 | pub fn from_file(path: &str) -> Result> { 66 | let mut file = std::fs::File::open(path)?; 67 | let mut contents = String::new(); 68 | 69 | file.read_to_string(&mut contents)?; 70 | let config = Config::from_toml(&contents)?; 71 | Ok(config) 72 | } 73 | 74 | pub fn to_file(&self, path: &str) -> Result<(), Box> { 75 | let mut file = std::fs::File::create(path)?; 76 | let toml = self.to_toml(); 77 | file.write_all(toml.as_bytes())?; 78 | Ok(()) 79 | } 80 | 81 | pub fn get_or_create(path: &str) -> Result> { 82 | if std::path::Path::new(path).exists() { 83 | Config::from_file(path) 84 | } else { 85 | let config = Config::default(); 86 | config 87 | .to_file(path) 88 | .expect("Failed to create a default config file, check permissions"); 89 | 90 | println!( 91 | "\x1b[31m[Magnesium] Please edit the default config file ({}) and restart the program.\x1b[0m", 92 | path 93 | ); 94 | 95 | std::process::exit(0); 96 | } 97 | } 98 | } 99 | -------------------------------------------------------------------------------- /src/modules/crypto.rs: -------------------------------------------------------------------------------- 1 | use std::fmt::Display; 2 | 3 | use aes_gcm_siv::{ 4 | aead::{Aead, NewAead}, 5 | Aes256GcmSiv, Key, Nonce, 6 | }; 7 | use bytes::{Bytes, BytesMut}; 8 | use rand::{rngs::OsRng, Rng}; 9 | use std::io::{Error, ErrorKind}; 10 | 11 | pub struct EncryptionKey { 12 | pub key: Vec, 13 | pub nonce: Vec, 14 | } 15 | 16 | impl Display for EncryptionKey { 17 | fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { 18 | write!( 19 | f, 20 | "EncryptionKey {{ key: {:?}, nonce: {:?} }}", 21 | self.key, self.nonce 22 | ) 23 | } 24 | } 25 | 26 | pub fn generate_key() -> EncryptionKey { 27 | let mut rng = OsRng::default(); 28 | let key: [u8; 32] = rng.gen(); 29 | let nonce: [u8; 12] = rng.gen(); 30 | 31 | let nonce = Nonce::from_slice(&nonce).to_vec(); 32 | let key = Key::from(key).to_vec(); 33 | 34 | EncryptionKey { key, nonce } 35 | } 36 | 37 | pub fn encrypt_bytes( 38 | crypto: &EncryptionKey, 39 | data: &BytesMut, 40 | ) -> Result> { 41 | let nonce = Nonce::from_slice(&crypto.nonce); 42 | let cipher = Aes256GcmSiv::new(Key::from_slice(&crypto.key)); 43 | 44 | let data_crypt = match cipher.encrypt(nonce, data.as_ref()) { 45 | Ok(data) => BytesMut::from(data.as_slice()), 46 | Err(_) => { 47 | return Err(Box::new(Error::new( 48 | ErrorKind::Other, 49 | "Failed to encrypt data", 50 | ))) 51 | } 52 | }; 53 | 54 | Ok(data_crypt.freeze()) 55 | } 56 | 57 | pub fn decrypt_bytes( 58 | crypto: &EncryptionKey, 59 | data: &Bytes, 60 | ) -> Result> { 61 | let nonce = Nonce::from_slice(&crypto.nonce); 62 | let cipher = Aes256GcmSiv::new(Key::from_slice(&crypto.key)); 63 | 64 | let data_decrypt = match cipher.decrypt(nonce, data.as_ref()) { 65 | Ok(data) => BytesMut::from(data.as_slice()), 66 | Err(_) => { 67 | return Err(Box::new(Error::new( 68 | ErrorKind::Other, 69 | "Failed to decrypt data", 70 | ))) 71 | } 72 | }; 73 | 74 | Ok(data_decrypt.freeze()) 75 | } 76 | 77 | #[test] 78 | fn test_crypto() { 79 | let crypto = generate_key(); 80 | let data = BytesMut::from("Hello World!"); 81 | 82 | println!("{}", crypto); 83 | 84 | let encrypted = match encrypt_bytes(&crypto, &data) { 85 | Ok(bytes) => { 86 | println!("{:?}", bytes); 87 | bytes 88 | } 89 | Err(err) => { 90 | println!("{:?}", err); 91 | panic!("Failed to encrypt data"); 92 | } 93 | }; 94 | 95 | let decrypted = match decrypt_bytes(&crypto, &encrypted) { 96 | Ok(bytes) => { 97 | println!("{:?}", bytes); 98 | bytes 99 | } 100 | Err(err) => { 101 | println!("{:?}", err); 102 | panic!("Failed to decrypt data"); 103 | } 104 | }; 105 | 106 | assert_eq!(data.as_ref(), decrypted.as_ref()); 107 | } 108 | -------------------------------------------------------------------------------- /src/modules/hashing.rs: -------------------------------------------------------------------------------- 1 | use sha3::{Digest, Sha3_512}; 2 | 3 | pub fn hash_string>(input: T) -> String { 4 | let mut hasher = Sha3_512::default(); 5 | hasher.update(input.into().as_bytes()); 6 | let out = format!("{:x}", hasher.finalize()); 7 | 8 | out 9 | } 10 | 11 | pub fn hash_bytes(input: &[u8]) -> String { 12 | let mut hasher = Sha3_512::default(); 13 | hasher.update(input); 14 | 15 | let out = format!("{:x}", hasher.finalize()); 16 | out 17 | } 18 | -------------------------------------------------------------------------------- /src/modules/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod config; 2 | pub mod crypto; 3 | pub mod hashing; 4 | pub mod storage; 5 | -------------------------------------------------------------------------------- /src/modules/storage.rs: -------------------------------------------------------------------------------- 1 | use bytes::Bytes; 2 | use tokio::io::{AsyncReadExt, AsyncWriteExt}; 3 | 4 | use super::config::S3StorageConfig; 5 | 6 | #[derive(Clone, Debug)] 7 | pub enum Storage { 8 | Local(String), 9 | S3(S3StorageConfig), 10 | } 11 | 12 | impl Storage { 13 | pub fn path(&self) -> Result<&str, &'static str> { 14 | match self { 15 | Storage::Local(path) => Ok(path), 16 | #[allow(unreachable_patterns)] 17 | _ => Err("This storage module is not a local storage module"), 18 | } 19 | } 20 | 21 | pub async fn get_file( 22 | &self, 23 | uid: &str, 24 | hash: &str, 25 | ) -> Result> { 26 | match self { 27 | Storage::Local(ref local) => { 28 | let path = format!("{}/{}/{}.mgo", local, uid, hash); 29 | let mut file = tokio::fs::File::open(path).await?; 30 | let mut bytes = Vec::new(); 31 | file.read_to_end(&mut bytes).await?; 32 | Ok(Bytes::from(bytes)) 33 | } 34 | Storage::S3(ref _s3) => { 35 | todo!("S3 storage module") 36 | } 37 | } 38 | } 39 | 40 | pub async fn put_file( 41 | &self, 42 | uid: &str, 43 | hash: &str, 44 | bytes: &[u8], 45 | ) -> Result<(), Box> { 46 | match self { 47 | Storage::Local(ref local) => { 48 | let path = format!("{}/{}/{}.mgo", local, uid, hash); 49 | let mut file = tokio::fs::File::create(path).await?; 50 | file.write_all(bytes).await?; 51 | Ok(()) 52 | } 53 | Storage::S3(ref _s3) => { 54 | todo!("S3 storage module") 55 | } 56 | } 57 | } 58 | 59 | pub async fn remove_file( 60 | &self, 61 | uid: &str, 62 | hash: &str, 63 | ) -> Result<(), Box> { 64 | match self { 65 | Storage::Local(ref local) => { 66 | let path = format!("{}/{}/{}.mgo", local, uid, hash); 67 | tokio::fs::remove_file(path).await?; 68 | Ok(()) 69 | } 70 | Storage::S3(ref _s3) => { 71 | todo!("S3 storage module") 72 | } 73 | } 74 | } 75 | 76 | pub async fn exists(&self, uid: &str, hash: &str) -> bool { 77 | match self { 78 | Storage::Local(ref local) => { 79 | let path = format!("{}/{}/{}.mgo", local, uid, hash); 80 | tokio::fs::metadata(path).await.is_ok() 81 | } 82 | Storage::S3(ref _s3) => { 83 | todo!("S3 storage module") 84 | } 85 | } 86 | } 87 | } 88 | 89 | impl Default for Storage { 90 | fn default() -> Self { 91 | Storage::Local(String::from("data")) 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /src/routes/api/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod v1; 2 | -------------------------------------------------------------------------------- /src/routes/api/v1/files.rs: -------------------------------------------------------------------------------- 1 | use actix_multipart::Multipart; 2 | use actix_web::{ 3 | web::{Path, Query}, 4 | Error, HttpRequest, HttpResponse, Result, 5 | }; 6 | use base64::URL_SAFE_NO_PAD; 7 | use bson::{doc, oid::ObjectId}; 8 | use bytes::BytesMut; 9 | use chrono::Utc; 10 | use futures_util::{StreamExt, TryStreamExt}; 11 | use serde_json::json; 12 | 13 | use uuid::Uuid; 14 | 15 | use crate::{ 16 | modules::{ 17 | crypto::{decrypt_bytes, encrypt_bytes, generate_key, EncryptionKey}, 18 | hashing::{hash_bytes, hash_string}, 19 | }, 20 | structs::users::User, 21 | structs::{ 22 | files::{File, FileDeleteRequest, FileGetRequest}, 23 | Privileges, 24 | }, 25 | AppState, 26 | }; 27 | 28 | pub async fn upload_file(request: HttpRequest, mut data: Multipart) -> Result { 29 | let state = request.app_data::().unwrap(); 30 | 31 | let files = state.database.collection::("files"); 32 | let users = state.database.collection::("users"); 33 | 34 | let auth_header = request.headers().get("Authorization"); 35 | 36 | if auth_header.is_none() { 37 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 38 | } 39 | 40 | let token_hash = hash_string(auth_header.unwrap().to_str().unwrap()); 41 | 42 | let uploader = users 43 | .find_one( 44 | doc! { 45 | "token": token_hash 46 | }, 47 | None, 48 | ) 49 | .await 50 | .unwrap(); 51 | 52 | if uploader.is_none() { 53 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 54 | } 55 | 56 | let uploader = uploader.unwrap(); 57 | 58 | if !uploader.privileges.contains(Privileges::USER) { 59 | return Ok( 60 | HttpResponse::Unauthorized().body("Your privileges are not sufficient to upload files") 61 | ); 62 | } 63 | 64 | let storage = state.storage.clone(); 65 | let mut file_name = String::new(); 66 | let mut file_mimetype = String::new(); 67 | let mut file_bits = vec![]; 68 | 69 | while let Some(mut field) = data.try_next().await.unwrap() { 70 | while let Some(chunk) = field.next().await { 71 | file_bits.extend_from_slice(&chunk?); 72 | } 73 | 74 | if field.name() != "file" { 75 | return Ok(HttpResponse::BadRequest().body("Invalid file")); 76 | } 77 | 78 | file_name = field 79 | .content_disposition() 80 | .get_filename() 81 | .unwrap() 82 | .to_string(); 83 | file_mimetype = field.content_type().to_string(); 84 | } 85 | 86 | let file_hash = hash_bytes(&file_bits); 87 | let file_size = file_bits.len() as i64; 88 | 89 | let crypto = generate_key(); 90 | let file_bits = match encrypt_bytes(&crypto, &BytesMut::from(file_bits.as_slice())) { 91 | Ok(bytes) => bytes, 92 | Err(_) => { 93 | return Ok(HttpResponse::InternalServerError().body("Failed to encrypt file")); 94 | } 95 | }; 96 | 97 | if uploader.quota.used + file_size >= uploader.quota.available { 98 | return Ok(HttpResponse::BadRequest() 99 | .body("The file you are trying to upload would exceed your available quota")); 100 | } 101 | 102 | let dkey = Uuid::new_v4().to_string(); 103 | 104 | let file = File { 105 | _id: ObjectId::new(), 106 | filename: file_name.clone(), 107 | mimetype: file_mimetype, 108 | uploader: uploader._id, 109 | hash: file_hash.clone(), 110 | dkey: hash_string(&dkey), 111 | size: file_size, 112 | created_at: Utc::now(), 113 | }; 114 | 115 | storage 116 | .put_file(file.uploader.to_hex().as_str(), &file_hash, &file_bits) 117 | .await?; 118 | 119 | let key_str = base64::encode_config(crypto.key, URL_SAFE_NO_PAD); 120 | let nonce_str = base64::encode_config(crypto.nonce, URL_SAFE_NO_PAD); 121 | 122 | let file_check = files 123 | .find_one(doc! {"hash": &file_hash}, None) 124 | .await 125 | .unwrap(); 126 | 127 | if file_check.is_none() { 128 | files.insert_one(&file, None).await.unwrap(); 129 | 130 | users 131 | .update_one( 132 | doc! {"_id": uploader._id}, 133 | doc! {"$set": {"quota.used": uploader.quota.used + file_size, "updated_at": file.created_at}}, 134 | None, 135 | ).await.unwrap(); 136 | } else { 137 | files 138 | .delete_one(doc! {"_id": file_check.unwrap()._id}, None) 139 | .await 140 | .unwrap(); 141 | files.insert_one(file, None).await.unwrap(); 142 | } 143 | 144 | return Ok(HttpResponse::Created().json(json!({ 145 | "hash": file_hash, 146 | "ext": file_name.split('.').last().unwrap(), 147 | "key": key_str, 148 | "nonce": nonce_str, 149 | "dkey": dkey 150 | }))); 151 | } 152 | 153 | pub async fn delete_file( 154 | request: HttpRequest, 155 | data: Query, 156 | ) -> Result { 157 | let state = request.app_data::().unwrap(); 158 | let files = state.database.collection::("files"); 159 | let storage = state.storage.clone(); 160 | 161 | let dkey = hash_string(&data.dkey); 162 | 163 | let file = files 164 | .find_one(doc! {"hash": &data.hash}, None) 165 | .await 166 | .unwrap(); 167 | 168 | if file.is_none() { 169 | return Ok(HttpResponse::NotFound() 170 | .body("The specified file does not exist or your deletion key is invalid")); 171 | } 172 | 173 | let file = file.unwrap(); 174 | 175 | if dkey != file.dkey { 176 | return Ok(HttpResponse::Unauthorized().body("Invalid deletion key")); 177 | } 178 | 179 | storage 180 | .remove_file(file.uploader.to_hex().as_str(), &file.hash) 181 | .await?; 182 | 183 | files 184 | .delete_one(doc! {"_id": file._id}, None) 185 | .await 186 | .unwrap(); 187 | 188 | Ok(HttpResponse::NoContent().body("")) 189 | } 190 | 191 | pub async fn get_file( 192 | request: HttpRequest, 193 | auth: Query, 194 | hash: Path, 195 | ) -> Result { 196 | let state = request.app_data::().unwrap(); 197 | let files = state.database.collection::("files"); 198 | let storage = state.storage.clone(); 199 | 200 | let hash = hash.into_inner(); 201 | let hash = hash.split('.').next().unwrap(); 202 | 203 | let file = match files.find_one(doc! {"hash": &hash}, None).await { 204 | Ok(file) => { 205 | if file.is_none() { 206 | return Ok(HttpResponse::NotFound().body("The specified file does not exist")); 207 | } 208 | file.unwrap() 209 | } 210 | Err(_) => { 211 | return Ok( 212 | HttpResponse::InternalServerError().body("Failed to retrieve file from database") 213 | ); 214 | } 215 | }; 216 | 217 | let file_bits = match storage 218 | .get_file(file.uploader.to_hex().as_str(), &file.hash) 219 | .await 220 | { 221 | Ok(bytes) => { 222 | let key = base64::decode_config(&auth.key, URL_SAFE_NO_PAD).unwrap(); 223 | let nonce = base64::decode_config(&auth.nonce, URL_SAFE_NO_PAD).unwrap(); 224 | 225 | let crypto = EncryptionKey { key, nonce }; 226 | 227 | match decrypt_bytes(&crypto, &bytes) { 228 | Ok(dbytes) => dbytes, 229 | Err(_) => { 230 | return Ok(HttpResponse::InternalServerError().body("Failed to decrypt file")); 231 | } 232 | } 233 | } 234 | Err(_) => { 235 | return Ok(HttpResponse::NotFound().body("The specified file does not exist")); 236 | } 237 | }; 238 | 239 | Ok(HttpResponse::Ok() 240 | .content_type(file.mimetype.clone()) 241 | .append_header(( 242 | "Content-Disposition", 243 | format!("filename=\"{}\"", file.filename), 244 | )) 245 | .body(file_bits)) 246 | } 247 | -------------------------------------------------------------------------------- /src/routes/api/v1/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod files; 2 | pub mod users; 3 | -------------------------------------------------------------------------------- /src/routes/api/v1/users.rs: -------------------------------------------------------------------------------- 1 | use std::str::FromStr; 2 | 3 | use actix_web::{ 4 | web::{Form, Header}, 5 | Error, HttpRequest, HttpResponse, Result, 6 | }; 7 | 8 | use bson::{doc, oid::ObjectId}; 9 | use serde_json::json; 10 | 11 | use crate::{ 12 | modules::storage::Storage, 13 | structs::{ 14 | files::File, 15 | users::{User, UserCreateRequest, UserIdRequest}, 16 | AuthorizationHeader, Privileges, 17 | }, 18 | AppState, 19 | }; 20 | 21 | pub async fn create_user( 22 | request: HttpRequest, 23 | data: Form, 24 | ) -> Result { 25 | let state = request.app_data::().unwrap(); 26 | let users = state.database.collection::("users"); 27 | let storage = state.storage.clone(); 28 | 29 | let token = User::generate_token(); 30 | let user = User::from(&data.username, &data.password, &data.email, &token.clone()); 31 | 32 | let result = users.insert_one(&user, None).await; 33 | 34 | match storage { 35 | Storage::Local(ref storage) => { 36 | let path = format!("{}/{}", storage, user._id.to_hex()); 37 | tokio::fs::create_dir_all(&path).await?; 38 | } 39 | Storage::S3(ref _storage) => { 40 | todo!("S3 storage"); 41 | } 42 | } 43 | 44 | if result.is_err() { 45 | return Ok(HttpResponse::InternalServerError().body("Internal Server Error")); 46 | } 47 | 48 | Ok(HttpResponse::Created().json(json!({ "token": token }))) 49 | } 50 | 51 | pub async fn get_user( 52 | request: HttpRequest, 53 | data: Form, 54 | headers: &Header, 55 | ) -> Result { 56 | if headers.authorization.is_none() { 57 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 58 | } 59 | 60 | let state = request.app_data::().unwrap(); 61 | let users = state.database.collection::("users"); 62 | 63 | let auth_token = headers.authorization.clone().unwrap(); 64 | 65 | let requester = users 66 | .find_one(doc! {"token": auth_token}, None) 67 | .await 68 | .unwrap(); 69 | 70 | if requester.is_none() { 71 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 72 | } 73 | 74 | let requester = requester.unwrap(); 75 | 76 | if !requester.privileges.contains(Privileges::ADMIN) { 77 | return Ok(HttpResponse::Forbidden().body("Forbidden")); 78 | } 79 | 80 | let _id = match ObjectId::from_str(&data.id) { 81 | Ok(id) => id, 82 | Err(_) => { 83 | return Ok(HttpResponse::BadRequest().body("The specfiied id is not valid")); 84 | } 85 | }; 86 | 87 | let user = users.find_one(doc! { "_id": _id }, None).await.unwrap(); 88 | 89 | if user.is_none() { 90 | return Ok(HttpResponse::NotFound().body("Not Found")); 91 | } 92 | 93 | Ok(HttpResponse::Ok().json(user.unwrap())) 94 | } 95 | 96 | /// 97 | 98 | pub async fn delete_user( 99 | request: HttpRequest, 100 | data: Form, 101 | headers: &Header, 102 | ) -> Result { 103 | if headers.authorization.is_none() { 104 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 105 | } 106 | 107 | let auth_token = headers.authorization.clone().unwrap(); 108 | 109 | let state = request.app_data::().unwrap(); 110 | let users = state.database.collection::("users"); 111 | let files = state.database.collection::("files"); 112 | let storage = state.storage.clone(); 113 | 114 | let requester = users 115 | .find_one(doc! {"token": auth_token}, None) 116 | .await 117 | .unwrap(); 118 | 119 | if requester.is_none() { 120 | return Ok(HttpResponse::Unauthorized().body("Unauthorized")); 121 | } 122 | 123 | let requester = requester.unwrap(); 124 | 125 | let user = users 126 | .find_one(doc! {"_id": ObjectId::from_str(&data.id).unwrap()}, None) 127 | .await 128 | .unwrap(); 129 | 130 | if user.is_none() { 131 | return Ok(HttpResponse::NotFound().body("Not Found")); 132 | } 133 | 134 | let user = user.unwrap(); 135 | 136 | if requester._id.to_hex() == user._id.to_hex() { 137 | let user_result = users.delete_one(doc! {"_id": user._id}, None).await; 138 | 139 | if user_result.is_err() { 140 | return Ok(HttpResponse::InternalServerError() 141 | .body("There was an error deleting the user from the database")); 142 | } 143 | 144 | let files_result = files.delete_many(doc! {"uploader": user._id}, None).await; 145 | 146 | if files_result.is_err() { 147 | return Ok(HttpResponse::InternalServerError() 148 | .body("There was an error deleting the user's files from the database")); 149 | } 150 | 151 | match storage { 152 | Storage::Local(ref storage) => { 153 | let path = format!("{}/{}", storage, user._id.to_hex()); 154 | match tokio::fs::remove_dir_all(&path).await { 155 | Ok(_) => { 156 | return Ok(HttpResponse::Ok().body("User deleted")); 157 | } 158 | Err(_) => { 159 | return Ok(HttpResponse::InternalServerError() 160 | .body("There was an error deleting the user's storage")); 161 | } 162 | } 163 | } 164 | Storage::S3(ref _storage) => { 165 | todo!("S3 storage"); 166 | } 167 | }; 168 | }; 169 | 170 | if !requester.privileges.contains(Privileges::ADMIN) { 171 | return Ok(HttpResponse::Forbidden().body("Forbidden")); 172 | } 173 | 174 | let user_result = users.delete_one(doc! {"_id": user._id}, None).await; 175 | 176 | if user_result.is_err() { 177 | return Ok(HttpResponse::InternalServerError() 178 | .body("There was an error deleting the user from the database")); 179 | } 180 | 181 | let files_result = files.delete_many(doc! {"uploader": user._id}, None).await; 182 | 183 | if files_result.is_err() { 184 | return Ok(HttpResponse::InternalServerError() 185 | .body("There was an error deleting the user's files from the database")); 186 | } 187 | 188 | match storage { 189 | Storage::Local(ref storage) => { 190 | let path = format!("{}/{}", storage, user._id.to_hex()); 191 | match tokio::fs::remove_dir_all(&path).await { 192 | Ok(_) => { 193 | return Ok(HttpResponse::Ok().body("User deleted")); 194 | } 195 | Err(_) => { 196 | return Ok(HttpResponse::InternalServerError() 197 | .body("There was an error deleting the user's storage")); 198 | } 199 | } 200 | } 201 | Storage::S3(ref _storage) => { 202 | todo!("S3 storage"); 203 | } 204 | }; 205 | } 206 | -------------------------------------------------------------------------------- /src/routes/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod api; 2 | pub mod views; 3 | -------------------------------------------------------------------------------- /src/routes/views/index.rs: -------------------------------------------------------------------------------- 1 | use actix_web::{Error, HttpRequest, HttpResponse, Result}; 2 | use futures_util::StreamExt; 3 | 4 | use crate::{structs::files::File, AppState}; 5 | use tera::Context; 6 | 7 | pub async fn index(request: HttpRequest) -> Result { 8 | let state = request.app_data::().unwrap(); 9 | 10 | let mut total_size: i64 = 0; 11 | let mut total_files: i64 = 0; 12 | 13 | { 14 | let files = state.database.collection::("files"); 15 | let mut cursor = files.find(None, None).await.unwrap(); 16 | 17 | while let Some(file) = cursor.next().await { 18 | let file = file.unwrap(); 19 | 20 | total_size += file.size; 21 | total_files += 1; 22 | } 23 | } 24 | 25 | let mut context = Context::new(); 26 | context.insert("total_size", &total_size); 27 | context.insert("total_files", &total_files); 28 | context.insert("version", env!("CARGO_PKG_VERSION")); 29 | 30 | let html = state.tera.render("index.html", &context).unwrap(); 31 | 32 | Ok(HttpResponse::Ok().content_type("text/html").body(html)) 33 | } 34 | -------------------------------------------------------------------------------- /src/routes/views/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod index; 2 | -------------------------------------------------------------------------------- /src/structs.rs: -------------------------------------------------------------------------------- 1 | use bson::{doc, oid::ObjectId, serde_helpers::chrono_datetime_as_bson_datetime}; 2 | use chrono::{DateTime, Utc}; 3 | use serde::{Deserialize, Serialize}; 4 | use uuid::Uuid; 5 | 6 | use crate::modules::hashing::hash_string; 7 | 8 | #[derive(Debug, Serialize, Deserialize)] 9 | pub struct AuthorizationHeader { 10 | pub authorization: Option, 11 | } 12 | 13 | bitflags::bitflags! { 14 | 15 | #[derive(Serialize, Deserialize)] 16 | pub struct Privileges: u32 { 17 | const ADMIN = 1; 18 | const USER = 2; 19 | } 20 | } 21 | 22 | impl Default for Privileges { 23 | fn default() -> Self { 24 | Privileges::USER 25 | } 26 | } 27 | 28 | pub mod users { 29 | use super::*; 30 | 31 | #[derive(Debug, Serialize, Deserialize)] 32 | pub struct User { 33 | pub _id: ObjectId, 34 | pub username: String, 35 | pub email: String, 36 | pub password: String, //? SHA3-512 hash 37 | pub quota: UserQuota, 38 | pub privileges: Privileges, 39 | pub token: String, //? SHA3-512 hash 40 | #[serde(with = "chrono_datetime_as_bson_datetime")] 41 | pub created_at: DateTime, 42 | #[serde(with = "chrono_datetime_as_bson_datetime")] 43 | pub updated_at: DateTime, 44 | } 45 | 46 | impl User { 47 | pub fn from(username: T, password: T, email: T, token: T) -> User 48 | where 49 | T: Into, 50 | { 51 | User { 52 | _id: ObjectId::new(), 53 | username: username.into(), 54 | password: hash_string(password.into()), 55 | email: email.into(), 56 | quota: User::default_quota(), 57 | token: hash_string(token.into()), 58 | privileges: Privileges::default(), 59 | created_at: Utc::now(), 60 | updated_at: Utc::now(), 61 | } 62 | } 63 | 64 | pub fn default_quota() -> UserQuota { 65 | UserQuota { 66 | used: 0, 67 | 68 | available: 1024 * 1024 * 1024 * 8, 69 | } 70 | } 71 | 72 | pub fn generate_token() -> String { 73 | Uuid::new_v4().to_string() 74 | } 75 | } 76 | 77 | #[derive(Debug, Serialize, Deserialize)] 78 | pub struct UserQuota { 79 | pub used: i64, 80 | pub available: i64, 81 | } 82 | 83 | #[derive(Debug, Serialize, Deserialize)] 84 | pub struct UserCreateRequest { 85 | pub username: String, 86 | pub password: String, 87 | pub email: String, 88 | } 89 | 90 | pub struct UserIdRequest { 91 | pub id: String, 92 | } 93 | } 94 | 95 | pub mod files { 96 | use super::*; 97 | 98 | #[derive(Debug, Serialize, Deserialize)] 99 | pub struct File { 100 | pub _id: ObjectId, 101 | pub filename: String, 102 | pub mimetype: String, 103 | pub uploader: ObjectId, 104 | pub hash: String, 105 | pub dkey: String, 106 | pub size: i64, 107 | #[serde(with = "chrono_datetime_as_bson_datetime")] 108 | pub created_at: DateTime, 109 | } 110 | 111 | #[derive(Debug, Deserialize)] 112 | pub struct FileGetRequest { 113 | pub key: String, 114 | pub nonce: String, 115 | } 116 | 117 | #[derive(Debug, Serialize, Deserialize)] 118 | pub struct FileDeleteRequest { 119 | pub hash: String, 120 | pub dkey: String, 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /src/templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Magnesium Oxide 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 16 | 17 | 18 | 19 |
20 |

Magnesium Oxide

21 |

22 | This server is running Magnesium Oxide 23 | (v{{version}}) 24 |

25 |

26 | We are currently storing {{ total_files }} files and {{ total_size / 1024 / 1024 | 27 | round(method="ceil", precision=2) }} MB of data. 28 |

29 |
30 | 31 | 32 | View on GitHub 33 | 34 | 35 | 36 | Join our Discord 37 | 38 |
39 |
40 | 41 | 42 | --------------------------------------------------------------------------------