expose configuration to UI

cmd/tinc-web-boot/main.go

@@ -170,6 +170,7 @@ func (m *Root) Run(global *globalContext) error {
 		AuthKey:         m.AuthKey,
 		LocalUIPort:     uint16(port),
 		PublicAddresses: m.UIPublicAddress,
+		Binding:         m.Bind,
 	}
 	webApi, uiApp := apiCfg.New(pool)
 	if !m.Headless {

docs/tinc_web_ui.md

@@ -6,6 +6,7 @@ Operations with tinc-web-boot related to UI
 * [TincWebUI.IssueAccessToken](#tincwebuiissueaccesstoken) - Issue and sign token
 * [TincWebUI.Notify](#tincwebuinotify) - Make desktop notification if system supports it
 * [TincWebUI.Endpoints](#tincwebuiendpoints) - Endpoints list to access web UI
+* [TincWebUI.Configuration](#tincwebuiconfiguration) - Configuration defined for the instance
 
 
 
@@ -81,4 +82,27 @@ EOF
 |------|------|---------|
 | host | `string` |  |
 | port | `uint16` |  |
-| kind | `EndpointKind` |  |
+| kind | `EndpointKind` |  |
+
+## TincWebUI.Configuration
+
+Configuration defined for the instance
+
+* Method: `TincWebUI.Configuration`
+* Returns: `*Config`
+
+```bash
+curl -H 'Content-Type: application/json' --data-binary @- "http://127.0.0.1:8686/api/" <<EOF
+{
+    "jsonrpc" : "2.0",
+    "id" : 1,
+    "method" : "TincWebUI.Configuration",
+    "params" : []
+}
+EOF
+```
+### Config
+
+| Json | Type | Comment |
+|------|------|---------|
+| binding | `string` |  |

support/go/tincwebui/client.go

@@ -20,6 +20,11 @@ type Endpoint struct {
 	Kind EndpointKind `json:"kind"`
 }
 
+//
+type Config struct {
+	Binding string `json:"binding"`
+}
+
 func Default() *TincWebUIClient {
 	return &TincWebUIClient{BaseURL: "http://127.0.0.1:8686/api/"}
 }
@@ -46,3 +51,9 @@ func (impl *TincWebUIClient) Endpoints(ctx context.Context) (reply []Endpoint, e
 	err = client.CallHTTP(ctx, impl.BaseURL, "TincWebUI.Endpoints", atomic.AddUint64(&impl.sequence, 1), &reply)
 	return
 }
+
+// Configuration defined for the instance
+func (impl *TincWebUIClient) Configuration(ctx context.Context) (reply *Config, err error) {
+	err = client.CallHTTP(ctx, impl.BaseURL, "TincWebUI.Configuration", atomic.AddUint64(&impl.sequence, 1), &reply)
+	return
+}

support/js/tincwebui.js

@@ -56,6 +56,18 @@ export class TincWebUI {
         }));
     }
 
+    /**
+    Configuration defined for the instance
+    **/
+    async configuration(){
+        return (await this.__call('Configuration', {
+            "jsonrpc" : "2.0",
+            "method" : "TincWebUI.Configuration",
+            "id" : this.__next_id(),
+            "params" : []
+        }));
+    }
+
 
 
     __next_id() {

support/postman/tincwebui.json

@@ -122,6 +122,45 @@
         },
         "description": "# TincWebUI.Endpoints\n\nEndpoints list to access web UI\n\n* Method: `TincWebUI.Endpoints`\n* Returns: `[]Endpoint`\n\n### Endpoint\n\n| Json | Type | Comment |\n|------|------|---------|\n| host | `string` |  |\n| port | `uint16` |  |\n| kind | `EndpointKind` |  |\n\n"
       }
+    },
+    {
+      "name": "Configuration",
+      "request": {
+        "method": "POST",
+        "header": [
+          {
+            "key": "Content-Type",
+            "value": "application/json",
+            "type": "text"
+          }
+        ],
+        "body": {
+          "mode": "raw",
+          "raw": "{\n  \"jsonrpc\": \"2.0\",\n  \"method\": \"TincWebUI.Configuration\",\n  \"id\": 1,\n  \"params\": {}\n}",
+          "options": {
+            "raw": {
+              "language": "json"
+            }
+          }
+        },
+        "url": {
+          "raw": "http://127.0.0.1:8686/api/",
+          "protocol": "http",
+          "host": [
+            "127",
+            "0",
+            "0",
+            "1"
+          ],
+          "port": "8686",
+          "path": [
+            "",
+            "api",
+            ""
+          ]
+        },
+        "description": "# TincWebUI.Configuration\n\nConfiguration defined for the instance\n\n* Method: `TincWebUI.Configuration`\n* Returns: `*Config`\n\n### Config\n\n| Json | Type | Comment |\n|------|------|---------|\n| binding | `string` |  |\n\n"
+      }
     }
   ]
 }

support/python/tincwebui.py

@@ -41,6 +41,22 @@ def from_json(payload: dict) -> 'Endpoint':
         )
 
 
+@dataclass
+class Config:
+    binding: 'str'
+
+    def to_json(self) -> dict:
+        return {
+            "binding": self.binding,
+        }
+
+    @staticmethod
+    def from_json(payload: dict) -> 'Config':
+        return Config(
+                binding=payload['binding'],
+        )
+
+
 class TincWebUIError(RuntimeError):
     def __init__(self, method: str, code: int, message: str, data: Any):
         super().__init__('{}: {}: {} - {}'.format(method, code, message, data))
@@ -119,3 +135,19 @@ async def endpoints(self) -> List[Endpoint]:
         if 'error' in payload:
             raise TincWebUIError.from_json('endpoints', payload['error'])
         return [Endpoint.from_json(x) for x in (payload['result'] or [])]
+
+    async def configuration(self) -> Config:
+        """
+        Configuration defined for the instance
+        """
+        response = await self.__request('POST', self.__url, json={
+            "jsonrpc": "2.0",
+            "method": "TincWebUI.Configuration",
+            "id": self.__next_id(),
+            "params": []
+        })
+        assert response.status // 100 == 2, str(response.status) + " " + str(response.reason)
+        payload = await response.json()
+        if 'error' in payload:
+            raise TincWebUIError.from_json('configuration', payload['error'])
+        return Config.from_json(payload['result'])

support/ts/tincweb.ts

@@ -70,7 +70,7 @@ export interface Upgrade {
 
 
 
-export type Duration = string; // suffixes: ns, us, ms, s, m, h (!!!!)
+export type Duration = string; // suffixes: ns, us, ms, s, m, h
 
 
 // support stuff

support/ts/tincwebui.ts

@@ -16,6 +16,10 @@ export interface Endpoint {
     kind: EndpointKind
 }
 
+export interface Config {
+    binding: string
+}
+
 
 
 export enum EndpointKind {
@@ -220,6 +224,18 @@ export class TincWebUI {
         })) as Array<Endpoint>;
     }
 
+    /**
+    Configuration defined for the instance
+    **/
+    async configuration(): Promise<Config> {
+        return (await this.__call({
+            "jsonrpc" : "2.0",
+            "method" : "TincWebUI.Configuration",
+            "id" : this.__next_id(),
+            "params" : []
+        })) as Config;
+    }
+
 
     private __next_id() {
         this.__id += 1;

web/routes.go

@@ -22,6 +22,7 @@ type Config struct {
 	AuthKey         string
 	LocalUIPort     uint16
 	PublicAddresses []string
+	Binding         string
 }
 
 //go:generate go-bindata -pkg web -prefix ui/build/ -fs ui/build/...
@@ -60,6 +61,7 @@ func (cfg Config) New(pool *tincd.Tincd) (*gin.Engine, *uiRoutes) {
 		port:          cfg.LocalUIPort,
 		publicAddress: cfg.PublicAddresses,
 		pool:          pool,
+		config:        shared.Config{Binding: cfg.Binding},
 	}
 
 	internal.RegisterTincWeb(&jsonRouter, &api{pool: pool, publicAddress: cfg.PublicAddresses, key: cfg.AuthKey})

web/routes_ui.go

@@ -15,6 +15,7 @@ type uiRoutes struct {
 	key           string
 	port          uint16
 	publicAddress []string
+	config        shared.Config
 	pool          *tincd.Tincd
 }
 
@@ -78,3 +79,7 @@ func (srv *uiRoutes) Endpoints() ([]shared.Endpoint, error) {
 	}
 	return ans, nil
 }
+
+func (srv *uiRoutes) Configuration() (*shared.Config, error) {
+	return &srv.config, nil
+}

web/shared/interface.go

@@ -71,6 +71,10 @@ type Endpoint struct {
 	Kind EndpointKind `json:"kind"`
 }
 
+type Config struct {
+	Binding string `json:"binding"`
+}
+
 // Operations with tinc-web-boot related to UI
 type TincWebUI interface {
 	// Issue and sign token
@@ -79,6 +83,8 @@ type TincWebUI interface {
 	Notify(title, message string) (bool, error)
 	// Endpoints list to access web UI
 	Endpoints() ([]Endpoint, error)
+	// Configuration defined for the instance
+	Configuration() (*Config, error)
 }
 
 // Operations for joining public network