PHPPHP V4 Access Manager API Reference for Realtime Apps

 

These docs are for PubNub 4.x for PHP which is our latest and greatest! For the docs of the older versions of the SDK, please check PubNub 3.x for PHP.

If you have questions about the PubNub for PHP SDK, please contact us at support@pubnub.com.

PubNub Access Manager (PAM) extends PubNub's existing security framework by allowing developers to create and enforce secure access to channels and channel groups throughout the PubNub Real-Time Network.

As soon as Access Manager is enabled, no pub/sub-operations can be done without first explicitly providing an authorization token to the PubNub object. If an invalid token is provided, the requesting client will receive a Forbidden Error.

Learn more about Access Manager here.


Requires Access Manager add-on XRequires that the Access Manager add-on is enabled for your key. See this page on enabling add-on features on your keys:

http://www.pubnub.com/knowledge-base/discussion/644/how-do-i-enable-add-on-features-for-my-keys.
This function establishes access permissions for PubNub Access Manager (PAM) by setting the read or write attribute to true. A grant with read or write set to false (or not included) will revoke any previous grants with read or write set to true.
Permissions can be applied to any one of three levels:
  1. Application level privileges are based on subscribeKey applying to all associated channels.
  2. Channel level privileges are based on a combination of subscribeKey and channel name.
  3. User level privileges are based on the combination of subscribeKey, channel and AuthKey.
 
For NTP synchronization, please ensure that you have configured NTP on your server to keep the clock in sync. This is to prevent system clock drift leading to 400 Invalid Timestamp error response.
https://support.pubnub.com/support/solutions/articles/14000043626-why-do-i-get-invalid-timestamp-when-i-try-to-grant-permission-using-access-manager-
When a user attempts to access a PubNub resource, PAM will evaluate any existing rules using the following order of precedence before access to a channel is granted to the user:
  1. Application Level - PAM privileges are always evaluated first at the Application level. If either read or write attribute is set to true for a subscribeKey, PAM will immediately grant access for that attribute without proceeding to check permissions at either Channel or User levels. If an attribute is set to false at the Application level, PAM proceeds to evaluate the attribute at the next most granular level.
     

    Use application level grants with caution

    When access is granted on an application level, all channels and users will have access.

    Application level grants can also happen due to a bug in your code. e.g. Null parameters for channels and auth-keys can cause accidental application level grants.

  2. Channel Level - After first verifying an attribute at the Application level, PAM evaluates the attribute at the Channel level. If an attribute is set to true for a combination of subscribeKey and channel, PAM grants access for that attribute at the Channel level without proceeding to check whether there may be user level permissions.
  3. User Level - As a final step PAM evaluates the attributes at the User level. If an attribute is set to true for subscribeKey, channel and AuthKey, access is granted for that attribute.
 
If an argument of the grant is not provided, an expected default will be assumed.
  • read and write arguments default to false.
  • no AuthKey results in channel-level grant.
  • no channel results in application-level grant.
No Permissions - If no permissions were granted at any of the three levels, the user will be denied access to the PubNub resource and receive a 403 error message. This is the default behavior for a PAM enabled application.
 
Note that privileges specifically granted to an application's subscribeKey always take precedence over privileges granted to channel or AuthKey. Therefore an application that requires authentication at the userlevel should not grant access at either the Application or Channel levels.
  • History: To access historical messages you must grant full read access at either the subscribeKey or channel level. When a user has the appropriate permissions they can access any data stored. If they do not have access a 403 will be returned by PAM.
  • Presence: To grant access to Presence for a particular channel name you must also allow read and write access to the presence channel name which is specified by adding the -pnpres suffix to the name. Also note that a leave will fail in the case where a user's grant expires while connected. An HTTP 403 will be returned.
  • APNS: Standard permissions are required for publishing.
The duration of permission set with grant() are controlled by setting a time-to-live(TTL). If a TTL is not specified it is automatically set to 1440 minutes by default. Once the TTL associated with an entry in PAM has expired, the read and write attributes are immediately set to false for that entry in the PAM table.
 
PAM grant or revoke requests must be less than ~32KB at a time, or the client will return an error. For requests greater than 32KB, break them into smaller batched requests.
 
When the message size exceeds 32KB the server returns the HTTP Error code 500, instead of the correct error code 414.
 The limit on the total amount of channels that you can pass at once when using grant() is 200.
To Grant Permissions on a Channel you can use the following method(s) in the PHP V4 SDK
  1. ParameterTypeRequiredDescription
    readBooleanYesRead permissions are granted by setting to True. Read permissions are removed by setting to False.
    default: False
    writeBooleanYesWrite permissions are granted by setting to true. Write permissions are removed by setting to false.
    default: False
    channelStringYesThe channel name to grant permissions to.
    If channel is not specified, the grant applies to all channels (current and future).

    Wildcard notation like a.* can be used to grant access on channels. You can grant one level deep.
    • a.* - you can grant on this.
    • a.b.* - grant will not work on this. If you grant on a.b.*, the grant will treat a.b.* as a single channel with name a.b.*.

    auth_keyStringYesSpecifies auth Key to grant permissions.
    It is possible to specify multiple auth keys as comma separated list in combination with a single channel name.
    You can also grant access to a single auth key for multiple channels at the same time.
    Zero or more channels with zero or more auth tokens are allowed.
    ttlIntegerYes Time in minutes for which granted permissions are valid.
      Max : 525600
      Min : 1
    Setting 0 will apply the grant indefinitely (forever grant).
    default: 1440 i.e 24 hrs.
require_once _DIR_ . '/../src/autoloader.php';
require_once _DIR_ . '/../vendor/autoload.php';
$pnconfig = new \PubNub\PNConfiguration();
$pnconfig->setSecretKey("demo");
$pnconfig->setPublishKey("demo");
$pnconfig->setSubscribeKey("demo");
$pubnub = new \PubNub\PubNub($pnconfig);
$channel_comma_list = ['ch1', 'ch2'];
$auth_key = "blah";
$read = true;
$write = false;
$ttl_mins = 15;
try { 
	$result = $pubnub->grant()
	              ->channels($channel_comma_list) 
				  ->authKeys($auth_key) 
				  ->read($read) 
				  ->write($write) 
				  ->ttl($ttl_mins)
				  ->sync(); 
} catch (\PubNub\Exceptions\PubNubServerException $exception) { 
	print_r("Message: " . $exception->getMessage() . "\n"); 
	print_r("Status: " . $exception->getStatusCode() . "\n"); 
	echo "Original message: "; print_r($exception->getBody()); 
} catch (\PubNub\Exceptions\PubNubException $exception) {
	print_r("Message: " . $exception->getMessage()); 
}
The grant() operation returns a PNAccessManagerGrantResult which contains the following fields:
MethodTypeDescription
getLevel()StringPermissions level, one of subkey, subkey+auth, channel, channel-group, channel-group + auth level.
getTtl()Integerttl of grant.
getSubscribeKey()StringThe subscribe key.
getChannels()ArrayAccess rights per channel. See PNAccessManagerChannelData for more details.
isReadEnabled()Booleansubkey level read permissions.
isWriteEnabled()Booleansubkey level write permissions.
isManageEnabled()Booleansubkey level manage permissions.
getTtl()IntegerTime to live value.

PNAccessManagerChannelData and PNAccessManagerGroupData has the same fields structure.

MethodTypeDescription
getAuthKeys()ArrayAccess rights per auth-key. See PNAccessManagerKeyData for more details.
getName()StringChannel or group name.
isReadEnabled()BooleanChannel or group level read permissions.
isWriteEnabled()BooleanChannel or group level write permissions.
isManageEnabled()BooleanChannel or group level manage permissions.
getTtl()IntegerTime to live value.
MethodTypeDescription
isReadEnabled()Booleanauth-key read permissions.
isWriteEnabled()Booleanauth-key write permissions.
isManageEnabled()Booleanauth-key manage permissions.
getTtl()IntegerTime to live value.

read, write and manage permissions has 3 states:

  1. true if enabled.
  2. false if disabled.
  3. None if not explicitly set.
  1. $pubnub->grant()
        ->read(true)
        ->write(true)
        ->sync();
  2. $pubnub->grant()
        ->channels("my_channel")
        ->read(true)
        ->write(true)
        ->sync();
  3. $pubnub->grant()
        ->channels("my_channel")
        ->read(false)
        ->write(true)
        ->authKeys("my_ro_authkey")
        ->ttl(5)
        ->sync();
    The above code would return the following response to the client:
    
    {
    	"status" : 200,
    	"message" : "Success",
    	"payload" : {
    		"ttl" : 5,
    		"auths" : {
    			"my_ro_authkey" : {
    				"r" : 1,
    				"w" : 0,
    				"d" : 0
    			}
    		},
    		"subscribe_key" : "my_subkey",
    		"level" : "user",
    		"channel" : "my_channel"
    	},
    	"service" : "Access Manager"
    }
    
  4. $pubnub->grant()
        ->channels("my_channel-pnpres")
        ->read(true)
        ->write(true)
        ->sync();
  5. $result = $pubnub->grant()
                  ->channelGroups(["cg1", "cg2", "cg3"])
                  ->authKeys(["key1", "key2", "auth3"])
                  ->read(true)
                  ->write(true)
                  ->manage(true)
                  ->ttl(12237)
                  ->sync();
    The above code would return the following response to the client:
    
    {
        "status":200,
        "message":"Success",
        "payload":{
            "ttl":5,
            "auths":{
                "my_rw_authkey":{
                    "r":1,
                    "w":1,
                    "d":1
                }
            },
            "subscribe_key":"my_subkey",
            "level":"user",
            "channel":"my_channel"
        },
        "service":"Access Manager"
    }
    
  6.  

    Use application level grants with caution

    When access is granted on an application level, all channels and users will have access.

    Application level grants can also happen due to a bug in your code. e.g. Null parameters for channels and auth-keys can cause accidental application level grants.

    try {
        $result = $pubnub->grant()
            ->read(true)
            ->write(true)
            ->sync();
    
        print_r($result);
    } catch (\PubNub\Exceptions\PubNubServerException $exception) {
        print_r($exception->getMessage() . "\n");
        print_r($exception->getStatusCode() . "\n");
        print_r($exception->getBody());
    } catch (\PubNub\Exceptions\PubNubException $exception) {
        print_r($exception->getMessage());
    }
  7. $result = $pubnub->grant()
                  ->channels("my_channel")
                  ->read(true)
                  ->write(true)
                  ->sync();
  8. $result = $pubnub->grant()
                  ->channels("my_channel")
                  ->authKeys("my_authkey")
                  ->read(true)
                  ->write(true)
                  ->ttl(5)
                  ->sync();