org.keycloak.authorization.protection.permission.PermissionTicketService クラス

org.keycloak.authorization.protection.permission.PermissionTicketService 連携図

公開メンバ関数
	PermissionTicketService (KeycloakIdentity identity, ResourceServer resourceServer, AuthorizationProvider authorization)
Response	create (PermissionTicketRepresentation representation)
Response	update (PermissionTicketRepresentation representation)
Response	delete (@PathParam("id") String id)
Response	find (@QueryParam("scopeId") String scopeId, @QueryParam("resourceId") String resourceId, @QueryParam("owner") String owner, @QueryParam("requester") String requester, @QueryParam("granted") Boolean granted, @QueryParam("returnNames") Boolean returnNames, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResult)

非公開メンバ関数
String	getUserId (String userIdOrName)

非公開変数類
final AuthorizationProvider	authorization
final KeycloakIdentity	identity
final ResourceServer	resourceServer

詳解

著者

Pedro Igor

構築子と解体子

PermissionTicketService()

org.keycloak.authorization.protection.permission.PermissionTicketService.PermissionTicketService ( KeycloakIdentity  identity, ResourceServer  resourceServer, AuthorizationProvider  authorization  )

inline

                                                                                                                                  {
        this.identity = identity;
        this.resourceServer = resourceServer;
        this.authorization = authorization;
    }

関数詳解

create()

Response org.keycloak.authorization.protection.permission.PermissionTicketService.create ( PermissionTicketRepresentation  representation )

inline

                                                                          {
        PermissionTicketStore ticketStore = authorization.getStoreFactory().getPermissionTicketStore();
        if (representation == null)
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_permission", Response.Status.BAD_REQUEST);
        if (representation.getId() != null)
            throw new ErrorResponseException("invalid_permission", "created permissions should not have id", Response.Status.BAD_REQUEST);
        if (representation.getResource() == null)
            throw new ErrorResponseException("invalid_permission", "created permissions should have resource", Response.Status.BAD_REQUEST);
        if (representation.getScope() == null && representation.getScopeName() == null)
            throw new ErrorResponseException("invalid_permission", "created permissions should have scope or scopeName", Response.Status.BAD_REQUEST);
        if (representation.getRequester() == null && representation.getRequesterName() == null)
            throw new ErrorResponseException("invalid_permission", "created permissions should have requester or requesterName", Response.Status.BAD_REQUEST);
         
        ResourceStore rstore = this.authorization.getStoreFactory().getResourceStore();
        Resource resource = rstore.findById(representation.getResource(), resourceServer.getId());
        if (resource == null ) throw new ErrorResponseException("invalid_resource_id", "Resource set with id [" + representation.getResource() + "] does not exists in this server.", Response.Status.BAD_REQUEST);
        
        if (!resource.getOwner().equals(this.identity.getId()))
            throw new ErrorResponseException("not_authorised", "permissions for [" + representation.getResource() + "] can be only created by the owner", Response.Status.FORBIDDEN);
        
        UserModel user = null;
        if(representation.getRequester() != null)
            user = this.authorization.getKeycloakSession().userStorageManager().getUserById(representation.getRequester(), this.authorization.getRealm());
        else 
            user = this.authorization.getKeycloakSession().userStorageManager().getUserByUsername(representation.getRequesterName(), this.authorization.getRealm());
        
        if (user == null)
            throw new ErrorResponseException("invalid_permission", "Requester does not exists in this server as user.", Response.Status.BAD_REQUEST);
        
        Scope scope = null;
        ScopeStore sstore = this.authorization.getStoreFactory().getScopeStore();

        if(representation.getScopeName() != null)
            scope = sstore.findByName(representation.getScopeName(), resourceServer.getId());
        else
            scope = sstore.findById(representation.getScope(), resourceServer.getId());

        if (scope == null && representation.getScope() !=null )
            throw new ErrorResponseException("invalid_scope", "Scope [" + representation.getScope() + "] is invalid", Response.Status.BAD_REQUEST);
        if (scope == null && representation.getScopeName() !=null )
            throw new ErrorResponseException("invalid_scope", "Scope [" + representation.getScopeName() + "] is invalid", Response.Status.BAD_REQUEST);

        boolean match = resource.getScopes().contains(scope);

        if (!match)
           throw new ErrorResponseException("invalid_resource_id", "Resource set with id [" + representation.getResource() + "] does not have Scope [" + scope.getName() + "]", Response.Status.BAD_REQUEST);     
        
        Map<String, String> attributes = new HashMap<String, String>();
        attributes.put(PermissionTicket.RESOURCE, resource.getId());
        attributes.put(PermissionTicket.SCOPE, scope.getId());
        attributes.put(PermissionTicket.REQUESTER, user.getId());
        
        if (!ticketStore.find(attributes, resourceServer.getId(), -1, -1).isEmpty())
            throw new ErrorResponseException("invalid_permission", "Permission already exists", Response.Status.BAD_REQUEST);
        
        PermissionTicket ticket = ticketStore.create(resource.getId(), scope.getId(), user.getId(), resourceServer);
        if(representation.isGranted())
                ticket.setGrantedTimestamp(java.lang.System.currentTimeMillis());
        representation = ModelToRepresentation.toRepresentation(ticket, authorization);
        return Response.ok(representation).build();
    }

delete()

Response org.keycloak.authorization.protection.permission.PermissionTicketService.delete ( @PathParam("id") String  id )

inline

                                                       {
        if (id == null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_ticket", Response.Status.BAD_REQUEST);
        }

        PermissionTicketStore ticketStore = authorization.getStoreFactory().getPermissionTicketStore();
        PermissionTicket ticket = ticketStore.findById(id, resourceServer.getId());

        if (ticket == null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_ticket", Response.Status.BAD_REQUEST);
        }
        
        if (!ticket.getOwner().equals(this.identity.getId()) && !this.identity.isResourceServer() && !ticket.getRequester().equals(this.identity.getId()))
            throw new ErrorResponseException("not_authorised", "permissions for [" + ticket.getResource() + "] can be deleted only by the owner, the requester, or the resource server", Response.Status.FORBIDDEN);

        ticketStore.delete(id);

        return Response.noContent().build();
    }

find()

Response org.keycloak.authorization.protection.permission.PermissionTicketService.find ( @QueryParam("scopeId") String  scopeId, @QueryParam("resourceId") String  resourceId, @QueryParam("owner") String  owner, @QueryParam("requester") String  requester, @QueryParam("granted") Boolean  granted, @QueryParam("returnNames") Boolean  returnNames, @QueryParam("first") Integer  firstResult, @QueryParam("max") Integer  maxResult  )

inline

                                                               {
        StoreFactory storeFactory = authorization.getStoreFactory();
        PermissionTicketStore permissionTicketStore = storeFactory.getPermissionTicketStore();

        Map<String, String> filters = new HashMap<>();

        if (resourceId != null) {
            filters.put(PermissionTicket.RESOURCE, resourceId);
        }

        if (scopeId != null) {
            ScopeStore scopeStore = storeFactory.getScopeStore();
            Scope scope = scopeStore.findById(scopeId, resourceServer.getId());

            if (scope == null) {
                scope = scopeStore.findByName(scopeId, resourceServer.getId());
            }

            filters.put(PermissionTicket.SCOPE, scope != null ? scope.getId() : scopeId);
        }

        if (owner != null) {
            filters.put(PermissionTicket.OWNER, getUserId(owner));
        }

        if (requester != null) {
            filters.put(PermissionTicket.REQUESTER, getUserId(requester));
        }

        if (granted != null) {
            filters.put(PermissionTicket.GRANTED, granted.toString());
        }

        return Response.ok().entity(permissionTicketStore.find(filters, resourceServer.getId(), firstResult != null ? firstResult : -1, maxResult != null ? maxResult : Constants.DEFAULT_MAX_RESULTS)
                    .stream()
                        .map(permissionTicket -> ModelToRepresentation.toRepresentation(permissionTicket, authorization, returnNames == null ? false : returnNames))
                        .collect(Collectors.toList()))
                .build();
    }

getUserId()

String org.keycloak.authorization.protection.permission.PermissionTicketService.getUserId ( String  userIdOrName )

inlineprivate

                                                  {
        UserProvider userProvider = authorization.getKeycloakSession().users();
        RealmModel realm = authorization.getRealm();
        UserModel userModel = userProvider.getUserById(userIdOrName, realm);

        if (userModel != null) {
            return userModel.getId();
        }

        userModel = userProvider.getUserByUsername(userIdOrName, realm);

        if (userModel != null) {
            return userModel.getId();
        }

        return userIdOrName;
    }

update()

Response org.keycloak.authorization.protection.permission.PermissionTicketService.update ( PermissionTicketRepresentation  representation )

inline

                                                                          {
        if (representation == null || representation.getId() == null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_ticket", Response.Status.BAD_REQUEST);
        }

        PermissionTicketStore ticketStore = authorization.getStoreFactory().getPermissionTicketStore();
        PermissionTicket ticket = ticketStore.findById(representation.getId(), resourceServer.getId());

        if (ticket == null) {
            throw new ErrorResponseException(OAuthErrorException.INVALID_REQUEST, "invalid_ticket", Response.Status.BAD_REQUEST);
        }
        
        if (!ticket.getOwner().equals(this.identity.getId()) && !this.identity.isResourceServer())
            throw new ErrorResponseException("not_authorised", "permissions for [" + representation.getResource() + "] can be updated only by the owner or by the resource server", Response.Status.FORBIDDEN);

        RepresentationToModel.toModel(representation, resourceServer.getId(), authorization);

        return Response.noContent().build();
    }

メンバ詳解

authorization

final AuthorizationProvider org.keycloak.authorization.protection.permission.PermissionTicketService.authorization

private

identity

final KeycloakIdentity org.keycloak.authorization.protection.permission.PermissionTicketService.identity

private

resourceServer

final ResourceServer org.keycloak.authorization.protection.permission.PermissionTicketService.resourceServer

private

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authorization/protection/permission/PermissionTicketService.java