From 9316502432a5b4d49f0e81ce9b8bbf953ebea015 Mon Sep 17 00:00:00 2001 From: core Date: Thu, 15 Dec 2022 17:59:56 -0500 Subject: [PATCH] [meta] boring documentation text stuff --- CHANGELOG.txt | 1 + CONTRIBUTING.md | 25 +++++++ LICENSE.txt | 165 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +- quicktap/README.md | 38 ++++++++++ quicktap/src/lib.rs | 2 + 6 files changed, 234 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.txt create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.txt create mode 100644 quicktap/README.md diff --git a/CHANGELOG.txt b/CHANGELOG.txt new file mode 100644 index 0000000..a633d33 --- /dev/null +++ b/CHANGELOG.txt @@ -0,0 +1 @@ +we haven't made any releases yet! nothing here... \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3f660bc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Elaeis/Quicktap Contributor Guidelines + +Glad to hear you're willing to contribute to the project! We just have a couple guidelines we kindly ask you to follow just to make sure everything goes smoothly: + +## Legal Mumbo Jumbo +By contributing anything to the project, you agree that your contributions **become a part of the project** and are licensed under the [GNU Lesser General Public License 3.0](https://www.gnu.org/licenses/lgpl-3.0.txt). This is non-negotiable as we don't want another CraftBukkit situation. + +## Code Quality +We try to keep the number of warnings down to a nice 0. We turn on a *lot* of Clippy lints, on purpose, so this might be an annoyance at times, but please try to make your code compile without warnings before pushing it to stable. +Also, try to avoid `unwrap` and `expect` where possible. If you use them, explicitly `#[allow(clippy::unwrap_used)]` and put a comment explaining why they are safe and will not cause a panic. + +The only time you should be allowing these panic-y functions is in test modules, as a .unwrap() is what you *want* in that situation. + +## Test Modules + +We do not have a centralized test module. Tests should be close to the code they are testing, *however* they should still be seperate. +If you are adding tests, please look for the closest `tests.rs` file. Use your best judgement, ie "would other people look here?". If it doesn't make sense to put it in an existing test module, create a new one, but please **always** name it `tests.rs`. +This makes it easier to find tests. + +## Documentation +We have `#[deny(missing_docs)]` on for a reason. Please try to write good documentation for any public API you add to the project. + +## Running Tests + +Although we do have a CI job to run tests, please make sure that you don't submit any code **for merging** if the tests fail. It's okay if the code is still a WIP, but we won't merge code with failing tests. Please don't push to get code merged, let the process work! \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..153d416 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. \ No newline at end of file diff --git a/README.md b/README.md index 6da1e95..874d5ae 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # Elaeis 4.0 -Elaeis is a implementation of the WireGuard protocol (quicktap) and a management system built around it (elaeis itself). \ No newline at end of file +Elaeis is a implementation of the WireGuard protocol (quicktap) and a management system built around it (elaeis itself). + +For more information, check [quicktap's README](quicktap/README.md) or [elaeis4's README](elaeis/README.md) \ No newline at end of file diff --git a/quicktap/README.md b/quicktap/README.md new file mode 100644 index 0000000..6619686 --- /dev/null +++ b/quicktap/README.md @@ -0,0 +1,38 @@ +# Quicktap +Quicktap is a (hopefully) standard-compliant Rust implementation of the [WireGuard protocol](https://wireguard.org). + +It was designed to be a simpler alternative to Cloudflare's [boringtun](https://github.com/cloudflare/boringtun). + +## Getting Started: Normal People + +> Warning: Quicktap's CLI (and quicktap as a whole) is in a very unfinished state right now. Use something else for a little bit. + +See the sections below for your platform for a guide on how to use Quicktap. + +### Linux +> Dont! Linux has had [in-kernel WireGuard support since 5.6](https://lists.zx2c4.com/pipermail/wireguard/2020-March/005206.html) and you probably have it. If you don't, use `wireguard-linux-compat`. There is no reason to use quicktap on Linux. The kernel module is better and faster. + +After you've ignored the previous sentences and want to do it anyway: + +First, compile quicktap. You only need to do this once per release. + +1. Download the latest release from https://gitlab.e3t.cc/e3team/elaeis4/-/releases. +2. Make sure you have Rust installed. Check out https://rustup.rs if you don't. +3. Run `cargo build --release` in the project directory. + +After compilation, use `target/release/quicktap-cli ` to create your interface. Then you can configure it as usual with `ip` and `wg` commands. + +### MacOS +Not yet... + +### NetBSD +Not yet... + +## Getting Started: Application Developers + +It's just a typical Rust library. It's up on crates.io as `quicktap` for stable releases. +We aim to have pretty good documentation, so check out the crate documentation for more info on how to use it. + +## Getting Started: Quicktap Developers + +It's just a typical Rust library. Try to follow our [contributor guidelines](../CONTRIBUTING.md). Thanks! \ No newline at end of file diff --git a/quicktap/src/lib.rs b/quicktap/src/lib.rs index 7879fce..35c9dbc 100644 --- a/quicktap/src/lib.rs +++ b/quicktap/src/lib.rs @@ -4,6 +4,8 @@ #![warn(clippy::pedantic)] #![warn(clippy::nursery)] #![deny(missing_docs)] +#![deny(clippy::unwrap_used)] +#![deny(clippy::expect_used)] // This is an annoyance #![allow(clippy::must_use_candidate)]