🔐 Safe Keyboard Flutter

A secure and privacy-focused keyboard plugin for Flutter, designed to prevent text input leaks and enhance security when handling sensitive data (e.g., passwords, PINs). 🚀

---

⚠️🚨 IMPORTANT NOTICE 🚨⚠️

This plugin does not guarantee 100% protection against leaks and interception. However, it significantly complicates the process of extracting complete sensitive data from memory dumps. 🛡️

---

📢 Why Use This Plugin?

Flutter’s default TextField can leak input data due to the way it interacts with the native platform. This plugin helps mitigate such issues by ensuring secure text entry and preventing sensitive data from lingering in memory.

🔍 More about the problem:
Check this detailed research on security leaks in Flutter's TextField:
Exploring the security leakage issue in Flutter

---

✅ Features

• 🛡️ Reduces memory leaks from Flutter's TextField
• 🚀 Easy integration with existing TextField
• 🔒 Designed for secure text input handling
• 🏴‍☠️ Complicates data retrieval from memory dumps

---

📦 Installation

Add the package to your pubspec.yaml:

dependencies:
  safe_keyboard_flutter: latest_version

Then run:

flutter pub get

---

🛠️ How to Use

1️⃣ Basic Setup

To use SafeKeyboardFlutter, you need to set up the keyboard controller and handle input events.

final _passwordSafeKeyboardEditingController = SafeKeyboardEditingController(
  text: 'random',
  textEditingController: TextEditingController(),
  focusNode: FocusNode(),
);

SafeKeyboardFlutter(
  controller: _passwordSafeKeyboardEditingController,
  child: TextFormField(
    controller: _passwordSafeKeyboardEditingController.textEditingController,
    obscureText: _obscurePassword,
    focusNode: _passwordSafeKeyboardEditingController.focusNode,
    decoration: InputDecoration(
      labelText: "Password",
      prefixIcon: const Icon(Icons.lock_outline),
      suffixIcon: IconButton(
        icon: Icon(_obscurePassword ? Icons.visibility_off : Icons.visibility),
        onPressed: () {
          setState(() {
            _obscurePassword = !_obscurePassword;
          });
        },
      ),
      border: OutlineInputBorder(borderRadius: BorderRadius.circular(12)),
    ),
    keyboardType: TextInputType.none, // ❗ This is required for SafeKeyboardFlutter to work properly
  ),
);

@override
void dispose() {
  _passwordSafeKeyboardEditingController.dispose();
  super.dispose();
}

---

📊 Platform Support

Platform	Support Status
🚧 Android	In Development
❌ iOS	Planned
❌ Web	Not Supported
❌ MacOS	Not Supported
❌ Windows	Not Supported
❌ Linux	Not Supported

🚀 Currently, the focus is on Android due to its unique security challenges. iOS support is planned for future releases.

---

⚠️ What Problems Does This Solve?

🚨 The Security Issue with Default TextField

By default, Flutter's TextField can leak sensitive data because:

1. Keyboard apps can log user input.
2. Input is stored in system buffers, which third-party apps might access.
3. Flutter's text input mechanism does not immediately clear sensitive data from memory, creating potential leakage risks.

Check this article for a deep dive:
Security Leak in Flutter TextField

🔐 How safe_keyboard_flutter Helps

• Clears sensitive input data from memory immediately after use 🔏
• Prevents keyboard input logging 🛡️
• Forces secure input handling in sensitive fields (passwords, PINs) 🔑
• Complicates memory dump analysis, making data harder to extract 🔍

---

📢 Building New API

To generate a new API, run the following command:

dart run pigeon \
  --input pigeons/keyboard_api.dart \
  --dart_out lib/src/keyboard_api.dart \
  --kotlin_out android/src/main/kotlin/com/robotoss/safe_keyboard_flutter/KeyboardApi.kt \
  --kotlin_package "com.robotoss.safe_keyboard_flutter"

---

🤝 Contributing

We welcome contributions! If you have ideas or found issues, feel free to:

• Open a GitHub Issue 🛠️
• Submit a pull request 📬

---

⚖️ License

This project is licensed under the BSD-3-Clause License. See LICENSE for details.