Skip to content

Commit

Permalink
Add a note on the secure attribute of the endpoints in both the meta.…
Browse files Browse the repository at this point in the history
…yml (#1075)

and devfile about the assumptions made to make it really secure.
  • Loading branch information
metlos authored Feb 17, 2020
1 parent 3eee2ea commit babc813
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ The link:https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins[c

.`spec.endpoints.attributes` attributes
:===
`protocol`: Protocol, example: `ws`
`protocol`: Protocol, example\: `ws`
`type`: `ide`, `ide-dev`
`discoverable`: `true`, `false`
`secure`: `true`, `false`
`secure`: `true`, `false`. If `true` the endpoint is assumed to listen solely on `127.0.0.1` and is exposed using a JWT proxy.
`cookiesAuthEnabled`: `true`, `false`
:===

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -502,7 +502,9 @@ Here, there are two dockerimages, each defining a single endpoint. Endpoint is a

* `protocol`: For public endpoints the protocol is a hint to the UI on how to construct the URL for the endpoint access. Typical values are `http`, `https`, `ws`, `wss`.

* `secure`: A boolean (defaulting to `false`) specifying whether the endpoint is put behind a JWT proxy requiring a JWT workspace token to grant access.
* `secure`: A boolean (defaulting to `false`) specifying whether the endpoint is put behind a JWT proxy requiring a JWT workspace token to grant access. The JWT proxy is deployed in the same pod as the server and assumes the server listens solely on the local loopback interface (i.e. the `127.0.0.1` address).
+
WARNING: Listening on any other interface than the local loopback poses a security risk, because such server will be accessible without the JWT authentication within the cluster network on the corresponding IP addresses.

* `path`: The URL of the endpoint

Expand Down

0 comments on commit babc813

Please sign in to comment.