Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /lib/python2.7/site-packages/certbot/ |
�
���_c @ s� d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m
Z
d d l m Z d d l m
Z
d d l m Z d d l m Z e j e � Z d e f d � � YZ d S(
sG Reverter class saves configuration checkpoints and allows for recovery.i����N( t errors( t util( t constants( t
filesystem( t ost Reverterc B s� e Z d Z d � Z d � Z d d � Z d � Z d � Z d � Z d � Z d � Z
d
� Z d � Z d � Z
d
� Z d � Z d � Z d � Z d � Z d � Z d � Z RS( sf Reverter Class - save and revert configuration checkpoints.
This class can be used by the plugins, especially Installers, to
undo changes made to the user's system. Modifications to files and
commands to do undo actions taken by the plugin should be registered
with this class before the action is taken.
Once a change has been registered with this class, there are three
states the change can be in. First, the change can be a temporary
change. This should be used for changes that will soon be reverted,
such as config changes for the purpose of solving a challenge.
Changes are added to this state through calls to
:func:`~add_to_temp_checkpoint` and reverted when
:func:`~revert_temporary_config` or :func:`~recovery_routine` is
called.
The second state a change can be in is in progress. These changes
are not temporary, however, they also have not been finalized in a
checkpoint. A change must become in progress before it can be
finalized. Changes are added to this state through calls to
:func:`~add_to_checkpoint` and reverted when
:func:`~recovery_routine` is called.
The last state a change can be in is finalized in a checkpoint. A
change is put into this state by first becoming an in progress
change and then calling :func:`~finalize_checkpoint`. Changes
in this state can be reverted through calls to
:func:`~rollback_checkpoints`.
As a final note, creating new files and registering undo commands
are handled specially and use the methods
:func:`~register_file_creation` and :func:`~register_undo_command`
respectively. Both of these methods can be used to create either
temporary or in progress changes.
.. note:: Consider moving everything over to CSV format.
:param config: Configuration.
:type config: :class:`certbot.interfaces.IConfig`
c C s, | | _ t j | j t j | j j � d S( N( t configR t make_or_verify_dirt
backup_dirR t CONFIG_DIRS_MODEt strict_permissions( t selfR ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt __init__? s c C sr t j j | j j � rn y | j | j j � Wqn t j k
rj t j d | j j � t j d � � qn Xn d S( s Reload users original configuration files after a temporary save.
This function should reinstall the users original configuration files
for all saves with temporary=True
:raises .ReverterError: when unable to revert config
s$ Incomplete or failed recovery for %ss! Unable to revert temporary configN(
R t patht isdirR t temp_checkpoint_dirt _recover_checkpointR t
ReverterErrort loggert critical( R ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt revert_temporary_configE s
i c C sZ y t | � } Wn- t k
r? t j d � t j d � � n X| d k rk t j d � t j d � � n t j | j j � } | j
� | s� t j d � n. t | � | k r� t j d | t | � � n x� | d k rU| rUt j
j | j j | j � � } y | j | � Wn0 t j k
rGt j d � t j d � � n X| d 8} q� Wd S(
sy Revert 'rollback' number of configuration checkpoints.
:param int rollback: Number of checkpoints to reverse. A str num will be
cast to an integer. So "2" is also acceptable.
:raises .ReverterError:
if there is a problem with the input or if the function is
unable to correctly revert the configuration checkpoints
s, Rollback argument must be a positive integers
Invalid Inputi sH Certbot hasn't modified your configuration, so rollback isn't available.s0 Unable to rollback %d checkpoints, only %d exists) Failed to load checkpoint during rollbacks) Unable to load checkpoint during rollbacki N( t intt
ValueErrorR t errorR R R t listdirR R t sortt warningt lenR
t joint popR R ( R t rollbackt backupst cp_dir( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt rollback_checkpointsY s2
!
c C s | j | j j | | � d S( s� Add files to temporary checkpoint.
:param set save_files: set of filepaths to save
:param str save_notes: notes about changes during the save
N( t _add_to_checkpoint_dirR R ( R t
save_filest
save_notes( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt add_to_temp_checkpoint� s c C s* | j | � | j | j j | | � d S( s� Add files to a permanent checkpoint.
:param set save_files: set of filepaths to save
:param str save_notes: notes about changes during the save
N( t _check_tempfile_savesR" R t in_progress_dir( R R# R$ ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt add_to_checkpoint� s
c C sg t j | t j | j j � | j t j j | d � � \ } } t
| � } x� | D]� } | | k rS t j d | � yS t
j | t j j | t j j | � d t | � � � | j d j | � � WnI t k
r| j � t j d | | � t j d j | | � � � n X| d 7} qS qS W| j � t t j j | d � d � � } | j | � Wd
QXd
S( sg Add save files to checkpoint directory.
:param str cp_dir: Checkpoint directory filepath
:param set save_files: set of files to save
:param str save_notes: notes about changes made during the save
:raises IOError: if unable to open cp_dir + FILEPATHS file
:raises .ReverterError: if unable to add checkpoint
t FILEPATHSs Creating backup of %st _s {0}
s& Unable to add file %s to checkpoint %ss( Unable to add file {0} to checkpoint {1}i t
CHANGES_SINCEt aN( R R R R R R
t _read_and_appendR R
R R R t debugt shutilt copy2t basenamet strt writet formatt IOErrort closeR R R t open( R R R# R$ t op_fdt existing_filepathst idxt filenamet notes_fd( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyR" � s0
'
!c C sU t j j | � r6 t | d � } | j � j � } n g } t | d � } | | f S( s� Reads the file lines and returns a file obj.
Read the file returning the lines, and a pointer to the end of the file.
s r+t w( R R
t isfileR7 t readt
splitlines( R t filepathR8 t lines( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyR- � s c C s� t j j t j j | d � � r@ | j t j j | d � � n t j j t j j | d � � r1y� t t j j | d � � �o } | j � j � } xS t | � D]E \ } } t j
t j j | t j j | � d t | � � | � q� WWd QXWq1t
t f k
r-t j d | � t j d | � � q1Xn | j t j j | d � � y t j | � Wn4 t k
r�t j d | � t j d | � � n Xd S( s Recover a specific checkpoint.
Recover a specific checkpoint provided by cp_dir
Note: this function does not reload augeas.
:param str cp_dir: checkpoint directory file path
:raises errors.ReverterError: If unable to recover checkpoint
t COMMANDSR) R* Ns Unable to recover files from %st NEW_FILESs Unable to remove directory: %s( R R
R> R t _run_undo_commandsR7 R? R@ t enumerateR/ R0 R1 R2 R5 t OSErrorR R R R t _remove_contained_filest rmtree( R R t paths_fdt filepathsR: R
( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyR � s* ! ! 5
c
C s� t j d d k r i d d 6n i } t | d | � �t } t j | � } x[ t t | � � D]G } y t j | � Wq] t j
k
r� t j d d j
| � � q] Xq] WWd QXd S( s Run all commands in a file.i i t t newlinet rs Unable to run undo command: %st N( t syst version_infoR7 t csvt readert reversedt listR t
run_scriptR t SubprocessErrorR R R ( R RA t kwargst csvfilet csvreadert command( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyRE � s &c C s� g } t j j | j j d � } t j j | � rg t | d � � } | j | j � j � � Wd QXn t j j | j j d � } t j j | � r� t | d � � } | j | j � j � � Wd QXn x0 | D]( } | | k r� t
j d | � � q� q� Wd S( s� Verify save isn't overwriting any temporary files.
:param set save_files: Set of files about to be saved.
:raises certbot.errors.ReverterError:
when save is attempting to overwrite a temporary file.
R) RN NRD s+ Attempting to overwrite challenge file - %s( R R
R R R R> R7 t extendR? R@ R R ( R R# t protected_filest temp_patht protected_fdt new_pathR; ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyR&
s ""
c G s� | s t j d � � n | j | � } d } z� y^ | j t j j | d � � \ } } x3 | D]+ } | | k r^ | j d j | � � q^ q^ WWn? t
t f k
r� t j
d | � t j d j | � � � n XWd | d k r� | j � n Xd S( sA Register the creation of all files during certbot execution.
Call this method before writing to the file to make sure that the
file will be cleaned up if the program exits unexpectedly.
(Before a save occurs)
:param bool temporary: If the file creation registry is for
a temp or permanent save.
:param \*files: file paths (str) to be registered
:raises certbot.errors.ReverterError: If
call does not contain necessary parameters or if the file creation
is unable to be registered.
s, Forgot to provide files to registration callRD s {0}
s( Unable to register file creation(s) - %ss) Unable to register file creation(s) - {0}N( R R t _get_cp_dirt NoneR- R R
R R3 R4 R5 RG R R R6 ( R t temporaryt filesR t new_fdt ex_filesR
( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt register_file_creation+ s $
! c C s� t j j | j | � d � } d
} t j d d k rD i d d 6n i } z� yY t j j | � rw t | d | � } n t | d | � } t j
| � } | j | � Wn3 t t
f k
r� t j d � t j d � � n XWd
| d
k r� | j � n Xd
S( s� Register a command to be run to undo actions taken.
.. warning:: This function does not enforce order of operations in terms
of file modification vs. command registration. All undo commands
are run first before all normal files are reverted to their previous
state. If you need to maintain strict order, you may create
checkpoints before and after the the command registration. This
function may be improved in the future based on demand.
:param bool temporary: Whether the command should be saved in the
IN_PROGRESS or TEMPORARY checkpoints.
:param command: Command to be run.
:type command: list of str
RC i i RL RM R, R= s Unable to register undo commands Unable to register undo command.N( R R
R Ra Rb RP RQ R> R7 RR t writert writerowR5 RG R R R R R6 ( R Rc R[ t commands_fpt command_fileRX t csvwriter( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt register_undo_commandR s &
c C sA | r | j j } n | j j } t j | t j | j j � | S( s% Return the proper reverter directory.( R R R' R R R R R
( R Rc R ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyRa x s c C s� | j � t j j | j j � r� y | j | j j � Wq� t j k
r~ t j
d | j j � t j d | j j � � q� Xn d S( sC Revert configuration to most recent finalized checkpoint.
Remove all changes (temporary and permanent) that have not been
finalized. This is useful to protect against crashes and other
execution interruptions.
:raises .errors.ReverterError: If unable to recover the configuration
s= Incomplete or failed recovery for IN_PROGRESS checkpoint - %sN( R R R
R R R' R R R R R ( R ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt recovery_routine� s
c C s� t j j | � s t Syq t | d � �\ } | j � j � } x@ | D]8 } t j j | � rl t j | � qD t j
d | � qD WWd QXWn? t t f k
r� t j
d | � t j d j | � � � n Xt S( s Erase all files contained within file_list.
:param str file_list: file containing list of file paths to be deleted
:returns: Success
:rtype: bool
:raises certbot.errors.ReverterError: If
all files within file_list cannot be removed
RN sV File: %s - Could not be found to be deleted
- Certbot probably shut down unexpectedlyNs. Unable to remove filepaths contained within %ss/ Unable to remove filepaths contained within {0}( R R
R> t FalseR7 R? R@ t lexistst removeR R R5 RG R R R R4 t True( R t file_listt list_fdRK R
( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyRH � s$
c C s[ t j j | j j � s d St j j | j j d � } t j j | j j d � } t j j | � s� t j d � t | d � � } | j
d � Wd QXn yh t | d � �C } | j
d | � t | d � � } | j
| j � � Wd QXWd QXt j
| | � WnI t t f k
rLt j d � t j d
t j � � t j d � � n X| j � d S( sZ Finalize the checkpoint.
Timestamps and permanently saves all changes made through the use
of :func:`~add_to_checkpoint` and :func:`~register_file_creation`
:param str title: Title describing checkpoint
:raises certbot.errors.ReverterError: when the
checkpoint is not able to be finalized.
NR+ s CHANGES_SINCE.tmps/ Rollback checkpoint is empty (no changes made?)R= s No changes
s -- %s --
RN s, Unable to finalize checkpoint - adding titles Exception was:
%ss Unable to add title( R R
R R R' R t existsR t infoR7 R3 R? R/ t moveR5 RG R R. t tracebackt
format_excR R t _timestamp_progress_dir( R t titlet changes_since_patht changes_since_tmp_patht ft changes_tmpt changes_orig( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt finalize_checkpoint� s&
c C s t t j � � } t j t j j | j j d � � } g | D] } t j j | � ^ q= } | j | � | j
� | d | k r� t t | d � d � } t j
d | | � | } nU t | � d k r
| d | k r
t j d | � t t | d � d � } | } n | S( sB Determine the timestamp of the checkpoint, enforcing monotonicity.s [0-9]*i����i sy Current timestamp %s does not correspond to newest reverter checkpoint; your clock probably jumped. Time travelling to %si����s6 Race condition with timestamp %s, incrementing by 0.01g{�G�z�?( R2 t timet globR R
R R R R1 t appendR t floatR R R R. ( R t timestampt otherst dt
timetravel( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt _checkpoint_timestamp� s $%
" c C s� x� t j j d � D]o } | j � } t j j | j j | � } y t j
| j j | � d SWq t k
r� t
j d | � q Xq Wt
j d | j j | � t j d � � d S( s Timestamp the checkpoint.i Ns1 Extreme, unexpected race condition, retrying (%s)s' Unable to finalize checkpoint, %s -> %ss& Unable to finalize checkpoint renaming( t sixt movest rangeR� R R
R R R R t replaceR' RG R R R R R ( R R* R� t final_dir( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyRz s
( t __name__t
__module__t __doc__R R R! R% R( R" R- R RE R& Rg Rm Ra Rn RH R� R� Rz ( ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyR s& ) *
- ' ' & & ) ( R� RR R� t loggingR/ RP R� Rx R� t certbotR R t certbot._internalR t certbot.compatR R t getLoggerR� R t objectR ( ( ( s4 /usr/lib/python2.7/site-packages/certbot/reverter.pyt <module> s