File size: 3,868 Bytes
26e6f31 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | from __future__ import annotations
from enum import Enum
from io import StringIO
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from datetime import datetime
class SameSite(Enum):
"""
SameSite allows a server to define a cookie attribute making it impossible for
the browser to send this cookie along with cross-site requests. The main
goal is to mitigate the risk of cross-origin information leakage, and provide
some protection against cross-site request forgery attacks.
See https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00 for details.
"""
DEFAULT_MODE = ""
LAX_MODE = "Lax"
STRICT_MODE = "Strict"
NONE_MODE = "None"
def _format_date(timestamp: datetime) -> str:
# Specification example: Wed, 21 Oct 2015 07:28:00 GMT
return timestamp.strftime("%a, %d %b %Y %H:%M:%S GMT")
class Cookie:
"""
A Cookie represents an HTTP cookie as sent in the Set-Cookie header of an
HTTP response or the Cookie header of an HTTP request.
See https://tools.ietf.org/html/rfc6265 for details.
"""
def __init__(
self,
name: str,
value: str,
path: str = "",
domain: str = "",
secure: bool = True,
http_only: bool = False,
max_age: int | None = None,
expires: datetime | None = None,
same_site: SameSite | None = None,
custom_attributes: list[str] | None = None,
):
"""
Parameters
----------
name: str
The name of this cookie, for example session_id
value: str
The cookie value, for instance an uuid
path: str
The path for which this cookie is valid. Optional
domain: str
The domain for which this cookie is valid. Optional
secure: bool
Marks the cookie as secure, only sendable to the server with an encrypted request over the HTTPS protocol
http_only: bool
Enabling this attribute makes the cookie inaccessible to the JavaScript `Document.cookie` API
max_age: int | None
Defines the period of time after which the cookie is invalid. Use negative values to force cookie deletion.
expires: datetime | None
Defines a date where the permanent cookie expires.
same_site: SameSite | None
Determines if the cookie should be sent to third party websites
custom_attributes: list[str] | None
List of additional custom attributes to set on the cookie
"""
self.name = name
self.value = value
self.path = path
self.domain = domain
self.secure = secure
self.expires = expires
self.max_age = max_age
self.http_only = http_only
self.same_site = same_site
self.custom_attributes = custom_attributes
def __str__(self) -> str:
payload = StringIO()
payload.write(f"{self.name}={self.value}")
if self.path:
payload.write(f"; Path={self.path}")
if self.domain:
payload.write(f"; Domain={self.domain}")
if self.expires:
payload.write(f"; Expires={_format_date(self.expires)}")
if self.max_age:
if self.max_age > 0:
payload.write(f"; Max-Age={self.max_age}")
else:
# negative or zero max-age should be set to 0
payload.write("; Max-Age=0")
if self.http_only:
payload.write("; HttpOnly")
if self.secure:
payload.write("; Secure")
if self.same_site:
payload.write(f"; SameSite={self.same_site.value}")
if self.custom_attributes:
for attr in self.custom_attributes:
payload.write(f"; {attr}")
return payload.getvalue()
|