certbot-apache 4.2.0__tar.gz → 5.1.0__tar.gz

{certbot_apache-4.2.0/src/certbot_apache.egg-info → certbot_apache-5.1.0}/PKG-INFO

@@ -1,45 +1,37 @@
 Metadata-Version: 2.4
 Name: certbot-apache
-Version: 4.2.0
+Version: 5.1.0
 Summary: Apache plugin for Certbot
-Home-page: https://github.com/certbot/certbot
-Author: Certbot Project
-Author-email: certbot-dev@eff.org
-License: Apache License 2.0
+Author-email: Certbot Project <certbot-dev@eff.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/certbot/certbot
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Plugins
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Security
 Classifier: Topic :: System :: Installation/Setup
 Classifier: Topic :: System :: Networking
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Utilities
-Requires-Python: >=3.9.2
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
-Requires-Dist: acme>=4.2.0
-Requires-Dist: certbot>=4.2.0
+Requires-Dist: acme>=5.1.0
+Requires-Dist: certbot>=5.1.0
 Requires-Dist: python-augeas
 Provides-Extra: dev
 Requires-Dist: apacheconfig>=0.3.2; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: provides-extra
 Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+
+Apache plugin for Certbot

certbot_apache-5.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "certbot-apache"
+dynamic = ["version", "dependencies"]
+description = "Apache plugin for Certbot"
+readme = "README.rst"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+authors = [
+    { name = "Certbot Project", email = "certbot-dev@eff.org" },
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Plugins",
+    "Intended Audience :: System Administrators",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Security",
+    "Topic :: System :: Installation/Setup",
+    "Topic :: System :: Networking",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
+]
+
+[project.optional-dependencies]
+dev = [
+    "apacheconfig>=0.3.2",
+]
+test = [
+    "pytest",
+]
+
+[project.entry-points."certbot.plugins"]
+apache = "certbot_apache._internal.entrypoint:ENTRYPOINT"
+
+[project.urls]
+Homepage = "https://github.com/certbot/certbot"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

certbot_apache-5.1.0/setup.py

@@ -0,0 +1,17 @@
+from setuptools import setup
+
+version = '5.1.0'
+
+install_requires = [
+    # We specify the minimum acme and certbot version as the current plugin
+    # version for simplicity. See
+    # https://github.com/certbot/certbot/issues/8761 for more info.
+    f'acme>={version}',
+    f'certbot>={version}',
+    'python-augeas',
+]
+
+setup(
+    version=version,
+    install_requires=install_requires,
+)

{certbot_apache-4.2.0 → certbot_apache-5.1.0}/src/certbot_apache/_internal/apache_util.py

@@ -7,11 +7,8 @@ import logging
 import re
 import subprocess
 from contextlib import ExitStack
-from typing import Dict
 from typing import Iterable
-from typing import List
 from typing import Optional
-from typing import Tuple
 
 from certbot import errors
 from certbot import util
@@ -20,7 +17,7 @@ from certbot.compat import os
 logger = logging.getLogger(__name__)
 
 
-def get_mod_deps(mod_name: str) -> List[str]:
+def get_mod_deps(mod_name: str) -> list[str]:
     """Get known module dependencies.
 
     .. note:: This does not need to be accurate in order for the client to
@@ -68,7 +65,7 @@ def get_internal_aug_path(vhost_path: str) -> str:
     return _split_aug_path(vhost_path)[1]
 
 
-def _split_aug_path(vhost_path: str) -> Tuple[str, str]:
+def _split_aug_path(vhost_path: str) -> tuple[str, str]:
     """Splits an Augeas path into a file path and an internal path.
 
     After removing "/files", this function splits vhost_path into the
@@ -82,7 +79,7 @@ def _split_aug_path(vhost_path: str) -> Tuple[str, str]:
     """
     # Strip off /files
     file_path = vhost_path[6:]
-    internal_path: List[str] = []
+    internal_path: list[str] = []
 
     # Remove components from the end of file_path until it becomes valid
     while not os.path.exists(file_path):
@@ -92,7 +89,7 @@ def _split_aug_path(vhost_path: str) -> Tuple[str, str]:
     return file_path, "/".join(reversed(internal_path))
 
 
-def parse_define_file(filepath: str, varname: str) -> Dict[str, str]:
+def parse_define_file(filepath: str, varname: str) -> dict[str, str]:
     """ Parses Defines from a variable in configuration file
 
     :param str filepath: Path of file to parse
@@ -102,7 +99,7 @@ def parse_define_file(filepath: str, varname: str) -> Dict[str, str]:
     :rtype: `dict`
 
     """
-    return_vars: Dict[str, str] = {}
+    return_vars: dict[str, str] = {}
     # Get list of words in the variable
     a_opts = util.get_var_from_file(varname, filepath).split()
     for i, v in enumerate(a_opts):
@@ -137,7 +134,7 @@ def included_in_paths(filepath: str, paths: Iterable[str]) -> bool:
     return any(fnmatch.fnmatch(filepath, path) for path in paths)
 
 
-def parse_defines(define_cmd: List[str]) -> Dict[str, str]:
+def parse_defines(define_cmd: list[str]) -> dict[str, str]:
     """
     Gets Defines from httpd process and returns a dictionary of
     the defined variables.
@@ -148,7 +145,7 @@ def parse_defines(define_cmd: List[str]) -> Dict[str, str]:
     :rtype: dict
     """
 
-    variables: Dict[str, str] = {}
+    variables: dict[str, str] = {}
     matches = parse_from_subprocess(define_cmd, r"Define: ([^ \n]*)")
     try:
         matches.remove("DUMP_RUN_CFG")
@@ -164,7 +161,7 @@ def parse_defines(define_cmd: List[str]) -> Dict[str, str]:
     return variables
 
 
-def parse_includes(inc_cmd: List[str]) -> List[str]:
+def parse_includes(inc_cmd: list[str]) -> list[str]:
     """
     Gets Include directives from httpd process and returns a list of
     their values.
@@ -178,7 +175,7 @@ def parse_includes(inc_cmd: List[str]) -> List[str]:
     return parse_from_subprocess(inc_cmd, r"\(.*\) (.*)")
 
 
-def parse_modules(mod_cmd: List[str]) -> List[str]:
+def parse_modules(mod_cmd: list[str]) -> list[str]:
     """
     Get loaded modules from httpd process, and return the list
     of loaded module names.
@@ -192,7 +189,7 @@ def parse_modules(mod_cmd: List[str]) -> List[str]:
     return parse_from_subprocess(mod_cmd, r"(.*)_module")
 
 
-def parse_from_subprocess(command: List[str], regexp: str) -> List[str]:
+def parse_from_subprocess(command: list[str], regexp: str) -> list[str]:
     """Get values from stdout of subprocess command
 
     :param list command: Command to run
@@ -206,7 +203,7 @@ def parse_from_subprocess(command: List[str], regexp: str) -> List[str]:
     return re.compile(regexp).findall(stdout)
 
 
-def _get_runtime_cfg(command: List[str]) -> str:
+def _get_runtime_cfg(command: list[str]) -> str:
     """
     Get runtime configuration info.
 

{certbot_apache-4.2.0 → certbot_apache-5.1.0}/src/certbot_apache/_internal/apacheparser.py

@@ -1,9 +1,7 @@
 """ apacheconfig implementation of the ParserNode interfaces """
 from typing import Any
 from typing import Iterable
-from typing import List
 from typing import Optional
-from typing import Tuple
 
 from certbot_apache._internal import assertions
 from certbot_apache._internal import interfaces
@@ -31,7 +29,7 @@ class ApacheParserNode(interfaces.ParserNode):
     def save(self, msg: str) -> None:
         pass  # pragma: no cover
 
-    def find_ancestors(self, name: str) -> List["ApacheParserNode"]:  # pylint: disable=unused-variable
+    def find_ancestors(self, name: str) -> list["ApacheParserNode"]:  # pylint: disable=unused-variable
         """Find ancestor BlockNodes with a given name"""
         return [ApacheBlockNode(name=assertions.PASS,
                                 parameters=assertions.PASS,
@@ -90,7 +88,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
 
     def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
-        self.children: Tuple[ApacheParserNode, ...] = ()
+        self.children: tuple[ApacheParserNode, ...] = ()
 
     def __eq__(self, other: Any) -> bool:
         if isinstance(other, self.__class__):
@@ -105,7 +103,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
         return False  # pragma: no cover
 
     # pylint: disable=unused-argument
-    def add_child_block(self, name: str, parameters: Optional[List[str]] = None,
+    def add_child_block(self, name: str, parameters: Optional[list[str]] = None,
                         position: Optional[int] = None) -> "ApacheBlockNode":  # pragma: no cover
         """Adds a new BlockNode to the sequence of children"""
         new_block = ApacheBlockNode(name=assertions.PASS,
@@ -117,7 +115,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
         return new_block
 
     # pylint: disable=unused-argument
-    def add_child_directive(self, name: str, parameters: Optional[List[str]] = None,
+    def add_child_directive(self, name: str, parameters: Optional[list[str]] = None,
                             position: Optional[int] = None
     ) -> ApacheDirectiveNode:  # pragma: no cover
         """Adds a new DirectiveNode to the sequence of children"""
@@ -142,7 +140,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
         self.children += (new_comment,)
         return new_comment
 
-    def find_blocks(self, name: str, exclude: bool = True) -> List["ApacheBlockNode"]:  # pylint: disable=unused-argument
+    def find_blocks(self, name: str, exclude: bool = True) -> list["ApacheBlockNode"]:  # pylint: disable=unused-argument
         """Recursive search of BlockNodes from the sequence of children"""
         return [ApacheBlockNode(name=assertions.PASS,
                                 parameters=assertions.PASS,
@@ -150,7 +148,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
                                 filepath=assertions.PASS,
                                 metadata=self.metadata)]
 
-    def find_directives(self, name: str, exclude: bool = True) -> List[ApacheDirectiveNode]:  # pylint: disable=unused-argument
+    def find_directives(self, name: str, exclude: bool = True) -> list[ApacheDirectiveNode]:  # pylint: disable=unused-argument
         """Recursive search of DirectiveNodes from the sequence of children"""
         return [ApacheDirectiveNode(name=assertions.PASS,
                                     parameters=assertions.PASS,
@@ -159,7 +157,7 @@ class ApacheBlockNode(ApacheDirectiveNode):
                                     metadata=self.metadata)]
 
     # pylint: disable=unused-argument
-    def find_comments(self, comment: str, exact: bool = False) -> List[ApacheCommentNode]:
+    def find_comments(self, comment: str, exact: bool = False) -> list[ApacheCommentNode]:
         """Recursive search of DirectiveNodes from the sequence of children"""
         return [ApacheCommentNode(comment=assertions.PASS,  # pragma: no cover
                                   ancestor=self,
@@ -170,11 +168,11 @@ class ApacheBlockNode(ApacheDirectiveNode):
         """Deletes a ParserNode from the sequence of children"""
         return  # pragma: no cover
 
-    def unsaved_files(self) -> List[str]:
+    def unsaved_files(self) -> list[str]:
         """Returns a list of unsaved filepaths"""
         return [assertions.PASS]  # pragma: no cover
 
-    def parsed_paths(self) -> List[str]:
+    def parsed_paths(self) -> list[str]:
         """Returns a list of parsed configuration file paths"""
         return [assertions.PASS]
 

{certbot_apache-4.2.0 → certbot_apache-5.1.0}/src/certbot_apache/_internal/assertions.py

@@ -2,7 +2,6 @@
 import fnmatch
 from typing import Any
 from typing import Iterable
-from typing import List
 from typing import Optional
 from typing import Union
 
@@ -103,7 +102,7 @@ def isPassComment(comment: CommentNode) -> bool:
     return False
 
 
-def isPassNodeList(nodelist: List[Union[DirectiveNode, CommentNode]]) -> bool:  # pragma: no cover
+def isPassNodeList(nodelist: list[Union[DirectiveNode, CommentNode]]) -> bool:  # pragma: no cover
     """ Checks if a ParserNode in the nodelist should pass the assertion,
     this function is used for results of find_* methods. Unimplemented find_*
     methods should return a sequence containing a single ParserNode instance

{certbot_apache-4.2.0 → certbot_apache-5.1.0}/src/certbot_apache/_internal/augeasparser.py

@@ -66,12 +66,8 @@ Translates over to:
 """
 from typing import Any
 from typing import cast
-from typing import Dict
 from typing import Iterable
-from typing import List
 from typing import Optional
-from typing import Set
-from typing import Tuple
 from typing import Union
 
 from certbot import errors
@@ -109,7 +105,7 @@ class AugeasParserNode(interfaces.ParserNode):
     def save(self, msg: Iterable[str]) -> None:
         self.parser.save(msg)
 
-    def find_ancestors(self, name: str) -> List["AugeasParserNode"]:
+    def find_ancestors(self, name: str) -> list["AugeasParserNode"]:
         """
         Searches for ancestor BlockNodes with a given name.
 
@@ -119,7 +115,7 @@ class AugeasParserNode(interfaces.ParserNode):
         :rtype: list of AugeasParserNode
         """
 
-        ancestors: List["AugeasParserNode"] = []
+        ancestors: list["AugeasParserNode"] = []
 
         parent = self.metadata["augeaspath"]
         while True:
@@ -143,7 +139,7 @@ class AugeasParserNode(interfaces.ParserNode):
         """
 
         name: str = self._aug_get_name(path)
-        metadata: Dict[str, Union[parser.ApacheParser, str]] = {
+        metadata: dict[str, Union[parser.ApacheParser, str]] = {
             "augeasparser": self.parser, "augeaspath": path
         }
 
@@ -236,7 +232,7 @@ class AugeasDirectiveNode(AugeasParserNode):
             self.parser.aug.set(param_path, param)
 
     @property
-    def parameters(self) -> Tuple[str, ...]:
+    def parameters(self) -> tuple[str, ...]:
         """
         Fetches the parameters from Augeas tree, ensuring that the sequence always
         represents the current state
@@ -246,7 +242,7 @@ class AugeasDirectiveNode(AugeasParserNode):
         """
         return tuple(self._aug_get_params(self.metadata["augeaspath"]))
 
-    def _aug_get_params(self, path: str) -> List[str]:
+    def _aug_get_params(self, path: str) -> list[str]:
         """Helper function to get parameters for DirectiveNodes and BlockNodes"""
 
         arg_paths = self.parser.aug.match(path + "/arg")
@@ -259,7 +255,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
 
     def __init__(self, **kwargs: Any) -> None:
         super().__init__(**kwargs)
-        self.children: Tuple["AugeasBlockNode", ...] = ()
+        self.children: tuple["AugeasBlockNode", ...] = ()
 
     def __eq__(self, other: Any) -> bool:
         if isinstance(other, self.__class__):
@@ -275,7 +271,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
 
     # pylint: disable=unused-argument
     def add_child_block(self, name: str,  # pragma: no cover
-                        parameters: Optional[List[str]] = None,
+                        parameters: Optional[list[str]] = None,
                         position: Optional[int] = None) -> "AugeasBlockNode":
         """Adds a new BlockNode to the sequence of children"""
 
@@ -283,7 +279,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
             name,
             position
         )
-        new_metadata: Dict[str, Any] = {"augeasparser": self.parser, "augeaspath": realpath}
+        new_metadata: dict[str, Any] = {"augeasparser": self.parser, "augeaspath": realpath}
 
         # Create the new block
         self.parser.aug.insert(insertpath, name, before)
@@ -305,7 +301,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
 
     # pylint: disable=unused-argument
     def add_child_directive(self, name: str,  # pragma: no cover
-                            parameters: Optional[List[str]] = None,
+                            parameters: Optional[list[str]] = None,
                             position: Optional[int] = None) -> AugeasDirectiveNode:
         """Adds a new DirectiveNode to the sequence of children"""
 
@@ -346,7 +342,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
             "#comment",
             position
         )
-        new_metadata: Dict[str, Any] = {
+        new_metadata: dict[str, Any] = {
             "augeasparser": self.parser, "augeaspath": realpath,
         }
 
@@ -362,10 +358,10 @@ class AugeasBlockNode(AugeasDirectiveNode):
             metadata=new_metadata,
         )
 
-    def find_blocks(self, name: str, exclude: bool = True) -> List["AugeasBlockNode"]:
+    def find_blocks(self, name: str, exclude: bool = True) -> list["AugeasBlockNode"]:
         """Recursive search of BlockNodes from the sequence of children"""
 
-        nodes: List["AugeasBlockNode"] = []
+        nodes: list["AugeasBlockNode"] = []
         paths: Iterable[str] = self._aug_find_blocks(name)
         if exclude:
             paths = self.parser.exclude_dirs(paths)
@@ -374,14 +370,14 @@ class AugeasBlockNode(AugeasDirectiveNode):
 
         return nodes
 
-    def find_directives(self, name: str, exclude: bool = True) -> List["AugeasDirectiveNode"]:
+    def find_directives(self, name: str, exclude: bool = True) -> list["AugeasDirectiveNode"]:
         """Recursive search of DirectiveNodes from the sequence of children"""
 
         nodes = []
         ownpath = self.metadata.get("augeaspath")
 
         directives = self.parser.find_dir(name, start=ownpath, exclude=exclude)
-        already_parsed: Set[str] = set()
+        already_parsed: set[str] = set()
         for directive in directives:
             # Remove the /arg part from the Augeas path
             directive = directive.partition("/arg")[0]
@@ -393,14 +389,14 @@ class AugeasBlockNode(AugeasDirectiveNode):
 
         return nodes
 
-    def find_comments(self, comment: str) -> List["AugeasCommentNode"]:
+    def find_comments(self, comment: str) -> list["AugeasCommentNode"]:
         """
         Recursive search of DirectiveNodes from the sequence of children.
 
         :param str comment: Comment content to search for.
         """
 
-        nodes: List["AugeasCommentNode"] = []
+        nodes: list["AugeasCommentNode"] = []
         ownpath = self.metadata.get("augeaspath")
 
         comments = self.parser.find_comments(comment, start=ownpath)
@@ -422,11 +418,11 @@ class AugeasBlockNode(AugeasDirectiveNode):
                  "seem to exist.").format(child.metadata["augeaspath"])
             )
 
-    def unsaved_files(self) -> Set[str]:
+    def unsaved_files(self) -> set[str]:
         """Returns a list of unsaved filepaths"""
         return self.parser.unsaved_files()
 
-    def parsed_paths(self) -> List[str]:
+    def parsed_paths(self) -> list[str]:
         """
         Returns a list of file paths that have currently been parsed into the parser
         tree. The returned list may include paths with wildcard characters, for
@@ -437,7 +433,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
         :returns: list of file paths of files that have been parsed
         """
 
-        res_paths: List[str] = []
+        res_paths: list[str] = []
 
         paths = self.parser.existing_paths
         for directory in paths:
@@ -463,7 +459,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
         """Helper function to create a DirectiveNode from Augeas path"""
 
         name = self.parser.get_arg(path)
-        metadata: Dict[str, Union[parser.ApacheParser, str]] = {
+        metadata: dict[str, Union[parser.ApacheParser, str]] = {
             "augeasparser": self.parser, "augeaspath": path,
         }
 
@@ -477,12 +473,12 @@ class AugeasBlockNode(AugeasDirectiveNode):
                                    filepath=apache_util.get_file_path(path),
                                    metadata=metadata)
 
-    def _aug_find_blocks(self, name: str) -> Set[str]:
+    def _aug_find_blocks(self, name: str) -> set[str]:
         """Helper function to perform a search to Augeas DOM tree to search
         configuration blocks with a given name"""
 
         # The code here is modified from configurator.get_virtual_hosts()
-        blk_paths: Set[str] = set()
+        blk_paths: set[str] = set()
         for vhost_path in list(self.parser.parser_paths):
             paths = self.parser.aug.match(
                 ("/files%s//*[label()=~regexp('%s')]" %
@@ -492,7 +488,7 @@ class AugeasBlockNode(AugeasDirectiveNode):
         return blk_paths
 
     def _aug_resolve_child_position(
-        self, name: str, position: Optional[int]) -> Tuple[str, str, bool]:
+        self, name: str, position: Optional[int]) -> tuple[str, str, bool]:
         """
         Helper function that iterates through the immediate children and figures
         out the insertion path for a new AugeasParserNode.