dulwich.signature.SignatureSigner

class documentation

class SignatureSigner:

Known subclasses: dulwich.signature.GPGCliSignatureVendor, dulwich.signature.GPGSignatureVendor, dulwich.signature.SSHCliSignatureVendor, dulwich.signature.X509SignatureVendor

View In Hierarchy

A signature implementation for signing Git objects.

Class Method	`available`	Check if this signature signer is available.
Method	`sign`	Sign data with a key.

@classmethod

def available(cls) -> bool: ¶

overridden in dulwich.signature.GPGCliSignatureVendor, dulwich.signature.GPGSignatureVendor, dulwich.signature.SSHCliSignatureVendor, dulwich.signature.X509SignatureVendor

Check if this signature signer is available.

Returns
`bool`	True if the signer's dependencies are available, False otherwise

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

overridden in dulwich.signature.GPGCliSignatureVendor, dulwich.signature.GPGSignatureVendor, dulwich.signature.SSHCliSignatureVendor, dulwich.signature.X509SignatureVendor

Sign data with a key.

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

Returns
`bytes`	The signature as bytes