magistrala

README

Magistrala

Magistrala is modern, scalable, secure, open-source, and patent-free IoT cloud platform written in Go.

It accepts user and thing (sensor, actuator, application) connections over various network protocols (i.e. HTTP, MQTT, WebSocket, CoAP), thus making a seamless bridge between them. It is used as the IoT middleware for building complex IoT solutions.

For more details, check out the official documentation. For extra bits and services see our contrib repository.

Features

• Multi-protocol connectivity and bridging (HTTP, MQTT, WebSocket and CoAP; see contrib repository for LoRa and OPC UA)
• Device management and provisioning (Zero Touch provisioning)
• Mutual TLS Authentication (mTLS) using X.509 Certificates
• Fine-grained access control (policies, ABAC/RBAC)
• Message persistence (Timescale and PostgresSQL - see contrib repository for Cassandra, InfluxDB, and MongoDB support)
• Platform logging and instrumentation support (Prometheus and OpenTelemetry)
• Event sourcing
• Container-based deployment using Docker and Kubernetes
• Edge Agent and Export services for remote IoT gateway management and edge computing
• SDK
• CLI
• Small memory footprint and fast execution
• Domain-driven design architecture, high-quality code and test coverage

Prerequisites

The following are needed to run Magistrala:

• Docker (version 26.0.0)

Developing Magistrala will also require:

• Go (version 1.21)
• Protobuf (version 25.1)

Install

Once the prerequisites are installed, execute the following commands from the project's root:

docker compose -f docker/docker-compose.yml --env-file docker/.env -p git_github_com_absmach_magistrala_git_  up

This will bring up the Magistrala docker services and interconnect them. This command can also be executed using the project's included Makefile:

make run

If you want to run services from specific release checkout code from github and make sure that MG_RELEASE_TAG in .env is being set to match the release version

git checkout tags/<release_number> -b <release_number>
# e.g. `git checkout tags/0.13.0 -b 0.13.0`

Check that .env file contains:

MG_RELEASE_TAG=<release_number>

docker-compose should be used for development and testing deployments. For production we suggest using Kubernetes.

Usage

The quickest way to start using Magistrala is via the CLI. The latest version can be downloaded from the official releases page.

It can also be built and used from the project's root directory:

make cli
./build/cli version

Additional details on using the CLI can be found in the CLI documentation.

Documentation

Official documentation is hosted at Magistrala official docs page. Documentation is auto-generated, checkout the instructions on official docs repository:

If you spot an error or a need for corrections, please let us know - or even better: send us a PR.

Authors

Main architect and BDFL of Magistrala project is @drasko.

Additionally, @nmarcetic and @janko-isidorovic assured overall architecture and design, while @manuio and @darkodraskovic helped with crafting initial implementation and continuously worked on the project evolutions.

Besides them, Magistrala is constantly improved and actively developed by @anovakovic01, @dusanb94, @srados, @gsaleh, @blokovi, @chombium, @mteodor, @rodneyosodo and a large set of contributors.

Maintainers are listed in MAINTAINERS file.

The Magistrala team would like to give special thanks to @mijicd for his monumental work on designing and implementing a highly improved and optimized version of the platform, and @malidukica for his effort on implementing the initial user interface.

Professional Support

There are many companies offering professional support for the Magistrala system.

If you need this kind of support, best is to reach out to @drasko directly, and he will point you out to the best-matching support team.

Contributing

Thank you for your interest in Magistrala and the desire to contribute!

1. Take a look at our open issues. The good-first-issue label is specifically for issues that are great for getting started.
2. Checkout the contribution guide to learn more about our style and conventions.
3. Make your changes compatible to our workflow.

Also, explore our contrib repository for extra services such as Cassandra, InfluxDB, MongoDB readers and writers, LoRa, OPC UA support, Digital Twins, and more. If you have a contribution that is not a good fit for the core monorepo (it's specific to your use case, it's an additional feature or a new service, it's optional or an add-on), this is a great place to submit the pull request.

We're Hiring

You like Magistrala and you would like to make it your day job? We're always looking for talented engineers interested in open-source, IoT and distributed systems. If you recognize yourself, reach out to @drasko - he will contact you back.

The best way to grab our attention is, of course, by sending PRs 😎.

Community

• Google group
• Gitter
• Twitter

License

Apache-2.0

Data Collection for Magistrala

Magistrala is committed to continuously improving its services and ensuring a seamless experience for its users. To achieve this, we collect certain data from your deployments. Rest assured, this data is collected solely for the purpose of enhancing Magistrala and is not used with any malicious intent. The deployment summary can be found on our website.

The collected data includes:

• IP Address - Used for approximate location information on deployments.
• Services Used - To understand which features are popular and prioritize future developments.
• Last Seen Time - To ensure the stability and availability of Magistrala.
• Magistrala Version - To track the software version and deliver relevant updates.

We take your privacy and data security seriously. All data collected is handled in accordance with our stringent privacy policies and industry best practices.

Data collection is on by default and can be disabled by setting the env variable: MG_SEND_TELEMETRY=false

By utilizing Magistrala, you actively contribute to its improvement. Together, we can build a more robust and efficient IoT platform. Thank you for your trust in Magistrala!

Documentation

Overview

package magistrala acts as an umbrella package containing multiple different microservices and defines all shared domain concepts.

Index

• Constants
• Variables
• func Health(service, instanceID string) http.HandlerFunc
• func RegisterAuthServiceServer(s grpc.ServiceRegistrar, srv AuthServiceServer)
• func RegisterDomainsServiceServer(s grpc.ServiceRegistrar, srv DomainsServiceServer)
• func RegisterThingsServiceServer(s grpc.ServiceRegistrar, srv ThingsServiceServer)
• func RegisterTokenServiceServer(s grpc.ServiceRegistrar, srv TokenServiceServer)
• type AuthNReq
  • func (*AuthNReq) Descriptor() ([]byte, []int)
  • func (x *AuthNReq) GetToken() string
  • func (*AuthNReq) ProtoMessage()
  • func (x *AuthNReq) ProtoReflect() protoreflect.Message
  • func (x *AuthNReq) Reset()
  • func (x *AuthNReq) String() string
• type AuthNRes
  • func (*AuthNRes) Descriptor() ([]byte, []int)
  • func (x *AuthNRes) GetDomainId() string
  • func (x *AuthNRes) GetId() string
  • func (x *AuthNRes) GetUserId() string
  • func (*AuthNRes) ProtoMessage()
  • func (x *AuthNRes) ProtoReflect() protoreflect.Message
  • func (x *AuthNRes) Reset()
  • func (x *AuthNRes) String() string
• type AuthServiceClient
  • func NewAuthServiceClient(cc grpc.ClientConnInterface) AuthServiceClient
• type AuthServiceServer
• type AuthZReq
  • func (*AuthZReq) Descriptor() ([]byte, []int)
  • func (x *AuthZReq) GetDomain() string
  • func (x *AuthZReq) GetObject() string
  • func (x *AuthZReq) GetObjectType() string
  • func (x *AuthZReq) GetPermission() string
  • func (x *AuthZReq) GetRelation() string
  • func (x *AuthZReq) GetSubject() string
  • func (x *AuthZReq) GetSubjectKind() string
  • func (x *AuthZReq) GetSubjectRelation() string
  • func (x *AuthZReq) GetSubjectType() string
  • func (*AuthZReq) ProtoMessage()
  • func (x *AuthZReq) ProtoReflect() protoreflect.Message
  • func (x *AuthZReq) Reset()
  • func (x *AuthZReq) String() string
• type AuthZRes
  • func (*AuthZRes) Descriptor() ([]byte, []int)
  • func (x *AuthZRes) GetAuthorized() bool
  • func (x *AuthZRes) GetId() string
  • func (*AuthZRes) ProtoMessage()
  • func (x *AuthZRes) ProtoReflect() protoreflect.Message
  • func (x *AuthZRes) Reset()
  • func (x *AuthZRes) String() string
• type DeleteUserReq
  • func (*DeleteUserReq) Descriptor() ([]byte, []int)
  • func (x *DeleteUserReq) GetId() string
  • func (*DeleteUserReq) ProtoMessage()
  • func (x *DeleteUserReq) ProtoReflect() protoreflect.Message
  • func (x *DeleteUserReq) Reset()
  • func (x *DeleteUserReq) String() string
• type DeleteUserRes
  • func (*DeleteUserRes) Descriptor() ([]byte, []int)
  • func (x *DeleteUserRes) GetDeleted() bool
  • func (*DeleteUserRes) ProtoMessage()
  • func (x *DeleteUserRes) ProtoReflect() protoreflect.Message
  • func (x *DeleteUserRes) Reset()
  • func (x *DeleteUserRes) String() string
• type DomainsServiceClient
  • func NewDomainsServiceClient(cc grpc.ClientConnInterface) DomainsServiceClient
• type DomainsServiceServer
• type HealthInfo
• type IDProvider
• type IssueReq
  • func (*IssueReq) Descriptor() ([]byte, []int)
  • func (x *IssueReq) GetType() uint32
  • func (x *IssueReq) GetUserId() string
  • func (*IssueReq) ProtoMessage()
  • func (x *IssueReq) ProtoReflect() protoreflect.Message
  • func (x *IssueReq) Reset()
  • func (x *IssueReq) String() string
• type RefreshReq
  • func (*RefreshReq) Descriptor() ([]byte, []int)
  • func (x *RefreshReq) GetRefreshToken() string
  • func (*RefreshReq) ProtoMessage()
  • func (x *RefreshReq) ProtoReflect() protoreflect.Message
  • func (x *RefreshReq) Reset()
  • func (x *RefreshReq) String() string
• type Response
• type ThingsAuthzReq
  • func (*ThingsAuthzReq) Descriptor() ([]byte, []int)
  • func (x *ThingsAuthzReq) GetChannelId() string
  • func (x *ThingsAuthzReq) GetPermission() string
  • func (x *ThingsAuthzReq) GetThingId() string
  • func (x *ThingsAuthzReq) GetThingKey() string
  • func (*ThingsAuthzReq) ProtoMessage()
  • func (x *ThingsAuthzReq) ProtoReflect() protoreflect.Message
  • func (x *ThingsAuthzReq) Reset()
  • func (x *ThingsAuthzReq) String() string
• type ThingsAuthzRes
  • func (*ThingsAuthzRes) Descriptor() ([]byte, []int)
  • func (x *ThingsAuthzRes) GetAuthorized() bool
  • func (x *ThingsAuthzRes) GetId() string
  • func (*ThingsAuthzRes) ProtoMessage()
  • func (x *ThingsAuthzRes) ProtoReflect() protoreflect.Message
  • func (x *ThingsAuthzRes) Reset()
  • func (x *ThingsAuthzRes) String() string
• type ThingsServiceClient
  • func NewThingsServiceClient(cc grpc.ClientConnInterface) ThingsServiceClient
• type ThingsServiceServer
• type Token
  • func (*Token) Descriptor() ([]byte, []int)
  • func (x *Token) GetAccessToken() string
  • func (x *Token) GetAccessType() string
  • func (x *Token) GetRefreshToken() string
  • func (*Token) ProtoMessage()
  • func (x *Token) ProtoReflect() protoreflect.Message
  • func (x *Token) Reset()
  • func (x *Token) String() string
• type TokenServiceClient
  • func NewTokenServiceClient(cc grpc.ClientConnInterface) TokenServiceClient
• type TokenServiceServer
• type UnimplementedAuthServiceServer
  • func (UnimplementedAuthServiceServer) Authenticate(context.Context, *AuthNReq) (*AuthNRes, error)
  • func (UnimplementedAuthServiceServer) Authorize(context.Context, *AuthZReq) (*AuthZRes, error)
• type UnimplementedDomainsServiceServer
  • func (UnimplementedDomainsServiceServer) DeleteUserFromDomains(context.Context, *DeleteUserReq) (*DeleteUserRes, error)
• type UnimplementedThingsServiceServer
  • func (UnimplementedThingsServiceServer) Authorize(context.Context, *ThingsAuthzReq) (*ThingsAuthzRes, error)
• type UnimplementedTokenServiceServer
  • func (UnimplementedTokenServiceServer) Issue(context.Context, *IssueReq) (*Token, error)
  • func (UnimplementedTokenServiceServer) Refresh(context.Context, *RefreshReq) (*Token, error)
• type UnsafeAuthServiceServer
• type UnsafeDomainsServiceServer
• type UnsafeThingsServiceServer
• type UnsafeTokenServiceServer

Constants

const (
	TokenService_Issue_FullMethodName   = "/magistrala.TokenService/Issue"
	TokenService_Refresh_FullMethodName = "/magistrala.TokenService/Refresh"
)

const (
	AuthService_Authorize_FullMethodName    = "/magistrala.AuthService/Authorize"
	AuthService_Authenticate_FullMethodName = "/magistrala.AuthService/Authenticate"
)

const (
	DomainsService_DeleteUserFromDomains_FullMethodName = "/magistrala.DomainsService/DeleteUserFromDomains"
)

const (
	ThingsService_Authorize_FullMethodName = "/magistrala.ThingsService/Authorize"
)

Variables

var (
	// Version represents the last service git tag in git history.
	// It's meant to be set using go build ldflags:
	// -ldflags "-X 'github.com/absmach/magistrala.Version=0.0.0'".
	Version = "0.0.0"
	// Commit represents the service git commit hash.
	// It's meant to be set using go build ldflags:
	// -ldflags "-X 'github.com/absmach/magistrala.Commit=ffffffff'".
	Commit = "ffffffff"
	// BuildTime represetns the service build time.
	// It's meant to be set using go build ldflags:
	// -ldflags "-X 'github.com/absmach/magistrala.BuildTime=1970-01-01_00:00:00'".
	BuildTime = "1970-01-01_00:00:00"
)

var AuthService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "magistrala.AuthService",
	HandlerType: (*AuthServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Authorize",
			Handler:    _AuthService_Authorize_Handler,
		},
		{
			MethodName: "Authenticate",
			Handler:    _AuthService_Authenticate_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "auth.proto",
}

AuthService_ServiceDesc is the grpc.ServiceDesc for AuthService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var DomainsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "magistrala.DomainsService",
	HandlerType: (*DomainsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "DeleteUserFromDomains",
			Handler:    _DomainsService_DeleteUserFromDomains_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "auth.proto",
}

DomainsService_ServiceDesc is the grpc.ServiceDesc for DomainsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var File_auth_proto protoreflect.FileDescriptor

var ThingsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "magistrala.ThingsService",
	HandlerType: (*ThingsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Authorize",
			Handler:    _ThingsService_Authorize_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "auth.proto",
}

ThingsService_ServiceDesc is the grpc.ServiceDesc for ThingsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var TokenService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "magistrala.TokenService",
	HandlerType: (*TokenServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Issue",
			Handler:    _TokenService_Issue_Handler,
		},
		{
			MethodName: "Refresh",
			Handler:    _TokenService_Refresh_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "auth.proto",
}

TokenService_ServiceDesc is the grpc.ServiceDesc for TokenService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func Health

func Health(service, instanceID string) http.HandlerFunc

Health exposes an HTTP handler for retrieving service health.

func RegisterAuthServiceServer

func RegisterAuthServiceServer(s grpc.ServiceRegistrar, srv AuthServiceServer)

func RegisterDomainsServiceServer

func RegisterDomainsServiceServer(s grpc.ServiceRegistrar, srv DomainsServiceServer)

func RegisterThingsServiceServer

func RegisterThingsServiceServer(s grpc.ServiceRegistrar, srv ThingsServiceServer)

func RegisterTokenServiceServer

func RegisterTokenServiceServer(s grpc.ServiceRegistrar, srv TokenServiceServer)

Types

type AuthNReq

type AuthNReq struct {
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*AuthNReq) Descriptor

func (*AuthNReq) Descriptor() ([]byte, []int)

Deprecated: Use AuthNReq.ProtoReflect.Descriptor instead.

func (*AuthNReq) GetToken

func (x *AuthNReq) GetToken() string

func (*AuthNReq) ProtoMessage

func (*AuthNReq) ProtoMessage()

func (*AuthNReq) ProtoReflect

func (x *AuthNReq) ProtoReflect() protoreflect.Message

func (*AuthNReq) Reset

func (x *AuthNReq) Reset()

func (*AuthNReq) String

func (x *AuthNReq) String() string

type AuthNRes

type AuthNRes struct {
	Id       string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                             // change "id" to "subject", sub in jwt = user + domain id
	UserId   string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`       // user id
	DomainId string `protobuf:"bytes,3,opt,name=domain_id,json=domainId,proto3" json:"domain_id,omitempty"` // domain id
	// contains filtered or unexported fields
}

func (*AuthNRes) Descriptor

func (*AuthNRes) Descriptor() ([]byte, []int)

Deprecated: Use AuthNRes.ProtoReflect.Descriptor instead.

func (*AuthNRes) GetDomainId

func (x *AuthNRes) GetDomainId() string

func (*AuthNRes) GetId

func (x *AuthNRes) GetId() string

func (*AuthNRes) GetUserId

func (x *AuthNRes) GetUserId() string

func (*AuthNRes) ProtoMessage

func (*AuthNRes) ProtoMessage()

func (*AuthNRes) ProtoReflect

func (x *AuthNRes) ProtoReflect() protoreflect.Message

func (*AuthNRes) Reset

func (x *AuthNRes) Reset()

func (*AuthNRes) String

func (x *AuthNRes) String() string

type AuthServiceClient

type AuthServiceClient interface {
	Authorize(ctx context.Context, in *AuthZReq, opts ...grpc.CallOption) (*AuthZRes, error)
	Authenticate(ctx context.Context, in *AuthNReq, opts ...grpc.CallOption) (*AuthNRes, error)
}

AuthServiceClient is the client API for AuthService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

AuthService is a service that provides authentication and authorization functionalities for magistrala services.

func NewAuthServiceClient

func NewAuthServiceClient(cc grpc.ClientConnInterface) AuthServiceClient

type AuthServiceServer

type AuthServiceServer interface {
	Authorize(context.Context, *AuthZReq) (*AuthZRes, error)
	Authenticate(context.Context, *AuthNReq) (*AuthNRes, error)
	// contains filtered or unexported methods
}

AuthServiceServer is the server API for AuthService service. All implementations must embed UnimplementedAuthServiceServer for forward compatibility

AuthService is a service that provides authentication and authorization functionalities for magistrala services.

type AuthZReq

type AuthZReq struct {
	Domain          string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain,omitempty"`                                          // Domain
	SubjectType     string `protobuf:"bytes,2,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`             // Thing or User
	SubjectKind     string `protobuf:"bytes,3,opt,name=subject_kind,json=subjectKind,proto3" json:"subject_kind,omitempty"`             // ID or Token
	SubjectRelation string `protobuf:"bytes,4,opt,name=subject_relation,json=subjectRelation,proto3" json:"subject_relation,omitempty"` // Subject relation
	Subject         string `protobuf:"bytes,5,opt,name=subject,proto3" json:"subject,omitempty"`                                        // Subject value (id or token, depending on kind)
	Relation        string `protobuf:"bytes,6,opt,name=relation,proto3" json:"relation,omitempty"`                                      // Relation to filter
	Permission      string `protobuf:"bytes,7,opt,name=permission,proto3" json:"permission,omitempty"`                                  // Action
	Object          string `protobuf:"bytes,8,opt,name=object,proto3" json:"object,omitempty"`                                          // Object ID
	ObjectType      string `protobuf:"bytes,9,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`                // Thing, User, Group
	// contains filtered or unexported fields
}

func (*AuthZReq) Descriptor

func (*AuthZReq) Descriptor() ([]byte, []int)

Deprecated: Use AuthZReq.ProtoReflect.Descriptor instead.

func (*AuthZReq) GetDomain

func (x *AuthZReq) GetDomain() string

func (*AuthZReq) GetObject

func (x *AuthZReq) GetObject() string

func (*AuthZReq) GetObjectType

func (x *AuthZReq) GetObjectType() string

func (*AuthZReq) GetPermission

func (x *AuthZReq) GetPermission() string

func (*AuthZReq) GetRelation

func (x *AuthZReq) GetRelation() string

func (*AuthZReq) GetSubject

func (x *AuthZReq) GetSubject() string

func (*AuthZReq) GetSubjectKind

func (x *AuthZReq) GetSubjectKind() string

func (*AuthZReq) GetSubjectRelation

func (x *AuthZReq) GetSubjectRelation() string

func (*AuthZReq) GetSubjectType

func (x *AuthZReq) GetSubjectType() string

func (*AuthZReq) ProtoMessage

func (*AuthZReq) ProtoMessage()

func (*AuthZReq) ProtoReflect

func (x *AuthZReq) ProtoReflect() protoreflect.Message

func (*AuthZReq) Reset

func (x *AuthZReq) Reset()

func (*AuthZReq) String

func (x *AuthZReq) String() string

type AuthZRes

type AuthZRes struct {
	Authorized bool   `protobuf:"varint,1,opt,name=authorized,proto3" json:"authorized,omitempty"`
	Id         string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*AuthZRes) Descriptor

func (*AuthZRes) Descriptor() ([]byte, []int)

Deprecated: Use AuthZRes.ProtoReflect.Descriptor instead.

func (*AuthZRes) GetAuthorized

func (x *AuthZRes) GetAuthorized() bool

func (*AuthZRes) GetId

func (x *AuthZRes) GetId() string

func (*AuthZRes) ProtoMessage

func (*AuthZRes) ProtoMessage()

func (*AuthZRes) ProtoReflect

func (x *AuthZRes) ProtoReflect() protoreflect.Message

func (*AuthZRes) Reset

func (x *AuthZRes) Reset()

func (*AuthZRes) String

func (x *AuthZRes) String() string

type DeleteUserReq

type DeleteUserReq struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteUserReq) Descriptor

func (*DeleteUserReq) Descriptor() ([]byte, []int)

Deprecated: Use DeleteUserReq.ProtoReflect.Descriptor instead.

func (*DeleteUserReq) GetId

func (x *DeleteUserReq) GetId() string

func (*DeleteUserReq) ProtoMessage

func (*DeleteUserReq) ProtoMessage()

func (*DeleteUserReq) ProtoReflect

func (x *DeleteUserReq) ProtoReflect() protoreflect.Message

func (*DeleteUserReq) Reset

func (x *DeleteUserReq) Reset()

func (*DeleteUserReq) String

func (x *DeleteUserReq) String() string

type DeleteUserRes

type DeleteUserRes struct {
	Deleted bool `protobuf:"varint,1,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteUserRes) Descriptor

func (*DeleteUserRes) Descriptor() ([]byte, []int)

Deprecated: Use DeleteUserRes.ProtoReflect.Descriptor instead.

func (*DeleteUserRes) GetDeleted

func (x *DeleteUserRes) GetDeleted() bool

func (*DeleteUserRes) ProtoMessage

func (*DeleteUserRes) ProtoMessage()

func (*DeleteUserRes) ProtoReflect

func (x *DeleteUserRes) ProtoReflect() protoreflect.Message

func (*DeleteUserRes) Reset

func (x *DeleteUserRes) Reset()

func (*DeleteUserRes) String

func (x *DeleteUserRes) String() string

type DomainsServiceClient

type DomainsServiceClient interface {
	DeleteUserFromDomains(ctx context.Context, in *DeleteUserReq, opts ...grpc.CallOption) (*DeleteUserRes, error)
}

DomainsServiceClient is the client API for DomainsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

DomainsService is a service that provides access to domains functionalities for magistrala services.

func NewDomainsServiceClient

func NewDomainsServiceClient(cc grpc.ClientConnInterface) DomainsServiceClient

type DomainsServiceServer

type DomainsServiceServer interface {
	DeleteUserFromDomains(context.Context, *DeleteUserReq) (*DeleteUserRes, error)
	// contains filtered or unexported methods
}

DomainsServiceServer is the server API for DomainsService service. All implementations must embed UnimplementedDomainsServiceServer for forward compatibility

DomainsService is a service that provides access to domains functionalities for magistrala services.

type HealthInfo

type HealthInfo struct {
	// Status contains service status.
	Status string `json:"status"`

	// Version contains current service version.
	Version string `json:"version"`

	// Commit represents the git hash commit.
	Commit string `json:"commit"`

	// Description contains service description.
	Description string `json:"description"`

	// BuildTime contains service build time.
	BuildTime string `json:"build_time"`

	// InstanceID contains the ID of the current service instance
	InstanceID string `json:"instance_id"`
}

HealthInfo contains version endpoint response.

type IDProvider

type IDProvider interface {
	// ID generates the unique identifier.
	ID() (string, error)
}

IDProvider specifies an API for generating unique identifiers.

type IssueReq

type IssueReq struct {
	UserId string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Type   uint32 `protobuf:"varint,2,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*IssueReq) Descriptor

func (*IssueReq) Descriptor() ([]byte, []int)

Deprecated: Use IssueReq.ProtoReflect.Descriptor instead.

func (*IssueReq) GetType

func (x *IssueReq) GetType() uint32

func (*IssueReq) GetUserId

func (x *IssueReq) GetUserId() string

func (*IssueReq) ProtoMessage

func (*IssueReq) ProtoMessage()

func (*IssueReq) ProtoReflect

func (x *IssueReq) ProtoReflect() protoreflect.Message

func (*IssueReq) Reset

func (x *IssueReq) Reset()

func (*IssueReq) String

func (x *IssueReq) String() string

type RefreshReq

type RefreshReq struct {
	RefreshToken string `protobuf:"bytes,1,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// contains filtered or unexported fields
}

func (*RefreshReq) Descriptor

func (*RefreshReq) Descriptor() ([]byte, []int)

Deprecated: Use RefreshReq.ProtoReflect.Descriptor instead.

func (*RefreshReq) GetRefreshToken

func (x *RefreshReq) GetRefreshToken() string

func (*RefreshReq) ProtoMessage

func (*RefreshReq) ProtoMessage()

func (*RefreshReq) ProtoReflect

func (x *RefreshReq) ProtoReflect() protoreflect.Message

func (*RefreshReq) Reset

func (x *RefreshReq) Reset()

func (*RefreshReq) String

func (x *RefreshReq) String() string

type Response

type Response interface {
	// Code returns HTTP response code.
	Code() int

	// Headers returns map of HTTP headers with their values.
	Headers() map[string]string

	// Empty indicates if HTTP response has content.
	Empty() bool
}

Response contains HTTP response specific methods.

type ThingsAuthzReq

type ThingsAuthzReq struct {
	ChannelId  string `protobuf:"bytes,1,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`
	ThingId    string `protobuf:"bytes,2,opt,name=thing_id,json=thingId,proto3" json:"thing_id,omitempty"`
	ThingKey   string `protobuf:"bytes,3,opt,name=thing_key,json=thingKey,proto3" json:"thing_key,omitempty"`
	Permission string `protobuf:"bytes,4,opt,name=permission,proto3" json:"permission,omitempty"`
	// contains filtered or unexported fields
}

func (*ThingsAuthzReq) Descriptor

func (*ThingsAuthzReq) Descriptor() ([]byte, []int)

Deprecated: Use ThingsAuthzReq.ProtoReflect.Descriptor instead.

func (*ThingsAuthzReq) GetChannelId

func (x *ThingsAuthzReq) GetChannelId() string

func (*ThingsAuthzReq) GetPermission

func (x *ThingsAuthzReq) GetPermission() string

func (*ThingsAuthzReq) GetThingId

func (x *ThingsAuthzReq) GetThingId() string

func (*ThingsAuthzReq) GetThingKey

func (x *ThingsAuthzReq) GetThingKey() string

func (*ThingsAuthzReq) ProtoMessage

func (*ThingsAuthzReq) ProtoMessage()

func (*ThingsAuthzReq) ProtoReflect

func (x *ThingsAuthzReq) ProtoReflect() protoreflect.Message

func (*ThingsAuthzReq) Reset

func (x *ThingsAuthzReq) Reset()

func (*ThingsAuthzReq) String

func (x *ThingsAuthzReq) String() string

type ThingsAuthzRes

type ThingsAuthzRes struct {
	Authorized bool   `protobuf:"varint,1,opt,name=authorized,proto3" json:"authorized,omitempty"`
	Id         string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*ThingsAuthzRes) Descriptor

func (*ThingsAuthzRes) Descriptor() ([]byte, []int)

Deprecated: Use ThingsAuthzRes.ProtoReflect.Descriptor instead.

func (*ThingsAuthzRes) GetAuthorized

func (x *ThingsAuthzRes) GetAuthorized() bool

func (*ThingsAuthzRes) GetId

func (x *ThingsAuthzRes) GetId() string

func (*ThingsAuthzRes) ProtoMessage

func (*ThingsAuthzRes) ProtoMessage()

func (*ThingsAuthzRes) ProtoReflect

func (x *ThingsAuthzRes) ProtoReflect() protoreflect.Message

func (*ThingsAuthzRes) Reset

func (x *ThingsAuthzRes) Reset()

func (*ThingsAuthzRes) String

func (x *ThingsAuthzRes) String() string

type ThingsServiceClient

type ThingsServiceClient interface {
	// Authorize checks if the thing is authorized to perform
	// the action on the channel.
	Authorize(ctx context.Context, in *ThingsAuthzReq, opts ...grpc.CallOption) (*ThingsAuthzRes, error)
}

ThingsServiceClient is the client API for ThingsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

ThingsService is a service that provides things authorization functionalities for magistrala services.

func NewThingsServiceClient

func NewThingsServiceClient(cc grpc.ClientConnInterface) ThingsServiceClient

type ThingsServiceServer

type ThingsServiceServer interface {
	// Authorize checks if the thing is authorized to perform
	// the action on the channel.
	Authorize(context.Context, *ThingsAuthzReq) (*ThingsAuthzRes, error)
	// contains filtered or unexported methods
}

ThingsServiceServer is the server API for ThingsService service. All implementations must embed UnimplementedThingsServiceServer for forward compatibility

ThingsService is a service that provides things authorization functionalities for magistrala services.

type Token

type Token struct {
	AccessToken  string  `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3" json:"access_token,omitempty"`
	RefreshToken *string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3,oneof" json:"refresh_token,omitempty"`
	AccessType   string  `protobuf:"bytes,3,opt,name=access_type,json=accessType,proto3" json:"access_type,omitempty"`
	// contains filtered or unexported fields
}

If a token is not carrying any information itself, the type field can be used to determine how to validate the token. Also, different tokens can be encoded in different ways.

func (*Token) Descriptor

func (*Token) Descriptor() ([]byte, []int)

Deprecated: Use Token.ProtoReflect.Descriptor instead.

func (*Token) GetAccessToken

func (x *Token) GetAccessToken() string

func (*Token) GetAccessType

func (x *Token) GetAccessType() string

func (*Token) GetRefreshToken

func (x *Token) GetRefreshToken() string

func (*Token) ProtoMessage

func (*Token) ProtoMessage()

func (*Token) ProtoReflect

func (x *Token) ProtoReflect() protoreflect.Message

func (*Token) Reset

func (x *Token) Reset()

func (*Token) String

func (x *Token) String() string

type TokenServiceClient

type TokenServiceClient interface {
	Issue(ctx context.Context, in *IssueReq, opts ...grpc.CallOption) (*Token, error)
	Refresh(ctx context.Context, in *RefreshReq, opts ...grpc.CallOption) (*Token, error)
}

TokenServiceClient is the client API for TokenService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewTokenServiceClient

func NewTokenServiceClient(cc grpc.ClientConnInterface) TokenServiceClient

type TokenServiceServer

type TokenServiceServer interface {
	Issue(context.Context, *IssueReq) (*Token, error)
	Refresh(context.Context, *RefreshReq) (*Token, error)
	// contains filtered or unexported methods
}

TokenServiceServer is the server API for TokenService service. All implementations must embed UnimplementedTokenServiceServer for forward compatibility

type UnimplementedAuthServiceServer

type UnimplementedAuthServiceServer struct {
}

UnimplementedAuthServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedAuthServiceServer) Authenticate

func (UnimplementedAuthServiceServer) Authenticate(context.Context, *AuthNReq) (*AuthNRes, error)

func (UnimplementedAuthServiceServer) Authorize

func (UnimplementedAuthServiceServer) Authorize(context.Context, *AuthZReq) (*AuthZRes, error)

type UnimplementedDomainsServiceServer

type UnimplementedDomainsServiceServer struct {
}

UnimplementedDomainsServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedDomainsServiceServer) DeleteUserFromDomains

func (UnimplementedDomainsServiceServer) DeleteUserFromDomains(context.Context, *DeleteUserReq) (*DeleteUserRes, error)

type UnimplementedThingsServiceServer

type UnimplementedThingsServiceServer struct {
}

UnimplementedThingsServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedThingsServiceServer) Authorize

func (UnimplementedThingsServiceServer) Authorize(context.Context, *ThingsAuthzReq) (*ThingsAuthzRes, error)

type UnimplementedTokenServiceServer

type UnimplementedTokenServiceServer struct {
}

UnimplementedTokenServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTokenServiceServer) Issue

func (UnimplementedTokenServiceServer) Issue(context.Context, *IssueReq) (*Token, error)

func (UnimplementedTokenServiceServer) Refresh

func (UnimplementedTokenServiceServer) Refresh(context.Context, *RefreshReq) (*Token, error)

type UnsafeAuthServiceServer

type UnsafeAuthServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAuthServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AuthServiceServer will result in compilation errors.

type UnsafeDomainsServiceServer

type UnsafeDomainsServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeDomainsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DomainsServiceServer will result in compilation errors.

type UnsafeThingsServiceServer

type UnsafeThingsServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeThingsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ThingsServiceServer will result in compilation errors.

type UnsafeTokenServiceServer

type UnsafeTokenServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeTokenServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TokenServiceServer will result in compilation errors.