Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

MindSafe

Your mind. Kept safe.

MindSafe by Aryawork is a secure, offline-first notebook/editor built with Rust and egui-eframe, designed so that ONLY you can access and read your data. Whether you’re writing ideas, keeping a personal journal, or storing sensitive information, this app ensures your words remain yours — private, secure, and under your control.

Features

Important

Your data remains secure—unless your password is exposed, guessed or your device is compromised/infected while the app is unlocked.

For details, explore the sections in the sidebar.

Transparency & AI Disclosure

Transparency & AI Disclosure

Transparency is the bedrock of security-critical software. We believe users have a right to know how the tools they trust with their data were constructed.

Development Composition

  • Core Logic & Security (80% Human / 20% AI): The architectural design, cryptographic implementation (including encryption flows and memory management), and core Rust logic are hand-written and human-audited. AI was utilized strictly as a “force multiplier” for generating repetitive boilerplate, standard definitions, and basic UI layouts. This ensures the security model remains the product of human intent and oversight.
  • Documentation (10% Human / 90% AI): To ensure our guides are comprehensive, readable, and well-structured, we leverage AI for drafting and formatting. However, every technical claim and instruction is human-verified for accuracy before publication.

Our Commitment: No Paywalls

MindSafe is built on the belief that privacy is a right, not a premium feature.

  • Permanent FOSS Status: We are committed to Free and Open Source Software principles. The core offline features of MindSafe—encryption, local notes, and backup—will never be locked behind a paywall or a subscription model.
  • The “Offline-First” Promise: You will never be forced to pay to access or export your own data.

Future Considerations

While the core app remains free, we may introduce a Optional Paid Cloud Sync service in the future for users who require seamless end-to-end encrypted synchronization across multiple devices. This would be an entirely optional value-add to cover server infrastructure and maintenance costs; the fundamental offline vault experience will always remain free of charge.

Technical Stack

MindSafe is built using a modern, systems-oriented stack that prioritizes memory safety, cryptographic integrity, and local performance, we ensure a lightweight footprint and a reduced attack surface.

Core Development

  • Language: Rust
    • Chosen for its “fearless concurrency” and memory safety guarantees. Rust eliminates common vulnerabilities such as buffer overflows and null pointer dereferences, which are critical for security-sensitive software.
  • GUI Framework: egui / eframe
    • An immediate-mode GUI library for Rust. It provides a highly responsive, hardware-accelerated interface. Because it is written in pure Rust, it allows for easy cross-platform compilation without heavy external dependencies.

Security & Cryptography

  • Encryption Algorithm: XChaCha20-Poly1305
    • A high-speed, stream-based authenticated encryption (AEAD) cipher. It is resistant to nonce-reuse issues and side-channel attacks, making it a robust choice for modern application security.
  • Password Hashing: Argon2id
    • Used for key derivation. Argon2id is the industry standard for protecting against GPU/ASIC-based brute-force attacks by utilizing memory-hard functions.
  • Cryptography Provider: RustCrypto
    • We utilize pure-Rust implementations of cryptographic primitives to ensure that our security stack is as transparent and auditable as the rest of our codebase.

Data Storage

  • Database: SQLite
    • The backend engine for every Workbook. SQLite is a serverless, zero-configuration, ACID-compliant database. Each Workbook is a standalone .db file, ensuring complete data portability and reliability.
  • Interface: rusqlite
    • A high-level, ergonomic wrapper for using SQLite within Rust, ensuring type safety and efficient query execution.

Documentation & Tooling

  • Documentation: mdBook
    • Our official documentation (including this page) is built using mdBook. This allows us to write documentation in Markdown and deploy it as a fast, searchable, and clean static site.
  • Build System: Cargo
    • The Rust package manager and build tool. It manages our dependencies and ensures reproducible builds across Windows, macOS, and Linux.

Technical Architecture Overview

The interaction between these components follows a strict isolation principle:

  1. UI Layer (egui): Handles user input and markdown rendering.
  2. Logic Layer (Rust): Manages state and triggers cryptographic operations.
  3. Security Layer (Argon2id/XChaCha20): Encrypts/Decrypts data in memory.
  4. Persistence Layer (SQLite): Writes the encrypted ciphertext to the local disk.

Installation

MindSafe is designed to be portable and lightweight. You can either download a pre-built binary or compile it yourself to verify the source code.

Windows

  1. Download the mindsafe-windows.zip from the Latest Releases.
  2. Extract the .zip file to a folder of your choice.
  3. Run mindsafe.exe to start the application.

Important

Since MindSafe is an independent open-source project, Windows SmartScreen may show a warning. You can click "More Info" > "Run Anyway" to proceed.

macOS (Universal)

Our macOS build is Universal, meaning it runs natively on both Intel and Apple Silicon (M1/M2/M3) chips.

  1. Download mindsafe-macos.dmg or the .tar.gz archive.
  2. Open the .dmg and drag MindSafe to your Applications folder.
  3. If the app is blocked by Gatekeeper, go to System Settings > Privacy & Security and click Open Anyway.

Linux

  1. Download mindsafe-linux.tar.gz.
  2. Ensure you have the necessary runtime dependencies installed. On Debian/Ubuntu-based systems: 
    sudo apt update
sudo apt install libgtk-3-0 libssl3 libsqlite3-0
  3. Extract the archive and run the mindsafe binary: 
    tar -xzf mindsafe-linux.tar.gz
./mindsafe

Build from Source

If you wish to audit the code or build for a different architecture, follow these steps.

1. Prerequisites

You will need the Rust toolchain installed. If you don’t have it:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2. Install System Dependencies

Depending on your OS, you may need specific development libraries:

  • Linux (Ubuntu/Debian): 
    sudo apt install libgtk-3-dev libssl-dev libsqlite3-dev pkg-config
  • macOS: No additional dependencies required beyond Xcode Command Line Tools.
  • Windows: Ensure you have the C++ Build Tools installed.

3. Clone and Build

# Clone the repository
git clone https://github.com/aryawork-com/MindSafe.git
cd mindsafe

# Build the release binary
cargo build --release

The compiled binary will be located in target/release/.

Verifying Authenticity

To ensure your download has not been tampered with, we provide SHA256 checksums for every release.

  1. Download the SHA256SUMS.txt file from the release page.
  2. Run the verification command in your terminal:
    • Linux/macOS: sha256sum -c SHA256SUMS.txt
    • Windows (PowerShell): Get-FileHash ./mindsafe-windows.zip (then compare with the text file).

Data Organization

MindSafe allows you to maintain completely different threat profiles or “identities” on a single device. The hierarchical structure is a key security feature. By separating data into isolated “Workbooks.”

MindSafe uses a three-tier organizational structure designed to balance logical flow with strict cryptographic isolation. This ensures that even if one area of your life is compromised, the others remain mathematically secure.

1. The Workbook (The Secure Perimeter)

The Workbook is the highest level of organization. Think of a Workbook as a completely independent “Vault” or “Account.”

  • Total Isolation: Each Workbook exists as a separate, unique database file (.db) on your disk. There is no shared data between them.
  • Independent Credentials: Every Workbook is protected by its own Master Password and its own unique set of Argon2id-derived encryption keys. You can have a “Work” Workbook with one password and a “Personal” Workbook with an entirely different one.
  • Multi-Identity Support: You can create an unlimited number of Workbooks. If you are forced to reveal the password to one Workbook, the data in your other Workbooks remains invisible and inaccessible, as they are not logically linked in the file system.
  • Hardware Portability: Because a Workbook is a self-contained encrypted file, you can move a specific Workbook (e.g., finances.db) to a hardware USB drive while keeping your journal.db on your local machine.

2. Notebooks (The Logical Folders)

Inside a single Workbook, you can create multiple Notebooks to categorize your information.

  • Categorization: Notebooks act as high-level “Folders” or “Projects” within your secure perimeter.
  • Structural Clarity: A Workbook can contain an unlimited number of Notebooks (e.g., “Project Alpha,” “Health Logs,” “Travel Plans”).
  • Shared Security Boundary: All Notebooks within a specific Workbook share the same Master Key. Once you unlock the Workbook, you have access to all the Notebooks contained inside it.

3. Notes (The Atomic Data)

The Note is the final layer where your content resides.

  • Markdown Support: Notes are written in Markdown, allowing for rich text formatting, lists, and code blocks while maintaining a clean, future-proof file format.
  • Per-Note Encryption: As detailed in our Security documentation, every Note is individually encrypted with a unique random nonce. Even though they live within the same Notebook, the cipher text for two identical notes will look completely different.
  • Version History: Every Note tracks its own evolution. You can roll back to previous versions of a specific note without affecting the rest of the Notebook or Workbook.

Organizational Summary Table

LevelScopeSecurity Property
WorkbookAccount / VaultUnique Database, Unique Password, Unique Keys.
NotebookProjects / CategoriesLogical grouping within the unlocked vault.
NoteIndividual EntryIndividually encrypted, supports Markdown and History.

Additional

MindSafe includes several automated systems designed to balance high-security protocols with a seamless writing experience. These features ensure that your data is preserved and protected even if you forget to manually save or lock your device.

Automated Safeguards

Adaptive Auto-Save

MindSafe eliminates the risk of data loss due to unexpected interruptions.

  • Configurable Intervals: You can define exactly how often the application commits changes to the encrypted database (e.g., every 30 seconds or 5 minutes).
  • Atomic Writes: Utilizing SQLite’s ACID-compliant architecture, auto-saves are “atomic,” meaning a save operation either completes fully or not at all, preventing file corruption during a power failure.

Session Auto-Lock

To protect against unauthorized physical access to an unattended device, MindSafe monitors user activity.

  • Idle Timeout: The application will automatically “lock” and zero-out session keys from memory after a user-defined period of inactivity.
  • Instant Re-Authentication: Once locked, the vault cannot be viewed or accessed without re-entering the master password to re-derive the encryption keys.

Scheduled Backups

Redundancy is a core pillar of data security.

  • Automated Redundancy: MindSafe can be configured to create encrypted copies of your entire vault at specified intervals.
  • Local Control: You choose the backup destination—whether it is a separate local folder or an external hardware drive. Like the primary database, these backups are fully encrypted and require your master password to restore.

Security Architecture

MindSafe is designed with a “Trust No One” philosophy. We assume the host environment could be compromised, and therefore implement multiple layers of defense to ensure your data remains encrypted and inaccessible to unauthorized parties.

Key Management & Derivation

The security of your vault starts with your master password, but your password is never used directly as an encryption key.

  • Argon2id Hardening: We use Argon2id, the winner of the Password Hashing Competition, to derive a Key Encryption Key (KEK) from your password. This algorithm is specifically designed to resist GPU-based brute-force attacks by requiring significant memory and time to compute.
  • Unique Master Key: A high-entropy Master Key is generated locally on your device. This key is “wrapped” (encrypted) using the Argon2id-derived key.
  • Key Regeneration: You have the option to rotate/regenerate your internal keys without losing your data, providing a path to recovery if you believe your secondary keys have been exposed. (coming soon)

Tip

Always keep a physical backup of your master password in a safe place.

Data Encryption (At Rest)

Every piece of information MindSafe stores is cryptographically transformed into meaningless noise for anyone without the key.

  • XChaCha20-Poly1305: We utilize this modern, “authenticated” encryption AEAD (Authenticated Encryption with Associated Data). It doesn’t just hide your text; it ensures the data hasn’t been tampered with or corrupted.
  • Per-Note Encryption: MindSafe does not use a single “bulk” encryption for the whole database. Every individual note is encrypted with its own unique random nonce. This prevents pattern analysis attacks (where an attacker could guess content based on repeating encrypted blocks).
  • SQLite Security: While we use SQLite for its reliability, the data stored within the tables is already encrypted at the application level before it ever hits the disk.

Active Protection (In Motion)

Security isn’t just about files on a disk; it’s about protecting data while the app is running.

  • Safe Copy (Encrypted Clipboard): When you copy text within MindSafe, we protect the system clipboard. The data is copied in an encrypted state, preventing “Clipboard Listeners” (malicious background apps) from stealing your sensitive snippets. It only decrypts when pasted back into a secure MindSafe environment.
  • Memory Zeroization: Sensitive secrets, such as your decrypted Master Key or plaintext notes, are wrapped in specialized Rust containers that “zero out” (overwrite with zeros) the memory as soon as the object is dropped. This mitigates “Cold Boot” attacks and forensic memory analysis.
  • No Persistence of Secrets: Your master password is never saved to disk, not even in an encrypted form.

Caution

MindSafe follows a Zero-Knowledge architecture. We do not have a “Forgot Password” feature. We do not store your keys. If you lose your master password, your data is mathematically impossible to recover.

Auditability & Integrity

  • Encrypted Activity Logs: MindSafe maintains a local ledger of sensitive actions, such as login attempts, registration, and configuration changes. These logs are encrypted using the same standard as your notes, allowing you to review the history of your vault’s security.
  • Version History: To protect against accidental data loss or “ransomware-style” overwriting, MindSafe keeps a cryptographically signed history of note changes, allowing you to roll back to a known-safe state.

Network-Isolated Architecture

MindSafe is built on an “Offline-First, Privacy-Always” model. To ensure your data remains on your device, we implement strict boundaries regarding network connectivity:

  • User-Triggered Updates Only: The application does not maintain a persistent internet connection. It only communicates with the network (GitHub API) if, and only if, the user explicitly clicks the “Check for Updates” button.
  • No Automatic Background Calls: There are no “heartbeat” signals, telemetry pings, or background update checks. The application remains entirely dormant and offline until you manually request an update check.
  • Zero Data Exfiltration Path: The networking logic is strictly scoped to fetching version metadata and binaries from GitHub. There is no code path within the application capable of transmitting your database, notes, or encryption keys to a remote server.
  • Auditability: Because MindSafe is open-source, any developer can verify that the network stack is used exclusively for the update mechanism and is not integrated into the note-handling or storage modules.

Important

When checking for updates, MindSafe only transmits the current version string to GitHub to compare it against the latest release. No personal identifiers or usage statistics are shared during this process.

Privacy

MindSafe is built on the principle of Data Sovereignty. We believe that your digital notes should be as private as a paper journal locked in a physical safe.

Local-Only Infrastructure

  • Device-Bound Storage: Every note, configuration setting, and cryptographic key is stored strictly on your local hardware. There is no central server, no “shadow” cloud syncing, and no hidden remote backups.
  • No Third-Party Dependencies: We do not use third-party storage providers or “Software as a Service” (SaaS) backends. You own the hardware; you own the data.
  • Portable Vaults: Your database is a single, encrypted SQLite file. You can move, back up, or delete it at any time without needing permission from a service provider.

Zero Telemetry Policy

  • No Usage Analytics: We do not track how many notes you write, how often you open the app, or which features you use. MindSafe does not contain any “phone home” code for usage statistics.
  • No Crash Reporting: Unlike many modern apps, MindSafe does not automatically upload crash logs to our servers. Any debugging information stays on your machine.
  • In-App Activity Logs: While the application maintains a security log (recording logins and config changes), these logs are encrypted and remain exclusively on your device. This feature is for your own audit purposes and can be disabled in the settings at any time.

Network Isolation

  • Offline by Default: MindSafe operates without an internet connection. It does not require a login to a web service, nor does it verify licenses online.
  • Controlled Updates: The only network activity initiated by the application is a manual check for updates, which occurs only when you click the “Check for Updates” button. This connection is strictly one-way (fetching version data from GitHub) and never transmits your personal data or note metadata.

Data Portability

Privacy also means the freedom to leave. MindSafe supports exporting your notes into standard formats like Markdown or Plain Text. Because we use a standard SQLite backend, your data is never “locked” into a proprietary ecosystem.

Threat Model

The following model evaluates the security of MindSafe against common adversary profiles and attack vectors.

1. The “Physical Thief” (High Protection)

  • Scenario: Your laptop is stolen while the app is closed.
  • Threat: The attacker has full disk access and attempts to read your sqlite database or configuration files.
  • MindSafe Defense: Because every note is encrypted with XChaCha20-Poly1305 and the Master Key is wrapped with Argon2id, the attacker sees only high-entropy ciphertext. Without your master password, the data is mathematically equivalent to random noise.
  • Status: Protected.

2. The “Forensic Investigator” (Medium/High Protection)

  • Scenario: An attacker gains access to your device and uses forensic tools to scan the RAM or unallocated disk space for remnants of deleted notes.
  • Threat: Sensitive data remains in memory after the app is closed or remains on the disk after a note is deleted.
  • MindSafe Defense: We utilize Memory Zeroization in Rust to overwrite sensitive buffers with zeros as soon as they are dropped. For disk remnants, the “History” feature ensures that even if old blocks exist, they remain encrypted.
  • Status: Protected (Limited only by OS-level swap file handling).

3. The “Clipboard Sniffer” (High Protection)

  • Scenario: You have a malicious background process or a “free” utility app installed that monitors your system clipboard to steal passwords or private text.
  • Threat: Copying a sensitive note to paste it elsewhere exposes the plaintext to the malicious app.
  • MindSafe Defense: The Safe Copy feature ensures that data residing in the clipboard is encrypted. Only a MindSafe-aware paste action can decrypt the content, leaving the “sniffer” with useless ciphertext.
  • Status: Protected.

4. The “Remote Data Siphoner” (Total Protection)

  • Scenario: A background process tries to “exfiltrate” (upload) your database to a remote server.
  • Threat: Stealthy data theft via the internet.
  • MindSafe Defense: MindSafe is built with a Hardened Offline Boundary. The application contains no networking code and does not link against network libraries. Even if an attacker moves the files, they remain encrypted (see Scenario 1).
  • Status: Protected.

5. The “OS-Level Compromise” (No Protection)

  • Scenario: Your operating system is infected with a Kernel-level keylogger or a screen-recorder.
  • Threat: The attacker records your keystrokes as you type your master password or takes screenshots of your decrypted notes while the app is open.
  • MindSafe Boundary: No application can fully protect against a compromised host Operating System. If your OS is infected at the kernel level, the attacker can see what you see on your screen.
  • Status: Out of Scope. (Users are advised to maintain OS integrity and use hardware-level security where possible).

6. The “Brute Force / Dictionary Attack” (High Protection)

  • Scenario: An attacker uses a supercomputer to guess millions of password combinations per second against your vault.
  • Threat: Cracking the master password.
  • MindSafe Defense: Argon2id is a memory-hard function. By forcing the CPU to use significant RAM and time for every single guess, we make large-scale brute-force attacks economically and computationally unfeasible.
  • Status: Protected.

Security Policy

MindSafe is built with a “Security-First” philosophy. We take every report seriously and appreciate the efforts of the security community to help keep our users’ data safe.

Supported Versions

We only provide security updates for the latest stable release. If you discover a vulnerability, please ensure you are testing against the most recent version available on the Releases page.

Reporting a Vulnerability

Caution

Please do not open a public GitHub Issue for security vulnerabilities.

To protect our users, we follow a strict Responsible Disclosure policy. If you find a security flaw, please report it privately using one of the following methods:

  1. Email: Send a detailed report to oss@aryawork.com with subject SECURITY - <Small Title>.
  2. GitHub Private Reporting: If enabled, use the “Report a vulnerability” button under the Security tab of this repository.

What to Include in Your Report

To help us triage and fix the issue quickly, please include:

  • A descriptive title of the vulnerability.
  • The version of MindSafe affected.
  • A Proof of Concept (PoC) or step-by-step instructions to reproduce the issue.
  • The potential impact (e.g., local data leak, bypass of the master password, etc.).

Our Process

  1. Acknowledgment: We will acknowledge receipt of your report within 48–72 hours.
  2. Investigation: We will investigate the issue and may contact you for further details.
  3. Fix: Once confirmed, we will work on a fix. We aim to resolve critical vulnerabilities within 14 days.
  4. Disclosure: After a fix is released, we will publicly disclose the vulnerability and credit you for the discovery (unless you prefer to remain anonymous).

Scope

In-Scope

  • Cryptographic flaws in the XChaCha20-Poly1305 or Argon2id implementation.
  • Memory leaks that expose plaintext notes or master keys after the app is locked.
  • Bypassing the “Safe Copy” (encrypted clipboard) mechanism.
  • Unauthorized local data access flaws.

Out-of-Scope

  • Attacks requiring a compromised Host Operating System (Keyloggers, Screen Recorders).
  • Physical attacks where the attacker knows the user’s master password.
  • Vulnerabilities in third-party crates (though we appreciate being informed so we can update them).
  • Issues related to the “Check for Update” network call that do not result in data exfiltration.

Rewards

As an independent open-source project, we do not currently offer a financial bug bounty program. However, we are happy to provide:

  • Public attribution in our release notes and CONTRIBUTORS.md.
  • A permanent place in our “Security Hall of Fame” within the documentation.

Performance

MindSafe is engineered for speed and stability. By leveraging low-level systems programming and a battle-tested storage engine, the application remains responsive even as your vault grows to thousands of notes.

Systems-Level Efficiency

  • Built with Rust: By using Rust, MindSafe achieves native execution speeds without the overhead of a heavy runtime or garbage collector. This ensures a “near-instant” startup time and minimal CPU usage during cryptographic operations.
  • Memory Safety: Rust’s strict ownership model prevents common memory-related crashes and vulnerabilities, ensuring that performance does not come at the cost of stability.
  • Lightweight Footprint: Packaged as a native desktop application for Windows, macOS, and Linux, MindSafe maintains a small disk and RAM footprint compared to Electron-based editors.

Robust Data Management

  • Powered by SQLite: We use SQLite as our primary storage engine. It is the most deployed database in the world, known for its extreme reliability and high-performance local data handling.
  • ACID Compliance: Your data is protected by Atomicity, Consistency, Isolation, and Durability (ACID) guarantees. This means that even in the event of a sudden power loss or system crash, your database remains uncorrupted and your notes remain safe.
  • Indexed Searching: Despite full-note encryption, MindSafe utilizes optimized indexing strategies to ensure that searching through your vault remains fluid and instantaneous.

Developer Setup

Follow these steps to configure your local environment and build MindSafe from source.

1. Install the Rust Toolchain

MindSafe requires the stable Rust compiler and cargo (Rust’s build system and package manager).

  • Universal Install: 
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Verification: Ensure your installation is active by checking the version: 
    rustc --version

2. System Dependencies

Depending on your operating system, you will need specific libraries to compile the egui interface and the SQLite backend.

Linux (Ubuntu/Debian)

You need the GTK, SSL, and SQLite development headers:

sudo apt update
sudo apt install -y libgtk-3-dev libssl-dev libsqlite3-dev pkg-config build-essential

macOS

Ensure you have the Xcode Command Line Tools installed:

xcode-select --clt

Windows

You must have the C++ Build Tools installed via the Visual Studio Installer. Select the “Desktop development with C++” workload during installation.

3. Clone the Repository

git clone https://github.com/aryawork-com/MindSafe.git
cd mindsafe

4. Building and Running

Development Build

To run the application in debug mode (faster compilation, slower execution):

cargo run

Release Build

To generate the optimized, production-ready binary:

cargo build --release

The resulting binary will be located at ./target/release/mindsafe (or mindsafe.exe on Windows).

5. Documentation (mdBook)

MindSafe uses mdBook for its documentation. To contribute to the docs:

  1. Install mdBook: 
    cargo install mdbook
  2. Navigate to the docs folder: 
    cd docs
  3. Serve locally: 
    mdbook serve --open
    This will start a local server at http://localhost:3000 that live-reloads as you edit the markdown files.

🧪 Running Tests

We maintain a suite of unit tests for the cryptographic logic and database operations.

cargo test

🛠️ Code Quality

Before submitting a Pull Request, please ensure your code follows the project’s formatting and linting standards:

# Format the code
cargo fmt

# Run the linter
cargo clippy -- -D warnings

Contribution Guidelines

Thank you for your interest in contributing to MindSafe. As a security-focused project, we maintain high standards for code quality, memory safety, and cryptographic implementation.

The Transparency Pact

As noted in our Transparency Disclosure, MindSafe is approximately 80% human-written. To maintain the integrity of our security model:

  • Logic & Security: We require all core logic, encryption flows, and database interactions to be human-audited.
  • AI Assistance: You may use AI for generating boilerplate, unit test structures, or UI layouts. However, any AI-generated code must be clearly identified in your Pull Request (PR) description and thoroughly audited by the contributor before submission.

Security-First Contributions

If your contribution affects the crypto, auth, or database modules:

  1. No Proprietary Cryptography: Do not implement custom “rolled” encryption. We only accept industry-standard primitives (e.g., RustCrypto crates).
  2. Zeroization: Ensure any new sensitive buffers (passwords, keys, plaintext) are wrapped in zeroizing containers to prevent memory leaks.
  3. Audit Requirement: PRs involving security logic require a “deep dive” review. Expect detailed questions regarding memory safety and side-channel resistance.

Development Workflow

1. Branching Strategy

  • main: The stable, production-ready branch. Never push directly to main.
  • stage: The integration branch for upcoming releases.
  • feature/your-feature: Create a descriptive branch from stage for your changes.

2. Pull Request Process

  1. Sync: Ensure your branch is rebased against the latest stage branch.
  2. Test: Run cargo test and ensure all suites pass. (if available)
  3. Lint: Run cargo fmt and cargo clippy. We do not accept PRs with clippy warnings in the core logic.
  4. Description: Your PR must include:
    • A summary of changes.
    • The problem it solves.
    • A disclosure of which parts (if any) used AI assistance.

Code Style

  • Follow standard Rust API Guidelines.
  • Use descriptive naming for variables and functions.
  • Document all public functions and structs using /// doc comments (this helps our mdBook generation).

Reporting Vulnerabilities

Do not open a public Issue for security vulnerabilities. If you discover a security flaw, please follow the instructions in our SECURITY.md file to report it privately to the maintainers. This allows us to coordinate a fix before the vulnerability is made public.

License

By contributing to MindSafe, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0).

Languages

  • English (Original)
  • Hindi (AI Generated)
  • Spanish (AI Generated)
  • French (AI Generated)
  • German (AI Generated)
  • Portuguese (AI Generated)
  • Italian (AI Generated)

Release 0.5

Released on

  1. Application Core
    • Main State
    • Page Routing
    • Modal Routing
    • Main State Zeroizing
  2. Pages
    • Register Page
    • Login Page
    • Editor Page
  3. Modal
    • Settings Modal
    • Change Password Modal
    • Change Master Key Modal
    • Update App Modal
  4. Languages
    • i18n Configuration
    • English Language
  5. Encryption
    • Master Key Derivation using Argon2id from Password
    • DB, File Key Derivation using HKDF, SHA512 from Master Key
    • Zeroizing DB, File, Master Key, Password, Nonce, Key, Salt
  6. Database
    • DatabaseService
    • Creating SQLCipher using Db Key
    • Migration Engine
  7. Configuration
    • Auto Save
    • Auto Lock
    • Main Directory
    • Backup Directory
    • Safe Copy
    • Syntax Highlight
    • Selected Language
    • Persistence in DB
    • Zeroizing Config
  8. Notes
    • Encyption of text using File Key via XChaCha20-Poly1305
    • Decryption of text using File Key
    • CRUD in DB notes table
    • Auto save text
    • Encrypted text history (recording only; display to be done in #28)
    • Zeroizing Notes
  9. Tabs Controller
    • Creating Core Engine
    • Tabs & Controller
  10. Activities (recording only; display to be done in #14)
    • Core Engine
    • Authentication
    • Configuration
    • CRUD
  11. Import
    • Import Notes from MD
    • Import Notes from TXT
  12. Workspace Feature
    • Create Default Workspace
    • Create New Workspace
    • Modify Name of Workspace
    • Delete Workspace
  13. Notebook Feature
    • Create Default Notebook
    • Create New Notebook
    • Modify Name of Notebook
    • Delete Notebook
  14. Safe Copy
    • Core Engine
    • Safe Paste
  15. Update
    • Check update via GitHub Releases API
  16. Backup
    • Backup DB & State to backup folder at intervals

Release 0.9

Releasing on

  1. Pages (Continued)
  • Activities Page
  1. Change Password
    • Core Engine
  2. Tabs Controller (Continued)
    • Getting Last Opened Tabs
    • Drag & Drop Tabs Index
  3. Tags
    • Core Engine
    • Notes Link
  4. Change Master Key

    Re-encypts all data (DB, Notes, config) with new key */

    • Core Engine
  5. Import (Continued)
    • Import all data from backups
  6. Export
    • Export Note as MD
    • Export Note as PDF
    • Export Notes with encryption
    • Export all notes as MD or PDF
  7. Search via Note Name
    • Core Engine

      Content search not feasible as all data is only decrypted when the note is accessed (for safety) even embeddings can be used to deduce the overall theme and topic, thus, not feasible

  8. Code Clean
    • Remove Clutter
    • Clean Functions
    • Remove unused code
    • Remove duplicate code
  9. Filter
    • Core Engine
    • Created Date Range
    • Updated Date Range
    • Tags
  10. SymLink (Link one note to another)
    • Core Engine
  11. Attach Files
    • Core Engine
    • Save Encrypted Files
  12. Security Audit
    • Memory Cleaning
    • Memory Locking for Keys
    • Side Channel attacks prevention
    • Secure protection
  13. Code Optimization
    • Memory Audit
    • Performance Audit
  14. Notes History Page
    • See all history
    • Manage diff and restore
    • Save history as new note

FOSS Compliance

FOSS Commitment & Licensing

Trust should never be blind. Because MindSafe handles your most sensitive data, we believe the source code must be available for public inspection, modification, and auditing.

Open Source Philosophy

MindSafe is strictly Free and Open Source Software (FOSS). This ensures:

  • Transparency: Anyone can verify our encryption implementation and “offline-only” claims.
  • Longevity: The community can maintain and fork the project, ensuring your notes are never trapped in a dead proprietary format.
  • Security: “Security through obscurity” is a myth; we rely on proven, peer-reviewed cryptographic standards.

Licensing

The entire codebase is released under the GNU Affero General Public License v3.0 or later (AGPL-3.0).

The AGPL-3.0 is a strong copyleft license. It ensures that if anyone modifies MindSafe and provides it as a service over a network, they must share their modified source code with the community. This protects the project from becoming a “closed” proprietary service and keeps the software free for everyone.

License

                GNU AFFERO GENERAL PUBLIC LICENSE
                   Version 3, 19 November 2007

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

                        Preamble

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.

A secondary benefit of defending all users’ freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.

The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.

An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.

The precise terms and conditions for copying, distribution and modification follow.

                   TERMS AND CONDITIONS
  1. Definitions.

“This License” refers to version 3 of the GNU Affero General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

  1. Source Code.

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

  1. Basic Permissions.

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

  1. Protecting Users’ Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

  1. Conveying Verbatim Copies.

You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

  1. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.

b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7.  This requirement modifies the requirement in section 4 to
"keep intact all notices".

c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy.  This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged.  This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

  1. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.

b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source.  This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.

d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge.  You need not require recipients to copy the
Corresponding Source along with the object code.  If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source.  Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

  1. Additional Terms.

“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or

e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or

f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.

All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

  1. Termination.

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

  1. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

  1. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

  1. Patents.

A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

  1. No Surrender of Others’ Freedom.

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

  1. Remote Network Interaction; Use with the GNU General Public License.

Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.

  1. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

  1. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  1. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

  1. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

                 END OF TERMS AND CONDITIONS

        How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a “Source” link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see https://www.gnu.org/licenses/.