Настройка входа через OAuth

Для авторизации пользователей при подключении к репозиторию в веб-приложении доступно использование протокола OAuth версии 2.0. Протокол OAuth 2.0 позволяет авторизоваться под учётной записью сервисов, поддерживающих данный протокол, например, Google.

Для настройки входа в систему выполните шаги, указанные ниже.

Шаг 1. Настройка подключения к репозиторию

Для подключения к репозиторию под конкретным пользователем, который проходил авторизацию на внешнем сервере, необходимо выполнить описанные в данном шаге настройки для каждого пользователя и для каждого репозитория. При этом в качестве имени пользователя указывается логин, используемый этим пользователем на внешнем сервере. Повторите данный шаг на всех рабочих узлах кластера, кроме пункта 2e.

Для настройки подключения к репозиторию:

1. Добавьте в реестр параметр Alg:

2. Запустите утилиту PP.Util, расположенную в папке с установленным продуктом «Форсайт. Аналитическая платформа», с помощью командной строки от имени администратора.

1. Убедитесь, что для пула веб-приложения задана учётная запись операционной системы.

2. Сохраните зашифрованный пароль для входа в репозиторий:

• если предполагается аутентификация на сервере базы данных под пользователем по умолчанию, то используйте команду:

PP.Util /save_creds /ALG gos "идентификатор репозитория" /dc "имя пользователя репозитория"

• если предполагается аутентификация на сервере базы данных под пользователем, соответствующим пользователю, который проходил авторизацию на внешнем сервере, то используйте команду:

PP.Util /save_creds /ALG gos "идентификатор репозитория" "имя пользователя репозитория"

После выполнения действия будет запрошен пароль для подключения к репозиторию. Введите пароль, после чего будет выведено сообщение «Password for metabase 'идентификатор репозитория' and login 'имя пользователя' saved».

3. Для настройки подключения к репозиторию понадобятся закрытый ключ и сертификат, представляющие собой цифровую подпись BI-сервера. Закрытый ключ и сертификат генерируются в формате PEM при помощи специальных программных средств, например, OpenSSL. Выполните предварительные настройки OpenSSL:

sudo apt-get install openssl

sudo yum install openssl

Сертификат генерируется и сохраняется в базу данных репозитория, а ключ для данного сертификата хранится на рабочем узле кластера.

4. Создайте файл openssl.cnf, содержащий вспомогательную информацию. Конфигурация файла одинакова для ОС Windows и ОС Linux:

[ req ]
default_md = sha1
distinguished_name = req_distinguished_name
 
[ req_distinguished_name ]
countryName = Country
countryName_default = RU
countryName_min = 2
countryName_max = 2
localityName = Locality
localityName_default = Russia
organizationName = Organization
organizationName_default = Foresight
commonName = Common Name
commonName_max = 64
 
[ certauth ]
subjectKeyIdentifier = hash
authorityKeyIdentifier = keyid:always,issuer:always
basicConstraints = CA:true
crlDistributionPoints = @crl
 
[ server ]
basicConstraints = CA:FALSE
keyUsage = digitalSignature, keyEncipherment, dataEncipherment
extendedKeyUsage = serverAuth
nsCertType = server
crlDistributionPoints = @crl
 
[ crl ]
URI=http://testca.local/ca.crl

5. Выполните команду для создания корневого сертификата (команда может быть использована как в ОС Windows, так и в ОС Linux):

openssl req -config ./openssl.cnf -newkey rsa:2048 -nodes -keyform PEM -keyout ca.key -x509 -days 3650 -extensions certauth -outform PEM -out ca.cer

При выполнении команды будут запрошены дополнительные данные: PEM пароль и пользовательские данные о владельце сертификата. При запросе «Common name» укажите название выпускаемого удостоверяющего центра, например, «Test CA».

6. Выполните команду для генерации ключа для серверного сертификата (команда может быть использована как в ОС Windows, так и в ОС Linux):

openssl genrsa -out server.key 2048

Создайте запрос на подпись серверного сертификата (команда может быть использована как в ОС Windows, так и в ОС Linux):

openssl req -config ./openssl.cnf -new -key server.key -out server.req

Выполните команду для выпуска серверного сертификата сроком действия 1 год (команда может быть использована как в ОС Windows, так и в ОС Linux):

openssl x509 -req -in server.req -CA ca.cer -CAkey ca.key -set_serial 100 -extfile openssl.cnf -extensions server -days 365 -outform PEM -out server.cer

Если требуется изменить срок действия сертификата, исправьте параметр -days перед выпуском сертификата.

Сертификат будет сгенерирован в файл с расширением *.cer, закрытый ключ будет сгенерирован в файл c расширением *.key. Наименования сертификата и ключа могут быть любыми, например, server_name.cer и server_name.key.

Примечание. Наименования сертификатов и ключей должны быть уникальными для каждого рабочего узла кластера.

7. Сохраните сгенерированный сертификат с расширением *.cer в репозиторий:

PP.Util /save_cert "путь до сертификата" <идентификатор репозитория> <имя пользователя>

После выполнения действия будет запрошен пароль указанного пользователя. Полученные учетные данные будут использоваться для подключения к репозиторию. При удачной авторизации и сохранении сертификата будет выведено сообщение «Certificate from file 'путь до сертификата' with identifier 'идентификатор сертификата' saved to metabase 'идентификатор репозитория'».

8. Сохраните сгенерированный закрытый ключ c расширением *.key в реестре:

PP.Util /save_private_key "путь до файла ключа" <идентификатор сертификата> <алгоритм 
шифрования := gos|pro, если не указан, то pro>

Идентификатор сертификата, необходимый для выполнения команды, указан в выводе предыдущей команды.

После выполнения действия будет выведено сообщение «Certificate from file 'путь до ключа' with identifier 'идентификатор сертификата' saved».

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

Шаг 2. Настройка параметров для протокола OAuth

Для протокола OAuth в редакторе реестра ОС Windows или в файле registry.reg в ОС Linux добавьте подразделы с именами OAuth-серверов и задайте соответствующие настройки реестра в разделе реестра [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\OAuth], или сформируйте раздел System в файле Settings.xml со следующими параметрами:

• PPUserNameFormat. Формат имен пользователей, например, «oa-ggl-%s»;

• ConsumerKey. Ключ зарегистрированного приложения;

• ConsumerSecret. Секретный код зарегистрированного приложения;

• AuthUrl. Адрес сервиса авторизации, который будет использоваться в веб-приложении для RequestTokenUrl, с содержанием дополнительных URL-параметров;

• RequestTokenUrl. Адрес сервиса авторизации, по которому будет возвращаться токен доступа;

• RequestCallbackParam. Наименование атрибута, через который будет передаваться адрес для переадресации пользователя после авторизации в веб-приложении, например, «redirect_uri»;

• UserDataUrl. Адрес сервиса данных, по которому будут возвращаться данные о пользователе после авторизации в веб-приложении;

• UserIdAttr. Путь до поля в запрашиваемых данных, которое будет использоваться в качестве уникального идентификатора пользователя, например, «/path/to/id»;

• UserNameAttr. Путь до поля в запрашиваемых данных, которое будет использоваться в качестве отображаемого имени пользователя, например, «/path/to/displayName».

Значения, указываемые в параметрах ConsumerKey и ConsumerSecret, могут будут получены после регистрации разрабатываемого приложения на необходимом OAuth-сервере. Данные параметры необходимы, чтобы после авторизации на OAuth-сервере BI-сервер смог проверить и авторизовать соответствующего пользователя в репозитории.

Если параметры ConsumerKey и ConsumerSecret не указаны, то используются внутренние настройки BI-сервера, при этом на OAuth-сервере должно быть зарегистрировано приложение на базе веб-приложения «Форсайт. Аналитическая платформа».

Пример заполнения параметров представлен в разделе System для файла Settings.xml.

Примечание. Для конструктора бизнес-приложений можно настроить автоматическую переадресацию на авторизацию пользователей через протокол OAuth 2.0 при входе в веб-приложение. Для этого в файле DBA.config.json задайте значение «OAuth» в поле authentication и укажите сервис авторизации, заданный при настройке параметров для протокола OAuth, в полях allowOauthProviders и autoStartOauthProvider.

Шаг 3. Подготовка BI-сервера

Для подготовки BI-сервера проверьте наличие интернета на сервере, где установлен BI-сервер, и убедитесь, что доступ к сайтам сервисов открыт.

Если интернет-соединение осуществляется через прокси-сервер, то создайте системные переменные CURLOPT_PROXY и CURLOPT_PROXYUSERPWD:

export <имя переменной>=<значение>

После выполнения действий будет подготовлен BI-сервер.

Шаг 4. Логирование сообщений

При настройке и отладке работы веб-приложения могут возникать различные ошибки. Для отслеживания выполняемых действий и получения отладочной информации включите логирование. Для этого в файле /etc/opt/Foresight/fp9.x-biserver/envvars добавьте переменные окружения PP_LOG и CURLOPT_VERBOSE. Более подробно читайте в статье «Конфигурация и настройка».

Шаг 5. Подготовка и открытие веб-приложения

Для подготовки веб-приложения:

1. В файле PP.xml:

1. Задайте значение «OAuth» для атрибута authentication в разделе <metabase>;

2. Заполните раздел <oAuthService>. Для входа в веб-приложение по протоколу OAuth атрибут enabled должен принимать значение true. Значение атрибута useDefaultUserOauth должно быть задано в зависимости от способа сохранения зашифрованного пароля для входа в репозиторий в шаге 1(2b):

• если предполагается аутентификация на сервере базы данных под пользователем по умолчанию - true;

• если предполагается аутентификация на сервере базы данных под пользователем, соответствующим пользователю, который проходил авторизацию на внешнем сервере - false.

Пример заполнения разделов:

<pp>
…
    <metabase authentication="OAuth" id="идентификатор репозитория"/>
    <oAuthService enabled="true" useDefaultUserOauth="true" allowOauthProviders="Google, FCC" autoStartOauthProvider="Google"/>
…
</pp>

2. Перезапустите BI-сервер.

3. Откройте веб-приложение.

После выполнения действий на странице login.html будут доступны кнопки авторизации для входа в систему с использованием протокола OAuth:

Выберите репозиторий и нажмите кнопку одного из сервисов авторизации без ввода имени пользователя и пароля. После чего будет осуществлен переход на страницу учетной записи соответствующего сервиса, например, Google. Введите имя пользователя и пароль на странице сервиса и нажмите кнопку «Авторизоваться». При успешной авторизации будет открыта стартовая страница веб-приложения.