Skip to content

BUILD_LINUX.md

Latest commit

 

History

History
217 lines (159 loc) · 5.57 KB

BUILD_LINUX.md

File metadata and controls

217 lines (159 loc) · 5.57 KB

Building FadCrypt for Linux

Prerequisites

Install build dependencies:

sudo apt install python3 python3-pip python3-dev build-essential

# Install Python dependencies from the pinned requirements file
pip install -r requirements.txt
pip install pyinstaller

Build Steps

1. Build GUI Executable (onefile, console=False)

python3 -m PyInstaller FadCrypt_Linux.spec --clean --noconfirm

Creates: dist/fadcrypt (single executable file)

2. Build CLI Executable (onefile, console=True)

python3 -m PyInstaller FadCrypt_Linux_CLI.spec --clean --noconfirm

Creates: dist/fadcrypt-cli (single executable file)

3. Create .deb Package (includes both executables)

chmod +x build-deb.sh
./build-deb.sh

Creates: fadcrypt_<version>_amd64.deb

Note: Both executables are built in onefile mode (single self-extracting executable), providing:

  • ✅ Fast installation (only 2 files to copy)
  • ✅ Smaller .deb package size
  • ✅ Automatic extraction to /tmp at runtime
  • ✅ No dependency on bundle structure

The --clean --noconfirm flags ensure a fresh build without prompts.

Installation

From .deb package

sudo dpkg -i fadcrypt_<version>_amd64.deb

Manual installation (without package)

# Copy single-file executables
sudo cp dist/fadcrypt /usr/bin/
sudo cp dist/fadcrypt-cli /usr/bin/
sudo chmod 755 /usr/bin/fadcrypt
sudo chmod 755 /usr/bin/fadcrypt-cli

# Copy desktop files and icons
sudo cp debian/fadcrypt.desktop /usr/share/applications/
sudo cp debian/fadcrypt-cli.desktop /usr/share/applications/
sudo cp img/1.png /usr/share/pixmaps/fadcrypt.png
sudo cp img/fadcrypt_cli.png /usr/share/pixmaps/fadcrypt_cli.png

Usage

GUI Mode

  • From application menu: Search for "FadCrypt"
  • Or run: fadcrypt or fadcrypt --gui

CLI/TUI Mode

  • From application menu: Search for "FadCrypt CLI"
  • Or run: fadcrypt-cli or fadcrypt-cli --cli

Direct Commands

fadcrypt-cli --lock file       # Lock a file
fadcrypt-cli --unlock file     # Unlock a file
fadcrypt-cli --list            # List locked items

Package Structure

After installation, the .deb provides:

  • GUI Executable: /usr/bin/fadcrypt (single-file, self-extracting)
  • CLI Executable: /usr/bin/fadcrypt-cli (single-file, self-extracting)
  • Daemon Script: /usr/share/fadcrypt/elevated-daemon.py
  • Systemd Service: /etc/systemd/system/fadcrypt-elevated.service
  • Desktop Files:
    • /usr/share/applications/fadcrypt.desktop (GUI launcher)
    • /usr/share/applications/fadcrypt-cli.desktop (CLI launcher)
  • Icons:
    • /usr/share/pixmaps/fadcrypt.png (GUI)
    • /usr/share/pixmaps/fadcrypt_cli.png (CLI)
  • Documentation: /usr/share/doc/fadcrypt/
  • User Config: ~/.config/FadCrypt/
  • User Backups: ~/.local/share/FadCrypt/Backup/
  • Runtime Temp: /tmp/_MEI* (auto-cleaned on exit)

Note: Onefile executables extract dependencies to /tmp/_MEI* at runtime and clean up on exit. This provides fast installation while maintaining full functionality.

Daemon Service

The .deb package automatically installs and enables the systemd daemon:

# View status
sudo systemctl status fadcrypt-elevated.service

# View logs
sudo journalctl -u fadcrypt-elevated.service -f

# Restart service
sudo systemctl restart fadcrypt-elevated.service

# Stop service
sudo systemctl stop fadcrypt-elevated.service

# Start service
sudo systemctl start fadcrypt-elevated.service

Service Details:

  • Name: fadcrypt-elevated.service
  • Configuration: /etc/systemd/system/fadcrypt-elevated.service
  • Socket: /run/fadcrypt/elevated.sock

Auto-start (Monitoring Mode)

When you enable monitoring in FadCrypt GUI:

  1. Creates: ~/.config/autostart/FadCrypt.desktop
  2. Exec: fadcrypt --auto-monitor
  3. Will start automatically on next system boot

To disable:

  • Open FadCrypt GUI and click "Stop Monitoring"
  • Or delete: ~/.config/autostart/FadCrypt.desktop

File Protection Mechanism

How It Works

When you lock a file or folder:

  1. Backup: Original permissions saved to ~/.config/FadCrypt/permission_backups/
  2. Lock: Applied via daemon:
    • chmod 000 - Remove all permissions
    • chattr +i - Set immutable flag
  3. Encryption: File encrypted to .fadcrypt format (optional)

When you unlock:

  1. Immutability Removed: Daemon removes immutable flag
  2. Permissions Restored: Original permissions restored
  3. Decryption: .fadcrypt file decrypted (optional)

Security Notes

  • File operations require root privileges (handled by daemon)
  • Immutable flag prevents accidental deletion even by root
  • Permissions enforced at filesystem level
  • All operations are atomic and recoverable

Uninstall

sudo dpkg -r fadcrypt

This removes:

  • Both GUI and CLI binaries
  • Daemon service
  • Desktop files and icons
  • User config is preserved in ~/.config/FadCrypt/

Troubleshooting

Daemon not starting:

sudo journalctl -u fadcrypt-elevated.service -n 20
sudo systemctl restart fadcrypt-elevated.service

Permission denied errors:

# Ensure daemon is running
sudo systemctl status fadcrypt-elevated.service

# Check socket exists
ls -la /run/fadcrypt/

# Restart daemon
sudo systemctl restart fadcrypt-elevated.service

Development

For development and testing, run directly from source:

# Start the development daemon (test-only helper)
sudo python3 tests/start_daemon_dev.py

# Run GUI mode
python3 FadCrypt.py --gui

# Run CLI/TUI mode
python3 FadCrypt.py --cli

# Run with verbose logging
python3 FadCrypt.py --cli --verbose