Access Manager v2 API for C# SDK
Access Manager 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.
Grant
Requires Access Manager add-on
This method requires that the Access Manager add-on is enabled for your key in the Admin Portal. See Enable the features your app calls.
This function establishes access permissions for Access Manager 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:
- Application level privileges are based on
SubscribeKeyapplying to all associated channels. - Channel level privileges are based on a combination of
SubscribeKeyandchannelname. - User level privileges are based on the combination of
SubscribeKey,channelandAuthKeys.
NTP configuration
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. See Why do I get "Invalid Timestamp" when I grant permissions?.
Wildcard permissions
Wildcard notation allows you to grant permissions to multiple channels at a time and later revoke these permissions in the same manner. You can only go one level deep using wildcards. In other words:
a.*grants access on all channels that begin witha..*ora.b.*won't work this way. If you grant on*ora.b.*, the grant treats*ora.b.*as a channel name, not a wildcard.
Wildcard revokes
You can revoke permissions with wildcards from one level deep, like a.*, only when you initially used wildcards to grant permissions to a.*.
How Access Manager rules are evaluated
When a user attempts to access a PubNub resource, Access Manager will evaluate any existing rules using the following order of precedence before access to a channel is granted to the user:
-
Application Level - Access Manager privileges are always evaluated first at the Application level. If either
readorwriteattribute is set totruefor aSubscribeKey, Access Manager will immediately grant access for that attribute without proceeding to check permissions at eitherChannelorUserlevels. If an attribute is set tofalseat the Application level, Access Manager 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 userswill have access.Application level grants can also happen due to a bug in your code. For example, Null parameters for channels and auth-keys can cause accidental application level grants.
-
Channel Level - After first verifying an attribute at the Application level, Access Manager evaluates the attribute at the Channel level. If an attribute is set to
truefor a combination ofSubscribeKeyandchannel, Access Manager grants access for that attribute at theChannellevel without proceeding to check whether there may beuserlevel permissions. -
User Level - As a final step Access Manager evaluates the attributes at the
Userlevel. If an attribute is set totrueforSubscribeKey,channelandAuthKeys, access is granted for that attribute.
grant method default
If an argument of the grant is not provided, an expected default will be assumed.
readandwritearguments default tofalse- no
AuthKeysresults inchannel-levelgrant - no
channelresults inapplication-levelgrant
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 Access Manager enabled application.
Privileges hierarchy
Note that privileges specifically granted to an application's SubscribeKey always take precedence over privileges granted to channel or AuthKeys. Therefore an application that requires authentication at the userlevel should not grant access at either the Application or Channel levels.
Related behavior
- History To access historical messages you must grant full
readaccess at either theSubscribeKeyorchannellevel. Note that you must grantreadaccess to each channel in a channel group individually. When a user has the appropriate permissions they can access any data stored. If they do not have access a403will be returned by Access Manager. - Presence To grant access to Presence for a particular channel name you must also allow
readandwriteaccess to the presencechannelname which is specified by adding the-pnpressuffix to the name. Also note that aleavewill fail in the case where a user's grant expires while connected. An HTTP403will be returned. - APNS Standard permissions are required for publishing.
Duration of permissions
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 Access Manager has expired, the read and write attributes are immediately set to false for that entry in the Access Manager table.
Requests size
Access Manager grant or revoke requests must be less than ~32 KiB at a time, or the client will return an error. For requests greater than 32 KiB, break them into smaller batched requests.
Maximum message size
When the message size exceeds 32 KiB the server returns the HTTP Error code 500, instead of the correct error code 414.
Maximum number of channels
The limit on the total amount of channels that you can pass at once when using Grant() is 200.
Category permissions
- A category permission lets a token list all metadata of one resource type on your subscribe key. Valid categories are
channelsanduuids. The only permission isget(32). - A
getpermission on one named channel or user, or on a pattern, does not grant a category. - A token can contain only categories. It needs no resource or pattern.
- When enumeration enforcement is enabled for a keyset, App Context list requests from a token or auth key without the matching category permission return a
403error.
Categories accepts PNGrantCategory.Channels for the channels category and PNGrantCategory.Uuids for the uuids category. When you set categories:
- Use
Get(true)to grant andGet(false)to revoke. Setting any other permission totruethrows anInvalidOperationExceptionbefore the SDK sends the request. AuthKeysmust contain at least one non-empty value.- The
Getpermission also applies to every channel, channel group, and UUID in the same request, because all resources in a request share one set of permissions. - The SDK always sends all permissions, and sends the ones you leave unset as
false. - The server rejects a category grant with
TTL(1)and returns a400error. The SDK doesn't check this before sending.
Method(s)
To Grant Permissions on a Channel you can use the following method(s) in the C# SDK:
1pubnub.Grant().Uuids(Array).Categories(PNGrantCategory[]).Channels(Array).ChannelGroups(Array).AuthKeys(Array).Get(bool).Update(bool).Join(bool).Write(bool).Read(bool).Delete(bool).Manage(bool).TTL(long).QueryParam(Dictionary<string,object>)
Uuids#- Specifies a list of
uuidson which tograntpermissions. You can't grant permissions to channels and channel groups in the same request if you decide to useuuids.
This parameter does not support wildcards. Categories#- Category grants that let the
AuthKeyslist all metadata of a type on the subscribe key.PNGrantCategory.Channelslists all channel metadata andPNGrantCategory.Uuidslists all UUID metadata. Requires at least one non-emptyAuthKeysentry. OnlyGetcan be set in the same request, so settingRead,Write,Manage,Delete,Update, orJointhrows anInvalidOperationException. This applies even whenChannels,ChannelGroups, orUuidsare also set. Other permissions must be sent in a separate request. Refer to Category permissions. Channels#- Specifies the
channelson which tograntpermissions. If nochannels/channelGroupsare specified, then thegrantapplies to any and allchannels/channelGroupsthat have been or will be created for thatpublish/subscribekey set. Furthermore, any existing or future grants on specificchannelsare ignored, until theall channelsgrant is revoked. It is possible tograntpermissions to multiplechannelssimultaneously.Wildcard notation likea.*can be used tograntaccess on channels. You cangrantone level deep.a.*- you can grant on this.*anda.b.*- grant will not work on these levels. If you grant on*ora.b.*, the grant will treat*ora.b.*as a single channel named either*ora.b.*.
ChannelGroups#- Specifies the
channelGroupstograntpermissions. If nochannels/channelGroupsare specified, then thegrantapplies to any and allchannels/channelGroupsthat have been or will be created for thatpublish/subscribekey set. Furthermore, any existing or future grants on specificchannelGroupsare ignored, until theall channelGroupsgrant is revoked. It is possible tograntpermissions to multiplechannelGroupssimultaneously.
This parameter does not support wildcards. AuthKeys#- Specifies
authKey to grant permissions. It is possible to specify multipleauthkeys. You can also grant access to a singleauthkey for multiplechannelsat the same time. Zero or morechannelswith zero or moreauthtokens are allowed. Get#Getpermission.Update#Updatepermission.Join#Joinpermission.Write#Writepermission.Read#Readpermission.Delete#Deletepermission.Manage#Managepermission.TTL#Time to livefor permission to be validQueryParam#- Dictionary
objectto pass name/value pairs as querystringparams with PubNub URL request for debug purpose. Async#PNCallbackof typePNAccessManagerGrantResultExecuterequired#PNCallbackof typePNAccessManagerGrantResultExecuteAsync#- Returns
PNResult<PNAccessManagerGrantResult>.
Sample code
Grant Access Manager permissions for channel and AuthKeys
1
Returns
The Grant() operation returns a PNResult<PNAccessManagerGrantResult> which contains the following properties:
| Property Name | Type | Description |
|---|---|---|
Result | PNAccessManagerGrantResult | Returns a PNAccessManagerGrantResult object. |
Status | PNStatus | Returns a PNStatus object. |
PNAccessManagerGrantResult contains the following properties:
| Property Name | Type | Description |
|---|---|---|
Level | string | Subkey or channel level. |
Ttl | int | Ttl of grant. |
SubscribeKey | string | The SubscribeKey. |
Channels | Dictionary<string, Dictionary<string, PNAccessManagerKeyData>> | Access rights per channel. See PNAccessManagerKeyData for more details. |
ChannelGroups | Dictionary<string, Dictionary<string, PNAccessManagerKeyData>> | Access rights per channel group. See PNAccessManagerKeyData for more details. |
Categories | Dictionary<string, Dictionary<string, PNAccessManagerKeyData>> | Category-level access rights, keyed channels and uuids, then by auth key. See PNAccessManagerKeyData for more details. null unless the response contains categories. |
PNAccessManagerKeyData
| Property Name | Type | Description |
|---|---|---|
ReadEnabled | bool | true if the user has read rights. |
WriteEnabled | bool | true if the user has write rights. |
DeleteEnabled | bool | true if the user has delete rights. |
ManageEnabled | bool | true if the user has manage rights. |
GetEnabled | bool | true if the user has get rights. This is the only permission set for category grants. |
Other examples
Grant Access Manager permissions for channel and AuthKeys synchronously
1
Grant subscribe access to a channel only for clients with a specific AuthKeys with a 5 minute ttl
1
The above code would return the following response to the client:
1{
2 "status" : 200,
3 "message" : "Success",
4 "payload" : {
5 "ttl" : 5,
6 "auths" : {
7 "my_ro_authkey" : {
8 "r" : 1,
9 "w" : 0,
10 "d" : 0
11 }
12 },
13 "subscribe_key" : "my_subkey",
14 "level" : "user",
15 "channel" : "my_channel"
show all 18 linesAllow access to a specific channel for Presence
1
Grant access to list all channel and UUID metadata
The code below allows my_authkey to list all channel and UUID metadata on the subscribe key. It then revokes the same categories with Get(false).
1
Grant Access Manager permissions for channel group
1
The above code would return the following response to the client:
1{
2 "status":200,
3 "message":"Success",
4 "payload":{
5 "ttl":5,
6 "auths":{
7 "my_rw_authkey":{
8 "r":1,
9 "w":1,
10 "d":1
11 }
12 },
13 "subscribe_key":"my_subkey",
14 "level":"user",
15 "channel":"my_channel"
show all 18 linesGrant get, update, and delete access to a uuid only for clients with a specific AuthKeys with a 24 hrs ttl
1
Application level grant
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. For example, Null parameters for channels and auth-keys can cause accidental application level grants.
1
Channel level grant
1
User level grant
1