Предоставление пользователям возможности ввода учетных данных для входа — одна из самых распространенных возможностей, добавляемых в веб-приложения. В этой статье мы расскажем, как добавить аутентификацию в ваше приложение Flask с помощью пакета Flask-Login.
Мы построим несколько образцов страниц регистрации и входа, которые позволят пользователям входить в приложение и видеть защищенные страницы, невидимые для пользователей, не выполнивших вход. Мы соберем информацию пользовательской модели и будем выводить ее на наших защищенных страницах при входе пользователя, чтобы смоделировать вид профиля.
В этой статье мы затронем следующие вопросы:
Исходный код этого проекта доступен на GitHub.
Для этого обучающего модуля вам потребуется следующее:
Наше приложение будет использовать шаблон фабрики приложений Flask с готовыми проектами. У нас будет один проект, отвечающий за все связанное с аутентификацией, и еще один проект для обычных маршрутов, включая указатель и страницу защищенного профиля. В реальном приложении функции можно распределять любым удобным образом, однако описанное здесь решение хорошо подходит для этого учебного модуля.
Здесь имеется схема, которая поможет понять, как будет выглядеть структура файлов проекта после завершения прохождения учебного модуля:
.
└── flask_auth_app
└── project
├── __init__.py # setup our app
├── auth.py # the auth routes for our app
├── db.sqlite # our database
├── main.py # the non-auth routes for our app
├── models.py # our user model
└── templates
├── base.html # contains common layout and links
├── index.html # show the home page
├── login.html # show the login form
├── profile.html # show the profile page
└── signup.html # show the signup form
По мере выполнения этого учебного модуля мы будем создавать эти каталоги и файлы.
Для нашего проекта нам потребуется три основных проекта:
Мы будем использовать SQLite, чтобы не устанавливать дополнительные зависимости для базы данных.
Для начала мы создадим каталог проекта:
Затем нам нужно будет перейти в каталог проекта:
Если у нас нет среды Python, нам нужно будет ее создать. В зависимости от способа установки Python на вашем компьютере команды будут выглядеть примерно так:
Примечание. Вы можете использовать учебный модуль по вашей локальной среде для получения информации по настройке venv
.
Выполните в своей виртуальной среде следующие команды для установки необходимых пакетов:
Мы установили пакеты и теперь можем создать основной файл приложения.
Для начала мы создадим каталог проекта
:
В первую очередь мы начнем работать над файлом __init__.py
для нашего проекта:
Этот файл будет содержать функцию создания нашего приложения, которая инициализирует базу данных и зарегистрирует наши проекты. На данный момент мы не увидим изменений, но это потребуется для создания остальных частей приложения. Нам нужно будет инициализировать SQLAlchemy, настроить определенные значения конфигурации и зарегистрировать здесь наши проекты.
Теперь у нас готов основной файл приложения, и мы можем начать добавление маршрутов.
Для наших маршрутов мы будем использовать два проекта. В основном проекте у нас будет главная страница (/
) и страница профиля (/profile
), открываемая после входа. Если пользователь попытается получить доступ к странице профиля без входа в систему, он будет направлен на маршрут входа.
В нашем проекте auth у нас будут маршруты для получения страницы входа (/login
) и страницы регистрации (/sign-up
). Также у нас имеются маршруты для обработки запросов POST от обоих этих маршрутов. Наконец, у нас имеется маршрут выхода (/logout
) для выхода активного пользователя из системы.
Пока что мы определим login
, signup
и logout
простыми возвратами. Мы вернемся к ним немного позднее и обновим их, добавив желаемые функции.
Вначале создайте файл main.py
для main_blueprint
:
Затем создайте файл auth.py
для auth_blueprint
:
В терминале вы можете задать значения FLASK_APP
и FLASK_DEBUG
:
Переменная среды FLASK_APP
сообщает Flask, как загружать приложение. Она должна указывать на место создания create_app
. Для наших целей мы будем использовать указатели на каталог project
.
Переменная среды FLASK_DEBUG
активируется посредством присвоения ей значения 1
. Это активирует отладчик, который будет отображать в браузере ошибки приложения.
Убедитесь, что вы находитесь в каталоге flask_auth_app
и запустите проект:
Теперь у вас должна появиться возможность открыть в браузере пять возможных URL-адресов и увидеть возвращаемый текст, определенный в файлах auth.py
и main.py
.
Например, если открыть адрес localhost:5000/profile
, появится: Profile
:
Мы проверили поведение наших маршрутов и можем перейти к созданию шаблонов.
Давайте продолжим и создадим шаблоны, которые используются в нашем приложении. Это будет первый шаг, прежде чем мы сможем реализовать реальную функцию входа. Наше приложение будет использовать четыре шаблона:
Также у нас будет базовый шаблон, который будет содержать общий код для каждой из страниц. В данном случае базовый шаблон будет содержать ссылки навигации и общий макет страницы. Давайте создадим их сейчас.
Для начала создайте каталог templates
в каталоге project
:
Затем создайте base.html
:
Добавьте следующий код в файл base.html
:
Этот код создаст серию ссылок меню на каждую страницу приложения, а также область, где будет отображаться контент.
Примечание. За кулисами мы используем Bulma для работы со стилями и макетом. Чтобы узнать больше о Bulma, ознакомьтесь с официальной документацией Bulma.
Затем создайте файл templates/index.html
:
Добавьте в созданный файл следующий код, чтобы заполнить страницу содержанием:
Этот код создаст базовую страницу указателя с заголовком и подзаголовком.
Затем создайте страницу templates/login.html
:
Этот код генерирует страницу входа с полями Email и Password. Также имеется поле для отметки запоминания сеанса входа.
Создайте шаблон templates/signup.html
:
Добавьте в файл следующий код, чтобы создать страницу регистрации с полями адреса электронной почты, имени и пароля:
Затем создайте шаблон templates/profile.html
:
Добавьте этот код, чтобы создать простую страницу с закодированным заголовком, welcome Anthony:
Позднее мы добавим код для динамического приветствия пользователя.
После добавления шаблонов мы можем обновить выражения возврата в каждом из маршрутов, чтобы вместо текста возвращались шаблоны.
Обновите файл main.py
, изменив строку импорта и маршруты index
и profile
:
Теперь мы обновим auth.py
, изменив строку импорта и маршруты login
и signup
:
После внесения этих изменений страница регистрации будет следующим образом при переходе в /sign-up
:
Теперь вы должны видеть страницы /
, /login
и /profile
.
Пока что мы оставим /logout
отдельно, потому что эта страница не отображает шаблон.
Наша пользовательская модель отражает, что означает наличие пользователя для нашего приложения. У нас есть поля адреса эл. почты, пароля и имени. В приложении вы можете указать, хотите ли хранить больше информации для каждого пользователя. Вы можете добавлять такие вещи как день рождения, изображение профиля или предпочтения пользователя.
Модели, созданные в Flask-SQLAlchemy, представляются классами, которые преобразуются в таблицу в базе данных. Атрибуты этих классов превратятся в столбцы этих таблиц.
Давайте вместе создадим эту пользовательскую модель:
Этот код создает пользовательскую модель со столбцами id
, email
, password
и name
:
Мы создали пользовательскую модель и теперь можем перейти к настройке базы данных.
Как указано в разделе «Предварительные требования», мы будем использовать базу данных SQLite. Мы можем создать базу данных SQLite самостоятельно, но сейчас используем для этого Flask-SQLAlchemy. Мы уже указали путь к базе данных в файле __init__.py
, так что нам нужно просто указать Flask-SQLAlchemy создать базу данных на Python REPL.
Если вы остановите приложение и откроете Python REPL, мы сможем создать базу данных, используя метод create_all
для объекта db
. Убедитесь, что вы все еще находитесь в виртуальной среде и в каталоге flask_auth_app
.
Примечание. Если вы незнакомы с использованием интерпретатора Python, вы можете проконсультироваться с официальной документацией.
Теперь вы видите файл db.sqlite
в каталоге проекта. В этой базе данных будет наша пользовательская таблица.
Для нашей функции регистрации мы возьмем данные, вводимые пользователем в форму, и добавим их в нашу базу данных. Прежде чем добавить это, нам нужно убедиться, что пользователя еще нет в базе данных. Если его нет, нам нужно хэшировать пароль, прежде чем поместить его в базу данных, потому что мы не хотим хранить пароли в формате обычного текста.
Для начала давайте добавим вторую функцию для обработки данных формы POST. В этой функции мы вначале соберем данные, которые были переданы пользователем.
Создайте функцию и добавьте в ее конец переадресацию. В результате после успешной регистрации пользователь будет переадресован на страницу входа.
Обновите файл auth.py
, изменив строку import и реализовав signup_post
:
Теперь добавим остальной код, необходимый для регистрации пользователя.
Для начала нам нужно будет использовать объект запроса для получения данных формы.
Продолжим обновлять файл auth.py
, добавляя элементы импорта и реализуя signup_post
:
Примечание. Хранение паролей в формате обычного текста считается плохой практикой с точки зрения безопасности. Обычно для защиты паролей нужно использовать сложный алгоритм хэширования и шифрование паролей.
У нас готов метод регистрации, и теперь мы можем создать нового пользователя. Используйте форму для создания пользователя.
Существует два способа проверить регистрацию: использовать инструмент просмотра БД для поиска строки, добавленную в таблицу, или попробовать зарегистрироваться с тем же адресом электронной почты, и если вы получите сообщение об ошибке, это будет означать, что первый адрес электронной почты был сохранен правильно. Используем этот подход.
Мы можем добавить код, чтобы сообщить пользователю, что адрес электронной почты уже существует, а затем отправить пользователя на страницу входа. Вызывая функцию flash
, мы отправим сообщение для следующего запроса, в данном случае это запрос переадресации. На итоговой странице мы получим доступ к этому сообщение в шаблоне.
Вначале мы добавим элемент flash
, выводимый до возврата на страницу регистрации.
Чтобы добавить в шаблон мигающее сообщение, нужно добавить над формой этот код. Так сообщение будет выводиться непосредственно над формой.
Метод входа похож на функцию регистрации тем, что мы берем информацию пользователя и что-то делаем с ней. В данном случае мы сравниваем введенный адрес электронной почты, чтобы проверить его наличие в базе данных. Если он там есть, мы протестируем указанный пользователем пароль, выполнив хэширование введенного пользователем пароля и сравнив его с хэшированным паролем в базе данных. Если оба хэшированных пароля совпадают, мы понимаем, что пользователь ввел правильный пароль.
После успешной проверки пароля мы знаем, что учетные данные пользователя верны, и мы можем разрешить ему вход в систему, используя Flask-Login. Вызывая login_user
, Flask-Login создает сеанс этого пользователя, который сохраняется все время, пока пользователь остается в системе, и позволяет пользователю просматривать защищенные страницы.
Мы можем начать с нового маршрута обработки данных, переданных через метод POST. Мы будем выполнять переадресацию на страницу профиля после успешного входа пользователя:
Теперь нам нужно убедиться, что учетные данные пользователя введены верно:
Добавим в шаблон блок, чтобы пользователь мог видеть мигающее сообщение. Как и в случае с формой регистрации, добавим потенциальное сообщение об ошибке непосредственно над формой:
Теперь мы можем указать, что пользователь успешно выполнил вход, но пользователю пока некуда входить. На этом этапе мы используем Flask-Login для управления сеансами пользователя.
Прежде чем начать, нам потребуется несколько вещей для работы Flask-Login. Для начала добавьте UserMixin
в пользовательскую модель. UserMixin
добавит в модель атрибуты Flask-Login, чтобы Flask-Login мог с ней работать.
Затем нам нужно указать загрузчик пользователя. Загрузчик пользователя сообщает Flask-Login, как найти определенного пользователя по идентификатору, сохраненному в файле cookie сеанса. Мы можем добавить его в функцию create_app
вместе с кодом init
для Flask-Login:
В заключение мы можем добавить функцию login_user
перед переадресацией на страницу профиля для создания сеанса:
С помощью Flask-Login мы можем использовать маршрут /login
. Когда все размещено правильно, вы увидите страницу профиля.
Если ваше имя не Anthony, вы увидите, что ваше имя указано неправильно. Нам нужно, чтобы профиль отображал имя в базе данных. Вначале следует защитить страницу, а затем получить доступ к данным пользователя для получения его имени.
Чтобы защитить страницу при использовании Flask-Login, мы добавим декоратор @login_requried
между маршрутом и функцией. Это не даст пользователю, не выполнившему вход в систему, увидеть этот маршрут. Если пользователь не выполнил вход, он будет переадресован на страницу входа согласно конфигурации Flask-Login.
Используя маршруты с декоратором @login_required
, мы можем использовать объект current_user
внутри функций. Этот объект current_user
представляет пользователя из базы данных, и мы можем получить доступ ко всем атрибутам этого пользователя, используя точечную нотацию. Например, current_user.email
, current_user.password
, current_user.name
и current_user.id
будут возвращать реальные значения, хранящиеся в базе данных для пользователя, который выполнил вход в систему.
Давайте используем имя текущего пользователя и отправим его в шаблон. Затем мы используем это имя и выведем его значение.
Затем в файле profile.html
мы обновим страницу для отображения значения name
:
Когда мы перейдем на страницу профиля, мы увидим, что там отображается имя пользователя.
В заключение мы можем обновить представление выхода из системы. Мы можем вызвать функцию logout_user
в маршруте выхода. Мы используем декоратор @login_required
, потому что не имеет смысла выполнять выход для пользователя, который не выполнил вход.
После выхода и повторной попытки просмотра страницы профиля мы должны увидеть сообщение об ошибке. Это связано с тем, что Flask-Login выводит мигающее сообщение, когда пользователю не разрешен доступ к странице.
В заключение мы поместим в шаблоны выражения if
, чтобы отображать только ссылки, актуальные для пользователя. До входа в систему у пользователя должна быть возможность выполнить вход или зарегистрироваться. После входа у него должна быть возможность перейти в свой профиль или выйти из системы:
Мы успешно создали приложение с аутентификацией.
Мы использовали Flask-Login и Flask-SQLAlchemy для создания системы входа в наше приложение. Мы рассказали о том, как организовать аутентификацию пользователей посредством создания пользовательской модели и сохранения данных пользователя. Затем нам нужно было проверить правильность пароля пользователя, выполнив хэширование пароля из формы, и сравнив его с сохраненным в базе данных. В заключение мы добавили в приложение авторизацию, используя декоратор @login_required
на странице профиля, чтобы пользователи могли видеть ее только после входа.
Того, что мы создали в этом учебном модуле, будет достаточно для небольших приложений, но если вы хотите с самого начала использовать больше функций, подумайте об использовании библиотек Flask-User или Flask-Security, которые построены на базе библиотеки Flask-Login.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
Шаг 9 файл project/auth.py имеется ошибка в переменной в функции: login_user(user, remember=remember)
remember - принимает bool значения (True, False) По стандарту стоит False и определяет оставлять ли пользователя после истечения времени его сессии.
Я не понимаю, что делает строка
в файлах auth.py, models.py. Ведь в папке проекта нет файла db.py. Это потому что db определяется в файле init.py кодом
db = SQLAlchemy()
???