Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor CoAP adapter #2224

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+187 −172
Draft

Refactor CoAP adapter #2224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 1 addition & 172 deletions coap/api/transport.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,17 @@
package api

import (
"context"
"fmt"
"io"
"log/slog"
"net/http"
"net/url"
"regexp"
"strings"
"time"

"github.com/absmach/magistrala"
"github.com/absmach/magistrala/coap"
"github.com/absmach/magistrala/pkg/errors"
svcerr "github.com/absmach/magistrala/pkg/errors/service"
"github.com/absmach/magistrala/pkg/messaging"
"github.com/go-chi/chi/v5"
"github.com/plgd-dev/go-coap/v2/message"
"github.com/plgd-dev/go-coap/v2/message/codes"
"github.com/plgd-dev/go-coap/v2/mux"
"github.com/prometheus/client_golang/prometheus/promhttp"
)

const (
protocol = "coap"
authQuery = "auth"
startObserve = 0 // observe option value that indicates start of observation
)

var channelPartRegExp = regexp.MustCompile(`^/channels/([\w\-]+)/messages(/[^?]*)?(\?.*)?$`)

const (
numGroups = 3 // entire expression + channel group + subtopic group
channelGroup = 2 // channel group is second in channel regexp
)

var (
errMalformedSubtopic = errors.New("malformed subtopic")
errBadOptions = errors.New("bad options")
)
const protocol = "coap"

var (
logger *slog.Logger
Expand All @@ -63,148 +35,5 @@
logger = l
service = svc

return handler

Check failure on line 38 in coap/api/transport.go

View workflow job for this annotation

GitHub Actions / Lint and Build 

undefined: handler (typecheck)
}

func sendResp(w mux.ResponseWriter, resp *message.Message) {
if err := w.Client().WriteMessage(resp); err != nil {
logger.Warn(fmt.Sprintf("Can't set response: %s", err))
}
}

func handler(w mux.ResponseWriter, m *mux.Message) {
resp := message.Message{
Code: codes.Content,
Token: m.Token,
Context: m.Context,
Options: make(message.Options, 0, 16),
}
defer sendResp(w, &resp)
msg, err := decodeMessage(m)
if err != nil {
logger.Warn(fmt.Sprintf("Error decoding message: %s", err))
resp.Code = codes.BadRequest
return
}
key, err := parseKey(m)
if err != nil {
logger.Warn(fmt.Sprintf("Error parsing auth: %s", err))
resp.Code = codes.Unauthorized
return
}
switch m.Code {
case codes.GET:
err = handleGet(m.Context, m, w.Client(), msg, key)
case codes.POST:
resp.Code = codes.Created
err = service.Publish(m.Context, key, msg)
default:
err = svcerr.ErrNotFound
}
if err != nil {
switch {
case err == errBadOptions:
resp.Code = codes.BadOption
case err == svcerr.ErrNotFound:
resp.Code = codes.NotFound
case errors.Contains(err, svcerr.ErrAuthorization),
errors.Contains(err, svcerr.ErrAuthentication):
resp.Code = codes.Unauthorized
default:
resp.Code = codes.InternalServerError
}
}
}

func handleGet(ctx context.Context, m *mux.Message, c mux.Client, msg *messaging.Message, key string) error {
var obs uint32
obs, err := m.Options.Observe()
if err != nil {
logger.Warn(fmt.Sprintf("Error reading observe option: %s", err))
return errBadOptions
}
if obs == startObserve {
c := coap.NewClient(c, m.Token, logger)
return service.Subscribe(ctx, key, msg.GetChannel(), msg.GetSubtopic(), c)
}
return service.Unsubscribe(ctx, key, msg.GetChannel(), msg.GetSubtopic(), m.Token.String())
}

func decodeMessage(msg *mux.Message) (*messaging.Message, error) {
if msg.Options == nil {
return &messaging.Message{}, errBadOptions
}
path, err := msg.Options.Path()
if err != nil {
return &messaging.Message{}, err
}
channelParts := channelPartRegExp.FindStringSubmatch(path)
if len(channelParts) < numGroups {
return &messaging.Message{}, errMalformedSubtopic
}

st, err := parseSubtopic(channelParts[channelGroup])
if err != nil {
return &messaging.Message{}, err
}
ret := &messaging.Message{
Protocol: protocol,
Channel: channelParts[1],
Subtopic: st,
Payload: []byte{},
Created: time.Now().UnixNano(),
}

if msg.Body != nil {
buff, err := io.ReadAll(msg.Body)
if err != nil {
return ret, err
}
ret.Payload = buff
}
return ret, nil
}

func parseKey(msg *mux.Message) (string, error) {
if obs, _ := msg.Options.Observe(); obs != 0 && msg.Code == codes.GET {
return "", nil
}
authKey, err := msg.Options.GetString(message.URIQuery)
if err != nil {
return "", err
}
vars := strings.Split(authKey, "=")
if len(vars) != 2 || vars[0] != authQuery {
return "", svcerr.ErrAuthorization
}
return vars[1], nil
}

func parseSubtopic(subtopic string) (string, error) {
if subtopic == "" {
return subtopic, nil
}

subtopic, err := url.QueryUnescape(subtopic)
if err != nil {
return "", errMalformedSubtopic
}
subtopic = strings.ReplaceAll(subtopic, "/", ".")

elems := strings.Split(subtopic, ".")
filteredElems := []string{}
for _, elem := range elems {
if elem == "" {
continue
}

if len(elem) > 1 && (strings.Contains(elem, "*") || strings.Contains(elem, ">")) {
return "", errMalformedSubtopic
}

filteredElems = append(filteredElems, elem)
}

subtopic = strings.Join(filteredElems, ".")
return subtopic, nil
}
186 changes: 186 additions & 0 deletions coap/service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

package coap

import (
"context"
"fmt"
"io"
"log/slog"
"net/url"
"regexp"
"strings"
"time"

"github.com/absmach/magistrala/pkg/errors"
svcerr "github.com/absmach/magistrala/pkg/errors/service"
"github.com/absmach/magistrala/pkg/messaging"
"github.com/mainflux/mainflux/coap"
"github.com/plgd-dev/go-coap/v2/message"
"github.com/plgd-dev/go-coap/v2/message/codes"
mux "github.com/plgd-dev/go-coap/v2/mux"
)

const (
protocol = "coap"
authQuery = "auth"
startObserve = 0 // observe option value that indicates start of observation
numGroups = 3 // entire expression + channel group + subtopic group
channelGroup = 2 // channel group is second in channel regexp
)

var (
errMalformedSubtopic = errors.New("malformed subtopic")
errBadOptions = errors.New("bad options")
channelPartRegExp = regexp.MustCompile(`^/channels/([\w\-]+)/messages(/[^?]*)?(\?.*)?$`)
)

var (
logger *slog.Logger
service coap.Service
)

func sendResp(w mux.ResponseWriter, resp *message.Message) {
if err := w.Client().WriteMessage(resp); err != nil {
logger.Warn(fmt.Sprintf("Can't set response: %s", err))
}
}

// MakeCoAPHandler creates handler for CoAP messages.
func handler(w mux.ResponseWriter, m *mux.Message) {
resp := message.Message{
Code: codes.Content,
Token: m.Token,
Context: m.Context,
Options: make(message.Options, 0, 16),
}
defer sendResp(w, &resp)
msg, err := decodeMessage(m)
if err != nil {
logger.Warn(fmt.Sprintf("Error decoding message: %s", err))
resp.Code = codes.BadRequest
return
}
key, err := parseKey(m)
if err != nil {
logger.Warn(fmt.Sprintf("Error parsing auth: %s", err))
resp.Code = codes.Unauthorized
return
}
switch m.Code {
case codes.GET:
err = handleGet(m.Context, m, w.Client(), msg, key)
case codes.POST:
resp.Code = codes.Created
err = service.Publish(m.Context, key, msg)
default:
err = svcerr.ErrNotFound
}
if err != nil {
switch {
case err == errBadOptions:
resp.Code = codes.BadOption
case err == svcerr.ErrNotFound:
resp.Code = codes.NotFound
case errors.Contains(err, svcerr.ErrAuthorization),
errors.Contains(err, svcerr.ErrAuthentication):
resp.Code = codes.Unauthorized
default:
resp.Code = codes.InternalServerError
}
}
}

func handleGet(ctx context.Context, m *mux.Message, c mux.Client, msg *messaging.Message, key string) error {
var obs uint32
obs, err := m.Options.Observe()
if err != nil {
logger.Warn(fmt.Sprintf("Error reading observe option: %s", err))
return errBadOptions
}
if obs == startObserve {
c := coap.NewClient(c, m.Token, logger)
return service.Subscribe(ctx, key, msg.GetChannel(), msg.GetSubtopic(), c)
}
return service.Unsubscribe(ctx, key, msg.GetChannel(), msg.GetSubtopic(), m.Token.String())
}

func decodeMessage(msg *mux.Message) (*messaging.Message, error) {
if msg.Options == nil {
return &messaging.Message{}, errBadOptions
}
path, err := msg.Options.Path()
if err != nil {
return &messaging.Message{}, err
}
channelParts := channelPartRegExp.FindStringSubmatch(path)
if len(channelParts) < numGroups {
return &messaging.Message{}, errMalformedSubtopic
}

st, err := parseSubtopic(channelParts[channelGroup])
if err != nil {
return &messaging.Message{}, err
}
ret := &messaging.Message{
Protocol: protocol,
Channel: channelParts[1],
Subtopic: st,
Payload: []byte{},
Created: time.Now().UnixNano(),
}

if msg.Body != nil {
buff, err := io.ReadAll(msg.Body)
if err != nil {
return ret, err
}
ret.Payload = buff
}
return ret, nil
}

func parseKey(msg *mux.Message) (string, error) {
if obs, _ := msg.Options.Observe(); obs != 0 && msg.Code == codes.GET {
return "", nil
}
authKey, err := msg.Options.GetString(message.URIQuery)
if err != nil {
return "", err
}
vars := strings.Split(authKey, "=")
if len(vars) != 2 || vars[0] != authQuery {
return "", svcerr.ErrAuthorization
}
return vars[1], nil
}

func parseSubtopic(subtopic string) (string, error) {
if subtopic == "" {
return subtopic, nil
}

subtopic, err := url.QueryUnescape(subtopic)
if err != nil {
return "", errMalformedSubtopic
}
subtopic = strings.ReplaceAll(subtopic, "/", ".")

elems := strings.Split(subtopic, ".")
filteredElems := []string{}
for _, elem := range elems {
if elem == "" {
continue
}

if len(elem) > 1 && (strings.Contains(elem, "*") || strings.Contains(elem, ">")) {
return "", errMalformedSubtopic
}

filteredElems = append(filteredElems, elem)
}

subtopic = strings.Join(filteredElems, ".")
return subtopic, nil
}
Loading