playa-ru / keycloak-russian-providers

Popular russian mail (Yandex, Mail.ru) and social networks (VK, OK) identity providers for Keycloak Identity and Access Management server.

Провайдеры авторизации российских социальных сетей для Keycloak.

Please find english version here.

Библиотека провайдеров российских социальных сетей для Keycloak

• ВКонтакте
• Однокласники
• Яндекс
• Mail.Ru

Посмотреть на это в действии можно здесь - тут используется docker образ из нашей директории на Docker Hub.

Совместимость

Библиотека провайдеров проверялась на следующих версиях Keycloak:

• 21.1.1
• 21.0.1
• 17.0.0
• 16.1.1
• 15.0.2
• 13.0.0
• 12.0.1
• 11.0.3
• 10.0.0
• 8.0.1
• 4.8.3.Final
• 4.5.0.Final
• 4.4.0.Final
• 3.4.3.Final

Таблица поддерживаемых версий:

Версия библиотеки	Версия Keycloak	Репозиторий
21.1.1-rsp	21.1.1	Maven Central
1.0.46	21.0.1	Maven Central
1.0.43	17.0.0	Maven Central
1.0.42	16.1.1	Maven Central
1.0.38	15.0.2	Maven Central
1.0.37	13.0.0	Maven Central
1.0.32	12.0.4	Maven Central
1.0.28	12.0.0	Playa Repository
1.0.26	12.0.1	Playa Repository
1.0.25	11.0.3	Playa Repository
1.0.21	10.0.0	Playa Repository
1.0.17	8.0.1	Playa Repository
1.0.16	6.0.1	Playa Repository
1.0.15	4.8.3.Final	Playa Repository
1.0.1	4.5.0.Final	Playa Repository

Установка провайдеров авторизации в Keycloak

Если вы используете Docker:

• вы можете загрузить готовый Keycloak с этим модулем и парой дополнительных тем с Docker Hub: https://github.com/playa-ru/keycloak-russian

docker pull playaru/keycloak-russian

• или соберите проект с профилем docker и переменной с указанием токена к GitHub (у токена должны быть выданы права чтение репозитория), получится готовый образ. Например, сборка образа Keycloak:

  mvn install -Pdocker -Dtoken.github=XXX

Если вы не используете Docker

Можно установить библиотеку провайдеров в ваш Keycloak самостоятельно.

Keycloak <= 16.1.1

Для этого нужно будет вручную выполнить шаги, описанные в Dockerfile, в целом следуя инструкции:

1. Соберите проект из исходников с помощью Maven, или возьмите готовый keycloak-russian-providers.jar в нашем репозитории.
2. Скопируйте keycloak-russian-providers.jar в [директорию] ${keycloak.home.dir}/standalone/deployments.
3. Скопируйте содержимое директории /src/main/resources/themes/base/admin/resources/partials в ${keycloak.home.dir}/themes/base/admin/resources/partials
4. Добавьте переводы необходимые для темы, для этого необходимо дополнить файлы: ${keycloak.home.dir}/themes/base/admin/messages/admin-messages_en.custom ( из файла src/main/resources/theme/base/admin/messages/admin-messages_en.custom) ${keycloak.home.dir}/themes/base/admin/messages/admin-messages_ru.custom ( из файла src/main/resources/theme/base/admin/messages/admin-messages_ru.custom) ${keycloak.home.dir}/themes/base/login/messages/messages_en.properties ( из файла src/main/resources/theme/base/login/messages/messages_en.custom) ${keycloak.home.dir}/themes/base/login/messages/messages_ru.properties ( из файла src/main/resources/theme/base/login/messages/messages_ru.custom)

Keycloak 17.0.0 - 20.0.5

Для установки модуля авторизации через ЕСИА необходимо выполнить следующие шаги:

1. Соберите проект из исходников с помощью Maven, или возьмите готовый keycloak-russian-providers.jar в нашем репозитории.
2. Скопируйте keycloak-russian-providers.jar файл в директорию /providers
3. Разархивируйте стандартные темы в папку /themes (стандартные темы находятся по пути /lib/lib/main/org.keycloak.keycloak-themes-${keycloak-version}, где keycloak-version версия Keycloak)
4. Скопируйте содержимое директории /src/main/resources/themes/base/admin/resources/partials в ${keycloak.home.dir}/themes/base/admin/resources/partials
5. Добавьте переводы необходимые для темы, для этого необходимо дополнить файлы: ${keycloak.home.dir}/themes/base/admin/messages/admin-messages_en.custom ( из файла src/main/resources/theme/base/admin/messages/admin-messages_en.custom) ${keycloak.home.dir}/themes/base/admin/messages/admin-messages_ru.custom ( из файла src/main/resources/theme/base/admin/messages/admin-messages_ru.custom) ${keycloak.home.dir}/themes/base/login/messages/messages_en.properties ( из файла src/main/resources/theme/base/login/messages/messages_en.custom) ${keycloak.home.dir}/themes/base/login/messages/messages_ru.properties ( из файла src/main/resources/theme/base/login/messages/messages_ru.custom)
6. Выполнить установку новых модулей для этого необходимо выполнить команду /bin/kc.sh build

Keycloak >= 21.1.1

1. Соберите проект из исходников с помощью Maven, или возьмите готовый keycloak-russian-providers.jar в нашем репозитории.
2. Скопируйте keycloak-russian-providers.jar файл в директорию /providers
3. Скачайте обновленную версию библиотеки keycloak-admin-ui с github. Шаблон формирования версии библиотеки ${keycloak-version}.rsp
4. Скопируйте keycloak-admin-ui в /lib/lib/main/org.keycloak.keycloak-admin-ui-${keycloak-version}.jar
5. Выполнить установку новых модулей для этого необходимо выполнить команду /bin/kc.sh build