phil/open-badges

phil/open-badges émet des titres Open Badges 3.0 — un OpenBadgeCredential dans le modèle de données de Verifiable Credentials 2.0 — et les vérifie. Un titre affirme qu'un émetteur reconnaît une réalisation d'un destinataire. Il est signé par la clé de l'émetteur : le destinataire peut ainsi l'emporter partout — un portfolio, un profil professionnel, un portefeuille — et tout le monde peut le vérifier avec la clé publique de l'émetteur, sans interroger le site qui l'a émis.

Il s'adresse à toute application PHP qui reconnaît ce que font les gens : une plateforme de formation qui décerne des certificats, une communauté qui remercie ses bénévoles, un événement qui reconnaît ses conférenciers. La bibliothèque ne lit aucun compte et ne stocke rien : l'application dit qui est le destinataire, tel qu'il se présente, et garde ce qu'elle a émis.

C'est une simple bibliothèque PHP qui n'exige que PHP et ses extensions. Un titre est sécurisé de l'une des deux façons que reconnaît Open Badges 3.0 : comme un JSON Web Token (EdDSA ou RS256), ou avec une preuve Data Integrity intégrée de la suite cryptographique eddsa-rdfc-2022. Pour celle-ci, la bibliothèque a son propre processeur JSON-LD et sa propre canonicalisation RDF. La vérification ne télécharge jamais rien : les contextes JSON-LD sont inclus, et les clés sont celles que donne l'application.

État

Documentation

Démarrage rapide

composer require phil/open-badges

use Phil\OpenBadges\Achievement;
use Phil\OpenBadges\CredentialIssuer;
use Phil\OpenBadges\DataIntegrity\EddsaRdfc2022;
use Phil\OpenBadges\Issuer;
use Phil\OpenBadges\Key\Ed25519Signer;
use Phil\OpenBadges\Recipient;

$signer = Ed25519Signer::fromSeed($seed);              // 32 secret bytes
$issuer = new CredentialIssuer(new Issuer('https://example.org/issuer', 'Example'), $signer, 'https://example.org/issuer#key-1');
$achievement = new Achievement('https://example.org/badges/mentor', 'Mentor', 'Guided five newcomers.', 'Guide five newcomers through their first month.');
$recipient = Recipient::email($emailTheyGave, bin2hex(random_bytes(8)));

$token = $issuer->issue($achievement, $recipient, 'urn:uuid:'.$uuid, $awardedAt);     // VC-JWT

$document = new EddsaRdfc2022()->sign(                                                // Data Integrity
    $issuer->credential($achievement, $recipient, 'urn:uuid:'.$uuid, $awardedAt),
    $signer,
    'https://example.org/issuer#key-1',
    $now,
);

Prérequis

PHP 8.5 ou plus récent avec les extensions dom, json, libxml, mbstring, openssl, sodium et zlib.

Contribuer

Les contributions sont les bienvenues sur le monodépôt PHIL : lisez le guide de contribution et le code de conduite. Signalez une vulnérabilité en privé, comme l'explique la politique de sécurité, jamais dans un ticket public.

Licence

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. Voyez LICENSE. Les contextes JSON-LD inclus gardent leurs propres avis : voyez NOTICE.