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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
"""Signer implementation for project sigstore."""
from __future__ import annotations
import json
import logging
from typing import Any
from urllib import parse
from securesystemslib.exceptions import (
UnsupportedLibraryError,
UnverifiedSignatureError,
VerificationError,
)
from securesystemslib.signer._signer import (
Key,
SecretsHandler,
Signature,
Signer,
)
from securesystemslib.signer._utils import compute_default_keyid
IMPORT_ERROR = "sigstore library required to use 'sigstore-oidc' keys"
logger = logging.getLogger(__name__)
class SigstoreKey(Key):
"""Sigstore verifier.
NOTE: The Sigstore key and signature serialization formats are not yet
considered stable in securesystemslib. They may change in future releases
and may not be supported by other implementations.
"""
DEFAULT_KEY_TYPE = "sigstore-oidc"
DEFAULT_SCHEME = "Fulcio"
def __init__(
self,
keyid: str,
keytype: str,
scheme: str,
keyval: dict[str, Any],
unrecognized_fields: dict[str, Any] | None = None,
):
for content in ["identity", "issuer"]:
if content not in keyval or not isinstance(keyval[content], str):
raise ValueError(f"{content} string required for scheme {scheme}")
super().__init__(keyid, keytype, scheme, keyval, unrecognized_fields)
@classmethod
def from_dict(cls, keyid: str, key_dict: dict[str, Any]) -> SigstoreKey:
keytype, scheme, keyval = cls._from_dict(key_dict)
return cls(keyid, keytype, scheme, keyval, key_dict)
def to_dict(self) -> dict:
return self._to_dict()
def verify_signature(self, signature: Signature, data: bytes) -> None:
try:
from sigstore.errors import VerificationError as SigstoreVerifyError
from sigstore.models import Bundle
from sigstore.verify import Verifier
from sigstore.verify.policy import Identity
except ImportError as e:
raise VerificationError(IMPORT_ERROR) from e
try:
verifier = Verifier.production()
identity = Identity(
identity=self.keyval["identity"], issuer=self.keyval["issuer"]
)
bundle_data = signature.unrecognized_fields["bundle"]
bundle = Bundle.from_json(json.dumps(bundle_data))
verifier.verify_artifact(data, bundle, identity)
except SigstoreVerifyError as e:
logger.info(
"Key %s failed to verify sig: %s",
self.keyid,
e,
)
raise UnverifiedSignatureError(
f"Failed to verify signature by {self.keyid}"
) from e
except Exception as e:
logger.info("Key %s failed to verify sig: %s", self.keyid, str(e))
raise VerificationError(
f"Unknown failure to verify signature by {self.keyid}"
) from e
class SigstoreSigner(Signer):
"""Sigstore signer.
NOTE: The Sigstore key and signature serialization formats are not yet
considered stable in securesystemslib. They may change in future releases
and may not be supported by other implementations.
All signers should be instantiated with ``Signer.from_priv_key_uri()``.
Unstable ``SigstoreSigner`` currently requires opt-in via
``securesystemslib.signer.SIGNER_FOR_URI_SCHEME``.
Usage::
identity = "luk.puehringer@gmail.com" # change, unless you know pw
issuer = "https://github.com/login/oauth"
# Create signer URI and public key for identity and issuer
uri, public_key = SigstoreSigner.import_(identity, issuer, ambient=False)
# Load signer from URI -- requires browser login with GitHub
signer = SigstoreSigner.from_priv_key_uri(uri, public_key)
# Sign with signer and verify public key
signature = signer.sign(b"data")
public_key.verify_signature(signature, b"data")
The private key URI scheme is "sigstore:?<PARAMS>", where PARAMS is
optional and toggles ambient credential usage. Example URIs:
* "sigstore:":
Sign with ambient credentials.
* "sigstore:?ambient=false":
Sign with OAuth2 + OpenID via browser login.
Arguments:
token: The OIDC identity token used for signing.
public_key: The related public key instance.
Raises:
UnsupportedLibraryError: sigstore library not found.
"""
SCHEME = "sigstore"
def __init__(self, token: Any, public_key: Key):
self._public_key = public_key
# token is of type sigstore.oidc.IdentityToken but the module should be usable
# without sigstore so it's not annotated
self._token = token
@property
def public_key(self) -> Key:
return self._public_key
@classmethod
def from_priv_key_uri(
cls,
priv_key_uri: str,
public_key: Key,
secrets_handler: SecretsHandler | None = None,
) -> SigstoreSigner:
try:
from sigstore.oidc import IdentityToken, Issuer, detect_credential
except ImportError as e:
raise UnsupportedLibraryError(IMPORT_ERROR) from e
if not isinstance(public_key, SigstoreKey):
raise ValueError(f"expected SigstoreKey for {priv_key_uri}")
uri = parse.urlparse(priv_key_uri)
if uri.scheme != cls.SCHEME:
raise ValueError(f"SigstoreSigner does not support {priv_key_uri}")
params = dict(parse.parse_qsl(uri.query))
ambient = params.get("ambient", "true") == "true"
if not ambient:
# TODO: Restrict oauth flow to use identity/issuer from public_key
# TODO: Use secrets_handler for identity_token() secret arg
token = Issuer.production().identity_token()
else:
credential = detect_credential()
if not credential:
raise RuntimeError("Failed to detect Sigstore credentials")
token = IdentityToken(credential)
key_identity = public_key.keyval["identity"]
key_issuer = public_key.keyval["issuer"]
if key_issuer != token.federated_issuer:
raise ValueError(
f"Signer identity issuer {token.federated_issuer} "
f"did not match key: {key_issuer}"
)
# TODO: should check ambient identity too: unfortunately IdentityToken does
# not provide access to the expected identity value (cert SAN) in ambient case
if not ambient and key_identity != token.identity:
raise ValueError(
f"Signer identity {token.identity} did not match key: {key_identity}"
)
return cls(token, public_key)
@classmethod
def _get_uri(cls, ambient: bool) -> str:
return f"{cls.SCHEME}:{'' if ambient else '?ambient=false'}"
@classmethod
def import_(
cls, identity: str, issuer: str, ambient: bool = True
) -> tuple[str, SigstoreKey]:
"""Create public key and signer URI.
Returns a private key URI (for Signer.from_priv_key_uri()) and a public
key. import_() should be called once and the returned URI and public
key should be stored for later use.
Arguments:
identity: The OIDC identity to use when verifying a signature.
issuer: The OIDC issuer to use when verifying a signature.
ambient: Toggle usage of ambient credentials in returned URI.
"""
keytype = SigstoreKey.DEFAULT_KEY_TYPE
scheme = SigstoreKey.DEFAULT_SCHEME
keyval = {"identity": identity, "issuer": issuer}
keyid = compute_default_keyid(keytype, scheme, keyval)
key = SigstoreKey(keyid, keytype, scheme, keyval)
uri = cls._get_uri(ambient)
return uri, key
@classmethod
def import_via_auth(cls) -> tuple[str, SigstoreKey]:
"""Create public key and signer URI by interactive authentication
Returns a private key URI (for Signer.from_priv_key_uri()) and a public
key. This method always uses the interactive authentication.
"""
try:
from sigstore.oidc import Issuer
except ImportError as e:
raise UnsupportedLibraryError(IMPORT_ERROR) from e
# authenticate to get the identity and issuer
token = Issuer.production().identity_token()
return cls.import_(token.identity, token.federated_issuer, False)
def sign(self, payload: bytes) -> Signature:
"""Signs payload using the OIDC token on the signer instance.
Arguments:
payload: bytes to be signed.
Raises:
Various errors from sigstore-python.
Returns:
Signature.
NOTE: The relevant data is in `unrecognized_fields["bundle"]`.
"""
try:
from sigstore.sign import SigningContext
except ImportError as e:
raise UnsupportedLibraryError(IMPORT_ERROR) from e
context = SigningContext.production()
with context.signer(self._token) as sigstore_signer:
bundle = sigstore_signer.sign_artifact(payload)
# We want to access the actual signature, see
# https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
bundle_json = json.loads(bundle.to_json())
return Signature(
self.public_key.keyid,
bundle_json["messageSignature"]["signature"],
{"bundle": bundle_json},
)
@classmethod
def import_github_actions(
cls, project: str, workflow_path: str, ref: str | None = "refs/heads/main"
) -> tuple[str, SigstoreKey]:
"""Convenience method to build identity and issuer string for import_() from
GitHub project and workflow path.
Args:
project: GitHub project name (example:
"secure-systems-lab/securesystemslib")
workflow_path: GitHub workflow path (example:
".github/workflows/online-sign.yml")
ref: optional GitHub ref, defaults to refs/heads/main
Returns:
uri: string
key: SigstoreKey
"""
identity = f"https://github.com/{project}/{workflow_path}@{ref}"
issuer = "https://token.actions.githubusercontent.com"
uri, key = cls.import_(identity, issuer)
return uri, key
|