license and readme improvements, updates
This commit is contained in:
parent
896a64e835
commit
19d289c1d8
66
LICENSE
Normal file
66
LICENSE
Normal file
@ -0,0 +1,66 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016-2018, Leslie Krause (leslie@searstower.org)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
||||
persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
|
||||
For more details:
|
||||
https://opensource.org/licenses/MIT
|
||||
|
||||
License of modified or added source code
|
||||
----------------------------------------
|
||||
Copyright (C) 2020-2023 mckaygerhard <mckaygerhard@gmail.com>,
|
||||
|
||||
The auto initializer code and improvements were adde under CC BY-SA NC 4.0
|
||||
|
||||
CC-BY-SA-NC 4.0
|
||||
===============
|
||||
|
||||
Attribution-ShareAlike 4.0 Unported (CC BY-SA 4.0)
|
||||
http://creativecommons.org/licenses/by-sa/4.0/
|
||||
|
||||
You are free to:
|
||||
|
||||
* Share — copy and redistribute the material in any medium or format
|
||||
* Adapt — remix, transform, and build upon the material
|
||||
|
||||
The licensor cannot revoke these freedoms as long as you follow
|
||||
the license terms.
|
||||
|
||||
Under the following terms:
|
||||
|
||||
* Attribution — You must give appropriate credit, provide a link to
|
||||
the license, and indicate if changes were made. You may do so in any
|
||||
reasonable manner, but not in any way that suggests the licensor
|
||||
endorses you or your use.
|
||||
* NonCommercial — You may not use the material for commercial purposes.
|
||||
* ShareAlike — If you remix, transform, or build upon the material,
|
||||
you must distribute your contributions under the same license as the
|
||||
original.
|
||||
* No additional restrictions — You may not apply legal terms or technological
|
||||
measures that legally restrict others from doing anything the license permits.
|
||||
|
||||
Notices:
|
||||
|
||||
You do not have to comply with the license for elements of the material in
|
||||
the public domain or where your use is permitted by an applicable exception
|
||||
or limitation.
|
||||
|
||||
No warranties are given. The license may not give you all of the permissions
|
||||
necessary for your intended use. For example, other rights such as publicity,
|
||||
privacy, or moral rights may limit how you use the material.
|
||||
|
||||
198
README.md
Normal file
198
README.md
Normal file
@ -0,0 +1,198 @@
|
||||
minetest mod Auth Redux
|
||||
=======================
|
||||
|
||||
AUTH drop-in faster replacement for authentication handler in minetest.
|
||||
|
||||
Information
|
||||
-----------
|
||||
|
||||
Auth Redux is a drop-in replacement for the builtin authentication handler
|
||||
of Minetest. It is designed from the ground up to be robust and secure enough
|
||||
for use on high-traffic Minetest servers, while also addressing a number of
|
||||
outstanding engine bugs
|
||||
|
||||
Its **the most faster equilibrated authentication handler in minetest.** (its like
|
||||
if you were using Redist or LevelDB but with very high stability).
|
||||
|
||||
[](screenshot.png)
|
||||
|
||||
## Technical information
|
||||
------------------------
|
||||
|
||||
Auth Redux provides an efficient and scalable back-end solution for player
|
||||
authentication, making it suitable for even the most demanding server
|
||||
environments. It has been put to the test with a database of over 520,000 registered
|
||||
users -- with no in-game overhead!
|
||||
|
||||
Recommended Enhancement: The DataMiner Mod extends the capabilities of Auth Redux,
|
||||
providing comprehensive player and server statistics within a graphical user-interface,
|
||||
in addition to an API for custom-tailored log analysis and reporting directly
|
||||
from the command line.
|
||||
|
||||
- [Technical information](#technical-information)
|
||||
- [Feature matrix metrics](#feature-matrix-metrics)
|
||||
- [Full lua based code](#full-lua-based-code)
|
||||
- [increased security and bug free](#increased-security-and-bug-free)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Documentation](#documentation)
|
||||
- [Technical features](#technical-features)
|
||||
- [Integrated ruleset debugger](#integrated-ruleset-debugger)
|
||||
- [benchmarks](#benchmarks)
|
||||
- [Changelog](#changelog)
|
||||
- [Copyright and LICENSE](#copyright-and-license)
|
||||
|
||||
|
||||
#### Feature matrix metrics
|
||||
|
||||
Auth Redux is the most equilibrated faster authentication handler:
|
||||
|
||||
| Player Auth handler | re-joins | new join | set privilegies | database size | stability |
|
||||
| ------------------- | ------------ | ----------- | ------------ | ----------- | ------------ |
|
||||
| 5.0+ Builtin | 4.5 x Faster | 4 x Faster | 4.2 x Faster | 17% smaller | 100 x stable |
|
||||
| 0.4.X Builtin | 592 x Faster | 3 x Faster | 633 x Faster | 32% smaller | 1000 x stable |
|
||||
| sauth mod (sqlite) | 40 x Faster | 33x Faster | 48 x Faster | 32% smaller | 4 x stable |
|
||||
| SQLite Builtin | 30 x Faster | 23x Faster | 40 x Faster | 30% smaller | 4 x stable |
|
||||
| Redist Builtin | 8 x slower | 2 x slower | 1 x slower | unknow | 10 x stable |
|
||||
| PostgreSQL Builtin | 35 x Faster | 33x Faster | 40 x Faster | 30% smaller | 4 x stable |
|
||||
|
||||
#### Full lua based code
|
||||
|
||||
Auth Redux is completely Lua-driven, with no external dependencies. It
|
||||
interfaces seamlessly with Minetest's authentication handler API, therefore
|
||||
no complicated setup or configuration is required. It is intended to be
|
||||
compatible with all versions of Minetest 0.4.14+, providing server administrators
|
||||
with both flexible and fine-grained access control.
|
||||
|
||||
#### increased security and bug free
|
||||
|
||||
It addressing following long time bugs without complicated dependencies:
|
||||
|
||||
* #5334 https://github.com/minetest/minetest/issues/5334
|
||||
* #6783 https://github.com/minetest/minetest/issues/6783
|
||||
* #4451 https://github.com/minetest/minetest/issues/4451
|
||||
|
||||
#### Dependencies:
|
||||
|
||||
* default
|
||||
* formspecs (ActiveFormspecs Mod)
|
||||
|
||||
#### Documentation
|
||||
|
||||
Original documentation is on https://github.com/sorcerykid/auth_rx/wiki/Introduction
|
||||
|
||||
#### Technical features
|
||||
|
||||
* High-Performance Journaling System
|
||||
|
||||
To protect the master database against corruption and data loss, all
|
||||
transactions are serially recorded within a journal, thereby reducing the
|
||||
frequency and intensity of disk writes. In the event of a server crash or
|
||||
power outage, any pending transactions are committed to the master database.
|
||||
|
||||
* Stateful Rule-Based Login Filtering
|
||||
|
||||
MARS is an easy-to-learn scripting language that affords a first line of
|
||||
defense against unwanted visitors. Both restrictive and permissive security
|
||||
models can be enforced via rulesets, allowing every login request to be
|
||||
filtered according to conditional action-chains with custom error messages.
|
||||
|
||||
* Expanded Master Database Schema
|
||||
|
||||
The master database supports additional metadata to aid in reviewing and monitoring
|
||||
login activity, including the timestamp of the first login, the total time
|
||||
spent playing, the total number of player sessions, etc. This information
|
||||
can prove invaluable for command-line reporting and analysis tools.
|
||||
|
||||
#### Integrated ruleset debugger
|
||||
|
||||
By entering the `/fdebug` command into chat (requires the "server privilege"),
|
||||
you will be presented with a debugging console. The workspace consists of the
|
||||
following elements:
|
||||
|
||||
* A. The "Show Client Output" option toggles whether to display the client output
|
||||
panel. The "Show Debug Prompt" option toggles whether to insert debug status prompts
|
||||
into the source code.
|
||||
* B. This textarea contains the ruleset definition to be examined. Although Minetest
|
||||
supports editing of text, it is strongly recommended to copy and paste your source
|
||||
code into a full-fledged text editor.
|
||||
* C. The client output panel renders error messages as they would appear within the
|
||||
client. The status panel typically indicates whether the ruleset passed or failed,
|
||||
as well as other debugging conditions.
|
||||
* D. The "Save" button will export the current ruleset definition, overwriting
|
||||
"greenlist.mt" in your world directory. The "Load" button will import an existing
|
||||
ruleset definition from "greenlist.mt" for debugging.
|
||||
* E. The "Process" button will process the ruleset definition according to the
|
||||
selected login filtering criteria: Normal, New Account, or Wrong Password (thereby
|
||||
changing the relevant preset variables).
|
||||
* F. The preset variables are listed here with their corresponding values. These
|
||||
values will never change except during the login filtering process, or unless
|
||||
explicitly set in the panel below.
|
||||
* G. The name and type of the selected variable is indicated here. The value can be
|
||||
edited in the text field, and set with the "Set" button. The arrow buttons allow for
|
||||
re-ordering any variable within the list.
|
||||
|
||||
Some variables, like $clock and $uptime, have an "Auto Update" option to toggle whether
|
||||
the values should be derived from the system state. For a fully sandboxed environment,
|
||||
you can disable this option.
|
||||
|
||||
The special `$__debug` variable gives you direct access to the MARS expression
|
||||
interpreter. You can enter any valid expression, and the resulting value and type
|
||||
will be displayed in the panel above (all variable types, except patterns, are
|
||||
supported). This is particularly helpful for monitoring the values of certain
|
||||
variables. To calculate the size of the $ip_names_list, for example, you would enter
|
||||
|
||||
```
|
||||
size($ip_names_list)
|
||||
```
|
||||
|
||||
Whenever a ruleset passes or fails, or if a syntax error is encountered, a debug
|
||||
status prompt will be inserted into the source code below the line in question:
|
||||
|
||||
```
|
||||
if $name->len() eq "administrator"`
|
||||
# ====== ^ Line 12: Mismatched operands in ruleset^ ======
|
||||
```
|
||||
|
||||
These breakpoints will be removed automatically when the ruleset definition is saved,
|
||||
so there is no need to edit them out.
|
||||
|
||||
#### benchmarks
|
||||
|
||||
You can check the file [benchmark.txt](benchmark.txt) from where the
|
||||
comparisons were made.
|
||||
|
||||
As these benchmarks reveal, there is no discernible benefit to using an SQLite3
|
||||
backend for authentication over a flat-file database, whether in terms of
|
||||
reliability or performance.
|
||||
|
||||
The cons of using LEvelDB or REdist is the unstability of those fast storage
|
||||
authentication handlers, so auth_RX solves the problem and being more faster.
|
||||
|
||||
If anything, SQLite3/File/LevelDB databases are a hindrance when it comes to
|
||||
random access of large volumes of data, and more than likely the culprit for
|
||||
why some high-traffic servers lately are experiencing notable lag spikes
|
||||
|
||||
## Changelog
|
||||
|
||||
Please see [changelog](changelog) file
|
||||
|
||||
## Copyright and LICENSE
|
||||
|
||||
Copyright (c) 2016-2018, Leslie Krause (leslie@searstower.org)
|
||||
Copyright (c) 2020-2023, PICCORO Lenz McKAY (mckaygerhard@gmail.com)
|
||||
|
||||
**License of modified or added source code**
|
||||
|
||||
The auto initializer code and improvements were adde under CC BY-SA NC 4.0
|
||||
by mckaygerhard or "PICCORO" Lenz McKAY (mckaygerhard@gmail.com)
|
||||
|
||||
**License of original source files until 2018**
|
||||
|
||||
Auth Redux Mod v2.13 By Leslie Krause under The MIT License (MIT)
|
||||
|
||||
https://forum.minetest.net/viewtopic.php?f=9&t=20393
|
||||
|
||||
Browse orignal source code: https://bitbucket.org/sorcerykid/auth_rx
|
||||
|
||||
Check the [LICENSE](LICENSE) file.
|
||||
|
||||
343
README.txt
343
README.txt
@ -1,159 +1,198 @@
|
||||
Auth Redux Mod v2.13
|
||||
By Leslie Krause
|
||||
minetest mod Auth Redux
|
||||
=======================
|
||||
|
||||
Auth Redux is a drop-in replacement for the builtin authentication handler of Minetest.
|
||||
It is designed from the ground up to be robust and secure enough for use on high-traffic
|
||||
Minetest servers, while also addressing a number of outstanding bugs (including #5334
|
||||
and #6783 and #4451) in the Minetest 0.4.x engine.
|
||||
AUTH drop-in faster replacement for authentication handler in minetest.
|
||||
|
||||
Auth Redux is intended to be compatible with all versions of Minetest 0.4.14+.
|
||||
Information
|
||||
-----------
|
||||
|
||||
Auth Redux is a drop-in replacement for the builtin authentication handler
|
||||
of Minetest. It is designed from the ground up to be robust and secure enough
|
||||
for use on high-traffic Minetest servers, while also addressing a number of
|
||||
outstanding engine bugs
|
||||
|
||||
Its **the most faster equilibrated authentication handler in minetest.** (its like
|
||||
if you were using Redist or LevelDB but with very high stability).
|
||||
|
||||
[](screenshot.png)
|
||||
|
||||
## Technical information
|
||||
------------------------
|
||||
|
||||
Auth Redux provides an efficient and scalable back-end solution for player
|
||||
authentication, making it suitable for even the most demanding server
|
||||
environments. It has been put to the test with a database of over 520,000 registered
|
||||
users -- with no in-game overhead!
|
||||
|
||||
Recommended Enhancement: The DataMiner Mod extends the capabilities of Auth Redux,
|
||||
providing comprehensive player and server statistics within a graphical user-interface,
|
||||
in addition to an API for custom-tailored log analysis and reporting directly
|
||||
from the command line.
|
||||
|
||||
- [Technical information](#technical-information)
|
||||
- [Feature matrix metrics](#feature-matrix-metrics)
|
||||
- [Full lua based code](#full-lua-based-code)
|
||||
- [increased security and bug free](#increased-security-and-bug-free)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Documentation](#documentation)
|
||||
- [Technical features](#technical-features)
|
||||
- [Integrated ruleset debugger](#integrated-ruleset-debugger)
|
||||
- [benchmarks](#benchmarks)
|
||||
- [Changelog](#changelog)
|
||||
- [Copyright and LICENSE](#copyright-and-license)
|
||||
|
||||
|
||||
#### Feature matrix metrics
|
||||
|
||||
Auth Redux is the most equilibrated faster authentication handler:
|
||||
|
||||
| Player Auth handler | re-joins | new join | set privilegies | database size | stability |
|
||||
| ------------------- | ------------ | ----------- | ------------ | ----------- | ------------ |
|
||||
| 5.0+ Builtin | 4.5 x Faster | 4 x Faster | 4.2 x Faster | 17% smaller | 100 x stable |
|
||||
| 0.4.X Builtin | 592 x Faster | 3 x Faster | 633 x Faster | 32% smaller | 1000 x stable |
|
||||
| sauth mod (sqlite) | 40 x Faster | 33x Faster | 48 x Faster | 32% smaller | 4 x stable |
|
||||
| SQLite Builtin | 30 x Faster | 23x Faster | 40 x Faster | 30% smaller | 4 x stable |
|
||||
| Redist Builtin | 8 x slower | 2 x slower | 1 x slower | unknow | 10 x stable |
|
||||
| PostgreSQL Builtin | 35 x Faster | 33x Faster | 40 x Faster | 30% smaller | 4 x stable |
|
||||
|
||||
#### Full lua based code
|
||||
|
||||
Auth Redux is completely Lua-driven, with no external dependencies. It
|
||||
interfaces seamlessly with Minetest's authentication handler API, therefore
|
||||
no complicated setup or configuration is required. It is intended to be
|
||||
compatible with all versions of Minetest 0.4.14+, providing server administrators
|
||||
with both flexible and fine-grained access control.
|
||||
|
||||
#### increased security and bug free
|
||||
|
||||
It addressing following long time bugs without complicated dependencies:
|
||||
|
||||
* #5334 https://github.com/minetest/minetest/issues/5334
|
||||
* #6783 https://github.com/minetest/minetest/issues/6783
|
||||
* #4451 https://github.com/minetest/minetest/issues/4451
|
||||
|
||||
#### Dependencies:
|
||||
|
||||
* default
|
||||
* formspecs (ActiveFormspecs Mod)
|
||||
|
||||
#### Documentation
|
||||
|
||||
Original documentation is on https://github.com/sorcerykid/auth_rx/wiki/Introduction
|
||||
|
||||
#### Technical features
|
||||
|
||||
* High-Performance Journaling System
|
||||
|
||||
To protect the master database against corruption and data loss, all
|
||||
transactions are serially recorded within a journal, thereby reducing the
|
||||
frequency and intensity of disk writes. In the event of a server crash or
|
||||
power outage, any pending transactions are committed to the master database.
|
||||
|
||||
* Stateful Rule-Based Login Filtering
|
||||
|
||||
MARS is an easy-to-learn scripting language that affords a first line of
|
||||
defense against unwanted visitors. Both restrictive and permissive security
|
||||
models can be enforced via rulesets, allowing every login request to be
|
||||
filtered according to conditional action-chains with custom error messages.
|
||||
|
||||
* Expanded Master Database Schema
|
||||
|
||||
The master database supports additional metadata to aid in reviewing and monitoring
|
||||
login activity, including the timestamp of the first login, the total time
|
||||
spent playing, the total number of player sessions, etc. This information
|
||||
can prove invaluable for command-line reporting and analysis tools.
|
||||
|
||||
#### Integrated ruleset debugger
|
||||
|
||||
By entering the `/fdebug` command into chat (requires the "server privilege"),
|
||||
you will be presented with a debugging console. The workspace consists of the
|
||||
following elements:
|
||||
|
||||
* A. The "Show Client Output" option toggles whether to display the client output
|
||||
panel. The "Show Debug Prompt" option toggles whether to insert debug status prompts
|
||||
into the source code.
|
||||
* B. This textarea contains the ruleset definition to be examined. Although Minetest
|
||||
supports editing of text, it is strongly recommended to copy and paste your source
|
||||
code into a full-fledged text editor.
|
||||
* C. The client output panel renders error messages as they would appear within the
|
||||
client. The status panel typically indicates whether the ruleset passed or failed,
|
||||
as well as other debugging conditions.
|
||||
* D. The "Save" button will export the current ruleset definition, overwriting
|
||||
"greenlist.mt" in your world directory. The "Load" button will import an existing
|
||||
ruleset definition from "greenlist.mt" for debugging.
|
||||
* E. The "Process" button will process the ruleset definition according to the
|
||||
selected login filtering criteria: Normal, New Account, or Wrong Password (thereby
|
||||
changing the relevant preset variables).
|
||||
* F. The preset variables are listed here with their corresponding values. These
|
||||
values will never change except during the login filtering process, or unless
|
||||
explicitly set in the panel below.
|
||||
* G. The name and type of the selected variable is indicated here. The value can be
|
||||
edited in the text field, and set with the "Set" button. The arrow buttons allow for
|
||||
re-ordering any variable within the list.
|
||||
|
||||
Some variables, like $clock and $uptime, have an "Auto Update" option to toggle whether
|
||||
the values should be derived from the system state. For a fully sandboxed environment,
|
||||
you can disable this option.
|
||||
|
||||
The special `$__debug` variable gives you direct access to the MARS expression
|
||||
interpreter. You can enter any valid expression, and the resulting value and type
|
||||
will be displayed in the panel above (all variable types, except patterns, are
|
||||
supported). This is particularly helpful for monitoring the values of certain
|
||||
variables. To calculate the size of the $ip_names_list, for example, you would enter
|
||||
|
||||
```
|
||||
size($ip_names_list)
|
||||
```
|
||||
|
||||
Whenever a ruleset passes or fails, or if a syntax error is encountered, a debug
|
||||
status prompt will be inserted into the source code below the line in question:
|
||||
|
||||
```
|
||||
if $name->len() eq "administrator"`
|
||||
# ====== ^ Line 12: Mismatched operands in ruleset^ ======
|
||||
```
|
||||
|
||||
These breakpoints will be removed automatically when the ruleset definition is saved,
|
||||
so there is no need to edit them out.
|
||||
|
||||
#### benchmarks
|
||||
|
||||
You can check the file [benchmark.txt](benchmark.txt) from where the
|
||||
comparisons were made.
|
||||
|
||||
As these benchmarks reveal, there is no discernible benefit to using an SQLite3
|
||||
backend for authentication over a flat-file database, whether in terms of
|
||||
reliability or performance.
|
||||
|
||||
The cons of using LEvelDB or REdist is the unstability of those fast storage
|
||||
authentication handlers, so auth_RX solves the problem and being more faster.
|
||||
|
||||
If anything, SQLite3/File/LevelDB databases are a hindrance when it comes to
|
||||
random access of large volumes of data, and more than likely the culprit for
|
||||
why some high-traffic servers lately are experiencing notable lag spikes
|
||||
|
||||
## Changelog
|
||||
|
||||
Please see [changelog](changelog) file
|
||||
|
||||
## Copyright and LICENSE
|
||||
|
||||
Copyright (c) 2016-2018, Leslie Krause (leslie@searstower.org)
|
||||
Copyright (c) 2020-2023, PICCORO Lenz McKAY (mckaygerhard@gmail.com)
|
||||
|
||||
**License of modified or added source code**
|
||||
|
||||
The auto initializer code and improvements were adde under CC BY-SA NC 4.0
|
||||
by mckaygerhard or "PICCORO" Lenz McKAY (mckaygerhard@gmail.com)
|
||||
|
||||
**License of original source files until 2018**
|
||||
|
||||
Auth Redux Mod v2.13 By Leslie Krause under The MIT License (MIT)
|
||||
|
||||
https://forum.minetest.net/viewtopic.php?f=9&t=20393
|
||||
|
||||
Repository
|
||||
----------------------
|
||||
Browse orignal source code: https://bitbucket.org/sorcerykid/auth_rx
|
||||
|
||||
Browse source code:
|
||||
https://bitbucket.org/sorcerykid/auth_rx
|
||||
Check the [LICENSE](LICENSE) file.
|
||||
|
||||
Download archive:
|
||||
https://bitbucket.org/sorcerykid/auth_rx/get/master.zip
|
||||
https://bitbucket.org/sorcerykid/auth_rx/get/master.tar.gz
|
||||
|
||||
Revision History
|
||||
----------------------
|
||||
|
||||
Version 2.1b (30-Jun-2018)
|
||||
- initial beta version
|
||||
- included code samples for basic login filtering
|
||||
- included a command-line database import script
|
||||
|
||||
Version 2.2b (04-Jul-2018)
|
||||
- added install option to database import script
|
||||
- improved exception handling by AuthFilter class
|
||||
- fixed parsing of number literals in rulesets
|
||||
- fixed type-checking of try statements in rulesets
|
||||
- included mod.conf and description.txt files
|
||||
|
||||
Version 2.3b (08-Jul-2018)
|
||||
- general code cleanup of AuthFilter class
|
||||
- moved datasets into separate directory of world
|
||||
- added two more comparison operators for rulesets
|
||||
- tweaked pattern matching behavior in rulesets
|
||||
- changed database search method to use Lua regexes
|
||||
- removed hard-coded file names from database methods
|
||||
|
||||
Version 2.4b (13-Jul-2018)
|
||||
- moved Journal and AuthDatabase classes into library
|
||||
- added rollback function to AuthDatabase class
|
||||
- reworked journal audit to support rollback option
|
||||
- better encapsulated database commit function
|
||||
- allowed for STOPPED opcode during database update
|
||||
- various changes to error and action messages
|
||||
- moved command-line scripts to separate directory
|
||||
- included script to rollback database via journal
|
||||
- included script to extract debug log into journal
|
||||
|
||||
Version 2.5b (17-Jul-2018)
|
||||
- implemented function parsing algorithm for rulesets
|
||||
- simplified operand matching logic in rulesets
|
||||
- improved transcoding of literals in rulesets
|
||||
- added some basic functions for use by rulesets
|
||||
- fixed validation of dataset names in rulesets
|
||||
|
||||
Version 2.6b (19-Jul-2018)
|
||||
- introduced support for array literals in rulesets
|
||||
- added array-related functions for use by rulesets
|
||||
- localized references to transcoding functions
|
||||
- registered chat command to control login filtering
|
||||
- included support for disabling login filtering
|
||||
- added reload function to AuthFilter class
|
||||
- tweaked lexer to skip comments on ruleset loading
|
||||
- added search function to AuthDatabase class
|
||||
|
||||
Version 2.7b (22-Jul-2018)
|
||||
- implemented time and date datatypes for rulesets
|
||||
- updated code samples with latest feature-set
|
||||
- added time-related functions for use by rulesets
|
||||
- added time-related variables for use by rulesets
|
||||
- minor formatting fixes to source code
|
||||
- optimized comparison algorithm in ruleset parser
|
||||
|
||||
Version 2.8b (24-Jul-2018)
|
||||
- introduced support for numeric patterns in rulesets
|
||||
- created polymorphic pattern-matching classes
|
||||
- excluded time-zone offsets in time/date comparisons
|
||||
- standardized timestamps for use in filter functions
|
||||
- removed daylight saving time from preset variables
|
||||
- updated comparison algorithm in ruleset parser
|
||||
- passed preset variables array to filter functions
|
||||
|
||||
Version 2.9b (26-Jul-2018)
|
||||
- implemented address datatype for rulesets
|
||||
- added more helper functions for use by rulesets
|
||||
- fixed missing syntax checks in ruleset parser
|
||||
- developed and integrated AuthWatchdog class
|
||||
- added meta-variables for stateful login filtering
|
||||
|
||||
Version 2.10b (29-Jul-2018)
|
||||
- major code reorganization via multiple libraries
|
||||
- removed extra variables from AuthFilter class
|
||||
- developed interactive debugger for testing rulesets
|
||||
- added optional debugger hooks in AuthFilter class
|
||||
- allowed for overriding preset variables by debugger
|
||||
- included line-number in results of login filter
|
||||
- added missing preset variable needed by rulesets
|
||||
|
||||
Version 2.11 (04-Aug-2018)
|
||||
- developed a command-line player analytics script
|
||||
|
||||
Version 2.12 (10-Aug-2018)
|
||||
- better code consolidation of AuthFilter class
|
||||
- reworked ruleset parser to support syntax changes
|
||||
|
||||
Version 2.13 (20-Aug-2018)
|
||||
- developed in-game database management console
|
||||
- combined generic filter functions into superclass
|
||||
- updated debugger to use new GenericFilter class
|
||||
- added flag for constant-value operands in rulesets
|
||||
- simplified operand matching logic in rulesets
|
||||
- optimized comparison algorithm in ruleset parser
|
||||
- consolidated lookup tables of lexical analyzer
|
||||
- fixed erroneous status message shown in debugger
|
||||
- added support for per-player debugging sessions
|
||||
- redesigned login filter APIs for new architecture
|
||||
- switched order of return values in login filter
|
||||
- various code refactoring and better comments
|
||||
|
||||
Installation
|
||||
----------------------
|
||||
|
||||
1) Unzip the archive into the mods directory of your game
|
||||
2) Rename the auth_rx-master directory to "auth_rx"
|
||||
3) Execute the "convert.awk" script (refer to instructions)
|
||||
|
||||
Source Code License
|
||||
----------------------
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016-2018, Leslie Krause (leslie@searstower.org)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
||||
software and associated documentation files (the "Software"), to deal in the Software
|
||||
without restriction, including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
||||
persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or
|
||||
substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
|
||||
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
DEALINGS IN THE SOFTWARE.
|
||||
|
||||
For more details:
|
||||
https://opensource.org/licenses/MIT
|
||||
|
||||
112
changelog
Normal file
112
changelog
Normal file
@ -0,0 +1,112 @@
|
||||
Revision History
|
||||
----------------------
|
||||
|
||||
Version 2.1b (30-Jun-2018)
|
||||
- initial beta version
|
||||
- included code samples for basic login filtering
|
||||
- included a command-line database import script
|
||||
|
||||
Version 2.2b (04-Jul-2018)
|
||||
- added install option to database import script
|
||||
- improved exception handling by AuthFilter class
|
||||
- fixed parsing of number literals in rulesets
|
||||
- fixed type-checking of try statements in rulesets
|
||||
- included mod.conf and description.txt files
|
||||
|
||||
Version 2.3b (08-Jul-2018)
|
||||
- general code cleanup of AuthFilter class
|
||||
- moved datasets into separate directory of world
|
||||
- added two more comparison operators for rulesets
|
||||
- tweaked pattern matching behavior in rulesets
|
||||
- changed database search method to use Lua regexes
|
||||
- removed hard-coded file names from database methods
|
||||
|
||||
Version 2.4b (13-Jul-2018)
|
||||
- moved Journal and AuthDatabase classes into library
|
||||
- added rollback function to AuthDatabase class
|
||||
- reworked journal audit to support rollback option
|
||||
- better encapsulated database commit function
|
||||
- allowed for STOPPED opcode during database update
|
||||
- various changes to error and action messages
|
||||
- moved command-line scripts to separate directory
|
||||
- included script to rollback database via journal
|
||||
- included script to extract debug log into journal
|
||||
|
||||
Version 2.5b (17-Jul-2018)
|
||||
- implemented function parsing algorithm for rulesets
|
||||
- simplified operand matching logic in rulesets
|
||||
- improved transcoding of literals in rulesets
|
||||
- added some basic functions for use by rulesets
|
||||
- fixed validation of dataset names in rulesets
|
||||
|
||||
Version 2.6b (19-Jul-2018)
|
||||
- introduced support for array literals in rulesets
|
||||
- added array-related functions for use by rulesets
|
||||
- localized references to transcoding functions
|
||||
- registered chat command to control login filtering
|
||||
- included support for disabling login filtering
|
||||
- added reload function to AuthFilter class
|
||||
- tweaked lexer to skip comments on ruleset loading
|
||||
- added search function to AuthDatabase class
|
||||
|
||||
Version 2.7b (22-Jul-2018)
|
||||
- implemented time and date datatypes for rulesets
|
||||
- updated code samples with latest feature-set
|
||||
- added time-related functions for use by rulesets
|
||||
- added time-related variables for use by rulesets
|
||||
- minor formatting fixes to source code
|
||||
- optimized comparison algorithm in ruleset parser
|
||||
|
||||
Version 2.8b (24-Jul-2018)
|
||||
- introduced support for numeric patterns in rulesets
|
||||
- created polymorphic pattern-matching classes
|
||||
- excluded time-zone offsets in time/date comparisons
|
||||
- standardized timestamps for use in filter functions
|
||||
- removed daylight saving time from preset variables
|
||||
- updated comparison algorithm in ruleset parser
|
||||
- passed preset variables array to filter functions
|
||||
|
||||
Version 2.9b (26-Jul-2018)
|
||||
- implemented address datatype for rulesets
|
||||
- added more helper functions for use by rulesets
|
||||
- fixed missing syntax checks in ruleset parser
|
||||
- developed and integrated AuthWatchdog class
|
||||
- added meta-variables for stateful login filtering
|
||||
|
||||
Version 2.10b (29-Jul-2018)
|
||||
- major code reorganization via multiple libraries
|
||||
- removed extra variables from AuthFilter class
|
||||
- developed interactive debugger for testing rulesets
|
||||
- added optional debugger hooks in AuthFilter class
|
||||
- allowed for overriding preset variables by debugger
|
||||
- included line-number in results of login filter
|
||||
- added missing preset variable needed by rulesets
|
||||
|
||||
Version 2.11 (04-Aug-2018)
|
||||
- developed a command-line player analytics script
|
||||
|
||||
Version 2.12 (10-Aug-2018)
|
||||
- better code consolidation of AuthFilter class
|
||||
- reworked ruleset parser to support syntax changes
|
||||
|
||||
Version 2.13 (20-Aug-2018)
|
||||
- developed in-game database management console
|
||||
- combined generic filter functions into superclass
|
||||
- updated debugger to use new GenericFilter class
|
||||
- added flag for constant-value operands in rulesets
|
||||
- simplified operand matching logic in rulesets
|
||||
- optimized comparison algorithm in ruleset parser
|
||||
- consolidated lookup tables of lexical analyzer
|
||||
- fixed erroneous status message shown in debugger
|
||||
- added support for per-player debugging sessions
|
||||
- redesigned login filter APIs for new architecture
|
||||
- switched order of return values in login filter
|
||||
- various code refactoring and better comments
|
||||
|
||||
Version 2.13.0 (20-Jul-2023)
|
||||
- nil player object check due problematic joins on incomplete auth process
|
||||
- added missing depends formspecs (it work without in basics but, some commands needs)
|
||||
- we will later aded formspecs checks to made optional
|
||||
- init the files when are fresh install, still do not convert from auth.txt if previous
|
||||
- improve the auth handler cos fails for recent versions of mineshit engine
|
||||
- fix deprecation warnings for fails handler of authentication player on recent engine
|
||||
Loading…
x
Reference in New Issue
Block a user