Skip to content
This repository has been archived by the owner on Apr 2, 2024. It is now read-only.

Commit

Permalink
Update outdated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexGodbehere committed Mar 30, 2023
1 parent f264f18 commit 355cd60
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ This returns information about a particular device; in particular, if an applica
If bad data is received via Sparkplug it will be recorded and returned. In particular, if two devices publish on the same Sparkplug address at the same time the data returned from the directory will be very confusing.

### Authentication & Authorisation
The API requires HTTP Basic authentication on every request. (This means external access MUST be over HTTPS). The credentials required are the client's MQTT server credentials; currently they are checked rather crudely by attempting to connect to the MQTT broker using the supplied credentials (this happens for every request, which is not ideal).

There are no ACLs currently. Any authenticated client has access to all data. This is subject to further specification.

Expand Down Expand Up @@ -85,8 +84,6 @@ In addition to the metrics required for command escalation, the mqtt component p

## Known issues

- Authenticating every request against the MQTT server is crude and inefficient (if we could maintain the TLS connection and simply send a new CONNECT every time it would not be so bad, but MQTT does not allow that).

- There are no ACLs; all users are provided with all information. It is not clear what the right thing to do is, here.

- There is no mechanism to expire devices that have been permanently removed from the network.
Expand Down

0 comments on commit 355cd60

Please sign in to comment.