Skip to content

Commit 2161846

Browse files
authored
docs: clarify Verifier APIs (sigstore#1310)
Signed-off-by: William Woodruff <[email protected]>
1 parent 1dc531d commit 2161846

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

sigstore/verify/verifier.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ def __init__(self, *, rekor: RekorClient, trusted_root: TrustedRoot):
7676
`rekor` is a `RekorClient` capable of connecting to a Rekor instance
7777
containing logs for the file(s) being verified.
7878
79-
`fulcio_certificate_chain` is a list of PEM-encoded X.509 certificates,
80-
establishing the trust chain for the signing certificate and signature.
79+
`trusted_root` is the `TrustedRoot` object containing the root of trust
80+
for the verification process.
8181
"""
8282
self._rekor = rekor
8383
self._fulcio_certificate_chain: List[X509] = [
@@ -90,6 +90,10 @@ def __init__(self, *, rekor: RekorClient, trusted_root: TrustedRoot):
9090
def production(cls, *, offline: bool = False) -> Verifier:
9191
"""
9292
Return a `Verifier` instance configured against Sigstore's production-level services.
93+
94+
`offline` controls the Trusted Root refresh behavior: if `True`,
95+
the verifier uses the Trusted Root in the local TUF cache. If `False`,
96+
a TUF repository refresh is attempted.
9397
"""
9498
return cls(
9599
rekor=RekorClient.production(),
@@ -100,6 +104,10 @@ def production(cls, *, offline: bool = False) -> Verifier:
100104
def staging(cls, *, offline: bool = False) -> Verifier:
101105
"""
102106
Return a `Verifier` instance configured against Sigstore's staging-level services.
107+
108+
`offline` controls the Trusted Root refresh behavior: if `True`,
109+
the verifier uses the Trusted Root in the local TUF cache. If `False`,
110+
a TUF repository refresh is attempted.
103111
"""
104112
return cls(
105113
rekor=RekorClient.staging(),

0 commit comments

Comments
 (0)