Giter Club home page Giter Club logo

odas_notes_app's Introduction

Projekt ODAS

link github: https://github.com/isso1550/my_secure_app
W plik README specyfikacja elementów aplikacji, wbudowane dane (do ułatwienia testów) oraz wyjaśnienia dotyczące korzystania.
Samo działanie najważniejszych elementów aplikacji starałem się opisywać komentarzami w kodzie.
Aplikacja uruchamiana przez docker compose.

Rzeczywista specyfikacja (elementy obowiązkowe):

  • Szablon - Flask
  • Baza danych - sqlite3
  • Sanityzacja - bleach
  • Edycja notatek - markdown
  • Przechowywanie haseł - wielokrotne hashowanie sha256 z solą losowaną przy rejestracji
  • Szyfrowanie - AES w trybie CBC
    • W przypadku szyfrowania hasłem użytkownika hasło przekształcane na klucz funkcją PBKDF2
  • Logowanie użytkowników - flask login
  • Tymczasowa blokada konta za zbyt dużą ilość prób logowania w krótkim czasie
    • Użytkownik dostaje informacje, że zostało niewiele prób
    • Użytkownik może odblokować swoje konto przez wiadomość e-mail
  • Jakość hasła - entropia wyliczana na podstawie obszerności alfabetu i ilości znaków
    • Odrzucanie rejestracji w przypadku zbyt słabego hasła - definicja jakie hasło jest "za słabe" na podstawie własnego doświadczenia
  • Weryfikacja danych od użytkownika - sprawdzanie poprawności przy użyciu wyrażeń regularnych oraz sprawdzanie obecności konkretnych znaków w celu wykrycia konkretnych ataków (np. obecność znaku ' sprawia, że logger rejestruje podejrzaną akcję - możliwą próbę SQL Injection)
  • Przekazywanie danych użytkownika, kiedy nie jest zalogowany (na przykład e-mail do resetu hasła) - jwt

Dodatkowe elementy:

  • Logowanie działalności aplikacji do oddzielnej bazy danych przez moduł logger.py (utworzony przeze mnie)
    • Do przeglądania logów trzeba wejść do kontenera i uruchomić plik logger używając python-a (python3 logger.py)
  • Wyłączony nagłówek Server
  • Możliwość resetu hasła pod adresem /resetPassword

Dodatkowe informacje:

  • Sprawdzanie rzeczywistego formatu pliku przy użyciu biblioteki filetype
  • Wczytywanie sekretów przy użyciu dotenv

Podział na pliki:

  • notes_app - główna aplikacja flask
  • logger - odpowiada za tworzenie logów podczas działania aplikacji
  • login_ban_handler - odpowiada za funkcję blokowania użytkowników po zbyt wielu nieudanych próbach logowania
    • sprawdza ile nieudanych logowań wystąpiło w danym czasie, jeśli więcej niż dozwolone to zwraca informację żeby odrzucić logowanie użytkownika
  • notecrypt - odpowiada za szyfrowanie notatek
  • tools - zawiera funkcje do hashowania haseł, obliczania entropii oraz czyszczenia tekstu markdown przy użyciu bleach
  • /docker - zawiera pliki konfiguracyjne nginx (nginx.conf oraz default) i klucze, certyfikaty do obsługi https
  • .env - zawiera tylko "sekretne" parametry, konfiguracje są w plikach *.py
  • /user_pictures/notepics - przechowuje zdjęcia dołączane do notatek
  • /user_pictures/temp - służy do tymczasowego zapisywania pliku na czas sprawdzania jego formatu

Wbudowane dane

  • Użytkownicy (username, e-mail, hasło):
  • Notatki:
    • Zwykła prywatna notatka użytkownika bob - widoczna tylko dla bob
    • Zwykła publiczna notatka użytkownika admin - widoczna dla wszystkich
    • Szyfrowana publiczna notatka użytkownika bob - widoczna dla wszystkich znających hasło (hasło: parrot)
    • Niepubliczna notatka od użytkownika bob dla użytkownika friend - widoczna tylko dla tej dwójki (/render/4)

Wyjaśnienia dotyczące działania

  • Notatki dla wybranych użytkowników
    • Przy tworzeniu wybrać opcję prywatności "unlisted" i wpisać listę użytkowników mogących ją odczytać oddzielając nazwy przecinkami
    • Dostępna tylko przez link, nie wyświetla się w notatkach odbiorców

odas_notes_app's People

Contributors

isso1550 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.