Keycloak for Java app
Last updated
Was this helpful?
Last updated
Was this helpful?
Содержание
О чем речь?
Подготовка стенда для разработки
Настройка realm
Подготовка приложения к внедрению
Настройка приложения для взаимодействия с Keycloak
Реализация Attribute based access control в Keycloak
Это первая часть серии статей о переходе на Keycloak в качестве SSO в условиях кровавого enterprise.
Целью данной серии постов является демонстрация одного из возможных вариантов внедрения Keycloak в большой enterprise проект в качестве SSO. Еще в ней будут приведены мои размышления на этот счет, а также описаны сложности, с которыми пришлось столкнуться и решения, которые при этом были найдены.
В данный момент я работаю в большом проекте, который имеет весьма длинную историю развития. Нашими заказчиками являются представители крупного бизнеса, такие как банки и различные торговые площадки.
Проект написан на spring-framework и как следствие использует компоненты spring-security для реализации системы аутентификации / авторизации пользователей.
В силу специфики нашего бизнеса крупные заказчики иногда имеют возможность проталкивать свои потребности в наш проект, в частности различные подходы к аутентификации пользователей. Таким образом, со временем развития проекта в нем появилась куча специфичных для конкретных заказчиков компонентов аутентификации:
Basic (по логину паролю)
По логину паролю с ассеss и refresh-token
OAUTH
SAML
LDAP
JWT (где наш бэкенд выступает просто в качестве resource-server, а аутентификация происходит на стороне заказчика)
На сегодняшний день реализованные нами компоненты аутентификации и авторизации уже очень сильно устарели и техническое руководство приняло, на мой взгляд, очень верное решение избавиться от них полностью и внедрить SSO (Single sign-on). Выбор пал на Keycloak, как на явного фаворита в среде систем данного рода с открытым исходным кодом. (В данной последующих постах не будут подниматься вопросы delivery нашего продукта заказчику вкупе с Keycloak и специфики комбинации проприетарного и open-source кода).
Когда я только начал заниматься этой задачей, я весьма оптимистично оценил ее в 100 чч по трудозатратам, потому что буквально недавно внедрил Keycloak на другом проекте за неделю, однако я не учел, что мой нынешний проект в десятки раз больше и запутаннее чем предыдущий, который только-только стартовал.
Основной практической темой данного раздела является настройка стенда для локальной разработки, который в дальнейшем можно будет использовать и в CI для выполнения тестов.
Ниже я приведу compose файл, который у меня получился и дам ряд комментариев:
Данный compose-файл позволяет запустить keycloak в продуктивном режиме с реляционной базой данных.
Так как SSO это как правило отдельный микросервис, то под него имеет смысл выделять собственную БД.
Данный файл содержит ряд place-holder’ов для более гибкой конфигурации через .env файлы (в дальнейшем нам это пригодится для CI).
Пройдемся подробнее по конфигурации сервиса keycloak:
Все начинается с команды запуска:
Теперь пройдемся по опциям:
auto-build – собирает наш экземпляр со всеми зависимостями и кастомизациями
db – указывает, какую БД мы будем использовать, чтобы выбрать соответствующий драйвер
hostname-strict-https разрешаем/запрещаем фронту и бэку keycloak общаться по HTTP
proxy устанавливает режим reverse-proxy
hostname-strict вкл/выкл динамического имени хоста из заголовков запросов
http-enabled разрешаем взаимодействие по http
import-realm включаем импортирование realms из файлов конфигураций
Войдя по admin:admin мы окажемся на странице master realm:
Темой данного раздела является базовая настройка realm Keycloak для разработки.
В прошлом разделе мы создали docker-compose файл, который позволяет нам развернуть стенд Keycloak, теперь нам необходимо его настроить, для этого:
Создадим собственный realm:
Теперь в рамках созданного realm создадим клиента:
На следующей вкладке, включаем аутентификацию и авторизацию у нашего клиента, это нужно для того, чтобы мы могли входить в систему и совершать определенные действия не от лица пользователя (человека), а от лица клиента как такового:
Теперь у нас есть клиент, с возможностью логиниться из под него в Keycloak, давайте попробуем получить access-token с помощью сurl, для этого нам понадобится client_secret, который был сгенерирован в момент создания клиента, найти его можно в разделе credentials вашего клиента, тут важно подчеркнуть, что в продуктивном контуре этот секрет всегда должен генерироваться keycloak, однако в тестовой среде и среде для разработки допускается его определять заранее, ниже будет описано как именно:
Очевидно, что производить ручную настройку клиента каждый раз неудобно и долго, к тому же в этом примере мы почти ничего не настраивали, в следующих постах мы настроим ресурсы, политики и прочее. Для того чтобы иметь возможность содержать эти настройки в коде, и автоматизировать развертывание стенда, keycloak предоставляет механизмы импорта/экспорта нашего realm.
Для того чтобы экспортировать realm, переходим на страницу настроек и выбираем соответствующее действие:
В итоге мы получим большой JSON файл, содержащий конфигурацию нашего realm.
Теперь мы можем усовершенствовать наш docker‑compose файл из прошлого поста, мы прокинем наш файл внутрь контейнера keycloak, чтобы наш realm импортировался автоматически при старте приложения:
Теперь при запуске наших контейнеров, в Keycloak сразу будет realm demo и client backend.
Для удобства локальной разработки и тестирования (ЭТО ВАЖНО, В ПРОДЕ НИКОГДА ТАК НЕ ДЕЛАЙТЕ !!!), мы можем прописать secret нашего клиента в файл импорта, и тогда он не будет генерироваться заново каждый раз. Для этого в нашем JSON файле находим следующее поле: clients[YOUR CLIENT INDEX.secret и пишем туда что хотим.
Темой данного раздела является проблема конфликтов конфигураций, с которой я столкнулся в процессе внедрения Keycloak.
Когда мы используем Spring очень многое настраивается за нас, в частности, простое добавление зависимости spring-security уже тянет за собой пачку авто-конфигураций, которые добавляют бин SecurityFilterChain, и много других разностей, которые и отвечают за то, чтобы наше приложение было защищено от неправомерного доступа.
Различные конфигурации иногда вполне могут сосуществовать совместно, а иногда нет. В моем случае я столкнулся с тем, что один из фильтров, которые тянет конфигурация, использующая устаревшую зависимость, конфликтует с фильтрами, которые нужны мне для внедрения Keycloak.
Например, мы внедряем SSO, следовательно если мы ходим в приложение через SSO остальные варианты входа нам не нужны, но и выпилить их из проекта мы тоже не можем, потому что их используют другие заказчики, что нам остается? - правильно - исключить их из контекста приложения завязавшись, например, на настройку приложения.
keykloak.enabled=true
Тогда старая конфигурация, которая нам мешает, примет следующий вид:
Теперь, если у нас в проекте включено использование keycloak, то конфигурации, которые нам мешают, просто не будут инициализированы при старте приложения.
Если ваш проект достаточно большой, то вам придется потратить довольно много времени на то, чтобы найти и "выключить" все, что вам мешает. Тут могу посоветовать, вооружившись отладчиком, при старте приложения смотреть содержание бина SecurityFilterChain, чтобы удостовериться, что оно соответствует вашим потребностям.
Темой данного раздела является самая простая часть внедрения Keycloak, а именно настройка spring-security для проверки токенов через Keycloak.
Небольшое пояснение, в выбранной архитектуре схема взаимодействия фронта и бэка выглядит следующим образом:
Поэтому на стороне бэкенда от нас требуется только валидировать JWT-токены, которые присылаются в запросах.
Для того чтобы подружить наше приложение с Keycloak нужно не так много.
Для начала подключим зависимости, в данном примере используется gradle:
В application.yml надо прописать URL откуда наше приложение будет брать информацию о том, как именно ему коммуницировать с Keycloak:
Теперь надо добавить конфигурацию spring-security, которая будет проверять JWT из запроса через Keycloak:
Voi la, наше приложение подружилось с keycloak и теперь пропускает запросы, которые содержат токены авторизации, полученные в Keycloak. Давайте добавим контроллер и убедимся в этом:
В данном примере мы просто возвращаем информацию из JWT-токена, которую наше приложение распарсило с помощью данных полученных от Keycloak через URL, который мы указали в настройках:
Темой данного раздела является реализация ABAC-политик безопасности в Keycloak.
ABAC или Attribute based access control - весьма популярный способ разграничения прав в крупных системах с большим числом пользователей и множеством ролей. ABAC позволяет разграничивать доступ между пользователями одной роли или группы на основе атрибутов этих пользователей. И так уж вышло, что и в нашей системе присутствует ABAC, и следовательно его логику нужно было переносить в Keycloak, и все было бы здорово, но Keycloak не поддерживает его из коробки.
Для реализации кастомных политик безопасности в Keycloak есть возможность писать их на JavaScript и упаковав в JAR со специальным дескриптором подложить в Keycloak.
Рассмотрим это на примере.
В парадигме Keycloak есть основные сущности, когда речь идет о разграничении доступа:
Ресурс - например оконечная точка API
Политика - правило на основе которого предоставляется доступ
Разрешение - связующий элемент, который объединяет ресурс и политику
Таким образом если мы имеем ресурс RESOURCE_1, политику, которая гласит, что разрешение выдается только пользователям с атрибутом RESOURCE_1_ACCESS_ATTRIBUTE, то чтобы это все объединить, нам нужно еще разрешение PERMISSION_1, что доступ к ресурсу RESOURCE_1 могут получить только пользователи с атрибутом RESOURCE_1_ACCESS_ATTRIBUTE.
P.S. с точки зрения Keycloak разрешение - тоже политика, но об этом позже.
Для того чтобы использовать атрибут как средство разграничения доступа у рядового пользователя не должно быть возможности его самостоятельно редактировать, потому что иначе любой джуниор пропишет себе, что он CTO и пойдет крушить-ломать. Тут на помощь приходит механизм Keycloak, который позволяет задать шаблон, соответствие которому автоматически защищает атрибут от редактирования. Вспомним наш compose файл, в команде запуска сервера у нас есть следующая опция:
-spi-user-profile-legacy-user-profile-read-only-attributes *_RES_ACCESS_MODE
Данная опция означает, что все пользовательские атрибуты с постфиксом _RES_ACCESS_MODE доступны для редактирования только администратору realm.
Давайте добавим в наше приложение новый ресурс:
Мы хотим, чтобы доступ к этому ресурсу был только у пользователя с атрибутом FANCY_RES_ACCESS_ATTRIBUTE в значении PRETTY_FANCY, каков наш алгоритм действий?
Нам нужно создать ресурс в Keycloak, мы это можем сделать руками, для этого переходим во вкладку authorization -> resources и создаем его:
либо это можно сделать через код, для этого в наш JSON, в список ресурсов нашего клиента (clients[YOUR CLIENT INDEX].authorizationSettings.resources) добавляем следующее:
теперь если мы пересоздадим контейнеры, этот ресурс сразу будет в нашем клиенте.
Создаем политику
Тут все будет несколько сложнее) Для начала где-нибудь в ресурсах создадим структуру каталогов вида:
custom-scripts
из этого каталога мы впоследствии будем собирать JAR-файл и деплоить его в Keycloak.
keycloak-scripts.json это дескриптор следующего вида:
теперь давайте создадим политику, как уже говорилось ранее, мы хотим, чтобы доступ к ресурсу был только у пользователя с атрибутом FANCY_RES_ACCESS_ATTRIBUTE в значении PRETTY_FANCY
для этого мы реализуем следующую логику:
сохраним это в файле pretty-fancy-policy.js в подкаталоге policies и опишем в дескрипторе в соответствии с документацией:
Когда все готово нам нужно собрать JAR файл, для этого вызываем следующую команду:
Теперь нам надо прокинуть этот JAR в контейнер Keycloak, это можно сделать командой докера, потом залезть в контейнер и перезагрузить сервер, но так как мы вынесли нашу конфигурацию в код, мы смело можем просто пересоздать контейнер дописав volume в compose файле:
после запуска, наша политика станет доступна как тип в разделе политик нашего клиента your realm -> your client -> authorization -> policies -> create new:
теперь мы можем создать политику с нашим кастомным типом, это можно сделать через интерфейс, но я не буду отдельно останавливаться на этом, так как наша основная цель - содержать конфигурацию keycloak в коде. Поэтому мы добавим следующий код в секцию политик нашего клиента (clients[YOUR CLIENT INDEX].authorizationSettings.policies):
Политика:
В описании политики поле type формируется следующим образом: script-[Путь до JS файла от корня Jar]
logic в значении POSITIVE означает, что логика работы нашей политики - прямая, т. е. если политика принимает положительное решение оно таковым и остается, с помощью значения NEGATIVE можно сделать обратную логику
decisionStrategy в значении UNANIMOUS условно означает логическое И, если бы наша политика состояла из комбинации нескольких других, то все они должны были бы прийти к положительному решению, чтобы наша также дала положительный ответ, помимо UNANIMOUS есть еще AFFIRMATIVE - логическое ИЛИ, а также CONSENSUS, в последнем случае решение принимается в зависимости от того каких решений было больше.
Разрешение:
Типом данного разрешения является resource, это означает, что данное разрешение выдается на конкретный ресурс, безотносительно к Scope и другим атрибутам ресурса.
Поля logic и decisionStrategy имеют такую же семантику, как и в обычной политике
Основным отличием разрешения от обычной политики является наличие атрибута config, в котором перечислены ресурсы, относящиеся к данному разрешению, и комбинация политик, которые должны принять решение о предоставлении доступа.
Теперь когда мы добавили в наш файл импорта политику и разрешение, можно пересоздать контейнеры, если шалость удалась, то в секции authorization нашего клиента мы увидим наши политику и разрешение:
Если честно, я до конца не понял, почему политика и разрешение это по сути одна и та же сущность, на мой взгляд было бы логичнее их архитектурно разделить.
Теперь, когда у нас есть ресурс, политика и связывающее их разрешение, мы можем проверить как это все работает.
Для начала создадим пользователя:
Теперь идем во вкладку evaluate секции authorization, там выбираем нашего пользователя и ресурс и жмем evaluate:
Иииии….
Получаем вполне закономерный результат, потому что у нашего пользователя нет требуемого атрибута. Добавим его:
И проверим еще раз:
Хмммм… мы что-то явно упустили.
А именно, то что заботливые разработчики клоаки решили, что просто добавить пользовательский атрибут это слишком просто, и чтобы он был доступен во время проверки прав, нужно еще добавить маппер, поэтому идем в секцию clients[YOUR CLIENT INDEX].protocolMappers и добавляем туда маппер для нашего атрибута:
Перезапускаем все и проверяем еще раз:
Наконец разрешение получено.
У нас получилось реализовать полноценный ABAC в Keycloak, более того, вся конфигурация у нас хранится в коде, тут небольшое лирическое отступление, когда сами будете это все разрабатывать - проще всего набить все настройки в интерфейсе, а потом экспортировать в файл средствами Keycloak ;)
И так у нас есть контроль доступа, который работает на основе пользовательских атрибутов и вроде все прекрасно …, НО наше spring-приложение про это ничего не знает и все также пропускает любого авторизованного в keycloak пользователя к своим ресурсам, как это поправить поговорим в следующих постах.
Если мы посмотрим DockerFile [ ] из которого собирается наш образ Keycloak, то увидим, что entrypoint там стоит ENTRYPOINT ["/opt/keycloak/bin/kc.sh"] (скрипт запуска Keycloak в standalone режиме). Команда start запускает приложение в production режиме.
После запуска данной конфигурации командой docker-compose up -d у вас будет готовый стенд Keycloak, который можно использовать для разработки и прогона тестов, Главная страница будет доступна по адресу .
Есть один интересный баг, который пока никто не исправил - при создании клиента создается политика по умолчанию, которая имеет тип JS (подробнее о политиках и разрешениях можно прочитать здесь ). В более ранних версиях сложные кастомные политики можно было загружать прямо через интерфейс в виде JS кода, позже эту возможность убрали (потому что не секьюрно). Однако эта политика по умолчанию осталась, и при экспорте, она тоже выгрузится, но когда вы захотите потом импортировать ваш realm, вы получите ошибку, так как в актуальной версии JS политики можно загружать только через специальный JAR файл, однако об этом позже. Сейчас, чтобы магия случилась нам нужно удалить эту политику и связанное с ней разрешение:
В таком случае нам на помощь приходят механизмы Spring из группы аннотаций ..., которые выключают те или иные конфигурации в зависимости от различных условий.
Про то как писать политики на JS и какие данные при этом в вашем распоряжении можно почитать тут ().
как его составлять, можно прочитать здесь ()
Подробнее про ресурсы, политики и разрешения можно прочитать здесь ()
