#SafePhish SafePhish is a product and service being developed to provide small to medium businesses with a way of testing their employees' phishing scam awareness. It involves a Web Interface that clients can use to view test results and start new tests. It also has it's own Outlook Addin for reporting potential phishing scams for review.

###Development Notes

Utilizes Laravel PHP Framework
Utilizes the centralized controller PhishingController.php, to execute routes and processes.

#####Classes

• DBManager - Manages database connection using PDO
• Email - Executes an email process to send out a batch of emails to a database of users
• EmailConfiguration - Configuration object for maintaining all the necessary information to send an email
• TemplateConfiguration - Configuration object for maintaining all the necessary information to read and access a template
• User - User object
• Project - Projects are groupings to organize email sets sent out based on a specific task
• PDOIterator - Iterator class to iterate through a PDOStatement returned by a PDO Object or DBManager
• User_test - A Test User object being worked on to test best implementation of User object

#####Libraries

• RandomObjectGeneration - Basic Library include for common Random Generation methods

#####Exceptions

• ConfigurationException - Custom exception thrown from EmailConfiguration and TemplateConfiguration if error occurs
• EmailException - Custom exception thrown from Email if error occurs
• QueryException - Custom exception thrown from DBManager if error occurs after PDO Object instantiated

#####Templating Utilizes blade templating for all public facing pages.
Templates organized based on:

• Errors
• Forms
• Emails
  • Educational
  • Phishing
  • Errors
• Masters
• DataDisplays
• Authentication

Laravel PHP Framework

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.

Laravel is accessible, yet powerful, providing powerful tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.

Official Documentation

Documentation for the framework can be found on the Laravel website.

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

License

The Laravel framework is open-sourced software licensed under the MIT license