corsac_jwt 0.1.2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 84

Lightweight implementation of JSON Web Tokens (JWT).

Build Status codecov

Usage

import 'package:corsac_jwt/corsac_jwt.dart';

void main() {
  var builder = new JWTBuilder();
  var token = builder
    ..issuer = 'https://api.foobar.com'
    ..expiresAt = new DateTime.now().add(new Duration(minutes: 3))
    ..setClaim('data', {'userId': 836})
    ..getToken(); // returns token without signature

  var signer = new JWTHmacSha256Signer('sharedSecret');
  var signedToken = builder.getSignedToken(signer);
  print(signedToken); // prints encoded JWT
  var stringToken = signedToken.toString();

  var decodedToken = new JWT.parse(stringToken);
  // Verify signature:
  print(decodedToken.verify(signer)); // true

  // Validate claims:
  var validator = new JWTValidator() // uses DateTime.now() by default
    ..issuer = 'https://api.foobar.com'; // set claims you wish to validate
  Set<String> errors = validator.validate(decodedToken);
  print(errors); // (empty list)
}

Supported signers:

Refer to documentation for more details.

License

BSD-2

0.1.2

  • Exposed complete claims Map (read-only).

0.1.1

  • Relaxed SDK constraint to allow 2.0.0-dev versions.

0.1.0

  • Initial release.

Use this package as a library

1. Depend on it

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


dependencies:
  corsac_jwt: ^0.1.2

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:corsac_jwt/corsac_jwt.dart';
  
Version Uploaded Documentation Archive
0.1.2 Sep 8, 2018 Go to the documentation of corsac_jwt 0.1.2 Download corsac_jwt 0.1.2 archive
0.1.1 Aug 9, 2018 Go to the documentation of corsac_jwt 0.1.1 Download corsac_jwt 0.1.1 archive
0.1.0 Aug 9, 2018 Go to the documentation of corsac_jwt 0.1.0 Download corsac_jwt 0.1.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
81
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
84
Learn more about scoring.

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

  • Dart: 2.0.0
  • pana: 0.12.4

Platforms

Detected platforms: Flutter, web, other

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

Maintenance suggestions

The description is too short. (-20 points)

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. (-10 points)

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 corsac_jwt.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
asn1lib ^0.5.0 0.5.3
crypto ^2.0.0 2.0.6
logging ^0.11.3 0.11.3+2
Transitive dependencies
charcode 1.1.2
collection 1.14.11
convert 2.0.2
typed_data 1.1.6
Dev dependencies
test ^1.0.0
test_coverage any