Aller au contenu

Référence

phil/open-badges

Phil\OpenBadges

TypeRôle
IssuerLe Profile de l'émetteur, intégré à ses titres ; profileDocument() avec ses méthodes de vérification Multikey.
AchievementCe qui est reconnu, avec ses critères, son image et ses appuis.
RecipientUn DID, ou une empreinte salée d'une adresse courriel ou d'une URL ; identifies() vérifie qui présente un titre.
CredentialIssuerConstruit un OpenBadgeCredential ; issue() le sécurise sous forme de JSON Web Token.
EndorsementIssuerConstruit l'EndorsementCredential que signe un tiers.
EndorsementsLes champs endorsement et endorsementJwt.
ContextLes URL des contextes JSON-LD.
CredentialsInterne : identifiants et périodes de validité.

Phil\OpenBadges\Key et Phil\OpenBadges\Contract

TypeRôle
Contract\Signer, Contract\VerificationKeyUne clé privée qui signe, une clé publique qui vérifie.
Contract\VerificationMethodsTrouve la clé que nomme une méthode de vérification.
Contract\ContextLoaderDonne le contexte JSON-LD d'une URL.
Key\Ed25519Signer, Key\Ed25519KeyEdDSA par libsodium ; JSON Web Keys et Multikeys.
Key\RsaSigner, Key\RsaKeyRS256 par OpenSSL, 2048 bits ou plus.

Sécuriser et vérifier

TypeRôle
Jwt\JwtSigner, Jwt\JwtVerifierVC-JWT, l'algorithme étant pris de la clé.
DataIntegrity\EddsaRdfc2022La suite cryptographique eddsa-rdfc-2022 : sign(), verify(), canonicalize().
DataIntegrity\DidKeyMethodsLes clés de l'application et chaque did:key Ed25519.
JsonLd\BundledContextsLes contextes inclus et ceux que l'application ajoute.
JsonLd\ToRdf, JsonLd\Conversion, JsonLd\ContextProcessor, JsonLd\ActiveContext, JsonLd\TermDefinition, JsonLd\TermDefiningInterne : JSON-LD vers RDF en mode sûr.
Rdf\Canonicalizer, Rdf\IdentifierIssuer, Rdf\NQuadsInterne : RDFC-1.0 et N-Quads canoniques.
Verification\CredentialVerifier, Verification\VerifiedCredentialUn jeton ou un document vérifié, avec sa période et son entrée d'état.

États, relevés, images

TypeRôle
Status\StatusListEntryLe credentialStatus d'un titre.
Status\StatusListLes bits d'une Bitstring Status List, encodés et décodés.
Status\StatusListIssuerLe BitstringStatusListCredential ; applies() y lit un état.
Clr\ClrIssuerUn Comprehensive Learner Record 2.0.
Baking\PngBaker, Baking\SvgBakerUn titre intégré dans une image et lu dans celle-ci.
Baking\BakedInterne : ce qu'une image peut contenir.

Phil\OpenBadges\Encoding et Phil\OpenBadges\Exception

TypeRôle
Encoding\Base64Url, Encoding\Base58Btc, Encoding\MultibaseLes encodages des jetons, des preuves, des clés et des listes.
Exception\OpenBadgesExceptionImplémentée par chaque exception de la bibliothèque.
Exception\InvalidBadge, Exception\InvalidCredential, Exception\InvalidImageVoyez Exceptions.