openbadgeslib 3.0.0__tar.gz → 3.0.1__tar.gz

{openbadgeslib-3.0.0 → openbadgeslib-3.0.1}/Changelog.txt

@@ -4,6 +4,14 @@ OpenBadgesLib - Changelog
 Newest first. Dates are ISO 8601 (YYYY-MM-DD).
 
 
+* v3.0.1 - 2026-07-02
+
+  - fix(cli): the OpenBadges 1.0 signer (`-V 1`) now writes the signed badge
+    before appending to the audit log, and guards the log write, so a missing
+    or unwritable `base_log` reports a clean error instead of crashing with a
+    raw OSError and losing the already-signed badge (matches the OB2 path).
+
+
 * v3.0.0 - 2026-07-01
 
   - BREAKING: the pre-2.0 wire format previously shipped as `-V 2` is relabelled

{openbadgeslib-3.0.0/openbadgeslib.egg-info → openbadgeslib-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openbadgeslib
-Version: 3.0.0
+Version: 3.0.1
 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

{openbadgeslib-3.0.0 → openbadgeslib-3.0.1}/openbadgeslib/openbadges_signer.py

@@ -233,15 +233,21 @@ def _sign_ob1(args: argparse.Namespace, conf: configparser.ConfigParser, badge:
     badge_signed = sf.sign_badge(badge_obj)
 
     if badge_signed:
+        # Persist the signed badge first, then append to the audit log. Writing
+        # the log first and unguarded meant a missing/unwritable base_log raised
+        # a raw OSError out of the CLI and lost the already-signed badge; mirror
+        # the OB2 path — save, then log inside try/except.
+        badge_signed.save_to_file(badge_file_out)
+
         sign_log = os.path.join(conf['paths']['base_log'], conf['logs']['signer'])
-        msg = '%s %s SIGNED for %s UID %s\n' \
+        msg = '%s %s SIGNED for %s UID %s' \
             % (datetime.today().isoformat(), badge,
                badge_signed.get_identity(), badge_signed.get_serial_num())
-
-        with open(sign_log, 'a') as file:
-            file.write(msg)
-
-        badge_signed.save_to_file(badge_file_out)
+        try:
+            with open(sign_log, 'a') as file:
+                file.write(msg + '\n')
+        except OSError as err:
+            print('[!] Could not write sign log: %s' % err)
 
         if bool(args.mail_badge):
             server = conf['smtp']['smtp_server']
@@ -266,7 +272,7 @@ def _sign_ob1(args: argparse.Namespace, conf: configparser.ConfigParser, badge:
                 # crashing with a traceback.
                 print('[!] Could not send mail: %s' % err)
 
-        print('%s at: %s' % (msg.strip('\n'), badge_file_out))
+        print('%s at: %s' % (msg, badge_file_out))
 
 
 def _sign_ob3(args: argparse.Namespace, conf: configparser.ConfigParser, badge: str,

{openbadgeslib-3.0.0 → openbadgeslib-3.0.1}/openbadgeslib/util.py

@@ -21,7 +21,7 @@
         License along with this library.
 """
 
-__version__ = '3.0.0'
+__version__ = '3.0.1'
 
 import hashlib
 import ipaddress

{openbadgeslib-3.0.0 → openbadgeslib-3.0.1/openbadgeslib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openbadgeslib
-Version: 3.0.0
+Version: 3.0.1
 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

{openbadgeslib-3.0.0 → openbadgeslib-3.0.1}/tests/test_cli_smoke.py

@@ -303,6 +303,37 @@ def test_signer_ob3_then_verify_roundtrip(tmp_path, capsys):
     assert 'valid' in capsys.readouterr().out.lower()
 
 
+def test_signer_ob1_missing_log_dir_still_saves_badge(tmp_path, svg_rsa_badge, capsys):
+    """A missing/unwritable base_log must not crash OB1 signing or lose the
+    already-signed badge: the badge is saved and a clean [!] message is printed
+    instead of a raw OSError traceback (mirrors the OB2 signer's handling)."""
+    import argparse
+    from pathlib import Path
+    from openbadgeslib import openbadges_signer
+
+    # base_log points at a directory that does not exist (its parent too).
+    conf = {
+        'paths': {'base_log': str(tmp_path / 'nonexistent' / 'log')},
+        'logs': {'signer': 'signer.log'},
+    }
+    badge_file_out = str(tmp_path / 'badge_out.svg')
+    args = argparse.Namespace(receptor='user@example.com', expires=None,
+                              mail_badge=False)
+
+    # Bypass the network reachability precheck (the badge's URLs are unreachable
+    # in tests); the path under test is the save/log ordering after it.
+    with patch.object(openbadges_signer.Badge, 'urls_has_problems',
+                      return_value=False):
+        openbadges_signer._sign_ob1(args, conf, 'badge_test_1', svg_rsa_badge,
+                                    badge_file_out, evidence=None)
+
+    out = capsys.readouterr().out
+    # The signed badge is written despite the log failure ...
+    assert Path(badge_file_out).is_file()
+    # ... and the failure is reported cleanly rather than as a traceback.
+    assert 'Could not write sign log' in out
+
+
 # ── openbadges-publish ──────────────────────────────────────────────────────────
 
 def test_publish_ob3_prints_info(tmp_path, capsys):