From fce9e330113557f5eb813c238a25bddc52146182 Mon Sep 17 00:00:00 2001 From: Felix Prahl-Kamps Date: Sun, 22 Jul 2018 20:18:25 +0200 Subject: [PATCH] restructure --- README.md | 22 ++-- {Screenshots => images/Screenshots}/main.png | Bin .../Screenshots}/org-info-received.png | Bin .../Screenshots}/pub-key-received.png | Bin .../Screenshots}/scan-pub-key.png | Bin .../Screenshots}/sync-profile.png | Bin .../Screenshots}/upload.png | Bin images/mispbump.svg | 96 ++++++++++++++++++ 8 files changed, 107 insertions(+), 11 deletions(-) rename {Screenshots => images/Screenshots}/main.png (100%) rename {Screenshots => images/Screenshots}/org-info-received.png (100%) rename {Screenshots => images/Screenshots}/pub-key-received.png (100%) rename {Screenshots => images/Screenshots}/scan-pub-key.png (100%) rename {Screenshots => images/Screenshots}/sync-profile.png (100%) rename {Screenshots => images/Screenshots}/upload.png (100%) create mode 100644 images/mispbump.svg diff --git a/README.md b/README.md index ec66d5e..44157dd 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ + +![MispBump Logo](./images/mispbump.svg) + # MISPBump -With MISPBump it is easy to share events on your MISP instance with other instances. Instead of generating organisations, sync-users and sync-servers you scan only two QR-Codes and the job is done. +With MISPBump it is easy to synchronise events on different MISP instances. Instead of generating organisations, sync-users and sync-servers you only have to scan two QR-Codes and you are ready for syncing. # Security A key agreement is realized with Diffie Hellman (Elliptic Curve 256 Bit), sensible data is encrypted with AES. -(how are credentials stored in app, keystore?) - +TODO: how are credentials stored in app, keystore? # How does it work? -1. Main screen (no changes) - 1. Gather your organisation information from your MISP instance -![Gather Information](./Screenshots/sync-profile.png) +![Gather Information](./images/Screenshots/sync-profile.png) 1. Scan your partners generated public key and at the same time share yours -![Scan Public Key](./Screenshots/scan-pub-key.png) +![Scan Public Key](./images/Screenshots/scan-pub-key.png) 2. Validate the public key you scanned -![Public Key Received](./Screenshots/pub-key-received.png) +![Public Key Received](./images/Screenshots/pub-key-received.png) 3. After another scan the information you need to synchronise is securely transmitted to your phone -![Secure Info Received](./Screenshots/org-info-received.png) +![Secure Info Received](./images/Screenshots/org-info-received.png) 4. Upload the information to your own MISP instance -![Upload](./Screenshots/upload.png) +![Upload](./images/Screenshots/upload.png) 5. That's it! You are ready to share events across your instances -![Main Screen](./Screenshots/main.png) +![Main Screen](./images/Screenshots/main.png) diff --git a/Screenshots/main.png b/images/Screenshots/main.png similarity index 100% rename from Screenshots/main.png rename to images/Screenshots/main.png diff --git a/Screenshots/org-info-received.png b/images/Screenshots/org-info-received.png similarity index 100% rename from Screenshots/org-info-received.png rename to images/Screenshots/org-info-received.png diff --git a/Screenshots/pub-key-received.png b/images/Screenshots/pub-key-received.png similarity index 100% rename from Screenshots/pub-key-received.png rename to images/Screenshots/pub-key-received.png diff --git a/Screenshots/scan-pub-key.png b/images/Screenshots/scan-pub-key.png similarity index 100% rename from Screenshots/scan-pub-key.png rename to images/Screenshots/scan-pub-key.png diff --git a/Screenshots/sync-profile.png b/images/Screenshots/sync-profile.png similarity index 100% rename from Screenshots/sync-profile.png rename to images/Screenshots/sync-profile.png diff --git a/Screenshots/upload.png b/images/Screenshots/upload.png similarity index 100% rename from Screenshots/upload.png rename to images/Screenshots/upload.png diff --git a/images/mispbump.svg b/images/mispbump.svg new file mode 100644 index 0000000..67c294a --- /dev/null +++ b/images/mispbump.svg @@ -0,0 +1,96 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + M I S P + + +