Skip to content

Security Module

Cade edited this page Sep 20, 2022 · 1 revision

Overview

Server Module Overview

The security server module is the center of the entire system. It holds all the users as well as doors in it's drive as well as makes the decisions on whether a player is allowed through or not. Essentially the brain. This is the first thing you will install in your world everytime. It also logs all actions and inputs on it's screen, letting you see what is happening.

Functionality

  • Actions are color coded for easy understanding.

Logs

There are many functions that are logged in the server.

  • Received door parameters from id: #: A door was either started, created, or edited and it submitted it's settings to the server.
  • Checking if device is linked: this is an extra feature that doesn't have any documentation or programs with it yet, but programs can link to a user uuid to get their username for stuff. Site 91 uses it for ScD testing tablets, so tests go under their username only. This might be implemented publicly sometime soon.
  • Checking user...: This is when someone swipes their card. It is checking if they are allowed to go through. What comes after this is whether they are allowed in. It will either say access granted or access denied.

Installation

To install it, all you have to do is install the security module on the database, which will install it on the server.

Database Module Overview

The database is the main area where you can manage users, passes, and write cards. Without it, you wouldn't be able to do much. The database runs off of MineOS only at the moment, so it will require a mineos installation

Functionality

the database has many features that can take some time to understand.

MORE COMING SOON

Installation

Simply install the security module on the database.

Permissions

These are the following permissions you can use to allow/deny users access to certain features

"all" - access to everything on database including security and sector modules. "security.*" - access to all security and sector module features. "security.sector" - All sector module features "security.varmanagement" - All security module features (technically, I think this does it all) "security.passediting" - Same as varmanagement, but you cannot add/del/edit users, add/del/edit var types, write card/admin card, or reset uuid. "security.name" - Edit name of a user "security.writecard" - Write user to a card "security.admincard" - Write an admin card "security.resetuuid" - Reset card uuid (rendering previously written cards of that user useless) "security.link" - Link a special device (not public yet) to a user. "security.block" - Block cards from working temporarily "security.staff" - Give card staff permissions

If you create passes, you can then assign permissions for those passes by putting the var key at the end. For instance, if a pass was given the key "test", the permission would be "security.test"