org.keycloak.services.resources.admin.ClientScopeEvaluateResource クラス

org.keycloak.services.resources.admin.ClientScopeEvaluateResource 連携図

クラス
class	ProtocolMapperEvaluationRepresentation

公開メンバ関数
	ClientScopeEvaluateResource (KeycloakSession session, UriInfo uriInfo, RealmModel realm, AdminPermissionEvaluator auth, ClientModel client, ClientConnection clientConnection)
ClientScopeEvaluateScopeMappingsResource	scopeMappings (@QueryParam("scope") String scopeParam, @PathParam("roleContainerId") String roleContainerId)
List< ProtocolMapperEvaluationRepresentation >	getGrantedProtocolMappers (@QueryParam("scope") String scopeParam)
AccessToken	generateExampleAccessToken (@QueryParam("scope") String scopeParam, @QueryParam("userId") String userId)

静的限定公開変数類
static final Logger	logger = Logger.getLogger(ClientScopeEvaluateResource.class)

非公開メンバ関数
AccessToken	generateToken (UserModel user, String scopeParam)

非公開変数類
final RealmModel	realm
final ClientModel	client
final AdminPermissionEvaluator	auth
final UriInfo	uriInfo
final KeycloakSession	session
final ClientConnection	clientConnection

詳解

著者

Marek Posolda

構築子と解体子

ClientScopeEvaluateResource()

org.keycloak.services.resources.admin.ClientScopeEvaluateResource.ClientScopeEvaluateResource ( KeycloakSession  session, UriInfo  uriInfo, RealmModel  realm, AdminPermissionEvaluator  auth, ClientModel  client, ClientConnection  clientConnection  )

inline

                                                                                        {
        this.uriInfo = uriInfo;
        this.realm = realm;
        this.client = client;
        this.auth = auth;
        this.session = session;
        this.clientConnection = clientConnection;
    }

関数詳解

generateExampleAccessToken()

AccessToken org.keycloak.services.resources.admin.ClientScopeEvaluateResource.generateExampleAccessToken ( @QueryParam("scope") String  scopeParam, @QueryParam("userId") String  userId  )

inline

Create JSON with payload of example access token

戻り値

                                                                                                                               {
        auth.clients().requireView(client);

        if (userId == null) {
            throw new NotFoundException("No userId provided");
        }

        UserModel user = session.users().getUserById(userId, realm);
        if (user == null) {
            throw new NotFoundException("No user found");
        }

        logger.debugf("generateExampleAccessToken invoked. User: %s, Scope param: %s", user.getUsername(), scopeParam);

        AccessToken token = generateToken(user, scopeParam);
        return token;
    }

generateToken()

AccessToken org.keycloak.services.resources.admin.ClientScopeEvaluateResource.generateToken ( UserModel  user, String  scopeParam  )

inlineprivate

                                                                         {
        AuthenticationSessionModel authSession = null;
        UserSessionModel userSession = null;
        AuthenticationSessionManager authSessionManager = new AuthenticationSessionManager(session);

        try {
            RootAuthenticationSessionModel rootAuthSession = authSessionManager.createAuthenticationSession(realm, false);
            authSession = rootAuthSession.createAuthenticationSession(client);

            authSession.setAuthenticatedUser(user);
            authSession.setProtocol(OIDCLoginProtocol.LOGIN_PROTOCOL);
            authSession.setClientNote(OIDCLoginProtocol.ISSUER, Urls.realmIssuer(uriInfo.getBaseUri(), realm.getName()));
            authSession.setClientNote(OIDCLoginProtocol.SCOPE_PARAM, scopeParam);

            userSession = session.sessions().createUserSession(authSession.getParentSession().getId(), realm, user, user.getUsername(),
                    clientConnection.getRemoteAddr(), "example-auth", false, null, null);

            AuthenticationManager.setClientScopesInSession(authSession);
            ClientSessionContext clientSessionCtx = TokenManager.attachAuthenticationSession(session, userSession, authSession);

            TokenManager tokenManager = new TokenManager();

            TokenManager.AccessTokenResponseBuilder responseBuilder = tokenManager.responseBuilder(realm, client, null, session, userSession, clientSessionCtx)
                    .generateAccessToken();

            return responseBuilder.getAccessToken();

        } finally {
            if (authSession != null) {
                authSessionManager.removeAuthenticationSession(realm, authSession, false);
            }
            if (userSession != null) {
                session.sessions().removeUserSession(realm, userSession);
            }
        }
    }

getGrantedProtocolMappers()

List<ProtocolMapperEvaluationRepresentation> org.keycloak.services.resources.admin.ClientScopeEvaluateResource.getGrantedProtocolMappers ( @QueryParam("scope") String  scopeParam )

inline

Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.

戻り値

                                                                                                                          {
        auth.clients().requireView(client);

        List<ProtocolMapperEvaluationRepresentation> protocolMappers = new LinkedList<>();

        Set<ClientScopeModel> clientScopes = TokenManager.getRequestedClientScopes(scopeParam, client);

        for (ClientScopeModel mapperContainer : clientScopes) {
            Set<ProtocolMapperModel> currentMappers = mapperContainer.getProtocolMappers();
            for (ProtocolMapperModel current : currentMappers) {
                if (current.getProtocol().equals(client.getProtocol())) {
                    ProtocolMapperEvaluationRepresentation rep = new ProtocolMapperEvaluationRepresentation();
                    rep.setMapperId(current.getId());
                    rep.setMapperName(current.getName());
                    rep.setProtocolMapper(current.getProtocolMapper());

                    if (mapperContainer.getId().equals(client.getId())) {
                        // Must be this client
                        rep.setContainerId(client.getId());
                        rep.setContainerName("");
                        rep.setContainerType("client");
                    } else {
                        ClientScopeModel clientScope = (ClientScopeModel) mapperContainer;
                        rep.setContainerId(clientScope.getId());
                        rep.setContainerName(clientScope.getName());
                        rep.setContainerType("client-scope");
                    }

                    protocolMappers.add(rep);
                }
            }
        }

        return protocolMappers;
    }

scopeMappings()

ClientScopeEvaluateScopeMappingsResource org.keycloak.services.resources.admin.ClientScopeEvaluateResource.scopeMappings ( @QueryParam("scope") String  scopeParam, @PathParam("roleContainerId") String  roleContainerId  )

inline

引数

scopeParam
roleContainerId	either realm name OR client UUID

戻り値

                                                                                                                                                                {
        auth.clients().requireView(client);

        if (roleContainerId == null) {
            throw new NotFoundException("No roleContainerId provided");
        }

        RoleContainerModel roleContainer = roleContainerId.equals(realm.getName()) ? realm : realm.getClientById(roleContainerId);
        if (roleContainer == null) {
            throw new NotFoundException("Role Container not found");
        }

        return new ClientScopeEvaluateScopeMappingsResource(roleContainer, auth, client, scopeParam, session);
    }

メンバ詳解

auth

final AdminPermissionEvaluator org.keycloak.services.resources.admin.ClientScopeEvaluateResource.auth

private

client

final ClientModel org.keycloak.services.resources.admin.ClientScopeEvaluateResource.client

private

clientConnection

final ClientConnection org.keycloak.services.resources.admin.ClientScopeEvaluateResource.clientConnection

private

logger

final Logger org.keycloak.services.resources.admin.ClientScopeEvaluateResource.logger = Logger.getLogger(ClientScopeEvaluateResource.class)

staticprotected

realm

final RealmModel org.keycloak.services.resources.admin.ClientScopeEvaluateResource.realm

private

session

final KeycloakSession org.keycloak.services.resources.admin.ClientScopeEvaluateResource.session

private

uriInfo

final UriInfo org.keycloak.services.resources.admin.ClientScopeEvaluateResource.uriInfo

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/resources/admin/ClientScopeEvaluateResource.java