Skip to main content

flutter_security_suite 1.2.0 copy "flutter_security_suite: ^1.2.0" to clipboard
flutter_security_suite: ^1.2.0 copied to clipboard

Flutter security plugin: root/jailbreak and tamper detection, certificate pinning, biometrics, app lock, secure token storage, screen capture and clipboard protection.

example/lib/main.dart

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter_security_suite/flutter_security_suite.dart';

void main() => runApp(const SecureBankKitDemo());

class SecureBankKitDemo extends StatelessWidget {
  const SecureBankKitDemo({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'flutter_security_suite Demo',
      theme: ThemeData(
        colorSchemeSeed: Colors.indigo,
        useMaterial3: true,
      ),
      home: const HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  const HomePage({super.key});

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  late final SecureBankKit _kit;
  SecurityStatus? _lastStatus;
  final List<_LogEntry> _log = [];
  bool _screenshotProtectionEnabled = false;
  StreamSubscription<ScreenCaptureEvent>? _captureSub;
  late final SessionManager _session;
  late final AppLockManager _appLock;

  @override
  void initState() {
    super.initState();
    _kit = SecureBankKit.initialize(
      enableRootDetection: true,
      enableAppIntegrity: true,
      enableEmulatorDetection: true,
      enableScreenRecordingDetection: true,
      enableTamperDetection: true,
      enableRuntimeProtection: true,
      enableLogging: true,
    );

    _captureSub = _kit.screenCapture.events.listen(
      (event) => _addLog(
        event.type == ScreenCaptureEventType.screenshot
            ? 'πŸ“Έ Screenshot taken'
            : 'πŸŽ₯ Screen capture: ${event.isCaptured}',
      ),
      onError: (Object e) => _addLog('Capture stream error: $e', isError: true),
    );

    _session = _kit.createSessionManager(timeout: const Duration(minutes: 5));
    _session.onSessionExpired.listen(
      (_) => _addLog('⏱ Session expired β€” tokens wiped', isError: true),
    );

    _appLock = _kit.createAppLockManager(
      gracePeriod: const Duration(seconds: 10),
      reason: 'Unlock the demo',
    )..start();
    _appLock.lockStateChanges.listen(
      (locked) => _addLog(locked ? 'πŸ”’ App locked' : 'πŸ”“ App unlocked'),
    );
  }

  @override
  void dispose() {
    _captureSub?.cancel();
    _session.dispose();
    _appLock.dispose();
    super.dispose();
  }

  void _addLog(String message, {bool isError = false}) {
    setState(() => _log.insert(0, _LogEntry(message, isError: isError)));
  }

  // ── Security Check ─────────────────────────────────────────────────────────

  Future<void> _runSecurityCheck() async {
    _addLog('β–Ά Running full security check…');
    final status = await _kit.runSecurityCheck();
    setState(() => _lastStatus = status);

    _addLog(
        '  isSecure:              ${_icon(status.isSecure, invert: false)}  ${status.isSecure}');
    _addLog(
        '  isRooted:              ${_icon(!status.isRooted)}  ${status.isRooted}');
    _addLog(
        '  isEmulator:            ${_icon(!status.isEmulator)}  ${status.isEmulator}');
    _addLog(
        '  isScreenBeingRecorded: ${_icon(!status.isScreenBeingRecorded)}  ${status.isScreenBeingRecorded}');
    _addLog(
        '  isTampered:            ${_icon(!status.isTampered)}  ${status.isTampered}');
    _addLog(
        '  isRuntimeHooked:       ${_icon(!status.isRuntimeHooked)}  ${status.isRuntimeHooked}');
    _addLog(
        '  appIntegrityValid:     ${_icon(status.isAppIntegrityValid)}  ${status.isAppIntegrityValid}');
    _addLog(
        '  certPinningValid:      ${_icon(status.isCertificatePinningValid)}  ${status.isCertificatePinningValid}');
    _addLog('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
  }

  String _icon(bool good, {bool invert = true}) => good ? 'βœ“' : 'βœ—';

  // ── Screenshot Protection ──────────────────────────────────────────────────

  Future<void> _toggleScreenshotProtection() async {
    final enable = !_screenshotProtectionEnabled;
    final result = enable
        ? await _kit.screenshotProtection.enable()
        : await _kit.screenshotProtection.disable();

    result.fold(
      onSuccess: (_) {
        setState(() => _screenshotProtectionEnabled = enable);
        _addLog('Screenshot protection ${enable ? "enabled" : "disabled"}');
      },
      onFailure: (e) =>
          _addLog('Screenshot protection error: ${e.message}', isError: true),
    );
  }

  // ── Tamper: signature hash ─────────────────────────────────────────────────

  Future<void> _getSignatureHash() async {
    _addLog('β–Ά Retrieving signing certificate hash…');
    final result = await _kit.tamperDetection.getSignatureHash();
    result.fold(
      onSuccess: (hash) => _addLog('  SHA-256: ${hash ?? "(null)"}'),
      onFailure: (e) => _addLog('  Error: ${e.message}', isError: true),
    );
  }

  // ── Secure Storage ─────────────────────────────────────────────────────────

  Future<void> _testSecureStorage() async {
    _addLog('β–Ά Testing secure storage…');

    final writeResult = await _kit.secureStorage.write(
      key: 'demo_token',
      value: 'jwt_abc123',
    );
    writeResult.fold(
      onSuccess: (_) => _addLog('  Write: OK'),
      onFailure: (e) => _addLog('  Write error: ${e.message}', isError: true),
    );

    final readResult = await _kit.secureStorage.read(key: 'demo_token');
    readResult.fold(
      onSuccess: (v) => _addLog('  Read:  $v'),
      onFailure: (e) => _addLog('  Read error: ${e.message}', isError: true),
    );

    final deleteResult = await _kit.secureStorage.delete(key: 'demo_token');
    deleteResult.fold(
      onSuccess: (_) => _addLog('  Delete: OK'),
      onFailure: (e) => _addLog('  Delete error: ${e.message}', isError: true),
    );
  }

  // ── Anti-tamper ────────────────────────────────────────────────────────────

  Future<void> _checkAntiTamper() async {
    _addLog('β–Ά Anti-tamper check…');
    final result = await _kit.antiTamper.check();
    result.fold(
      onSuccess: (s) => _addLog(
        '  debugger: ${s.isDebuggerAttached}, '
        'injected libs: ${s.hasInjectedLibraries}',
        isError: s.isCompromised,
      ),
      onFailure: (e) => _addLog('  Error: ${e.message}', isError: true),
    );
  }

  // ── Pasteboard ─────────────────────────────────────────────────────────────

  Future<void> _copySensitive() async {
    final result = await _kit.pasteboard.copy(
      '4111 1111 1111 1111',
      expiresAfter: const Duration(seconds: 15),
    );
    result.fold(
      onSuccess: (_) => _addLog('πŸ“‹ Copied β€” clears itself in 15s'),
      onFailure: (e) => _addLog('Copy error: ${e.message}', isError: true),
    );
  }

  // ── Biometrics & app lock ──────────────────────────────────────────────────

  Future<void> _authenticate() async {
    final availability = await _kit.biometrics.checkAvailability();
    availability.fold(
      onSuccess: (a) => _addLog('β–Ά Biometrics: $a'),
      onFailure: (e) => _addLog('Biometrics: ${e.message}', isError: true),
    );
    final result = await _kit.biometrics.authenticate(
      reason: 'Confirm it is you',
    );
    result.fold(
      onSuccess: (ok) => _addLog(ok ? '  Authenticated' : '  Cancelled'),
      onFailure: (e) =>
          _addLog('  Auth error [${e.code}]: ${e.message}', isError: true),
    );
  }

  Future<void> _lockAndUnlock() async {
    _appLock.lock();
    final result = await _appLock.unlock();
    result.fold(
      onSuccess: (ok) {
        if (!ok) _addLog('  Unlock cancelled');
      },
      onFailure: (e) => _addLog('  Unlock error: ${e.message}', isError: true),
    );
  }

  // ── Tokens & session ───────────────────────────────────────────────────────

  Future<void> _testTokens() async {
    _addLog('β–Ά Token lifecycle…');
    await _kit.tokenStorage.saveTokens(
      accessToken: 'access-old',
      refreshToken: 'refresh-1',
    );
    await _kit.tokenExpiry.setExpiresIn(const Duration(seconds: 30));
    _session.startSession();

    final result = await _kit.tokenExpiry.refreshIfNeeded(
      (refreshToken) async => RefreshedTokens(
        accessToken: 'access-new',
        expiresAt: DateTime.now().add(const Duration(hours: 1)),
      ),
      buffer: const Duration(minutes: 1),
    );
    result.fold(
      onSuccess: (token) => _addLog(
        '  Token in use: ${SecurityLogger.redact(token, visibleEnd: 3)}',
      ),
      onFailure: (e) => _addLog('  Refresh error: ${e.message}', isError: true),
    );
    _addLog('  Session active: ${_session.isActive}');
  }

  Future<void> _endSession() async {
    final result = await _session.endSession();
    _addLog(
      result.isSuccess ? '  Session ended, tokens cleared' : '  End failed',
      isError: result.isFailure,
    );
  }

  // ── UI ─────────────────────────────────────────────────────────────────────

  @override
  Widget build(BuildContext context) {
    final status = _lastStatus;
    return Scaffold(
      appBar: AppBar(
        title: const Text('flutter_security_suite'),
        actions: [
          if (status != null)
            Padding(
              padding: const EdgeInsets.only(right: 16),
              child: Chip(
                label: Text(
                  status.isSecure ? 'SECURE' : 'THREAT DETECTED',
                  style: const TextStyle(
                    color: Colors.white,
                    fontWeight: FontWeight.bold,
                    fontSize: 12,
                  ),
                ),
                backgroundColor: status.isSecure
                    ? Colors.green.shade700
                    : Colors.red.shade700,
              ),
            ),
        ],
      ),
      body: Listener(
        onPointerDown: (_) => _session.recordActivity(),
        child: Column(
          children: [
            // ── Status cards ──────────────────────────────────────────────────
            if (status != null) _StatusGrid(status: status),

            // ── Action buttons ────────────────────────────────────────────────
            ConstrainedBox(
              constraints: BoxConstraints(
                maxHeight: MediaQuery.sizeOf(context).height * 0.4,
              ),
              child: SingleChildScrollView(
                padding:
                    const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
                child: Wrap(
                  spacing: 8,
                  runSpacing: 8,
                  children: [
                    FilledButton.icon(
                      onPressed: _runSecurityCheck,
                      icon: const Icon(Icons.security),
                      label: const Text('Full Security Check'),
                    ),
                    FilledButton.tonal(
                      onPressed: _toggleScreenshotProtection,
                      child: Text(
                        _screenshotProtectionEnabled
                            ? 'Disable Screenshot Protection'
                            : 'Enable Screenshot Protection',
                      ),
                    ),
                    OutlinedButton.icon(
                      onPressed: _getSignatureHash,
                      icon: const Icon(Icons.fingerprint),
                      label: const Text('Get Signature Hash'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _testSecureStorage,
                      icon: const Icon(Icons.lock),
                      label: const Text('Test Secure Storage'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _checkAntiTamper,
                      icon: const Icon(Icons.bug_report),
                      label: const Text('Anti-Tamper'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _copySensitive,
                      icon: const Icon(Icons.content_copy),
                      label: const Text('Secure Copy'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _authenticate,
                      icon: const Icon(Icons.face),
                      label: const Text('Biometric Auth'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _lockAndUnlock,
                      icon: const Icon(Icons.lock_clock),
                      label: const Text('Lock + Unlock'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _testTokens,
                      icon: const Icon(Icons.key),
                      label: const Text('Token Lifecycle'),
                    ),
                    OutlinedButton.icon(
                      onPressed: _endSession,
                      icon: const Icon(Icons.logout),
                      label: const Text('End Session'),
                    ),
                  ],
                ),
              ),
            ),

            const Divider(height: 1),

            // ── Log output ────────────────────────────────────────────────────
            Expanded(
              child: _log.isEmpty
                  ? const Center(
                      child: Text(
                        'Tap "Full Security Check" to begin',
                        style: TextStyle(color: Colors.grey),
                      ),
                    )
                  : ListView.builder(
                      padding: const EdgeInsets.fromLTRB(16, 8, 16, 16),
                      itemCount: _log.length,
                      itemBuilder: (context, index) {
                        final entry = _log[index];
                        return Text(
                          entry.message,
                          style: TextStyle(
                            fontFamily: 'monospace',
                            fontSize: 12,
                            color: entry.isError ? Colors.red : null,
                          ),
                        );
                      },
                    ),
            ),
          ],
        ),
      ),
    );
  }
}

// ── Status grid widget ────────────────────────────────────────────────────────

class _StatusGrid extends StatelessWidget {
  final SecurityStatus status;

  const _StatusGrid({required this.status});

  @override
  Widget build(BuildContext context) {
    final checks = [
      _Check('Rooted', !status.isRooted, Icons.phone_android),
      _Check('Emulator', !status.isEmulator, Icons.computer),
      _Check('Recording', !status.isScreenBeingRecorded, Icons.videocam_off),
      _Check('Tampered', !status.isTampered, Icons.verified_user),
      _Check('Runtime Hook', !status.isRuntimeHooked, Icons.code_off),
      _Check('App Integrity', status.isAppIntegrityValid, Icons.check_circle),
    ];

    return Padding(
      padding: const EdgeInsets.fromLTRB(16, 12, 16, 4),
      child: Wrap(
        spacing: 8,
        runSpacing: 8,
        children: checks.map((c) => _CheckChip(check: c)).toList(),
      ),
    );
  }
}

class _Check {
  final String label;
  final bool passed;
  final IconData icon;

  const _Check(this.label, this.passed, this.icon);
}

class _CheckChip extends StatelessWidget {
  final _Check check;

  const _CheckChip({required this.check});

  @override
  Widget build(BuildContext context) {
    final color = check.passed ? Colors.green.shade700 : Colors.red.shade700;
    return Chip(
      avatar: Icon(check.icon, size: 16, color: color),
      label: Text(
        check.label,
        style:
            TextStyle(fontSize: 11, color: color, fontWeight: FontWeight.w600),
      ),
      side: BorderSide(color: color),
      backgroundColor: color.withValues(alpha: 0.08),
      padding: const EdgeInsets.symmetric(horizontal: 4),
    );
  }
}

// ── Log entry model ───────────────────────────────────────────────────────────

class _LogEntry {
  final String message;
  final bool isError;

  const _LogEntry(this.message, {this.isError = false});
}
3
likes
140
points
901
downloads

Documentation

Documentation
API reference

Publisher

unverified uploader

Weekly Downloads

Flutter security plugin: root/jailbreak and tamper detection, certificate pinning, biometrics, app lock, secure token storage, screen capture and clipboard protection.

Repository (GitHub)
View/report issues

Topics

#security #biometrics #root-detection #certificate-pinning #tamper-detection

License

MIT (license)

Dependencies

crypto, flutter

More

Packages that depend on flutter_security_suite

Packages that implement flutter_security_suite