Edge for Private Cloud версии 4.17.05
Сопоставление внешних ролей позволяет сопоставлять собственные группы или роли с ролями и группами контроля доступа на основе ролей (RBAC), созданными в Apigee Edge.
Требования
- Для настройки необходимы права системного администратора Apigee Private Cloud с учетными данными глобального системного администратора.
- Вам нужно знать корневой каталог установки Apigee Edge Private Cloud. Корневой каталог по умолчанию – /opt. Если при установке Apigee Edge Private Cloud вы выбрали другой корневой каталог, используйте его вместо /opt.
- Получите необходимые JAR-файлы от Apigee.
Убедитесь, что пользователи зарегистрированы в Edge и службе каталогов
При использовании сопоставления ролей все пользователи, у которых есть доступ к Edge, должны быть зарегистрированы как во внешней службе каталогов, так и в хранилище пользователей Edge. Это означает, что при добавлении пользователя в службу внешних каталогов вы также должны добавить этого же пользователя в хранилище пользователей Apigee.
Например, пользователь a01@company.com находится в группе apiadmin внешнего каталога. Затем вы хотите сопоставить пользователя a01@company.com с ролью orgadmin в Edge. Поэтому пользователя a01@company.com необходимо сначала добавить в группу orgadmin в Edge.
Подробнее о том, как создавать пользователей Edge и назначать им роли…
Конфигурация по умолчанию
По умолчанию сопоставление внешних ролей отключено.
Включение сопоставления внешних ролей
- Прежде чем выполнить описанную ниже настройку, необходимо создать класс Java, реализующий интерфейс ExternalRoleMapperService. Подробные сведения о реализации приведены в примере ниже.
- Войдите в Apigee Edge Management Server и остановите его:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-server stop - Проверьте статус серверов. Убедитесь, что сервер управления остановлен или не запущен:
> /opt/apigee/apigee-service/bin/apigee-all status - Откройте файл /opt/apigee/customer/application/management-server.properties в текстовом редакторе.
- Отредактируйте файл management-server.properties, указав следующие настройки:
conf_security_authentication.user.store=externalized.authentication
conf_security_externalized.authentication.role.mapper.enabled=true
conf_security_externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Важно! Класс реализации и название пакета, указанные выше (ExternalRoleMapperImpl), приведены только в качестве примера. Вы должны реализовать этот класс и можете назвать его и пакет как угодно. Подробные сведения о реализации этого класса приведены в примере ниже. - Сохраните файл management-server.properties.
- Запустите сервер управления:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-server start - Убедитесь, что сервер работает:
> /opt/apigee/apigee-service/bin/apigee-all status
Отключение внешней авторизации
Чтобы отключить внешнюю авторизацию:
- Откройте файл /opt/apigee/customer/application/management-server.properties в текстовом редакторе.
- Измените хранилище пользователей для аутентификации на ldap:
conf_security_authentication.user.store=ldap - Задайте для следующего свойства значение false:
conf_security_externalized.authentication.role.mapper.enabled=false - Перезапустите сервер управления:
> /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
Пример реализации ExternalRoleMapperImpl
В файле конфигурации management-server.properties, описанном выше, обратите внимание на следующую строку:
conf_security_externalized.authentication.role.mapper.implementation.class=com.customer.authorization.impl.ExternalRoleMapperImpl
Этот класс реализует интерфейс ExternalRoleMapperService и является обязательным. Вам нужно создать собственную реализацию этого класса, которая отражает ваши группы. После этого поместите скомпилированный класс в JAR-файл и сохраните его в каталоге /<install_dir>/apigee/edge-gateway/lib/infra/libraries.
Вы можете назвать класс и пакет как угодно, если они реализуют ExternalRoleMapperService, доступны в classpath и правильно указаны в файле конфигурации management-server.properties.
Ниже приведен пример реализации класса ExternalRoleMapperImpl с комментариями. Чтобы скомпилировать этот класс, необходимо сослаться на следующий JAR-файл, включенный в Edge:
/<install_dir>/apigee/edge-gateway/lib/infra/libraries/authentication-1.0.0.jar
package com.apigee.authenticate; import com.apigee.authentication.ConfigBean; import com.apigee.authentication.ConnectionException; import com.apigee.authentication.ExternalRoleMapperService; import com.apigee.authentication.NameSpace; import com.apigee.authentication.NameSpacedRole; import com.apigee.authorization.namespace.OrganizationNamespace; import com.apigee.authorization.namespace.SystemNamespace; import java.util.Collection; import java.util.HashSet; import javax.naming.NamingEnumeration; import javax.naming.NamingException; import javax.naming.directory.Attributes; import javax.naming.directory.DirContext; import javax.naming.directory.InitialDirContext; import javax.naming.directory.SearchControls; import javax.naming.directory.SearchResult; /** * * Sample Implementation constructed with dummy roles with required namespaces. * * Created by GopiAlagar on 6/12/15. */ public class ExternalRoleMapperImpl implements ExternalRoleMapperService { InitialDirContext dirContext = null; @Override public void stop() throws Exception { } /** * * This method would be implemented by the customer, Below is the basic * example. * * If User has sysadmin role then it's expected to set SystemNameSpace * along with the * res\quested NameSpace. Otherwise role's requestedNameSpace to be set * for the NameSpacedRole. * * Collection<NameSpacedRole> results = new HashSet<NameSpacedRole>(); * * NameSpacedRole sysNameSpace = new NameSpacedRole("sysadmin", * SystemNamespace.get()); * * String orgName = * ((OrganizationNamespace)requestedNameSpace).getOrganization(); * * NameSpacedRole orgNameSpace = new NameSpacedRole ("orgadmin", * requestedNameSpace); * * results.add(sysNameSpace); * * results.add(orgNameSpace); */ public Collection<NameSpacedRole> getUserRoles(String userName, String password, NameSpace requestedNameSpace) { /* * There are 3 actions performed in the below implementation * 1. Authenticate Given User against ADS * 2. Fetch the internal groups from the ADS * 3. Map the internal group into the apigee-edge roles */ /*************************************************************/ /******************* Authenticate Given User *******************/ /*************************************************************/ // Customer Specific Implementation will override this method // implementation. // Obtain dnName for given username or email address. String dnName = ImplementDnameLookupLogic(); if (dnName == null) { System.out.println("Error "); } DirContext dirContext = null; Collection<NameSpacedRole> results = new HashSet<NameSpacedRole>(); try { // Verify the credentials for a given username or dnName // and password in order to create a directory context. dirContext = ImplementDirectoryContextCreationLogic(); /****************************************************/ /********** Fetch internal groups *******************/ /****************************************************/ String groupDN = "OU=Groups,DC=corp,DC=wacapps,DC=net"; SearchControls controls = new SearchControls(); controls.setSearchScope(SearchControls.ONELEVEL_SCOPE); NamingEnumeration<SearchResult> groups = dirContext.search(groupDN,"(objectClass=*)", new Object[] { "", "" }, controls); if (groups.hasMoreElements()) { while (groups.hasMoreElements()) { SearchResult searchResult = groups.nextElement(); Attributes attributes = searchResult.getAttributes(); String groupName = attributes.get("name").get().toString(); /**************************************/ /** Map the internal group into the ***/ /** apigee-edge roles ***/ /**************************************/ if (groupName.equals("BusDev")) { results.add(new NameSpacedRole("businessAdmin",SystemNamespace.get())); } else if (groupName.equals("DevSupport")) { results.add(new NameSpacedRole("devOpsAdmin",SystemNamespace.get())); } else if (groupName.equals("Engineering")) { if (requestedNameSpace instanceof OrganizationNamespace) { String orgName = ((OrganizationNamespace) requestedNameSpace).getOrganization(); results.add(new NameSpacedRole("orgadmin", new OrganizationNamespace(orgName))); } } else if (groupName.equals("Operations") || groupName.equals("IT")) { results.add(new NameSpacedRole("sysadmin",SystemNamespace.get())); } else if (groupName.equals("Marketing")) { results.add(new NameSpacedRole("marketAdmin",SystemNamespace.get())); } else { results.add(new NameSpacedRole("readOnly",SystemNamespace.get())); } } } else { /** * In case of no group found or exception found we throw empty * roles. */ System.out.println(" !!!!! NO GROUPS FOUND !!!!!"); } } catch (Exception ex) { ex.printStackTrace(); System.out.println("Error in authenticating User: {}" + new Object[] { userName }); } finally { // Customer implementation to close // ActiveDirectory/LDAP context. } return results; } @Override public void start(ConfigBean arg0) throws ConnectionException { try { // Create InitialDirContext. // Create a directory context based on the // system admin user credentials. dirContext = ImplementDirContextCreationLogicForSysAdmin(); } catch (NamingException e) { // TODO Auto-generated catch block throw new ConnectionException(e); } } }