diff --git a/SUMMARY.md b/SUMMARY.md index 869e858..98305d2 100755 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -12,4 +12,5 @@ * [Taxonomies](taxonomy/README.md) * [Galaxies](galaxy/README.md) - in progress * [Categories and Types](categories-and-types/README.md) +* [Synchronisation/Sharing](sharing/README.md) * [Appendices](appendices/README.md) diff --git a/sharing/README.md b/sharing/README.md new file mode 100644 index 0000000..c710042 --- /dev/null +++ b/sharing/README.md @@ -0,0 +1,145 @@ + + +## Sharing / Syncronisation + +* [Explanation](#users) +* [Setup](#setup) +* [Roles](#roles) +* [Tools](#tools) +* [Server Settings](#server-settings) + +* Misp's core functionality is sharing where everyone can be a consumer and/or a contributor/producer. +* Quick benefit without the obligation to contribute +* Low barrier access to get acquainted to the system + +##Concept + +![Scenario example](figures/MISP_scenario_example.png) + + +##Setu + +###Adding a server + +Servers can be added by users via + +~~~~ +https:///servers/add +~~~~ + +![Add Server](figures/add_server_1.png) + + +The Add Server Form has several input fields: + +![Add Server](figures/add_server_ui.png) + +1. Base URL + +The base-url to the external server you want to sync with. Example: https://foo.sig.mil.be + +2. Instance Name + +A name that will make it clear to your users what this instance is. For example: Organisation A's instance + +3. Remote Sync Organisation Type + +The organization having the external server you want to sync with. Example: BE + +4. Local Organisation + +5. Authkey + +You can find the authentication key on your profile on the external server. + +6. Push + +Allow the upload of events and their attributes. + +7. Pull + +Allow the download of events and their attributes from the server. + +8. Self Signed + +Click this, if you would like to allow a connection despite the other instance using a self-signed certificate (not recommended). (server certificate file still needed) + +9. Server certificate file + +You can also upload a certificate file if the instance you are trying to connect to has its own signing authority. (*.pem) + +10. Client certificate file + +You can also upload a certificate file if the instance you are trying to connect to has its own signing authority. (*.pem) + + + +###Test connection + +###Rules + +### + +##Collaboration + +### Proposals + +### Forums / Threats + +Forums can be used to discuss non event related topics. + +Discussions can be accessed on the top "Global Actions - List Discussions" + +and via URL: + +~~~~ +https:///threads/index +~~~~ + +![Discussions](figures/discussions.png) + +####Create a new Topic + +To create a new topic + +~~~~ +https:///posts/add +~~~~ + +![Start a topic](figures/discussions_start_topic.png) + +####Comment a topic + +A topic can be commented by any user + +~~~~ +https:///threads/view/ +~~~~ + + +### Comments to events + +In MISP ongoing events can be commented by every user. + +![Contact reporter](figures/comment_an_event.png) + + +### Contact a reporter + +This feature can be used to contact the person or the organisation that the person belongs to that has created the event. + +All E-Mails can be enforced to be encrypted + +![Contact reporter](figures/contact_reporter.png) + +### Receive alerts + +It is possible to get alerts via encrypted mail in the following cases: + +* published events by other user of the MISP instance +* events pushed to the MISP instance +* events pulled by the MISP instance + +These E-Mail alerts are an opt-in feature + +![Change user settings](figures/profile_receive_alerts.png) diff --git a/sharing/figures/MISP_scenario_example.png b/sharing/figures/MISP_scenario_example.png new file mode 100644 index 0000000..1ee9048 Binary files /dev/null and b/sharing/figures/MISP_scenario_example.png differ diff --git a/sharing/figures/add_server_1.png b/sharing/figures/add_server_1.png new file mode 100644 index 0000000..02431f2 Binary files /dev/null and b/sharing/figures/add_server_1.png differ diff --git a/sharing/figures/add_server_ui.png b/sharing/figures/add_server_ui.png new file mode 100644 index 0000000..9e2da57 Binary files /dev/null and b/sharing/figures/add_server_ui.png differ diff --git a/sharing/figures/comment_an_event.png b/sharing/figures/comment_an_event.png new file mode 100644 index 0000000..eb20e3b Binary files /dev/null and b/sharing/figures/comment_an_event.png differ diff --git a/sharing/figures/contact_reporter.png b/sharing/figures/contact_reporter.png new file mode 100644 index 0000000..e328f08 Binary files /dev/null and b/sharing/figures/contact_reporter.png differ diff --git a/sharing/figures/discussions.png b/sharing/figures/discussions.png new file mode 100644 index 0000000..2815929 Binary files /dev/null and b/sharing/figures/discussions.png differ diff --git a/sharing/figures/discussions_add_post.png b/sharing/figures/discussions_add_post.png new file mode 100644 index 0000000..d105eb7 Binary files /dev/null and b/sharing/figures/discussions_add_post.png differ diff --git a/sharing/figures/discussions_start_topic.png b/sharing/figures/discussions_start_topic.png new file mode 100644 index 0000000..f7b558e Binary files /dev/null and b/sharing/figures/discussions_start_topic.png differ diff --git a/sharing/figures/list_servers.png b/sharing/figures/list_servers.png new file mode 100644 index 0000000..d00cf7f Binary files /dev/null and b/sharing/figures/list_servers.png differ diff --git a/sharing/figures/profile_receive_alerts.png b/sharing/figures/profile_receive_alerts.png new file mode 100644 index 0000000..d2dbbf6 Binary files /dev/null and b/sharing/figures/profile_receive_alerts.png differ