pointycastle 1.0.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 75

Pointy Castle #

A Dart library for encryption and decryption. As of today, most of the classes are ports of Bouncy Castle from Java to Dart. The porting is almost always direct except for some classes that had been added to ease the use of low level data.

To make sure nothing fails, tests and benchmarks for every algorithm are provided. The expected results are taken from the Bouncy Castle Java version and also from standards, and matched against the results got from Pointy Castle.

Algorithms #

As of the last release, the following algorithms are implemented:

Block ciphers:

  • AES

Asymmetric block ciphers:

  • RSA

Asymmetric block cipher encodings:

  • PKCS1
  • OAEP

Stream ciphers:

  • Salsa20

Block cipher modes of operation:

  • CBC (Cipher Block Chaining mode)
  • CFB (Cipher Feedback mode)
  • ECB (Electronic Code Book mode)
  • GCTR (GOST 28147 OFB counter mode)
  • OFB (Output FeedBack mode)
  • CTR (Counter mode)
  • SIC

Paddings:

  • PKCS7

Digests:

  • Blake2b
  • MD2
  • MD4
  • MD5
  • RIPEMD-128|160|256|320
  • SHA-1
  • SHA-224|256|384|512
  • SHA-512/t (t=8 to 376 and 392 to 504 in multiples of 8)
  • Keccak-224|256|384|512*
  • Tiger
  • Whirlpool

*Keccak is currently implemented as SHA3Digest.

MACs:

  • HMAC

Signatures:

  • (DET-)ECDSA
  • RSA

Password based key derivators:

  • PBKDF2
  • scrypt

Asymmetric key generators:

  • ECDSA
  • RSA

Secure PRNGs:

  • Based on block cipher in CTR mode
  • Based on block cipher in CTR mode with auto reseed (for forward security)
  • Based on Fortuna algorithm

Usage #

There are two ways to use the algorithms that PointyCastle provides: with or without using the registry.

Registry #

The registry allows users to easily instantiate classes for the algorithms using the algorithm shorthands like given in the list above. It also makes it possible to seamlessly chain different algorithms together. For example:

import "package:pointycastle/pointycastle.dart";

void main() {
  Digest sha256 = new Digest("SHA-256");
  // or
  KeyDerivator derivator = new KeyDerivator("SHA-1/HMAC/PBKDF2");
}

Without the registry #

Using the registry means that all algorithms will be imported by default, which can possibly increase the compiled size of your program. To avoid this, it is possible to import algorithms one by one. In that case, you can decide to either use the classes directly, or still use the registry. But remember that the registry only contains the classes that you import. For example:

import "package:pointycastle/api.dart";

import "package:pointycastle/digests/sha256.dart";

import "package:pointycastle/digests/sha1.dart";
import "package:pointycastle/macs/hmac.dart";
import "package:pointycastle/key_derivators/pbkdf2.dart";

void main() {
  Digest sha256 = new SHA256Digest();
  // or
  KeyDerivator derivator = new PBKDF2KeyDerivator(
      new HMac(new SHA1Digest(), 64));

  // But the registry keeps working for all imported algorithms:

  Digest sha256 = new Digest("SHA-256");
  // or
  KeyDerivator derivator = new KeyDerivator("SHA-1/HMAC/PBKDF2");
}

Libraries #

  • package:pointycastle/pointycastle.dart: exports the high-level API and the registry loaded with all available implementations
  • package:pointycastle/api.dart: exports the high-level API and the registry without any implementations
  • package:pointycastle/export.dart: exports the API and all implementation classes

Changelog #

Version 1.0.1 (2019-02-20) #

  • Add Blake2b support

Version 1.0.0 (2018-12-17) (Dart SDK version 2.0) #

  • Support Dart 2 and Strong Mode
  • Migrate from package:bignum.BigInteger to dart:core.BigInt
  • Remove Quiver and fixnum dependency
  • OAEP encoding for block ciphers

Version 0.10.0 (2016-02-04) (Dart SDK version 0.14.0) #

  • First Pointy Castle release.

  • Reorganised file structure.

  • Completely new Registry implementation that dynamically loads imported implementations using reflection. It is explained in this commit.

  • Migrated from unittest to test package.

cipher releases #

Version 0.8.0 (2014-??-??) (Dart SDK version ???) #

  • [bug 80] PaddedBlockCipher doesn't add padding when data length is a multiple of the block size. This fix introduces a BREAKING CHANGE in PaddedBlockCipher specification. Read its API documentation to know about the changes.

Version 0.7.0 (2014-03-22) (Dart SDK version 1.3.0-dev.5.2) #

  • [enh 15] Implement stream cipher benchmarks.

  • [enh 64] Benchmark and optimize digests.

  • [enh 74] Make SHA-3 usable in terms of speed.

  • [bug 67] Removed some unused code.

  • [bug 68] Fix process() method of PaddedBlockCipher.

  • [bug 75] Remove a registry dependency in the Scrypt algorithm.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  pointycastle: ^1.0.1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:pointycastle/pointycastle.dart';
  
Version Uploaded Documentation Archive
1.0.1 Feb 20, 2019 Go to the documentation of pointycastle 1.0.1 Download pointycastle 1.0.1 archive
1.0.0 Dec 17, 2018 Go to the documentation of pointycastle 1.0.0 Download pointycastle 1.0.0 archive
0.11.1 Jan 28, 2018 Go to the documentation of pointycastle 0.11.1 Download pointycastle 0.11.1 archive
0.11.0 Jan 28, 2018 Go to the documentation of pointycastle 0.11.0 Download pointycastle 0.11.0 archive
0.10.0+5 Dec 8, 2016 Go to the documentation of pointycastle 0.10.0+5 Download pointycastle 0.10.0+5 archive
0.10.0+4 Dec 8, 2016 Go to the documentation of pointycastle 0.10.0+4 Download pointycastle 0.10.0+4 archive
0.10.0+3 Dec 8, 2016 Go to the documentation of pointycastle 0.10.0+3 Download pointycastle 0.10.0+3 archive
0.10.0+2 Dec 7, 2016 Go to the documentation of pointycastle 0.10.0+2 Download pointycastle 0.10.0+2 archive
0.10.0+1 Feb 12, 2016 Go to the documentation of pointycastle 0.10.0+1 Download pointycastle 0.10.0+1 archive
0.10.0 Feb 3, 2016 Go to the documentation of pointycastle 0.10.0 Download pointycastle 0.10.0 archive

All 15 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
93
Health:
Code health derived from static analysis. [more]
39
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
82
Overall:
Weighted score of the above. [more]
75
Learn more about scoring.

We analyzed this package on Apr 25, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:pointycastle/pointycastle.dart.

Health suggestions

Fix lib/src/ufixnum.dart. (-4.89 points)

Analysis of lib/src/ufixnum.dart reported 10 hints, including:

line 116 col 1: Prefer using /// for doc comments.

line 128 col 1: Prefer using /// for doc comments.

line 201 col 1: Prefer using /// for doc comments.

line 213 col 1: Prefer using /// for doc comments.

line 228 col 27: The value of the field '_MAX_VALUE' isn't used.

Fix lib/signers/ecdsa_signer.dart. (-4.41 points)

Analysis of lib/signers/ecdsa_signer.dart reported 9 hints, including:

line 35 col 8: The value of the field '_deterministic' isn't used.

line 39 col 3: Prefer using /// for doc comments.

line 45 col 16: Don't explicitly initialize variables to null.

line 45 col 37: Don't explicitly initialize variables to null.

line 52 col 3: Prefer using /// for doc comments.

Fix lib/ecc/ecc_base.dart. (-3.93 points)

Analysis of lib/ecc/ecc_base.dart reported 8 hints, including:

line 22 col 60: Avoid types as parameter names.

line 23 col 8: Don't explicitly initialize variables to null.

line 23 col 24: Don't explicitly initialize variables to null.

line 68 col 3: Avoid return types on setters.

line 99 col 3: Prefer using /// for doc comments.

Fix additional 86 files with analysis or formatting issues. (-80.37 points)

Additional issues in the following files:

  • lib/ecc/ecc_fp.dart (7 hints)
  • lib/key_generators/rsa_key_generator.dart (5 hints)
  • lib/block/modes/cfb.dart (4 hints)
  • lib/asymmetric/oaep.dart (3 hints)
  • lib/digests/blake2b.dart (3 hints)
  • lib/src/api/block_cipher.dart (3 hints)
  • lib/src/api/mac.dart (3 hints)
  • lib/src/api/padded_block_cipher.dart (3 hints)
  • lib/ecc/api.dart (2 hints)
  • lib/ecc/curves/brainpoolp160r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp160t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp192r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp192t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp224r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp224t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp256r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp256t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp320r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp320t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp384r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp384t1.dart (2 hints)
  • lib/ecc/curves/brainpoolp512r1.dart (2 hints)
  • lib/ecc/curves/brainpoolp512t1.dart (2 hints)
  • lib/ecc/curves/gostr3410_2001_cryptopro_a.dart (2 hints)
  • lib/ecc/curves/gostr3410_2001_cryptopro_b.dart (2 hints)
  • lib/ecc/curves/gostr3410_2001_cryptopro_c.dart (2 hints)
  • lib/ecc/curves/gostr3410_2001_cryptopro_xcha.dart (2 hints)
  • lib/ecc/curves/gostr3410_2001_cryptopro_xchb.dart (2 hints)
  • lib/ecc/curves/prime192v1.dart (2 hints)
  • lib/ecc/curves/prime192v2.dart (2 hints)
  • lib/ecc/curves/prime192v3.dart (2 hints)
  • lib/ecc/curves/prime239v1.dart (2 hints)
  • lib/ecc/curves/prime239v2.dart (2 hints)
  • lib/ecc/curves/prime239v3.dart (2 hints)
  • lib/ecc/curves/prime256v1.dart (2 hints)
  • lib/ecc/curves/secp112r1.dart (2 hints)
  • lib/ecc/curves/secp112r2.dart (2 hints)
  • lib/ecc/curves/secp128r1.dart (2 hints)
  • lib/ecc/curves/secp128r2.dart (2 hints)
  • lib/ecc/curves/secp160k1.dart (2 hints)
  • lib/ecc/curves/secp160r1.dart (2 hints)
  • lib/ecc/curves/secp160r2.dart (2 hints)
  • lib/ecc/curves/secp192k1.dart (2 hints)
  • lib/ecc/curves/secp192r1.dart (2 hints)
  • lib/ecc/curves/secp224k1.dart (2 hints)
  • lib/ecc/curves/secp224r1.dart (2 hints)
  • lib/ecc/curves/secp256k1.dart (2 hints)
  • lib/ecc/curves/secp256r1.dart (2 hints)
  • lib/ecc/curves/secp384r1.dart (2 hints)
  • lib/ecc/curves/secp521r1.dart (2 hints)
  • lib/impl.dart (2 hints)
  • lib/src/api/asymmetric_block_cipher.dart (2 hints)
  • lib/src/api/digest.dart (2 hints)
  • lib/src/api/key_derivator.dart (2 hints)
  • lib/src/api/key_generator.dart (2 hints)
  • lib/src/api/padding.dart (2 hints)
  • lib/src/api/stream_cipher.dart (2 hints)
  • lib/src/impl/long_sha2_family_digest.dart (2 hints)
  • lib/stream/salsa20.dart (2 hints)
  • lib/stream/sic.dart (2 hints)
  • lib/api.dart (1 hint)
  • lib/asymmetric/pkcs1.dart (1 hint)
  • lib/block/aes_fast.dart (1 hint)
  • lib/block/modes/gctr.dart (1 hint)
  • lib/block/modes/ofb.dart (1 hint)
  • lib/block/modes/sic.dart (1 hint)
  • lib/digests/md2.dart (1 hint)
  • lib/digests/sha224.dart (1 hint)
  • lib/digests/sha256.dart (1 hint)
  • lib/export.dart (1 hint)
  • lib/key_derivators/api.dart (1 hint)
  • lib/key_derivators/pbkdf2.dart (1 hint)
  • lib/key_derivators/scrypt.dart (1 hint)
  • lib/macs/hmac.dart (1 hint)
  • lib/pointycastle.dart (1 hint)
  • lib/random/auto_seed_block_ctr_random.dart (1 hint)
  • lib/random/block_ctr_random.dart (1 hint)
  • lib/src/api/padded_block_cipher_parameters.dart (1 hint)
  • lib/src/api/parameters_with_iv.dart (1 hint)
  • lib/src/api/parameters_with_random.dart (1 hint)
  • lib/src/api/secure_random.dart (1 hint)
  • lib/src/api/signer.dart (1 hint)
  • lib/src/impl/base_padding.dart (1 hint)
  • lib/src/impl/md4_family_digest.dart (1 hint)
  • lib/src/impl/secure_random_base.dart (1 hint)
  • lib/src/registry/registry.dart (1 hint)

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and pointycastle.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

The package description is too short. (-8 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=0.8.10+6 <3.0.0
Dev dependencies
benchmark_harness >=1.0.5 <2.0.0
matcher >=0.12.0 <0.13.0
test >=0.12.30 <1.4.0