diff --git a/README.md b/README.md index 4a6d387..133d7d0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ # Domain Security -=================== -# Budowanie -Aby aplikacja dzialala niezbedne jest srodowisko python 3 z blibliotekami: +## Opis problemu +W dużych przedsiębiorstwach zarządzanie dostępem do witryn jest podstawowym narzędziem poprawiającym cyberbezpieczeństwo. Wraz z rozrostem takich list coraz ciężej jest zachować ich aktualność. Cyberprzestępcy mogą to wykorzystać, wykupując domeny o niegdyś dobrej reputacji. Niezbędy jest system, który będzie w stanie monitorować informacje o bezpieczeńswie stron, najlpiej agregująć wiele źródeł. + +## Opis rozwiązania +Aplikacja służy do zarządzania whitelistami i blacklistami z domenami. Globalna lista śledzi wszystkie zapisane domeny i na bierząco aktualizuje informacje o ich bezpieczeństwie. Robi to na podstawie informacji o lukach w zabezpieczeniach z serwisów Talos i Shodan. Dzieki temu użytkownicy aplikacji mają bierzący podgląd na bezpieczeństwo stron blokowanych i przepuszczanych. Dzięki możliwości dowolnego kształtowania formatu wyjściowego list, mogą być one przystosowane zarówno do przetworzenia przez systemy komputerowe, jak i człowieka (Np. w formie pliku html z linkami). System umożlwia mapowanie wiele do wielu, co pozwala zarówno serwować jedną listę w wielu formatach, jak i wiele list w jednym formacie. Umożliwia o minimalizacje redundancji. + +## Budowanie +Aby aplikacja dzialala, niezbedne jest srodowisko python 3 z blibliotekami: - pymysql - talos (Biblioteka ulatwiajaca parsowanie danych z talosinteligence) - shodan (analogiczna dla serwiso shodan.io). @@ -11,4 +16,10 @@ Aby skompilwoac projekt nalezy wywolac komende ```bash [admin@linux gowebapp]$ go build ``` -z katalogu glownego projektu. +z katalogu glownego projektu. Należy mieć na uwadze, żeby GO_PATH kierowało na ten właśnie folder. + +## Uruchamianie +Serwer uruchamia się ze zbudowanego pliku wykonywalnego gowebapp +```bash +[admin@linux gowebapp]$ ./gowebapp +```