From 9c8fe6c590451ea3bd2501f058c5d5f0a2670b8c Mon Sep 17 00:00:00 2001 From: Ryan Wild Date: Thu, 18 Mar 2021 22:42:52 +0000 Subject: [PATCH] Fix checkstyle & other formatting This should help clear a lot of the "Security" alerts resolving FS-58 --- CONTRIBUTING.md | 4 ++-- LICENSE.md | 19 ++++++++++++------- README.md | 7 ++++--- SECURITY.md | 14 +++++++------- checkstyle.xml | 11 ++++------- supressions.xml | 4 +--- 6 files changed, 30 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29cd3a48..76586aaf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ -# Contributing to TotalFreedomMod # +# Contributing to TotalFreedomMod -For information about contributing to TotalFreedomMod, please see the [contributing guidelines](https://github.com/TotalFreedom/TotalFreedomMod/wiki/Contributing). \ No newline at end of file +For information about contributing to TotalFreedomMod, please see the [contributing guidelines](https://github.com/TotalFreedom/TotalFreedomMod/wiki/Contributing). diff --git a/LICENSE.md b/LICENSE.md index 99a177f4..5ee5fb7c 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,5 @@ -# TotalFreedom General License # +# TotalFreedom General License + _Version 2.0, 27th February 2015_ Copyright (c) 2011 Steven Lawson @@ -7,7 +8,8 @@ Copyright (c) 2012 Jerom van der Sar All rights reserved. -##### 1. Definitions ##### +##### 1. Definitions + "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by this document. "Licensor" shall mean the copyright holder or entity authorised by the copyright owner that is granting the License. @@ -30,12 +32,13 @@ All rights reserved. "Redistribution" shall mean any partial or complete availability, transfer or publication of the Work from one Legal Entity to another. -##### 2. Grant of Copyright License ##### - Subject to the terms and conditions of this License, You are granted a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to prepare Derivative Works of, publicly display, publicly perform, inspect and redistribute the Work and such Derivative Works as long as the following conditions are met: +##### 2. Grant of Copyright License + +Subject to the terms and conditions of this License, You are granted a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to prepare Derivative Works of, publicly display, publicly perform, inspect and redistribute the Work and such Derivative Works as long as the following conditions are met: 1. Redistributions of This Software must solely occur in Source form. Redistribution in Object form is prohibited without prior written permission from the Licensor. -2. Neither the names of the copyright holders nor the names this software's contributors may be removed from This Software's source code. +2. Neither the names of the copyright holders nor the names this software's contributors may be removed from This Software's source code. 3. Neither the names of the copyright holders nor the names of its contributors may be used to endorse or promote products derived from This Software without specific prior written permission. @@ -47,8 +50,10 @@ All rights reserved. 7. Sub licensing of This Software is prohibited without prior written permission from the Licensor. -##### 3. Submission of Contributions ##### +##### 3. Submission of Contributions + Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. -##### 4. Disclaimer of Warranty ##### +##### 4. Disclaimer of Warranty + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 49adaceb..24e51aa6 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -# TotalFreedomMod [![Build Status](https://travis-ci.com/AtlasMediaGroup/TotalFreedomMod.svg?branch=development)](https://travis-ci.com/AtlasMediaGroup/TotalFreedomMod) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/29c0f964da304666bd654bc7b1d556db)](https://www.codacy.com/gh/AtlasMediaGroup/TotalFreedomMod/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AtlasMediaGroup/TotalFreedomMod&utm_campaign=Badge_Grade) +# TotalFreedomMod [![Build Status](https://travis-ci.com/AtlasMediaGroup/TotalFreedomMod.svg?branch=development)](https://travis-ci.com/AtlasMediaGroup/TotalFreedomMod) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/29c0f964da304666bd654bc7b1d556db)](https://www.codacy.com/gh/AtlasMediaGroup/TotalFreedomMod/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AtlasMediaGroup/TotalFreedomMod&utm_campaign=Badge_Grade) TotalFreedomMod is a CraftBukkit server plugin designed primarily to support the [Official TotalFreedom Minecraft Server](https://totalfreedom.me/). However, you are more than welcome to adapt the source for your own server. This plugin was originally coded by StevenLawson (Madgeek1450), with Jerom van der Sar (Prozza) becoming heavily involved in its development some time later. It consists of over 85 custom coded commands and a large variety of distinguishable features not included in any other plugin. The plugin has since its beginning grown immensely. Together, with the main TotalFreedom server, TotalFreedomMod has a long-standing reputation of effectiveness whilst maintaining a clear feeling of openness towards the administrators and the players themselves. -### Contributing ### +### Contributing + Please see [CONTRIBUTING.md](CONTRIBUTING.md) if you are interested in developing TotalFreedomMod. For information on how TotalFreedomMod is licensed, please see [LICENSE.md](LICENSE.md). For information on our security policy and reporting an issue, please see [SECURITY.md](SECURITY.md) -### Compiling ### +### Compiling You need Maven to build. You'd also need to set the JDK version to Java 8 as that is the current standard as of now. diff --git a/SECURITY.md b/SECURITY.md index 1224ae03..c2650afc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,15 +6,15 @@ We currently support the code running on the "development" branch of this reposi In terms of plugin releases, we support the following versions: -| Version | Supported | -| ------- | ------------------ | -| 2020.11 | :white_check_mark: | -| 6.0.x (Pre-Release) | :x: | -| < 2020.11 | :x: | -| < 5.x | :x: | +| Version | Supported | +| ------------------- | ------------------ | +| 2020.11 | :white_check_mark: | +| 6.0.x (Pre-Release) | :x: | +| < 2020.11 | :x: | +| < 5.x | :x: | ## Reporting a Vulnerability If the report has minor security implications (ie we've added a super admin to a senior admins permission) please raise an post on [our forums](https://forum.totalfreedom.me/) in the first instance. If you do not have a forum account and do not wish to sign up, please e-mail us using the e-mail in the next sentence. -For security vulnerabilities that are more severe and that may pose a more significant threat to the servers running this plugin, please e-mail os-security-reports [ AT ] atlas-media.co.uk - You can expect an automated response immediately to acknowledge receipt of your e-mail, and one of our team will aim to respond within 72 hours and will work with you on the best way to address your concerns. +For security vulnerabilities that are more severe and that may pose a more significant threat to the servers running this plugin, please e-mail os-security-reports [ AT ] atlas-media.co.uk - You can expect an automated response immediately to acknowledge receipt of your e-mail, and one of our team will aim to respond within 72 hours and will work with you on the best way to address your concerns. diff --git a/checkstyle.xml b/checkstyle.xml index d3cab91f..b060ebbe 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -2,20 +2,16 @@ - - - - @@ -91,7 +87,7 @@ value="Local variable name ''{0}'' must match pattern ''{1}''."/> - + @@ -112,7 +108,8 @@ value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> - + + @@ -133,4 +130,4 @@ - + \ No newline at end of file diff --git a/supressions.xml b/supressions.xml index 7330506f..09efa3c8 100644 --- a/supressions.xml +++ b/supressions.xml @@ -1,11 +1,9 @@ - - - + \ No newline at end of file