Coverage for certbot/compat.py : 71%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
""" Compatibility layer to run certbot both on Linux and Windows.
This module contains all required platform specific code, allowing the rest of Certbot codebase to be platform agnostic. """
'certificates', 'enhance', 'revoke', 'delete', 'register', 'unregister', 'config_changes', 'plugins']
""" On Windows, raise if current shell does not have the administrative rights. Do nothing on Linux.
:param str subcommand: The subcommand (like 'certonly') passed to the certbot client.
:raises .errors.Error: If the provided subcommand must be run on a shell with administrative rights, and current shell does not have these rights.
""" # Why not simply try ctypes.windll.shell32.IsUserAnAdmin() and catch AttributeError ? # Because windll exists only on a Windows runtime, and static code analysis engines # do not like at all non existent objects when run from Linux (even if we handle properly # all the cases in the code). # So we access windll only by reflection to trick theses engines. windll = getattr(ctypes, 'windll') if windll.shell32.IsUserAnAdmin() == 0: raise errors.Error( 'Error, "{0}" subcommand must be run on a shell with administrative rights.' .format(subcommand))
""" Get current user uid
:returns: The current user uid. :rtype: int
""" # Linux specific except AttributeError: # Windows specific return 0
""" Rename a file to a destination path and handles situations where the destination exists.
:param str src: The current file path. :param str dst: The new file path. """ except OSError as err: # Windows specific, renaming a file on an existing path is not possible. # On Python 3, the best fallback with atomic capabilities we have is os.replace. if err.errno != errno.EEXIST: # Every other error is a legitimate exception. raise if not hasattr(os, 'replace'): # pragma: no cover # We should never go on this line. Either we are on Linux and os.rename has succeeded, # either we are on Windows, and only Python >= 3.4 is supported where os.replace is # available. raise RuntimeError('Error: tried to run os_rename on Python < 3.3. ' 'Certbot supports only Python 3.4 >= on Windows.') getattr(os, 'replace')(src, dst)
""" Read user input to return the first line entered, or raise after specified timeout.
:param float timeout: The timeout in seconds given to the user. :param str prompt: The prompt message to display to the user.
:returns: The first line entered by the user. :rtype: str
""" # Linux specific # # Call to select can only be done like this on UNIX "Timed out waiting for answer to prompt '{0}'".format(prompt)) # Windows specific # # No way with select to make a timeout to the user input on Windows, # as select only supports socket in this case. # So no timeout on Windows for now. return sys.stdin.readline()
"""Return true if the two modes can be considered as equals for this platform""" # Linux specific: standard compare # Windows specific: most of mode bits are ignored on Windows. Only check user R/W rights. return (stat.S_IMODE(mode1) & stat.S_IREAD == stat.S_IMODE(mode2) & stat.S_IREAD and stat.S_IMODE(mode1) & stat.S_IWRITE == stat.S_IMODE(mode2) & stat.S_IWRITE)
'config': 'C:\\Certbot', 'work': 'C:\\Certbot\\lib', 'logs': 'C:\\Certbot\\log', } 'config': '/etc/letsencrypt', 'work': '/var/lib/letsencrypt', 'logs': '/var/log/letsencrypt', }
""" Return the relevant default folder for the current OS
:param str folder_type: The type of folder to retrieve (config, work or logs)
:returns: The relevant default folder. :rtype: str
""" # Linux specific # Windows specific return WINDOWS_DEFAULT_FOLDERS[folder_type]
# type: (str) -> str """ Replace unsupported characters in path for current OS by underscores. :param str path: the path to normalize :return: the normalized path :rtype: str """ # Linux specific
# Windows specific drive, tail = os.path.splitdrive(path) return drive + tail.replace(':', '_') |