СДоРаз - lib.py:aw_web_tools

authelia_helper

anonymous@undisclosed.example.com (Anonymous) — Wed, 15 Oct 2025 14:29:09 +0000

09.11.2024 17:09		текущий
Строка 38:		Строка 38:
	\| ''header_email'' \| ''str'' \| ''Remote-Email'' \| Имя заголовка c e-mail пользователя \|		\| ''header_email'' \| ''str'' \| ''Remote-Email'' \| Имя заголовка c e-mail пользователя \|
	\| ''header_name'' \| ''str'' \| ''Remote-Name'' \| Имя заголовка с именем пользователя \|		\| ''header_name'' \| ''str'' \| ''Remote-Name'' \| Имя заголовка с именем пользователя \|
		+	\| ''fake_auth'' \| ''bool'' \| ''False'' \| Включение режима подставной авторизации \|
		+
		+	Режим подставной авторизации, который включается параметром ''fake_auth'', создан для выполнения предварительной разработки приложения в целом (на этапе преальфа). На данном этапе АРМ разработчика может быть не оснащена ПО ''Authelia'', и во избежание дополнительных не контролируемых решений конкретного программиста данной проблемы с возможным появлением уязвимостей, и добавлен этот режим. В данном режиме объект пользователя имеет предопределённое значение:
		+	* ''uname'': ''//__UNK__//''
		+	* ''name'': ''//John Doe//''
		+	* ''email'': ''//devnull@localhost.localdomain//''
		+
		+	Группы в этом режиме не назначаются и являются пустым массивом.

btle_tools

anonymous@undisclosed.example.com (Anonymous) — Sat, 12 Jul 2025 12:17:26 +0000

02.11.2024 20:08		текущий
Строка 16:		Строка 16:
	Получение реального адреса клиента.		Получение реального адреса клиента.

-	Пытается получить адрес клиента из специальной переменной реверс-прокси. В случае неудачи, берёт IP узла, откуда пришёл запрос.	+	Пытается получить адрес клиента из специальной переменной реверс-прокси ''X-Real-IP''. В случае неудачи, берёт IP узла, откуда пришёл запрос.

-	Проверки на установку IP доверенным источником не производится. Поскольку приложения не выставляются наружу без прикрытия ''nginx'', который можно соответственно настроить, это не считается проблемой.	+	Проверки на установку IP доверенным источником не производится. Поскольку приложения не выставляются наружу без прикрытия ''nginx'', который можно соответственно настроить. Это не считается проблемой.

	<code>		<code>
Строка 162:		Строка 162:
	</code>		</code>

-	Возвращает: Строку, которую можно использовать для инициализации [[lib.py:aw_log:api\|объекта лога]]	+	Возвращает: Строку, которую можно использовать для инициализации [[lib.py:aw_log:api\|объекта лога]]. Строка представляет собой:
		+	<code bash>
		+	${USER}[${IP} \| ${REQ_ID} \| ${CONN_ID}] - ${URL}
		+	</code>
		+	Где:
		+	* ''${USER}'' - Переданное имя пользователя или ''_NOUID_'' если ничего передано не было.
		+	* ''${IP}'' - Результат работы функции [[#get_client_ip\|get_client_ip()]].
		+	* ''${REQ_ID}'' - Значение заголовка ''REQ_ID_HEADER'', если он имеется. В противном случае ничего не подставляется и не выводится разделитель.
		+	* ''${CONN_ID}'' - Значение заголовка ''CONN_ID_HEADER'', если он имеется. В противном случае ничего не подставляется и не выводится разделитель.
		+	* ''${URL}'' - Путь переданный в запросе.

cookie

anonymous@undisclosed.example.com (Anonymous) — Sun, 03 Nov 2024 13:43:26 +0000

30.05.2026 07:43	текущий
Строка 1:	Строка 1:
	+	====== Объект Cookie ======

	+	Предоставляет базовые средства работы с cookie.
	+
	+	===== Конструктор =====
	+
	+	<code>
	+	Cookie(name, value, [max_age], [expires], [path], [secure], [httponly], [samesite], [domain])
	+	</code>
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''name'' \| ''str'' \| -- \| Имя cookie \|
	+	\| ''value'' \| ''str'' \| -- \| Значение cookie \|
	+	\| ''max_age'' \| ''int'' \| ''None'' \| Время жизни cookie в секундах \|
	+	\| ''expires'' \| ''int'', ''datetime'' \| ''None'' \| Значение времени, когда cookie будет удалена, задаётся в виде ''unix timestamp (int)'' или ''datetime'' \|
	+	\| ''path'' \| ''str'' \| ''None'' \| Префикс пути поиска ресурса на данном сайте, для которого следует отправлять данное cookie \|
	+	\| ''secure'' \| ''bool'' \| ''True'' \| Отправлять cookie только по шифрованным каналам связи \|
	+	\| ''httponly'' \| ''bool'' \| ''True'' \| Сделать cookie не доступной (почти) для JavaScript \|
	+	\| ''samesite'' \| ''bool'' \| ''False'' \| Не отправлять данную cookie, если запрос пришёл не с того же сайта (анализируется заголовок referer) \|
	+	\| ''domain'' \| ''str'' \| ''None'' \| Имя домена в рамках которого выставляется cookie. В современных браузерах может и вести себя не адекватно \|
	+
	+	Подробнее о параметрах можно почитать, например, [[https://ru.wikipedia.org/wiki/Cookie#Параметры_cookie\|в википедии]].
	+
	+	Следующие параметры, если они заданы в ''None'' просто не выставляются в отправляемом cookie:
	+	* ''max_age''
	+	* ''expires''
	+	* ''path''
	+	* ''domain''
	+
	+
	+	===== to_dict() =====
	+
	+	Преобразует cookie в словарь Python
	+
	+	<code>
	+	obj.to_dict()
	+	</code>
	+
	+	===== response_add() =====
	+
	+	Добавляет данную cookie в заданный ''bottle.Response''
	+
	+	<code>
	+	obj.response_add(resp)
	+	</code>
	+
	+	^ Параметр ^ Тип ^ Описание ^
	+	\| ''resp'' \| ''bottle.BaseResponse'' \| Ответ, в который следует добавить cookie \|
	+
	+
	+	===== response_delete() =====
	+
	+	Оправляет браузеру признак того, что cookie следует удалить.
	+
	+	<code>
	+	obj.response_delete(resp)
	+	</code>
	+
	+	^ Параметр ^ Тип ^ Описание ^
	+	\| ''resp'' \| ''bottle.BaseResponse'' \| Ответ, в который следует добавить данную инструкцию для браузера \|

id_helper

anonymous@undisclosed.example.com (Anonymous) — Sun, 03 Nov 2024 14:50:10 +0000

30.05.2026 07:43	текущий
Строка 1:	Строка 1:
	+	====== Константы ======
	+
	+	^ Имя ^ Значение ^ Описание ^
	+	\| ''SESSION_TIMEOUT'' \| ''86400'' \| Продолжительность сессии пользователя в секундах \|
	+
	+
	+	====== Исключения ======
	+
	+	^ Имя ^ Предок ^ Описание ^
	+	\| ''IDError'' \| ''aw_web_tools.Error'' \| Общий класс ошибок идентификации \|
	+	\| ''IDCheckError'' \| ''IDError'' \| Ошибка проверки ID \|
	+	\| ''IDNotFound'' \| ''IDCheckError'' \| Запрос не идентифицирован \|
	+	\| ''UIDError'' \| ''IDError'' \| Ошибки при работе с классом пользовательского идентификатора \|
	+
	+
	+	====== Классы объектов ======
	+
	+	===== UID =====
	+
	+	Класс пользовательского идентификатора.
	+
	+	Обеспечивает хранение идентификационной информации о пользователе.
	+
	+	==== Свойства объекта ====
	+
	+	^ Свойство ^ Описание ^
	+	\| ''name'' \| Имя пользователя \|
	+	\| ''level'' \| Заданный пользователю уровень допуска \|
	+	\| ''sess_id'' \| Заданный ID сессии работы с системой \|
	+
	+
	+	==== Конструктор ====
	+
	+	<code>
	+	UID(uname, [acc_level], [sess_id], [acc_tags], [user_meta])
	+	</code>
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''uname'' \| ''str'' \| -- \| Имя пользователя внутри системы \|
	+	\| ''acc_level'' \| ''int'' \| ''-1'' \| Уровень допуска пользователя. Интерпретация целиком на стороне приложения. \|
	+	\| ''sess_id'' \| ''str'' \| ''None'' \| Идентификатор сессии пользователя \|
	+	\| ''acc_tags'' \| ''Iterable[str]'' \| ''None'' \| Строковые константы, определяющие конкретное множество доступных пользователю ресурсов. Интерпретация целиком на стороне приложения. \|
	+	\| ''user_meta'' \| ''Dict[str, str]'' \| ''None'' \| Иная полезная приложению информация, сохранённая в виде тег-значение \|
	+
	+
	+	==== Преобразование в строку ====
	+
	+	При вызове
	+	<code>
	+	str(obj)
	+	</code>
	+	Значением будет имя пользователя.
	+
	+
	+	==== get_access() ====
	+
	+	Получить теги доступа, заданные параметром ''acc_tags'' конструктора.
	+	<code>
	+	obj.get_access()
	+	</code>
	+
	+	Возвращает: Список тегов доступа либо пустой список, если их не заданно.
	+
	+
	+	==== get_meta() ====
	+
	+	Получить словарь метаинформации о пользователе, заданной параметром ''user_meta'' конструктора.
	+	<code>
	+	obj.get_meta()
	+	</code>
	+
	+	Возвращает: Словарь с мета-информацией либо пустой словарь, если она не заданна.
	+
	+
	+	==== to_dict() ====
	+
	+	Создаёт словарь на основе объекта. Словарь получается следующей структуры:
	+	<code yaml>
	+	n: obj.name,
	+	id: obj.sess_id
	+	al: obj.level
	+	a: obj.get_access()
	+	m: obj.get_meta()
	+	</code>
	+
	+
	+	===== IDHelper =====
	+
	+	Класс поддержки идентификации. Может выступать в качестве плагина ''bottle'', а также декорировать методы обработки url данного фреймворка.
	+
	+
	+	==== Конструктор ====
	+
	+	<code>
	+	IDHelper(app_name, sign_secret, [sess_timeout])
	+	</code>
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''app_name'' \| ''str'' \| -- \| Имя приложения. Допускаются цифры символы латиницы и знак ''-'', остальное запрещено \|
	+	\| ''sign_secret'' \| ''str'' \| -- \| Ключ подпись JWT для построения cookie \|
	+	\| ''sess_timeout'' \| ''int'' \| ''SESSION_TIMEOUT'' \| Время жизни сессии пользователя \|
	+
	+
	+	==== make_cookie() ====
	+
	+	Формирует объект ''Cookie'' для идентификации сессии пользователя.
	+
	+	<code>
	+	obj.make_cookie([uid], [request], [is_secure], [is_httponly])
	+	</code>
	+
	+	Возвращает: Объект [[.:cookie#Cookie]], на основе данного [[#UID]].
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''uid'' \| ''UID'' \| ''None'' \| [[#UID]] на основе которого формируется cookie. Если не задано (''None'') берётся из контекста запроса \|
	+	\| ''request'' \| ''bottle.BaseRequest'' \| ''bottle.request'' \| Экземпляр запроса, на основании которого формируется ответ. \|
	+	\| ''is_secure'' \| ''bool'' \| ''True'' \| Установить признак ''secure'' на cookie \|
	+	\| ''is_httponly'' \| ''bool'' \| ''True'' \| Установить признак ''httponly'' на cookie \|
	+
	+	Имя cookie при этом имеет вид:
	+	<code bash>
	+	X-ID-${obj.app_name}
	+	</code>
	+	То есть строится на основе имени приложения, заданного при создании объекта
	+
	+
	+	==== set_id() ====
	+
	+	Установка cookie на ответ пользователю
	+
	+	<code>
	+	obj.set_id([uid], [response], [request], [is_secure], [is_httponly])
	+	</code>
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''uid'' \| ''UID'' \| ''None'' \| [[#UID]] на основе которого формируется cookie. Если не задано (''None'') берётся из контекста запроса \|
	+	\| ''response'' \| ''bottle.BaseResponse'' \| ''bottle.response'' \| Объект ответа, на который устанавливаем cookie. \|
	+	\| ''request'' \| ''bottle.BaseRequest'' \| ''bottle.request'' \| Экземпляр запроса, на основании которого формируется ответ. \|
	+	\| ''is_secure'' \| ''bool'' \| ''True'' \| Установить признак ''secure'' на cookie \|
	+	\| ''is_httponly'' \| ''bool'' \| ''True'' \| Установить признак ''httponly'' на cookie \|
	+
	+
	+	==== env_id() ====
	+
	+	Получаем ID из контекста запроса (для случая, когда проверка и валидация ID проведена на уровне плагина или декоратора
	+
	+	Метод статический
	+
	+	<code>
	+	IDHelper.env_id([request])
	+	</code>
	+
	+	Возвращает: Объект [[#UID]], связанный с данным запросом, или возбуждает ''IDNotFound'', если он не задан.
	+
	+	^ Параметр ^ Тип ^ По умолчанию ^ Описание ^
	+	\| ''request'' \| ''bottle.BaseRequest'' \| ''bottle.request'' \| Экземпляр обрабатываемого запроса. \|
	+
	+
	+	==== need_id() ====
	+
	+	Декоратор для проверки UID для заданного пути в приложении.
	+	<code python>
	+
	+	app = bottle.Bottle()
	+
	+	id_helper = IDHelper('some_name', 'some Very $ecr3t K3y')
	+
	+	@id_helper.need_id
	+	@app.get('/resource'):
	+	pass
	+	</code>
	+
	+
	+

jwt

anonymous@undisclosed.example.com (Anonymous) — Sun, 03 Nov 2024 15:23:16 +0000

03.11.2024 18:22		текущий
Строка 62:		Строка 62:

	Возвращает: Фабрику для получения объектов ''JWTHelper'' с данным ключём.		Возвращает: Фабрику для получения объектов ''JWTHelper'' с данным ключём.
		+
		+	^ Параметр ^ Тип ^ Описание ^
		+	\| ''key'' \| ''str'' \| Ключ подписи токена \|

	<code python>		<code python>

misc_tools

anonymous@undisclosed.example.com (Anonymous) — Sun, 03 Nov 2024 14:54:34 +0000

30.05.2026 07:43	текущий
Строка 1:	Строка 1:
	+	====== dict_filter() ======

	+	Создать новый словарь на основе существующего, добавив в него только нужные ключи
	+
	+	<code>
	+	dict_filter(data, need_keys)
	+	</code>
	+
	+	Возвращает: Новый словарь, в котором остались только заданные ключи
	+
	+	^ Параметр ^ Тип ^ Описание ^
	+	\| ''data'' \| ''dict'' \| Исходный словарь \|
	+	\| ''need_keys'' \| ''List[str]'', ''Tuple[str]'' \| Ключи, которые следует оставить \|

root

anonymous@undisclosed.example.com (Anonymous) — Sun, 02 Mar 2025 13:38:39 +0000

02.03.2025 15:03		текущий
Строка 4:		Строка 4:


-	====== Разделы ======	+	====== Подмодули ======

	^ Название ^ Строка импорта ^		^ Название ^ Строка импорта ^

simple_template_helper

anonymous@undisclosed.example.com (Anonymous) — Sat, 12 Jul 2025 09:24:09 +0000

12.07.2025 12:23		текущий
Строка 45:		Строка 45:
	Вместо объекта создаётся фабрика объектов, при каждом вызове которой инициализируется новый объект.		Вместо объекта создаётся фабрика объектов, при каждом вызове которой инициализируется новый объект.

-	Помогает в работе над шаблонами. В частности препятствует кешированию и способствует перечитыванию файла с шаблоном на каждом вызове данного шаблона в коде	+	Помогает в работе над шаблонами. В частности, препятствует кешированию и способствует перечитыванию файла с шаблоном на каждом вызове данного шаблона в коде

	^ Параметр ^ Тип ^ Описание ^		^ Параметр ^ Тип ^ Описание ^

url

anonymous@undisclosed.example.com (Anonymous) — Sun, 03 Nov 2024 15:01:04 +0000

03.11.2024 18:00		текущий
Строка 4:		Строка 4:
	</code>		</code>

-	принимают и возвращают строку, выполнив соответствующую функцию.	+	принимают и возвращают строку, выполнив соответствующее преобразование.

	Список функций:		Список функций: