https://github.com/bfpimentel/flutter-security

https://github.com/bfpimentel/flutter-security

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bfpimentel/flutter-security
• Owner: bfpimentel
• License: mit
• Created: 2023-12-05T21:28:42.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-19T01:14:36.000Z (about 1 year ago)
• Last Synced: 2024-11-05T09:20:30.441Z (about 2 months ago)
• Language: Dart
• Size: 470 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Security: security/.gitignore

Awesome Lists containing this project

README

        
# Flutter Security Client

Stupid simple Security Client for storing encrypted data locally.

## About

This project uses SQLite as the database for the encrypted keys and, for the encryption part, it uses the SQLCipher layer through the sqflite lib.

## Installation

SecurityClient can be installed with a single command:

```

flutter pub add security_client

```

## Getting Started

An instance of SecurityClient can be created easily by passing just two params to its static constructor:

```dart

final SecurityClient securityClient = await SecurityClient.create("", "");

// e.g.

final SecurityClient securityClient = await SecurityClient.create("my-cool-database", "1234567890");

```

Multiple instances can be created at once since each client will use a separate database file for each one.

## API

For more information regarding all the available methods, the documentation can be found [here](https://bfpimentel.github.io/flutter-security/security/SecurityClient-class.html).

## Demo

The [demo](./demo) folder contains a demonstration of a SecurityClient's implementation.

To run the demo, you **must** pass an environment variable called `GLOBAL_SECURITY_CLIENT_PASSWORD` with any text value.

The demo project is using Redux for state management.

## Contributing

The SecurityClient development files is located in the root of this repository.

There aren't any special processes to this step, so to start contributing:

1. Have Flutter installed;

2. Clone the project;

3. Install the dependencies with `flutter pub get`.