ansible_sign package

Subpackages

• ansible_sign.checksum package
  • Subpackages
    • ansible_sign.checksum.differ package
      • Submodules
      • ansible_sign.checksum.differ.base module
      • ansible_sign.checksum.differ.distlib_manifest module
      • Module contents
  • Submodules
  • ansible_sign.checksum.base module
    • ChecksumFile
      • ChecksumFile.calculate_checksum()
      • ChecksumFile.calculate_checksums_from_root()
      • ChecksumFile.diff()
      • ChecksumFile.differ_warnings
      • ChecksumFile.generate_gnu_style()
      • ChecksumFile.parse()
      • ChecksumFile.verify()
      • ChecksumFile.warnings
    • ChecksumMismatch
    • InvalidChecksumLine
    • NoDifferException
  • Module contents
• ansible_sign.signing package
  • Subpackages
    • ansible_sign.signing.gpg package
      • Submodules
      • ansible_sign.signing.gpg.signer module
      • ansible_sign.signing.gpg.verifier module
      • Module contents
  • Submodules
  • ansible_sign.signing.base module
    • SignatureSigner
      • SignatureSigner.sign()
    • SignatureSigningResult
    • SignatureVerificationResult
    • SignatureVerifier
      • SignatureVerifier.verify()
  • Module contents

Submodules

ansible_sign.cli module

class ansible_sign.cli.AnsibleSignCLI(args)

Bases: object

gpg_sign()

gpg_verify()

parse_args(args)

Parse command line parameters

Parameters:

args (List[str]) – command line parameters as list of strings (for example ["--help"]).

Returns:

command line parameters namespace

Return type:

argparse.Namespace

run_command()

parse_args() will set self.args.func() to the function we wish to execute, based on the subcommand the user ran. These ‘action functions’ will return the integer exit code with which we exit at the very end.

Roughly: 0 = success 1 = error (e.g. file missing, permissions issue, couldn’t parse checksum file, etc.) 2 = checksum verification failed 3 = signature verification failed 4 = signing failed

validate_checksum()

Validate a checksum manifest file. Print a pretty message and return an appropriate exit code.

NOTE that this function does not actually check the path for existence, it leaves that to the caller (which in nearly all cases would need to do so anyway). This function will throw FileNotFoundError if the manifest does not exist.

ansible_sign.cli.main(args)

ansible_sign.cli.run()

Calls main() passing the CLI arguments extracted from sys.argv

This function can be used as entry point to create console scripts with setuptools.

Module contents