First commit with base concept.

Author: dave83649

.gitignore

@@ -3,6 +3,9 @@
 # Learn more about .gitignore:
 #     https://www.atlassian.com/git/tutorials/saving-changes/gitignore
 
+# PHP artifact files
+vendor/
+
 # Node artifact files
 node_modules/
 dist/

README.md

@@ -1,29 +1,22 @@
-# README #
+# Patchstack Firewall Engine #
 
-This README would normally document whatever steps are necessary to get your application up and running.
+This repository contains the firewall engine of Patchstack.
+It can be implemented inside of other content management systems to provide firewall functionality.
 
-### What is this repository for? ###
+## How do I get set up? ##
 
-* Quick summary
-* Version
-* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+Due to library limitations and the way the firewall engine works, a few manual interactions are required. Since the firewall engine depends on the opis/closure and laravel/serializable-closure packages which both require different PHP versions, sticking to one PHP version is tricky.
 
-### How do I get set up? ###
+Therefore, in order to use this package, these libraries must exist in the following locations:
+* opis/closure at /vendor/closure/
+* laravel/serializable-closure at /vendor/serializable-closure/
 
-* Summary of set up
-* Configuration
-* Dependencies
-* Database configuration
-* How to run tests
-* Deployment instructions
+## To-Do List ##
+- ⬜️ Unit tests
+- ⬜️ Test on many different environments and combinations with other plugins
+- ⬜️ Attach PHP CS Fixer
+- ✅ First initial concept and implementation
 
-### Contribution guidelines ###
+## Who do I talk to? ##
 
-* Writing tests
-* Code review
-* Other guidelines
-
-### Who do I talk to? ###
-
-* Repo owner or admin
-* Other community or team contact
+* dave.jong@patchstack.com

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "patchstack/firewall",
+    "description": "The firewall engine of Patchstack.",
+    "type": "library",
+    "require": {
+        "php": ">=5.4"
+    },
+    "license": "GNU AGPLv3",
+    "autoload": {
+        "psr-4": {
+            "Patchstack\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Patchstack",
+            "email": "support@patchstack.com"
+        }
+    ]
+}

composer.lock

@@ -0,0 +1,67 @@
+<?php
+
+namespace Patchstack\Extensions;
+
+/**
+ * Any extension must implement the methods of the interface.
+ * Some CMS systems might implement some of the logic completely different than others.
+ */
+interface ExtensionInterface
+{
+    /**
+     * Log the request, this can be of type BLOCK, LOG or REDIRECT.
+     * 
+     * @param int $ruleId
+     * @param string $bodyData
+     * @param string $blockType
+     * @return void
+     */
+    public function logRequest($ruleId, $bodyData, $blockType);
+
+    /**
+     * Determine if the current visitor can bypass the firewall.
+     * 
+     * @return bool
+     */
+    public function canBypass();
+
+    /**
+     * Determine if the visitor is blocked from the website.
+     * 
+     * @param int $minutes
+     * @param int $blockTime
+     * @param int $attempts
+     * @return bool
+     */
+    public function isBlocked($minutes, $blockTime, $attempts);
+
+    /**
+     * Force exit the page when a request has been blocked.
+     * 
+     * @param int $ruleId
+     * @return void
+     */
+    public function forceExit($ruleId);
+
+    /**
+     * Get the IP address of the request.
+     * 
+     * @return string
+     */
+    public function getIpAddress();
+
+    /**
+     * Determine if the request should be passed without going through the firewall.
+     * 
+     * @param array $whitelistRules
+     * @param array $request
+     */
+    public function isWhitelisted($whitelistRules, $request);
+
+    /**
+     * Determine if the current request is a file upload request.
+     * 
+     * @return boolean
+     */
+    public function isFileUploadRequest();
+}