mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
Stefan Pratter
5eb925e319
* fix next redirect when using U2F 2FA auth (#1191) * Added self identifier to API * fix migrations hierarchy after merging in previous support branch * campus object Co-authored-by: Stefan Pratter <stefan@20c.com> * fix out of bound error message add city / country to campus view * fix tests * relock poetry * linting * linting * fix docs regen * regen docs * linting * refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future * remove debug message --------- Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
138 lines
3.0 KiB
Markdown
138 lines
3.0 KiB
Markdown
Generated from middleware.py on 2023-02-14 15:33:37.135106
|
|
|
|
# peeringdb_server.middleware
|
|
|
|
Custom django middleware.
|
|
|
|
# Classes
|
|
---
|
|
|
|
## CacheControlMiddleware
|
|
|
|
```
|
|
CacheControlMiddleware(django.utils.deprecation.MiddlewareMixin)
|
|
```
|
|
|
|
Sets the Cache-Control s-maxage header on responses
|
|
|
|
|
|
## CurrentRequestContext
|
|
|
|
```
|
|
CurrentRequestContext(builtins.object)
|
|
```
|
|
|
|
Middleware that sets the current request context.
|
|
|
|
This allows access to the current request from anywhere.
|
|
|
|
|
|
### Methods
|
|
|
|
#### \__call__
|
|
`def __call__(self, request)`
|
|
|
|
Call self as a function.
|
|
|
|
---
|
|
#### \__init__
|
|
`def __init__(self, get_response)`
|
|
|
|
Initialize self. See help(type(self)) for accurate signature.
|
|
|
|
---
|
|
|
|
## HttpResponseUnauthorized
|
|
|
|
```
|
|
HttpResponseUnauthorized(django.http.response.HttpResponse)
|
|
```
|
|
|
|
An HTTP response class with a string as content.
|
|
|
|
This content can be read, appended to, or replaced.
|
|
|
|
|
|
## PDBCommonMiddleware
|
|
|
|
```
|
|
PDBCommonMiddleware(django.middleware.common.CommonMiddleware)
|
|
```
|
|
|
|
"Common" middleware for taking care of some basic operations:
|
|
|
|
- Forbid access to User-Agents in settings.DISALLOWED_USER_AGENTS
|
|
|
|
- URL rewriting: Based on the APPEND_SLASH and PREPEND_WWW settings,
|
|
append missing slashes and/or prepends missing "www."s.
|
|
|
|
- If APPEND_SLASH is set and the initial URL doesn't end with a
|
|
slash, and it is not found in urlpatterns, form a new URL by
|
|
appending a slash at the end. If this new URL is found in
|
|
urlpatterns, return an HTTP redirect to this new URL; otherwise
|
|
process the initial URL as usual.
|
|
|
|
This behavior can be customized by subclassing CommonMiddleware and
|
|
overriding the response_redirect_class attribute.
|
|
|
|
|
|
### Methods
|
|
|
|
#### process_request
|
|
`def process_request(self, request)`
|
|
|
|
Check for denied User-Agents and rewrite the URL based on
|
|
settings.APPEND_SLASH and settings.PREPEND_WWW
|
|
|
|
---
|
|
|
|
## PDBPermissionMiddleware
|
|
|
|
```
|
|
PDBPermissionMiddleware(django.utils.deprecation.MiddlewareMixin)
|
|
```
|
|
|
|
Middleware that checks if the current user has the correct permissions
|
|
to access the requested resource.
|
|
|
|
|
|
### Methods
|
|
|
|
#### get_username_and_password
|
|
`def get_username_and_password(self, http_auth)`
|
|
|
|
Get the username and password from the HTTP auth header.
|
|
|
|
---
|
|
#### response_unauthorized
|
|
`def response_unauthorized(self, request, status=None, message=None)`
|
|
|
|
Return a Unauthorized response.
|
|
|
|
---
|
|
|
|
## PDBSessionMiddleware
|
|
|
|
```
|
|
PDBSessionMiddleware(django.contrib.sessions.middleware.SessionMiddleware)
|
|
```
|
|
|
|
As PeeringDB gets a lot of repeated anonymous requests that do not
|
|
store and re-use session cookies this lead to substantial amount of junk
|
|
django session objects.
|
|
|
|
It was decided in #1205 that new django sessions are only to be established
|
|
On the login and registration processes.
|
|
|
|
|
|
### Methods
|
|
|
|
#### process_response
|
|
`def process_response(self, request, response)`
|
|
|
|
If request.session was modified, or if the configuration is to save the
|
|
session every time, save the changes and set a session cookie or delete
|
|
the session cookie if the session has been emptied.
|
|
|
|
---
|