mirror of
https://github.com/certbot/certbot.git
synced 2026-07-27 08:09:10 +02:00
Adrien FerrandandBrad Warren
56f609d4f5
Fixes #6850 This PR makes the last corrections needed to run all unit tests on Windows: add a function to check if a hook is executable in a cross-platform compatible way handle correctly the PATH surgery for Windows during hook execution handle correctly an account compatibility over both ACMEv1 and ACMEv2 remove (finally!) the @broken_on_windows decorator. * Fix account_tests * Fix hook executable test * Remove the temporary decorator @broken_on_windows * Fix util_test * No broken unit test on Windows anymore * More elegant mock * Fix context manager * Adapt coverage * Corrections * Adapt coverage * Forbid os.access
124 lines
3.7 KiB
Python
124 lines
3.7 KiB
Python
"""
|
|
This compat module handles various platform specific calls that do not fall into one
|
|
particular category.
|
|
"""
|
|
from __future__ import absolute_import
|
|
|
|
import select
|
|
import stat
|
|
import sys
|
|
|
|
try:
|
|
from win32com.shell import shell as shellwin32 # pylint: disable=import-error
|
|
POSIX_MODE = False
|
|
except ImportError: # pragma: no cover
|
|
POSIX_MODE = True
|
|
|
|
from certbot import errors
|
|
from certbot.compat import os
|
|
|
|
|
|
# MASK_FOR_PRIVATE_KEY_PERMISSIONS defines what are the permissions flags to keep
|
|
# when transferring the permissions from an old private key to a new one.
|
|
if POSIX_MODE:
|
|
# On Linux, we keep read/write/execute permissions
|
|
# for group and read permissions for everybody.
|
|
MASK_FOR_PRIVATE_KEY_PERMISSIONS = stat.S_IRGRP | stat.S_IWGRP | stat.S_IXGRP | stat.S_IROTH
|
|
else:
|
|
# On Windows, the mode returned by os.stat is not reliable,
|
|
# so we do not keep any permission from the previous private key.
|
|
MASK_FOR_PRIVATE_KEY_PERMISSIONS = 0
|
|
|
|
|
|
# For Linux: define OS specific standard binary directories
|
|
STANDARD_BINARY_DIRS = ["/usr/sbin", "/usr/local/bin", "/usr/local/sbin"] if POSIX_MODE else []
|
|
|
|
|
|
def raise_for_non_administrative_windows_rights():
|
|
# type: () -> None
|
|
"""
|
|
On Windows, raise if current shell does not have the administrative rights.
|
|
Do nothing on Linux.
|
|
|
|
:raises .errors.Error: If the current shell does not have administrative rights on Windows.
|
|
"""
|
|
if not POSIX_MODE and shellwin32.IsUserAnAdmin() == 0: # pragma: no cover
|
|
raise errors.Error('Error, certbot must be run on a shell with administrative rights.')
|
|
|
|
|
|
def readline_with_timeout(timeout, prompt):
|
|
# type: (float, str) -> str
|
|
"""
|
|
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
|
|
|
|
"""
|
|
try:
|
|
# Linux specific
|
|
#
|
|
# Call to select can only be done like this on UNIX
|
|
rlist, _, _ = select.select([sys.stdin], [], [], timeout)
|
|
if not rlist:
|
|
raise errors.Error(
|
|
"Timed out waiting for answer to prompt '{0}'".format(prompt))
|
|
return rlist[0].readline()
|
|
except OSError:
|
|
# 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()
|
|
|
|
|
|
WINDOWS_DEFAULT_FOLDERS = {
|
|
'config': 'C:\\Certbot',
|
|
'work': 'C:\\Certbot\\lib',
|
|
'logs': 'C:\\Certbot\\log',
|
|
}
|
|
LINUX_DEFAULT_FOLDERS = {
|
|
'config': '/etc/letsencrypt',
|
|
'work': '/var/lib/letsencrypt',
|
|
'logs': '/var/log/letsencrypt',
|
|
}
|
|
|
|
|
|
def get_default_folder(folder_type):
|
|
# type: (str) -> str
|
|
"""
|
|
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
|
|
|
|
"""
|
|
if os.name != 'nt':
|
|
# Linux specific
|
|
return LINUX_DEFAULT_FOLDERS[folder_type]
|
|
# Windows specific
|
|
return WINDOWS_DEFAULT_FOLDERS[folder_type]
|
|
|
|
|
|
def underscores_for_unsupported_characters_in_path(path):
|
|
# 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
|
|
"""
|
|
if os.name != 'nt':
|
|
# Linux specific
|
|
return path
|
|
|
|
# Windows specific
|
|
drive, tail = os.path.splitdrive(path)
|
|
return drive + tail.replace(':', '_')
|