org.apache.pulsar.broker.authorization

Class AuthorizationService

java.lang.Object

org.apache.pulsar.broker.authorization.AuthorizationService

public class AuthorizationService
extends Object

Authorization service that manages pluggable authorization provider and authorize requests accordingly.

Constructor Summary

Constructors

Constructor and Description
AuthorizationService(ServiceConfiguration conf, ConfigurationCacheService configCache)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	allowFunctionOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, String role, AuthenticationDataSource authenticationData)
boolean	allowNamespaceOperation(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.NamespaceOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowNamespaceOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.NamespaceOperation operation, String role, AuthenticationDataSource authData) Grant authorization-action permission on a namespace to the given client
CompletableFuture<Boolean>	allowNamespaceOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.NamespaceOperation operation, String originalRole, String role, AuthenticationDataSource authData)
boolean	allowNamespacePolicyOperation(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowNamespacePolicyOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String role, AuthenticationDataSource authData) Grant authorization-action permission on a namespace to the given client
CompletableFuture<Boolean>	allowNamespacePolicyOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowSinkOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, String role, AuthenticationDataSource authenticationData)
CompletableFuture<Boolean>	allowSourceOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName, String role, AuthenticationDataSource authenticationData)
boolean	allowTenantOperation(String tenantName, org.apache.pulsar.common.policies.data.TenantOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowTenantOperationAsync(String tenantName, org.apache.pulsar.common.policies.data.TenantOperation operation, String role, AuthenticationDataSource authData) Grant authorization-action permission on a tenant to the given client
CompletableFuture<Boolean>	allowTenantOperationAsync(String tenantName, org.apache.pulsar.common.policies.data.TenantOperation operation, String originalRole, String role, AuthenticationDataSource authData)
Boolean	allowTopicOperation(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.TopicOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowTopicOperationAsync(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.TopicOperation operation, String role, AuthenticationDataSource authData) Grant authorization-action permission on a topic to the given client
CompletableFuture<Boolean>	allowTopicOperationAsync(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.TopicOperation operation, String originalRole, String role, AuthenticationDataSource authData)
Boolean	allowTopicPolicyOperation(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String originalRole, String role, AuthenticationDataSource authData)
CompletableFuture<Boolean>	allowTopicPolicyOperationAsync(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String role, AuthenticationDataSource authData) Grant authorization-action permission on a topic to the given client
CompletableFuture<Boolean>	allowTopicPolicyOperationAsync(org.apache.pulsar.common.naming.TopicName topicName, org.apache.pulsar.common.policies.data.PolicyName policy, org.apache.pulsar.common.policies.data.PolicyOperation operation, String originalRole, String role, AuthenticationDataSource authData)
boolean	canConsume(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData, String subscription)
CompletableFuture<Boolean>	canConsumeAsync(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData, String subscription) Check if the specified role has permission to receive messages from the specified fully qualified topic name.
boolean	canLookup(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData) Check whether the specified role can perform a lookup for the specified topic.
CompletableFuture<Boolean>	canLookupAsync(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData) Check whether the specified role can perform a lookup for the specified topic.
boolean	canProduce(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData)
CompletableFuture<Boolean>	canProduceAsync(org.apache.pulsar.common.naming.TopicName topicName, String role, AuthenticationDataSource authenticationData) Check if the specified role has permission to send messages to the specified fully qualified topic name.
CompletableFuture<Void>	grantPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace, Set<org.apache.pulsar.common.policies.data.AuthAction> actions, String role, String authDataJson) Grant authorization-action permission on a namespace to the given client
CompletableFuture<Void>	grantPermissionAsync(org.apache.pulsar.common.naming.TopicName topicname, Set<org.apache.pulsar.common.policies.data.AuthAction> actions, String role, String authDataJson) Grant authorization-action permission on a topic to the given client
CompletableFuture<Void>	grantSubscriptionPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace, String subscriptionName, Set<String> roles, String authDataJson) Grant permission to roles that can access subscription-admin api
CompletableFuture<Boolean>	isSuperUser(String user, AuthenticationDataSource authenticationData)
CompletableFuture<Boolean>	isTenantAdmin(String tenant, String role, org.apache.pulsar.common.policies.data.TenantInfo tenantInfo, AuthenticationDataSource authenticationData)
CompletableFuture<Void>	revokeSubscriptionPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace, String subscriptionName, String role, String authDataJson) Revoke subscription admin-api access for a role

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthorizationService

public AuthorizationService(ServiceConfiguration conf,
                            ConfigurationCacheService configCache)
                     throws PulsarServerException

Throws:

PulsarServerException

Method Detail

isSuperUser

public CompletableFuture<Boolean> isSuperUser(String user,
                                              AuthenticationDataSource authenticationData)

isTenantAdmin

public CompletableFuture<Boolean> isTenantAdmin(String tenant,
                                                String role,
                                                org.apache.pulsar.common.policies.data.TenantInfo tenantInfo,
                                                AuthenticationDataSource authenticationData)

grantPermissionAsync

public CompletableFuture<Void> grantPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace,
                                                    Set<org.apache.pulsar.common.policies.data.AuthAction> actions,
                                                    String role,
                                                    String authDataJson)

Grant authorization-action permission on a namespace to the given client

Parameters:

namespace -

actions -

role -

authDataJson - additional authdata in json for targeted authorization provider

Returns:

Throws:

IllegalArgumentException - when namespace not found

IllegalStateException - when failed to grant permission

grantSubscriptionPermissionAsync

public CompletableFuture<Void> grantSubscriptionPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace,
                                                                String subscriptionName,
                                                                Set<String> roles,
                                                                String authDataJson)

Grant permission to roles that can access subscription-admin api

Parameters:

namespace -

subscriptionName -

roles -

authDataJson - additional authdata in json for targeted authorization provider

Returns:

revokeSubscriptionPermissionAsync

public CompletableFuture<Void> revokeSubscriptionPermissionAsync(org.apache.pulsar.common.naming.NamespaceName namespace,
                                                                 String subscriptionName,
                                                                 String role,
                                                                 String authDataJson)

Revoke subscription admin-api access for a role

Parameters:

namespace -

subscriptionName -

role -

Returns:

grantPermissionAsync

public CompletableFuture<Void> grantPermissionAsync(org.apache.pulsar.common.naming.TopicName topicname,
                                                    Set<org.apache.pulsar.common.policies.data.AuthAction> actions,
                                                    String role,
                                                    String authDataJson)

Grant authorization-action permission on a topic to the given client

Parameters:

topicname -

role -

authDataJson - additional authdata in json for targeted authorization provider

Returns:

IllegalArgumentException when namespace not found

Throws:

IllegalStateException - when failed to grant permission

canProduceAsync

public CompletableFuture<Boolean> canProduceAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                  String role,
                                                  AuthenticationDataSource authenticationData)

Check if the specified role has permission to send messages to the specified fully qualified topic name.

Parameters:

topicName - the fully qualified topic name associated with the topic.

role - the app id used to send messages to the topic.

canConsumeAsync

public CompletableFuture<Boolean> canConsumeAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                  String role,
                                                  AuthenticationDataSource authenticationData,
                                                  String subscription)

Check if the specified role has permission to receive messages from the specified fully qualified topic name.

Parameters:

topicName - the fully qualified topic name associated with the topic.

role - the app id used to receive messages from the topic.

subscription - the subscription name defined by the client

canProduce

public boolean canProduce(org.apache.pulsar.common.naming.TopicName topicName,
                          String role,
                          AuthenticationDataSource authenticationData)
                   throws Exception

Throws:

Exception

canConsume

public boolean canConsume(org.apache.pulsar.common.naming.TopicName topicName,
                          String role,
                          AuthenticationDataSource authenticationData,
                          String subscription)
                   throws Exception

Throws:

Exception

canLookup

public boolean canLookup(org.apache.pulsar.common.naming.TopicName topicName,
                         String role,
                         AuthenticationDataSource authenticationData)
                  throws Exception

Check whether the specified role can perform a lookup for the specified topic. For that the caller needs to have producer or consumer permission.

Parameters:

topicName -

role -

Returns:

Throws:

Exception

canLookupAsync

public CompletableFuture<Boolean> canLookupAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                 String role,
                                                 AuthenticationDataSource authenticationData)

Check whether the specified role can perform a lookup for the specified topic. For that the caller needs to have producer or consumer permission.

Parameters:

topicName -

role -

Returns:

Throws:

Exception

allowFunctionOpsAsync

public CompletableFuture<Boolean> allowFunctionOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                        String role,
                                                        AuthenticationDataSource authenticationData)

allowSourceOpsAsync

public CompletableFuture<Boolean> allowSourceOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                      String role,
                                                      AuthenticationDataSource authenticationData)

allowSinkOpsAsync

public CompletableFuture<Boolean> allowSinkOpsAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                    String role,
                                                    AuthenticationDataSource authenticationData)

allowTenantOperationAsync

public CompletableFuture<Boolean> allowTenantOperationAsync(String tenantName,
                                                            org.apache.pulsar.common.policies.data.TenantOperation operation,
                                                            String role,
                                                            AuthenticationDataSource authData)

Grant authorization-action permission on a tenant to the given client

Parameters:

tenantName - tenant name

operation - tenant operation

role - role name

authData - additional authdata in json for targeted authorization provider

Returns:

IllegalArgumentException when tenant not found

Throws:

IllegalStateException - when failed to grant permission

allowTenantOperationAsync

public CompletableFuture<Boolean> allowTenantOperationAsync(String tenantName,
                                                            org.apache.pulsar.common.policies.data.TenantOperation operation,
                                                            String originalRole,
                                                            String role,
                                                            AuthenticationDataSource authData)

allowTenantOperation

public boolean allowTenantOperation(String tenantName,
                                    org.apache.pulsar.common.policies.data.TenantOperation operation,
                                    String originalRole,
                                    String role,
                                    AuthenticationDataSource authData)

allowNamespaceOperationAsync

public CompletableFuture<Boolean> allowNamespaceOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                               org.apache.pulsar.common.policies.data.NamespaceOperation operation,
                                                               String role,
                                                               AuthenticationDataSource authData)

Grant authorization-action permission on a namespace to the given client

Parameters:

namespaceName -

operation -

role -

authData - additional authdata in json for targeted authorization provider

Returns:

IllegalArgumentException when namespace not found

Throws:

IllegalStateException - when failed to grant permission

allowNamespaceOperationAsync

public CompletableFuture<Boolean> allowNamespaceOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                               org.apache.pulsar.common.policies.data.NamespaceOperation operation,
                                                               String originalRole,
                                                               String role,
                                                               AuthenticationDataSource authData)

allowNamespaceOperation

public boolean allowNamespaceOperation(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                       org.apache.pulsar.common.policies.data.NamespaceOperation operation,
                                       String originalRole,
                                       String role,
                                       AuthenticationDataSource authData)

allowNamespacePolicyOperationAsync

public CompletableFuture<Boolean> allowNamespacePolicyOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                                     org.apache.pulsar.common.policies.data.PolicyName policy,
                                                                     org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                                                     String role,
                                                                     AuthenticationDataSource authData)

Grant authorization-action permission on a namespace to the given client

Parameters:

namespaceName -

operation -

role -

authData - additional authdata in json for targeted authorization provider

Returns:

IllegalArgumentException when namespace not found

Throws:

IllegalStateException - when failed to grant permission

allowNamespacePolicyOperationAsync

public CompletableFuture<Boolean> allowNamespacePolicyOperationAsync(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                                                     org.apache.pulsar.common.policies.data.PolicyName policy,
                                                                     org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                                                     String originalRole,
                                                                     String role,
                                                                     AuthenticationDataSource authData)

allowNamespacePolicyOperation

public boolean allowNamespacePolicyOperation(org.apache.pulsar.common.naming.NamespaceName namespaceName,
                                             org.apache.pulsar.common.policies.data.PolicyName policy,
                                             org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                             String originalRole,
                                             String role,
                                             AuthenticationDataSource authData)

allowTopicPolicyOperationAsync

public CompletableFuture<Boolean> allowTopicPolicyOperationAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                                 org.apache.pulsar.common.policies.data.PolicyName policy,
                                                                 org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                                                 String role,
                                                                 AuthenticationDataSource authData)

Grant authorization-action permission on a topic to the given client

Parameters:

topicName -

policy -

operation -

role -

authData - additional authdata in json for targeted authorization provider

Throws:

IllegalStateException - when failed to grant permission

allowTopicPolicyOperationAsync

public CompletableFuture<Boolean> allowTopicPolicyOperationAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                                 org.apache.pulsar.common.policies.data.PolicyName policy,
                                                                 org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                                                 String originalRole,
                                                                 String role,
                                                                 AuthenticationDataSource authData)

allowTopicPolicyOperation

public Boolean allowTopicPolicyOperation(org.apache.pulsar.common.naming.TopicName topicName,
                                         org.apache.pulsar.common.policies.data.PolicyName policy,
                                         org.apache.pulsar.common.policies.data.PolicyOperation operation,
                                         String originalRole,
                                         String role,
                                         AuthenticationDataSource authData)

allowTopicOperationAsync

public CompletableFuture<Boolean> allowTopicOperationAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                           org.apache.pulsar.common.policies.data.TopicOperation operation,
                                                           String role,
                                                           AuthenticationDataSource authData)

Grant authorization-action permission on a topic to the given client

Parameters:

topicName -

operation -

role -

authData - additional authdata in json for targeted authorization provider

Returns:

IllegalArgumentException when namespace not found

Throws:

IllegalStateException - when failed to grant permission

allowTopicOperationAsync

public CompletableFuture<Boolean> allowTopicOperationAsync(org.apache.pulsar.common.naming.TopicName topicName,
                                                           org.apache.pulsar.common.policies.data.TopicOperation operation,
                                                           String originalRole,
                                                           String role,
                                                           AuthenticationDataSource authData)

allowTopicOperation

public Boolean allowTopicOperation(org.apache.pulsar.common.naming.TopicName topicName,
                                   org.apache.pulsar.common.policies.data.TopicOperation operation,
                                   String originalRole,
                                   String role,
                                   AuthenticationDataSource authData)