dulwich.signature.GPGCliSignatureVendor

class documentation

class GPGCliSignatureVendor(SignatureSigner, SignatureVerifier):

Signature vendor that uses the GPG command-line tool for signing and verification.

Class Method	`available`	Check if the gpg command is available.
Class Method	`from_config`	Create a GPG CLI vendor from git configuration.
Method	`__init__`	Initialize the GPG CLI vendor.
Method	`sign`	Sign data with a GPG key using the command-line tool.
Method	`verify`	Verify a GPG signature using the command-line tool.
Instance Variable	`gpg_command`	Undocumented

Instance Variable keyids Undocumented

def available(cls) -> bool: ¶

overrides dulwich.signature.SignatureSigner.available

Check if the gpg command is available.

Returns
`bool`	True if gpg command is in PATH, False otherwise

def from_config(cls, config: Config | None = None, keyids: Iterable[str] | None = None) -> GPGCliSignatureVendor: ¶

Create a GPG CLI vendor from git configuration.

Parameters
config:`Config \| None`	Git configuration to read settings from
keyids:`Iterable[str] \| None`	Optional iterable of trusted GPG key IDs for verification

Returns
`GPGCliSignatureVendor`	GPGCliSignatureVendor instance configured from the config

def __init__(self, gpg_command: str = 'gpg', keyids: Iterable[str] | None = None): ¶

overrides dulwich.signature.SignatureVerifier.__init__

Initialize the GPG CLI vendor.

Parameters
gpg_command:`str`	Path to the GPG command (default: "gpg")
keyids:`Iterable[str] \| None`	Optional iterable of trusted GPG key IDs for verification. If provided, only signatures from these keys will be trusted.

def sign(self, data: bytes, keyid: str | None = None) -> bytes: ¶

overrides dulwich.signature.SignatureSigner.sign

Sign data with a GPG key using the command-line tool.

Parameters
data:`bytes`	The data to sign
keyid:`str \| None`	Optional GPG key ID to use for signing. If not specified, the default GPG key will be used.

Returns
`bytes`	The signature as bytes

Raises
`subprocess.CalledProcessError`	if GPG command fails

def verify(self, data: bytes, signature: bytes): ¶

overrides dulwich.signature.SignatureVerifier.verify

Verify a GPG signature using the command-line tool.

Raises
`BadSignature`	if GPG signature verification fails
`UntrustedSignature`	if signature was not created by a trusted key

gpg_command = ¶

Undocumented