RubyRuby V4 Access Manager API Reference for Realtime Apps

Go to Presence


 

These docs are for PubNub 4.0 for Ruby which is our latest and greatest! For the docs of the older versions of the SDK, please check PubNub 3.0 for Ruby.

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

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 subscribe_key applying to all associated channels.
  2. Channel level privileges are based on a combination of subscribe_key and channel name.
  3. User level privileges are based on the combination of subscribe_key, channel and auth_key.
 
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 subscribe_key, 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 subscribe_key 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 subscribe_key, channel and auth_key, 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 auth_key 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 subscribe_key always take precedence over privileges granted to channel or auth_key. 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 subscribe_key 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.
 
When you init with secret_key, you get root permissions for the Access Manager. With this feature you don't have to grant access to your servers to access channel data. The servers get all access on all channels.
 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 Ruby V4 SDK:
  1. ParameterTypeRequiredDescription
    channelsString, Symbol, comma separated listOptionalSpecifies the channels on which to grant permissions.
    If no channels/channelGroups are specified, then the grant applies to any and all channels/channelGroups that have been or will be created for that publish/subscribe key set.
    Furthermore, any existing or future grants on specific channels are ignored, until the all channels grant is revoked.
    It is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.

    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.*.
    channel_groupsString, Symbol, comma separated listOptionalSpecifies the channelGroups to grant permissions. If no channels/channelGroups are specified, then the grant applies to any and all channels/channelGroups that have been or will be created for that publish/subscribe key set.
    Furthermore, any existing or future grants on specific channelGroups are ignored, until the all channelGroups grant is revoked.
    It is possible to grant permissions to multiple channelGroups simultaneously by specifying the channelGroups as a comma separated list.
    auth_keyString, SymbolOptionalSpecifies 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.
    readBooleanOptionalRead permissions.

    Default: true.

    writeBooleanOptionalWrite permissions.

    Default: true.

    manageBooleanOptionalManage permissions.

    Default: true.

    ttlIntegerOptionalTime in minutes for which granted permissions are valid.

    Default is 1440 (24hrs), Max is 525600 , Min is 1. Setting ttl to 0 will apply the grant indefinitely.

    http_syncBooleanOptional

    Default false. Method will be executed asynchronously and will return future, to get it's value you can use value method. If set to true, method will return array of envelopes (even if there's only one envelope).

    For sync methods Envelope object will be returned.

    callbackLambda accepting one parameterOptional

    Callback that will be called for each envelope.

    For async methods future will be returned, to retrieve value Envelope object you have to call value method (thread will be locked until the value is returned).

pubnub.grant(channels: 'my_channel', ttl: 5, auth_key: 'my_rw_authkey') do |envelope|
	puts envelope
end
#<Pubnub::Envelope:0x007fd384d2c288
	@result = {
		:code => 200,
		:data => { 
			"level" => "user", 
			"subscribe_key" => "sub-c-5f595120-6fe1-11e7-9980-0619f8945a4f", 
			"ttl" => 1440, 
			"channel" => "whatever", 
			"auths" => {
				"someuser" => {
					"r" => 1, 
					"w" => 1, 
					"m" => 1
				}
			}
		}
	},
	@status = {
		:code => 200
	}
>
  1. pubnub.grant(ttl: 60, write: false) do |envelope|
    	puts envelope
    end
  2. pubnub.grant(channels: 'my_channel') do |envelope|
    	puts envelope
    end
    
  3. pubnub.grant(channels: 'my_channel', ttl: 5, auth_key: 'my_ro_authkey', write: false) do |envelope|
    	puts envelope
    end
    The above code would return the following response to the client:
    #<Pubnub::Envelope:0x007fd384d671a8
    	@result = {
    		:code => 200,
    		:data => {
    			"level" => "user", 
    			"subscribe_key" => "sub-c-5f595120-6fe1-11e7-9980-0619f8945a4f", 
    			"ttl" => 5, 
    			"channel" => "my_channel", 
    			"auths" => {
    				"my_ro_authkey" => {
    					"r" => 1, 
    					"w" => 0,
    					"m" => 1
    				}
    			}
    		}
    	},
    	@status = {
    		:code => 200
    	}
    >
  4. pubnub.grant(presence: 'my_channel') do |envelope|
    	puts envelope
    end
  5. To perform a first level wildcard grant for channel groups you need to specify : (colon) as the parameter for channel_groups. This will ensure that users can read or manage all channel groups.
    pubnub.grant(channel_groups: ':') do |envelope|
        puts envelope
    end
  6. pubnub.grant(channels: 'ch1,ch2,ch3,', ttl: 60, auth_key: 'my_auth_key', read: true) do |envelope|
        puts envelope
    end
  7.  

    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.

    # Create PubNub client
    pubnub = Pubnub.new(
        publish_key: 'pub-c-', 
        subscribe_key: 'sub-c-', 
        secret_key: 'sec-c-'
    )
    
    # Additional optional parameters for grant, see: http://www.pubnub.com/docs/ruby/api-reference-access-manager#grant_arg_1
    
    pubnub.grant(http_sync: true)
  8. # Create PubNub client
    pubnub = Pubnub.new(
        publish_key: 'pub-c-', 
        subscribe_key: 'sub-c-', 
        secret_key: 'sec-c-'
    )
    
    # Additional optional parameters for grant, see: http://www.pubnub.com/docs/ruby/api-reference-access-manager#grant_arg_1
    
    pubnub.grant(channels: 'open-channel', http_sync: true)
  9. # Create PubNub client
    pubnub = Pubnub.new(
        publish_key: 'pub-c-', 
        subscribe_key: 'sub-c-', 
        secret_key: 'sec-c-'
    )
    
    # Additional optional parameters for grant, see: http://www.pubnub.com/docs/ruby/api-reference-access-manager#grant_arg_1
    
    pubnub.grant(channels: 'private-channel', auth_key: 'authorized-user', http_sync: true)

Go to Channel Groups