encrypt

Pub Package Build Status Donate

A set of high-level APIs over PointyCastle for two-way cryptography.

Looking for password hashing? Please, visit password.

API Overview

Encrypter(Algorithm algo)

Acts like a Adapter interface for any algorithm. Exposes:

  • Encrypted encrypt(String text, {IV iv}) encrypts the given plain-text.
  • String decrypt(Encrypted encrypted, {IV iv}) decrypts the given Encrypted value.
  • String decrypt16(String encoded, {IV iv}) sugar for decrypt(Encrypted.fromBase16(encoded)).
  • String decrypt64(String encoded, {IV iv}) sugar for decrypt(Encrypted.fromBase64(encoded)).

Encrypted(Uint8List bytes)

Wraps the encrypted bytes. Exposes:

  • Encrypted.fromBase16(String encoded) creates an Encrypted object from a hexdecimal string.
  • Encrypted.fromBase64(String encoded) creates an Encrypted object from a Base64 string.
  • String base16 returns a hexdecimal representation of the bytes.
  • String base64 returns a Base64 representation of the bytes.
  • Uint8List bytes returns raw bytes.

Key(Uint8List bytes)

Represents an Encryption Key. Exposes:

  • Key.fromBase16(String encoded) creates a Key from a hexdecimal string.
  • Key.fromBase64(String encoded) creates a Key from a Base64 string.
  • Key.fromUtf8(String encoded) creates a Key from a UTF-8 string.
  • Key.fromLength(int length) sugar for Key(Uint8List(length)).

IV(Uint8List bytes)

Represents an Initialization Vector https://en.wikipedia.org/wiki/Initialization_vector. Exposes:

  • IV.fromBase16(String encoded) creates an IV from a hexdecimal string.
  • IV.fromBase64(String encoded) creates an IV from a Base64 string.
  • IV.fromUtf8(String encoded) creates an IV from a UTF-8 string.
  • IV.fromLength(int length) sugar for IV(Uint8List(length)).

Utils

Secure random

You can generate cryptographically secure random keys and IVs for you project.

Activate the encrypt package:

pub global active encrypt

Then use the secure-random command-line tool:

$ secure-random
CBoaDQIQAgceGg8dFAkMDBEOECEZCxgMBiAUFQwKFhg=

You can set the length and the base output.

$ secure-random --help
-l, --length       The length of the bytes
                   (defaults to "32")

-b, --base         Bytes represented as base 64 or base 16 (Hexdecimal)
                   (defaults to "64")

-h, --[no-]help    Show this help message

Algorithms

Current status is:

  • AES with PKCS7 padding
  • RSA with PKCS1 and OAEP encoding
  • Salsa20

Usage

Symmetric

AES

import 'package:encrypt/encrypt.dart';

void main() {
  final plainText = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit';
  final key = Key.fromUtf8('my 32 length key................');
  final iv = IV.fromLength(16);

  final encrypter = Encrypter(AES(key));

  final encrypted = encrypter.encrypt(plainText, iv: iv);
  final decrypted = encrypter.decrypt(encrypted, iv: iv);

  print(decrypted); // Lorem ipsum dolor sit amet, consectetur adipiscing elit
  print(encrypted.base64); // R4PxiU3h8YoIRqVowBXm36ZcCeNeZ4s1OvVBTfFlZRdmohQqOpPQqD1YecJeZMAop/hZ4OxqgC1WtwvX/hP9mw==
}
Mode of operation

Default mode is SIC AESMode.sic, you can override it using the mode named parameter:

final encrypter = Encrypter(AES(key, mode: AESMode.cbc));
}
Supported modes are:
  • CBC AESMode.cbc
  • CFB-64 AESMode.cfb64
  • CTR AESMode.ctr
  • ECB AESMode.ecb
  • OFB-64/GCTR AESMode.ofb64Gctr
  • OFB-64 AESMode.ofb64
  • SIC AESMode.sic

Salsa20

import 'package:encrypt/encrypt.dart';

void main() {
  final plainText = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit';
  final key = Key.fromLength(32);
  final iv = IV.fromLength(8);
  final encrypter = Encrypter(Salsa20(key));

  final encrypted = encrypter.encrypt(plainText, iv: iv);
  final decrypted = encrypter.decrypt(encrypted, iv: iv);

  print(decrypted); // Lorem ipsum dolor sit amet, consectetur adipiscing elit
  print(encrypted.base64); // CR+IAWBEx3sA/dLkkFM/orYr9KftrGa7lIFSAAmVPbKIOLDOzGwEi9ohstDBqDLIaXMEeulwXQ==
}

Fernet

import 'package:encrypt/encrypt.dart';
import 'dart:convert';

void main() {
  final plainText = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit';
  final key = Key.fromUtf8('my32lengthsupersecretnooneknows1');
  final iv = IV.fromLength(16);

  final b64key = Key.fromUtf8(base64Url.encode(key.bytes));
  // if you need to use the ttl feature, you'll need to use APIs in the algorithm itself
  final fernet = Fernet(b64key);
  final encrypter = Encrypter(fernet);

  final encrypted = encrypter.encrypt(plainText);
  final decrypted = encrypter.decrypt(encrypted);

  print(decrypted); // Lorem ipsum dolor sit amet, consectetur adipiscing elit
  print(encrypted.base64); // random cipher text
  print(fernet.extractTimestamp(encrypted.bytes)); // unix timestamp
}

Asymmetric

RSA

import 'dart:io';
import 'package:encrypt/encrypt.dart';
import 'package:pointycastle/asymmetric/api.dart';

void main() {
  final publicKey = await parseKeyFromFile<RSAPublicKey>('test/public.pem');
  final privKey = await parseKeyFromFile<RSAPrivateKey>('test/private.pem');

  final plainText = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit';
  final encrypter = Encrypter(RSA(publicKey: publicKey, privateKey: privKey));

  final encrypted = encrypter.encrypt(plainText);
  final decrypted = encrypter.decrypt(encrypted);

  print(decrypted); // Lorem ipsum dolor sit amet, consectetur adipiscing elit
  print(encrypted.base64); // kO9EbgbrSwiq0EYz0aBdljHSC/rci2854Qa+nugbhKjidlezNplsEqOxR+pr1RtICZGAtv0YGevJBaRaHS17eHuj7GXo1CM3PR6pjGxrorcwR5Q7/bVEePESsimMbhHWF+AkDIX4v0CwKx9lgaTBgC8/yJKiLmQkyDCj64J3JSE=
}
Note

If you are just encrypting or just decrypting, you can ignore the respectives privateKey and publicKey. Trying the encrypt without a public key or decrypt without a private key will throw a StateError.

Libraries

encrypt
encrypt_io