a
}|gnF @ sB d Z ddlZddlmZ ddlZddlmZ ddlZddl Z ddl
Z
ddl Z ddl m Z ddl
Z
ddlZddlZddlmZ ddlmZ ddlmZ dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlZddlmZ ddlm Z ddl m Z ddl m Z ddl!Z"ddl#m$Z$ ddl%m&Z& ddl%m'Z' ddl(m)Z) ddl(m*Z* ddl(m+Z+ ddl,m-Z. ddl/m0Z0 ddl/m1Z1 ddl2m'Z3 ddl4m5Z5 G d d d e5j6Z7e8e8d d d Z9e8e:d d!d"Z;e8ed d&d'Z?e8e$j@d d(d)ZAe8e"jBd d*d+ZCe8e"jDd d,d-ZEe8e$jFd d.d/ZGdTe8e8eHe8d1d2d3ZIejJd4d5d6ZKdUee ejJd7d8d9ZLG d:d; d;ZMeMd4dd?ZOeedd@dAdBZPG dCdD dDejQZRG dEdF dFeRZSe jTe jTe8ddGdHdIZUeg ef e8ddJdKdLZVe8eedMef gedMef f dNdOdPZWe8e8dQdRdSZXdS )VzTest utilities. N) ExitStack)reload) synchronize)Any)Callable)cast)IO)Iterable)List)Optional)Union)mock)default_backend)
serialization)
RSAPrivateKey)crypto)
configuration)util) constants)lock)storage)obj)
filesystem)os)commonc @ s e Zd ZdZee dddZeeeeeddddZd eeee e
e ef dd d
d Z e
e dd d
Z d ee e
ddddZddddZddddZeed ddddZddddZedd d ZdS ) DummyInstallerz(Dummy installer plugin for test purpose.returnc C s g S N selfr r 6/usr/lib/python3.9/site-packages/certbot/tests/util.py
get_all_names- s z DummyInstaller.get_all_namesN)domain cert_pathkey_path
chain_pathfullchain_pathr c C s d S r r )r! r$ r% r& r' r( r r r" deploy_cert0 s zDummyInstaller.deploy_cert)r$ enhancementoptionsr c C s d S r r )r! r$ r* r+ r r r" enhance4 s zDummyInstaller.enhancec C s g S r r r r r r" supported_enhancements8 s z%DummyInstaller.supported_enhancementsF)title temporaryr c C s d S r r )r! r. r/ r r r" save; s zDummyInstaller.savec C s d S r r r r r r" config_test> s zDummyInstaller.config_testc C s d S r r r r r r" restartA s zDummyInstaller.restart).N)addr c C s d S r r )clsr3 r r r" add_parser_argumentsD s z#DummyInstaller.add_parser_argumentsc C s d S r r r r r r" prepareH s zDummyInstaller.preparec C s dS )N r r r r r" more_infoK s zDummyInstaller.more_info)N)NF)__name__
__module__ __qualname____doc__r strr# r) r r r
r, r- boolr0 r1 r2 classmethodr r5 r6 r8 r r r r" r + s" r )namesr c G sF t }t|j tjtjdg| R }| tj
|}t |S )zPath to a test vector.testdata) r atexitregisterclose importlib resourcesfiles __package__joinpath
enter_contextZas_filer= )r@ Z
_file_manager
vector_refpathr r r" vector_pathO s
rM c G sT t jtjdg| R }| }z| dd W S t yN | Y S 0 dS )z Load contents of a test vector.rA z
N)
rE rF rG rH rI
read_bytesdecodereplaceencode
ValueError)r@ rK datar r r" load_vectorX s rU )filename
loader_pem
loader_derr c C s< t j| \}}| dkr |S | dkr0|S tdd S )Nz.pemz.derz1Loader could not be recognized based on extension)r rL splitextlowerrS )rV rW rX _extr r r"
_guess_loadere s r] c G s$ t | d tjtj}t|t| S )zLoad certificate.)r] r FILETYPE_PEM
FILETYPE_ASN1Zload_certificaterU r@ loaderr r r" load_certn s rc c G s$ t | d tjtj}t|t| S )zLoad certificate request.r^ )r] r r_ r` Zload_certificate_requestrU ra r r r" load_csru s rd c G s t t| S )z(Load ComparableX509 certificate request.)joseComparableX509rd )r@ r r r" load_comparable_csr| s rg c G sL t | d tjtj}|tjkr&tj}ntj}tt t
|t | dt dS )zLoad RSA private key.r^ N)passwordZbackend)
r] r r_ r` r Zload_pem_private_keyZload_der_private_keyre ComparableRSAKeyr r rU r )r@ rb Z loader_fnr r r" load_rsa_private_key s
rj c G s$ t | d tjtj}t|t| S )zLoad pyOpenSSL private key.r^ )r] r r_ r` Zload_privatekeyrU ra r r r" load_pyopenssl_private_key s rk T)
config_dirtestfileecr c
sp |dt d }tj tj}tj tj|}tj tj|}|||fD ]}tj|sPt
| qPt d |rzdnd}t
|D ]$} ttj|| tj|| qtjD ]0} ttj|d | tj|d | qtj ||}
tt |T} t|
d(} | fd d
| D W d n1 sB0 Y W d n1 sb0 Y |
S ) a Creates a lineage defined by testfile.
This creates the archive, live, and renewal directories if
necessary and creates a simple lineage.
:param str config_dir: path to the configuration directory
:param str testfile: configuration file to base the lineage on
:param bool ec: True if we generate the lineage with an ECDSA key
:returns: path to the renewal conf file for the created lineage
:rtype: str
Nz.confzsample-archive{}z-ecr7 z{0}1.pemz{0}.pemwc 3 s | ]}| d V qdS )ZMAGICDIRN)rQ ).0linerl r r" s z make_lineage..)lenr rL joinr ZRENEWAL_CONFIGS_DIRZ ARCHIVE_DIRZLIVE_DIRexistsr makedirsrM formatlistdirshutilcopyfiler ZALL_FOURsymlinkopen
writelines)
rl rm rn Z lineage_nameZconf_dir archive_dirZlive_dirZ directoryZsample_archivekindZ conf_pathsrcdstr rr r" make_lineage s:
Hr r c C s t tjtjdtdS )aD Patch certbot.display.util to use a special mock display utility.
The mock display utility works like a regular mock object, except it also
also asserts that methods are called with valid arguments.
The mock created by this patch mocks out Certbot internals. That is, the
mock object will be called by the certbot.display.util functions and the
mock returned by that call will be used as the display utility. This was
done to simplify the transition from zope.component and mocking
certbot.display.util functions directly in test code should be preferred
over using this function in the future.
See https://github.com/certbot/certbot/issues/8948
:returns: patch on the function used internally by certbot.display.util to
get a display utility instance
:rtype: mock.MagicMock
)certbot._internal.display.obj.get_display)Z new_callable)r r
MagicMockpatch_create_display_util_mockr r r r" patch_display_util s r )stdoutr c C s* | r| nt } ttjtjdt| dS )a Patch certbot.display.util to use a special mock display utility.
The mock display utility works like a regular mock object, except it also
asserts that methods are called with valid arguments.
The mock created by this patch mocks out Certbot internals. That is, the
mock object will be called by the certbot.display.util functions and the
mock returned by that call will be used as the display utility. This was
done to simplify the transition from zope.component and mocking
certbot.display.util functions directly in test code should be preferred
over using this function in the future.
See https://github.com/certbot/certbot/issues/8948
The `message` argument passed to the display utility methods is passed to
stdout's write method.
:param object stdout: object to write standard output to; it is
expected to have a `write` method
:returns: patch on the function used internally by certbot.display.util to
get a display utility instance
:rtype: mock.MagicMock
r )new)ioStringIOr r
r r %_create_display_util_mock_with_stdoutr r r r" patch_display_util_with_stdout s r c @ s e Zd ZdZddejjfeee de
f e
ddddZ ddd d
Z e
e
ej
d d d
Zee
dddZee
ddddZdS )
FreezableMocka Mock object with the ability to freeze attributes.
This class works like a regular mock.MagicMock object, except
attributes and behavior set before the object is frozen cannot
be changed during tests.
If a func argument is provided to the constructor, this function
is called first when an instance of FreezableMock is called,
followed by the usual behavior defined by MagicMock. The return
value of func is ignored.
FN.)frozenfunc return_valuer c C s> |r
t ndh| _|| _t | _|tjjkr4|| _|| _ d S )Nfreeze)
set _frozen_set_funcr
r _mocksentinelDEFAULTr _frozen)r! r r r r r r" __init__ s
zFreezableMock.__init__r c C s
d| _ dS )z)Freeze object preventing further changes.TN)r r r r r" r s zFreezableMock.freezeargskwargsr c O s* | j d ur| j |i | | j|i |S r )r r )r! r r r r r" __call__ s
zFreezableMock.__call__)namer c C s| |dkr.zt | |W S ty* Y dS 0 nJ|dv rHtt | d|S |dksZ|| jv rft | |S tt | d|S d S )Nr Fr Z side_effectr r )object__getattribute__AttributeErrorgetattrr )r! r r r r" r s
z FreezableMock.__getattribute__)r valuer c C sb | j r*|| jv r td| t| j||S |dkr>| j| |dv rTt| j||S t| ||S )a Before it is frozen, attributes are set on the FreezableMock
instance and added to the _frozen_set. Attributes in the _frozen_set
cannot be changed after the FreezableMock is frozen. In this case,
they are set on the underlying _mock.
In cases of return_value and side_effect, these attributes are always
passed through to the instance's _mock and added to the _frozen_set
before the object is frozen.
z Cannot change frozen attribute r r )r r r setattrr r3 r __setattr__)r! r r r r r" r & s
zFreezableMock.__setattr__)r9 r: r; r< r
r r r> r r r r r r r r= r r r r r r" r s
r c C sX t } dd ttjD }|D ]$}|dkr t dtd}t| || q | t d| dS )Nc S s* g | ]"}t ttj|r|d s|qS __callabler display_obj FileDisplay
startswithrp r r r r"
B s
z-_create_display_util_mock.. notificationTr r r r )r dirr r _assert_valid_callr r )display method_listmethod frozen_mockr r r" r ? s r c s t ttd dfdd ttd d fdd }t }dd ttjD }|D ]2}|d krftd
d }n td
|d }t||| qL| td
|d S )
N)message unused_args
unused_kwargsr c s | r | dS )z$Write to message to stdout.
N)write)r r r r r r"
_write_msgN s z9_create_display_util_mock_with_stdout.._write_msgr c s t | | | i | dS )z<
Mock function for display utility methods.
N)r )r r )r r r" mock_methodT s
z:_create_display_util_mock_with_stdout..mock_methodc S s* g | ]"}t ttj|r|d s|qS r r r r r r" r ] s
z9_create_display_util_mock_with_stdout..r Tr r )r= r r r r r r r )r r r r r r r )r r r" r M s r r c O sN | r | d n|d g}| dd | dd | ddd}tj|i | d S )Nr r defaultcli_flagforce_interactiveF)r r r )get display_utilZassert_valid_call)r r Z assert_argsZ
assert_kwargsr r r" r l s
r c @ s, e Zd ZdZddddZddddZdS )TempDirTestCasezBBase test class which sets up and tears down a temporary directoryNr c C s t | _dS )zExecute before testN)tempfileZmkdtemptempdirr r r r" setUp{ s zTempDirTestCase.setUpc C s* t g t _t t| j dS )zExecute after testN) loggingZshutdownZ getLoggerhandlersr Z_release_locksrz rmtreer r r r r" tearDown s
zTempDirTestCase.tearDown)r9 r: r; r< r r r r r r" r x s r c s& e Zd ZdZdd fdd Z ZS )ConfigTestCasez2Test class which sets up a NamespaceConfig object.Nr c s t ttjf i ttj | _
| j
i d| j
j _
tj| jd| j
j _tj| jd| j
j _tj| jd| j
j _tj d | j
j _tj d | j
j _tj d | j
j _d| j
j _d S )NZcertonlyconfigZworkZlogsZauth_cert_pathZauth_chain_pathzhttps://example.com)superr r ZNamespaceConfigr
r copydeepcopyr Z CLI_DEFAULTSr Zset_argument_sources namespaceZverbr rL ru r rl Zwork_dirZlogs_dirr% r( r' Zserverr __class__r r" r s
zConfigTestCase.setUp)r9 r: r; r< r
__classcell__r r r r" r s r )event_in event_outrL r c C sF t j|rt|}n
t|}z| W | n
| 0 dS )a
Acquire a file lock on given path, then wait to release it. This worker is coordinated
using events to signal when the lock should be acquired and released.
:param multiprocessing.Event event_in: event object to signal when to release the lock
:param multiprocessing.Event event_out: event object to signal when the lock is acquired
:param path: the path to lock
N)r rL isdirr Zlock_dirZLockFiler release)r r rL Zmy_lockr r r" _handle_lock s
r )callback path_to_lockr c C sR t t t }t }tjt|||fd}| | | |jdd dS )z
Grab a lock on path_to_lock from a foreign process then execute the callback.
:param callable callback: object to call after acquiring the lock
:param str path_to_lock: path to file or directory to lock
)targetr
)timeoutN)
reload_moduler multiprocessingEventZProcessr startr ru )r r Z
emit_eventZ
receive_eventZprocessr r r"
lock_and_call s r .)reasonr c s( t dtf t dtf d fdd }|S )zFDecorator to skip permanently a test on Windows. A reason is required..)functionr c s t tjdk | S )zWrapped versionwin32)unittestZskipIfsysplatform)r r r r" wrapper s z skip_on_windows..wrapper)r r )r r r r r" skip_on_windows s $r )rL r c C s t jt | S )z
Return the given path joined to the tempdir path for the current platform
Eg.: 'cert' => /tmp/cert (Linux) or 'C:\Users\currentuser\AppData\Temp\cert' (Windows)
)r rL ru r Z
gettempdir)rL r r r" temp_join s r )T)N)Yr< rB
contextlibr r rE r r Zimportlib.resourcesr r r r rz r r typingr r r r r r
r r r r
Z cryptography.hazmat.backendsr Z cryptography.hazmat.primitivesr Z-cryptography.hazmat.primitives.asymmetric.rsar Zjosepyre ZOpenSSLr Zcertbotr r Zcertbot._internalr r r Zcertbot._internal.displayr r Zcertbot.compatr r Zcertbot.displayr Zcertbot.pluginsr Z Installerr r= rM bytesrU intr] ZX509rc ZX509Reqrd rf rg ri rj ZPKeyrk r> r r r r r r r r ZTestCaser r r r r r r r r r r" s| $
-
E *