openbadgeslib 0.4.2__tar.gz → 1.1.2__tar.gz

openbadgeslib-1.1.2/Changelog.txt

@@ -0,0 +1,256 @@
+OpenBadgesLib - Changelog
+=========================
+
+Newest first. Dates are ISO 8601 (YYYY-MM-DD).
+
+
+* v1.1.2 - 2026-06-27
+
+  - The -d/--debug flag now actually enables DEBUG-level console logging. It was
+    previously parsed but ignored in openbadges-signer; it is now wired up and
+    also added to openbadges-keygenerator and openbadges-verifier.
+
+  - Packaging metadata refreshed: README is now Markdown, and the project URLs
+    point to the GitHub Wiki (documentation) and the GitHub Pages API reference
+    instead of the old homepage.
+
+  - Docs & infra: the version is single-sourced from util.__version__; CI gates
+    catch doc drift (CLI flags, wiki links); an auto-generated pdoc API site and
+    an auto-synced wiki were added; Changelog normalised; CONTRIBUTORS.txt
+    removed (see docs/authors.rst); pending work is now tracked in GitHub Issues.
+
+
+* v1.1.1 - 2026-06-27
+
+  - OB3: recipient identifiers are normalised through one shared helper, fixing
+    a DID being corrupted into 'mailto:did:...'; the verifier CLI now delegates
+    recipient binding to OB3Verifier.verify() instead of re-implementing it.
+
+  - OB3: verify() cross-checks the JWT registered claims against the vc body -
+    a token whose 'iss'/'sub' disagree with the credential issuer/subject is
+    rejected - and OB3VerificationError now inherits from LibOpenBadgesException
+    so one except clause covers both OB2 and OB3.
+
+  - Refactor: shared keys.alg_for_key_type and CLI config helpers
+    (read_config_or_exit / resolve_badge_section / _resolve_trusted_pubkey)
+    remove the boilerplate duplicated across the entrypoints; first-party code
+    imports openbadgeslib.ob2 directly rather than the back-compat shims; the
+    oversized verify/main/_verify_ob3 functions were decomposed.
+
+  - Type hints added on the OB2/core byte-vs-str boundaries.
+
+  - Tests: OB2 signer CLI, the mail subsystem and read_from_file edge cases are
+    now covered; 258 tests, 92% line coverage; the whole repo (source and
+    tests) is flake8-clean.
+
+  - CI: a GitHub Actions workflow runs flake8 and the test suite on Python
+    3.10-3.13 for every push and pull request.
+
+
+* v1.1.0 - 2026-06-27
+
+  - SECURITY: signature verification now pins the accepted algorithm to the
+    verification key's type instead of trusting the token header. OB3Verifier
+    derives the RS*/ES* family from the key and passes it to jwt.decode;
+    _jws.verify_block rejects any header alg that doesn't match the key. This
+    blocks cross-type confusion and any none/HMAC downgrade.
+
+  - SECURITY: SVG badge XML is parsed with defusedxml, defusing entity-expansion
+    (billion-laughs) DoS on untrusted badges. New defusedxml dependency.
+
+  - SECURITY: iTXt PNG token extraction caps zlib decompression at 256 KB to
+    stop a decompression-bomb DoS during extraction (before verification).
+
+  - SECURITY: the OB2 verifier CLI now distinguishes a trusted operator key
+    (--local/--pubkey) from the badge's own embedded key. Without a trusted key
+    it reports the signature as internally-consistent-only, not "[+] correct"
+    (the embedded key proves nothing about issuer identity). --pubkey now
+    applies to OB2 as well as OB3.
+
+  - SECURITY: check_revocation guards the issuer / revocation-list downloads and
+    JSON parsing, raising a clean VerifierException instead of a raw error.
+
+  - Fixed: _jws base64url padding (wrong when the length was a multiple of 4);
+    BadgeSigned.get_serial_num crashed on badges read from a file (str vs bytes);
+    Verifier.check_identity crashed instead of skipping when no identity was
+    given; extract_svg_assertion could raise NameError masking the real error;
+    unknown key/image types now fail loudly instead of UnboundLocalError.
+
+  - Refactor: a single keys.key_to_pem() replaces three drifting copies, and a
+    new openbadgeslib.baking module is the one home for the SVG/PNG carrier
+    format (OB2 and OB3 share it; the OB2 fixed-offset PNG reader is gone in
+    favour of the structured iTXt parser).
+
+  - Cleanup: removed the redundant setup.py, the stale committed dist/ artifacts
+    and generated MANIFEST, and several never-raised exception classes; docs now
+    cover OB3 on the landing page and document the SMTP/email-badge feature;
+    test import hygiene tidied. 236 tests pass, 87% line coverage.
+
+
+* v1.0.2 - 2026-06-18
+
+  - SECURITY: OB2 verification now uses the operator-supplied trusted key when
+    one is given, instead of always trusting the key the badge points to. A
+    forged badge can no longer self-describe its own verification key.
+
+  - SECURITY: download_file now refuses non-HTTPS URLs by default (the verify
+    key is the OB2 root of trust); pass allow_insecure=True to override.
+
+  - Fixed expiration check: a badge is now considered expired when its
+    expiration date is in the past relative to *now*, not relative to its own
+    issue date (expired badges were previously reported VALID).
+
+  - Fixed openbadges-publish: it copied no verify key and stopped after the
+    first badge (it read a non-existent [keys] section). It now reads each
+    badge's public_key and iterates all badge_* sections.
+
+  - Fixed SMTP: use_ssl is parsed as a boolean (the string 'False' was truthy);
+    connection-level mail errors are caught instead of crashing a successful
+    sign; the example config uses 'username' (matching the code), not 'login'.
+
+  - openbadges-keygenerator now honours a key_type (RSA/ECC) field in the badge
+    profile, so ECC key pairs are reachable from the CLI.
+
+  - OB2 sign log and log files are opened in append mode (were truncated on
+    every run).
+
+  - OB3 credentials use the W3C VC 2.0 data model (validFrom/validUntil,
+    /ns/credentials/v2 context); from_jwt_payload still reads VC 1.1 fields.
+    OB3Verifier.verify() gained an optional expected_recipient argument and now
+    asserts the credential type; PNG token extraction parses the iTXt chunk
+    structure instead of a fixed offset.
+
+  - Robustness: unsigned PNGs raise a clear error instead of crashing;
+    read_from_file raises instead of calling sys.exit; identity is normalised to
+    bytes; revocation handles issuers without a revocationList.
+
+  - Tests: added CLI/publish/keygenerator/mail/revocation coverage and removed
+    the coverage omit list that hid those modules; expiration tests rewritten to
+    model real timestamps.
+
+
+* v1.0.1 - 2026-04-22
+
+  - OpenBadges 3.0 support (W3C Verifiable Credentials / JWT-VC):
+    new openbadgeslib.ob3 subpackage with OpenBadgeCredential, Issuer,
+    Achievement data model; OB3Signer for JWT-VC signing and SVG/PNG
+    baking; OB3Verifier for JWT-VC verification and token extraction.
+
+  - OpenBadges 2.0 implementation moved to openbadgeslib.ob2 subpackage.
+    Top-level badge.py / signer.py / verifier.py kept as backward-compatible
+    shims so existing code continues to work unchanged.
+
+  - All CLI tools (openbadges-keygenerator, openbadges-signer,
+    openbadges-verifier, openbadges-publish) gained a -V / --ob-version
+    flag to select the specification version (2 or 3, default 2).
+
+  - openbadges-verifier: new -k / --pubkey FILE option to supply the
+    public key directly when verifying OB3 badges without a config file.
+
+  - Python 3.10+ compatibility: removed distutils (dropped in 3.12),
+    packaging migrated to pyproject.toml with setuptools.build_meta.
+
+  - Replaced abandoned pycrypto with pycryptodome >= 3.20.
+
+  - Replaced custom bundled JWS engine (3dparty/jws/) with PyJWT[crypto]
+    algorithm classes (RS256/384/512, ES256/384/512). Internal module
+    moved to openbadgeslib/_jws/. Old 3dparty/ directory removed.
+
+  - TLS security fix: download_file relies on urllib's default TLS context
+    (certificate validation on) instead of the deprecated PROTOCOL_TLSv1 /
+    CERT_NONE settings.
+
+  - pypng API update: signature constant renamed, chunk tags now bytes.
+
+  - Copyright year range updated to 2014-2026 across all source files.
+
+  - Bug fixes: verifier signature check logic, ECC private-key detection,
+    hash_email str/bytes coercion.
+
+  - Test suite: 203 tests, 89% line coverage.
+
+
+* v0.4.2
+
+  - Adding support to verifying external openbadges.
+
+  - Adding a new parameter to show assertion before verifying.
+
+  - OpenBadges URLs are verified before the signing process.
+
+
+* v0.4
+
+  - Support for PNG. The library can now verify and sign OpenBadges in PNG
+    format.
+
+  - Support for sending badges via mail.
+
+  - Badge signatures are registered in a log file.
+
+  - Mail code now supports SMTP auth. The config file needs modifications;
+    see the example.
+
+
+* v0.3
+
+  - The email is no longer encoded in the filename when creating a new badge.
+
+  - When creating a badge, "-o" is optional.
+
+  - When specified, "-o" is supposed to be a directory.
+
+  - We can specify "-E" or "--no-evidence" when creating a new badge.
+
+  - When creating a new badge we now need to choose EXPLICITLY between
+    providing evidence or not.
+
+  - Badge sections in the INI file must now be prefixed with "badge_".
+    UPGRADE: if your badge is called "ponente2014", rename it to
+    "badge_ponente2014".
+
+  - Each badge can now have a different key.
+    UPGRADE: move your current key configuration to the badge section,
+    renaming "private" to "private_key" and "public" to "public_key".
+    UPGRADE: "openbadges-keygenerator -g" now requires a badge name.
+
+  - "openbadges-verifier" changes its parameter from "-lk" to "-l" and now
+    needs the name of the badge to locate its public key.
+
+  - "openbadges-verifier" now accepts a parameter -x to specify the expiration
+    for a badge.
+
+  - "openbadges-verifier" now checks the revocation status and the expiration
+    dates of badges.
+
+
+* v0.2.1 - 2014-12-16
+
+  - config.ini now allows configuring the badge json url and image url.
+
+  - Signer now uses randomly salted emails by default in assertions.
+
+  - Compatibility with more SVG formats.
+
+  - Documentation in the "docs" directory.
+
+
+* v0.2 - 2014-12-10
+
+  - "openbadges-init".
+
+  - New configuration format. If you are using the 0.1 format, you must
+    migrate by hand.
+
+  - Tests.
+
+  - Use proper logging instead of simple "print" calls.
+
+  - Massive cleanup of internal imports.
+
+  - Do not change "sys.path".
+
+
+* v0.1 - 2014-12-01
+
+  - Initial release.

{openbadgeslib-0.4.2 → openbadgeslib-1.1.2}/MANIFEST.in

@@ -4,4 +4,4 @@ recursive-include openbadgeslib *
 recursive-include tests *
 recursive-include docs *
 global-exclude __pycache__/*
-include *.txt MANIFEST.in
+include *.txt *.md MANIFEST.in

openbadgeslib-1.1.2/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: openbadgeslib
+Version: 1.1.2
+Summary: A library to sign and verify OpenBadges
+Author-email: Luis González Fernández <luisgf@luisgf.es>, Jesús Cea Avión <jcea@jcea.es>
+License: LGPLv3
+Project-URL: Homepage, https://github.com/luisgf/openbadgeslib
+Project-URL: Documentation, https://github.com/luisgf/openbadgeslib/wiki
+Project-URL: API Reference, https://luisgf.github.io/openbadgeslib/
+Project-URL: Source, https://github.com/luisgf/openbadgeslib
+Project-URL: Changelog, https://github.com/luisgf/openbadgeslib/blob/master/Changelog.txt
+Keywords: openbadges
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: English
+Classifier: Natural Language :: Spanish
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: pycryptodome>=3.20
+Requires-Dist: ecdsa>=0.19
+Requires-Dist: pypng>=0.20220715.0
+Requires-Dist: PyJWT[crypto]>=2.8
+Requires-Dist: defusedxml>=0.7
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: flake8>=7.0; extra == "dev"
+Requires-Dist: pdoc>=14; extra == "dev"
+Dynamic: license-file
+
+# OpenBadgesLib
+
+[![CI](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml/badge.svg)](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/openbadgeslib.svg)](https://pypi.org/project/openbadgeslib/)
+[![Python](https://img.shields.io/badge/python-3.10%E2%80%933.13-blue.svg)](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-LGPLv3%20%2F%20BSD-blue.svg)](#license)
+
+A Python library and CLI for signing and verifying
+[Open Badges](https://www.imsglobal.org/activity/digital-badges) embedded in SVG
+and PNG image files. It supports both **OpenBadges 2.0** (JWS compact
+serialisation) and **OpenBadges 3.0** (W3C Verifiable Credentials / JWT-VC).
+
+## Features
+
+- Sign badge images (SVG and PNG) with a JWS assertion (OB 2.0)
+- Issue and verify OpenBadges 3.0 JWT-VC credentials
+- Bake OB 3.0 JWT tokens into SVG and PNG badge images
+- RSA 2048-bit (RS256) and ECC NIST P-256 (ES256) key support
+- SHA-256 hashed recipient identity with salt (OB 2.0)
+- Expiration and revocation checking
+- Five command-line tools included
+
+## Requirements
+
+- Python >= 3.10 (tested on 3.10–3.13)
+- [pycryptodome](https://pypi.org/project/pycryptodome/) >= 3.20
+- [ecdsa](https://pypi.org/project/ecdsa/) >= 0.19
+- [pypng](https://pypi.org/project/pypng/) >= 0.20220715.0
+- [PyJWT[crypto]](https://pypi.org/project/PyJWT/) >= 2.8
+- [defusedxml](https://pypi.org/project/defusedxml/) >= 0.7
+
+## Installation
+
+```bash
+pip install openbadgeslib
+```
+
+All dependencies are installed automatically. For a development checkout with
+the test suite and linters:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+# 1. Initialize a configuration directory
+openbadges-init ./config/
+
+# 2. Generate a key pair for a badge
+openbadges-keygenerator -c ./config/config.ini -g 1
+
+# 3a. Sign a badge — OpenBadges 2.0 (default)
+openbadges-signer -c ./config/config.ini -b 1 -r recipient@example.com -o /tmp/ -E
+
+# 3b. Sign a badge — OpenBadges 3.0
+openbadges-signer -c ./config/config.ini -b 1 -r recipient@example.com -o /tmp/ -E -V 3
+
+# 4a. Verify — OpenBadges 2.0 (pin a trusted key with -l/--local or -k/--pubkey)
+openbadges-verifier -i /tmp/badge_1_recipient@example.com.svg \
+    -r recipient@example.com -l 1
+
+# 4b. Verify — OpenBadges 3.0
+openbadges-verifier -i /tmp/badge_1_recipient@example.com.svg \
+    -r recipient@example.com -V 3 -k ./config/keys/verify_rsa_key_1.pem
+```
+
+See the [Quick Start](https://github.com/luisgf/openbadgeslib/wiki/Quick-Start)
+and [CLI Reference](https://github.com/luisgf/openbadgeslib/wiki/CLI-Reference)
+wiki pages for the full walkthrough and every flag.
+
+## Using the library — OpenBadges 2.0
+
+```python
+from openbadgeslib.ob2 import Badge, BadgeImgType, BadgeType, Signer
+from openbadgeslib.keys import KeyType
+
+with open('sign.pem', 'rb') as f:
+    priv_pem = f.read()
+with open('verify.pem', 'rb') as f:
+    pub_pem = f.read()
+with open('badge.svg', 'rb') as f:
+    image = f.read()
+
+badge = Badge(
+    ini_name='my_badge',
+    name='My Badge',
+    description='Awarded for excellence',
+    image_type=BadgeImgType.SVG,
+    image=image,
+    image_url='https://example.com/badge.svg',
+    criteria_url='https://example.com/criteria.html',
+    json_url='https://example.com/badge.json',
+    verify_key_url='https://example.com/verify.pem',
+    key_type=KeyType.RSA,
+    privkey_pem=priv_pem,
+    pubkey_pem=pub_pem,
+)
+
+signer = Signer(identity='recipient@example.com', badge_type=BadgeType.SIGNED)
+signed = signer.sign_badge(badge)
+signed.save_to_file('/tmp/signed_badge.svg')
+```
+
+## Using the library — OpenBadges 3.0 (JWT-VC)
+
+```python
+from openbadgeslib.ob3 import (
+    Issuer, Achievement, OpenBadgeCredential, OB3Signer, OB3Verifier,
+)
+
+issuer = Issuer(id='https://example.com/issuer', name='Example Org')
+achievement = Achievement(
+    id='https://example.com/achievements/python',
+    name='Python Developer',
+    description='Awarded for Python proficiency',
+    criteria_narrative='Must pass the Python assessment',
+)
+credential = OpenBadgeCredential(
+    issuer=issuer,
+    recipient_id='mailto:recipient@example.com',
+    achievement=achievement,
+)
+
+with open('sign.pem', 'rb') as f:
+    priv_pem = f.read()
+signer = OB3Signer(privkey_pem=priv_pem, algorithm='RS256')
+
+# Bake the signed JWT-VC into a badge image
+with open('badge.svg', 'rb') as f:
+    baked_svg = signer.sign_into_svg(credential, f.read())
+
+# Verify
+with open('verify.pem', 'rb') as f:
+    verifier = OB3Verifier(pubkey_pem=f.read())
+token = OB3Verifier.extract_token_from_svg(baked_svg)
+restored = verifier.verify(token, expected_recipient='recipient@example.com')
+print('Recipient:', restored.recipient_id)
+```
+
+## Documentation
+
+- **User & developer guide** — the project [**Wiki**](https://github.com/luisgf/openbadgeslib/wiki):
+  installation, configuration, concepts, the security model, CLI reference and
+  how-to guides.
+- **API reference** — generated from the docstrings and published at
+  [**luisgf.github.io/openbadgeslib**](https://luisgf.github.io/openbadgeslib/).
+
+## Running the test suite
+
+```bash
+pytest
+pytest --cov=openbadgeslib      # with coverage report
+flake8 openbadgeslib tests      # lint
+```
+
+## Changelog
+
+See [`Changelog.txt`](Changelog.txt) for the full history, and the
+[GitHub Releases](https://github.com/luisgf/openbadgeslib/releases) page for
+release notes.
+
+## License
+
+The **library** (`openbadgeslib/` package) is licensed under the
+[GNU Lesser General Public License v3](https://opensource.org/licenses/lgpl-3.0.html)
+(LGPLv3). The **command-line wrapper tools** are licensed under the
+[BSD 2-Clause](https://opensource.org/licenses/BSD-2-Clause) license.
+
+## Authors
+
+- Luis González Fernández <luisgf@luisgf.es>
+- Jesús Cea Avión <jcea@jcea.es>

openbadgeslib-1.1.2/README.md

@@ -0,0 +1,174 @@
+# OpenBadgesLib
+
+[![CI](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml/badge.svg)](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/openbadgeslib.svg)](https://pypi.org/project/openbadgeslib/)
+[![Python](https://img.shields.io/badge/python-3.10%E2%80%933.13-blue.svg)](https://github.com/luisgf/openbadgeslib/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-LGPLv3%20%2F%20BSD-blue.svg)](#license)
+
+A Python library and CLI for signing and verifying
+[Open Badges](https://www.imsglobal.org/activity/digital-badges) embedded in SVG
+and PNG image files. It supports both **OpenBadges 2.0** (JWS compact
+serialisation) and **OpenBadges 3.0** (W3C Verifiable Credentials / JWT-VC).
+
+## Features
+
+- Sign badge images (SVG and PNG) with a JWS assertion (OB 2.0)
+- Issue and verify OpenBadges 3.0 JWT-VC credentials
+- Bake OB 3.0 JWT tokens into SVG and PNG badge images
+- RSA 2048-bit (RS256) and ECC NIST P-256 (ES256) key support
+- SHA-256 hashed recipient identity with salt (OB 2.0)
+- Expiration and revocation checking
+- Five command-line tools included
+
+## Requirements
+
+- Python >= 3.10 (tested on 3.10–3.13)
+- [pycryptodome](https://pypi.org/project/pycryptodome/) >= 3.20
+- [ecdsa](https://pypi.org/project/ecdsa/) >= 0.19
+- [pypng](https://pypi.org/project/pypng/) >= 0.20220715.0
+- [PyJWT[crypto]](https://pypi.org/project/PyJWT/) >= 2.8
+- [defusedxml](https://pypi.org/project/defusedxml/) >= 0.7
+
+## Installation
+
+```bash
+pip install openbadgeslib
+```
+
+All dependencies are installed automatically. For a development checkout with
+the test suite and linters:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```bash
+# 1. Initialize a configuration directory
+openbadges-init ./config/
+
+# 2. Generate a key pair for a badge
+openbadges-keygenerator -c ./config/config.ini -g 1
+
+# 3a. Sign a badge — OpenBadges 2.0 (default)
+openbadges-signer -c ./config/config.ini -b 1 -r recipient@example.com -o /tmp/ -E
+
+# 3b. Sign a badge — OpenBadges 3.0
+openbadges-signer -c ./config/config.ini -b 1 -r recipient@example.com -o /tmp/ -E -V 3
+
+# 4a. Verify — OpenBadges 2.0 (pin a trusted key with -l/--local or -k/--pubkey)
+openbadges-verifier -i /tmp/badge_1_recipient@example.com.svg \
+    -r recipient@example.com -l 1
+
+# 4b. Verify — OpenBadges 3.0
+openbadges-verifier -i /tmp/badge_1_recipient@example.com.svg \
+    -r recipient@example.com -V 3 -k ./config/keys/verify_rsa_key_1.pem
+```
+
+See the [Quick Start](https://github.com/luisgf/openbadgeslib/wiki/Quick-Start)
+and [CLI Reference](https://github.com/luisgf/openbadgeslib/wiki/CLI-Reference)
+wiki pages for the full walkthrough and every flag.
+
+## Using the library — OpenBadges 2.0
+
+```python
+from openbadgeslib.ob2 import Badge, BadgeImgType, BadgeType, Signer
+from openbadgeslib.keys import KeyType
+
+with open('sign.pem', 'rb') as f:
+    priv_pem = f.read()
+with open('verify.pem', 'rb') as f:
+    pub_pem = f.read()
+with open('badge.svg', 'rb') as f:
+    image = f.read()
+
+badge = Badge(
+    ini_name='my_badge',
+    name='My Badge',
+    description='Awarded for excellence',
+    image_type=BadgeImgType.SVG,
+    image=image,
+    image_url='https://example.com/badge.svg',
+    criteria_url='https://example.com/criteria.html',
+    json_url='https://example.com/badge.json',
+    verify_key_url='https://example.com/verify.pem',
+    key_type=KeyType.RSA,
+    privkey_pem=priv_pem,
+    pubkey_pem=pub_pem,
+)
+
+signer = Signer(identity='recipient@example.com', badge_type=BadgeType.SIGNED)
+signed = signer.sign_badge(badge)
+signed.save_to_file('/tmp/signed_badge.svg')
+```
+
+## Using the library — OpenBadges 3.0 (JWT-VC)
+
+```python
+from openbadgeslib.ob3 import (
+    Issuer, Achievement, OpenBadgeCredential, OB3Signer, OB3Verifier,
+)
+
+issuer = Issuer(id='https://example.com/issuer', name='Example Org')
+achievement = Achievement(
+    id='https://example.com/achievements/python',
+    name='Python Developer',
+    description='Awarded for Python proficiency',
+    criteria_narrative='Must pass the Python assessment',
+)
+credential = OpenBadgeCredential(
+    issuer=issuer,
+    recipient_id='mailto:recipient@example.com',
+    achievement=achievement,
+)
+
+with open('sign.pem', 'rb') as f:
+    priv_pem = f.read()
+signer = OB3Signer(privkey_pem=priv_pem, algorithm='RS256')
+
+# Bake the signed JWT-VC into a badge image
+with open('badge.svg', 'rb') as f:
+    baked_svg = signer.sign_into_svg(credential, f.read())
+
+# Verify
+with open('verify.pem', 'rb') as f:
+    verifier = OB3Verifier(pubkey_pem=f.read())
+token = OB3Verifier.extract_token_from_svg(baked_svg)
+restored = verifier.verify(token, expected_recipient='recipient@example.com')
+print('Recipient:', restored.recipient_id)
+```
+
+## Documentation
+
+- **User & developer guide** — the project [**Wiki**](https://github.com/luisgf/openbadgeslib/wiki):
+  installation, configuration, concepts, the security model, CLI reference and
+  how-to guides.
+- **API reference** — generated from the docstrings and published at
+  [**luisgf.github.io/openbadgeslib**](https://luisgf.github.io/openbadgeslib/).
+
+## Running the test suite
+
+```bash
+pytest
+pytest --cov=openbadgeslib      # with coverage report
+flake8 openbadgeslib tests      # lint
+```
+
+## Changelog
+
+See [`Changelog.txt`](Changelog.txt) for the full history, and the
+[GitHub Releases](https://github.com/luisgf/openbadgeslib/releases) page for
+release notes.
+
+## License
+
+The **library** (`openbadgeslib/` package) is licensed under the
+[GNU Lesser General Public License v3](https://opensource.org/licenses/lgpl-3.0.html)
+(LGPLv3). The **command-line wrapper tools** are licensed under the
+[BSD 2-Clause](https://opensource.org/licenses/BSD-2-Clause) license.
+
+## Authors
+
+- Luis González Fernández <luisgf@luisgf.es>
+- Jesús Cea Avión <jcea@jcea.es>

openbadgeslib-1.1.2/docs/authors.rst

@@ -0,0 +1,21 @@
+Authors
+=======
+
+Contributors
+------------
+
+Sorted alphabetically:
+
+* Jesús Cea Avión <jcea@jcea.es>
+* Luis González Fernández <luisgf@luisgf.es>
+
+
+License
+-------
+
+The **library** (``openbadgeslib/`` package) is licensed under the terms of
+the :term:`LGPL3`.
+
+The **command-line wrapper tools** (``openbadges-init``,
+``openbadges-keygenerator``, ``openbadges-signer``, ``openbadges-verifier``,
+``openbadges-publish``) are licensed under the :term:`BSD 2-Clause` licence.