File: check_sigstore_signer.py

package info (click to toggle)
python-securesystemslib 1.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,316 kB
  • sloc: python: 5,319; sh: 38; makefile: 5
file content (120 lines) | stat: -rw-r--r-- 3,967 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
"""
Test SigstoreSigner API.

These tests require git and will use it to fetch a testing identity token from
https://github.com/sigstore-conformance/extremely-dangerous-public-oidc-beacon

Because of these unusual requirements (and because sometimes the fetch may take
a longer time) the test file is named check_* and is not included in the default
tests.
"""

import json
import os
import subprocess
import time
import unittest
from base64 import b64decode
from datetime import datetime, timedelta
from pathlib import Path
from tempfile import TemporaryDirectory
from unittest import mock

from securesystemslib.exceptions import (
    UnverifiedSignatureError,
    VerificationError,
)
from securesystemslib.signer import (
    SIGNER_FOR_URI_SCHEME,
    Signer,
    SigstoreSigner,
)

SIGNER_FOR_URI_SCHEME[SigstoreSigner.SCHEME] = SigstoreSigner

TEST_IDENTITY = (
    "https://github.com/sigstore-conformance/extremely-dangerous-public-oidc-beacon/.github/"
    "workflows/extremely-dangerous-oidc-beacon.yml@refs/heads/main"
)
TEST_ISSUER = "https://token.actions.githubusercontent.com"


def identity_token() -> str:
    """Return identity token for TEST_IDENTITY"""
    # following code is modified from extremely-dangerous-public-oidc-beacon download-token.py.
    # Caching can be made smarter (to return the cached token only if it is valid) if token
    # starts going invalid during runs
    min_validity = timedelta(seconds=5)
    max_retry_time = timedelta(minutes=5 if os.getenv("CI") else 1)
    retry_sleep_secs = 30 if os.getenv("CI") else 5
    git_url = "https://github.com/sigstore-conformance/extremely-dangerous-public-oidc-beacon.git"

    def git_clone(url: str, dir_: str) -> None:
        base_cmd = [
            "git",
            "clone",
            "--quiet",
            "--branch",
            "current-token",
            "--depth",
            "1",
        ]
        subprocess.run(base_cmd + [url, dir_], check=True)

    def is_valid_at(token: str, reference_time: datetime) -> bool:
        # split token, b64 decode (with padding), parse as json, validate expiry
        payload = token.split(".")[1]
        payload += "=" * (4 - len(payload) % 4)
        payload_json = json.loads(b64decode(payload))

        expiry = datetime.fromtimestamp(payload_json["exp"])
        return reference_time < expiry

    start_time = datetime.now()
    while datetime.now() <= start_time + max_retry_time:
        with TemporaryDirectory() as tempdir:
            git_clone(git_url, tempdir)

            with Path(tempdir, "oidc-token.txt").open(encoding="utf-8") as f:
                token = f.read().rstrip()

            if is_valid_at(token, datetime.now() + min_validity):
                return token

        print(
            f"Current token expires too early, retrying in {retry_sleep_secs} seconds."
        )
        time.sleep(retry_sleep_secs)

    raise TimeoutError(f"Failed to find a valid token in {max_retry_time}")


class TestSigstoreSigner(unittest.TestCase):
    """Test public key parsing, signature creation and verification."""

    @classmethod
    def setUpClass(cls):
        cls.token = identity_token()

    def test_sign(self):
        uri, public_key = SigstoreSigner.import_(TEST_IDENTITY, TEST_ISSUER)
        with mock.patch("sigstore.oidc.detect_credential", return_value=self.token):
            signer = Signer.from_priv_key_uri(uri, public_key)

        sig = signer.sign(b"data")

        # Successful verification
        public_key.verify_signature(sig, b"data")

        # Signature mismatch
        with self.assertRaises(UnverifiedSignatureError):
            public_key.verify_signature(sig, b"incorrect data")

        # Broken bundle
        sig.unrecognized_fields["bundle"]["verificationMaterial"] = None
        with self.assertRaises(VerificationError):
            public_key.verify_signature(sig, b"data")


if __name__ == "__main__":
    unittest.main(verbosity=4, buffer=False)