crypto_keys 0.1.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 82

Build Status

A library for doing cryptographic signing/verifying and encrypting/decrypting.

It uses pointycastle under the hood, but exposes a more convenient api.

Usage #

Signing #

A simple usage example:

import 'package:crypto_keys/crypto_keys.dart';
import 'dart:typed_data';

main() {
  // Create a key pair from a JWK representation
  var keyPair = new KeyPair.fromJwk({
    "kty": "oct",
    "k": "AyM1SysPpbyDfgZld3umj1qzKObwVMkoqQ-EstJQLr_T-1qS0gZH75"
        "aKtMN3Yj0iPS4hcgUuTwjAzZr1Z9CAow"
  });

  // A key pair has a private and public key, possibly one of them is null, if
  // required info was not available when construction
  // The private key can be used for signing
  var privateKey = keyPair.privateKey;

  // Create a signer for the key using the HMAC/SHA-256 algorithm
  var signer = privateKey.createSigner(algorithms.signing.hmac.sha256);

  // Sign some content, to be integrity protected
  var content = "It's me, really me";
  var signature = signer.sign("It's me, really me".codeUnits);

  print("Signing '$content'");
  print("Signature: ${signature.data}");

  // The public key can be used for verifying the signature
  var publicKey = keyPair.publicKey;

  // Create a verifier for the key using the specified algorithm
  var verifier = publicKey.createVerifier(algorithms.signing.hmac.sha256);

  var verified =
      verifier.verify(new Uint8List.fromList(content.codeUnits), signature);
  if (verified)
    print("Verification succeeded");
  else
    print("Verification failed");
}

Encryption #

A simple usage example:


import 'package:crypto_keys/crypto_keys.dart';
import 'dart:typed_data';

main() {
  // Generate a new random symmetric key pair
  var keyPair = new KeyPair.generateSymmetric(128);

  // Use the public key to create an encrypter with the AES/GCM algorithm
  var encrypter =
      keyPair.publicKey.createEncrypter(algorithms.encryption.aes.gcm);

  // Encrypt the content with an additional authentication data for integrity
  // protection
  var content = "A very secret text";
  var aad = "It is me";
  var v = encrypter.encrypt(new Uint8List.fromList(content.codeUnits),
      additionalAuthenticatedData: new Uint8List.fromList(aad.codeUnits));

  print("Encrypting '$content'");
  print("Ciphertext: ${v.data}");
  print("Authentication tag: ${v.authenticationTag}");

  // Use the private key to create the decrypter
  var decrypter =
      keyPair.privateKey.createEncrypter(algorithms.encryption.aes.gcm);

  // Decrypt and verify authentication tag
  var decrypted = decrypter.decrypt(v);

  print("Decrypted text: '${new String.fromCharCodes(decrypted)}'");
}

Features and bugs #

Please file feature requests and bugs at the issue tracker.

0.1.0 #

  • Initial version

Use this package as a library

1. Depend on it

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


dependencies:
  crypto_keys: ^0.1.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:crypto_keys/crypto_keys.dart';
  
Version Uploaded Documentation Archive
0.1.0 Nov 2, 2018 Go to the documentation of crypto_keys 0.1.0 Download crypto_keys 0.1.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
70
Health:
Code health derived from static analysis. [more]
91
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

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

  • Dart: 2.3.2
  • pana: 0.12.18

Platforms

Detected platforms: Flutter, web, other

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

Health suggestions

Fix lib/src/impl.g.dart. (-6.78 points)

Analysis of lib/src/impl.g.dart reported 14 hints, including:

line 30 col 7: DO use curly braces for all flow control structures.

line 32 col 7: DO use curly braces for all flow control structures.

line 131 col 7: DO use curly braces for all flow control structures.

line 134 col 7: DO use curly braces for all flow control structures.

line 137 col 7: DO use curly braces for all flow control structures.

Fix lib/src/keys.dart. (-1 points)

Analysis of lib/src/keys.dart reported 2 hints:

line 18 col 7: DO use curly braces for all flow control structures.

line 29 col 7: DO use curly braces for all flow control structures.

Fix lib/src/algorithms.dart. (-0.50 points)

Analysis of lib/src/algorithms.dart reported 1 hint:

line 304 col 9: DO use curly braces for all flow control structures.

Fix lib/src/symmetric_keys.dart. (-0.50 points)

Analysis of lib/src/symmetric_keys.dart reported 1 hint:

line 12 col 7: DO use curly braces for all flow control structures.

Fix lib/src/symmetric_operator.dart. (-0.50 points)

Analysis of lib/src/symmetric_operator.dart reported 1 hint:

line 39 col 7: DO use curly braces for all flow control structures.

Maintenance suggestions

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

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

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
built_collection ^4.0.0 4.2.2
built_value ^6.1.5 6.6.0
meta ^1.1.6 1.1.7
pointycastle ^1.0.0-rc4 1.0.1
Transitive dependencies
collection 1.14.11
fixnum 0.10.9
matcher 0.12.5
path 1.6.2
quiver 2.0.3
stack_trace 1.9.3
Dev dependencies
test ^1.0.0