Search packages, repositories and app categories

GitHub repositorybennyboer/diary

Diary

Digital diary with state-of-the-art encryption

Diary project cover
Stars
8
Forks
2
Last push (UTC)
Jan 8, 2023
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

Diary

A digital diary with state-of-the-art encryption.

Calendar

Editor

Background

I feel like the days of traditional diaries are over. Not only are they inconvenient to carry around, but they are also not very secure. Thus, I decided to create a digital diary that is secure and easy to use.

Technology

The project is a local Desktop application that stores all data on the local file system. All files in the repository are encrypted using the ChaCha20-Poly1305 cipher which uses a 256-Bit key. That is plenty to protect your diary for the next years. The key is derived from a password using the Argon2 algorithm, which is currently the recommended algorithm. You can only decrypt the diary again using the same password. In the future we might add support for a second factor like a FIDO2 key that offers a higher level of security.

If you want to save your data in the cloud you can bind a directory to a cloud storage service like Dropbox or Google Drive. Since your data is encrypted and the cloud service private your diary should be safe from prying eyes.

Installation

Build it yourself
cd client
flutter build windows

You'll find the executable in client/build/windows/runner/Release/.

Build Installer
flutter pub run msix:create

Usage

The app currently consists of a simple calendar that just shows whether a day has an entry or not. When clicking on the day in the calendar you'll be able to either create a new entry or edit an existing one (if you know the password for decryption at least).

The encrypted diary entries are stored under your home directory in a folder named .diary.

Getting started

Prerequisites
  • Install Rust
  • Install Flutter
  • Install LLVM (https://pub.dev/packages/ffigen#installing-llvm)
Rebuilding Flutter <> Rust bridge

Run ./tools/build_bridge.sh or ./tools/build_bridge.bat depending on your OS

Benjamin Michel GitHub avatar
GitHub author

Benjamin Michel ↗

Working as a full-stack developer at Yolawo.

Yolawo GmbHMunichOfficial website ↗
LanguagesDartC++CMakeRustCShellBatchfile

Categories

Flutter dependencies

App categories

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗