0]j"ddlZddlmZmZddlmZddlmZddlm Z ddl m Z ddl m Z ddlmZmZmZmZmZGd d eZGd d ZGd deeZy)N)ABCabstractmethod)Optional)warn)reverse)NoReverseMatch)settings)get_failure_limit is_client_ip_address_blacklisted is_client_ip_address_whitelistedis_client_method_whitelistedis_user_attempt_whitelistedcjeZdZdZed defdZedZedZed de ede fdZ y) AbstractAxesHandlerz3 Contract that all handlers need to follow N credentialsc td)zm Handles the Django ``django.contrib.auth.signals.user_login_failed`` authentication signal. z'user_login_failed should be implementedNotImplementedErrorselfsenderrrequestkwargss I/var/www/zogu/zoguvenv/lib/python3.12/site-packages/axes/handlers/base.pyuser_login_failedz%AbstractAxesHandler.user_login_faileds ""KLLc td)zj Handles the Django ``django.contrib.auth.signals.user_logged_in`` authentication signal. z$user_logged_in should be implementedrrrruserrs ruser_logged_inz"AbstractAxesHandler.user_logged_ins ""HIIrc td)zk Handles the Django ``django.contrib.auth.signals.user_logged_out`` authentication signal. z%user_logged_out should be implementedrrs ruser_logged_outz#AbstractAxesHandler.user_logged_out&s ""IJJrreturnctd)a Checks the number of failures associated to the given request and credentials. This is a virtual method that needs an implementation in the handler subclass if the ``settings.AXES_LOCK_OUT_AT_FAILURE`` flag is set to ``True``. z"get_failures should be implementedrrrrs r get_failuresz AbstractAxesHandler.get_failures-s""FGGrN) __name__ __module__ __qualname____doc__rdictrr r"rintr&rrrrs{MTMM JJ KK H$H3HHrrc eZdZdZddeedefdZddeedefdZddeedefdZ ddeedefdZ dee fd Z defd Z defd Zddd d dee dee dedefdZdddeedefdZdddeedefdZddde deedefdZy)AxesBaseHandlera Handler API definition for implementations that are used by the ``AxesProxyHandler``. If you wish to specialize your own handler class, override the necessary methods and configure the class for use by setting ``settings.AXES_HANDLER = 'module.path.to.YourClass'``. Make sure that new the handler is compliant with AbstractAxesHandler and make sure it extends from this mixin. Refer to `AxesHandler` for an example. The default implementation that is actually used by Axes is ``axes.handlers.database.AxesDatabaseHandler``. .. note:: This is a virtual class and **can not be used without specialization**. Nrr#ctjr|j|sy|j||ry|j ||ry|j ||ryy)aF Checks if the user is allowed to access or use given functionality such as a login view or authentication. This method is abstract and other backends can specialize it as needed, but the default implementation checks if the user has attempted to authenticate into the site too many times through the Django authentication backends and returns ``False`` if user exceeds the configured Axes thresholds. This checker can implement arbitrary checks such as IP whitelisting or blacklisting, request frequency checking, failed attempt monitoring or similar functions. Please refer to the ``axes.handlers.database.AxesDatabaseHandler`` for the default implementation and inspiration on some common checks and access restrictions before writing your own implementation. TF)r AXES_ONLY_ADMIN_SITEis_admin_requestis_blacklistedis_whitelisted is_lockedr%s r is_allowedzAxesBaseHandler.is_allowedFsW  ( (1F1Fw1O   w 4   w 4 >>'; /rct|ryy)zY Checks if the request or given credentials are blacklisted from access. TF)r r%s rr4zAxesBaseHandler.is_blacklistedcs ,G 4rcNt||ryt|ryt|ryy)zX Checks if the request or given credentials are whitelisted for access. TF)rr r r%s rr5zAxesBaseHandler.is_whitelistedms* 'w < +G 4 ' 0rcbtjr|j||t||k\Sy)zH Checks if the request or given credentials are locked. F)r AXES_LOCK_OUT_AT_FAILUREr&r r%s rr6zAxesBaseHandler.is_locked}s9  , ,$$"7K89 9rc8 tdS#t$rYywxYw)zE Returns admin url if exists, otherwise returns None admin:indexN)rr)rs r get_admin_urlzAxesBaseHandler.get_admin_urls$ =) )  s ct|dr;|j}|duxr%tjd||jduSy)z> Checks that request located under admin site pathN^F)hasattrr>rematchr@rr admin_urls rr3z AxesBaseHandler.is_admin_requestsQ 7F #**,I%HHHq _gll;4G  rctdttjr     ( (WWf-E #M2 xx!I;>> > "  s A A*)A*F) ip_addressusernameip_or_usernamerJrKrLcy)aZ Resets access attempts that match the given IP address or username. This method makes more sense for the DB backend, but as it is used by the ProxyHandler (via inherent), it needs to be defined here, so we get compliant with all proxy methods. Please overwrite it on each specialized handler as needed. rr.)rrJrKrLs rreset_attemptszAxesBaseHandler.reset_attemptssr)age_daysrOcy)aS Resets access logs that are older than given number of days. This method makes more sense for the DB backend, but as it is used by the ProxyHandler (via inherent), it needs to be defined here, so we get compliant with all proxy methods. Please overwrite it on each specialized handler as needed. rr.rrOs r reset_logszAxesBaseHandler.reset_logsrcy)a[ Resets access failure logs that are older than given number of days. This method makes more sense for the DB backend, but as it is used by the ProxyHandler (via inherent), it needs to be defined here, so we get compliant with all proxy methods. Please overwrite it on each specialized handler as needed. rr.rQs rreset_failure_logsz"AxesBaseHandler.reset_failure_logsrSr)limitrVcy)ayRemove access failure logs that are over AXES_ACCESS_FAILURE_LOG_PER_USER_LIMIT for user username. This method makes more sense for the DB backend, but as it is used by the ProxyHandler (via inherent), it needs to be defined here, so we get compliant with all proxy methods. Please overwrite it on each specialized handler as needed. rr.)rrKrVs r remove_out_of_limit_failure_logsz0AxesBaseHandler.remove_out_of_limit_failure_logssrr')r(r)r*r+rr,boolr7r4r5r6strr>r3rIr-rNrRrUrXr.rrr0r08s* x~:8D>T8D>T htn  x} 4 2%)"&$ SM3-    "7; hsm s ?C hsm s 8<  '/}   rr0cBeZdZdZd defdZdZdZd deede fdZ y) AxesHandlerzI Signal bare handler implementation without any storage backend. Nrc yr'r.rs rrzAxesHandler.user_login_failed rc yr'r.rs rr zAxesHandler.user_logged_inr^rc yr'r.rs rr"zAxesHandler.user_logged_outr^rr#cy)Nrr.r%s rr&zAxesHandler.get_failuressrr') r(r)r*r+r,rr r"rr-r&r.rrr\r\s4 T   $3rr\)rCabcrrtypingrwarningsr django.urlsrdjango.urls.exceptionsr axes.confr axes.helpersr r r r rrr0r\r.rrrisO #1"H#"HJqqh%r