3
گau @ s d Z ddlmZ ddlZddlZddlZddlZddlmZ ddlm Z ddlm
Z
ddlm Z yZ,eedd d?d@Z-dZeee e edAdBdCZ.ee ee eef f dDdEdFZ/eedd'dGdHZ0eedd'dIdJZ1e eef edKdLdMZ2eeed dNdOZ3eeedPdQdRZ4edSdTdUZ5dS )[z;Compat module to handle files security on Windows and Linux )absolute_importN)Any)Dict)List)OptionalTFc @ s e Zd ZdZddddZdS )
_WindowsUmaskz+Store the current umask to apply on WindowsN)returnc C s
d| _ d S )N )mask)self r /usr/lib/python3.6/filesystem.py__init__" s z_WindowsUmask.__init__)__name__
__module__ __qualname____doc__r r r r r
r s r ) file_pathmoder c C s t rtj| | n
t| | dS )a[
Apply a POSIX mode on given file_path:
- for Linux, the POSIX mode will be directly applied using chmod,
- for Windows, the POSIX mode will be translated into a Windows DACL that make sense for
Certbot context, and applied to the file using kernel calls.
The definition of the Windows DACL that correspond to a POSIX mode, in the context of Certbot,
is explained at https://github.com/certbot/certbot/issues/6356 and is implemented by the
method `_generate_windows_flags()`.
:param str file_path: Path of the file
:param int mode: POSIX mode to apply
N)
POSIX_MODEoschmod_apply_win_mode)r r r r r
r ) s r )r
r c C s t rtj| S tj}| t_|S )a$
Set the current numeric umask and return the previous umask. On Linux, the built-in umask
method is used. On Windows, our Certbot-side implementation is used.
:param int mask: The user file-creation mode mask to apply.
:rtype: int
:return: The previous umask value.
)r r umask_WINDOWS_UMASKr
)r
Zprevious_umaskr r r
r > s
r )srcdstr copy_user
copy_groupr c C sV t r:tj| }|r|jnd}|r&|jnd}tj||| n|rHt| | t|| dS )a
Copy ownership (user and optionally group on Linux) from the source to the
destination, then apply given mode in compatible way for Linux and Windows.
This replaces the os.chown command.
:param str src: Path of the source file
:param str dst: Path of the destination file
:param int mode: Permission mode to apply on the destination file
:param bool copy_user: Copy user if `True`
:param bool copy_group: Copy group if `True` on Linux (has no effect on Windows)
Nr )r r statst_uidst_gidchown_copy_win_ownershipr )r r r r r statsuser_idgroup_idr r r
copy_ownership_and_apply_modeX s
r) )r r r r r c C sb t rFtj| }|r|jnd}|r&|jnd}tj||| t||j n|rTt| | t | | dS )aU
Copy ownership (user and optionally group on Linux) and mode/DACL
from the source to the destination.
:param str src: Path of the source file
:param str dst: Path of the destination file
:param bool copy_user: Copy user if `True`
:param bool copy_group: Copy group if `True` on Linux (has no effect on Windows)
r Nr r )
r r r! r" r# r$ r st_moder% _copy_win_mode)r r r r r& r' r( r r r
copy_ownership_and_modey s
r, c C s$ t rtjtj| j|kS t| |S )aa
Check if the given mode matches the permissions of the given file.
On Linux, will make a direct comparison, on Windows, mode will be compared against
the security model.
:param str file_path: Path of the file
:param int mode: POSIX mode to test
:rtype: bool
:return: True if the POSIX mode matches the file permissions
)r r! S_IMODEr r* _check_win_mode)r r r r r
check_mode s r/ )r r c C s8 t rtj| jtj kS tj| tj}|j }t |kS )z
Check if given file is owned by current user.
:param str file_path: File path to check
:rtype: bool
:return: True if given file is owned by current user, False otherwise.
)
r r r! r" getuid
win32securityGetFileSecurityOWNER_SECURITY_INFORMATIONGetSecurityDescriptorOwner_get_current_user)r securityuserr r r
check_owner s
r8 c C s t | ot| |S )z
Check if given file has the given mode and is owned by current user.
:param str file_path: File path to check
:param int mode: POSIX mode to check
:rtype: bool
:return: True if file has correct mode and owner, False otherwise.
)r8 r/ )r r r r r
check_permissions s r9 )r flagsr r c
C s> t rtj| ||S |tj@ r$|tj@ r.tjntj}tj }|j
}t }t ||t
j}|j|d |jd|d d}zy$tj| tjtjtj@ ||dd}W n\ tjk
r } z>| jtjkrttj | j | jtj krttj | j | W Y dd} ~ X nX W d|r
|j X tj| |tjA tjA S tj| |}t!| | |S )aw
Wrapper of original os.open function, that will ensure on Windows that given mode
is correctly applied.
:param str file_path: The file path to open
:param int flags: Flags to apply on file while opened
:param int mode: POSIX mode to apply on file when opened,
Python defaults will be applied if ``None``
:returns: the file descriptor to the opened file
:rtype: int
:raise: OSError(errno.EEXIST) if the file already exists and os.O_CREAT & os.O_EXCL are set,
OSError(errno.EACCES) on Windows if the file already exists and is a directory, and
os.O_CREAT is set.
r r N)"r r openO_CREATO_EXCLwin32conZ
CREATE_NEWZ
CREATE_ALWAYSr1 SECURITY_ATTRIBUTESSECURITY_DESCRIPTORr5 _generate_daclr r
SetSecurityDescriptorOwnerSetSecurityDescriptorDacl win32fileZ
CreateFileZ GENERIC_READZFILE_SHARE_READZFILE_SHARE_WRITE
pywintypeserrorwinerrorZERROR_FILE_EXISTSOSErrorerrnoEEXISTstrerrorZERROR_SHARING_VIOLATIONZEACCESZCloser )
r r; r Z disposition
attributesr6 r7 daclZhandleerrr r r
r< s6
r< c C s^ t d}zFt |d|A B tr*tj| |S tj}ztt_tj| |S |t_X W dt | X dS )a4
Rewrite of original os.makedirs function, that will ensure on Windows that given mode
is correctly applied.
:param str file_path: The file path to open
:param int mode: POSIX mode to apply on leaf directory when created, Python defaults
will be applied if ``None``
r i N)r r r makedirsmkdir)r r Z
current_umaskZ
orig_mkdir_fnr r r
rP s rP c C s t rtj| |S tj }|j}t }t||tj }|j
|d |j d|d yt j
| | W nH tjk
r } z*|jtjkrttj|j| |j|W Y dd}~X nX dS )a,
Rewrite of original os.mkdir function, that will ensure on Windows that given mode
is correctly applied.
:param str file_path: The file path to open
:param int mode: POSIX mode to apply on directory when created, Python defaults
will be applied if ``None``
Fr r N)r r rQ r1 r@ rA r5 rB r r
rC rD rE ZCreateDirectoryrF rG rH ZERROR_ALREADY_EXISTSrI rJ rK rL )r r rM r6 r7 rN rO r r r
rQ ' s rQ )r r r c C s, t tdr ttd| | n tj| | dS )z
Rename a file to a destination path and handles situations where the destination exists.
:param str src: The current file path.
:param str dst: The new file path.
replaceN)hasattrr getattrrename)r r r r r
rR F s
rR c C s | }t stjdkr characters) is encountered on Windows
z\\?\i Nz3Long paths are not supported by Certbot on Windows.)r r_ r
startswithlen
ValueError)re rZ r r r
r_ y s
r_ )rZ r c C s& t r tjj| o tj| tjS t| S )z
Is path an executable file?
:param str path: path to test
:return: True if path is an executable file
:rtype: bool
)r r rZ isfileaccessX_OK_win_is_executable)rZ r r r
is_executable s rn c C sV t r ttjtj| jtj@ S tj| tj }|j
}t|j tj tj
tjddS )z
Check if everybody/world has any right (read/write/execute) on a file given its path.
:param str path: path to test
:return: True if everybody/world has any right to the file
:rtype: bool
zS-1-1-0) TrusteeForm TrusteeType
Identifier)r boolr! r- r r* S_IRWXOr1 r2 DACL_SECURITY_INFORMATIONGetSecurityDescriptorDaclGetEffectiveRightsFromAclTRUSTEE_IS_SIDTRUSTEE_IS_USERConvertStringSidToSid)rZ r6 rN r r r
has_world_permissions s rz )old_key base_moder c C s: t r6tjtj| jtjtjB tjB tjB @ }||B S |S )a
Calculate the POSIX mode to apply to a private key given the previous private key.
:param str old_key: path to the previous private key
:param int base_mode: the minimum modes to apply to a private key
:return: the POSIX mode to apply
:rtype: int
) r r! r- r r* S_IRGRPS_IWGRPS_IXGRPS_IROTH)r{ r| Zold_moder r r
compute_private_key_mode s
r )path1path2r c C sd t r0tj| }tj|}|j|jf|j|jfkS tj| tj}|j }tj|tj}|j }||kS )as
Return True if the ownership of two files given their respective path is the same.
On Windows, ownership is checked against owner only, since files do not have a group owner.
:param str path1: path to the first file
:param str path2: path to the second file
:return: True if both files have the same ownership, False otherwise
:rtype: bool
) r r r! r" r# r1 r2 r3 r4 )r r Zstats1Zstats2Z security1Zuser1Z security2Zuser2r r r
has_same_ownership s
r )rZ min_moder c C s t r tj| j}|||B kS t| } tj| tjtjB }|j }|j
}t ||}xTt |j
D ]D}|j|}|d } |d }|jtjtj|d}
|
|
| B kr`dS q`W dS )a
Check if a file given its path has at least the permissions defined by the given minimal mode.
On Windows, group permissions are ignored since files do not have a group owner.
:param str path: path to the file to check
:param int min_mode: the minimal permissions expected
:return: True if the file matches the minimal permissions expectations, False otherwise
:rtype: bool
r )ro rp rq FT)r r r! r* r[ r1 r2 r3 rt r4 ru rB range GetAceCountGetAcerv rw rx ) rZ r r* r6 r7 rN Zmin_daclindexZmin_acer
Zeffective_maskr r r
has_min_permissions s(
r c C sN t jj| sdS tj| tj}|j }|jtjtj t
d}|t j @ t j kS )NF)ro rp rq )
r rZ rj r1 r2 rt ru rv rw rx r5
ntsecurityconFILE_GENERIC_EXECUTE)rZ r6 rN r r r r
rm s rm c C sJ t | } tj| tj}|j }t||}|jd|d tj| tj| dS )z
This function converts the given POSIX mode into a Windows ACL list, and applies it to the
file given its path. If the given path is a symbolic link, it will resolved to apply the
mode on the targeted file.
r r N) r[ r1 r2 r3 r4 rB rD SetFileSecurityrt )r r r6 r7 rN r r r
r ) s
r )user_sidr r
r c C s |r|d| @ }t |}tjd}tjd}tjd}tj }| ||gkrjt|d }|rj|jtj|| t|d } | r|jtj| | tdddd}
|jtj|
| |jtj|
| |S ) Ni zS-1-5-18z S-1-5-32-544zS-1-1-0r7 allT)readwriteexecute)
_analyze_moder1 ry ZACL_generate_windows_flagsZAddAccessAllowedAceZ ACL_REVISION) r r r
ZanalysissystemZadminsZeveryonerN Z
user_flagsZeverybody_flagsZfull_permissionsr r r
rB < s$
rB )r r c C s> | t j@ | t j@ | t j@ d| t j@ | t j@ | t j@ ddS )N)r r r )r7 r )r! S_IRUSRS_IWUSRS_IXUSRr S_IWOTHS_IXOTH)r r r r
r ` s r c C sL t | } tj| tj}|j }tj|tj}|j|d tj|tj| d S )NF)r[ r1 r2 r3 r4 rC r )r r security_srcZuser_src security_dstr r r
r% o s r% c C sN t | } tj| tj}|j }tj|tj}|jd|d tj|tj| d S )Nr r )r[ r1 r2 rt ru rD r )r r r rN r r r r
r+ ~ s r+ ) rights_descr c C sJ d}| d r|t jB }| d r4|t jt jA t jA B }| d rF|t jB }|S )Nr r r r )r ZFILE_GENERIC_READZFILE_ALL_ACCESSr )r flagr r r
r s
r c C sH t | } tj| tjtjB }|j }|j }|s4dS t||}t||S )NF) r[ r1 r2 r3 rt ru r4 rB _compare_dacls)r r r6 rN r7 Zref_daclr r r
r. s
r. )dacl1dacl2r c s4 fddt j D fddt j D kS )z
This method compare the two given DACLs to check if they are identical.
Identical means here that they contains the same set of ACEs in the same order.
c s g | ]} j |qS r )r ).0r )r r r
s z"_compare_dacls..c s g | ]} j |qS r )r )r r )r r r
r s )r r )r r r )r r r
r s r )r c C s$ dj tj tj } tjd| d S )z=
Return the pySID corresponding to the current user.
z{0}\{1}Nr )r^ win32apiZ
GetDomainNameZ GetUserNamer1 ZLookupAccountName)Z account_namer r r
r5 s r5 )TT)r: )r: )r: )N)6r Z
__future__r rJ r r! rX Ztypingr r r r r rF r r? rE r1 rH ImportErrorr r r strintr r rr r) r, r/ r8 r9 r< rP rQ rR r[ r_ rn rz r r r rm r rB r r% r+ r r. r r5 r r r r
sf
! E ""-$