auth

README

Auth client

Auth client package is used to identify a thing and authorize a thing's access to a profile.

To identify a thing, you need a valid thing key. You retrieve thing's identity in the form of a thing ID. The latter is used in CRUD operations on things and their connections.

To authorize a thing's access to a profile, you need a valid thing ID and a valid profile ID. If a thing is not connected to a profile, the auth client responds with an error. Otherwise, a nil value is returned, signaling the successful authorization.

Documentation

Index

• type Client
  • func New(redisClient *redis.Client, things protomfx.ThingsServiceClient) Client

Types

type Client

type Client interface {
	Identify(ctx context.Context, thingKey string) (string, error)
	GetPubConfByKey(ctx context.Context, thingKey string) (protomfx.PubConfByKeyRes, error)
}

Client represents Auth cache.

func New

func New(redisClient *redis.Client, things protomfx.ThingsServiceClient) Client

New returns redis profile cache implementation.