From ba91c489a6be89848d1d8a6c93690fcd06a519a0 Mon Sep 17 00:00:00 2001 From: James Kasten Date: Thu, 27 Nov 2014 00:53:10 -0800 Subject: [PATCH] Removed __functions, minor formatting --- letsencrypt/client/apache_configurator.py | 69 +++++++++++------------ letsencrypt/client/augeas_configurator.py | 20 +++---- 2 files changed, 44 insertions(+), 45 deletions(-) diff --git a/letsencrypt/client/apache_configurator.py b/letsencrypt/client/apache_configurator.py index 250b840ef..723cbd950 100644 --- a/letsencrypt/client/apache_configurator.py +++ b/letsencrypt/client/apache_configurator.py @@ -99,7 +99,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): self.standardize_excl() # Determine user's main config file - self.__set_user_config_file() + self._set_user_config_file() self.vhosts = self.get_virtual_hosts() # Add name_server association dict @@ -282,7 +282,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): return all_names - def __set_user_config_file(self, filename=''): + def _set_user_config_file(self, filename=''): """Set the appropriate user configuration file TODO: This will have to be updated for other distros versions @@ -304,7 +304,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): else: self.user_config_file = self.server_root + 'apache2.conf' - def __add_servernames(self, host): + def _add_servernames(self, host): """Helper function for get_virtual_hosts(). :param host: In progress vhost whose names will be added @@ -322,7 +322,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): for arg in args: host.add_name(self.aug.get(arg)) - def __create_vhost(self, path): + def _create_vhost(self, path): """Used by get_virtual_hosts to create vhost objects :param path: Augeas path to virtual host @@ -345,7 +345,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): filename = self.get_file_path(path) is_enabled = self.is_site_enabled(filename) vhost = VH(filename, path, addrs, is_ssl, is_enabled) - self.__add_servernames(vhost) + self._add_servernames(vhost) return vhost # TODO: make "sites-available" a configurable directory @@ -362,7 +362,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): (self.server_root, case_i('VirtualHost')))) vhs = [] for p in paths: - vhs.append(self.__create_vhost(p)) + vhs.append(self._create_vhost(p)) return vhs @@ -556,7 +556,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): :type directive: str :param arg: Specific value direcitve must have, None if all should - be considered + be considered :type arg: str or None :param start: Beginning Augeas path to begin looking @@ -777,7 +777,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): self.save() # We know the length is one because of the assertion above - ssl_vhost = self.__create_vhost(vh_p[0]) + ssl_vhost = self._create_vhost(vh_p[0]) self.vhosts.append(ssl_vhost) # Check if nonssl_vhost's address was NameVirtualHost @@ -818,7 +818,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): # to avoid the extra restart self.enable_mod("rewrite") - general_v = self.__general_vhost(ssl_vhost) + general_v = self._general_vhost(ssl_vhost) if general_v is None: # Add virtual_server with redirect logger.debug( @@ -896,7 +896,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): """ # Consider changing this to a dictionary check # Make sure adding the vhost will be safe - conflict, hostOrAddrs = self.__conflicting_host(ssl_vhost) + conflict, hostOrAddrs = self._conflicting_host(ssl_vhost) if conflict: return False, hostOrAddrs @@ -950,7 +950,7 @@ LogLevel warn \n\ self.aug.load() # Make a new vhost data structure and add it to the lists new_fp = self.server_root + "sites-available/" + redirect_filename - new_vhost = self.__create_vhost("/files" + new_fp) + new_vhost = self._create_vhost("/files" + new_fp) self.vhosts.append(new_vhost) # Finally create documentation for the change @@ -960,8 +960,8 @@ LogLevel warn \n\ return True, new_vhost - def __conflicting_host(self, ssl_vhost): - """Checks for conflicting HTTP vhost for ssl_vhost + def _conflicting_host(self, ssl_vhost): + """Checks for conflicting HTTP vhost for ssl_vhost. Checks for a conflicting host, such that a new port 80 host could not be created without ruining the apache config @@ -1003,7 +1003,7 @@ LogLevel warn \n\ return False, redirect_addrs - def __general_vhost(self, ssl_vhost): + def _general_vhost(self, ssl_vhost): """Find appropriate HTTP vhost for ssl_vhost. Function needs to be thoroughly tested and perhaps improved @@ -1182,7 +1182,7 @@ LogLevel warn \n\ sys.exit(1) def fnmatch_to_re(self, clean_fn_match): - """Method converts Apache's basic fnmatch to regular expression + """Method converts Apache's basic fnmatch to regular expression. :param clean_fn_match: Apache style filename match, similar to globs :type clean_fn_match: str @@ -1224,7 +1224,7 @@ LogLevel warn \n\ # self.httpd_incl.append(file_path) # self.aug.add_transform("Httpd.lns", # self.httpd_incl, None, self.httpd_excl) - self.__add_httpd_transform(file_path) + self._add_httpd_transform(file_path) self.aug.load() def save_apache_config(self): @@ -1306,7 +1306,7 @@ LogLevel warn \n\ return True - def __add_httpd_transform(self, incl): + def _add_httpd_transform(self, incl): """Add a transform to Augeas. This function will correctly add a transform to augeas @@ -1365,9 +1365,10 @@ LogLevel warn \n\ def dvsni_perform(self, chall_dict): """Peform a DVSNI challenge. + Composed of listSNITuple: List of tuples with form (addr, r, nonce) addr (string), r (base64 string), nonce (hex string) - key: string - File path to key + dvsni_key: string - File path to key :param chall_dict: dvsni challenge - see documentation :type chall_dict: dict @@ -1444,7 +1445,7 @@ LogLevel warn \n\ """ return CONFIG.WORK_DIR + nonce + ".crt" - def __getConfigText(self, nonce, ip_addrs, key): + def _getConfigText(self, nonce, ip_addrs, key): """Chocolate virtual server configuration text :param nonce: hex form of nonce @@ -1460,21 +1461,19 @@ LogLevel warn \n\ :rtype: str """ - configText = " \n \ -ServerName " + nonce + CONFIG.INVALID_EXT + " \n \ -UseCanonicalName on \n \ -SSLStrictSNIVHostCheck on \n \ -\n \ -LimitRequestBody 1048576 \n \ -\n \ -Include " + CONFIG.OPTIONS_SSL_CONF + " \n \ -SSLCertificateFile " + self.dvsni_get_cert_file(nonce) + " \n \ -SSLCertificateKeyFile " + key + " \n \ -\n \ -DocumentRoot " + CONFIG.CONFIG_DIR + "challenge_page/ \n \ - \n\n " - - return configText + return (" \n" + "ServerName " + nonce + CONFIG.INVALID_EXT + " \n" + "UseCanonicalName on \n" + "SSLStrictSNIVHostCheck on \n" + "\n" + "LimitRequestBody 1048576 \n" + "\n" + "Include " + CONFIG.OPTIONS_SSL_CONF + " \n" + "SSLCertificateFile " + self.dvsni_get_cert_file(nonce) + " \n" + "SSLCertificateKeyFile " + key + " \n" + "\n" + "DocumentRoot " + CONFIG.CONFIG_DIR + "challenge_page/ \n" + " \n\n") def dvsni_mod_config(self, mainConfig, listSNITuple, dvsni_key, listlistAddrs): @@ -1507,7 +1506,7 @@ DocumentRoot " + CONFIG.CONFIG_DIR + "challenge_page/ \n \ # TODO: Use ip address of existing vhost instead of relying on FQDN configText = " \n" for idx, lis in enumerate(listlistAddrs): - configText += self.__getConfigText(listSNITuple[idx][2], + configText += self._getConfigText(listSNITuple[idx][2], lis, dvsni_key) configText += " \n" diff --git a/letsencrypt/client/augeas_configurator.py b/letsencrypt/client/augeas_configurator.py index 2f9688579..89d7277ec 100644 --- a/letsencrypt/client/augeas_configurator.py +++ b/letsencrypt/client/augeas_configurator.py @@ -54,7 +54,7 @@ class AugeasConfigurator(configurator.Configurator): :type title: str :param temporary: Indicates whether the changes made will be quickly - reversed in the future (ie. challenges) + reversed in the future (ie. challenges) :type temporary: bool """ @@ -107,7 +107,7 @@ class AugeasConfigurator(configurator.Configurator): self.add_to_checkpoint(CONFIG.IN_PROGRESS_DIR, save_files) if title and not temporary and os.path.isdir(CONFIG.IN_PROGRESS_DIR): - success = self.__finalize_checkpoint(CONFIG.IN_PROGRESS_DIR, title) + success = self._finalize_checkpoint(CONFIG.IN_PROGRESS_DIR, title) if not success: # This should never happen # This will be hopefully be cleaned up on the recovery @@ -128,7 +128,7 @@ class AugeasConfigurator(configurator.Configurator): """ if os.path.isdir(CONFIG.TEMP_CHECKPOINT_DIR): - result = self.__recover_checkpoint(CONFIG.TEMP_CHECKPOINT_DIR) + result = self._recover_checkpoint(CONFIG.TEMP_CHECKPOINT_DIR) changes = True if result != 0: # We have a partial or incomplete recovery @@ -163,7 +163,7 @@ class AugeasConfigurator(configurator.Configurator): while rollback > 0 and backups: cp_dir = CONFIG.BACKUP_DIR + backups.pop() - result = self.__recover_checkpoint(cp_dir) + result = self._recover_checkpoint(cp_dir) if result != 0: logger.fatal("Failed to load checkpoint during rollback") sys.exit(39) @@ -216,7 +216,7 @@ class AugeasConfigurator(configurator.Configurator): pass print "" - def __finalize_checkpoint(self, cp_dir, title): + def _finalize_checkpoint(self, cp_dir, title): """Move IN_PROGRESS checkpoint to timestamped checkpoint. Adds title to cp_dir CHANGES_SINCE @@ -283,7 +283,7 @@ class AugeasConfigurator(configurator.Configurator): with open(cp_dir + "CHANGES_SINCE", 'a') as notes_fd: notes_fd.write(self.save_notes) - def __recover_checkpoint(self, cp_dir): + def _recover_checkpoint(self, cp_dir): """Recover a specific checkpoint. Recover a specific checkpoint provided by cp_dir @@ -309,7 +309,7 @@ class AugeasConfigurator(configurator.Configurator): return 1 # Remove any newly added files if they exist - self.__remove_contained_files(cp_dir + "/NEW_FILES") + self._remove_contained_files(cp_dir + "/NEW_FILES") try: shutil.rmtree(cp_dir) @@ -380,7 +380,7 @@ class AugeasConfigurator(configurator.Configurator): """ self.revert_challenge_config() if os.path.isdir(CONFIG.IN_PROGRESS_DIR): - result = self.__recover_checkpoint(CONFIG.IN_PROGRESS_DIR) + result = self._recover_checkpoint(CONFIG.IN_PROGRESS_DIR) if result != 0: # We have a partial or incomplete recovery # Not as egregious @@ -392,8 +392,8 @@ class AugeasConfigurator(configurator.Configurator): # Need to reload configuration after these changes take effect self.aug.load() - def __remove_contained_files(self, file_list): - """Erase all files contained within file_list + def _remove_contained_files(self, file_list): + """Erase all files contained within file_list. :param file_list: file containing list of file paths to be deleted :type file_list: str