flutter_sodium - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #go #android #deep-learning #nodejs #macos #java #windows #cli #awesome-list #vue #mcp

flutter_sodium

(★ 104)

Flutter bindings for libsodium

File Explorer

Download Latest Version (.zip)

- .gitignore
- build.gradle
- gradle.properties
- settings.gradle
- - .gitignore
  - build.gradle
  - gradle.properties
  - gradlew
  - gradlew.bat
  - settings.gradle
- - .gitignore
  - Podfile
  - Podfile.lock
- - main.dart
  - sample_widget.dart
  - samples.dart
  - toc.dart
  - topic_page.dart
- - Podfile
- - widget_test.dart
- .gitignore
- .metadata
- example.md
- flutter_sodium_example.iml
- pubspec.yaml
- README.md
- - FlutterSodiumPlugin.h
  - FlutterSodiumPlugin.m
- .gitignore
- flutter_sodium.podspec
- libsodium.a
- - cha_cha20_poly1305.dart
  - cha_cha20_poly1305_ietf.dart
  - crypto_auth.dart
  - crypto_box.dart
  - crypto_sign.dart
  - crypto_stream.dart
  - detached_cipher.dart
  - extensions.dart
  - generic_hash.dart
  - hash.dart
  - init_push_result.dart
  - key_derivation.dart
  - key_exchange.dart
  - key_pair.dart
  - onetime_auth.dart
  - password_hash.dart
  - pull_result.dart
  - random_bytes.dart
  - scalar_mult.dart
  - sealed_box.dart
  - secret_box.dart
  - session_keys.dart
  - short_hash.dart
  - sodium.dart
  - sodium_exception.dart
  - x_cha_cha20_poly1305_ietf.dart
- flutter_sodium.dart
- flutter_sodium_test.dart
.gitignore
.metadata
ACKNOWLEDGEMENTS.md
CHANGELOG.md
flutter_sodium.iml
LICENSE
pubspec.yaml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/kozw/flutter_sodium

Downloads the entire project code from GitHub to your computer.

cd flutter_sodium

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

cd android

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# flutter_sodium

With flutter_sodium you get access to the modern, easy-to-use [libsodium](https://download.libsodium.org/doc/) crypto library in your [Flutter](https://flutter.io) apps. One set of crypto APIs supporting both Android and iOS.

[![Pub](https://img.shields.io/pub/v/flutter_sodium.svg)](https://pub.dartlang.org/packages/flutter_sodium)

## Getting Started

In your flutter project add the dependency:

```yml
dependencies:
  ...
  flutter_sodium: ^0.2.0
```

Import the plugin and initialize it. Sodium.init() initializes the plugin and should be called before any other function provided by flutter_sodium.

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

// initialize sodium
Sodium.init();
```

## Usage example

```dart
// Password hashing (using Argon)
final password = 'my password';
final str = PasswordHash.hashStringStorage(password);

print(str);

// verify hash str
final valid = PasswordHash.verifyStorage(str, password);

assert(valid);
```

This project includes an extensive example app with runnable code samples. Be sure to check it out!

<img src="https://raw.githubusercontent.com/firstfloorsoftware/flutter_sodium/master/example/assets/screenshots/screenshot1.png" width="300">

## API coverage
The flutter_sodium plugin implements the following libsodium APIs:
- crypto_aead
- crypto_auth
- crypto_box
- crypto_generichash
- crypto_hash
- crypto_kdf
- crypto_kx
- crypto_onetimeauth
- crypto_pwhash
- crypto_scalarmult
- crypto_secretbox
- crypto_secretstream
- crypto_shorthash
- crypto_sign
- crypto_stream
- randombytes
- sodium_version

API coverage is not 100% complete, track the progress in [issue #61](https://github.com/firstfloorsoftware/flutter_sodium/issues/61)

## Dart APIs
The plugin includes a core API that maps native libsodium functions 1:1 to Dart equivalents. The core API is available in the class [`Sodium`](https://github.com/firstfloorsoftware/flutter_sodium/blob/master/lib/flutter_sodium.dart). Dart naming conventions are used for core API function names. A native libsodium function such as `crypto_pwhash_str`, is available in flutter as `Sodium.cryptoPwhashStr`.

Also included in flutter_sodium is a high-level, opinionated API providing access to libsodium in a Dart friendly manner. The various functions are available in separate Dart classes. Password hashing for example is available in the `PasswordHash` class. The high-level API depends on the core API to get things done.

## Migrating to fluttter_sodium FFI
The FFI implementation of flutter_sodium is backwards incompatible with the previous platform channel implementation. The list of changes:
- the entire FFI API is now synchronous, while the previous implementation was entirely asynchronous
- all hardcoded libsodium constants are now available as properties on the Sodium class.
- in the platform channel versions the Android and iOS implementations were not in sync. Some functions were available only in iOS, others only in Android. With the FFI implementation, there is a single API covering both platforms.

## Background threads
Since the entire FFI API is synchronous, you'll need to do some extra work to execute long running crypto function on a background thread. Luckily this is very easy with Flutter's [compute function](https://api.flutter.dev/flutter/foundation/compute.html).

The following code snippet demonstrates running a password hash on the background thread.

```dart
final pw = 'hello world';
final str = await compute(PasswordHash.hashStringStorageModerate, pw);

print(str);
```