subscription

Documentation

Overview

Package subscription contains functionality to handle AuthDB access, including authorization to subscribe to the Pubsub topic for AuthDB change notifications, and updating ACLs to the AuthDB in Google Cloud Storage.

Index

• func Authorize(ctx *router.Context) error
• func CheckAccess(ctx *router.Context) error
• func Deauthorize(ctx *router.Context) error

Functions

func Authorize

func Authorize(ctx *router.Context) error

Authorize authorizes the caller to: - subscribe to AuthDB change notifications from Pubsub; and - read the AuthDB from Google Cloud Storage.

Response body:

{
	'topic': <full name of Pubsub topic for AuthDB change notifications>,
	'authorized': true,
	'gs': {
		'auth_db_gs_path': <same as auth_db_gs_path in SettingsCfg proto>,
		'authorized': true
	}
}

func CheckAccess

func CheckAccess(ctx *router.Context) error

CheckAccess queries whether the caller is authorized to: - subscribe to AuthDB change notifications from Pubsub; and - read the AuthDB from Google Cloud Storage.

Response body:

{
	'topic': <full name of Pubsub topic for AuthDB change notifications>,
	'authorized': <true if the caller is allowed to subscribe to it>,
	'gs': {
		'auth_db_gs_path': <same as auth_db_gs_path in SettingsCfg proto>,
		'authorized': <true if the caller should be able to read GS files>
	}
}

func Deauthorize

func Deauthorize(ctx *router.Context) error

Deauthorize revokes the caller's authorization to: - subscribe to AuthDB change notifications from Pubsub; and - read the AuthDB from Google Cloud Storage.

Response body:

{
	'topic': <full name of Pubsub topic for AuthDB change notifications>,
	'authorized': false,
	'gs': {
		'auth_db_gs_path': <same as auth_db_gs_path in SettingsCfg proto>,
		'authorized': false
	}
}