U n5{iè\ã@sœdZddlZddlmZddlmZddlmZmZddl m Z m Z m Z ddl mZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlmZmZddlmZddl m!Z!m"Z"ddl#m$Z$ddl%m&Z&m'Z'm(Z(ddl)m*Z*ddl+m,Z,ddl-m.Z.dd„Z/Gdd„dƒZ0Gdd„dƒZ1Gdd„de1e0ej2ƒZ3Gdd„de1ej2ƒZ4Gd d!„d!e1ej2ƒZ5eej6ƒGd"d#„d#ƒZ7Gd$d%„d%ej2ƒZ8dS)&z! Tests for L{twisted.web._auth}. éN)Ú implementer)Ú verifyObject)ÚerrorÚportal)Ú ANONYMOUSÚAllowAnonymousAccessÚ'InMemoryUsernamePasswordDatabaseDontUse)ÚIUsernamePassword)Ú IPv4Address)ÚConnectionDone)ÚEventLoggingObserver)ÚglobalLogPublisher)ÚFailure)Úunittest)ÚbasicÚdigest)ÚBasicCredentialFactory)ÚHTTPAuthSessionWrapperÚUnauthorizedResource)ÚICredentialFactory)Ú IResourceÚResourceÚgetChildForRequest©Ú NOT_DONE_YET)ÚData)Ú DummyRequestcCst |¡ ¡S©N)Úbase64Ú b64encodeÚstrip)Ús©r"úB/tmp/pip-unpacked-wheel-mnhg7r0q/twisted/web/test/test_httpauth.pyr%src@sJeZdZdZdd„Zddd„Zdd „Zd d „Zd d „Zdd„Z dd„Z dS)ÚBasicAuthTestsMixinz½ L{TestCase} mixin class which defines a number of tests for L{basic.BasicCredentialFactory}. Because this mixin defines C{setUp}, it must be inherited before L{TestCase}. cCs.| ¡|_d|_d|_d|_t |j¡|_dS)NsfoosdreidsS3CuR1Ty)Ú makeRequestÚrequestÚrealmÚusernameÚpasswordrrÚcredentialFactory©Úselfr"r"r#ÚsetUp0s  zBasicAuthTestsMixin.setUpóGETNcCst|j›dƒ‚dS)zª Create a request object to be passed to L{basic.BasicCredentialFactory.decode} along with a response value. Override this in a subclass. z did not implement makeRequestN)ÚNotImplementedErrorÚ __class__)r,ÚmethodÚ clientAddressr"r"r#r%7szBasicAuthTestsMixin.makeRequestcCs| tt|jƒ¡dS)zM L{BasicCredentialFactory} implements L{ICredentialFactory}. N©Ú assertTruerrr*r+r"r"r#Útest_interface?sz"BasicAuthTestsMixin.test_interfacecCsdtd |jd|jg¡ƒ}|j ||j¡}| t  |¡¡| |  |j¡¡|  |  |jd¡¡dS)zÔ L{basic.BasicCredentialFactory.decode} turns a base64-encoded response into a L{UsernamePassword} object with a password which reflects the one which was encoded in the response. óó:swrongN) rÚjoinr(r)r*Údecoder&r4r Z providedByÚ checkPasswordZ assertFalse©r,ÚresponseÚcredsr"r"r#Útest_usernamePasswordEs z)BasicAuthTestsMixin.test_usernamePasswordcCsXtd |jd|jg¡ƒ}| d¡}|j ||j¡}| t t |ƒ¡| |  |j¡¡dS)zz L{basic.BasicCredentialFactory.decode} decodes a base64-encoded response with incorrect padding. r6r7ó=N) rr8r(r)r r*r9r&r4rr r:r;r"r"r#Útest_incorrectPaddingRs  z)BasicAuthTestsMixin.test_incorrectPaddingcCs"d}| tj|jj|| ¡¡dS)zˆ L{basic.BasicCredentialFactory.decode} raises L{LoginFailed} if passed a response which is not base64-encoded. óxN)Ú assertRaisesrÚ LoginFailedr*r9r%©r,r<r"r"r#Útest_invalidEncoding^süz(BasicAuthTestsMixin.test_invalidEncodingcCs&tdƒ}| tj|jj|| ¡¡dS)z• L{basic.BasicCredentialFactory.decode} raises L{LoginFailed} when passed a response which is not valid base64-encoded text. s123abc+/N)rrBrrCr*r9r%rDr"r"r#Útest_invalidCredentialsksüz+BasicAuthTestsMixin.test_invalidCredentials)r.N) Ú__name__Ú __module__Ú __qualname__Ú__doc__r-r%r5r>r@rErFr"r"r"r#r$)s    r$c@seZdZddd„ZdS)Ú RequestMixinr.NcCs,|dkrtdddƒ}tdƒ}||_||_|S)zo Create a L{DummyRequest} (change me to create a L{twisted.web.http.Request} instead). NÚTCPÚ localhostiÒó/)r rr1Úclient)r,r1r2r&r"r"r#r%zs  zRequestMixin.makeRequest)r.N)rGrHrIr%r"r"r"r#rKysrKc@seZdZdZdS)ÚBasicAuthTestszK Basic authentication tests which use L{twisted.web.http.Request}. N)rGrHrIrJr"r"r"r#rP‡srPc@s8eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd S) ÚDigestAuthTestszL Digest authentication tests which use L{twisted.web.http.Request}. cCs,d|_d|_t |j|j¡|_| ¡|_dS)z> Create a DigestCredentialFactory for testing ó test realmómd5N)r'Ú algorithmrÚDigestCredentialFactoryr*r%r&r+r"r"r#r-’sÿzDigestAuthTests.setUpcsnd‰d‰dg‰tƒ‰‡‡‡‡‡fdd„}ˆ ˆjjd|¡ˆ ˆtdˆdƒ¡}ˆj ˆ|¡ˆ ˆd ¡d S) zÅ L{digest.DigestCredentialFactory.decode} calls the C{decode} method on L{twisted.cred.digest.DigestCredentialFactory} with the HTTP method and host of the request. s 169.254.0.1r.Fcs0ˆ ˆ|¡ˆ ˆ|¡ˆ ˆ|¡dˆd<dS)NTr)Ú assertEqual)Ú _responseÚ_methodZ_host©ÚdoneÚhostr1r<r,r"r#Úcheck¨s   z*DigestAuthTests.test_decode..checkr9rLéQrN)ÚobjectÚpatchr*rr%r r9r4)r,r\Úreqr"rYr#Ú test_decodeszDigestAuthTests.test_decodecCs| tt|jƒ¡dS)zN L{DigestCredentialFactory} implements L{ICredentialFactory}. Nr3r+r"r"r#r5³szDigestAuthTests.test_interfacecCst|j |j¡}| |dd¡| |dd¡| |dd¡| d|¡| d|¡| ¡D]}| d |¡q^d S) ah The challenge issued by L{DigestCredentialFactory.getChallenge} must include C{'qop'}, C{'realm'}, C{'algorithm'}, C{'nonce'}, and C{'opaque'} keys. The values for the C{'realm'} and C{'algorithm'} keys must match the values supplied to the factory's initializer. None of the values may have newlines in them. Úqopóauthr'rRrTrSÚnonceÚopaqueó N)r*Ú getChallenger&rVÚassertInÚvaluesZ assertNotIn)r,Ú challengeÚvr"r"r#Útest_getChallenge¹s   z!DigestAuthTests.test_getChallengecCsd| dd¡}|j |¡}| |dd¡| |dd¡| |dd¡| d |¡| d |¡dS) z  L{DigestCredentialFactory.getChallenge} can issue a challenge even if the L{Request} it is passed returns L{None} from C{getClientIP}. r.Nrbrcr'rRrTrSrdre)r%r*rgrVrh)r,r&rjr"r"r#Ú test_getChallengeWithoutClientIPÊs   z0DigestAuthTests.test_getChallengeWithoutClientIPN) rGrHrIrJr-rar5rlrmr"r"r"r#rQs  rQc@s@eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dS)ÚUnauthorizedResourceTestsz, Tests for L{UnauthorizedResource}. cCs4tgƒ}| | dd¡|¡| | dd¡|¡dS)zF An L{UnauthorizedResource} is every child of itself. ZfooNÚbar)rZassertIdenticalZgetChildWithDefault)r,Úresourcer"r"r#Útest_getChildWithDefaultÝsz2UnauthorizedResourceTests.test_getChildWithDefaultcCs@ttdƒgƒ}| |¡| |jd¡| |j d¡dg¡dS)zç Render L{UnauthorizedResource} for the given request object and verify that the response code is I{Unauthorized} and that a I{WWW-Authenticate} header is set in the response containing a challenge. ú example.comé‘ówww-authenticatesbasic realm="example.com"N)rrÚrenderrVÚ responseCodeÚresponseHeadersÚ getRawHeaders)r,r&rpr"r"r#Ú_unauthorizedRenderTestås  þz1UnauthorizedResourceTests._unauthorizedRenderTestcCs*| ¡}| |¡| dd |j¡¡dS)zº L{UnauthorizedResource} renders with a 401 response code and a I{WWW-Authenticate} header and puts a simple unauthorized message into the response body. s Unauthorizedr6N©r%ryrVr8Úwritten©r,r&r"r"r#Ú test_renderós z%UnauthorizedResourceTests.test_rendercCs.|jdd}| |¡| dd |j¡¡dS)z´ The rendering behavior of L{UnauthorizedResource} for a I{HEAD} request is like its handling of a I{GET} request, but no response body is written. sHEAD)r1r6Nrzr|r"r"r#Útest_renderHEADýs  z)UnauthorizedResourceTests.test_renderHEADcCs:ttdƒgƒ}| ¡}| |¡| |j d¡dg¡dS)z¾ The realm value included in the I{WWW-Authenticate} header set in the response when L{UnauthorizedResounrce} is rendered has quotes and backslashes escaped. z example\"foortsbasic realm="example\\\"foo"N)rrr%rurVrwrx)r,rpr&r"r"r#Útest_renderQuotesRealms  þz0UnauthorizedResourceTests.test_renderQuotesRealmcCsPtt dd¡gƒ}| ¡}| |¡|j d¡d}| d|¡| d|¡dS)z¾ The digest value included in the I{WWW-Authenticate} header set in the response when L{UnauthorizedResource} is rendered has quotes and backslashes escaped. rSs example\"foortrsrealm="example\\\"foo"shm="md5N)rrrUr%rurwrxrh)r,rpr&Z authHeaderr"r"r#Útest_renderQuotesDigests ÿ  z1UnauthorizedResourceTests.test_renderQuotesDigestN) rGrHrIrJrqryr}r~rr€r"r"r"r#rnØs  rnc@s(eZdZdZdd„Zdd„Zdd„ZdS) ÚRealmaJ A simple L{IRealm} implementation which gives out L{WebAvatar} for any avatarId. @type loggedIn: C{int} @ivar loggedIn: The number of times C{requestAvatar} has been invoked for L{IResource}. @type loggedOut: C{int} @ivar loggedOut: The number of times the logout callback has been invoked. cCsd|_d|_||_dS)Nr)Ú loggedOutÚloggedInÚ avatarFactory)r,r„r"r"r#Ú__init__5szRealm.__init__cGs2t|kr(|jd7_t| |¡|jfStƒ‚dS©Né)rrƒr„Úlogoutr/)r,ZavatarIdZmindZ interfacesr"r"r#Ú requestAvatar:szRealm.requestAvatarcCs|jd7_dSr†)r‚r+r"r"r#rˆ@sz Realm.logoutN)rGrHrIrJr…r‰rˆr"r"r"r#r(s rc@s¤eZdZdZeZdd„Zdd„Zdd„Zdd „Z d d „Z d d „Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zdd„Zdd„Zdd„Zd d!„Zd"d#„Zd$d%„Zd&S)'ÚHTTPAuthHeaderTestsz. Tests for L{HTTPAuthSessionWrapper}. cCs¨d|_d|_d|_d|_d|_tƒ|_|j |j|j¡t|jdƒ|_ |j   |jt|jdƒ¡|j|j i|_ t |j j ƒ|_t |j|jg¡|_g|_t|j|jƒ|_dS)z\ Create a realm, portal, and L{HTTPAuthSessionWrapper} to use in the tests. sfoo barsbar bazs&contents of the avatar resource itselfs foo-childs'contents of the foo child of the avatarú text/plainN)r(r)Ú avatarContentÚ childNameÚ childContentrÚcheckerZaddUserrÚavatarÚputChildÚavatarsrÚgetr'rZPortalÚcredentialFactoriesrÚwrapperr+r"r"r#r-KszHTTPAuthHeaderTests.setUpcCs2t|jd|jƒ}|j dd|¡t|j|ƒS)z¹ Add an I{basic authorization} header to the given request and then dispatch it, starting from C{self.wrapper} and returning the resulting L{IResource}. r7ó authorizationóBasic )rr(r)ÚrequestHeadersÚ addRawHeaderrr•)r,r&Ú authorizationr"r"r#Ú_authorizedBasicLogin^sz)HTTPAuthHeaderTests._authorizedBasicLogincsHˆ ˆjg¡‰tˆjˆƒ}ˆ ¡}‡‡fdd„}| |¡ˆ |¡|S)z× Resource traversal which encounters an L{HTTPAuthSessionWrapper} results in an L{UnauthorizedResource} instance when the request does not have the required I{Authorization} headers. csˆ ˆjd¡dS©Nrs©rVrv©Úresult©r&r,r"r#Ú cbFinishedrsz@HTTPAuthHeaderTests.test_getChildWithDefault..cbFinished)r%rrr•Ú notifyFinishÚ addCallbackru©r,ÚchildÚdr¡r"r r#rqhs   z,HTTPAuthHeaderTests.test_getChildWithDefaultcsfˆj tdƒ¡ˆ ˆjg¡‰ˆj d|¡tˆjˆƒ}ˆ  ¡}‡‡fdd„}|  |¡ˆ  |¡|S)a( Create a request with the given value as the value of an I{Authorization} header and perform resource traversal with it, starting at C{self.wrapper}. Assert that the result is a 401 response code. Return a L{Deferred} which fires when this is all done. rrr–csˆ ˆjd¡dSrœrržr r"r#r¡†szAHTTPAuthHeaderTests._invalidAuthorizationTest..cbFinished) r”Úappendrr%rr˜r™rr•r¢r£ru)r,r<r¥r¦r¡r"r r#Ú_invalidAuthorizationTestys   z-HTTPAuthHeaderTests._invalidAuthorizationTestcCs| dtdƒ¡S)zÚ Resource traversal which enouncters an L{HTTPAuthSessionWrapper} results in an L{UnauthorizedResource} when the request has an I{Authorization} header with a user which does not exist. r—sfoo:bar)r¨rr+r"r"r#Ú(test_getChildWithDefaultUnauthorizedUserszHTTPAuthHeaderTests.test_getChildWithDefaultUnrecognizedSchemecsVˆj tdƒ¡ˆ ˆjg¡‰ˆ ˆ¡}ˆ ¡}‡‡fdd„}| |¡ˆ |¡|S)zû Resource traversal which encounters an L{HTTPAuthSessionWrapper} results in an L{IResource} which renders the L{IResource} avatar retrieved from the portal when the request has a valid I{Authorization} header. rrcsˆ ˆjˆjg¡dSr)rVr{rŽ©Zignoredr r"r#r¡´szJHTTPAuthHeaderTests.test_getChildWithDefaultAuthorized..cbFinished) r”r§rr%rr›r¢r£rur¤r"r r#Ú"test_getChildWithDefaultAuthorized¨s   z6HTTPAuthHeaderTests.test_getChildWithDefaultAuthorizedcsRˆj tdƒ¡ˆ g¡‰ˆ ˆ¡}ˆ ¡}‡‡fdd„}| |¡ˆ |¡|S)a Resource traversal which terminates at an L{HTTPAuthSessionWrapper} and includes correct authentication headers results in the L{IResource} avatar (not one of its children) retrieved from the portal being rendered. rrcsˆ ˆjˆjg¡dSr)rVr{rŒr¬r r"r#r¡Èsz=HTTPAuthHeaderTests.test_renderAuthorized..cbFinished)r”r§rr%r›r¢r£rur¤r"r r#Útest_renderAuthorized»s    z)HTTPAuthHeaderTests.test_renderAuthorizedcsrttƒGdd„dƒƒ}|ƒ‰ˆj ˆ¡ˆ ˆjg¡‰tˆjˆƒ}ˆ ¡}‡‡‡fdd„}|  |¡ˆ  |¡|S)zº When L{HTTPAuthSessionWrapper} finds an L{ICredentialFactory} to issue a challenge, it calls the C{getChallenge} method with the request as an argument. c@s eZdZdZdd„Zdd„ZdS)zUHTTPAuthHeaderTests.test_getChallengeCalledWithRequest..DumbCredentialFactorysdumbcSs g|_dSr)Úrequestsr+r"r"r#r…Úsz^HTTPAuthHeaderTests.test_getChallengeCalledWithRequest..DumbCredentialFactory.__init__cSs|j |¡iSr)r¯r§r|r"r"r#rgÝs zbHTTPAuthHeaderTests.test_getChallengeCalledWithRequest..DumbCredentialFactory.getChallengeN)rGrHrIÚschemer…rgr"r"r"r#ÚDumbCredentialFactoryÖsr±csˆ ˆjˆg¡dSr)rVr¯r¬©Úfactoryr&r,r"r#r¡çszJHTTPAuthHeaderTests.test_getChallengeCalledWithRequest..cbFinished) rrr”r§r%rrr•r¢r£ru)r,r±r¥r¦r¡r"r²r#Ú"test_getChallengeCalledWithRequestÏs     z6HTTPAuthHeaderTests.test_getChallengeCalledWithRequestcCsh|j tdƒ¡Gdd„dtƒ}|j |j|ƒ¡| |jg¡}| |¡}|  |¡|  |j j d¡|S)a Issue a request for an authentication-protected resource using valid credentials and then return the C{DummyRequest} instance which was used. This is a helper for tests about the behavior of the logout callback. rrc@seZdZdd„ZdS)z7HTTPAuthHeaderTests._logoutTest..SlowerResourcecSstSrrr|r"r"r#ruúsz>HTTPAuthHeaderTests._logoutTest..SlowerResource.renderN)rGrHrIrur"r"r"r#ÚSlowerResourceùsrµr) r”r§rrrr‘rr%r›rurVr'r‚)r,rµr&r¥r"r"r#Ú _logoutTestîs   zHTTPAuthHeaderTests._logoutTestcCs$| ¡}| ¡| |jjd¡dS)zX The realm's logout callback is invoked after the resource is rendered. r‡N)r¶ÚfinishrVr'r‚r|r"r"r#Ú test_logoutszHTTPAuthHeaderTests.test_logoutcCs.| ¡}| ttdƒƒ¡| |jjd¡dS)zª The realm's logout callback is also invoked if there is an error generating the response (for example, if the client disconnects early). zSimulated disconnectr‡N)r¶ZprocessingFailedrr rVr'r‚r|r"r"r#Útest_logoutOnError sz&HTTPAuthHeaderTests.test_logoutOnErrorcCsH|j tdƒ¡| |jg¡}|j dd¡t|j|ƒ}|  |t ¡dS)zã Resource traversal which enouncters an L{HTTPAuthSessionWrapper} results in an L{UnauthorizedResource} when the request has a I{Basic Authorization} header which cannot be decoded using base64. rrr–sBasic decode should failN) r”r§rr%rr˜r™rr•ÚassertIsInstancer)r,r&r¥r"r"r#Útest_decodeRaisessÿ z%HTTPAuthHeaderTests.test_decodeRaisescCsHd}| |j |¡d¡tdƒ}|j |¡| |j |¡|df¡dS)zì L{HTTPAuthSessionWrapper._selectParseHeader} returns a two-tuple giving the L{ICredentialFactory} to use to parse the header and a string containing the portion of the header which remains to be parsed. sBasic abcdef123456)NNrrs abcdef123456N)rVr•Z_selectParseHeaderrr”r§)r,ZbasicAuthorizationr³r"r"r#Útest_selectParseResponse$s ÿ  þz,HTTPAuthHeaderTests.test_selectParseResponsecs¼t |t¡}Gdd„dtƒ‰G‡fdd„dƒ}|j |ƒ¡| |jg¡}|j  dd¡t |j |ƒ}|  |¡|  |jd¡| dt|ƒ¡| |d d jˆ¡|  t| ˆ¡ƒd¡d S) z´ Any unexpected exception raised by the credential factory's C{decode} method results in a 500 response code and causes the exception to be logged. c@s eZdZdS)zKHTTPAuthHeaderTests.test_unexpectedDecodeError..UnexpectedExceptionN©rGrHrIr"r"r"r#ÚUnexpectedException=sr¾cs$eZdZdZdd„Z‡fdd„ZdS)zBHTTPAuthHeaderTests.test_unexpectedDecodeError..BadFactorysbadcSsiSrr")r,rOr"r"r#rgCszOHTTPAuthHeaderTests.test_unexpectedDecodeError..BadFactory.getChallengecs ˆƒ‚dSrr")r,r<r&©r¾r"r#r9FszIHTTPAuthHeaderTests.test_unexpectedDecodeError..BadFactory.decodeN)rGrHrIr°rgr9r"r¿r"r#Ú BadFactory@srÀr–sBad abcéôr‡rÚ log_failureN)r ÚcreateWithCleanupr Ú Exceptionr”r§r%rr˜r™rr•rurVrvÚ assertEqualsÚlenrºÚvalueÚflushLoggedErrors)r,Ú logObserverrÀr&r¥r"r¿r#Útest_unexpectedDecodeError5s    z.HTTPAuthHeaderTests.test_unexpectedDecodeErrorcs¼t |t¡}Gdd„dtƒ‰G‡fdd„dƒ}|j |ƒ¡|j tdƒ¡|  |j g¡}|  |¡}|  |¡|  |jd¡| dt|ƒ¡| |dd jˆ¡|  t| ˆ¡ƒd¡d S) z‰ Any unexpected failure from L{Portal.login} results in a 500 response code and causes the failure to be logged. c@s eZdZdS)zJHTTPAuthHeaderTests.test_unexpectedLoginError..UnexpectedExceptionNr½r"r"r"r#r¾Zsr¾cseZdZefZ‡fdd„ZdS)zDHTTPAuthHeaderTests.test_unexpectedLoginError..BrokenCheckercs ˆƒ‚dSrr")r,Ú credentialsr¿r"r#ÚrequestAvatarId`szTHTTPAuthHeaderTests.test_unexpectedLoginError..BrokenChecker.requestAvatarIdN)rGrHrIr ZcredentialInterfacesrÌr"r¿r"r#Ú BrokenChecker]srÍrrrÁr‡rrÂN)r rÃr rÄrÚregisterCheckerr”r§rr%rr›rurVrvrÅrÆrºrÇrÈ)r,rÉrÍr&r¥r"r¿r#Útest_unexpectedLoginErrorSs   z-HTTPAuthHeaderTests.test_unexpectedLoginErrorcs’d‰tƒˆjt<ˆjt ˆjtˆdƒ¡ˆj tƒ¡ˆj   t dƒ¡ˆ  ˆjg¡‰t ˆjˆƒ}ˆ ¡}‡‡‡fdd„}| |¡ˆ |¡|S)zl Anonymous requests are allowed if a L{Portal} has an anonymous checker registered. s*contents of the unprotected child resourcer‹rrcsˆ ˆjˆg¡dSr)rVr{r¬©r&r,ZunprotectedContentsr"r#r¡sz.cbFinished)rr’rr‘rrrrÎrr”r§rr%rr•r¢r£rur¤r"rÐr#Útest_anonymousAccessms  ÿ   z(HTTPAuthHeaderTests.test_anonymousAccessN)rGrHrIrJrr%r-r›rqr¨r©rªr«r­r®r´r¶r¸r¹r»r¼rÊrÏrÑr"r"r"r#rŠDs(   rŠ)9rJrZzope.interfacerZzope.interface.verifyrZ twisted.credrrZtwisted.cred.checkersrrrZtwisted.cred.credentialsr Ztwisted.internet.addressr Ztwisted.internet.errorr Ztwisted.internet.testingr Ztwisted.loggerr Ztwisted.python.failurerZ twisted.trialrZtwisted.web._authrrZtwisted.web._auth.basicrZtwisted.web._auth.wrapperrrZtwisted.web.iwebrZtwisted.web.resourcerrrZtwisted.web.serverrZtwisted.web.staticrZtwisted.web.test.test_webrrr$rKZTestCaserPrQrnZIRealmrrŠr"r"r"r#Ús:              PKM