├── .gitignore ├── flowchart.png ├── Dockerfile.ci ├── go.mod ├── Dockerfile ├── .editorconfig ├── example-config.yaml ├── main.go ├── .gitlab-ci.yml ├── config.go ├── README.md ├── syncproxy.go ├── transaction.go ├── websocket.go ├── go.sum └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | config.yaml 2 | -------------------------------------------------------------------------------- /flowchart.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mautrix/wsproxy/HEAD/flowchart.png -------------------------------------------------------------------------------- /Dockerfile.ci: -------------------------------------------------------------------------------- 1 | FROM scratch 2 | 3 | ARG EXECUTABLE=./mautrix-wsproxy 4 | COPY $EXECUTABLE /usr/bin/mautrix-wsproxy 5 | 6 | ENV LISTEN_ADDRESS=:29331 7 | 8 | CMD ["/usr/bin/mautrix-wsproxy", "-config", "env"] 9 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module go.mau.fi/mautrix-wsproxy 2 | 3 | go 1.16 4 | 5 | require ( 6 | github.com/gorilla/mux v1.8.0 7 | github.com/gorilla/websocket v1.4.2 8 | gopkg.in/yaml.v2 v2.4.0 9 | maunium.net/go/mautrix v0.9.22 10 | ) 11 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1-alpine AS builder 2 | 3 | COPY . /build 4 | WORKDIR /build 5 | RUN CGO_ENABLED=0 go build -o /usr/bin/mautrix-wsproxy 6 | 7 | FROM scratch 8 | 9 | COPY --from=builder /usr/bin/mautrix-wsproxy /usr/bin/mautrix-wsproxy 10 | 11 | ENV LISTEN_ADDRESS=:29331 12 | 13 | CMD ["/usr/bin/mautrix-wsproxy", "-config", "env"] 14 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | indent_size = 4 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [*.{yaml,yml,md}] 12 | indent_style = space 13 | indent_size = 2 14 | 15 | [*.md] 16 | max_line_length = 80 17 | 18 | [.gitlab-ci.yml] 19 | indent_size = 2 20 | -------------------------------------------------------------------------------- /example-config.yaml: -------------------------------------------------------------------------------- 1 | listen_address: localhost:29331 2 | appservices: 3 | - id: imessage 4 | as: put your as_token here 5 | hs: put your hs_token here 6 | sync_proxy: 7 | # The URL that mautrix-wsproxy can use to reach mautrix-syncproxy 8 | url: http://localhost:29332 9 | # The URL that mautrix-syncproxy can use to reach mautrix-wsproxy 10 | wsproxy_url: http://localhost:29331 11 | shared_secret: null 12 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | // mautrix-wsproxy - A simple HTTP push -> websocket proxy for Matrix appservices. 2 | // Copyright (C) 2021 Tulir Asokan 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | 17 | package main 18 | 19 | import ( 20 | "context" 21 | "log" 22 | "net/http" 23 | "os" 24 | "os/signal" 25 | "syscall" 26 | "time" 27 | 28 | "github.com/gorilla/mux" 29 | "github.com/gorilla/websocket" 30 | ) 31 | 32 | func main() { 33 | loadConfig() 34 | router := mux.NewRouter() 35 | router.HandleFunc("/transactions/{txnID}", putTransaction).Methods(http.MethodPut) 36 | router.HandleFunc("/_matrix/app/v1/transactions/{txnID}", putTransaction).Methods(http.MethodPut) 37 | router.HandleFunc("/_matrix/app/unstable/fi.mau.syncproxy/error/{txnID}", putSyncProxyError).Methods(http.MethodPut) 38 | router.HandleFunc("/_matrix/client/unstable/fi.mau.as_sync", syncWebsocket).Methods(http.MethodGet) 39 | server := &http.Server{ 40 | Addr: cfg.ListenAddress, 41 | Handler: router, 42 | } 43 | go func() { 44 | log.Println("Starting to listen on", cfg.ListenAddress) 45 | err := server.ListenAndServe() 46 | if err != nil && err != http.ErrServerClosed { 47 | log.Fatalln("Error in listener:", err) 48 | } 49 | }() 50 | 51 | c := make(chan os.Signal) 52 | signal.Notify(c, os.Interrupt, syscall.SIGTERM) 53 | <-c 54 | 55 | for _, az := range cfg.AppServices { 56 | go func(oldConn *websocket.Conn) { 57 | if oldConn == nil { 58 | return 59 | } 60 | msg := websocket.FormatCloseMessage(websocket.CloseGoingAway, `{"command": "disconnect", "status": "server_shutting_down"}`) 61 | _ = oldConn.WriteControl(websocket.CloseMessage, msg, time.Now().Add(3*time.Second)) 62 | _ = oldConn.Close() 63 | }(az.conn) 64 | } 65 | 66 | ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) 67 | defer cancel() 68 | err := server.Shutdown(ctx) 69 | if err != nil { 70 | log.Println("Failed to close server:", err) 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | stages: 2 | - build 3 | - build docker 4 | - manifest 5 | 6 | build: 7 | stage: build 8 | image: golang:1-alpine 9 | cache: 10 | paths: 11 | - .cache 12 | variables: 13 | CGO_ENABLED: "0" 14 | before_script: 15 | - mkdir -p .cache 16 | - export GOPATH="$CI_PROJECT_DIR/.cache" 17 | - export GOCACHE="$CI_PROJECT_DIR/.cache/build" 18 | - export GOFLAGS="-buildvcs=false" 19 | script: 20 | - GOARCH=amd64 go build -o mautrix-wsproxy-amd64 21 | - GOARCH=arm64 go build -o mautrix-wsproxy-arm64 22 | - GOARCH=arm go build -o mautrix-wsproxy-arm 23 | artifacts: 24 | paths: 25 | - mautrix-wsproxy-amd64 26 | - mautrix-wsproxy-arm64 27 | - mautrix-wsproxy-arm 28 | - example-config.yaml 29 | 30 | .build-docker: &build-docker 31 | image: docker:stable 32 | stage: build docker 33 | dependencies: 34 | - build 35 | needs: 36 | - build 37 | before_script: 38 | - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY 39 | script: 40 | - docker pull $CI_REGISTRY_IMAGE:latest || true 41 | - docker build --pull --cache-from $CI_REGISTRY_IMAGE:latest --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-$DOCKER_ARCH . --file Dockerfile.ci --build-arg EXECUTABLE=./mautrix-wsproxy-$DOCKER_ARCH 42 | - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-$DOCKER_ARCH 43 | - docker rmi $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-$DOCKER_ARCH 44 | 45 | build docker amd64: 46 | <<: *build-docker 47 | tags: 48 | - amd64 49 | variables: 50 | DOCKER_ARCH: amd64 51 | 52 | build docker arm64: 53 | <<: *build-docker 54 | tags: 55 | - arm64 56 | variables: 57 | DOCKER_ARCH: arm64 58 | 59 | manifest: 60 | stage: manifest 61 | variables: 62 | GIT_STRATEGY: none 63 | before_script: 64 | - "mkdir -p $HOME/.docker && echo '{\"experimental\": \"enabled\"}' > $HOME/.docker/config.json" 65 | - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY 66 | needs: 67 | - build docker amd64 68 | - build docker arm64 69 | script: 70 | - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 71 | - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 72 | - if [ "$CI_COMMIT_BRANCH" = "master" ]; then docker manifest create $CI_REGISTRY_IMAGE:latest $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 && docker manifest push $CI_REGISTRY_IMAGE:latest; fi 73 | - if [ "$CI_COMMIT_BRANCH" != "master" ]; then docker manifest create $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 && docker manifest push $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME; fi 74 | - docker rmi $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-amd64 $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA-arm64 75 | -------------------------------------------------------------------------------- /config.go: -------------------------------------------------------------------------------- 1 | // mautrix-wsproxy - A simple HTTP push -> websocket proxy for Matrix appservices. 2 | // Copyright (C) 2021 Tulir Asokan 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | 17 | package main 18 | 19 | import ( 20 | "flag" 21 | "fmt" 22 | "log" 23 | "net/url" 24 | "os" 25 | 26 | "gopkg.in/yaml.v2" 27 | ) 28 | 29 | type Config struct { 30 | ListenAddress string `yaml:"listen_address"` 31 | AppServices []*AppService `yaml:"appservices"` 32 | 33 | SyncProxy SyncProxyConfig `yaml:"sync_proxy"` 34 | 35 | byASToken map[string]*AppService `yaml:"-"` 36 | byHSToken map[string]*AppService `yaml:"-"` 37 | } 38 | 39 | type SyncProxyConfig struct { 40 | URL string `yaml:"url"` 41 | OwnURL string `yaml:"wsproxy_url"` 42 | SharedSecret string `yaml:"shared_secret"` 43 | } 44 | 45 | func (spc *SyncProxyConfig) MakeURL(appserviceID string) (string, error) { 46 | spURL, err := url.Parse(cfg.SyncProxy.URL) 47 | if err != nil { 48 | return "", fmt.Errorf("failed to parse sync proxy URL: %w", err) 49 | } 50 | spURL.Path = fmt.Sprintf("/_matrix/client/unstable/fi.mau.syncproxy/%s", appserviceID) 51 | return spURL.String(), nil 52 | } 53 | 54 | var cfg Config 55 | 56 | var configPath = flag.String("config", "config.yaml", "path to config file") 57 | 58 | func loadConfig() { 59 | flag.Parse() 60 | if *configPath == "env" { 61 | cfg.ListenAddress = os.Getenv("LISTEN_ADDRESS") 62 | cfg.AppServices = []*AppService{{ 63 | ID: os.Getenv("APPSERVICE_ID"), 64 | AS: os.Getenv("AS_TOKEN"), 65 | HS: os.Getenv("HS_TOKEN"), 66 | }} 67 | cfg.SyncProxy.URL = os.Getenv("SYNC_PROXY_URL") 68 | cfg.SyncProxy.OwnURL = os.Getenv("SYNC_PROXY_WSPROXY_URL") 69 | cfg.SyncProxy.SharedSecret = os.Getenv("SYNC_PROXY_SHARED_SECRET") 70 | if len(cfg.ListenAddress) == 0 { 71 | log.Fatalln("LISTEN_ADDRESS environment variable is not set") 72 | } else if len(cfg.AppServices[0].ID) == 0 { 73 | log.Fatalln("APPSERVICE_ID environment variable is not set") 74 | } else if len(cfg.AppServices[0].AS) == 0 { 75 | log.Fatalln("AS_TOKEN environment variable is not set") 76 | } else if len(cfg.AppServices[0].HS) == 0 { 77 | log.Fatalln("HS_TOKEN environment variable is not set") 78 | } 79 | log.Printf("Found one appservice from environment variables") 80 | } else { 81 | file, err := os.Open(*configPath) 82 | if err != nil { 83 | log.Fatalln("Failed to open config:", err) 84 | } 85 | err = yaml.NewDecoder(file).Decode(&cfg) 86 | if err != nil { 87 | log.Fatalln("Failed to read config:", err) 88 | } else if len(cfg.AppServices) == 0 { 89 | log.Fatalln("No appservices configured") 90 | } else if len(cfg.ListenAddress) == 0 { 91 | log.Fatalln("Listen address not configured") 92 | } 93 | appservices := "appservices" 94 | if len(cfg.AppServices) == 1 { 95 | appservices = "appservice" 96 | } 97 | log.Println("Found", len(cfg.AppServices), appservices, "in", *configPath) 98 | } 99 | cfg.byHSToken = make(map[string]*AppService) 100 | cfg.byASToken = make(map[string]*AppService) 101 | for i, az := range cfg.AppServices { 102 | if len(az.ID) == 0 { 103 | log.Fatalf("Appservice #%d doesn't have an ID", i+1) 104 | } else if len(az.AS) == 0 { 105 | log.Fatalf("Appservice %s doesn't have the AS token set", az.ID) 106 | } else if len(az.AS) == 0 { 107 | log.Fatalf("Appservice %s doesn't have the HS token set", az.ID) 108 | } 109 | cfg.byASToken[az.AS] = az 110 | cfg.byHSToken[az.HS] = az 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mautrix-wsproxy 2 | A simple HTTP push -> websocket proxy for Matrix appservices. 3 | 4 | This is used by [mautrix-imessage](https://github.com/mautrix/imessage) 5 | to receive appservice transactions without opening a port to the local Mac 6 | where the bridge runs. In general, you should run wsproxy in the same place as 7 | your homeserver and use your existing reverse proxy to secure the websocket 8 | connection between the bridge and wsproxy. 9 | 10 | ![flowchart](./flowchart.png) 11 | 12 | ## Setup 13 | You can download a prebuilt executable from [the CI] or [GitHub releases]. The 14 | executables are statically compiled and have no dependencies. Alternatively, 15 | you can build from source: 16 | 17 | 0. Have [Go](https://golang.org/) 1.16 or higher installed. 18 | 1. Clone the repository (`git clone https://github.com/mautrix/wsproxy.git`). 19 | 2. Build with `go build -o mautrix-wsproxy`. The resulting executable will be 20 | in the current directory named `mautrix-wsproxy`. 21 | 22 | After you have the executable ready, configure and run mautrix-wsproxy: 23 | 24 | 1. Copy `example-config.yaml` from the root of the repo to `config.yaml` 25 | and fill out the fields (with the tokens from the registration file). 26 | 2. Change the appservice registration file to point your homeserver at 27 | mautrix-wsproxy. The registration's `url` field should have a `http://` 28 | address that your homeserver can use to reach mautrix-wsproxy. Restart 29 | homeserver after registration changes. 30 | 3. Change the bridge config (`homeserver` -> `websocket_proxy`) 31 | to point at mautrix-wsproxy (the URL should have `ws://` or `wss://`). 32 | 4. Run the proxy with `mautrix-wsproxy` and start the bridge. 33 | 34 | [the CI]: https://mau.dev/mautrix/wsproxy/-/pipelines 35 | [GitHub releases]: https://github.com/mautrix/wsproxy/releases 36 | 37 | ## Sample docker-compose file 38 | The compose files here also include [mautrix-syncproxy]. It's mostly needed for 39 | the Android SMS bridge (to save battery), but can be used with iMessage as well. 40 | You can omit it if you don't use the `bridge`→`encryption`→`appservice` option. 41 | 42 | [mautrix-syncproxy]: https://github.com/mautrix/syncproxy 43 | 44 | ```yaml 45 | version: "3.7" 46 | 47 | services: 48 | mautrix-wsproxy: 49 | container_name: mautrix-wsproxy 50 | image: dock.mau.dev/mautrix/wsproxy 51 | restart: unless-stopped 52 | ports: 53 | - 29331 54 | environment: 55 | #LISTEN_ADDRESS: ":29331" 56 | APPSERVICE_ID: imessage 57 | AS_TOKEN: put your as_token here 58 | HS_TOKEN: put your hs_token here 59 | # These URLs will work as-is with docker networking 60 | SYNC_PROXY_URL: http://mautrix-syncproxy:29332 61 | SYNC_PROXY_WSPROXY_URL: http://mautrix-wsproxy:29331 62 | SYNC_PROXY_SHARED_SECRET: random string here 63 | 64 | mautrix-syncproxy: 65 | container_name: mautrix-syncproxy 66 | image: dock.mau.dev/mautrix/syncproxy 67 | restart: unless-stopped 68 | environment: 69 | #LISTEN_ADDRESS: ":29332" 70 | DATABASE_URL: postgres://user:pass@host/mautrixsyncproxy 71 | HOMESERVER_URL: http://localhost:8008 72 | SHARED_SECRET: same random string as above here 73 | ``` 74 | 75 | ### Docker with multiple appservices 76 | The environment variables only support one appservice at a time, so you'll need 77 | to use a config file if you want more: 78 | 79 | ```yaml 80 | version: "3.7" 81 | 82 | services: 83 | mautrix-wsproxy: 84 | container_name: mautrix-wsproxy 85 | image: dock.mau.dev/mautrix/wsproxy 86 | restart: unless-stopped 87 | command: /usr/bin/mautrix-wsproxy -config /data/config.yaml 88 | volumes: 89 | - ./config:/data 90 | ports: 91 | - 29331 92 | environment: 93 | #LISTEN_ADDRESS: ":29331" 94 | 95 | mautrix-syncproxy: 96 | container_name: mautrix-syncproxy 97 | image: dock.mau.dev/mautrix/syncproxy 98 | restart: unless-stopped 99 | environment: 100 | #LISTEN_ADDRESS: ":29332" 101 | DATABASE_URL: postgres://user:pass@host/mautrixsyncproxy 102 | HOMESERVER_URL: http://localhost:8008 103 | SHARED_SECRET: random string here 104 | ``` 105 | -------------------------------------------------------------------------------- /syncproxy.go: -------------------------------------------------------------------------------- 1 | // mautrix-wsproxy - A simple HTTP push -> websocket proxy for Matrix appservices. 2 | // Copyright (C) 2021 Tulir Asokan 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | 17 | package main 18 | 19 | import ( 20 | "bytes" 21 | "encoding/json" 22 | "fmt" 23 | "io" 24 | "log" 25 | "net/http" 26 | "time" 27 | 28 | "maunium.net/go/mautrix" 29 | "maunium.net/go/mautrix/id" 30 | ) 31 | 32 | var syncProxyClient = http.Client{Timeout: 2 * time.Minute} 33 | 34 | // WSStartSyncRequest represents the content that bridges will send in start_sync requests. 35 | type WSStartSyncRequest struct { 36 | AccessToken string `json:"access_token"` 37 | UserID id.UserID `json:"user_id"` 38 | DeviceID id.DeviceID `json:"device_id"` 39 | } 40 | 41 | // SPStartSyncRequest represents the content that mautrix-syncproxy expects in PUT /fi.mau.syncproxy requests. 42 | type SPStartSyncRequest struct { 43 | AppserviceID string `json:"appservice_id"` 44 | UserID id.UserID `json:"user_id"` 45 | BotAccessToken string `json:"bot_access_token"` 46 | DeviceID id.DeviceID `json:"device_id"` 47 | HSToken string `json:"hs_token"` 48 | Address string `json:"address"` 49 | IsProxy bool `json:"is_proxy"` 50 | } 51 | 52 | // Sync proxy responses should be fairly small, so limit to 1 MiB 53 | const maxBodySize = 1024 * 1024 54 | 55 | func makeSyncProxyRequest(method, appserviceID string, data interface{}) error { 56 | var buf io.ReadWriter 57 | 58 | if data != nil { 59 | buf = &bytes.Buffer{} 60 | err := json.NewEncoder(buf).Encode(&data) 61 | if err != nil { 62 | return fmt.Errorf("failed to encode JSON for mautrix-syncproxy: %w", err) 63 | } 64 | } 65 | 66 | var err error 67 | var spURL string 68 | var req *http.Request 69 | var resp *http.Response 70 | var body []byte 71 | var respErr mautrix.RespError 72 | 73 | defer func() { 74 | if resp != nil && resp.Body != nil { 75 | _ = resp.Body.Close() 76 | } 77 | }() 78 | 79 | if spURL, err = cfg.SyncProxy.MakeURL(appserviceID); err != nil { 80 | return err 81 | } else if req, err = http.NewRequest(method, spURL, buf); err != nil { 82 | return fmt.Errorf("failed to prepare sync proxy %s request: %w", method, err) 83 | } else if req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", cfg.SyncProxy.SharedSecret)); len(cfg.SyncProxy.SharedSecret) == 0 { 84 | return fmt.Errorf("sync proxy shared secret not configured") 85 | } else if resp, err = syncProxyClient.Do(req); err != nil { 86 | return fmt.Errorf("failed to make sync proxy %s request: %w", method, err) 87 | } else if resp.StatusCode >= 200 && resp.StatusCode < 300 { 88 | return nil 89 | } else if body, err = io.ReadAll(io.LimitReader(resp.Body, maxBodySize)); err != nil { 90 | return fmt.Errorf("sync proxy returned HTTP %d and no body", resp.StatusCode) 91 | } else if err = json.Unmarshal(body, &respErr); err != nil { 92 | return fmt.Errorf("sync proxy returned HTTP %d and non-JSON body (%w): %s", resp.StatusCode, err, body) 93 | } 94 | return respErr 95 | } 96 | 97 | func (az *AppService) startSyncProxy(rawReq json.RawMessage) error { 98 | var wsReq WSStartSyncRequest 99 | err := json.Unmarshal(rawReq, &wsReq) 100 | log.Println("Starting sync proxy for", az.ID, "/", wsReq.UserID, "/", wsReq.DeviceID) 101 | if err != nil { 102 | return fmt.Errorf("failed to parse request JSON: %w", err) 103 | } 104 | return makeSyncProxyRequest(http.MethodPut, az.ID, &SPStartSyncRequest{ 105 | AppserviceID: az.ID, 106 | UserID: wsReq.UserID, 107 | BotAccessToken: wsReq.AccessToken, 108 | DeviceID: wsReq.DeviceID, 109 | HSToken: az.HS, 110 | Address: cfg.SyncProxy.OwnURL, 111 | IsProxy: false, 112 | }) 113 | } 114 | 115 | func (az *AppService) stopSyncProxy() error { 116 | return makeSyncProxyRequest(http.MethodDelete, az.ID, nil) 117 | } 118 | -------------------------------------------------------------------------------- /transaction.go: -------------------------------------------------------------------------------- 1 | // mautrix-wsproxy - A simple HTTP push -> websocket proxy for Matrix appservices. 2 | // Copyright (C) 2021 Tulir Asokan 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | 17 | package main 18 | 19 | import ( 20 | "encoding/json" 21 | "fmt" 22 | "log" 23 | "net/http" 24 | "strings" 25 | 26 | "github.com/gorilla/mux" 27 | "maunium.net/go/mautrix/appservice" 28 | ) 29 | 30 | var ( 31 | errMissingToken = appservice.Error{ 32 | HTTPStatus: http.StatusForbidden, 33 | ErrorCode: "M_MISSING_TOKEN", 34 | Message: "Missing authorization header", 35 | } 36 | errUnknownToken = appservice.Error{ 37 | HTTPStatus: http.StatusForbidden, 38 | ErrorCode: "M_UNKNOWN_TOKEN", 39 | Message: "Unknown authorization token", 40 | } 41 | errBadJSON = appservice.Error{ 42 | HTTPStatus: http.StatusBadRequest, 43 | ErrorCode: "M_BAD_JSON", 44 | Message: "Failed to decode request JSON", 45 | } 46 | errSendFail = appservice.Error{ 47 | HTTPStatus: http.StatusBadGateway, 48 | ErrorCode: "FI.MAU.WS_SEND_FAIL", 49 | Message: "Failed to send data through websocket", 50 | } 51 | errNotConnected = appservice.Error{ 52 | HTTPStatus: http.StatusBadGateway, 53 | ErrorCode: "FI.MAU.WS_NOT_CONNECTED", 54 | Message: "Endpoint is not connected to websocket", 55 | } 56 | ) 57 | 58 | func readTransaction(w http.ResponseWriter, r *http.Request, into interface{}) *AppService { 59 | var token string 60 | authHeader := r.Header.Get("Authorization") 61 | if !strings.HasPrefix(authHeader, "Bearer ") { 62 | token = r.URL.Query().Get("access_token") 63 | } else { 64 | token = authHeader[len("Bearer "):] 65 | } 66 | w.Header().Add("Content-Type", "application/json") 67 | if len(token) == 0 { 68 | errMissingToken.Write(w) 69 | return nil 70 | } 71 | az, ok := cfg.byHSToken[token] 72 | if !ok { 73 | errUnknownToken.Write(w) 74 | return nil 75 | } 76 | err := json.NewDecoder(r.Body).Decode(into) 77 | if err != nil { 78 | errBadJSON.Write(w) 79 | return nil 80 | } 81 | return az 82 | } 83 | 84 | func writeTransaction(w http.ResponseWriter, az *AppService, txnName, logContent string, payload interface{}) { 85 | conn := az.Conn() 86 | if conn != nil { 87 | az.writeLock.Lock() 88 | log.Printf("Sending %s to %s containing %s", txnName, az.ID, logContent) 89 | err := conn.WriteJSON(payload) 90 | az.writeLock.Unlock() 91 | if err != nil { 92 | log.Printf("Rejecting %s to %s: %v", txnName, az.ID, err) 93 | errSendFail.Write(w) 94 | } else { 95 | log.Printf("Sent %s to %s successfully", txnName, az.ID) 96 | appservice.WriteBlankOK(w) 97 | } 98 | } else { 99 | log.Printf("Rejecting %s to %s: websocket not connected", txnName, az.ID) 100 | errNotConnected.Write(w) 101 | } 102 | } 103 | 104 | func putTransaction(w http.ResponseWriter, r *http.Request) { 105 | var txn appservice.Transaction 106 | az := readTransaction(w, r, &txn) 107 | if az == nil { 108 | return 109 | } 110 | if txn.EphemeralEvents == nil && txn.MSC2409EphemeralEvents != nil { 111 | txn.EphemeralEvents = txn.MSC2409EphemeralEvents 112 | } 113 | if txn.DeviceLists == nil && txn.MSC3202DeviceLists != nil { 114 | txn.DeviceLists = txn.MSC3202DeviceLists 115 | } 116 | if txn.DeviceOTKCount == nil && txn.MSC3202DeviceOTKCount != nil { 117 | txn.DeviceOTKCount = txn.MSC3202DeviceOTKCount 118 | } 119 | deviceListChanges := 0 120 | if txn.DeviceLists != nil { 121 | deviceListChanges = len(txn.DeviceLists.Changed) 122 | } 123 | vars := mux.Vars(r) 124 | txnID := vars["txnID"] 125 | logContent := fmt.Sprintf("%d events, %d ephemeral events, %d OTK counts and %d device list changes", 126 | len(txn.Events), len(txn.EphemeralEvents), len(txn.DeviceOTKCount), deviceListChanges) 127 | txnName := fmt.Sprintf("transaction %s", txnID) 128 | writeTransaction(w, az, txnName, logContent, &appservice.WebsocketTransaction{ 129 | Status: "ok", 130 | TxnID: txnID, 131 | Transaction: txn, 132 | }) 133 | } 134 | 135 | type SyncProxyError struct { 136 | appservice.Error 137 | TxnID string `json:"txn_id"` 138 | } 139 | 140 | func putSyncProxyError(w http.ResponseWriter, r *http.Request) { 141 | var txn appservice.Error 142 | az := readTransaction(w, r, &txn) 143 | if az == nil { 144 | return 145 | } 146 | vars := mux.Vars(r) 147 | txnID := vars["txnID"] 148 | logContent := string(txn.ErrorCode) 149 | txnName := fmt.Sprintf("syncproxy error %s", txnID) 150 | writeTransaction(w, az, txnName, logContent, &appservice.WebsocketRequest{ 151 | Command: "syncproxy_error", 152 | Data: &SyncProxyError{ 153 | Error: txn, 154 | TxnID: txnID, 155 | }, 156 | }) 157 | } 158 | -------------------------------------------------------------------------------- /websocket.go: -------------------------------------------------------------------------------- 1 | // mautrix-wsproxy - A simple HTTP push -> websocket proxy for Matrix appservices. 2 | // Copyright (C) 2021 Tulir Asokan 3 | // 4 | // This program is free software: you can redistribute it and/or modify 5 | // it under the terms of the GNU Affero General Public License as published by 6 | // the Free Software Foundation, either version 3 of the License, or 7 | // (at your option) any later version. 8 | // 9 | // This program is distributed in the hope that it will be useful, 10 | // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | // GNU Affero General Public License for more details. 13 | // 14 | // You should have received a copy of the GNU Affero General Public License 15 | // along with this program. If not, see . 16 | 17 | package main 18 | 19 | import ( 20 | "encoding/json" 21 | "fmt" 22 | "log" 23 | "net/http" 24 | "runtime/debug" 25 | "strings" 26 | "sync" 27 | "time" 28 | 29 | "github.com/gorilla/websocket" 30 | "maunium.net/go/mautrix/appservice" 31 | ) 32 | 33 | type AppService struct { 34 | ID string `yaml:"id"` 35 | AS string `yaml:"as"` 36 | HS string `yaml:"hs"` 37 | 38 | conn *websocket.Conn `yaml:"-"` 39 | connLock sync.Mutex `yaml:"-"` 40 | writeLock sync.Mutex `yaml:"-"` 41 | } 42 | 43 | func (az *AppService) Conn() *websocket.Conn { 44 | return az.conn 45 | } 46 | 47 | const CloseConnReplaced = 4001 48 | 49 | var upgrader = websocket.Upgrader{} 50 | 51 | func syncWebsocket(w http.ResponseWriter, r *http.Request) { 52 | authHeader := r.Header.Get("Authorization") 53 | if !strings.HasPrefix(authHeader, "Bearer ") { 54 | errMissingToken.Write(w) 55 | return 56 | } 57 | az, ok := cfg.byASToken[authHeader[len("Bearer "):]] 58 | if !ok { 59 | errUnknownToken.Write(w) 60 | return 61 | } 62 | ws, err := upgrader.Upgrade(w, r, nil) 63 | if err != nil { 64 | log.Println("Failed to upgrade websocket request:", err) 65 | return 66 | } 67 | log.Println(az.ID, "connected to websocket") 68 | defer func() { 69 | log.Println(az.ID, "disconnected from websocket") 70 | az.connLock.Lock() 71 | if az.conn == ws { 72 | az.conn = nil 73 | err := az.stopSyncProxy() 74 | if err != nil { 75 | log.Println("Error requesting syncproxy stop after", az.ID, "disconnected:", err) 76 | } 77 | } 78 | az.connLock.Unlock() 79 | _ = ws.Close() 80 | }() 81 | err = ws.WriteMessage(websocket.TextMessage, []byte(`{"status": "connected"}`)) 82 | if err != nil { 83 | log.Printf("Failed to write welcome status message to %s: %v", az.ID, err) 84 | } 85 | az.connLock.Lock() 86 | if az.conn != nil { 87 | go func(oldConn *websocket.Conn) { 88 | msg := websocket.FormatCloseMessage(CloseConnReplaced, `{"command": "disconnect", "status": "conn_replaced"}`) 89 | _ = oldConn.WriteControl(websocket.CloseMessage, msg, time.Now().Add(3*time.Second)) 90 | _ = oldConn.Close() 91 | }(az.conn) 92 | } 93 | az.conn = ws 94 | az.connLock.Unlock() 95 | for { 96 | var msg appservice.WebsocketCommand 97 | err = ws.ReadJSON(&msg) 98 | if err != nil { 99 | log.Println("Error reading from websocket:", err) 100 | break 101 | } 102 | go handleCommand(az, ws, &msg) 103 | } 104 | } 105 | 106 | func handleCommand(az *AppService, ws *websocket.Conn, msg *appservice.WebsocketCommand) { 107 | defer func() { 108 | panicErr := recover() 109 | if panicErr != nil { 110 | log.Printf("Panic while responding to command %s in request #%d: %v\n%s", msg.Command, msg.ReqID, panicErr, debug.Stack()) 111 | } 112 | }() 113 | resp, err := actuallyHandleCommand(az, msg) 114 | if msg.ReqID != 0 { 115 | respPayload := appservice.WebsocketRequest{ 116 | ReqID: msg.ReqID, 117 | Command: "response", 118 | Data: resp, 119 | } 120 | if err != nil { 121 | respPayload.Command = "error" 122 | respPayload.Data = map[string]interface{}{ 123 | "message": err.Error(), 124 | } 125 | } 126 | az.writeLock.Lock() 127 | log.Printf("Sending response %+v", respPayload) 128 | err = ws.WriteJSON(&respPayload) 129 | az.writeLock.Unlock() 130 | if err != nil { 131 | log.Printf("Failed to send response to req #%d: %v", msg.ReqID, err) 132 | } 133 | } 134 | } 135 | 136 | type PingData struct { 137 | Timestamp int64 `json:"timestamp"` 138 | } 139 | 140 | func actuallyHandleCommand(az *AppService, msg *appservice.WebsocketCommand) (resp interface{}, err error) { 141 | defer func() { 142 | panicErr := recover() 143 | if panicErr != nil { 144 | log.Printf("Panic while handling command %s in request #%d: %v\n%s", msg.Command, msg.ReqID, panicErr, debug.Stack()) 145 | if err == nil { 146 | err = fmt.Errorf("internal server error") 147 | } 148 | } 149 | }() 150 | switch msg.Command { 151 | case "start_sync": 152 | err = az.startSyncProxy(msg.Data) 153 | if err != nil { 154 | log.Println("Error forwarding", az.ID, "sync proxy start request:", err) 155 | } 156 | case "ping": 157 | var req PingData 158 | jsonErr := json.Unmarshal(msg.Data, &req) 159 | now := time.Now() 160 | if req.Timestamp > 0 { 161 | pingStart := time.Unix(0, req.Timestamp * int64(time.Millisecond)) 162 | log.Printf("Received ping from %s in %s", az.ID, now.Sub(pingStart)) 163 | } else { 164 | log.Printf("Received ping from %s with no timestamp (json error: %v)", az.ID, jsonErr) 165 | } 166 | resp = &PingData{now.UnixNano() / int64(time.Millisecond)} 167 | default: 168 | log.Printf("Unknown command %s in request #%d from websocket. Data: %s", msg.Command, msg.ReqID, msg.Data) 169 | err = fmt.Errorf("unknown command %s", msg.Command) 170 | } 171 | return 172 | } 173 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/aead/siphash v1.0.1/go.mod h1:Nywa3cDsYNNK3gaciGTWPwHt0wlpNV15vwmswBAUSII= 2 | github.com/btcsuite/btcd v0.20.1-beta/go.mod h1:wVuoA8VJLEcwgqHBwHmzLRazpKxTv13Px/pDuV7OomQ= 3 | github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f/go.mod h1:TdznJufoqS23FtqVCzL0ZqgP5MqXbb4fg/WgDys70nA= 4 | github.com/btcsuite/btcutil v0.0.0-20190425235716-9e5f4b9a998d/go.mod h1:+5NJ2+qvTyV9exUAL/rxXi3DcLg2Ts+ymUAY5y4NvMg= 5 | github.com/btcsuite/btcutil v1.0.2 h1:9iZ1Terx9fMIOtq1VrwdqfsATL9MC2l8ZrUY6YZ2uts= 6 | github.com/btcsuite/btcutil v1.0.2/go.mod h1:j9HUFwoQRsZL3V4n+qG+CUnEGHOarIxfC3Le2Yhbcts= 7 | github.com/btcsuite/go-socks v0.0.0-20170105172521-4720035b7bfd/go.mod h1:HHNXQzUsZCxOoE+CPiyCTO6x34Zs86zZUiwtpXoGdtg= 8 | github.com/btcsuite/goleveldb v0.0.0-20160330041536-7834afc9e8cd/go.mod h1:F+uVaaLLH7j4eDXPRvw78tMflu7Ie2bzYOH4Y8rRKBY= 9 | github.com/btcsuite/snappy-go v0.0.0-20151229074030-0bdef8d06723/go.mod h1:8woku9dyThutzjeg+3xrA5iCpBRH8XEEg3lh6TiUghc= 10 | github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792/go.mod h1:ghJtEyQwv5/p4Mg4C0fgbePVuGr935/5ddU9Z3TmDRY= 11 | github.com/btcsuite/winsvc v1.0.0/go.mod h1:jsenWakMcC0zFBFurPLEAyrnc/teJEM1O46fmI40EZs= 12 | github.com/davecgh/go-spew v0.0.0-20171005155431-ecdeabc65495/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 13 | github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 14 | github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 15 | github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= 16 | github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= 17 | github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= 18 | github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= 19 | github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= 20 | github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 21 | github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU= 22 | github.com/jessevdk/go-flags v0.0.0-20141203071132-1679536dcc89/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI= 23 | github.com/jrick/logrotate v1.0.0/go.mod h1:LNinyqDIJnpAur+b8yyulnQw/wDuN1+BYKlTRt3OuAQ= 24 | github.com/kkdai/bstream v0.0.0-20161212061736-f391b8402d23/go.mod h1:J+Gs4SYgM6CZQHDETBtE9HaSEkGmuNXF86RwHhHUvq4= 25 | github.com/lib/pq v1.9.0/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= 26 | github.com/mattn/go-sqlite3 v1.14.6/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= 27 | github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= 28 | github.com/onsi/ginkgo v1.7.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE= 29 | github.com/onsi/gomega v1.4.3/go.mod h1:ex+gbHU/CVuBBDIJjb2X0qEXbFg53c61hWP/1CpauHY= 30 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 31 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 32 | github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= 33 | github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= 34 | github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= 35 | github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= 36 | github.com/tidwall/gjson v1.6.8/go.mod h1:zeFuBCIqD4sN/gmqBzZ4j7Jd6UcA2Fc56x7QFsv+8fI= 37 | github.com/tidwall/match v1.0.3/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= 38 | github.com/tidwall/pretty v1.0.2/go.mod h1:XNkn88O1ChpSDQmQeStsy+sBenx6DDtFZJxhVysOjyk= 39 | github.com/tidwall/sjson v1.1.5/go.mod h1:VuJzsZnTowhSxWdOgsAnb886i4AjEyTkk7tNtsL7EYE= 40 | golang.org/x/crypto v0.0.0-20170930174604-9419663f5a44/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= 41 | golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= 42 | golang.org/x/crypto v0.0.0-20200115085410-6d4e4cb37c7d/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= 43 | golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83 h1:/ZScEX8SfEmUGRHs0gxpqteO5nfNW6axyZbBdw9A12g= 44 | golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= 45 | golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= 46 | golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= 47 | golang.org/x/net v0.0.0-20210220033124-5f55cee0dc0d h1:1aflnvSoWWLI2k/dMUAl5lvU1YO4Mb4hz0gh+1rjcxU= 48 | golang.org/x/net v0.0.0-20210220033124-5f55cee0dc0d/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= 49 | golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= 50 | golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 51 | golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= 52 | golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 53 | golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 54 | golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= 55 | golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= 56 | golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= 57 | golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 58 | golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= 59 | golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= 60 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 61 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 62 | gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys= 63 | gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw= 64 | gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 65 | gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= 66 | gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= 67 | gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= 68 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= 69 | gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 70 | maunium.net/go/maulogger/v2 v2.2.4 h1:oV2GDeM4fx1uRysdpDC0FcrPg+thFicSd9XzPcYMbVY= 71 | maunium.net/go/maulogger/v2 v2.2.4/go.mod h1:TYWy7wKwz/tIXTpsx8G3mZseIRiC5DoMxSZazOHy68A= 72 | maunium.net/go/mautrix v0.9.22 h1:5O8brMUbZ1MRcAmJ9yYzRUj57hMEypcGok1pVOTsf8A= 73 | maunium.net/go/mautrix v0.9.22/go.mod h1:7IzKfWvpQtN+W2Lzxc0rLvIxFM3ryKX6Ys3S/ZoWbg8= 74 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------