https://github.com/jerson/flutter-openpgp
OpenPGP for flutter made with golang for fast performance with support for android, ios, macos, linux, windows, web and hover
https://github.com/jerson/flutter-openpgp
android dart ecc ecdsa echd eddsa flutter generate golang ios linux macos openpgp pgp sign verify web windows xcode
Last synced: 6 months ago
JSON representation
OpenPGP for flutter made with golang for fast performance with support for android, ios, macos, linux, windows, web and hover
- Host: GitHub
- URL: https://github.com/jerson/flutter-openpgp
- Owner: jerson
- License: mit
- Created: 2020-02-20T04:32:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-15T17:51:48.000Z (7 months ago)
- Last Synced: 2025-03-30T00:05:06.735Z (6 months ago)
- Topics: android, dart, ecc, ecdsa, echd, eddsa, flutter, generate, golang, ios, linux, macos, openpgp, pgp, sign, verify, web, windows, xcode
- Language: Dart
- Homepage: https://pub.dev/packages/openpgp
- Size: 397 MB
- Stars: 70
- Watchers: 4
- Forks: 24
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# OpenPGP
Library for use openPGP with support for android, ios, macos, windows, linux and web
[](https://github.com/jerson/flutter-openpgp/actions/workflows/tests_android.yml)
[](https://github.com/jerson/flutter-openpgp/actions/workflows/tests_linux.yml)
[](https://github.com/jerson/flutter-openpgp/actions/workflows/tests_windows.yml)
[](https://github.com/jerson/flutter-openpgp/actions/workflows/tests_ios.yml)
[](https://github.com/jerson/flutter-openpgp/actions/workflows/tests_macos.yml)
## Contents
- [OpenPGP](#openpgp)
- [Contents](#contents)
- [Usage](#usage)
- [Async methods](#async-methods)
- [Sync methods](#sync-methods)
- [Setup](#setup)
- [Android](#android)
- [iOS](#ios)
- [Web](#web)
- [MacOS](#macos)
- [Linux](#linux)
- [Windows](#windows)
- [Example](#example)
- [Native Code](#native-code)
- [Upgrade Library](#upgrade-library)
- [Tests](#tests)
## Usage
### Async methods
#### Generate methods
```dart
void main() async {
var keyOptions = KeyOptions()..rsaBits = 2048;
var keyPair = await OpenPGP.generate(
options: Options()
..name = 'test'
..email = 'test@test.com'
..passphrase = passphrase
..keyOptions = keyOptions);
}
```
#### Encrypt methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = await OpenPGP.encrypt("text","[publicKey here]");
var result = await OpenPGP.encryptSymmetric("text","[passphrase here]");
var result = await OpenPGP.encryptBytes(bytesSample,"[publicKey here]");
var result = await OpenPGP.encryptSymmetricBytes(bytesSample,"[passphrase here]");
}
```
#### Decrypt methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = await OpenPGP.decrypt("text encrypted","[privateKey here]","[passphrase here]");
var result = await OpenPGP.decryptSymmetric("text encrypted","[passphrase here]");
var result = await OpenPGP.decryptBytes(bytesSample,"[privateKey here]","[passphrase here]");
var result = await OpenPGP.decryptSymmetricBytes(bytesSample,"[passphrase here]");
}
```
#### Sign methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = await OpenPGP.sign("text","[privateKey here]","[passphrase here]");
var result = await OpenPGP.signBytesToString(bytesSample,"[privateKey here]","[passphrase here]");
// sign including data
var result = await OpenPGP.signData("text","[privateKey here]","[passphrase here]");
var result = await OpenPGP.signDataBytesToString(bytesSample,"[privateKey here]","[passphrase here]");
}
```
#### Verify methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = await OpenPGP.verify("text signed","text","[publicKey here]");
var result = await OpenPGP.verifyBytes("text signed", bytesSample,"[publicKey here]");
// verify signed with data
var result = await OpenPGP.verifyData("text signed","[publicKey here]");
var result = await OpenPGP.verifyDataBytes(bytesSample,"[publicKey here]");
}
```
#### Encode methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = await OpenPGP.armorEncode("PGP MESSAGE", bytesSample);
}
```
#### Decode methods
```dart
void main() async {
var result = await OpenPGP.armorDecode("message here");
}
```
#### Metadata methods
```dart
void main() async {
var result = await OpenPGP.getPrivateKeyMetadata("[privateKey here]");
var result = await OpenPGP.getPublicKeyMetadata("[publicKey here]");
}
```
#### Convert methods
```dart
void main() async {
var result = await OpenPGP.convertPrivateKeyToPublicKey("[privateKey here]");
}
```
### Sync methods
#### Generate methods
```dart
void main() {
var keyOptions = KeyOptions()..rsaBits = 2048;
var keyPair = OpenPGPSync.generate(
options: Options()
..name = 'test'
..email = 'test@test.com'
..passphrase = passphrase
..keyOptions = keyOptions);
}
```
#### Encrypt methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = OpenPGPSync.encrypt("text","[publicKey here]");
var result = OpenPGPSync.encryptSymmetric("text","[passphrase here]");
var result = OpenPGPSync.encryptBytes(bytesSample,"[publicKey here]");
var result = OpenPGPSync.encryptSymmetricBytes(bytesSample,"[passphrase here]");
}
```
#### Decrypt methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = OpenPGPSync.decrypt("text encrypted","[privateKey here]","[passphrase here]");
var result = OpenPGPSync.decryptSymmetric("text encrypted","[passphrase here]");
var result = OpenPGPSync.decryptBytes(bytesSample,"[privateKey here]","[passphrase here]");
var result = OpenPGPSync.decryptSymmetricBytes(bytesSample,"[passphrase here]");
}
```
#### Sign methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = OpenPGPSync.sign("text","[privateKey here]","[passphrase here]");
var result = OpenPGPSync.signBytesToString(bytesSample,"[privateKey here]","[passphrase here]");
// sign including data
var result = OpenPGPSync.signData("text","[privateKey here]","[passphrase here]");
var result = OpenPGPSync.signDataBytesToString(bytesSample,"[privateKey here]","[passphrase here]");
}
```
#### Verify methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = OpenPGPSync.verify("text signed","text","[publicKey here]");
var result = OpenPGPSync.verifyBytes("text signed", bytesSample,"[publicKey here]");
// verify signed with data
var result = OpenPGPSync.verifyData("text signed","[publicKey here]");
var result = OpenPGPSync.verifyDataBytes(bytesSample,"[publicKey here]");
}
```
#### Encode methods
```dart
void main() async {
var bytesSample = Uint8List.fromList('data'.codeUnits);
var result = OpenPGPSync.armorEncode("PGP MESSAGE", bytesSample);
}
```
#### Decode methods
```dart
void main() async {
var result = OpenPGPSync.armorDecode("message here");
}
```
#### Metadata methods
```dart
void main() async {
var result = OpenPGPSync.getPrivateKeyMetadata("[privateKey here]");
var result = OpenPGPSync.getPublicKeyMetadata("[publicKey here]");
}
```
#### Convert methods
```dart
void main() async {
var result = OpenPGPSync.convertPrivateKeyToPublicKey("[privateKey here]");
}
```
## Setup
### Android
No additional setup required.
### iOS
No additional setup required.
### Web
Add to you `pubspec.yaml`.
```yaml
assets:
- packages/openpgp/web/assets/worker.js
- packages/openpgp/web/assets/wasm_exec.js
- packages/openpgp/web/assets/openpgp.wasm
```
ref: https://github.com/jerson/flutter-openpgp/blob/master/example/pubspec.yaml
### MacOS
No additional setup required.
### Linux
No additional setup required.
### Windows
No additional setup required.
## Example
Inside example folder.
```bash
cd example && flutter run
```
check our web demo: [https://flutter-openpgp.jerson.dev/]
## Native Code
Native library is made in `Go` for faster performance.
[https://github.com/jerson/openpgp-mobile]
## Upgrade Library
You need to run
```bash
make upgrade
```
## Tests
You need to run
```bash
make test
```