corsac_jwt 0.1.2

  • Readme
  • Changelog
  • Installing
  • 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 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:corsac_jwt/corsac_jwt.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
90
Health:
Code health derived from static analysis. [more]
90
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
57
Overall:
Weighted score of the above. [more]
84
Learn more about scoring.

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

  • Dart: 2.6.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

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

Health suggestions

Fix lib/corsac_jwt.dart. (-10.44 points)

Analysis of lib/corsac_jwt.dart reported 22 hints, including:

line 74 col 50: Avoid const keyword.

line 103 col 18: Unnecessary new keyword.

line 105 col 17: Unnecessary new keyword.

line 108 col 13: Unnecessary new keyword.

line 117 col 14: Unnecessary new keyword.

Maintenance suggestions

Package is getting outdated. (-24.66 points)

The package was last published 65 weeks ago.

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 corsac_jwt.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 >=2.0.0-dev <3.0.0
asn1lib ^0.5.0 0.5.14
crypto ^2.0.0 2.1.4
logging ^0.11.3 0.11.3+2
Transitive dependencies
charcode 1.1.2
collection 1.14.12
convert 2.1.1
typed_data 1.1.6
Dev dependencies
test ^1.0.0
test_coverage any