luisgf / openbadges-validator

Tools for validating openbadges assertions

OpenBadges Validator Tools

Installing

$ npm install openbadges-validator

Usage

The following documentation assumes the module has been imported like so:

var validator = require('openbadges-validator');

validator(thing, callback)

Validate a badge assertion and return an object containing info about the validated assertion.

thing should be an assertion, URL for a hosted assertion, or a signed badge.

The callback is passed two arguments, (err, info).

info is an object containing the following properties:

• version: Version of the specification that the analyzed assertion corresponds to. Currently this will be either "1.0.0" or "0.5.0".

• guid: The GUID of the assertion, as per the algorithm described in the documentation for getAssertionGUID. If the assertion passed-in was the literal object for a 0.5.0-style assertion, this will be null, since there is no way to know what the URL of the assertion is.

• signature: JSON Web Signature representation of the assertion. This will only be present if the assertion came in as a JWS.

• structures

  • assertion: The assertion data
  • badge: Badge data related to assertion.
  • issuer: Issuer data related to badge.

• resources: Object with all of the resources related to the assertion, badge and issuer. A list of the possible properties follows (properties marked with a star are guaranteed to exist. NOTE, property names are the literal dotted strings, not deep property lookups, i.e, resources['assertion.image'].

  • assertion.image
  • assertion.verify.url
  • assertion.evidence
  • badge.criteria★
  • badge.image★
  • issuer.url
  • issuer.image
  • issuer.revocationList

validator.validateHosted(assertion, callback)

validator.validateHostedUrl(url, callback)

validator.validateSigned(signature, callback)

The methods underlying validator(thing, callback) can also be called directly to validate a specific type of input.

validator.getAssertionGUID(urlOrSignature, callback)

Given either a hosted assertion URL or a signed assertion, return an alphanumeric string that uniquely identifies the badge.

The callback is passed two arguments, (err, guid).

If the assertion is hosted, guid will be the SHA256 hash of the following string:

hosted: assertion URL

If the assertion is signed, guid will be the SHA256 hash of the following string:

signed: assertion UID : origin of assertion's public key

For example, if the signed assertion's public key is hosted at https://example.org/public-key and the assertion's UID is abcd, then the assertion's GUID will be the hex-encoded SHA256 hash of signed:abcd:https://example.org, or 61ae9c039ecc7d08cac6fea3ed6fa3d47463b34e3f2f3bbe86be33688b2f105a.

validator.doesRecipientMatch(info, identity)

Returns a boolean indicating whether or not an assertion has been issued to a particular recipient.

info is an object containing properties about the assertion, as returned by the validator function.

identity is an email address. (In the future, identities other than email addresses may be supported.)

Tests

All tests can be run with npm test.

A code coverage report can be generated with node_modules/.bin/jake test-cov (or jake test-cov if you have jake installed globally) and viewed in cover_html/index.html.

The coverage tool used is node-cover, see its documentation for details.

License

MPL 2.0