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.

ResourcePermissions
channelread, write, get, manage, update, join, delete
uuidget, update, delete
channelGroupread, 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 channels and uuids. The only permission is get (32).
  • A get permission 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 403 error.

When you set Categories:

  • Call Get(true) to grant the category. Call Get(false) with the same Categories and AuthKeys to revoke it. If you don't call Get(), the SDK sends no get permission and the grant gives nothing.
  • The SDK sends read, write, manage, and delete as 0 or 1, and sends get, update, and join only when you set them.
  • The SDK rejects the request before sending it if you set any permission other than get to true.
  • The server returns a 400 error for a category grant with get set to true and a ttl of 1. 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 with a..
  • * or a.b.* won't work this way. If you grant on * or a.b.*, the grant treats * or a.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:

  1. Application Level - Access Manager privileges are always evaluated first at the Application level. If either read or write attribute is set to true for a SubscribeKey, Access Manager 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, Access Manager proceeds to evaluate the attribute at the next most granular level.
  2. 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 true for a combination of SubscribeKey, and channel, Access Manager grants access for that attribute at the Channel level without proceeding to check whether there may be user level permissions.
  3. User Level (Recommended) - As a final step Access Manager 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. Similarly, user level grants also allow you granting an AuthKey access to channelGroups and uuids. User level grants require AuthKey and are the recommended approach if you need to manage permissions for individual users within your application. Each user should be assigned a unique AuthKey and 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#
Type: []string
Default: no default
Specifies a list of uuids on which to grant permissions. You can't grant permissions to channels and channel groups in the same request if you decide to use uuids.
This parameter does not support wildcards.
Channels#
Type: []string
Default: no default
Specifies 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. Wildcard notation like a.* can be used to grant access on channels. You can grant one level deep.
  • a.* - you can grant on this.
  • * and a.b.* - grant will not work on these levels. If you grant on * or a.b.*, the grant will treat * or a.b.* as a single channel named either * or a.b.*.
ChannelGroups#
Type: []string
Default: no default
Specifies 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.
This parameter does not support wildcards.
AuthKeys#
Type: []string
Default: no default
Specifies auth Key to grant permissions. It is possible to specify multiple auth keys. 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.
Read#
Type: bool
Default: false
Read permissions are granted by setting to true. Read permissions are removed by setting to false.
Write#
Type: bool
Default: false
Write permissions are granted by setting to true. Write permissions are removed by setting to false.
Delete#
Type: bool
Default: false
Delete permissions are granted by setting to true. Delete permissions are removed by setting to false.
Manage#
Type: bool
Default: false
Manage permissions are granted by setting to true. Manage permissions are removed by setting to false.
Get#
Type: bool
Default: false
Get permissions are granted by setting to true. Get permissions are removed by setting to false.
Update#
Type: bool
Default: false
Update permissions are granted by setting to true. Update permissions are removed by setting to false.
Join#
Type: bool
Default: false
Join permissions are granted by setting to true. Join permissions are removed by setting to false.
Categories#
Type: []PNGrantCategory
Default: no default
Category grants that let the token list all metadata of a type on the subscribe key. PNGrantCategoryChannels lists all channel metadata. PNGrantCategoryUUIDs lists all uuid metadata. Requires at least one AuthKeys entry. Only Get can be set in the same request. Setting Read, Write, Manage, Delete, Update, or Join to true returns a validation error. This applies even when Channels, ChannelGroups, or Uuids are also set. Other permissions must be sent in a separate request. The SDK doesn't validate the one-minute TTL rule, so the server returns the error.
TTL#
Type: int
Default: 1440 (24hrs)
Time 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.
QueryParam#
Type: map[string]string
Default: nil
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#
Type: string
Permissions level, one of subkey, subkey+auth, channel, channel-group, channel-group+auth level.
TTL#
Type: int
TTL of grant.
SubscribeKey#
Type: string
The subscribe key.
Channels#
Type: map[string]*PNPAMEntityData
Access rights per channel. See PNAccessManagerChannelData for more details.
ChannelGroups#
Type: map[string]*PNPAMEntityData
Access rights per channel groups. See PNAccessManagerChannelData for more details.
ReadEnabled#
Type: bool
subkey level read permissions.
WriteEnabled#
Type: bool
subkey level write permissions.
DeleteEnabled#
Type: bool
subkey level delete permissions.
ManageEnabled#
Type: bool
subkey level manage permissions.
Categories#
Type: map[string]*PNPAMEntityData
Category-level grants keyed by channels and uuids. Present only when Categories was requested in the grant.

PNPAMEntityData​

AuthKeys#
Type: map[string]*PNAccessManagerKeyData
Access rights per auth-key. See PNAccessManagerKeyData for more details.
Name#
Type: string
Channel or group name.
ReadEnabled#
Type: bool
Channel or group level read permissions.
WriteEnabled#
Type: bool
Channel or group level write permissions.
DeleteEnabled#
Type: bool
Channel or group level delete permissions.
ManageEnabled#
Type: bool
Channel or group level manage permissions.
GetEnabled#
Type: bool
Channel, group, or category level get permissions. For a category, this is the only meaningful permission.
UpdateEnabled#
Type: bool
Channel or group level update permissions.
JoinEnabled#
Type: bool
Channel or group level join permissions.
TTL#
Type: int
Time to live value.

PNAccessManagerKeyData​

ReadEnabled#
Type: bool
auth-key read permissions
WriteEnabled#
Type: bool
auth-key write permissions.
ManageEnabled#
Type: bool
auth-key managepermissions.
DeleteEnabled#
Type: bool
auth-key delete permissions.
GetEnabled#
Type: bool
auth-key get permissions.
UpdateEnabled#
Type: bool
auth-key update permissions.
JoinEnabled#
Type: bool
auth-key join permissions.
TTL#
Type: int
Time to live value.

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 lines

Allow 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 lines

Grant 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)

Was this page useful?

Last updated on