Access Manager v2 API for Go SDK
Access Manager allows you to enforce secure controls for client access to resources within the PubNub network. With Access Manager, your servers can grant their clients access to individual PubNub resources for a limited duration, with the ability to extend access or add permissions for additional resources.
As soon as Access Manager is enabled, no publish/subscribe 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.
For more information about Access Manager, refer to Managing Permissions with Access Manager.
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.
The grant method allows you to grant permissions for one or more resources to one or more authKeys. You may need to make multiple grant calls with an authKey so that you can specify explicit permissions for each channel, channelGroup and uuid resources. For common permissions, you can normally use a single request.
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 user level should not grant access at either the Application or Channel levels. View the Grant Levels section for more details.
Permissions
The grant request allows your server to securely grant access for your clients on the following resources within the platform. Each resource allows a limited set of permissions that control the operations that can be performed by the clients. For permissions and API operations mapping information, refer to Managing Permissions with Access Manager.
| Resource | Permissions |
|---|---|
channel | read, write, get, manage, update, join, delete |
uuid | get, update, delete |
channelGroup | read, manage |
category (channels, uuids) | get only |
In Grant(), the category resource maps to the channels and uuids categories in the request.
- 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.
When you set Categories:
- Call
Get(true)to grant the category. CallGet(false)with the sameCategoriesandAuthKeysto revoke it. If you don't callGet(), the SDK sends nogetpermission and the grant gives nothing. - The SDK sends
read,write,manage, anddeleteas0or1, and sendsget,update, andjoinonly when you set them. - The SDK rejects the request before sending it if you set any permission other than
gettotrue. - The server returns a
400error for a category grant withgetset totrueand attlof1. The SDK doesn't check this before sending.
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.*.
Grant levels
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
Applicationlevel. If eitherreadorwriteattribute 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. - 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 ofSubscribeKey, andchannel, Access Manager grants access for that attribute at theChannellevel without proceeding to check whether there may beuserlevel permissions. - User Level (Recommended) - As a final step Access Manager evaluates the attributes at the
Userlevel. If an attribute is set totrueforSubscribeKey,channelandAuthKey, access is granted for that attribute. Similarly, user level grants also allow you granting anAuthKeyaccess tochannelGroupsanduuids. User level grants requireAuthKeyand are the recommended approach if you need to manage permissions for individual users within your application. Each user should be assigned a uniqueAuthKeyand securely passed back to the user to perform operations on the platform.
Method(s)
To Grant Permissions on a Channel you can use the following method(s) in the Go SDK:
1pn.Grant()
2.Uuids([]string)
3.Channels([]string)
4.ChannelGroups([]string)
5.AuthKeys([]string)
6.Read(bool)
7.Write(bool)
8.Manage(bool)
9.Get(bool)
10.Update(bool)
11.Join(bool)
12.Categories([]PNGrantCategory)
13.TTL(int)
14.QueryParam(queryParam)
15.Execute()
Uuids#- Specifies a list of
uuidson which to grant permissions. 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. 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. Read#Readpermissions are granted by setting totrue.Readpermissions are removed by setting tofalse.Write#Writepermissions are granted by setting totrue.Writepermissions are removed by setting tofalse.Delete#Deletepermissions are granted by setting totrue.Deletepermissions are removed by setting tofalse.Manage#Managepermissions are granted by setting totrue.Managepermissions are removed by setting tofalse.Get#Getpermissions are granted by setting totrue.Getpermissions are removed by setting tofalse.Update#Updatepermissions are granted by setting totrue.Updatepermissions are removed by setting tofalse.Join#Joinpermissions are granted by setting totrue.Joinpermissions are removed by setting tofalse.Categories#- Category grants that let the token list all metadata of a type on the subscribe key.
PNGrantCategoryChannelslists all channel metadata.PNGrantCategoryUUIDslists all uuid metadata. Requires at least oneAuthKeysentry. OnlyGetcan be set in the same request. SettingRead,Write,Manage,Delete,Update, orJointotruereturns a validation error. This applies even whenChannels,ChannelGroups, orUuidsare also set. Other permissions must be sent in a separate request. The SDK doesn't validate the one-minuteTTLrule, so the server returns the error. TTL#- Time in minutes for which granted permissions are valid. Default is
1440 (24hrs), Max is525600, Min is1. SettingTTLto0will apply the grant indefinitely. QueryParam#- QueryParam accepts a map, the keys and values of the map are passed as the query string parameters of the URL called by the API.
Sample code
Grant Access Manager permissions for channel and AuthKey
1res, status, err := pn.Grant().
2 Channels([]string{"ch1", "ch2", "ch3"}). // channels to allow grant on
3 ChannelGroups([]string{"cg1", "cg2", "cg3"}). // groups to allow grant on
4 AuthKeys([]string{"my-key"}). // the keys we are provisioning
5 Read(true). // allow those keys to write (false by default)
6 Write(true). // allow those keys to manage channel groups (false by default)
7 Manage(true). // allow keys to read the subscribe feed (false by default)
8 TTL(123). // how long those keys will remain valid (0 for eternity)
9 Execute()
10
11fmt.Println(res, status, err)
Response
The grant() operation returns a PNAccessManagerGrantResult which contains the following fields:
Level#- Permissions level, one of
subkey,subkey+auth,channel,channel-group,channel-group+authlevel. TTL#TTLof grant.SubscribeKey#- The
subscribe key. Channels#- Access rights per channel. See PNAccessManagerChannelData for more details.
ChannelGroups#- Access rights per channel groups. See PNAccessManagerChannelData for more details.
ReadEnabled#- subkey level
readpermissions. WriteEnabled#- subkey level
writepermissions. DeleteEnabled#- subkey level
deletepermissions. ManageEnabled#- subkey level
managepermissions. Categories#- Category-level grants keyed by
channelsanduuids. Present only whenCategorieswas requested in the grant.
PNPAMEntityData
AuthKeys#- Access rights per auth-key. See PNAccessManagerKeyData for more details.
Name#- Channel or group
name. ReadEnabled#- Channel or group level
readpermissions. WriteEnabled#- Channel or group level
writepermissions. DeleteEnabled#- Channel or group level
deletepermissions. ManageEnabled#- Channel or group level
managepermissions. GetEnabled#- Channel, group, or category level
getpermissions. For a category, this is the only meaningful permission. UpdateEnabled#- Channel or group level
updatepermissions. JoinEnabled#- Channel or group level
joinpermissions. TTL#- Time to live value.
PNAccessManagerKeyData
Response parsing errors
The SDK checks the grant response before it builds a PNAccessManagerGrantResult. If the payload is malformed, Execute() returns a nil result and a non-nil error of type *pnerr.ResponseParsingError. A payload is malformed when it is missing, null, or not an object, or when a permission, TTL, channel, channel group, or auth key entry has an unexpected type. The OrigError field of the error names the field that failed, and the Body field holds the raw response. Check err before you use the result.
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. When the message size exceeds 32 KiB the server returns the HTTP Error code 500, instead of the correct error code 414.
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?.
Other examples
Grant an auth key access to list all channel and UUID metadata
The code below grants my_authkey the get category permission for both Channels and UUIDs, with a 15 minute TTL.
1
Grant subscribe privileges to all users on all channel(s) with default TTL (1440 minutes)
1res, status, err := pn.Grant().
2 Read(true).
3 Execute()
4
5fmt.Println(res, status, err)
Allow subscribe and publish to a specific grant subscribe and publish to a specific channel for all users (no AuthKey required) with default TTL (1440 minutes)
1res, status, err := pn.Grant().
2 Channels([]string{"my_channel"}).
3 Read(true).
4 Write(true).
5 Execute()
6
7fmt.Println(res, status, err)
Grant subscribe access to a channel only for clients with a specific AuthKey with a 5 minute TTL
1res, status, err := pn.Grant().
2 Channels([]string{"my_channel"}).
3 Read(true).
4 Write(false).
5 AuthKeys([]string{"my_authkeys"}).
6 TTL(5).
7 Execute()
8
9fmt.Println(res, status, err)
The above code would return the following response to the client:
1{
2 Level:user
3 SubscribeKey:sub-c-90c51098-c040-11e5-a316-0619f8945a4f
4 Ttl:1440
5 Channels:map[
6 my_channel:{
7 Name:ch1
8 AuthKeys:map[
9 my_authkeys:{
10 ReadEnabled:true
11 WriteEnabled:false
12 ManageEnabled:<nil>
13 Ttl:5
14 }
15 ]
show all 26 linesAllow access to a specific channel for Presence
1res, status, err := pn.Grant().
2 Channels([]string{"my_channel-pnpres"}).
3 Read(false).
4 Write(true).
5 Execute()
6
7fmt.Println(res, status, err)
Grant Access Manager permissions for channel group
1res, status, err := pn.Grant().
2 ChannelGroups([]string{"cg1", "cg2", "cg3"}).
3 AuthKeys([]string{"my-key"}).
4 Read(true).
5 Write(true).
6 Manage(true).
7 TTL(123).
8 Execute()
9
10fmt.Println(res, status, err)
The above code would return the following response to the client:
1{
2 Level:channel-group+auth
3 SubscribeKey:sub-c-90c51098-c040-11e5-a316-0619f8945a4f
4 Ttl:123
5 Channels:map[
6 my_channel-pnpres:{
7 Name:my_channel-pnpres
8 AuthKeys:map[
9 my-key:{
10 ReadEnabled:true
11 WriteEnabled:true
12 ManageEnabled:false
13 Ttl:0
14 }
15 ]
show all 26 linesGrant get and update access to a uuid only for clients with a specific AuthKeys with a 24 hrs ttl
1res, status, err := pn.Grant().
2 Uuids([]string{"my_uuid"}).
3 Get(true).
4 Update(false).
5 AuthKeys([]string{"my_authkeys"}).
6 TTL(1440).
7 Execute()
8
9fmt.Println(res, status, err)
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.
1res, status, err := pn.Grant().
2 Read(true).
3 Write(true).
4 Execute()
5
6fmt.Println(res, status, err)
Channel level grant
1res, status, err := pn.Grant().
2 Channels([]string{"my_channel"}).
3 Read(true).
4 Write(true).
5 Execute()
6
7fmt.Println(res, status, err)
User level grant
1res, status, err := pn.Grant().
2 Channels([]string{"my_channel"}).
3 AuthKeys([]string{"my_key"}).
4 Read(true).
5 Write(true).
6 TTL(5).
7 Execute()
8
9fmt.Println(res, status, err)