The LinkSmart® Border Gateway (BGW) can authenticate and authorize access to HTTP and MQTT services for users defined in an OpenID Connect provider.
If anonymous access to an endpoint accessed via browser is not allowed, the Border Gateway provides the OAuth2 / OpenID Connect "Authorization Code Flow" (sometimes referred to as "Standard Flow"). You will be re-directed to your OpenID Connect provider to log in.
>>> How to: send credentials in header.<<<
- User provides username/password in the REST request
- BGW intercepts the request and negotiates with an OpenID Connect server for an access token. This implements the OAuth2 / OpenID Connect "Resource Owner Password Credentials Flow".
- If authenticated, BGW forwards the request to API
Bearer token is especially useful if you are using a framework like Angular. You can set up keycloak-angular with "Standard Flow" (= "Authorization Code Flow") and connect to any REST APIs over endpoints protected by the Border Gateway. Border Gateway will validate the access token while Angular is handling login, token refresh etc.
You can also obtain a bearer token manually:
>>> How to: use Bearer authentication in Postman <<<
User directly negotiates with an OpenID Connect server for an access token. Example via curl for Keycloak (OAuth2 / OpenID Connect "Resource Owner Password Credentials Flow"):
- User provides the access token in the request
- BGW intercepts the request and validates the token
- If authenticated, BGW forwards the request to the API
If you connect to the Border Gateway via MQTT protocol, you can deliver username and password as defined in the MQTT standard. You can also deliver an access token (as described above for HTTP) in the MQTT username field. Leave the password field empty if you do. Both types of credentials will be validated against the OpenID Connect provider.
By default the BGW WebSocket proxy expects that you use protocol MQTT over WebSockets so the data is forwarded to the BGW MQTT proxy and authenticated and authorized there. You can configure the WebSocket proxy to forward to any upstream server though. In this case, you need to provide your credentials in the query parameters of the URL to the WebSocket proxy. You can use either one of these two options:
- Access token (see above how to obtain it from your OpenID Connect provider). The access token will be validated in the method
verifyClientof ws package before the WebSocket connection is established. If everything is ok, the WebSocket connection is established, otherwise rejected.
- Basic authentication with username / password. The WebSocket connection to the proxy server will be established in any case, then the WebSocket proxy server will contact your OpenID Connect provider in its
connectionevent. Messages are queued until the authorization process is finished. If successful, the queued messages will be sent to the upstream WebSocket service otherwise the socket is closed and the messages are discarded.
The LinkSmart® Border Gateway also offers some basic authorization capabilities. Authorization rules are defined as user and / or group attributes in the OpenID Connect Provider (see subpage).
- PROTOCOL is the transfer protocol (currently HTTP, HTTPS, MQTT or WS)
- METHOD is the method in regards to the protocol, e.g. GET,POST,DELETE for HTTP and PUB,SUB for MQTT. For WebSocket connections only method CONNECT is allowed.
- DOMAIN is the fully qualified domain name (FQDN)
- Case MQTT / WS: TCP port of the target / upstream service
- Case HTTPS: In a standard deployment the BGW External Interface will add headers x-forwarded-proto and x-forwarded-host (including port) and forward to the BGW HTTP proxy so in the rules regarding HTTP services you need to use protocol HTTPS and port 443 in your rule definitions. If you deploy a BGW HTTP Proxy without the BGW External Interface, you can configure your web server (e.g. nginx) to set headers x-forwarded-proto and x-forwarded-host and define rules in the same way.
- Case HTTP: If you do not use TLS at all or cannot configure your web server to set headers x-forwarded-proto and x-forwarded-host, you need to use HTTP in your rule definitions and the TCP port of BGW HTTP proxy.
- PATH is resource information and may contain slashes itself. For HTTP, it is the resource path (e.g. confluence/display/COM). For MQTT, it is the topic. For WebSocket connections PATH is currently not relevant.
Loolsely based on MQTT topic specification: https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices
- Every slash adds a new section. E.g.: a/b consists of two sections and a/b/ consists of three sections last of which contains an empty string.
- Strings are case-sensitive
- A plus + is a single section wildcard. E.g.: a/+ matches a/b but not a/b/ and a/b/c
- A hash # is a multi-section wildcard and may only be used in the end. E.g.: a/# matches all a/b and a/b/ and a/b/c