"jVdZddlZddlZddlmZddlmZddlmZddl m Z m Z m Z m Z ddlmZdZej"d Zd Zd Zd Zd ZdZGddZy)a Implements the `LockManager` object that provides the locking functionality. The LockManager requires a LockStorageDict object to implement persistence. Two alternative lock storage classes are defined in the lock_storage module: - wsgidav.lock_man.lock_storage.LockStorageDict - wsgidav.lock_man.lock_storage.LockStorageShelve The lock data model is a dictionary with these fields: root: Resource URL. principal: Name of the authenticated user that created the lock. type: Must be 'write'. scope: Must be 'shared' or 'exclusive'. depth: Must be '0' or 'infinity'. owner: String identifying the owner. timeout: Seconds remaining until lock expiration. This value is passed to create() and refresh() expire: Converted timeout for persistence: expire = time() + timeout. token: Automatically generated unique token. N)contextmanager)pformat)util) HTTP_LOCKEDDAVErrorDAVErrorConditionPRECONDITION_CODE_LockConflict) ReadWriteLockreStructuredTextzwsgidav.lock_mancjdtjttjdzS)Nzopaquelocktoken:)rto_strhexsecretsrandbitsL/srv/dav/.venv/lib/python3.12/site-packages/wsgidav/lock_man/lock_manager.pygenerate_lock_tokenr?s&  C0@0@0E,F G GGrc`|sJtj|}d|jdz}|S)N/)rrstrip)paths rnormalize_lock_rootrCs. K4 ;;t D C D KrcZt|d}|dk\xr|tjkS)Nexpirer)floattime)lockrs ris_lock_expiredr Ks* 4> "F Q; /6DIIK//rc |sy|ddkrdj|d}n@djtj|d|dtjz }dj|j ddd d |j d |j d |j d |j d|S)zReturn readable rep.z Lock: Nonerrz Infinite ({})z{} (in {} seconds)z-Lock(<{}..>, {!r}, {}, {}, depth-{}, until {}tokenz??????????????????????????????root principalscopedepth)formatr get_log_timerget) lock_dictrs r lock_stringr-Ps Q '' ((;<%,,   i1 2Ih4G$))+4U  ; A A gx(B/ f k" g g rctj|dsJ|djdsJ|ddk(sJ|ddvsJ|ddvsJtj|d sJ|t |d }|d kDs |d k(sJd tj|dsJd|vrtj|dsJyy)Nr%rtypewriter'shared exclusiver(0infinityownertimeoutrztimeout must be positive or -1r&r")ris_str startswithis_bytesr)rr8s r validate_lockr=gs ;;tF| $$ $ < " "3 '' ' <7 "" " =3 33 3 =- -- - ==g '-- 'DO$G Q;'R-I)II ' ;;tK( )) )${{4=)))rceZdZdZdZdZdZdZd dZdZ dZ d d d Z d Z e d d d ZdddZdddZdZdZdddZdddZdZdZdddZdZdZdZy)! LockManagerzI Implements locking functionality using a custom storage layer. i: ct|dsJt|_||_|jj i|_y)z@ storage: LockManagerStorage object get_lock_listN)hasattrr _lockstorageopen_active_writes)selfrDs r__init__zLockManager.__init__s> w000"_    !rc8|jjy)N)rDcloserGs r__del__zLockManager.__del__s rcN|jjd|jdS)N()) __class____name__rDrKs r__repr__zLockManager.__repr__s%..))*!DLL+;1==rci}i}i}i}tj|d||jjddddD]}|d}t |||<|j |dgj ||j |dgj ||j |d gj |tjd t|d d |rmtjdt|dd tjdt|dd tjdt|dd yy)Nz: rTF include_rootinclude_children token_onlyr"r&r7r%zLocks: r)indentwidthzLocks by URL: zLocks by principal: zLocks by owner: )_loggerinforDrAr- setdefaultappendr)rGmsgurlDict ownerDictuserDict tokenDictrtoks r_dumpzLockManager._dumpsU   vRu%&LL.. dTe/  =Dw-C(.IcN   [ 12 6 = =c B  g 3 : :3 ?   tF|R 0 7 7 < =  x !3 GHIJ  LL?771C+P*QR S LL'#(N'OP  LL,WYqPS-T,UV W rc|tj}n|dkrd}|||||||d}|jj|||S)aAcquire lock and return lock_dict. principal Name of the principal. lock_type Must be 'write'. lock_scope Must be 'shared' or 'exclusive'. lock_depth Must be '0' or 'infinity'. lock_owner String identifying the owner. path Resource URL. timeout Seconds to live This function does NOT check, if the new lock creates a conflict! rr9)r%r/r'r(r7r8r&)r?LOCK_TIME_OUT_DEFAULTrDcreate) rGr& lock_type lock_scope lock_depth lock_ownerrr8r,s r_generate_lockzLockManager._generate_locksZ, ?!77G q[G"  D),rc t|}|jj |j|||||||j ||||||||jj S#|jj wxYw)zCheck for permissions and acquire a lock. On success return new lock dictionary. On error raise a DAVError with an embedded DAVErrorCondition. )rrC acquire_write_check_lock_permissionrnrelease) rGurlrjrkrlrmr8r& token_lists racquirezLockManager.acquires""#&   " !  ' 'Y J I &&9j*j#w JJ   DJJ   s ,A..B r5)r(ct|}|jj |j||||}t |j dkDrt t||jj|ddz|j|<|jjy#|jjwxYw)aAtomically check write permission and mark as being written. Must be paired with a call to end_write_transaction(), typically in a try/finally block. This closes the TOCTOU race where a LOCK is granted to another principal after the write-permission check but before the (potentially slow) request body has been written (CWE-367): as long as the transaction is active, acquire() will deny new locks on . On error (conflicting lock) raise a DAVError(HTTP_LOCKED). r err_conditionN) rrCrp_get_write_conflictslenhrefsrrrFr+rr)rGrsrtr&r(errconds r_begin_write_transactionz$LockManager._begin_write_transactions"#&   " !//UJ RG7==!A%{'BB'+':':'>'>sA'F'JD   $ JJ   DJJ   s A)B++Ccbt|}|jj |jj |ddz }|dkr|jj |dn||j|<|jj y#|jj wxYw)z3Clear the marker set by _begin_write_transaction().rryN)rrCrprFr+poprr)rGrscounts r_end_write_transactionz"LockManager._end_write_transaction s!#&   " !''++C3a7Ez##''T2+0##C( JJ   DJJ   s ABB.c#K|j|||| d|j|y#|j|wxYww)zACheck write permission and clear the marker when the block exits.)rsrtr&r(N)r~r)rGrsrtr&r(s rwrite_transactionzLockManager.write_transactionsK %%! &  -   ' ' ,D ' ' ,sA/AAANr8c`|tj}|jj||S)z0Set new timeout for lock, if existing and valid.r)r?rhrDrefresh)rGr"r8s rrzLockManager.refresh's, ?!77G||##E7#;;rkeycZ|dvsJ|jj|}|||S||S)zReturn lock_dict, or None, if not found or invalid. Side effect: if lock is expired, it will be purged and None is returned. key: name of lock attribute that will be returned instead of a dictionary. ) Nr/r'r(r7r%r8r&r")rDr+)rGr"rrs rget_lockzLockManager.get_lock-sI    ||& ;$,KCyrc:|jj|y)z Delete lock.N)rDdelete)rGr"s rrrzLockManager.releaseEs E"rc.|j|d|k(S)zCReturn True, if exists, is valid, and bound to .r&r)r)rGr"r&s ris_token_locked_by_userz#LockManager.is_token_locked_by_userIs}}U }4 AArF recursivecZt|}|jj|d|d}|S)zReturn list of lock_dict, if is protected by at least one direct, valid lock. Side effect: expired locks for this url are purged. TFrT)rrDrA)rGrsrlockLists rget_url_lock_listzLockManager.get_url_lock_listMs7 "#&<<-- dY5. r)r&ct|}g}|}|rh|jj|ddd}|D],}||k7r |ddk7r| ||dk(s|j|.t j |}|rh|S)zReturn a list of valid lockDicts, that protect directly or indirectly. If a principal is given, only locks owned by this principal are returned. Side effect: expired locks for this path and all parents are purged. TFrTr(r6r&)rrDrAr_rget_uri_parent)rGrsr&ru lock_listrs rget_indirect_url_lock_listz&LockManager.get_indirect_url_lock_listXs "#&  22u3I" *8W  ; $ T+5F(FOOD) *##A&Arc@|j|}t|dkDS)z'Return True, if url is directly locked.r)rr{)rGrsrs r is_url_lockedzLockManager.is_url_lockedqs!))#.8}q  rc\|j|d}|xrtj||S)z?Check, if url (or any of it's parents) is locked by lock_token.r%r)rris_equal_or_child_uri)rGrs lock_tokenlockUrls ris_url_locked_by_tokenz"LockManager.is_url_locked_by_tokenvs,-- -7C455gsCCrc |jj |j||}|D]}|j|d |jjy#|jjwxYw)Nrr")rCrprrr)rGrsrrrs rremove_all_locks_from_urlz%LockManager.remove_all_locks_from_url{sn   " !--cY-GH  , T']+ , JJ   DJJ   s .A&&Bc  |dk(sJ|dvsJ|dvsJtjd|d|d|d|d tt}|jj  |}|r|j |} | D]w} tjd|dt| ||k7r | dd k7r5| d d k(r|d k(rCtjd t| |j| d ytj|}|r|jj|r)tjd||j||d k(r|jj|ddd} | D]R} tj || d sJtjdt| |j| d T|jj#D]H\} } | s tj || s tjd| |j| J|jj%t'|j(dkDrt+t,|y#|jj%wxYw)auCheck, if can lock , otherwise raise an error. If locking would create a conflict, DAVError(HTTP_LOCKED) is raised. An embedded DAVErrorCondition contains the conflicting resource. @see http://www.webdav.org/specs/rfc4918.html#lock-model - Parent locks WILL NOT be conflicting, if they are depth-0. - Exclusive depth-infinity parent locks WILL be conflicting, even if they are owned by . - Child locks WILL NOT be conflicting, if we request a depth-0 lock. - Exclusive child locks WILL be conflicting, even if they are owned by . (7.7) - It is not enough to check whether a lock is owned by , but also the token must be passed with the request. (Because may run two different applications on his client.) - cannot lock-exclusive, if he holds a parent shared-lock. (This would only make sense, if he was the only shared-lock holder.) - TODO: litmus tries to acquire a shared lock on one resource twice (locks: 27 'double_sharedlock') and fails, when we return HTTP_LOCKED. So we allow multi shared locks on a resource even for the same principal. @param url: URL that shall be locked @param lock_type: "write" @param lock_scope: "shared"|"exclusive" @param lock_depth: "0"|"infinity" @param token_list: list of lock tokens, that the user submitted in If: header @param principal: name of the principal requesting a lock @return: None (or raise) r0r1r4zcheckLockPermission(, rOz check parent r(r6r'r2 -> DENIED due to locked parent r%z. -> DENIED due to active write transaction on FTrT -> DENIED due to locked child rrwN)r\debugrr rC acquire_readrr-add_hrefrrrFr+warningrDrA is_child_uriitemsrrr{r|rr)rGrsrjrkrlrtr&r}rrr child_ocksw_urlrs rrqz"LockManager._check_lock_permissionsFG###4444.... "3%r*R |2i[PQ R $$BC !0 !A 2215 % 3DMM$5aS;t;L:M"NOCxDMZ$? g(2zX7M!MM:;t;L:MN$$T&\2 3''*!,""&&s+"PQTPU VW  %Z'!\\77edu8 '3D,,S$v,???MM$CKPTDUCV"WX$$T&\2 3 %)$7$7$=$=$?0LE5!2!23!>LUGT ((/ 0 JJ    w}}  !;g> > JJ   s B(I1 C!I1+I1+I11J c tj|sJ|dvsJtjd|d|d|d|d |jj  |j ||||}|jjt|jdkDrtt|y#|jjwxYw)aCheck, if can modify , otherwise raise HTTP_LOCKED. If modifying is prevented by a lock, DAVError(HTTP_LOCKED) is raised. An embedded DAVErrorCondition contains the conflicting locks. may be modified by , if it is not currently locked directly or indirectly (i.e. by a locked parent). For depth-infinity operations, also must not have locked children. It is not enough to check whether a lock is owned by , but also the token must be passed with the request. Because may run two different applications. See http://www.webdav.org/specs/rfc4918.html#lock-model http://www.webdav.org/specs/rfc4918.html#rfc.section.7.4 TODO: verify assumptions: - Parent locks WILL NOT be conflicting, if they are depth-0. - Exclusive child locks WILL be conflicting, even if they are owned by . @param url: URL that shall be modified, created, moved, or deleted @param depth: "0"|"infinity" @param token_list: list of lock tokens, that the principal submitted in If: header @param principal: name of the principal requesting a lock @return: None or raise error r4zcheck_write_permission(rrOrrwN) rr:r\rrCrrzrrr{r|rr)rGrsr(rtr&r}s rcheck_write_permissionz"LockManager.check_write_permissions8{{3)))) %cU"UG2j\I;a P  ! !//UJ RG JJ    w}}  !;g> > JJ   s B33Cctt}|}|r|j|}tj d||D]v}tj dt |||k7r |ddk7r2||dk(r|d|vrBtj dt ||j |dxtj|}|r|dk(rv|jj|d d d } | D]R}tj||dsJtj d t ||j |dT|S) zReturn a DAVErrorCondition listing locks that conflict with a write to . Caller must hold self._lock (read or write). z checking z lock=r(r6r&r"rr%FTrTr) rr rr\rr-rrrrDrAr) rGrsr(rtr&r}rrrrs rrzz LockManager._get_write_conflictssg $$BC ..q1I MMKs+ ,! 3 ;t+<*=>?8W  ;${"33W 8SMM:;t;L:MN$$T&\2 3##A&A#& J 33%$54J# /((d6l;;; ? D@Q?RST  f.  / r))rQ __module__ __qualname____doc__rhrHrLrRrfrnrur~rrrrrrrrrrrrrrqrrzrrrr?r?ys #! >X2&P!<MP!, !EH - -)-< &*0#B38 <@2! D ;@!eN,\)rr?)rrr contextlibrpprintrwsgidavrwsgidav.dav_errorrrrr wsgidav.rw_lockr __docformat__get_module_loggerr\rrr r-r=r?rrrrsi D % *" $ !3 4H0 . *$IIr