Compare commits
24 Commits
08f535c15c
...
v1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 0b16fd2202 | |||
| bab8edbe7f | |||
| ff43364df3 | |||
| 95ca1f0ba6 | |||
| d68e3eca3b | |||
| 3640f72d73 | |||
| 6adc0c1fbb | |||
| fa4665280d | |||
| 4589b3b339 | |||
| 53186d2e24 | |||
| b91b1ba096 | |||
| 4ee26df97b | |||
| 3822c209d3 | |||
| 17e086b43c | |||
| bb1e412d36 | |||
| b8a8e14f3c | |||
| 558d5cda3f | |||
| 4ff72e073e | |||
| c573d2f74a | |||
| babb3a2e07 | |||
| e6b347f90f | |||
| 8df3afe75e | |||
| af1dd4d122 | |||
| 501520a9df |
12
.drone.yml
Normal file
12
.drone.yml
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: default
|
||||
|
||||
steps:
|
||||
- name: cargo_check
|
||||
image: rust
|
||||
commands:
|
||||
- rustup component add clippy
|
||||
- cargo clippy -- -D warnings
|
||||
- cargo test
|
||||
530
Cargo.lock
generated
530
Cargo.lock
generated
@@ -68,6 +68,17 @@ dependencies = [
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "actix-remote-ip"
|
||||
version = "0.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7629b357d4705cf3f1e31f989f48ecd56027112f7d52dcf06dd96ee197065f8e"
|
||||
dependencies = [
|
||||
"actix-web",
|
||||
"futures-util",
|
||||
"log",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "actix-router"
|
||||
version = "0.5.3"
|
||||
@@ -203,6 +214,20 @@ dependencies = [
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "actix-ws"
|
||||
version = "0.3.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a3a1fb4f9f2794b0aadaf2ba5f14a6f034c7e86957b458c506a8cb75953f2d99"
|
||||
dependencies = [
|
||||
"actix-codec",
|
||||
"actix-http",
|
||||
"actix-web",
|
||||
"bytestring",
|
||||
"futures-core",
|
||||
"tokio",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "addr2line"
|
||||
version = "0.24.2"
|
||||
@@ -224,7 +249,7 @@ version = "0.5.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d122413f284cf2d62fb1b7db97e02edb8cda96d769b16e443a4f6195e35662b0"
|
||||
dependencies = [
|
||||
"crypto-common",
|
||||
"crypto-common 0.1.6",
|
||||
"generic-array",
|
||||
]
|
||||
|
||||
@@ -379,6 +404,12 @@ version = "0.7.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7c02d123df017efcdfbd739ef81735b36c5ba83ec3c59c80a9d7ecc718f92e50"
|
||||
|
||||
[[package]]
|
||||
name = "as_variant"
|
||||
version = "1.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f38fa22307249f86fb7fad906fcae77f2564caeb56d7209103c551cd1cf4798f"
|
||||
|
||||
[[package]]
|
||||
name = "askama"
|
||||
version = "0.12.1"
|
||||
@@ -423,6 +454,34 @@ dependencies = [
|
||||
"nom",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "assign"
|
||||
version = "1.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5f093eed78becd229346bf859eec0aa4dd7ddde0757287b2b4107a1f09c80002"
|
||||
|
||||
[[package]]
|
||||
name = "async-stream"
|
||||
version = "0.3.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b5a71a6f37880a80d1d7f19efd781e4b5de42c88f0722cc13bcb6cc2cfe8476"
|
||||
dependencies = [
|
||||
"async-stream-impl",
|
||||
"futures-core",
|
||||
"pin-project-lite",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-stream-impl"
|
||||
version = "0.3.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c7c24de15d275a1ecfd47a380fb4d5ec9bfe0933f309ed5e705b775596a3574d"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "async-trait"
|
||||
version = "0.1.85"
|
||||
@@ -566,6 +625,15 @@ dependencies = [
|
||||
"generic-array",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "block-buffer"
|
||||
version = "0.11.0-rc.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3fd016a0ddc7cb13661bf5576073ce07330a693f8608a1320b4e20561cc12cdc"
|
||||
dependencies = [
|
||||
"hybrid-array",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "brotli"
|
||||
version = "6.0.0"
|
||||
@@ -660,7 +728,7 @@ version = "0.4.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "773f3b9af64447d2ce9850330c473515014aa235e6a783b02db81ff39e4a3dad"
|
||||
dependencies = [
|
||||
"crypto-common",
|
||||
"crypto-common 0.1.6",
|
||||
"inout",
|
||||
]
|
||||
|
||||
@@ -754,6 +822,12 @@ version = "0.9.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c2459377285ad874054d797f3ccebf984978aa39129f6eafde5cdc8315b612f8"
|
||||
|
||||
[[package]]
|
||||
name = "const-oid"
|
||||
version = "0.10.0-rc.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "68ff6be19477a1bd5441f382916a89bc2a0b2c35db6d41e0f6e8538bf6d6463f"
|
||||
|
||||
[[package]]
|
||||
name = "const-random"
|
||||
version = "0.1.18"
|
||||
@@ -774,6 +848,12 @@ dependencies = [
|
||||
"tiny-keccak",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "const_panic"
|
||||
version = "0.2.12"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2459fc9262a1aa204eb4b5764ad4f189caec88aea9634389c0a25f8be7f6265e"
|
||||
|
||||
[[package]]
|
||||
name = "constant_time_eq"
|
||||
version = "0.3.1"
|
||||
@@ -798,7 +878,7 @@ dependencies = [
|
||||
"hmac",
|
||||
"percent-encoding",
|
||||
"rand 0.8.5",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
"subtle",
|
||||
"time",
|
||||
"version_check",
|
||||
@@ -867,6 +947,17 @@ dependencies = [
|
||||
"typenum",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "crypto-common"
|
||||
version = "0.2.0-rc.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b0b8ce8218c97789f16356e7896b3714f26c2ee1079b79c0b7ae7064bb9089fa"
|
||||
dependencies = [
|
||||
"getrandom 0.2.15",
|
||||
"hybrid-array",
|
||||
"rand_core 0.6.4",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ct-codecs"
|
||||
version = "1.1.3"
|
||||
@@ -882,13 +973,19 @@ dependencies = [
|
||||
"cipher",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "date_header"
|
||||
version = "1.0.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0c03c416ed1a30fbb027ef484ba6ab6f80e1eada675e1a2b92fd673c045a1f1d"
|
||||
|
||||
[[package]]
|
||||
name = "der"
|
||||
version = "0.7.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f55bf8e7b65898637379c1b74eb1551107c8294ed26d855ceb9fd1a09cfc9bc0"
|
||||
dependencies = [
|
||||
"const-oid",
|
||||
"const-oid 0.9.6",
|
||||
"pem-rfc7468",
|
||||
"zeroize",
|
||||
]
|
||||
@@ -943,12 +1040,23 @@ version = "0.10.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
|
||||
dependencies = [
|
||||
"block-buffer",
|
||||
"const-oid",
|
||||
"crypto-common",
|
||||
"block-buffer 0.10.4",
|
||||
"const-oid 0.9.6",
|
||||
"crypto-common 0.1.6",
|
||||
"subtle",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "digest"
|
||||
version = "0.11.0-pre.9"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "cf2e3d6615d99707295a9673e889bf363a04b2a466bd320c65a72536f7577379"
|
||||
dependencies = [
|
||||
"block-buffer 0.11.0-rc.3",
|
||||
"const-oid 0.10.0-rc.3",
|
||||
"crypto-common 0.2.0-rc.1",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "displaydoc"
|
||||
version = "0.2.5"
|
||||
@@ -976,7 +1084,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ee27f32b5c5292967d2d4a9d7f1e0b0aed2c15daded5a60300e4abb9d8020bca"
|
||||
dependencies = [
|
||||
"der",
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
"elliptic-curve",
|
||||
"rfc6979",
|
||||
"signature",
|
||||
@@ -1001,7 +1109,7 @@ checksum = "b5e6043086bf7973472e0c7dff2142ea0b680d30e18d9cc40f267efbf222bd47"
|
||||
dependencies = [
|
||||
"base16ct",
|
||||
"crypto-bigint",
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
"ff",
|
||||
"generic-array",
|
||||
"group",
|
||||
@@ -1233,16 +1341,13 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "getrandom"
|
||||
version = "0.3.0-rc.0"
|
||||
version = "0.3.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8a78f88e84d239c7f2619ae8b091603c26208e1cb322571f5a29d6806f56ee5e"
|
||||
checksum = "43a49c392881ce6d5c3b8cb70f98717b7c07aabbdff06687b9030dbfbe2725f8"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"js-sys",
|
||||
"libc",
|
||||
"rustix",
|
||||
"wasi 0.13.3+wasi-0.2.2",
|
||||
"wasm-bindgen",
|
||||
"windows-targets",
|
||||
]
|
||||
|
||||
@@ -1350,7 +1455,7 @@ version = "0.12.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6c49c37c09c17a53d937dfbb742eb3a961d65a994e6bcdcf37e7399d0cc8ab5e"
|
||||
dependencies = [
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -1365,7 +1470,7 @@ version = "1.1.8"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4a8575493d277c9092b988c780c94737fb9fd8651a1001e16bee3eccfc1baedb"
|
||||
dependencies = [
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -1374,7 +1479,7 @@ version = "1.1.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b0b3a0f572aa8389d325f5852b9e0a333a15b0f86ecccbb3fdb6e97cd86dc67c"
|
||||
dependencies = [
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -1458,6 +1563,15 @@ version = "2.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
|
||||
|
||||
[[package]]
|
||||
name = "hybrid-array"
|
||||
version = "0.2.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f2d35805454dc9f8662a98d6d61886ffe26bd465f5960e0e55345c70d5c0d2a9"
|
||||
dependencies = [
|
||||
"typenum",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "hyper"
|
||||
version = "1.5.2"
|
||||
@@ -1706,6 +1820,7 @@ checksum = "8c9c992b02b5b4c94ea26e32fe5bccb7aa7d9f390ab5c1221ff895bc7ea8b652"
|
||||
dependencies = [
|
||||
"equivalent",
|
||||
"hashbrown 0.15.2",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -1757,6 +1872,24 @@ dependencies = [
|
||||
"wasm-bindgen",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "js_int"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d937f95470b270ce8b8950207715d71aa8e153c0d44c6684d59397ed4949160a"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "js_option"
|
||||
version = "0.1.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "68421373957a1593a767013698dbf206e2b221eefe97a44d98d18672ff38423c"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jwt-simple"
|
||||
version = "0.12.11"
|
||||
@@ -1793,10 +1926,30 @@ dependencies = [
|
||||
"ecdsa",
|
||||
"elliptic-curve",
|
||||
"once_cell",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
"signature",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "konst"
|
||||
version = "0.3.16"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4381b9b00c55f251f2ebe9473aef7c117e96828def1a7cb3bd3f0f903c6894e9"
|
||||
dependencies = [
|
||||
"const_panic",
|
||||
"konst_kernel",
|
||||
"typewit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "konst_kernel"
|
||||
version = "0.3.15"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e4b1eb7788f3824c629b1116a7a9060d6e898c358ebff59070093d51103dcc3c"
|
||||
dependencies = [
|
||||
"typewit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "language-tags"
|
||||
version = "0.3.2"
|
||||
@@ -1883,14 +2036,24 @@ version = "0.4.25"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "04cbf5b083de1c7e0222a7a51dbfdba1cbe1c6ab0b15e29fff3f6c077fd9cd9f"
|
||||
|
||||
[[package]]
|
||||
name = "maplit"
|
||||
version = "1.0.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3e2e65a1a2e43cfcb47a895c4c8b10d1f4a61097f9f254f183aee60cad9c651d"
|
||||
|
||||
[[package]]
|
||||
name = "matrix_gateway"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"actix-remote-ip",
|
||||
"actix-session",
|
||||
"actix-web",
|
||||
"actix-ws",
|
||||
"anyhow",
|
||||
"askama",
|
||||
"base16ct",
|
||||
"bytes",
|
||||
"chrono",
|
||||
"clap",
|
||||
"env_logger",
|
||||
@@ -1901,12 +2064,15 @@ dependencies = [
|
||||
"light-openid",
|
||||
"log",
|
||||
"mime_guess",
|
||||
"rand 0.9.0-beta.3",
|
||||
"rand 0.9.0",
|
||||
"ruma",
|
||||
"rust-embed",
|
||||
"rust-s3",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"sha2 0.11.0-pre.4",
|
||||
"thiserror 2.0.11",
|
||||
"tokio",
|
||||
"urlencoding",
|
||||
"uuid",
|
||||
]
|
||||
@@ -2160,7 +2326,7 @@ dependencies = [
|
||||
"ecdsa",
|
||||
"elliptic-curve",
|
||||
"primeorder",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2172,7 +2338,7 @@ dependencies = [
|
||||
"ecdsa",
|
||||
"elliptic-curve",
|
||||
"primeorder",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2314,6 +2480,15 @@ dependencies = [
|
||||
"elliptic-curve",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro-crate"
|
||||
version = "3.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8ecf48c7ca261d60b74ab1a7b20da18bede46776b2e55535cb958eb595c5fa7b"
|
||||
dependencies = [
|
||||
"toml_edit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro2"
|
||||
version = "1.0.93"
|
||||
@@ -2365,12 +2540,12 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rand"
|
||||
version = "0.9.0-beta.3"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6fccbfebb3972a41a31c605a59207d9fba5489b9a87d9d87024cb6df73a32ec7"
|
||||
checksum = "3779b94aeb87e8bd4e834cee3650289ee9e0d5677f976ecdb6d219e5f4f6cd94"
|
||||
dependencies = [
|
||||
"rand_chacha 0.9.0-beta.1",
|
||||
"rand_core 0.9.0-beta.1",
|
||||
"rand_chacha 0.9.0",
|
||||
"rand_core 0.9.0",
|
||||
"zerocopy 0.8.14",
|
||||
]
|
||||
|
||||
@@ -2386,12 +2561,12 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rand_chacha"
|
||||
version = "0.9.0-beta.1"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f16da77124f4ee9fabd55ce6540866e9101431863b4876de58b68797f331adf2"
|
||||
checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb"
|
||||
dependencies = [
|
||||
"ppv-lite86",
|
||||
"rand_core 0.9.0-beta.1",
|
||||
"rand_core 0.9.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2405,11 +2580,11 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "rand_core"
|
||||
version = "0.9.0-beta.1"
|
||||
version = "0.9.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a98fa0b8309344136abe6244130311e76997e546f76fae8054422a7539b43df7"
|
||||
checksum = "b08f3c9802962f7e1b25113931d94f43ed9725bebc59db9d0c3e9a23b67e15ff"
|
||||
dependencies = [
|
||||
"getrandom 0.3.0-rc.0",
|
||||
"getrandom 0.3.1",
|
||||
"zerocopy 0.8.14",
|
||||
]
|
||||
|
||||
@@ -2557,21 +2732,164 @@ version = "0.9.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "47c75d7c5c6b673e58bf54d8544a9f432e3a925b0e80f7cd3602ab5c50c55519"
|
||||
dependencies = [
|
||||
"const-oid",
|
||||
"digest",
|
||||
"const-oid 0.9.6",
|
||||
"digest 0.10.7",
|
||||
"num-bigint-dig",
|
||||
"num-integer",
|
||||
"num-traits",
|
||||
"pkcs1",
|
||||
"pkcs8",
|
||||
"rand_core 0.6.4",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
"signature",
|
||||
"spki",
|
||||
"subtle",
|
||||
"zeroize",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma"
|
||||
version = "0.12.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7d6fea33e3d17b9e009fefb3f175ca7fd40b1e7d1e72444478fd1b28611eb50a"
|
||||
dependencies = [
|
||||
"assign",
|
||||
"js_int",
|
||||
"js_option",
|
||||
"ruma-client",
|
||||
"ruma-client-api",
|
||||
"ruma-common",
|
||||
"ruma-events",
|
||||
"web-time",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-client"
|
||||
version = "0.15.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7df765f1917f28ef0bf307b19c2c845be4fc2bb77f76e00b1eafbfa8921f7952"
|
||||
dependencies = [
|
||||
"as_variant",
|
||||
"assign",
|
||||
"async-stream",
|
||||
"bytes",
|
||||
"futures-core",
|
||||
"http 1.2.0",
|
||||
"http-body-util",
|
||||
"hyper",
|
||||
"hyper-tls",
|
||||
"hyper-util",
|
||||
"ruma-client-api",
|
||||
"ruma-common",
|
||||
"serde_html_form",
|
||||
"tracing",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-client-api"
|
||||
version = "0.20.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "23989b539eceeaad01ba089ad307788f90a29bac2e5f730ff0a523eeae3fa1d7"
|
||||
dependencies = [
|
||||
"as_variant",
|
||||
"assign",
|
||||
"bytes",
|
||||
"date_header",
|
||||
"http 1.2.0",
|
||||
"js_int",
|
||||
"js_option",
|
||||
"maplit",
|
||||
"ruma-common",
|
||||
"ruma-events",
|
||||
"serde",
|
||||
"serde_html_form",
|
||||
"serde_json",
|
||||
"thiserror 2.0.11",
|
||||
"url",
|
||||
"web-time",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-common"
|
||||
version = "0.15.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1058c04b8dd62f4fba71c9f65112fb79bc332438d11aefe1e8edf67b7fb58a98"
|
||||
dependencies = [
|
||||
"as_variant",
|
||||
"base64 0.22.1",
|
||||
"bytes",
|
||||
"form_urlencoded",
|
||||
"http 1.2.0",
|
||||
"indexmap",
|
||||
"js_int",
|
||||
"konst",
|
||||
"percent-encoding",
|
||||
"rand 0.8.5",
|
||||
"regex",
|
||||
"ruma-identifiers-validation",
|
||||
"ruma-macros",
|
||||
"serde",
|
||||
"serde_html_form",
|
||||
"serde_json",
|
||||
"thiserror 2.0.11",
|
||||
"time",
|
||||
"tracing",
|
||||
"url",
|
||||
"uuid",
|
||||
"web-time",
|
||||
"wildmatch",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-events"
|
||||
version = "0.30.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ff1b8e15942e35ba56004429bc0845f481281f903e86957973a08ec08f8d06f0"
|
||||
dependencies = [
|
||||
"as_variant",
|
||||
"indexmap",
|
||||
"js_int",
|
||||
"js_option",
|
||||
"percent-encoding",
|
||||
"regex",
|
||||
"ruma-common",
|
||||
"ruma-identifiers-validation",
|
||||
"ruma-macros",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"thiserror 2.0.11",
|
||||
"tracing",
|
||||
"url",
|
||||
"web-time",
|
||||
"wildmatch",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-identifiers-validation"
|
||||
version = "0.10.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6ad674b5e5368c53a2c90fde7dac7e30747004aaf7b1827b72874a25fc06d4d8"
|
||||
dependencies = [
|
||||
"js_int",
|
||||
"thiserror 2.0.11",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ruma-macros"
|
||||
version = "0.15.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c1182e83ee5cd10121974f163337b16af68a93eedfc7cdbdbd52307ac7e1d743"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"proc-macro-crate",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"ruma-identifiers-validation",
|
||||
"serde",
|
||||
"syn",
|
||||
"toml",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rust-embed"
|
||||
version = "8.5.0"
|
||||
@@ -2602,7 +2920,7 @@ version = "8.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2e5347777e9aacb56039b0e1f28785929a8a3b709e87482e7442c72e7c12529d"
|
||||
dependencies = [
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
"walkdir",
|
||||
]
|
||||
|
||||
@@ -2643,7 +2961,7 @@ dependencies = [
|
||||
"serde",
|
||||
"serde_derive",
|
||||
"serde_json",
|
||||
"sha2",
|
||||
"sha2 0.10.8",
|
||||
"thiserror 1.0.69",
|
||||
"time",
|
||||
"tokio",
|
||||
@@ -2836,6 +3154,19 @@ dependencies = [
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_html_form"
|
||||
version = "0.2.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9d2de91cf02bbc07cde38891769ccd5d4f073d22a40683aa4bc7a95781aaa2c4"
|
||||
dependencies = [
|
||||
"form_urlencoded",
|
||||
"indexmap",
|
||||
"itoa",
|
||||
"ryu",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_json"
|
||||
version = "1.0.137"
|
||||
@@ -2848,6 +3179,15 @@ dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_spanned"
|
||||
version = "0.6.8"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "87607cb1398ed59d48732e575a4c28a7a8ebf2454b964fe3f224f2afc07909e1"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "serde_urlencoded"
|
||||
version = "0.7.1"
|
||||
@@ -2868,7 +3208,7 @@ checksum = "e3bf829a2d51ab4a5ddf1352d8470c140cadc8301b2ae1789db023f01cedd6ba"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"cpufeatures",
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2879,7 +3219,18 @@ checksum = "793db75ad2bcafc3ffa7c68b215fee268f537982cd901d132f89c6343f3a3dc8"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"cpufeatures",
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sha2"
|
||||
version = "0.11.0-pre.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "540c0893cce56cdbcfebcec191ec8e0f470dd1889b6e7a0b503e310a94a168f5"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"cpufeatures",
|
||||
"digest 0.11.0-pre.9",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -2903,7 +3254,7 @@ version = "2.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "77549399552de45a898a580c1b41d445bf730df867cc44e6c0233bbc4b8329de"
|
||||
dependencies = [
|
||||
"digest",
|
||||
"digest 0.10.7",
|
||||
"rand_core 0.6.4",
|
||||
]
|
||||
|
||||
@@ -3155,9 +3506,21 @@ dependencies = [
|
||||
"pin-project-lite",
|
||||
"signal-hook-registry",
|
||||
"socket2",
|
||||
"tokio-macros",
|
||||
"windows-sys 0.52.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-macros"
|
||||
version = "2.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6e06d43f1345a3bcd39f6a56dbb7dcab2ba47e68e8ac134855e7e2bdbaf8cab8"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tokio-native-tls"
|
||||
version = "0.3.1"
|
||||
@@ -3213,6 +3576,40 @@ dependencies = [
|
||||
"tokio",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml"
|
||||
version = "0.8.19"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a1ed1f98e3fdc28d6d910e6737ae6ab1a93bf1985935a1193e68f93eeb68d24e"
|
||||
dependencies = [
|
||||
"serde",
|
||||
"serde_spanned",
|
||||
"toml_datetime",
|
||||
"toml_edit",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_datetime"
|
||||
version = "0.6.8"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0dd7358ecb8fc2f8d014bf86f6f638ce72ba252a2c3a2572f2a795f1d23efb41"
|
||||
dependencies = [
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "toml_edit"
|
||||
version = "0.22.23"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "02a8b472d1a3d7c18e2d61a489aee3453fd9031c33e4f55bd533f4a7adca1bee"
|
||||
dependencies = [
|
||||
"indexmap",
|
||||
"serde",
|
||||
"serde_spanned",
|
||||
"toml_datetime",
|
||||
"winnow",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tower"
|
||||
version = "0.5.2"
|
||||
@@ -3248,9 +3645,21 @@ checksum = "784e0ac535deb450455cbfa28a6f0df145ea1bb7ae51b821cf5e7927fdcfbdd0"
|
||||
dependencies = [
|
||||
"log",
|
||||
"pin-project-lite",
|
||||
"tracing-attributes",
|
||||
"tracing-core",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tracing-attributes"
|
||||
version = "0.1.28"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "395ae124c09f9e6918a2310af6038fba074bcf474ac352496d5910dd59a2226d"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tracing-core"
|
||||
version = "0.1.33"
|
||||
@@ -3278,6 +3687,21 @@ version = "1.17.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
|
||||
|
||||
[[package]]
|
||||
name = "typewit"
|
||||
version = "1.11.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "cb77c29baba9e4d3a6182d51fa75e3215c7fd1dab8f4ea9d107c716878e55fc0"
|
||||
dependencies = [
|
||||
"typewit_proc_macros",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "typewit_proc_macros"
|
||||
version = "1.8.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e36a83ea2b3c704935a01b4642946aadd445cea40b10935e3f8bd8052b8193d6"
|
||||
|
||||
[[package]]
|
||||
name = "unicase"
|
||||
version = "2.8.1"
|
||||
@@ -3302,7 +3726,7 @@ version = "0.5.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fc1de2c688dc15305988b563c3854064043356019f97a4b46276fe734c4f07ea"
|
||||
dependencies = [
|
||||
"crypto-common",
|
||||
"crypto-common 0.1.6",
|
||||
"subtle",
|
||||
]
|
||||
|
||||
@@ -3321,6 +3745,7 @@ dependencies = [
|
||||
"form_urlencoded",
|
||||
"idna",
|
||||
"percent-encoding",
|
||||
"serde",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -3506,6 +3931,22 @@ dependencies = [
|
||||
"wasm-bindgen",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "web-time"
|
||||
version = "1.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb"
|
||||
dependencies = [
|
||||
"js-sys",
|
||||
"wasm-bindgen",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "wildmatch"
|
||||
version = "2.4.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "68ce1ab1f8c62655ebe1350f589c61e505cf94d385bc6a12899442d9081e71fd"
|
||||
|
||||
[[package]]
|
||||
name = "winapi-util"
|
||||
version = "0.1.9"
|
||||
@@ -3636,6 +4077,15 @@ version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
|
||||
|
||||
[[package]]
|
||||
name = "winnow"
|
||||
version = "0.7.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "86e376c75f4f43f44db463cf729e0d3acbf954d13e22c51e26e4c264b4ab545f"
|
||||
dependencies = [
|
||||
"memchr",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "wit-bindgen-rt"
|
||||
version = "0.33.0"
|
||||
|
||||
13
Cargo.toml
13
Cargo.toml
@@ -16,7 +16,7 @@ actix-web = "4"
|
||||
actix-session = { version = "0.10.1", features = ["redis-session"] }
|
||||
light-openid = "1.0.2"
|
||||
thiserror = "2.0.11"
|
||||
rand = "0.9.0-beta.3"
|
||||
rand = "0.9.0"
|
||||
rust-embed = "8.5.0"
|
||||
mime_guess = "2.0.5"
|
||||
askama = "0.12.1"
|
||||
@@ -24,5 +24,12 @@ urlencoding = "2.1.3"
|
||||
uuid = { version = "1.12.1", features = ["v4", "serde"] }
|
||||
ipnet = { version = "2.11.0", features = ["serde"] }
|
||||
chrono = "0.4.39"
|
||||
futures-util = "0.3.31"
|
||||
jwt-simple = { version = "0.12.11", default-features=false, features=["pure-rust"] }
|
||||
futures-util = { version = "0.3.31", features = ["sink"] }
|
||||
jwt-simple = { version = "0.12.11", default-features = false, features = ["pure-rust"] }
|
||||
actix-remote-ip = "0.1.0"
|
||||
bytes = "1.9.0"
|
||||
sha2 = "0.11.0-pre.4"
|
||||
base16ct = "0.2.0"
|
||||
ruma = { version = "0.12.0", features = ["client-api-c", "client-ext-client-api", "client-hyper-native-tls", "rand"] }
|
||||
actix-ws = "0.3.0"
|
||||
tokio = { version = "1.43.0", features = ["rt", "time", "macros", "rt-multi-thread"] }
|
||||
10
Dockerfile
Normal file
10
Dockerfile
Normal file
@@ -0,0 +1,10 @@
|
||||
FROM debian:bookworm-slim
|
||||
|
||||
RUN apt-get update \
|
||||
&& apt-get install -y libssl3 \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
COPY matrix_gateway /usr/local/bin/matrix_gateway
|
||||
|
||||
ENTRYPOINT ["/usr/local/bin/matrix_gateway"]
|
||||
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
14
Makefile
Normal file
14
Makefile
Normal file
@@ -0,0 +1,14 @@
|
||||
DOCKER_TEMP_DIR=temp
|
||||
|
||||
all: gateway
|
||||
|
||||
gateway:
|
||||
cargo clippy -- -D warnings && cargo build --release
|
||||
|
||||
gateway_docker: gateway
|
||||
rm -rf $(DOCKER_TEMP_DIR)
|
||||
mkdir $(DOCKER_TEMP_DIR)
|
||||
cp target/release/matrix_gateway $(DOCKER_TEMP_DIR)
|
||||
docker build -t pierre42100/matrix_gateway -f ./Dockerfile "$(DOCKER_TEMP_DIR)"
|
||||
rm -rf $(DOCKER_TEMP_DIR)
|
||||
|
||||
17
README.md
17
README.md
@@ -1,6 +1,20 @@
|
||||
# Matrix Gateway
|
||||
WIP project
|
||||
[](https://drone.communiquons.org/pierre/MatrixGW)
|
||||
|
||||
Project that expose a simple API to make use of Matrix API. It acts as a Matrix client (like Element for example)
|
||||
|
||||
**Known limitations**:
|
||||
|
||||
- Supports only a limited subset of Matrix API
|
||||
- Does not support E2E encryption
|
||||
- Does not support spaces
|
||||
|
||||
Project written in Rust. Releases are published on Docker Hub.
|
||||
|
||||
## Docker image options
|
||||
```bash
|
||||
docker run --rm -it docker.io/pierre42100/matrix_gateway --help
|
||||
```
|
||||
|
||||
## Setup dev environment
|
||||
```
|
||||
@@ -20,3 +34,4 @@ Auto-created Matrix accounts:
|
||||
* `user1` : `user1`
|
||||
|
||||
Minio administration credentials: `minioadmin` : `minioadmin`
|
||||
|
||||
|
||||
68
assets/ws_debug.js
Normal file
68
assets/ws_debug.js
Normal file
@@ -0,0 +1,68 @@
|
||||
let ws;
|
||||
|
||||
const JS_MESSAGE = "JS code";
|
||||
const IN_MESSAGE = "Incoming";
|
||||
|
||||
/**
|
||||
* Log message
|
||||
*/
|
||||
function log(src, txt) {
|
||||
const target = document.getElementById("ws_log");
|
||||
const msg = document.createElement("div");
|
||||
msg.className = "message";
|
||||
msg.innerHTML = `<div class='type'>${src}</div><div>${txt}</div>`
|
||||
target.insertBefore(msg, target.firstChild);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the state of the WebSocket
|
||||
*/
|
||||
function setState(state) {
|
||||
document.getElementById("state").innerText = state;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize WebSocket connection
|
||||
*/
|
||||
function connect() {
|
||||
disconnect();
|
||||
log(JS_MESSAGE, "Initialize connection...");
|
||||
ws = new WebSocket("/api/ws");
|
||||
setState("Connecting...");
|
||||
ws.onopen = function () {
|
||||
log(JS_MESSAGE, "Connected to WebSocket !");
|
||||
setState("Connected");
|
||||
}
|
||||
ws.onmessage = function (event) {
|
||||
log(IN_MESSAGE, event.data);
|
||||
}
|
||||
ws.onclose = function () {
|
||||
log(JS_MESSAGE, "Disconnected from WebSocket !");
|
||||
setState("Disconnected");
|
||||
}
|
||||
ws.onerror = function (event) {
|
||||
console.error("WS Error!", event);
|
||||
log(JS_MESSAGE, `Error with websocket! ${event}`);
|
||||
setState("Error");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Close WebSocket connection
|
||||
*/
|
||||
function disconnect() {
|
||||
if (ws && ws.readyState === WebSocket.OPEN) {
|
||||
log(JS_MESSAGE, "Close connection...");
|
||||
ws.close();
|
||||
}
|
||||
|
||||
setState("Disconnected");
|
||||
ws = undefined;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear WS logs
|
||||
*/
|
||||
function clearLogs() {
|
||||
document.getElementById("ws_log").innerHTML = "";
|
||||
}
|
||||
@@ -31,6 +31,10 @@ struct Args {
|
||||
#[arg(short('X'), long, default_value = "GET")]
|
||||
method: String,
|
||||
|
||||
/// Payload SHA256 digest
|
||||
#[arg(short('D'), long)]
|
||||
payload_digest: Option<String>,
|
||||
|
||||
/// Request URI
|
||||
uri: String,
|
||||
|
||||
@@ -59,6 +63,7 @@ fn main() {
|
||||
custom: TokenClaims {
|
||||
method: args.method.to_string(),
|
||||
uri: args.uri,
|
||||
payload_sha256: args.payload_digest.clone(),
|
||||
},
|
||||
};
|
||||
|
||||
|
||||
9
renovate.json
Normal file
9
renovate.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"packageRules": [
|
||||
{
|
||||
"matchUpdateTypes": ["major", "minor", "patch"],
|
||||
"automerge": true
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -18,9 +18,13 @@ pub struct AppConfig {
|
||||
#[clap(short, long, env)]
|
||||
pub proxy_ip: Option<String>,
|
||||
|
||||
/// Secret key, used to sign some resources. Must be randomly generated
|
||||
#[clap(short = 'S', long, env, default_value = "")]
|
||||
secret: String,
|
||||
|
||||
/// Matrix API origin
|
||||
#[clap(short, long, env, default_value = "http://127.0.0.1:8448")]
|
||||
pub matrix_api: String,
|
||||
pub matrix_homeserver: String,
|
||||
|
||||
/// Redis connection hostname
|
||||
#[clap(long, env, default_value = "localhost")]
|
||||
@@ -99,6 +103,21 @@ impl AppConfig {
|
||||
&ARGS
|
||||
}
|
||||
|
||||
/// Get app secret
|
||||
pub fn secret(&self) -> &str {
|
||||
let mut secret = self.secret.as_str();
|
||||
|
||||
if cfg!(debug_assertions) && secret.is_empty() {
|
||||
secret = "DEBUGKEYDEBUGKEYDEBUGKEYDEBUGKEYDEBUGKEYDEBUGKEYDEBUGKEYDEBUGKEY";
|
||||
}
|
||||
|
||||
if secret.is_empty() {
|
||||
panic!("SECRET is undefined or too short (min 64 chars)!")
|
||||
}
|
||||
|
||||
secret
|
||||
}
|
||||
|
||||
/// Get Redis connection configuration
|
||||
pub fn redis_connection_string(&self) -> String {
|
||||
format!(
|
||||
|
||||
46
src/broadcast_messages.rs
Normal file
46
src/broadcast_messages.rs
Normal file
@@ -0,0 +1,46 @@
|
||||
use crate::sync_client::SyncClientID;
|
||||
use crate::user::{APIClientID, UserID};
|
||||
use ruma::api::client::sync::sync_events::v3::{GlobalAccountData, Presence, Rooms, ToDevice};
|
||||
use ruma::api::client::sync::sync_events::DeviceLists;
|
||||
|
||||
#[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
|
||||
pub struct SyncEvent {
|
||||
/// Updates to rooms.
|
||||
#[serde(default, skip_serializing_if = "Rooms::is_empty")]
|
||||
pub rooms: Rooms,
|
||||
|
||||
/// Updates to the presence status of other users.
|
||||
#[serde(default, skip_serializing_if = "Presence::is_empty")]
|
||||
pub presence: Presence,
|
||||
|
||||
/// The global private data created by this user.
|
||||
#[serde(default, skip_serializing_if = "GlobalAccountData::is_empty")]
|
||||
pub account_data: GlobalAccountData,
|
||||
|
||||
/// Messages sent directly between devices.
|
||||
#[serde(default, skip_serializing_if = "ToDevice::is_empty")]
|
||||
pub to_device: ToDevice,
|
||||
|
||||
/// Information on E2E device updates.
|
||||
///
|
||||
/// Only present on an incremental sync.
|
||||
#[serde(default, skip_serializing_if = "DeviceLists::is_empty")]
|
||||
pub device_lists: DeviceLists,
|
||||
}
|
||||
|
||||
/// Broadcast messages
|
||||
#[derive(Debug, Clone)]
|
||||
pub enum BroadcastMessage {
|
||||
/// Request to close the session of a specific client
|
||||
CloseClientSession(APIClientID),
|
||||
/// Close all the sessions of a given user
|
||||
CloseAllUserSessions(UserID),
|
||||
/// Stop sync client for a given user
|
||||
StopSyncTaskForUser(UserID),
|
||||
/// Start sync client for a given user (if not already running)
|
||||
StartSyncTaskForUser(UserID),
|
||||
/// Stop a client with a given client ID
|
||||
StopSyncClient(SyncClientID),
|
||||
/// Propagate a new sync event
|
||||
SyncEvent(UserID, SyncEvent),
|
||||
}
|
||||
@@ -1,3 +1,5 @@
|
||||
use std::time::Duration;
|
||||
|
||||
/// Session key for OpenID login state
|
||||
pub const STATE_KEY: &str = "oidc-state";
|
||||
|
||||
@@ -6,3 +8,11 @@ pub const USER_SESSION_KEY: &str = "user";
|
||||
|
||||
/// Token length
|
||||
pub const TOKEN_LEN: usize = 20;
|
||||
|
||||
/// How often heartbeat pings are sent.
|
||||
///
|
||||
/// Should be half (or less) of the acceptable client timeout.
|
||||
pub const WS_HEARTBEAT_INTERVAL: Duration = Duration::from_secs(5);
|
||||
|
||||
/// How long before lack of client response causes a timeout.
|
||||
pub const WS_CLIENT_TIMEOUT: Duration = Duration::from_secs(10);
|
||||
|
||||
@@ -1,24 +1,58 @@
|
||||
use crate::user::{APIClient, APIClientID, UserConfig, UserID};
|
||||
use crate::constants::USER_SESSION_KEY;
|
||||
use crate::server::HttpFailure;
|
||||
use crate::user::{APIClient, APIClientID, RumaClient, User, UserConfig, UserID};
|
||||
use crate::utils::base_utils::curr_time;
|
||||
use actix_remote_ip::RemoteIP;
|
||||
use actix_session::Session;
|
||||
use actix_web::dev::Payload;
|
||||
use actix_web::{FromRequest, HttpRequest};
|
||||
use bytes::Bytes;
|
||||
use jwt_simple::common::VerificationOptions;
|
||||
use jwt_simple::prelude::{Duration, HS256Key, MACLike};
|
||||
use ruma::api::{IncomingResponse, OutgoingRequest};
|
||||
use sha2::{Digest, Sha256};
|
||||
use std::net::IpAddr;
|
||||
use std::str::FromStr;
|
||||
|
||||
pub struct APIClientAuth {
|
||||
pub user: UserConfig,
|
||||
client: APIClient,
|
||||
payload: Option<Vec<u8>>,
|
||||
pub client: Option<APIClient>,
|
||||
pub payload: Option<Vec<u8>>,
|
||||
}
|
||||
|
||||
#[derive(Debug, serde::Serialize, serde::Deserialize)]
|
||||
pub struct TokenClaims {
|
||||
#[serde(rename = "met")]
|
||||
pub method: String,
|
||||
pub uri: String,
|
||||
#[serde(rename = "pay", skip_serializing_if = "Option::is_none")]
|
||||
pub payload_sha256: Option<String>,
|
||||
}
|
||||
|
||||
impl APIClientAuth {
|
||||
async fn extract_auth(req: &HttpRequest) -> Result<Self, actix_web::Error> {
|
||||
async fn extract_auth(
|
||||
req: &HttpRequest,
|
||||
remote_ip: IpAddr,
|
||||
payload_bytes: Option<Bytes>,
|
||||
) -> Result<Self, actix_web::Error> {
|
||||
// Check if user is authenticated using Web UI
|
||||
let session = Session::from_request(req, &mut Payload::None).await?;
|
||||
|
||||
if let Some(user) = session.get::<User>(USER_SESSION_KEY)? {
|
||||
match UserConfig::load(&user.id, false).await {
|
||||
Ok(config) => {
|
||||
return Ok(Self {
|
||||
user: config,
|
||||
client: None,
|
||||
payload: payload_bytes.map(|bytes| bytes.to_vec()),
|
||||
})
|
||||
}
|
||||
Err(e) => {
|
||||
log::error!("Failed to fetch user information for authentication using cookie token! {e}");
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
let Some(token) = req.headers().get("x-client-auth") else {
|
||||
return Err(actix_web::error::ErrorBadRequest(
|
||||
"Missing authentication header!",
|
||||
@@ -81,8 +115,11 @@ impl APIClientAuth {
|
||||
|
||||
// Decode JWT
|
||||
let key = HS256Key::from_bytes(client.secret.as_bytes());
|
||||
let mut verif = VerificationOptions::default();
|
||||
verif.max_validity = Some(Duration::from_mins(15));
|
||||
let verif = VerificationOptions {
|
||||
max_validity: Some(Duration::from_mins(15)),
|
||||
..Default::default()
|
||||
};
|
||||
|
||||
let claims = match key.verify_token::<TokenClaims>(jwt_token, Some(verif)) {
|
||||
Ok(t) => t,
|
||||
Err(e) => {
|
||||
@@ -98,6 +135,19 @@ impl APIClientAuth {
|
||||
));
|
||||
}
|
||||
|
||||
// Check IP restriction
|
||||
if let Some(net) = client.network {
|
||||
if !net.contains(&remote_ip) {
|
||||
log::error!(
|
||||
"Trying to use client {} from unauthorized IP address: {remote_ip}",
|
||||
client.id.0
|
||||
);
|
||||
return Err(actix_web::error::ErrorForbidden(
|
||||
"This client cannot be used from this IP address!",
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
// Check URI & verb
|
||||
if claims.custom.uri != req.uri().to_string() {
|
||||
return Err(actix_web::error::ErrorBadRequest("URI mismatch!"));
|
||||
@@ -113,16 +163,62 @@ impl APIClientAuth {
|
||||
));
|
||||
}
|
||||
|
||||
// TODO : handle payload
|
||||
// TODO : update last use (if required)
|
||||
// TODO : check for IP restriction
|
||||
let payload = match (payload_bytes, claims.custom.payload_sha256) {
|
||||
(None, _) => None,
|
||||
(Some(_), None) => {
|
||||
return Err(actix_web::error::ErrorBadRequest(
|
||||
"A payload digest must be included in the JWT when the request has a payload!",
|
||||
));
|
||||
}
|
||||
(Some(payload), Some(provided_digest)) => {
|
||||
let computed_digest = base16ct::lower::encode_string(&Sha256::digest(&payload));
|
||||
if computed_digest != provided_digest {
|
||||
log::error!(
|
||||
"Expected digest {provided_digest} but computed {computed_digest}!"
|
||||
);
|
||||
return Err(actix_web::error::ErrorBadRequest(
|
||||
"Computed digest is different from the one provided in the JWT!",
|
||||
));
|
||||
}
|
||||
|
||||
Some(payload.to_vec())
|
||||
}
|
||||
};
|
||||
|
||||
// Update last use (if needed)
|
||||
if client.need_update_last_used() {
|
||||
let mut user_up = user.clone();
|
||||
match user_up.find_client_by_id_mut(&client.id) {
|
||||
None => log::error!("Client ID disappeared!!!"),
|
||||
Some(u) => u.used = curr_time().unwrap(),
|
||||
}
|
||||
if let Err(e) = user_up.save().await {
|
||||
log::error!("Failed to update last token usage! {e}");
|
||||
}
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
client: client.clone(),
|
||||
payload: None,
|
||||
client: Some(client.clone()),
|
||||
payload,
|
||||
user,
|
||||
})
|
||||
}
|
||||
|
||||
/// Get an instance of Matrix client
|
||||
pub async fn client(&self) -> anyhow::Result<RumaClient> {
|
||||
self.user.matrix_client().await
|
||||
}
|
||||
|
||||
/// Send request to matrix server
|
||||
pub async fn send_request<R: OutgoingRequest<IncomingResponse = E>, E: IncomingResponse>(
|
||||
&self,
|
||||
request: R,
|
||||
) -> anyhow::Result<E, HttpFailure> {
|
||||
match self.client().await?.send_request(request).await {
|
||||
Ok(e) => Ok(e),
|
||||
Err(e) => Err(HttpFailure::MatrixClientError(e.to_string())),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl FromRequest for APIClientAuth {
|
||||
@@ -131,6 +227,30 @@ impl FromRequest for APIClientAuth {
|
||||
|
||||
fn from_request(req: &HttpRequest, payload: &mut Payload) -> Self::Future {
|
||||
let req = req.clone();
|
||||
Box::pin(async move { Self::extract_auth(&req).await })
|
||||
|
||||
let remote_ip = match RemoteIP::from_request(&req, &mut Payload::None).into_inner() {
|
||||
Ok(ip) => ip,
|
||||
Err(e) => return Box::pin(async { Err(e) }),
|
||||
};
|
||||
|
||||
let mut payload = payload.take();
|
||||
|
||||
Box::pin(async move {
|
||||
let payload_bytes = match Bytes::from_request(&req, &mut payload).await {
|
||||
Ok(b) => {
|
||||
if b.is_empty() {
|
||||
None
|
||||
} else {
|
||||
Some(b)
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
log::error!("Failed to extract request payload! {e}");
|
||||
None
|
||||
}
|
||||
};
|
||||
|
||||
Self::extract_auth(&req, remote_ip.0, payload_bytes).await
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
pub mod app_config;
|
||||
pub mod broadcast_messages;
|
||||
pub mod constants;
|
||||
pub mod extractors;
|
||||
pub mod server;
|
||||
pub mod sync_client;
|
||||
pub mod user;
|
||||
pub mod utils;
|
||||
|
||||
35
src/main.rs
35
src/main.rs
@@ -1,12 +1,15 @@
|
||||
use actix_remote_ip::RemoteIPConfig;
|
||||
use actix_session::config::SessionLifecycle;
|
||||
use actix_session::{storage::RedisSessionStore, SessionMiddleware};
|
||||
use actix_web::cookie::Key;
|
||||
use actix_web::{web, App, HttpServer};
|
||||
use matrix_gateway::app_config::AppConfig;
|
||||
use matrix_gateway::broadcast_messages::BroadcastMessage;
|
||||
use matrix_gateway::server::{api, web_ui};
|
||||
use matrix_gateway::sync_client;
|
||||
use matrix_gateway::user::UserConfig;
|
||||
|
||||
#[actix_web::main]
|
||||
#[tokio::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
env_logger::init_from_env(env_logger::Env::new().default_filter_or("info"));
|
||||
|
||||
@@ -14,13 +17,17 @@ async fn main() -> std::io::Result<()> {
|
||||
.await
|
||||
.expect("Failed to create bucket!");
|
||||
|
||||
// FIXME : not scalable
|
||||
let secret_key = Key::generate();
|
||||
let secret_key = Key::from(AppConfig::get().secret().as_bytes());
|
||||
|
||||
let redis_store = RedisSessionStore::new(AppConfig::get().redis_connection_string())
|
||||
.await
|
||||
.expect("Failed to connect to Redis!");
|
||||
|
||||
let (ws_tx, _) = tokio::sync::broadcast::channel::<BroadcastMessage>(16);
|
||||
|
||||
// Launch sync manager
|
||||
tokio::spawn(sync_client::sync_client_manager(ws_tx.clone()));
|
||||
|
||||
log::info!(
|
||||
"Starting to listen on {} for {}",
|
||||
AppConfig::get().listen_address,
|
||||
@@ -35,16 +42,38 @@ async fn main() -> std::io::Result<()> {
|
||||
.session_lifecycle(SessionLifecycle::BrowserSession(Default::default()))
|
||||
.build(),
|
||||
)
|
||||
.app_data(web::Data::new(RemoteIPConfig {
|
||||
proxy: AppConfig::get().proxy_ip.clone(),
|
||||
}))
|
||||
.app_data(web::Data::new(ws_tx.clone()))
|
||||
// Web configuration routes
|
||||
.route("/assets/{tail:.*}", web::get().to(web_ui::static_file))
|
||||
.route("/", web::get().to(web_ui::home))
|
||||
.route("/", web::post().to(web_ui::home))
|
||||
.route("/oidc_cb", web::get().to(web_ui::oidc_cb))
|
||||
.route("/sign_out", web::get().to(web_ui::sign_out))
|
||||
.route("/ws_debug", web::get().to(web_ui::ws_debug))
|
||||
// API routes
|
||||
.route("/api", web::get().to(api::api_home))
|
||||
.route("/api", web::post().to(api::api_home))
|
||||
.route("/api/account/whoami", web::get().to(api::account::who_am_i))
|
||||
.route("/api/room/joined", web::get().to(api::room::joined_rooms))
|
||||
.route("/api/room/{room_id}", web::get().to(api::room::info))
|
||||
.route(
|
||||
"/api/media/{server_name}/{media_id}/download",
|
||||
web::get().to(api::media::download),
|
||||
)
|
||||
.route(
|
||||
"/api/media/{server_name}/{media_id}/thumbnail",
|
||||
web::get().to(api::media::thumbnail),
|
||||
)
|
||||
.route(
|
||||
"/api/profile/{user_id}",
|
||||
web::get().to(api::profile::get_profile),
|
||||
)
|
||||
.service(web::resource("/api/ws").route(web::get().to(api::ws::ws)))
|
||||
})
|
||||
.workers(4)
|
||||
.bind(&AppConfig::get().listen_address)?
|
||||
.run()
|
||||
.await
|
||||
|
||||
23
src/server/api/account.rs
Normal file
23
src/server/api/account.rs
Normal file
@@ -0,0 +1,23 @@
|
||||
use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::HttpResult;
|
||||
use actix_web::HttpResponse;
|
||||
use ruma::api::client::account;
|
||||
use ruma::DeviceId;
|
||||
|
||||
#[derive(serde::Serialize)]
|
||||
struct WhoAmIResponse {
|
||||
user_id: String,
|
||||
device_id: Option<String>,
|
||||
}
|
||||
|
||||
/// Get current user identity
|
||||
pub async fn who_am_i(auth: APIClientAuth) -> HttpResult {
|
||||
let res = auth
|
||||
.send_request(account::whoami::v3::Request::default())
|
||||
.await?;
|
||||
|
||||
Ok(HttpResponse::Ok().json(WhoAmIResponse {
|
||||
user_id: res.user_id.to_string(),
|
||||
device_id: res.device_id.as_deref().map(DeviceId::to_string),
|
||||
}))
|
||||
}
|
||||
59
src/server/api/media.rs
Normal file
59
src/server/api/media.rs
Normal file
@@ -0,0 +1,59 @@
|
||||
use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::HttpResult;
|
||||
use actix_web::{web, HttpResponse};
|
||||
use ruma::api::client::media;
|
||||
use ruma::{OwnedServerName, UInt};
|
||||
|
||||
#[derive(serde::Deserialize)]
|
||||
pub struct MediaInfoInPath {
|
||||
server_name: OwnedServerName,
|
||||
media_id: String,
|
||||
}
|
||||
|
||||
/// Download a media
|
||||
#[allow(deprecated)]
|
||||
pub async fn download(auth: APIClientAuth, path: web::Path<MediaInfoInPath>) -> HttpResult {
|
||||
let res = auth
|
||||
.send_request(media::get_content::v3::Request::new(
|
||||
path.media_id.clone(),
|
||||
path.server_name.clone(),
|
||||
))
|
||||
.await?;
|
||||
|
||||
let mut http_res = HttpResponse::Ok();
|
||||
if let Some(content_type) = res.content_type {
|
||||
http_res.content_type(content_type);
|
||||
}
|
||||
|
||||
Ok(http_res.body(res.file))
|
||||
}
|
||||
|
||||
#[derive(serde::Deserialize)]
|
||||
pub struct MediaThumbnailQuery {
|
||||
width: Option<UInt>,
|
||||
height: Option<UInt>,
|
||||
}
|
||||
|
||||
/// Get a media thumbnail
|
||||
#[allow(deprecated)]
|
||||
pub async fn thumbnail(
|
||||
auth: APIClientAuth,
|
||||
path: web::Path<MediaInfoInPath>,
|
||||
query: web::Query<MediaThumbnailQuery>,
|
||||
) -> HttpResult {
|
||||
let res = auth
|
||||
.send_request(media::get_content_thumbnail::v3::Request::new(
|
||||
path.media_id.clone(),
|
||||
path.server_name.clone(),
|
||||
query.width.unwrap_or(UInt::new(500).unwrap()),
|
||||
query.height.unwrap_or(UInt::new(500).unwrap()),
|
||||
))
|
||||
.await?;
|
||||
|
||||
let mut http_res = HttpResponse::Ok();
|
||||
if let Some(content_type) = res.content_type {
|
||||
http_res.content_type(content_type);
|
||||
}
|
||||
|
||||
Ok(http_res.body(res.file))
|
||||
}
|
||||
@@ -2,6 +2,12 @@ use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::HttpResult;
|
||||
use actix_web::HttpResponse;
|
||||
|
||||
pub mod account;
|
||||
pub mod media;
|
||||
pub mod profile;
|
||||
pub mod room;
|
||||
pub mod ws;
|
||||
|
||||
/// API Home route
|
||||
pub async fn api_home(auth: APIClientAuth) -> HttpResult {
|
||||
Ok(HttpResponse::Ok().body(format!("Welcome user {}!", auth.user.user_id.0)))
|
||||
29
src/server/api/profile.rs
Normal file
29
src/server/api/profile.rs
Normal file
@@ -0,0 +1,29 @@
|
||||
use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::HttpResult;
|
||||
use crate::utils::matrix_utils::ApiMxcURI;
|
||||
use actix_web::{web, HttpResponse};
|
||||
use ruma::api::client::profile;
|
||||
use ruma::OwnedUserId;
|
||||
|
||||
#[derive(serde::Deserialize)]
|
||||
pub struct UserIDInPath {
|
||||
user_id: OwnedUserId,
|
||||
}
|
||||
|
||||
#[derive(serde::Serialize)]
|
||||
struct ProfileResponse {
|
||||
display_name: Option<String>,
|
||||
avatar: Option<ApiMxcURI>,
|
||||
}
|
||||
|
||||
/// Get user profile
|
||||
pub async fn get_profile(auth: APIClientAuth, path: web::Path<UserIDInPath>) -> HttpResult {
|
||||
let res = auth
|
||||
.send_request(profile::get_profile::v3::Request::new(path.user_id.clone()))
|
||||
.await?;
|
||||
|
||||
Ok(HttpResponse::Ok().json(ProfileResponse {
|
||||
display_name: res.displayname,
|
||||
avatar: res.avatar_url.map(ApiMxcURI),
|
||||
}))
|
||||
}
|
||||
81
src/server/api/room.rs
Normal file
81
src/server/api/room.rs
Normal file
@@ -0,0 +1,81 @@
|
||||
use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::{HttpFailure, HttpResult};
|
||||
use crate::utils::matrix_utils::ApiMxcURI;
|
||||
use actix_web::{web, HttpResponse};
|
||||
use ruma::api::client::{membership, state};
|
||||
use ruma::events::StateEventType;
|
||||
use ruma::{OwnedMxcUri, OwnedRoomId};
|
||||
use serde::de::DeserializeOwned;
|
||||
|
||||
#[derive(serde::Serialize)]
|
||||
struct GetRoomsMembershipsResponse {
|
||||
rooms: Vec<OwnedRoomId>,
|
||||
}
|
||||
|
||||
/// Get the list of rooms the user has joined
|
||||
pub async fn joined_rooms(auth: APIClientAuth) -> HttpResult {
|
||||
let res = auth
|
||||
.send_request(membership::joined_rooms::v3::Request::default())
|
||||
.await?;
|
||||
|
||||
Ok(HttpResponse::Ok().json(GetRoomsMembershipsResponse {
|
||||
rooms: res.joined_rooms,
|
||||
}))
|
||||
}
|
||||
|
||||
#[derive(serde::Deserialize)]
|
||||
pub struct RoomIDInPath {
|
||||
room_id: OwnedRoomId,
|
||||
}
|
||||
|
||||
#[derive(serde::Serialize)]
|
||||
struct GetRoomInfoResponse {
|
||||
name: Option<String>,
|
||||
avatar: Option<ApiMxcURI>,
|
||||
}
|
||||
|
||||
/// Get a room information
|
||||
async fn get_room_info<E: DeserializeOwned>(
|
||||
auth: &APIClientAuth,
|
||||
room_id: OwnedRoomId,
|
||||
event_type: StateEventType,
|
||||
field: &str,
|
||||
) -> anyhow::Result<Option<E>, HttpFailure> {
|
||||
let res = auth
|
||||
.send_request(state::get_state_events_for_key::v3::Request::new(
|
||||
room_id,
|
||||
event_type,
|
||||
String::default(),
|
||||
))
|
||||
.await?;
|
||||
|
||||
Ok(res.content.get_field(field)?)
|
||||
}
|
||||
|
||||
/// Get room information
|
||||
pub async fn info(auth: APIClientAuth, path: web::Path<RoomIDInPath>) -> HttpResult {
|
||||
let room_name: Option<String> = get_room_info(
|
||||
&auth,
|
||||
path.room_id.clone(),
|
||||
StateEventType::RoomName,
|
||||
"name",
|
||||
)
|
||||
.await
|
||||
.ok()
|
||||
.flatten();
|
||||
|
||||
let room_avatar: Option<OwnedMxcUri> = get_room_info(
|
||||
&auth,
|
||||
path.room_id.clone(),
|
||||
StateEventType::RoomAvatar,
|
||||
"url",
|
||||
)
|
||||
.await
|
||||
.ok()
|
||||
.flatten();
|
||||
|
||||
Ok(HttpResponse::Ok().json(GetRoomInfoResponse {
|
||||
name: room_name,
|
||||
avatar: room_avatar.map(ApiMxcURI),
|
||||
}))
|
||||
}
|
||||
176
src/server/api/ws.rs
Normal file
176
src/server/api/ws.rs
Normal file
@@ -0,0 +1,176 @@
|
||||
use crate::broadcast_messages::{BroadcastMessage, SyncEvent};
|
||||
use crate::constants::{WS_CLIENT_TIMEOUT, WS_HEARTBEAT_INTERVAL};
|
||||
use crate::extractors::client_auth::APIClientAuth;
|
||||
use crate::server::HttpResult;
|
||||
use actix_web::dev::Payload;
|
||||
use actix_web::{web, FromRequest, HttpRequest};
|
||||
use actix_ws::Message;
|
||||
use futures_util::StreamExt;
|
||||
use std::time::Instant;
|
||||
use tokio::select;
|
||||
use tokio::sync::broadcast;
|
||||
use tokio::sync::broadcast::Receiver;
|
||||
use tokio::time::interval;
|
||||
|
||||
/// Messages send to the client
|
||||
#[derive(Debug, serde::Deserialize, serde::Serialize)]
|
||||
#[serde(tag = "type")]
|
||||
pub enum WsMessage {
|
||||
Sync(SyncEvent),
|
||||
}
|
||||
|
||||
/// Main WS route
|
||||
pub async fn ws(
|
||||
req: HttpRequest,
|
||||
stream: web::Payload,
|
||||
tx: web::Data<broadcast::Sender<BroadcastMessage>>,
|
||||
) -> HttpResult {
|
||||
// Forcefully ignore request payload by manually extracting authentication information
|
||||
let auth = APIClientAuth::from_request(&req, &mut Payload::None).await?;
|
||||
|
||||
let (res, session, msg_stream) = actix_ws::handle(&req, stream)?;
|
||||
|
||||
// Ask for sync client to be started
|
||||
if let Err(e) = tx.send(BroadcastMessage::StartSyncTaskForUser(
|
||||
auth.user.user_id.clone(),
|
||||
)) {
|
||||
log::error!("Failed to send StartSyncTaskForUser: {}", e);
|
||||
}
|
||||
|
||||
let rx = tx.subscribe();
|
||||
|
||||
// spawn websocket handler (and don't await it) so that the response is returned immediately
|
||||
actix_web::rt::spawn(ws_handler(session, msg_stream, auth, rx));
|
||||
|
||||
Ok(res)
|
||||
}
|
||||
|
||||
pub async fn ws_handler(
|
||||
mut session: actix_ws::Session,
|
||||
mut msg_stream: actix_ws::MessageStream,
|
||||
auth: APIClientAuth,
|
||||
mut rx: Receiver<BroadcastMessage>,
|
||||
) {
|
||||
log::info!("WS connected");
|
||||
|
||||
let mut last_heartbeat = Instant::now();
|
||||
let mut interval = interval(WS_HEARTBEAT_INTERVAL);
|
||||
|
||||
let reason = loop {
|
||||
// waits for either `msg_stream` to receive a message from the client, the broadcast channel
|
||||
// to send a message, or the heartbeat interval timer to tick, yielding the value of
|
||||
// whichever one is ready first
|
||||
select! {
|
||||
ws_msg = rx.recv() => {
|
||||
let msg = match ws_msg {
|
||||
Ok(msg) => msg,
|
||||
Err(broadcast::error::RecvError::Closed) => break None,
|
||||
Err(broadcast::error::RecvError::Lagged(_)) => continue,
|
||||
};
|
||||
|
||||
match msg {
|
||||
BroadcastMessage::CloseClientSession(id) => {
|
||||
if let Some(client) = &auth.client {
|
||||
if client.id == id {
|
||||
log::info!(
|
||||
"closing client session {id:?} of user {:?} as requested", auth.user.user_id
|
||||
);
|
||||
break None;
|
||||
}
|
||||
}
|
||||
},
|
||||
BroadcastMessage::CloseAllUserSessions(userid) => {
|
||||
if userid == auth.user.user_id {
|
||||
log::info!(
|
||||
"closing WS session of user {userid:?} as requested"
|
||||
);
|
||||
break None;
|
||||
}
|
||||
}
|
||||
|
||||
BroadcastMessage::SyncEvent(userid, event) => {
|
||||
if userid != auth.user.user_id {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Send the message to the websocket
|
||||
if let Ok(msg) = serde_json::to_string(&WsMessage::Sync(event)) {
|
||||
if let Err(e) = session.text(msg).await {
|
||||
log::error!("Failed to send SyncEvent: {}", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => {}};
|
||||
|
||||
}
|
||||
|
||||
// heartbeat interval ticked
|
||||
_tick = interval.tick() => {
|
||||
// if no heartbeat ping/pong received recently, close the connection
|
||||
if Instant::now().duration_since(last_heartbeat) > WS_CLIENT_TIMEOUT {
|
||||
log::info!(
|
||||
"client has not sent heartbeat in over {WS_CLIENT_TIMEOUT:?}; disconnecting"
|
||||
);
|
||||
|
||||
break None;
|
||||
}
|
||||
|
||||
// send heartbeat ping
|
||||
let _ = session.ping(b"").await;
|
||||
},
|
||||
|
||||
msg = msg_stream.next() => {
|
||||
let msg = match msg {
|
||||
// received message from WebSocket client
|
||||
Some(Ok(msg)) => msg,
|
||||
|
||||
// client WebSocket stream error
|
||||
Some(Err(err)) => {
|
||||
log::error!("{err}");
|
||||
break None;
|
||||
}
|
||||
|
||||
// client WebSocket stream ended
|
||||
None => break None
|
||||
};
|
||||
|
||||
log::debug!("msg: {msg:?}");
|
||||
|
||||
match msg {
|
||||
Message::Text(s) => {
|
||||
log::info!("Text message: {s}");
|
||||
}
|
||||
|
||||
Message::Binary(_) => {
|
||||
// drop client's binary messages
|
||||
}
|
||||
|
||||
Message::Close(reason) => {
|
||||
break reason;
|
||||
}
|
||||
|
||||
Message::Ping(bytes) => {
|
||||
last_heartbeat = Instant::now();
|
||||
let _ = session.pong(&bytes).await;
|
||||
}
|
||||
|
||||
Message::Pong(_) => {
|
||||
last_heartbeat = Instant::now();
|
||||
}
|
||||
|
||||
Message::Continuation(_) => {
|
||||
log::warn!("no support for continuation frames");
|
||||
}
|
||||
|
||||
// no-op; ignore
|
||||
Message::Nop => {}
|
||||
};
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// attempt to close connection gracefully
|
||||
let _ = session.close(reason).await;
|
||||
|
||||
log::info!("WS disconnected");
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
use actix_web::http::StatusCode;
|
||||
use actix_web::{HttpResponse, ResponseError};
|
||||
use std::error::Error;
|
||||
use std::fmt::Debug;
|
||||
|
||||
pub mod api;
|
||||
pub mod web_ui;
|
||||
@@ -11,6 +12,8 @@ pub enum HttpFailure {
|
||||
Forbidden,
|
||||
#[error("this resource was not found")]
|
||||
NotFound,
|
||||
#[error("Actix web error")]
|
||||
ActixError(#[from] actix_web::Error),
|
||||
#[error("an unhandled session insert error occurred")]
|
||||
SessionInsertError(#[from] actix_session::SessionInsertError),
|
||||
#[error("an unhandled session error occurred")]
|
||||
@@ -21,6 +24,12 @@ pub enum HttpFailure {
|
||||
FetchUserConfig(anyhow::Error),
|
||||
#[error("an unspecified internal error occurred: {0}")]
|
||||
InternalError(#[from] anyhow::Error),
|
||||
#[error("a matrix api client error occurred: {0}")]
|
||||
MatrixApiClientError(#[from] ruma::api::client::Error),
|
||||
#[error("a matrix client error occurred: {0}")]
|
||||
MatrixClientError(String),
|
||||
#[error("a serde_json error occurred: {0}")]
|
||||
SerdeJsonError(#[from] serde_json::error::Error),
|
||||
}
|
||||
|
||||
impl ResponseError for HttpFailure {
|
||||
@@ -37,4 +46,4 @@ impl ResponseError for HttpFailure {
|
||||
}
|
||||
}
|
||||
|
||||
pub type HttpResult = std::result::Result<HttpResponse, HttpFailure>;
|
||||
pub type HttpResult = Result<HttpResponse, HttpFailure>;
|
||||
|
||||
@@ -1,14 +1,16 @@
|
||||
use crate::app_config::AppConfig;
|
||||
use crate::broadcast_messages::BroadcastMessage;
|
||||
use crate::constants::{STATE_KEY, USER_SESSION_KEY};
|
||||
use crate::server::{HttpFailure, HttpResult};
|
||||
use crate::user::{APIClient, APIClientID, User, UserConfig, UserID};
|
||||
use crate::utils;
|
||||
use crate::utils::base_utils;
|
||||
use actix_session::Session;
|
||||
use actix_web::{web, HttpResponse};
|
||||
use askama::Template;
|
||||
use ipnet::IpNet;
|
||||
use light_openid::primitives::OpenIDConfig;
|
||||
use std::str::FromStr;
|
||||
use tokio::sync::broadcast;
|
||||
|
||||
/// Static assets
|
||||
#[derive(rust_embed::Embed)]
|
||||
@@ -60,11 +62,15 @@ pub struct FormRequest {
|
||||
}
|
||||
|
||||
/// Main route
|
||||
pub async fn home(session: Session, form_req: Option<web::Form<FormRequest>>) -> HttpResult {
|
||||
pub async fn home(
|
||||
session: Session,
|
||||
form_req: Option<web::Form<FormRequest>>,
|
||||
tx: web::Data<broadcast::Sender<BroadcastMessage>>,
|
||||
) -> HttpResult {
|
||||
// Get user information, requesting authentication if information is missing
|
||||
let Some(user): Option<User> = session.get(USER_SESSION_KEY)? else {
|
||||
// Generate auth state
|
||||
let state = utils::rand_str(50);
|
||||
let state = base_utils::rand_str(50);
|
||||
session.insert(STATE_KEY, &state)?;
|
||||
|
||||
let oidc = AppConfig::get().openid_provider();
|
||||
@@ -93,10 +99,19 @@ pub async fn home(session: Session, form_req: Option<web::Form<FormRequest>>) ->
|
||||
if t.len() < 3 {
|
||||
error_message = Some("Specified Matrix token is too short!".to_string());
|
||||
} else {
|
||||
// TODO : invalidate all existing connections
|
||||
config.matrix_token = t;
|
||||
config.save().await?;
|
||||
success_message = Some("Matrix token was successfully updated!".to_string());
|
||||
|
||||
// Close sync task
|
||||
if let Err(e) = tx.send(BroadcastMessage::StopSyncTaskForUser(user.id.clone())) {
|
||||
log::error!("Failed to send StopSyncClientForUser: {}", e);
|
||||
}
|
||||
|
||||
// Invalidate all Ws connections
|
||||
if let Err(e) = tx.send(BroadcastMessage::CloseAllUserSessions(user.id.clone())) {
|
||||
log::error!("Failed to send CloseAllUserSessions: {}", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -128,7 +143,10 @@ pub async fn home(session: Session, form_req: Option<web::Form<FormRequest>>) ->
|
||||
config.clients.retain(|c| c.id != delete_client_id);
|
||||
config.save().await?;
|
||||
success_message = Some("The client was successfully deleted!".to_string());
|
||||
// TODO : close connections with given id
|
||||
|
||||
if let Err(e) = tx.send(BroadcastMessage::CloseClientSession(delete_client_id)) {
|
||||
log::error!("Failed to send CloseClientSession: {}", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -213,3 +231,22 @@ pub async fn sign_out(session: Session) -> HttpResult {
|
||||
.insert_header(("location", "/"))
|
||||
.finish())
|
||||
}
|
||||
|
||||
#[derive(askama::Template)]
|
||||
#[template(path = "ws_debug.html")]
|
||||
struct WsDebugTemplate {
|
||||
name: String,
|
||||
}
|
||||
|
||||
/// WebSocket debug
|
||||
pub async fn ws_debug(session: Session) -> HttpResult {
|
||||
let Some(user): Option<User> = session.get(USER_SESSION_KEY)? else {
|
||||
return Ok(HttpResponse::Found()
|
||||
.insert_header(("location", "/"))
|
||||
.finish());
|
||||
};
|
||||
|
||||
Ok(HttpResponse::Ok()
|
||||
.content_type("text/html")
|
||||
.body(WsDebugTemplate { name: user.name }.render().unwrap()))
|
||||
}
|
||||
|
||||
145
src/sync_client.rs
Normal file
145
src/sync_client.rs
Normal file
@@ -0,0 +1,145 @@
|
||||
use crate::broadcast_messages::{BroadcastMessage, SyncEvent};
|
||||
use crate::user::{UserConfig, UserID};
|
||||
use futures_util::TryStreamExt;
|
||||
use ruma::api::client::sync::sync_events;
|
||||
use ruma::assign;
|
||||
use ruma::presence::PresenceState;
|
||||
use std::collections::HashMap;
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
use tokio::sync::broadcast;
|
||||
|
||||
/// ID of sync client
|
||||
#[derive(Debug, Clone, Eq, PartialEq)]
|
||||
pub struct SyncClientID(uuid::Uuid);
|
||||
|
||||
/// Sync client launcher loop
|
||||
pub async fn sync_client_manager(tx: broadcast::Sender<BroadcastMessage>) -> ! {
|
||||
let mut rx = tx.subscribe();
|
||||
let tx = Arc::new(tx.clone());
|
||||
|
||||
let mut running_tasks = HashMap::new();
|
||||
|
||||
while let Ok(msg) = rx.recv().await {
|
||||
match msg {
|
||||
BroadcastMessage::StartSyncTaskForUser(user_id) => {
|
||||
if running_tasks.contains_key(&user_id) {
|
||||
log::info!("Won't start sync task for user {user_id:?} because a task is already running for this user!");
|
||||
continue;
|
||||
}
|
||||
|
||||
log::info!("Start sync task for user {:?}", user_id);
|
||||
let task_id = SyncClientID(uuid::Uuid::new_v4());
|
||||
running_tasks.insert(user_id.clone(), task_id.clone());
|
||||
|
||||
let tx = tx.clone();
|
||||
tokio::task::spawn(async move {
|
||||
sync_task(task_id, user_id, tx).await;
|
||||
});
|
||||
}
|
||||
|
||||
BroadcastMessage::StopSyncTaskForUser(user_id) => {
|
||||
// Check if a task is running for this user
|
||||
if let Some(task_id) = running_tasks.remove(&user_id) {
|
||||
log::info!("Stop sync task for user {:?}", user_id);
|
||||
tx.send(BroadcastMessage::StopSyncClient(task_id)).unwrap();
|
||||
} else {
|
||||
log::info!("Not stopping sync task for user {user_id:?}: not running");
|
||||
}
|
||||
}
|
||||
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
|
||||
panic!("Sync client manager stopped unexpectedly!");
|
||||
}
|
||||
|
||||
/// Sync task for a single user
|
||||
async fn sync_task(
|
||||
id: SyncClientID,
|
||||
user_id: UserID,
|
||||
tx: Arc<broadcast::Sender<BroadcastMessage>>,
|
||||
) {
|
||||
let mut rx = tx.subscribe();
|
||||
|
||||
let Ok(user_config) = UserConfig::load(&user_id, false).await else {
|
||||
log::error!("Failed to load user config in sync thread!");
|
||||
return;
|
||||
};
|
||||
|
||||
let client = match user_config.matrix_client().await {
|
||||
Err(e) => {
|
||||
log::error!("Failed to load matrix client for user {user_id:?}: {e}");
|
||||
return;
|
||||
}
|
||||
Ok(client) => client,
|
||||
};
|
||||
|
||||
let initial_sync_response = match client
|
||||
.send_request(assign!(sync_events::v3::Request::new(), {
|
||||
filter: None,
|
||||
}))
|
||||
.await
|
||||
{
|
||||
Ok(res) => res,
|
||||
Err(e) => {
|
||||
log::error!("Failed to perform initial sync request for user {user_id:?}! {e}");
|
||||
return;
|
||||
}
|
||||
};
|
||||
|
||||
let mut sync_stream = Box::pin(client.sync(
|
||||
None,
|
||||
initial_sync_response.next_batch,
|
||||
PresenceState::Offline,
|
||||
Some(Duration::from_secs(30)),
|
||||
));
|
||||
|
||||
loop {
|
||||
tokio::select! {
|
||||
// Message from tokio broadcast
|
||||
msg = rx.recv() => {
|
||||
match msg {
|
||||
Ok(BroadcastMessage::StopSyncClient(client_id)) => {
|
||||
if client_id == id {
|
||||
log::info!("A request was received to stop this client! {id:?} for user {user_id:?}");
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
Err(e) => {
|
||||
log::error!("Failed to receive a message from broadcast! {e}");
|
||||
return;
|
||||
}
|
||||
|
||||
Ok(_) => {}
|
||||
}
|
||||
}
|
||||
|
||||
// Message from Matrix
|
||||
msg_stream = sync_stream.try_next() => {
|
||||
match msg_stream {
|
||||
Ok(Some(msg)) => {
|
||||
log::debug!("Received new message from Matrix: {msg:#?}");
|
||||
if let Err(e) = tx.send(BroadcastMessage::SyncEvent(user_id.clone(), SyncEvent {
|
||||
rooms: msg.rooms,presence: msg.presence,
|
||||
account_data: msg.account_data,
|
||||
to_device: msg.to_device,
|
||||
device_lists: msg.device_lists,
|
||||
})) {
|
||||
log::error!("Failed to propagate event! {e}");
|
||||
}
|
||||
}
|
||||
Ok(None) => {
|
||||
log::debug!("Received no message from Matrix");
|
||||
}
|
||||
Err(e) => {
|
||||
log::error!("Failed to receive a message from Matrix! {e}");
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
33
src/user.rs
33
src/user.rs
@@ -6,15 +6,20 @@ use thiserror::Error;
|
||||
|
||||
use crate::app_config::AppConfig;
|
||||
use crate::constants::TOKEN_LEN;
|
||||
use crate::utils::{curr_time, format_time, rand_str};
|
||||
use crate::utils::base_utils::{curr_time, format_time, rand_str};
|
||||
|
||||
type HttpClient = ruma::client::http_client::HyperNativeTls;
|
||||
pub type RumaClient = ruma::Client<HttpClient>;
|
||||
|
||||
#[derive(Error, Debug)]
|
||||
pub enum UserError {
|
||||
#[error("failed to fetch user configuration: {0}")]
|
||||
FetchUserConfig(S3Error),
|
||||
#[error("missing matrix token")]
|
||||
MissingMatrixToken,
|
||||
}
|
||||
|
||||
#[derive(serde::Serialize, serde::Deserialize, Debug, Clone)]
|
||||
#[derive(serde::Serialize, serde::Deserialize, Debug, Clone, PartialEq, Eq, Hash)]
|
||||
pub struct UserID(pub String);
|
||||
|
||||
impl UserID {
|
||||
@@ -80,6 +85,10 @@ impl APIClient {
|
||||
pub fn fmt_used(&self) -> String {
|
||||
format_time(self.used).unwrap_or_default()
|
||||
}
|
||||
|
||||
pub fn need_update_last_used(&self) -> bool {
|
||||
self.used + 60 * 15 < curr_time().unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
impl APIClient {
|
||||
@@ -97,7 +106,7 @@ impl APIClient {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(serde::Serialize, serde::Deserialize)]
|
||||
#[derive(serde::Serialize, serde::Deserialize, Clone)]
|
||||
pub struct UserConfig {
|
||||
/// Target user ID
|
||||
pub user_id: UserID,
|
||||
@@ -211,4 +220,22 @@ impl UserConfig {
|
||||
pub fn find_client_by_id(&self, id: &APIClientID) -> Option<&APIClient> {
|
||||
self.clients.iter().find(|c| &c.id == id)
|
||||
}
|
||||
|
||||
/// Find a client by its id and get a mutable reference
|
||||
pub fn find_client_by_id_mut(&mut self, id: &APIClientID) -> Option<&mut APIClient> {
|
||||
self.clients.iter_mut().find(|c| &c.id == id)
|
||||
}
|
||||
|
||||
/// Get a matrix client instance for the current user
|
||||
pub async fn matrix_client(&self) -> anyhow::Result<RumaClient> {
|
||||
if self.matrix_token.is_empty() {
|
||||
return Err(UserError::MissingMatrixToken.into());
|
||||
}
|
||||
|
||||
Ok(ruma::Client::builder()
|
||||
.homeserver_url(AppConfig::get().matrix_homeserver.to_string())
|
||||
.access_token(Some(self.matrix_token.clone()))
|
||||
.build()
|
||||
.await?)
|
||||
}
|
||||
}
|
||||
|
||||
18
src/utils/matrix_utils.rs
Normal file
18
src/utils/matrix_utils.rs
Normal file
@@ -0,0 +1,18 @@
|
||||
use ruma::OwnedMxcUri;
|
||||
use serde::ser::SerializeMap;
|
||||
use serde::{Serialize, Serializer};
|
||||
|
||||
pub struct ApiMxcURI(pub OwnedMxcUri);
|
||||
|
||||
impl Serialize for ApiMxcURI {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
let mut map = serializer.serialize_map(Some(3))?;
|
||||
map.serialize_entry("uri", &self.0)?;
|
||||
map.serialize_entry("server_name", &self.0.server_name().ok())?;
|
||||
map.serialize_entry("media_id", &self.0.media_id().ok())?;
|
||||
map.end()
|
||||
}
|
||||
}
|
||||
2
src/utils/mod.rs
Normal file
2
src/utils/mod.rs
Normal file
@@ -0,0 +1,2 @@
|
||||
pub mod base_utils;
|
||||
pub mod matrix_utils;
|
||||
46
templates/base_page.html
Normal file
46
templates/base_page.html
Normal file
@@ -0,0 +1,46 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Matrix GW</title>
|
||||
<link rel="icon" type="image/png" href="/assets/favicon.png"/>
|
||||
|
||||
<link rel="stylesheet" href="/assets/bootstrap.css"/>
|
||||
<link rel="stylesheet" href="/assets/style.css"/>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<!-- Header -->
|
||||
<header data-bs-theme="dark">
|
||||
<div class="navbar navbar-dark bg-dark shadow-sm">
|
||||
<div class="container">
|
||||
<a href="/" class="navbar-brand d-flex align-items-center">
|
||||
<svg xxmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" stroke="currentColor"
|
||||
stroke-linecap="round" stroke-linejoin="round" stroke-width="1" aria-hidden="true" class="me-2"
|
||||
viewBox="0 0 24 24">
|
||||
<path d="M10 11.5H17V13H10V11.5M10 8.5H19V10H10V8.5M20 5H9C7.9 5 7 5.9 7 7V21L11 17H20C21.1 17 22 16.1 22 15V7C22 5.9 21.1 5 20 5M20 15H10.2L9 16.2V7H20V15M3 7C2.4 7 2 7.4 2 8S2.4 9 3 9H5V7H3M2 11C1.4 11 1 11.4 1 12S1.4 13 2 13H5V11H2M1 15C.4 15 0 15.4 0 16C0 16.6 .4 17 1 17H5V15H1Z"/>
|
||||
</svg>
|
||||
<strong>Matrix GW</strong>
|
||||
</a>
|
||||
<ul class="navbar-nav mr-auto" style="flex: 1">
|
||||
<li class="nav-item"><a href="/ws_debug" class="nav-link">WS Debug</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="navbar" >
|
||||
<span>Hi <span style="font-style: italic;">{{ name }}</span> </span>
|
||||
<a href="/sign_out">Sign out</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
|
||||
<div class="body-content">
|
||||
{% block content %}
|
||||
TO_REPLACE
|
||||
{% endblock content %}
|
||||
</div>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,181 +1,146 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Matrix GW</title>
|
||||
<link rel="icon" type="image/png" href="/assets/favicon.png"/>
|
||||
{% extends "base_page.html" %}
|
||||
{% block content %}
|
||||
<!-- Success message -->
|
||||
{% if let Some(msg) = success_message %}
|
||||
<div class="alert alert-success">
|
||||
{{ msg }}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<link rel="stylesheet" href="/assets/bootstrap.css"/>
|
||||
<link rel="stylesheet" href="/assets/style.css"/>
|
||||
<script src="/assets/script.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<!-- Error message -->
|
||||
{% if let Some(msg) = error_message %}
|
||||
<div class="alert alert-danger">
|
||||
{{ msg }}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Header -->
|
||||
<header data-bs-theme="dark">
|
||||
<div class="navbar navbar-dark bg-dark shadow-sm">
|
||||
<div class="container">
|
||||
<a href="/" class="navbar-brand d-flex align-items-center">
|
||||
<svg xxmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" stroke="currentColor"
|
||||
stroke-linecap="round" stroke-linejoin="round" stroke-width="1" aria-hidden="true" class="me-2"
|
||||
viewBox="0 0 24 24">
|
||||
<path d="M10 11.5H17V13H10V11.5M10 8.5H19V10H10V8.5M20 5H9C7.9 5 7 5.9 7 7V21L11 17H20C21.1 17 22 16.1 22 15V7C22 5.9 21.1 5 20 5M20 15H10.2L9 16.2V7H20V15M3 7C2.4 7 2 7.4 2 8S2.4 9 3 9H5V7H3M2 11C1.4 11 1 11.4 1 12S1.4 13 2 13H5V11H2M1 15C.4 15 0 15.4 0 16C0 16.6 .4 17 1 17H5V15H1Z"/>
|
||||
</svg>
|
||||
<strong>Matrix GW</strong>
|
||||
</a>
|
||||
<div class="navbar">
|
||||
<span>Hi <span style="font-style: italic;">{{ name }}</span> </span>
|
||||
<a href="/sign_out">Sign out</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<!-- User ID -->
|
||||
<div id="user_id_container"><strong>Current user ID</strong>: {{ user_id.0 }}</div>
|
||||
|
||||
<!-- Display clients list -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">Registered clients</div>
|
||||
<div class="card-body">
|
||||
{% if clients.len() > 0 %}
|
||||
<table class="table table-hover">
|
||||
<thead>
|
||||
<tr>
|
||||
<th scope="col">ID</th>
|
||||
<th scope="col">Description</th>
|
||||
<th scope="col">Read only</th>
|
||||
<th scope="col">Network</th>
|
||||
<th scope="col">Created</th>
|
||||
<th scope="col">Used</th>
|
||||
<th scope="col"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{% for client in clients %}
|
||||
<tr>
|
||||
<th scope="row">{{ client.id.0 }}</th>
|
||||
<td>{{ client.description }}</td>
|
||||
<td>
|
||||
{% if client.readonly_client %}
|
||||
<strong>YES</strong>
|
||||
{% else %}
|
||||
<i>NO</i>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td>
|
||||
{% if let Some(net) = client.network %}
|
||||
{{ net }}
|
||||
{% else %}
|
||||
<i>Unrestricted</i>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td>{{ client.fmt_created() }}</td>
|
||||
<td>{{ client.fmt_used() }}</td>
|
||||
<td>
|
||||
<button type="button" class="btn btn-danger btn-sm" onclick="deleteClient('{{ client.id.0 }}');">
|
||||
Delete
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
{% endif %}
|
||||
|
||||
<div class="body-content">
|
||||
<!-- Success message -->
|
||||
{% if let Some(msg) = success_message %}
|
||||
<div class="alert alert-success">
|
||||
{{ msg }}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Error message -->
|
||||
{% if let Some(msg) = error_message %}
|
||||
<div class="alert alert-danger">
|
||||
{{ msg }}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- User ID -->
|
||||
<div id="user_id_container"><strong>Current user ID</strong>: {{ user_id.0 }}</div>
|
||||
|
||||
<!-- Display clients list -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">Registered clients</div>
|
||||
<div class="card-body">
|
||||
{% if clients.len() > 0 %}
|
||||
<table class="table table-hover">
|
||||
<thead>
|
||||
<tr>
|
||||
<th scope="col">ID</th>
|
||||
<th scope="col">Description</th>
|
||||
<th scope="col">Read only</th>
|
||||
<th scope="col">Network</th>
|
||||
<th scope="col">Created</th>
|
||||
<th scope="col">Used</th>
|
||||
<th scope="col"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{% for client in clients %}
|
||||
<tr>
|
||||
<th scope="row">{{ client.id.0 }}</th>
|
||||
<td>{{ client.description }}</td>
|
||||
<td>
|
||||
{% if client.readonly_client %}
|
||||
<strong>YES</strong>
|
||||
{% else %}
|
||||
<i>NO</i>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td>
|
||||
{% if let Some(net) = client.network %}
|
||||
{{ net }}
|
||||
{% else %}
|
||||
<i>Unrestricted</i>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td>{{ client.fmt_created() }}</td>
|
||||
<td>{{ client.fmt_used() }}</td>
|
||||
<td>
|
||||
<button type="button" class="btn btn-danger btn-sm" onclick="deleteClient('{{ client.id.0 }}');">
|
||||
Delete
|
||||
</button>
|
||||
</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
{% endif %}
|
||||
|
||||
{% if clients.len() == 0 %}
|
||||
<p>No client registered yet!</p>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- New client -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">New client</div>
|
||||
<div class="card-body">
|
||||
<form action="/" method="post">
|
||||
<div>
|
||||
<label for="new_client_desc" class="form-label">Description</label>
|
||||
<input type="text" class="form-control" id="new_client_desc" required minlength="3"
|
||||
aria-describedby="new_client_desc" placeholder="New client description..."
|
||||
name="new_client_desc"/>
|
||||
<small class="form-text text-muted">Client description helps with identification.</small>
|
||||
</div>
|
||||
<div>
|
||||
<label for="ip_network" class="form-label">Allowed IP network</label>
|
||||
<input type="text" class="form-control" id="ip_network" aria-describedby="ip_network"
|
||||
placeholder="Client network (x.x.x.x/x or x:x:x:x:x:x/x" name="ip_network"/>
|
||||
<small class="form-text text-muted">Restrict the networks this IP address can be used from.</small>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
<div class="form-check">
|
||||
<input class="form-check-input" type="checkbox" value="" checked id="readonly_client"
|
||||
name="readonly_client"/>
|
||||
<label class="form-check-label" for="readonly_client">
|
||||
Readonly client
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
<input type="submit" class="btn btn-primary" value="Create client"/>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Matrix authentication token -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">Matrix authentication token</div>
|
||||
<div class="card-body">
|
||||
<p>To obtain a new Matrix authentication token:</p>
|
||||
<ol>
|
||||
<li>Sign in to Element <strong>from a private browser window</strong></li>
|
||||
<li>Open <em>All settings</em> and access the <em>Help & About</em> tag</li>
|
||||
<li>Expand <em>Access Token</em> and copy the value</li>
|
||||
<li>Paste the copied value below</li>
|
||||
<li>Close the private browser window <strong>without signing out</strong>!</li>
|
||||
</ol>
|
||||
|
||||
<p>You should not need to replace this value unless you explicitly signed out the associated browser
|
||||
session.</p>
|
||||
|
||||
<p>Tip: you can rename the session to easily identify it among all your other sessions!</p>
|
||||
|
||||
<form action="/" method="post">
|
||||
<div>
|
||||
<label for="accessTokenInput" class="form-label mt-4">New Matrix access token</label>
|
||||
<input type="text" class="form-control" id="accessTokenInput" aria-describedby="tokenHelp"
|
||||
placeholder="{{ matrix_token }}" required minlength="2" name="new_matrix_token"/>
|
||||
<small id="tokenHelp" class="form-text text-muted">Changing this value will reset all active
|
||||
connections
|
||||
to Matrix GW.</small>
|
||||
</div>
|
||||
|
||||
<input type="submit" class="btn btn-primary" value="Update"/>
|
||||
</form>
|
||||
</div>
|
||||
{% if clients.len() == 0 %}
|
||||
<p>No client registered yet!</p>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- New client -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">New client</div>
|
||||
<div class="card-body">
|
||||
<form action="/" method="post">
|
||||
<div>
|
||||
<label for="new_client_desc" class="form-label">Description</label>
|
||||
<input type="text" class="form-control" id="new_client_desc" required minlength="3"
|
||||
aria-describedby="new_client_desc" placeholder="New client description..."
|
||||
name="new_client_desc"/>
|
||||
<small class="form-text text-muted">Client description helps with identification.</small>
|
||||
</div>
|
||||
<div>
|
||||
<label for="ip_network" class="form-label">Allowed IP network</label>
|
||||
<input type="text" class="form-control" id="ip_network" aria-describedby="ip_network"
|
||||
placeholder="Client network (x.x.x.x/x or x:x:x:x:x:x/x" name="ip_network"/>
|
||||
<small class="form-text text-muted">Restrict the networks this IP address can be used from.</small>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
<br/>
|
||||
|
||||
<div class="form-check">
|
||||
<input class="form-check-input" type="checkbox" value="" checked id="readonly_client"
|
||||
name="readonly_client"/>
|
||||
<label class="form-check-label" for="readonly_client">
|
||||
Readonly client
|
||||
</label>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
<input type="submit" class="btn btn-primary" value="Create client"/>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Matrix authentication token -->
|
||||
<div class="card border-light mb-3">
|
||||
<div class="card-header">Matrix authentication token</div>
|
||||
<div class="card-body">
|
||||
<p>To obtain a new Matrix authentication token:</p>
|
||||
<ol>
|
||||
<li>Sign in to Element <strong>from a private browser window</strong></li>
|
||||
<li>Open <em>All settings</em> and access the <em>Help & About</em> tag</li>
|
||||
<li>Expand <em>Access Token</em> and copy the value</li>
|
||||
<li>Paste the copied value below</li>
|
||||
<li>Close the private browser window <strong>without signing out</strong>!</li>
|
||||
</ol>
|
||||
|
||||
<p>You should not need to replace this value unless you explicitly signed out the associated browser
|
||||
session.</p>
|
||||
|
||||
<p>Tip: you can rename the session to easily identify it among all your other sessions!</p>
|
||||
|
||||
<form action="/" method="post">
|
||||
<div>
|
||||
<label for="accessTokenInput" class="form-label mt-4">New Matrix access token</label>
|
||||
<input type="text" class="form-control" id="accessTokenInput" aria-describedby="tokenHelp"
|
||||
placeholder="{{ matrix_token }}" required minlength="2" name="new_matrix_token"/>
|
||||
<small id="tokenHelp" class="form-text text-muted">Changing this value will reset all active
|
||||
connections
|
||||
to Matrix GW.</small>
|
||||
</div>
|
||||
|
||||
<input type="submit" class="btn btn-primary" value="Update"/>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/assets/script.js"></script>
|
||||
{% endblock content %}
|
||||
46
templates/ws_debug.html
Normal file
46
templates/ws_debug.html
Normal file
@@ -0,0 +1,46 @@
|
||||
{% extends "base_page.html" %}
|
||||
{% block content %}
|
||||
|
||||
<style>
|
||||
#ws_actions {
|
||||
margin: 30px;
|
||||
border: 1px white solid;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
#ws_log {
|
||||
margin: 30px;
|
||||
border: 1px white solid;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
#ws_log .message {
|
||||
display: flex;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
#ws_log .message .type {
|
||||
font-style: italic;
|
||||
margin-right: 10px;
|
||||
}
|
||||
</style>
|
||||
|
||||
|
||||
<h2>WS Debug</h2>
|
||||
|
||||
<div id="ws_actions">
|
||||
<button onclick="connect()">Reconnect</button>
|
||||
<button onclick="disconnect()">Disconnect</button>
|
||||
<button onclick="clearLogs()">Clear logs</button>
|
||||
<span>State: <span id="state">DISCONNECTED</span></span>
|
||||
</div>
|
||||
|
||||
<div id="ws_log">
|
||||
<div class="message">
|
||||
<div class="type">INFO</div>
|
||||
<div>Welcome!</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<script src="/assets/ws_debug.js"></script>
|
||||
{% endblock content %}
|
||||
Reference in New Issue
Block a user