Qt қолданбасын OAuth 2.0 арқылы Google қызметтеріне қосу

OAuth2, Qt, Google API, QtNetworkAuth

С выпуском Qt 5.8 был добавлен модуль QtNetworkAuth в качестве технологии на предварительном рассмотрении. Он сфокусирован на помощи разработчикам с их безумием в аутентификации. На данный момент поддерживаются OAuth1 и OAuth2 . В будущем будет включено ещё несколько методов авторизации.

Данный пост ориентирован на поддержку OAuth2 в Qt. Здесь показано, как использовать авторизацию Google в приложении. Ваше приложение будет способно показать типичное окно авторизации, как в веб-приложении (Примечание: требуется браузер или WebView).

IETF определяет OAuth 2.0, как:

OAuth 2.0 фреймворк авторизации позволяет третьим приложениям получить ограниченный доступ к HTTP сервисам, либо со стороны владельца ресурса для организации взаимодействия  между владельцем ресурса и HTTP сервисом, либо разрешить приложениям третьей стороны получить собственный доступ.

OAuth авторизация также является требованием использования Google API и доступа пользователя к информации, которая хранится в сервисах Google, таких как Gmail, Drive, Youtube, Maps, и других.

Регистрация вашего нового проекта

Перед началом написания кода вам необходимо зарегистрировать новый проект в сервис провайдере. Этот шаг необходим, поскольку вы будете запрашивать учетные данные клиента для идентификации вашего приложения. Следующие шаги основаны на Google API Console, но они похожи и для других провайдеров.

Создание нового проекта

Для начала регистрации проекта получите доступ в Google API Console , затем нажмите “Create Project”.

Появится диалог “New Project”. Напечатайте имя вашего проекта и нажмите кнопку "Create". Сейчас вы готовы управлять вашим новым проектом.

Ваше приложение зарегистрировано, панель управления обновлена и Вы можете установить различные параметры из этого окна.

Создание учетных данных

Вы можете получить учётные данные для идентификации приложения. Перейдите в раздел "Credentials" и нажмите кнопку "Create credentials". Вы должны выбрать, какие учётные данные вам нужны. Выберите “OAuth client ID”.

В следующем окне, Вы можете настроить "экран согласия" с вашим адресом электронной почты, название продукта, домашнюю страницу, логотип продукта, ... Заполните его вашими данными и нажмите кнопку "Save".

Вернитесь обратно к экрану “Create client ID” и выберите "Application type”. Здесь доступны различные параметры, вам необходимо выбрать “Web application”. Введите его имя.

Под “Restrictions” имеется важное поле: “Authorized redirect URIs”.

Если пользователь выбирает позволить вашему приложения обрабатывать его данные, то приложение принимает “access token”, которые будет использоваться для запросов авторизации. “access token” может быть принят несколькими способами, но обычным способом является приём запроса своим веб-сервером с “access token”. В веб-приложении, пути сервера достаточно для обработки. В десктоп приложении необходимо подделать путь, используя локальный браузер.

Добавьте URI Доступ в вашем браузере, включая порт, если Вы используете порт отличный от 80-го. Когда приложение будет запущено, основной HTTP сервер примет информацию от браузера.

В большинстве случаем вам необходимо будет использовать URI похожий на: “http://localhost:8080/cb”.

Примечание: Путь "/cb" является обязательным в текущей реализации QOAuthHttpServerReplyHandler.

Примечание: Вы можете настроить различные идентификаторы URI. В этом примере предполагается один URI.

Завершаем процесс, нажав на кнопку "Create", и вы увидите новое удостоверение в списке полномочий с "Edit", "Delete" и "Download" кнопками справа. Нажмите кнопку загрузки и ... И, наконец, вы получите готовый файл в формате JSON для синтаксического анализа!

На скриншоте выше вы можете увидеть некоторые новые идентификаторы URI и client_id и client_secret. Там нет необходимости использовать файл в формате JSON, вы можете жёстко задать эту информацию непосредственно в приложении.

Написание кода обёртки для Google API

Здесь опущена часть определения класса, чтобы показать соответствующий код.

Создайте в вашем коде объект QOAuth2AuthorizationCodeFlow :

auto google = new QOAuth2AuthorizationCodeFlow;

Настройка области разрешений, требуемых для вашего приложения. Эта область определяет права доступа приложения. Это может быть одна строка или список строк, разделённых символом, определяемым провайдером сервиса. (Google использует пробел в качестве разделителя).

ПРИМЕЧАНИЕ: области различаются в зависимости от поставщика. Чтобы получить список областей, поддерживаемых Google API, нажмите здесь .

Давайте использовать область, с которой будем получать доступ к электронной почте пользователя:

google->setScope("email");

Подключите сигнал authorizeWithBrowser к функции QDesktopServices::openUrl для открытия внешнего браузера и завершению авторизации.

connect(google, &QOAuth2AuthorizationCodeFlow::authorizeWithBrowser, &QDesktopServices::openUrl);

Разберите скачанный JSON, чтобы получить настройки и требуемую информацию. document является объектом класса QJsonDocument из скачанного файла.

const auto object = document.object();
const auto settingsObject = object["web"].toObject();
const QUrl authUri(settingsObject["auth_uri"].toString());
const auto clientId = settingsObject["client_id"].toString();
const QUrl tokenUri(settingsObject["token_uri"].toString());
const auto clientSecret(settingsObject["client_secret"].toString());
const auto redirectUris = settingsObject["redirect_uris"].toArray();
const QUrl redirectUri(redirectUris[0].toString()); // Get the first URI
const auto port = static_cast<quint16>(redirectUri.port()); // Get the port

После парсинга файла настройте объект google.

google->setAuthorizationUrl(authUri);
google->setClientIdentifier(clientId);
google->setAccessTokenUrl(tokenUri);
google->setClientIdentifierSharedKey(clientSecret);

Создание и назначение QOAuthHttpServerReplyHandler, как обработчик ответа объекта QOAuth2AuthorizationCodeFlow. Обработчик ответа является объектом, который обрабатывает ответы от сервера и получает token`ы, как результат процесса авторизации.

auto replyHandler = new QOAuthHttpServerReplyHandler(port, this);
google->setReplyHandler(replyHandler);

Функция grant начнет процесс авторизации.

google->grant();

Если всё нормально, то вы должны получить QOAuth2AuthorizationCodeFlow::granted signal и начать посылать запросы авторизации.

Вы можете попробовать послать запрос, используя https://www.googleapis.com/plus/v1/people/me

auto reply = google->get(QUrl("https://www.googleapis.com/plus/v1/people/me"));

Это даст вам QNetworkReply и когда сигнал QNetworkReply::finished будет вызван, вы сможете прочитать данные.

Источник Qt Blog