diff --git a/app/BUGS.txt b/BUGS.txt similarity index 100% rename from app/BUGS.txt rename to BUGS.txt diff --git a/app/COPYRIGHT b/COPYRIGHT similarity index 78% rename from app/COPYRIGHT rename to COPYRIGHT index dec33928d..3689bbac3 100644 --- a/app/COPYRIGHT +++ b/COPYRIGHT @@ -1,5 +1,5 @@ -Copyright Belgian Defence CERT -Copyright NCIRC +Copyright Belgian Defence +Copyright NATO / NCIRC Developers: Christophe Vandeplas diff --git a/app/INSTALL.sysop.txt b/INSTALL/INSTALL.sysop.txt similarity index 100% rename from app/INSTALL.sysop.txt rename to INSTALL/INSTALL.sysop.txt diff --git a/app/README.txt b/INSTALL/INSTALL.txt similarity index 100% rename from app/README.txt rename to INSTALL/INSTALL.txt diff --git a/app/INSTALL.ubuntu.txt b/INSTALL/INSTALL.ubuntu.txt similarity index 100% rename from app/INSTALL.ubuntu.txt rename to INSTALL/INSTALL.ubuntu.txt diff --git a/app/INSTALL.vhost.txt b/INSTALL/INSTALL.vhost.txt similarity index 100% rename from app/INSTALL.vhost.txt rename to INSTALL/INSTALL.vhost.txt diff --git a/app/MYSQL.analysis.sql b/INSTALL/MYSQL.analysis.sql similarity index 100% rename from app/MYSQL.analysis.sql rename to INSTALL/MYSQL.analysis.sql diff --git a/app/MYSQL.blacklist.sql b/INSTALL/MYSQL.blacklist.sql similarity index 100% rename from app/MYSQL.blacklist.sql rename to INSTALL/MYSQL.blacklist.sql diff --git a/app/MYSQL.change_pw.sql b/INSTALL/MYSQL.change_pw.sql similarity index 100% rename from app/MYSQL.change_pw.sql rename to INSTALL/MYSQL.change_pw.sql diff --git a/app/MYSQL.perm_auth.sql b/INSTALL/MYSQL.perm_auth.sql similarity index 100% rename from app/MYSQL.perm_auth.sql rename to INSTALL/MYSQL.perm_auth.sql diff --git a/app/MYSQL.regexp.sql b/INSTALL/MYSQL.regexp.sql similarity index 100% rename from app/MYSQL.regexp.sql rename to INSTALL/MYSQL.regexp.sql diff --git a/app/MYSQL.role.sql b/INSTALL/MYSQL.role.sql similarity index 100% rename from app/MYSQL.role.sql rename to INSTALL/MYSQL.role.sql diff --git a/app/MYSQL.sql b/INSTALL/MYSQL.sql similarity index 100% rename from app/MYSQL.sql rename to INSTALL/MYSQL.sql diff --git a/app/build/patches/app_Config_bootstrap.php.diff b/INSTALL/build/patches/app_Config_bootstrap.php.diff similarity index 100% rename from app/build/patches/app_Config_bootstrap.php.diff rename to INSTALL/build/patches/app_Config_bootstrap.php.diff diff --git a/app/build/patches/app_Config_core.php.diff b/INSTALL/build/patches/app_Config_core.php.diff similarity index 100% rename from app/build/patches/app_Config_core.php.diff rename to INSTALL/build/patches/app_Config_core.php.diff diff --git a/app/build/patches/app_Config_database.php.diff b/INSTALL/build/patches/app_Config_database.php.diff similarity index 100% rename from app/build/patches/app_Config_database.php.diff rename to INSTALL/build/patches/app_Config_database.php.diff diff --git a/app/build/patches/app_Config_email.php.diff b/INSTALL/build/patches/app_Config_email.php.diff similarity index 100% rename from app/build/patches/app_Config_email.php.diff rename to INSTALL/build/patches/app_Config_email.php.diff diff --git a/app/build/patches/app_Config_routes.php.diff b/INSTALL/build/patches/app_Config_routes.php.diff similarity index 100% rename from app/build/patches/app_Config_routes.php.diff rename to INSTALL/build/patches/app_Config_routes.php.diff diff --git a/app/build/patches/app_Controller_AppController.php.diff b/INSTALL/build/patches/app_Controller_AppController.php.diff similarity index 100% rename from app/build/patches/app_Controller_AppController.php.diff rename to INSTALL/build/patches/app_Controller_AppController.php.diff diff --git a/app/build/patches/app_Controller_PagesController.php.diff b/INSTALL/build/patches/app_Controller_PagesController.php.diff similarity index 100% rename from app/build/patches/app_Controller_PagesController.php.diff rename to INSTALL/build/patches/app_Controller_PagesController.php.diff diff --git a/app/build/patches/app_View_Helper_AppHelper.php.diff b/INSTALL/build/patches/app_View_Helper_AppHelper.php.diff similarity index 100% rename from app/build/patches/app_View_Helper_AppHelper.php.diff rename to INSTALL/build/patches/app_View_Helper_AppHelper.php.diff diff --git a/app/build/patches/app_View_Layouts_Emails_html_default.ctp.diff b/INSTALL/build/patches/app_View_Layouts_Emails_html_default.ctp.diff similarity index 100% rename from app/build/patches/app_View_Layouts_Emails_html_default.ctp.diff rename to INSTALL/build/patches/app_View_Layouts_Emails_html_default.ctp.diff diff --git a/app/build/patches/app_View_Layouts_Emails_text_default.ctp.2.1.3.diff b/INSTALL/build/patches/app_View_Layouts_Emails_text_default.ctp.2.1.3.diff similarity index 100% rename from app/build/patches/app_View_Layouts_Emails_text_default.ctp.2.1.3.diff rename to INSTALL/build/patches/app_View_Layouts_Emails_text_default.ctp.2.1.3.diff diff --git a/app/build/patches/app_View_Layouts_Emails_text_default.ctp.diff b/INSTALL/build/patches/app_View_Layouts_Emails_text_default.ctp.diff similarity index 100% rename from app/build/patches/app_View_Layouts_Emails_text_default.ctp.diff rename to INSTALL/build/patches/app_View_Layouts_Emails_text_default.ctp.diff diff --git a/app/build/patches/app_View_Layouts_default.ctp.diff b/INSTALL/build/patches/app_View_Layouts_default.ctp.diff similarity index 100% rename from app/build/patches/app_View_Layouts_default.ctp.diff rename to INSTALL/build/patches/app_View_Layouts_default.ctp.diff diff --git a/app/build/patches/app_webroot_css_cake.generic.css.diff b/INSTALL/build/patches/app_webroot_css_cake.generic.css.diff similarity index 100% rename from app/build/patches/app_webroot_css_cake.generic.css.diff rename to INSTALL/build/patches/app_webroot_css_cake.generic.css.diff diff --git a/app/build/patches/app_webroot_css_cake.generic.css.unclean.diff b/INSTALL/build/patches/app_webroot_css_cake.generic.css.unclean.diff similarity index 100% rename from app/build/patches/app_webroot_css_cake.generic.css.unclean.diff rename to INSTALL/build/patches/app_webroot_css_cake.generic.css.unclean.diff diff --git a/app/build/patches/app_webroot_index.php.diff b/INSTALL/build/patches/app_webroot_index.php.diff similarity index 100% rename from app/build/patches/app_webroot_index.php.diff rename to INSTALL/build/patches/app_webroot_index.php.diff diff --git a/app/build/patches/lib_Cake_View_MediaView.php.diff b/INSTALL/build/patches/lib_Cake_View_MediaView.php.diff similarity index 100% rename from app/build/patches/lib_Cake_View_MediaView.php.diff rename to INSTALL/build/patches/lib_Cake_View_MediaView.php.diff diff --git a/app/build/technical_design/TD-ACL.txt b/INSTALL/build/technical_design/TD-ACL.txt similarity index 100% rename from app/build/technical_design/TD-ACL.txt rename to INSTALL/build/technical_design/TD-ACL.txt diff --git a/app/build/technical_design/TD-Audit.txt b/INSTALL/build/technical_design/TD-Audit.txt similarity index 100% rename from app/build/technical_design/TD-Audit.txt rename to INSTALL/build/technical_design/TD-Audit.txt diff --git a/app/build/technical_design/TD-forum.txt b/INSTALL/build/technical_design/TD-forum.txt similarity index 100% rename from app/build/technical_design/TD-forum.txt rename to INSTALL/build/technical_design/TD-forum.txt diff --git a/INSTALL/documentation1.pdf b/INSTALL/documentation1.pdf new file mode 100644 index 000000000..97f14b51e Binary files /dev/null and b/INSTALL/documentation1.pdf differ diff --git a/INSTALL/documentation2_user_management.pdf b/INSTALL/documentation2_user_management.pdf new file mode 100644 index 000000000..b7b47a3d6 Binary files /dev/null and b/INSTALL/documentation2_user_management.pdf differ diff --git a/INSTALL/documentation3_using_the_system.pdf b/INSTALL/documentation3_using_the_system.pdf new file mode 100644 index 000000000..04f728165 Binary files /dev/null and b/INSTALL/documentation3_using_the_system.pdf differ diff --git a/INSTALL/documentation4_administration.pdf b/INSTALL/documentation4_administration.pdf new file mode 100644 index 000000000..d04dea822 Binary files /dev/null and b/INSTALL/documentation4_administration.pdf differ diff --git a/INSTALL/documentation5_categories_and_types.pdf b/INSTALL/documentation5_categories_and_types.pdf new file mode 100644 index 000000000..e42082d01 Binary files /dev/null and b/INSTALL/documentation5_categories_and_types.pdf differ diff --git a/app/LICENSE b/LICENSE similarity index 100% rename from app/LICENSE rename to LICENSE diff --git a/README.md b/README.md new file mode 100644 index 000000000..901a3e2c1 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +MISP - Malware Information Sharing Platform +=========================================== + +Copyright: The copyright holders are the Belgian Defence and NATO / NCIRC. +License: Affero General Public License v3 + +Goal +---- +A huge challenge in the Cyber Security domain is the information sharing inside and between organizations. +This platform has as goal to facilitate: +* storing technical and non-technical information about seen malwares and attacks +* automatically creating relations between malwares and events +* storing data in a structured format (allowing automated use of the database for various purposes) +* generating IDS rules that can be imported on IDS systems (network, host) +* sharing the information with other parties and trust-groups +* storing locally all information from other instances + +To have a better idea what the platform does have a look at the PDF files in the INSTALL directory. + +Documentation +------------- +Make sure you read the documentation in the INSTALL directory. +We are currently consolidating the documentation, so it will be updated often. + +This part of the code is a major rewrite of a first version of the codebase.