secure_string 2.0.0

  • README.md
  • Installing
  • Versions
  • 77

Secure string

This is a cryptographically secure random string generator based on dart:math.Random.secure.

Usage:

Create an instance with new SecureString():

SecureString secureString = new SecureString();

Then generate random strings with it:

String randomString = secureString.generate(length: 512);

The length defaults to 1024 if no length is specified.

Custom character lists

To specify a list of allowed characters, use the named parameter charList:

String randomBinaryString = secureString.generate(charList: ["0", "1"]);

The list defaults to hexadecimal characters (0-f).

Insecure string:

To create insecure random strings: use new SecureString(string: false) instead of new SecureString(). You can also specify a seed using new SecureString(string: false, seed: 2) (replacing 2 with your seed).

Trivia:

This library was made in spite of a library already existing due to two reasons:

  • That library did not have functionality for Random.secure.
  • That library was licensed under the BSD 3 clause license.

1. Depend on it

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


dependencies:
  secure_string: "^2.0.0"

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 packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:secure_string/secure_string.dart';
        
Version Uploaded Documentation Archive
2.0.0 Jul 29, 2017 Go to the documentation of secure_string 2.0.0 Download secure_string 2.0.0 archive
1.1.0 Jul 29, 2017 Go to the documentation of secure_string 1.1.0 Download secure_string 1.1.0 archive
1.0.0 Jul 29, 2017 Go to the documentation of secure_string 1.0.0 Download secure_string 1.0.0 archive

Analysis

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

  • Dart: 2.0.0-dev.49.0
  • pana: 0.10.6

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
63 / 100
Health:
Code health derived from static analysis. [more]
98 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80 / 100
Overall score:
Weighted score of the above. [more]
77
Learn more about scoring.

Platforms

Detected platforms: Flutter, web, other

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

Suggestions

  • Maintain CHANGELOG.md.

    Changelog entries help clients to follow the progress in your code.

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Maintain an example.

    Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use secure_string.dart.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 1 hint.

    Run dartfmt to format lib/secure_string.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >1.24.0 <2.0.0