auth

Documentation

Overview

Package auth provides functions to generate and check Centrifugo tokens and signs.

Index

• Constants
• func CheckApiSign(secretKey, projectKey, encodedData, providedSign string) bool
• func CheckChannelSign(secretKey, client, channel, channelData, providedSign string) bool
• func CheckClientToken(secretKey, projectKey, user, timestamp, info, providedToken string) bool
• func GenerateApiSign(secretKey, projectKey, encodedData string) string
• func GenerateChannelSign(secretKey, client, channel, channelData string) string
• func GenerateClientToken(secretKey, projectKey, user, timestamp, info string) string

Constants

const (
	HMACLength = 64
)

Centrifugo uses sha256 as digest algorithm for HMAC tokens and signs so all correct tokens must be of fixed length set by HMACLength.

Functions

func CheckApiSign

func CheckApiSign(secretKey, projectKey, encodedData, providedSign string) bool

CheckApiSign validates correctness of provided (in HTTP API request) sign comparing it with generated one

func CheckChannelSign

func CheckChannelSign(secretKey, client, channel, channelData, providedSign string) bool

CheckChannelSign validates a correctness of provided (in subscribe client command) sign comparing it with generated one

func CheckClientToken

func CheckClientToken(secretKey, projectKey, user, timestamp, info, providedToken string) bool

CheckClientToken validates correctness of provided (by client connection) token comparing it with generated one

func GenerateApiSign

func GenerateApiSign(secretKey, projectKey, encodedData string) string

GenerateApiSign generates sign which is used to sign HTTP API requests

func GenerateChannelSign

func GenerateChannelSign(secretKey, client, channel, channelData string) string

GenerateChannelSign generates sign which is used to prove permission of client to subscribe on private channel

func GenerateClientToken

func GenerateClientToken(secretKey, projectKey, user, timestamp, info string) string

GenerateClientToken generates client token based on project secret key and provided connection parameters such as user ID, timestamp and info JSON string.