Package: aiohttp-csrf-fixed
The library provides csrf (xsrf) protection foraiohttp.web.Basic usageThe library allows you to implement csrf (xsrf) protection for requestsBasic usage example:importaiohttp_csrffromaiohttpimportwebFORM_FIELD_NAME='_csrf_token'COOKIE_NAME='csrf_token'defmake_app():csrf_policy=aiohttp_csrf.policy.FormPolicy(FORM_FIELD_NAME)csrf_storage=aiohttp_csrf.storage.CookieStorage(COOKIE_NAME)app=web.Application()aiohttp_csrf.setup(app,policy=csrf_policy,storage=csrf_storage)app.middlewares.append(aiohttp_csrf.csrf_middleware)asyncdefhandler_get_form_with_token(request):token=awaitaiohttp_csrf.generate_token(request)body='''
            <html>
                <head><title>Form with csrf protection</title></head>
                <body>
                    <form method="POST" action="/">
                        <input type="hidden" name="{field_name}" value="{token}" />
                        <input type="text" name="name" />
                        <input type="submit" value="Say hello">
                    </form>
                </body>
            </html>
        '''# noqabody=body.format(field_name=FORM_FIELD_NAME,token=token)returnweb.Response(body=body.encode('utf-8'),content_type='text/html',)asyncdefhandler_post_check(request):post=awaitrequest.post()body='Hello,{name}'.format(name=post['name'])returnweb.Response(body=body.encode('utf-8'),content_type='text/html',)app.router.add_route('GET','/',handler_get_form_with_token,)app.router.add_route('POST','/',handler_post_check,)returnappweb.run_app(make_app())InitializeFirst of all, you need to initializeaiohttp_csrfin your application:app=web.Application()csrf_policy=aiohttp_csrf.policy.FormPolicy(FORM_FIELD_NAME)csrf_storage=aiohttp_csrf.storage.CookieStorage(COOKIE_NAME)aiohttp_csrf.setup(app,policy=csrf_policy,storage=csrf_storage)Middleware and decoratorsAfter initialize you can use@aiohttp_csrf.csrf_protectfor handlers, that you want to protect.
Or you can initializeaiohttp_csrf.csrf_middlewareand do not disturb about using decorator (full middleware example here):...app.middlewares.append(aiohttp_csrf.csrf_middleware)...In this case all your handlers will be protected.Note:we strongly recommend to useaiohttp_csrf.csrf_middlewareand@aiohttp_csrf.csrf_exemptinstead of manually managing with@aiohttp_csrf.csrf_protect.
But if you prefer to use@aiohttp_csrf.csrf_protect, don’t forget to use@aiohttp_csrf.csrf_protectfor both methods: GET and POST
(manual protection example)If you want to use middleware, but need handlers without protection, you can use@aiohttp_csrf.csrf_exempt.
Mark you handler with this decorator and this handler will not check the token:@aiohttp_csrf.csrf_exemptasyncdefhandler_post_not_check(request):...Generate tokenFor generate token you need to callaiohttp_csrf.generate_tokenin your handler:@aiohttp_csrf.csrf_protectasyncdefhandler_get(request):token=awaitaiohttp_csrf.generate_token(request)...Advanced usagePoliciesYou can use different policies for check tokens. Library provides 3 types of policy:FormPolicy. This policy will search token in the body of your POST request (Usually use for forms) or as a GET variable of the same name. You need to specify name of field that will be checked.HeaderPolicy. This policy will search token in headers of your POST request (Usually use for AJAX requests). You need to specify name of header that will be checked.FormAndHeaderPolicy. This policy combines behavior ofFormPolicyandHeaderPolicy.You can implement your custom policies if needed. But make sure that your custom policy implementsaiohttp_csrf.policy.AbstractPolicyinterface.StoragesYou can use different types of storages for storing token. Library provides 2 types of storage:CookieStorage. Your token will be stored in cookie variable. You need to specify cookie name.SessionStorage. Your token will be stored in session. You need to specify session variable name.Important:If you want to use session storage, you need setup aiohttp_session in your application
(session storage example)You can implement your custom storages if needed. But make sure that your custom storage implementsaiohttp_csrf.storage.AbstractStorageinterface.Token generatorsYou can use different token generator in your application.
By default storages usingaiohttp_csrf.token_generator.SimpleTokenGeneratorBut if you need more secure token generator - you can useaiohttp_csrf.token_generator.HashedTokenGeneratorAnd you can implement your custom token generators if needed. But make sure that your custom token generator implementsaiohttp_csrf.token_generator.AbstractTokenGeneratorinterface.Invalid token behaviorBy default, if token is invalid,aiohttp_csrfwill raiseaiohttp.web.HTTPForbiddenexception.You have ability to specify your custom error handler. It can be:callable instance. Input parameter - aiohttp request.defcustom_error_handler(request):# do somethingreturnaiohttp.web.Response(status=403)# orasyncdefcustom_async_error_handler(request):# await do somethingreturnaiohttp.web.Response(status=403)It will be called instead of protected handler.sub class of Exception. In this case this Exception will be raised.classCustomException(Exception):passYou can specify custom error handler globally, when initializeaiohttp_csrfin your application:...classCustomException(Exception):pass...aiohttp_csrf.setup(app,policy=csrf_policy,storage=csrf_storage,error_renderer=CustomException)...In this case custom error handler will be applied to all protected handlers.Or you can specify custom error handler locally, for specific handler:...classCustomException(Exception):pass...@aiohttp_csrf.csrf_protect(error_renderer=CustomException)defhandler_with_custom_csrf_error(request):...In this case custom error handler will be applied to this handler only.
For all other handlers will be applied global error handler.