# protect

**Repository Path**: ibenz/protect

## Basic Information

- **Project Name**: protect
- **Description**: No description available
- **Primary Language**: Dart
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-16
- **Last Updated**: 2023-10-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# protect
  
  <a href="https://flutter.io">  
    <img src="https://img.shields.io/badge/Platform-Flutter-yellow.svg"  
      alt="Platform" />  
  </a> 
   <a href="https://pub.dartlang.org/packages/protect">  
    <img src="https://img.shields.io/pub/v/protect.svg"  
      alt="Pub Package" />  
  </a>
   <a href="https://opensource.org/licenses/MIT">  
    <img src="https://img.shields.io/badge/License-MIT-red.svg"  
      alt="License: MIT" />  
  </a>  
   <a href="https://www.paypal.me/kawal7415">  
    <img src="https://img.shields.io/badge/Donate-PayPal-green.svg"  
      alt="Donate" />  
  </a>
   <a href="https://github.com/justkawal/protect/issues">  
    <img src="https://img.shields.io/github/issues/justkawal/protect"  
      alt="Issue" />  
  </a> 
   <a href="https://github.com/justkawal/protect/network">  
    <img src="https://img.shields.io/github/forks/justkawal/protect"  
      alt="Forks" />  
  </a> 
   <a href="https://github.com/justkawal/protect/stargazers">  
    <img src="https://img.shields.io/github/stars/justkawal/protect"  
      alt="Stars" />  
  </a>
  <br>
  <br>
 
 [Protect](https://www.pub.dev/packages/protect) is a flutter and dart library for applying and removing password protection on excel files.



# Table of Contents
  - [Installing](#lets-get-started)
  - [Usage](#usage)
    * [Imports](#imports)
    * [Read xlsx file](#read-xlsx-file)
    * [Read xlsx file from Asset Folder](#read-xlsx-from-flutters-asset-folder)
    * [Apply password on xlsx file](#apply-password-protection-on-xlsx-file)
    * [Remove password on xlsx file](#remove-password-protection-on-xlsx-file)
    * [Saving xlsx file](#saving-xlsx-file)
    * [Also checkout our other libraries](#also-checkout-our-other-libraries)
  - [Donate (Be the First one)](#donate-be-the-first-one)

# Lets Get Started

### 1. Depend on it
Add this to your package's `pubspec.yaml` file:

```yaml
dependencies:
  protect: ^1.0.0
```

### 2. Install it

You can install packages from the command line:

with `pub`:

```css
$  pub get
```

with `Flutter`:

```css
$  flutter packages get
```

### 3. Import it

Now in your `Dart` code, you can use: 

````dart
    import 'package:protect/protect.dart';
````

# Usage

### Imports

````dart
    import 'dart:io';
    import 'package:protect/protect.dart';
    
````

### Read XLSX File

````dart
    var file = "Path_to_pre_existing_Excel_File/excel_file.xlsx";
    var unprotectedExcelBytes = await File(file).readAsBytes();
    or
  //var protectedExcelBytes = await File(file).readAsBytes();
    
````

### Read XLSX from Flutter's Asset Folder

````dart
    import 'package:flutter/services.dart' show ByteData, rootBundle;
    
    /* Your blah blah code here */
    
    ByteData data = await rootBundle.load("assets/existing_excel_file.xlsx");
    var bytes = data.buffer.asUint8List(data.offsetInBytes, data.lengthInBytes);
    var unprotectedExcelBytes = await File(file).readAsBytes();
    or
  //var protectedExcelBytes = await File(file).readAsBytes();
    
````

### Apply password protection on XLSX File
    
````dart  
  ///
  /// Applying password protection
  /// where `unprotectedExcelBytes` is the bytes of unprotected excel
  ///
  ProtectResponse encryptedResponse = await Protect.encryptUint8List(unprotectedUint8List, 'contact@kawal.dev');

  var data;
  if (encryptedResponse.isDataValid) {
    data = encryptedResponse.processedBytes;
  } else {
    print('Excel file used for applying password over it is corrupted');
  }
    
````

### Remove password protection on XLSX File
    
````dart  
  ///
  /// Applying password protection 
  /// where `protectedUint8List` is the bytes of encrypted excel
  ///
  ProtectResponse decryptedResponse = await Protect.decryptUint8List(protectedUint8List, 'contact@kawal.dev');
  
  var data;
  if (decryptedResponse.isDataValid) {
    data = decryptedResponse.processedBytes;
  } else {
    print('Either password is wrong for opening the excel file or the Excel file is corrupted');
  }
````
   
 ### Saving XLSX File
 
````dart
  // Save the Changes in file
  
  var outputPath = '/Path_to_excel_folder/form_encrypted_file.xlsx';
  await File(outputPath)
    ..create(recursive: true)
    ..writeAsBytes(data);
    
````

### Donate (Thanks for being kind)
  - [Paypal](https://www.paypal.me/kawal7415)