crypt/certbot
1
0
Fork 0
mirror of https://github.com/certbot/certbot.git synced 2026-01-24 19:22:07 +03:00
Code Activity

Made apache_configurator work in any location/first basic tests complete successfully

Browse Source
This commit is contained in:
James Kasten
2014-12-04 04:00:22 -08:00
parent a19333d84b
commit 30641db85f
3 changed files with 148 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
letsencrypt/client/CONFIG.py
View File

@@ -10,6 +10,7 @@ If you create your own server... change this line
Note: the server certificate must be trusted in order to avoid
further modifications to the client."""
# Directories
SERVER_ROOT = "/etc/apache2/"
"""Apache server root directory"""
@@ -39,6 +40,7 @@ KEY_DIR = os.path.join(SERVER_ROOT, "ssl/")
CERT_DIR = os.path.join(SERVER_ROOT, "certs/")
"""Certificate storage"""
# Files and extensions
OPTIONS_SSL_CONF = os.path.join(CONFIG_DIR, "options-ssl.conf")
"""Contains standard Apache SSL directives"""
@@ -48,18 +50,6 @@ LE_VHOST_EXT = "-le-ssl.conf"
APACHE_CHALLENGE_CONF = os.path.join(CONFIG_DIR, "le_dvsni_cert_challenge.conf")
"""Temporary file for challenge virtual hosts"""
S_SIZE = 32
"""Byte size of S"""
NONCE_SIZE = 16
"""byte size of Nonce"""
RSA_KEY_SIZE = 2048
"""Key size"""
DIFFICULTY = 23
"""bits of hashcash to generate"""
CERT_PATH = CERT_DIR + "cert-letsencrypt.pem"
"""Let's Encrypt cert file."""
@@ -69,6 +59,7 @@ CHAIN_PATH = CERT_DIR + "chain-letsencrypt.pem"
INVALID_EXT = ".acme.invalid"
"""Invalid Extension"""
# Challenge Information
CHALLENGE_PREFERENCES = ["dvsni", "recoveryToken"]
"""Challenge Preferences Dict for currently supported challenges"""
@@ -78,6 +69,25 @@ EXCLUSIVE_CHALLENGES = [frozenset(["dvsni", "simpleHttps"])]
CONFIG_CHALLENGES = frozenset(["dvsni", "simpleHttps"])
"""These are challenges that must be solved by a Configurator object"""
# Challenge Constants
S_SIZE = 32
"""Byte size of S"""
NONCE_SIZE = 16
"""byte size of Nonce"""
# Key Sizes
RSA_KEY_SIZE = 2048
"""Key size"""
# Config Optimizations
REWRITE_HTTPS_ARGS = [
"^.*$", "https://%{SERVER_NAME}%{REQUEST_URI}", "[L,R=permanent]"]
"""Rewrite rule arguments used for redirections to https vhost"""
# Apache Interaction
APACHE_CTL = "/usr/sbin/apache2ctl"
"""Command used for configtest and version number."""
APACHE2 = "/etc/init.d/apache2"
"""Command used for reload and restart."""

55
letsencrypt/client/apache_configurator.py
View File

@@ -92,9 +92,11 @@ class VH(object):
if isinstance(other, self.__class__):
return (self.file == other.file and self.path == other.path and
set(self.addrs) == set(other.addrs) and
set(self.names) == set(other.naems) and
set(self.names) == set(other.names) and
self.ssl == other.ssl and self.enabled == other.enabled)
return False
class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
"""Apache configurator.
@@ -145,6 +147,14 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
# vhosts
self.recovery_routine()
# Find configuration root and make sure augeas can parse it.
self.config_root = self._find_config_root()
self._parse_file(self.config_root)
# Must also attempt to parse sites-available or equivalent
# Sites-available is not included naturally in configuration
self._parse_file(os.path.join(self.server_root, "sites-available/*"))
# Set Version
if not version:
self.version = self.get_version()
@@ -335,6 +345,16 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
return all_names
def _find_config_root(self):
location = ["apache2.conf", "httpd.conf"]
for name in location:
if os.path.isfile(os.path.join(self.server_root, name)):
return os.path.join(self.server_root, name)
raise errors.LetsEncryptConfiguratorError(
"Could not find configuration root")
def _set_user_config_file(self, filename=''):
"""Set the appropriate user configuration file
@@ -370,6 +390,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
case_i('ServerName'),
host.path,
case_i('ServerAlias'))))
for name in name_match:
args = self.aug.match(name + "/*")
for arg in args:
@@ -413,6 +434,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
("/files%ssites-available//*[label()=~regexp('%s')]" %
(self.server_root, case_i('VirtualHost'))))
vhs = []
for path in paths:
vhs.append(self._create_vhost(path))
@@ -601,7 +623,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
"""
# Cannot place member variable in the definition of the function so...
if not start:
start = "/files%sapache2.conf" % self.server_root
start = "/files%s" % self.config_root
# Debug code
# print "find_dir:", directive, "arg:", arg, " | Looking in:", start
@@ -624,9 +646,14 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator):
"[self::arg=~regexp('%s')]" %
(start, directive, arg)))
incl_regex = "(%s)|(%s)" % (case_i('Include'),
case_i('IncludeOptional'))
includes = self.aug.match(("%s//* [self::directive=~regexp('%s')]/* "
"[label()='arg']" %
(start, case_i('Include'))))
"[label()='arg']" % (start, incl_regex)))
# for inc in includes:
# print inc, self.aug.get(inc)
for include in includes:
# start[6:] to strip off /files
@@ -1273,15 +1300,18 @@ LogLevel warn \n\
def get_version(self): # pylint: disable=no-self-use
"""Return version of Apache Server.
Version is returned as float. (ie. 2.4.7 = 2.47)
Version is returned as tuple. (ie. 2.4.7 = (2, 4, 7))
:returns: version
:rtype: float
:rtype: tuple
:raises errors.LetsEncryptConfiguratorError:
Unable to find Apache version
"""
try:
proc = subprocess.Popen(
['sudo', '/usr/sbin/apache2ctl', '-v'],
['/usr/sbin/apache2ctl', '-v'],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
text = proc.communicate()[0]
@@ -1296,10 +1326,7 @@ LogLevel warn \n\
raise errors.LetsEncryptConfiguratorError(
"Unable to find Apache version")
num_decimal = matches[0].count(".")
# Format return value such as 2.47 rather than 2.4.7
return float("".join(matches[0].rsplit(".", num_decimal-1)))
num_decimal = tuple(matches[0].split('.'))
###########################################################################
# Challenges Section
@@ -1481,7 +1508,7 @@ def enable_mod(mod_name):
stdout=open("/dev/null", 'w'),
stderr=open("/dev/null", 'w'))
# Hopefully this waits for output
subprocess.check_call(["sudo", "/etc/init.d/apache2", "restart"],
subprocess.check_call(["sudo", APACHE2, "restart"],
stdout=open("/dev/null", 'w'),
stderr=open("/dev/null", 'w'))
except (OSError, subprocess.CalledProcessError) as err:
@@ -1518,7 +1545,7 @@ def check_ssl_loaded():
return False
def apache_restart(quiet=False):
def apache_restart():
"""Restarts the Apache Server.
.. todo:: Try to use reload instead. (This caused timing problems before)
@@ -1526,7 +1553,7 @@ def apache_restart(quiet=False):
"""
try:
proc = subprocess.Popen(['/etc/init.d/apache2', 'restart'],
proc = subprocess.Popen([APACHE2, 'restart'],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
text = proc.communicate()

134
letsencrypt/client/tests/apache_configurator_test.py
View File

@@ -1,9 +1,9 @@
"""test_letsencrypt - Integration Test
"""apache_configurator_test - unittests
A series of basic full integration tests to ensure that Letsencrypt is
still running smoothly.
.. note:: This code is not complete nor has it been tested
.. note:: This code is not complete
.. note:: Do not document this code... it will change quickly
"""
@@ -24,10 +24,9 @@ from letsencrypt.client import logger
TESTING_DIR = "/home/ubuntu/testing/"
UBUNTU_CONFIGS = os.path.join(TESTING_DIR, "ubuntu_apache_2_4/")
TEMP_DIR = os.path.join(TESTING_DIR, "temp")
# I have not put this up on my website yet... it will not work
# This might end up going into the repo... but this is more of
# a user run test as opposed to a Travis CI test.
CONFIG_TGZ_URL = "https://jdkasten.com/letsencrypt/config.tgz"
# This will end up going into the repo...
CONFIG_TGZ_URL = "https://jdkasten.com/projects/config.tgz"
def setUpModule():
@@ -38,20 +37,23 @@ def setUpModule():
if not os.path.isdir(UBUNTU_CONFIGS):
print "Please place the configuration directory: %s" % UBUNTU_CONFIGS
sys.exit(1)
shutil.copytree(UBUNTU_CONFIGS, TEMP_DIR)
shutil.copytree(UBUNTU_CONFIGS, TEMP_DIR, symlinks=True)
def tearDownModule():
shutil.rmtree(TEMP_DIR)
class TwoVhosts_80(unittest.TestCase):
def setUp(self):
config_path = os.path.join(UBUNTU_CONFIGS, "two_vhosts_*80/apache2")
sites_path = os.path.join(UBUNTU_CONFIGS, "two_vhosts_*80/sites")
# Final slash is currently important
self.config_path = os.path.join(TEMP_DIR, "two_vhost_80/apache2/")
self.config = apache_configurator.ApacheConfigurator(
self.config_path, (2, 4, 7))
self.config = apache_configurator.ApacheConfigurator(config_path, 2.47)
prefix = os.path.join(TEMP_DIR, "sites-available")
aug_pre = os.path.join("/files", prefix)
prefix = os.path.join(TEMP_DIR, "two_vhost_80/apache2/sites-available/")
aug_pre = "/files" + prefix
self.vh_truth = []
self.vh_truth.append(apache_configurator.VH(
os.path.join(prefix + "encryption-example.conf"),
@@ -73,66 +75,97 @@ class TwoVhosts_80(unittest.TestCase):
self.vh_truth[2].add_name("ip-172-30-0-17")
self.vh_truth[3].add_name("letsencrypt.demo")
def test_get_all_names(self):
names = self.config.get_all_names()
def test_parse_file(self):
"""test parse_file.
print names
letsencrypt.conf is chosen as the test file as it will not be
included during the normal course of execution.
"""
file_path = os.path.join(
self.config_path, "sites-available", "letsencrypt.conf")
self.config._parse_file(file_path)
# search for the httpd incl
matches = self.config.aug.match(
"/augeas/load/Httpd/incl [. ='%s']" % file_path)
self.assertTrue(matches)
def test_get_all_names(self):
"""test get_all_names."""
names = self.config.get_all_names()
self.assertTrue(set(names) == set(
["letsencrypt.demo", "encryption-example.com", "ip-172-30-0-17"]))
['letsencrypt.demo', 'encryption-example.demo', 'ip-172-30-0-17']))
def test_find_directive(self):
self.assertTrue(
len(self.config.find_directive(
apache_configurator.case_i("Listen"), "443") == 2))
self.assertTrue(
len(self.config.find_directive(
apache_configurator.case_i("documentroot"))) == 4)
"""test find_directive."""
test = self.config.find_directive(
apache_configurator.case_i("Listen"), "443")
# This will only look in enabled hosts
test2 = self.config.find_directive(
apache_configurator.case_i("documentroot"))
self.assertTrue(len(test) == 2)
self.assertTrue(len(test2) == 3)
def test_get_virtual_hosts(self):
"""get_virtual_hosts."""
vhs = self.config.get_virtual_hosts()
self.assertTrue(len(vhs) == 4)
self.assertTrue(set(self.vh_truth) == set(vhs))
failed = False
for vhost in vhs:
for truth in self.vh_truth:
if vhost == truth:
break
failed = True
self.assertTrue(failed)
def test_is_site_enabled(self):
"""test is_site_enabled"""
self.assertTrue(self.config.is_site_enabled(self.vh_truth[0].file))
self.assertTrue(not self.config.is_site_enabled(self.vh_truth[1].file))
self.assertTrue(self.config.is_site_enabled(self.vh_truth[2].file))
self.assertTrue(self.config.is_site_enabled(self.vh_truth[3].file))
def test_deploy_cert(self):
self.config.deploy_cert(
self.vh_truth[1],
"example/cert.pem", "example/key.pem", "example/cert_chain.pem")
# def test_deploy_cert(self):
# """test deploy_cert."""
# self.config.deploy_cert(
# self.vh_truth[1],
# "example/cert.pem", "example/key.pem", "example/cert_chain.pem")
loc_cert = self.config.find_directive(
apache_configurator.case_i("sslcertificatefile"), "example/cert.pem")
loc_key = self.config.find_directive(
apache_configurator.case_i("sslcertificateKeyfile"), "example/key.pem")
loc_chain = self.config.find_directive(
apache_configurator.case_i("SSLCertificateChainFile"), "example/chain.pem")
# loc_cert = self.config.find_directive(
# apache_configurator.case_i(
# "sslcertificatefile"), "example/cert.pem")
# loc_key = self.config.find_directive(
# apache_configurator.case_i(
# "sslcertificateKeyfile"), "example/key.pem")
# loc_chain = self.config.find_directive(
# apache_configurator.case_i(
# "SSLCertificateChainFile"), "example/chain.pem")
self.assertTrue(len(loc_cert) == 1 and
apache_configurator.get_file_path(
loc_cert[0]) == self.vh_truth[1].file)
# self.assertTrue(len(loc_cert) == 1 and
# apache_configurator.get_file_path(
# loc_cert[0]) == self.vh_truth[1].file)
self.assertTrue(len(loc_key) == 1 and
apache_configurator.get_file_path(
loc_key[0]) == self.vh_truth[1].file)
# self.assertTrue(len(loc_key) == 1 and
# apache_configurator.get_file_path(
# loc_key[0]) == self.vh_truth[1].file)
self.assertTrue(len(loc_chain) == 1 and
apache_configurator.get_file_path(
loc_chain[0]) == self.vh_truth[1].file)
# self.assertTrue(len(loc_chain) == 1 and
# apache_configurator.get_file_path(
# loc_chain[0]) == self.vh_truth[1].file)
def test_is_name_vhost(self):
"""test is_name_vhost."""
self.assertTrue(not self.config.is_name_vhost("*:80"))
def test_add_name_vhost(self):
self.config.add_name_vhost("*:443")
self.config.save(temporary=True)
self.assertTrue(self.config.is_name_vhost("*:443"))
# def test_add_name_vhost(self):
# """test add_name_vhost."""
# self.config.add_name_vhost("*:443")
# self.config.save(temporary=True)
# self.assertTrue(self.config.is_name_vhost("*:443"))
def _verify_redirect(self, config_path):
with open(config_path, 'r') as config_fd:
@@ -140,6 +173,9 @@ class TwoVhosts_80(unittest.TestCase):
return CONFIG.REWRITE_HTTPS_ARGS[1] in conf
if __name__ == '__main__':
unittest.main()
# def download_unpack_tests(url=CONFIG_TGZ_URL):
# r = requests.get(url)
# local_tgz_file = os.path.join(TESTING_DIR, 'ubuntu_2_4.tgz')