aboutsummaryrefslogtreecommitdiff
path: root/cmd/client-api-proxy/main.go
diff options
context:
space:
mode:
authorruben <code@rbn.im>2019-05-21 22:56:55 +0200
committerBrendan Abolivier <babolivier@matrix.org>2019-05-21 21:56:55 +0100
commit74827428bd3e11faab65f12204449c1b9469b0ae (patch)
tree0decafa542436a0667ed2d3e3cfd4df0f03de1e5 /cmd/client-api-proxy/main.go
parent4d588f7008afe5600219ac0930c2eee2de5c447b (diff)
use go module for dependencies (#594)
Diffstat (limited to 'cmd/client-api-proxy/main.go')
-rw-r--r--cmd/client-api-proxy/main.go173
1 files changed, 173 insertions, 0 deletions
diff --git a/cmd/client-api-proxy/main.go b/cmd/client-api-proxy/main.go
new file mode 100644
index 00000000..b602016d
--- /dev/null
+++ b/cmd/client-api-proxy/main.go
@@ -0,0 +1,173 @@
+// Copyright 2017 Vector Creations Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+ "flag"
+ "fmt"
+ log "github.com/sirupsen/logrus"
+ "net/http"
+ "net/http/httputil"
+ "net/url"
+ "os"
+ "strings"
+ "time"
+)
+
+const usage = `Usage: %s
+
+Create a single endpoint URL which clients can be pointed at.
+
+The client-server API in Dendrite is split across multiple processes
+which listen on multiple ports. You cannot point a Matrix client at
+any of those ports, as there will be unimplemented functionality.
+In addition, all client-server API processes start with the additional
+path prefix '/api', which Matrix clients will be unaware of.
+
+This tool will proxy requests for all client-server URLs and forward
+them to their respective process. It will also add the '/api' path
+prefix to incoming requests.
+
+THIS TOOL IS FOR TESTING AND NOT INTENDED FOR PRODUCTION USE.
+
+Arguments:
+
+`
+
+var (
+ syncServerURL = flag.String("sync-api-server-url", "", "The base URL of the listening 'dendrite-sync-api-server' process. E.g. 'http://localhost:4200'")
+ clientAPIURL = flag.String("client-api-server-url", "", "The base URL of the listening 'dendrite-client-api-server' process. E.g. 'http://localhost:4321'")
+ mediaAPIURL = flag.String("media-api-server-url", "", "The base URL of the listening 'dendrite-media-api-server' process. E.g. 'http://localhost:7779'")
+ publicRoomsAPIURL = flag.String("public-rooms-api-server-url", "", "The base URL of the listening 'dendrite-public-rooms-api-server' process. E.g. 'http://localhost:7775'")
+ bindAddress = flag.String("bind-address", ":8008", "The listening port for the proxy.")
+ certFile = flag.String("tls-cert", "", "The PEM formatted X509 certificate to use for TLS")
+ keyFile = flag.String("tls-key", "", "The PEM private key to use for TLS")
+)
+
+func makeProxy(targetURL string) (*httputil.ReverseProxy, error) {
+ if !strings.HasSuffix(targetURL, "/") {
+ targetURL += "/"
+ }
+ // Check that we can parse the URL.
+ _, err := url.Parse(targetURL)
+ if err != nil {
+ return nil, err
+ }
+ return &httputil.ReverseProxy{
+ Director: func(req *http.Request) {
+ // URL.Path() removes the % escaping from the path.
+ // The % encoding will be added back when the url is encoded
+ // when the request is forwarded.
+ // This means that we will lose any unessecary escaping from the URL.
+ // Pratically this means that any distinction between '%2F' and '/'
+ // in the URL will be lost by the time it reaches the target.
+ path := req.URL.Path
+ path = "api" + path
+ log.WithFields(log.Fields{
+ "path": path,
+ "url": targetURL,
+ "method": req.Method,
+ }).Print("proxying request")
+ newURL, err := url.Parse(targetURL)
+ // Set the path separately as we need to preserve '#' characters
+ // that would otherwise be interpreted as being the start of a URL
+ // fragment.
+ newURL.Path += path
+ if err != nil {
+ // We already checked that we can parse the URL
+ // So this shouldn't ever get hit.
+ panic(err)
+ }
+ // Copy the query parameters from the request.
+ newURL.RawQuery = req.URL.RawQuery
+ req.URL = newURL
+ },
+ }, nil
+}
+
+func main() {
+ flag.Usage = func() {
+ fmt.Fprintf(os.Stderr, usage, os.Args[0])
+ flag.PrintDefaults()
+ }
+
+ flag.Parse()
+
+ if *syncServerURL == "" {
+ flag.Usage()
+ fmt.Fprintln(os.Stderr, "no --sync-api-server-url specified.")
+ os.Exit(1)
+ }
+
+ if *clientAPIURL == "" {
+ flag.Usage()
+ fmt.Fprintln(os.Stderr, "no --client-api-server-url specified.")
+ os.Exit(1)
+ }
+
+ if *mediaAPIURL == "" {
+ flag.Usage()
+ fmt.Fprintln(os.Stderr, "no --media-api-server-url specified.")
+ os.Exit(1)
+ }
+
+ if *publicRoomsAPIURL == "" {
+ flag.Usage()
+ fmt.Fprintln(os.Stderr, "no --public-rooms-api-server-url specified.")
+ os.Exit(1)
+ }
+
+ syncProxy, err := makeProxy(*syncServerURL)
+ if err != nil {
+ panic(err)
+ }
+ clientProxy, err := makeProxy(*clientAPIURL)
+ if err != nil {
+ panic(err)
+ }
+ mediaProxy, err := makeProxy(*mediaAPIURL)
+ if err != nil {
+ panic(err)
+ }
+ publicRoomsProxy, err := makeProxy(*publicRoomsAPIURL)
+ if err != nil {
+ panic(err)
+ }
+
+ http.Handle("/_matrix/client/r0/sync", syncProxy)
+ http.Handle("/_matrix/client/r0/directory/list/", publicRoomsProxy)
+ http.Handle("/_matrix/client/r0/publicRooms", publicRoomsProxy)
+ http.Handle("/_matrix/media/v1/", mediaProxy)
+ http.Handle("/", clientProxy)
+
+ srv := &http.Server{
+ Addr: *bindAddress,
+ ReadTimeout: 1 * time.Minute, // how long we wait for the client to send the entire request (after connection accept)
+ WriteTimeout: 5 * time.Minute, // how long the proxy has to write the full response
+ }
+
+ fmt.Println("Proxying requests to:")
+ fmt.Println(" /_matrix/client/r0/sync => ", *syncServerURL+"/api/_matrix/client/r0/sync")
+ fmt.Println(" /_matrix/client/r0/directory/list => ", *publicRoomsAPIURL+"/_matrix/client/r0/directory/list")
+ fmt.Println(" /_matrix/client/r0/publicRooms => ", *publicRoomsAPIURL+"/_matrix/media/client/r0/publicRooms")
+ fmt.Println(" /_matrix/media/v1 => ", *mediaAPIURL+"/api/_matrix/media/v1")
+ fmt.Println(" /* => ", *clientAPIURL+"/api/*")
+ fmt.Println("Listening on ", *bindAddress)
+ if *certFile != "" && *keyFile != "" {
+ panic(srv.ListenAndServeTLS(*certFile, *keyFile))
+ } else {
+ panic(srv.ListenAndServe())
+ }
+}