diff --git a/.github/workflows/style_checks.yml b/.github/workflows/style_checks.yml index 83c2d02..22ad2cc 100644 --- a/.github/workflows/style_checks.yml +++ b/.github/workflows/style_checks.yml @@ -24,11 +24,11 @@ jobs: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v3 - - name: apt install gstreamer + - name: apt install gstreamer and deps run: | sudo apt update sudo apt install -y aptitude - sudo aptitude install -y libgstrtspserver-1.0-dev libgstreamer1.0-dev libgtk2.0-dev + sudo aptitude install -y libgstrtspserver-1.0-dev libgstreamer1.0-dev libgtk2.0-dev protobuf-compiler - name: Install nightly rust run: | rustup toolchain install nightly --component clippy diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..e19cae0 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,2 @@ +MD013: + code_blocks: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 04984d9..af9fb14 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,4 +16,5 @@ repos: hooks: - id: markdownlint-fix files: README.md + args: [--disable, MD041, --] diff --git a/Cargo.lock b/Cargo.lock index 06be568..910de79 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -48,6 +48,15 @@ dependencies = [ "memchr", ] +[[package]] +name = "android_system_properties" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "819e7219dbd41043ac279b19830f2efc897156490d7fd6ea916720117ee66311" +dependencies = [ + "libc", +] + [[package]] name = "anstream" version = "0.3.2" @@ -280,6 +289,19 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +[[package]] +name = "chrono" +version = "0.4.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4e3c5919066adf22df73762e50cffcde3a758f2a848b113b586d1f86728b673b" +dependencies = [ + "iana-time-zone", + "num-integer", + "num-traits", + "serde", + "winapi 0.3.9", +] + [[package]] name = "cipher" version = "0.4.4" @@ -468,6 +490,41 @@ dependencies = [ "typenum", ] +[[package]] +name = "darling" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0558d22a7b463ed0241e993f76f09f30b126687447751a8638587b864e4b3944" +dependencies = [ + "darling_core", + "darling_macro", +] + +[[package]] +name = "darling_core" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab8bfa2e259f8ee1ce5e97824a3c55ec4404a0d772ca7fa96bf19f0752a046eb" +dependencies = [ + "fnv", + "ident_case", + "proc-macro2", + "quote", + "strsim", + "syn 2.0.15", +] + +[[package]] +name = "darling_macro" +version = "0.20.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29a358ff9f12ec09c3e61fef9b5a9902623a695a46a917b07f269bff1445611a" +dependencies = [ + "darling_core", + "quote", + "syn 2.0.15", +] + [[package]] name = "delegate" version = "0.10.0" @@ -491,6 +548,15 @@ version = "1.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07" +[[package]] +name = "encoding_rs" +version = "0.8.32" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071a31f4ee85403370b58aca746f01041ede6f0da2730960ad001edc2b71b394" +dependencies = [ + "cfg-if", +] + [[package]] name = "env_logger" version = "0.10.0" @@ -551,6 +617,32 @@ version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "6999dc1837253364c2ebb0704ba97994bd874e8f195d665c50b7548f6ea92764" +[[package]] +name = "fcm-push-listener" +version = "2.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "51e1e9327cb6abc9da64951727a3cf534ae7101e529382dac7f5d350bccdba42" +dependencies = [ + "base64 0.21.0", + "ece", + "log", + "prost", + "prost-build", + "reqwest", + "serde", + "serde_with", + "tokio", + "tokio-rustls", + "uuid", + "webpki-roots", +] + +[[package]] +name = "fixedbitset" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ce7134b9999ecaf8bcd65542e436736ef32ddca1b3e06094cb6ec5755203b80" + [[package]] name = "flate2" version = "1.0.26" @@ -580,6 +672,21 @@ version = "1.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" +[[package]] +name = "foreign-types" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1" +dependencies = [ + "foreign-types-shared", +] + +[[package]] +name = "foreign-types-shared" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" + [[package]] name = "form_urlencoded" version = "1.2.0" @@ -1090,6 +1197,24 @@ version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "848ec2dd093df965a34b434580d94852197fc83feac5b2c1962399bbf2cb4f0b" +[[package]] +name = "hkdf" +version = "0.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791a029f6b9fc27657f6f188ec6e5e43f6911f6f878e0dc5501396e09809d437" +dependencies = [ + "hmac", +] + +[[package]] +name = "hmac" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c49c37c09c17a53d937dfbb742eb3a961d65a994e6bcdcf37e7399d0cc8ab5e" +dependencies = [ + "digest", +] + [[package]] name = "http" version = "0.2.9" @@ -1166,6 +1291,48 @@ dependencies = [ "tokio-io-timeout", ] +[[package]] +name = "hyper-tls" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d6183ddfa99b85da61a140bea0efc93fdf56ceaa041b37d553518030827f9905" +dependencies = [ + "bytes", + "hyper", + "native-tls", + "tokio", + "tokio-native-tls", +] + +[[package]] +name = "iana-time-zone" +version = "0.1.56" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0722cd7114b7de04316e7ea5456a0bbb20e4adb46fd27a3697adb812cff0f37c" +dependencies = [ + "android_system_properties", + "core-foundation-sys", + "iana-time-zone-haiku", + "js-sys", + "wasm-bindgen", + "windows", +] + +[[package]] +name = "iana-time-zone-haiku" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f31827a206f56af32e590ba56d5d2d085f558508192593743f16b2306495269f" +dependencies = [ + "cc", +] + +[[package]] +name = "ident_case" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" + [[package]] name = "idna" version = "0.4.0" @@ -1373,6 +1540,12 @@ version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "956787520e75e9bd233246045d19f42fb73242759cc57fba9611d940ae96d4b0" +[[package]] +name = "multimap" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5ce46fe64a9d73be07dcbe690a38ce1b293be448fd8ce1e6c1b8062c9f72c6a" + [[package]] name = "nanorand" version = "0.7.0" @@ -1382,6 +1555,24 @@ dependencies = [ "getrandom", ] +[[package]] +name = "native-tls" +version = "0.2.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07226173c32f2926027b63cce4bcd8076c3552846cbe7925f3aaffeac0a3b92e" +dependencies = [ + "lazy_static", + "libc", + "log", + "openssl", + "openssl-probe", + "openssl-sys", + "schannel", + "security-framework", + "security-framework-sys", + "tempfile", +] + [[package]] name = "neli" version = "0.6.4" @@ -1562,12 +1753,50 @@ version = "1.18.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d" +[[package]] +name = "openssl" +version = "0.10.52" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "01b8574602df80f7b85fdfc5392fa884a4e3b3f4f35402c070ab34c3d3f78d56" +dependencies = [ + "bitflags", + "cfg-if", + "foreign-types", + "libc", + "once_cell", + "openssl-macros", + "openssl-sys", +] + +[[package]] +name = "openssl-macros" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.15", +] + [[package]] name = "openssl-probe" version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" +[[package]] +name = "openssl-sys" +version = "0.9.87" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e17f59264b2809d77ae94f0e1ebabc434773f370d6ca667bd223ea10e06cc7e" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + [[package]] name = "option-operations" version = "0.5.0" @@ -1612,6 +1841,16 @@ version = "2.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9b2a4787296e9989611394c33f193f676704af1686e70b8f8033ab5ba9a35a94" +[[package]] +name = "petgraph" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4dd7d28ee937e54fe3080c91faa1c3a46c06de6252988a7f4592ba2310ef22a4" +dependencies = [ + "fixedbitset", + "indexmap", +] + [[package]] name = "pin-project" version = "1.1.2" @@ -1662,6 +1901,16 @@ version = "0.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "c6fa0831dd7cc608c38a5e323422a0077678fa5744aa2be4ad91c4ece8eec8d5" +[[package]] +name = "prettyplease" +version = "0.1.25" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6c8646e95016a7a6c4adea95bafa8a16baab64b583356217f2c85db4a39d9a86" +dependencies = [ + "proc-macro2", + "syn 1.0.109", +] + [[package]] name = "proc-macro-crate" version = "1.3.1" @@ -1715,6 +1964,28 @@ dependencies = [ "prost-derive", ] +[[package]] +name = "prost-build" +version = "0.11.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "119533552c9a7ffacc21e099c24a0ac8bb19c2a2a3f363de84cd9b844feab270" +dependencies = [ + "bytes", + "heck", + "itertools", + "lazy_static", + "log", + "multimap", + "petgraph", + "prettyplease", + "prost", + "prost-types", + "regex", + "syn 1.0.109", + "tempfile", + "which", +] + [[package]] name = "prost-derive" version = "0.11.9" @@ -1737,6 +2008,25 @@ dependencies = [ "prost", ] +[[package]] +name = "pushnoti" +version = "0.1.0" +dependencies = [ + "anyhow", + "clap", + "env_logger", + "fcm-push-listener", + "lazy_static", + "log", + "neolink_core", + "regex", + "serde", + "tokio", + "toml", + "validator", + "validator_derive", +] + [[package]] name = "quote" version = "1.0.32" @@ -1855,6 +2145,43 @@ dependencies = [ "unicode-segmentation", ] +[[package]] +name = "reqwest" +version = "0.11.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cde824a14b7c14f85caff81225f411faacc04a2013f41670f41443742b1c1c55" +dependencies = [ + "base64 0.21.0", + "bytes", + "encoding_rs", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "hyper", + "hyper-tls", + "ipnet", + "js-sys", + "log", + "mime", + "native-tls", + "once_cell", + "percent-encoding", + "pin-project-lite", + "serde", + "serde_json", + "serde_urlencoded", + "tokio", + "tokio-native-tls", + "tower-service", + "url", + "wasm-bindgen", + "wasm-bindgen-futures", + "web-sys", + "winreg", +] + [[package]] name = "ring" version = "0.16.20" @@ -2060,6 +2387,57 @@ dependencies = [ "serde", ] +[[package]] +name = "serde_urlencoded" +version = "0.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd" +dependencies = [ + "form_urlencoded", + "itoa", + "ryu", + "serde", +] + +[[package]] +name = "serde_with" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "07ff71d2c147a7b57362cead5e22f772cd52f6ab31cfcd9edcd7f6aeb2a0afbe" +dependencies = [ + "base64 0.13.1", + "chrono", + "hex", + "indexmap", + "serde", + "serde_json", + "serde_with_macros", + "time", +] + +[[package]] +name = "serde_with_macros" +version = "2.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "881b6f881b17d13214e5d494c939ebab463d01264ce1811e9d4ac3a882e7695f" +dependencies = [ + "darling", + "proc-macro2", + "quote", + "syn 2.0.15", +] + +[[package]] +name = "sha2" +version = "0.10.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82e6b795fe2e3b1e845bafcb27aa35405c4d47cdfc92af5fc8d3002f76cebdc0" +dependencies = [ + "cfg-if", + "cpufeatures", + "digest", +] + [[package]] name = "sharded-slab" version = "0.1.4" @@ -2157,6 +2535,12 @@ version = "0.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623" +[[package]] +name = "subtle" +version = "2.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6bdef32e8150c2a081110b42772ffe7d7c9032b606bc226c8260fd97e0976601" + [[package]] name = "syn" version = "1.0.109" @@ -2385,6 +2769,16 @@ dependencies = [ "syn 2.0.28", ] +[[package]] +name = "tokio-native-tls" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbae76ab933c85776efabc971569dd6119c580d8f5d448769dec1764bf796ef2" +dependencies = [ + "native-tls", + "tokio", +] + [[package]] name = "tokio-rustls" version = "0.24.1" @@ -2647,6 +3041,28 @@ version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a" +[[package]] +name = "uuid" +version = "1.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "345444e32442451b267fc254ae85a209c64be56d2890e601a0c37ff0c3c5ecd2" +dependencies = [ + "getrandom", + "rand", + "uuid-macro-internal", +] + +[[package]] +name = "uuid-macro-internal" +version = "1.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f67b459f42af2e6e1ee213cb9da4dbd022d3320788c3fb3e1b893093f1e45da" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.15", +] + [[package]] name = "validator" version = "0.16.1" @@ -2694,6 +3110,12 @@ version = "0.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d" +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + [[package]] name = "version-compare" version = "0.1.1" @@ -2746,6 +3168,18 @@ dependencies = [ "wasm-bindgen-shared", ] +[[package]] +name = "wasm-bindgen-futures" +version = "0.4.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f219e0d211ba40266969f6dbdd90636da12f75bee4fc9d6c23d1260dadb51454" +dependencies = [ + "cfg-if", + "js-sys", + "wasm-bindgen", + "web-sys", +] + [[package]] name = "wasm-bindgen-macro" version = "0.2.87" @@ -2822,6 +3256,15 @@ version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" +[[package]] +name = "windows" +version = "0.48.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f" +dependencies = [ + "windows-targets 0.48.0", +] + [[package]] name = "windows-sys" version = "0.48.0" @@ -2897,6 +3340,15 @@ dependencies = [ "memchr", ] +[[package]] +name = "winreg" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80d0f4e272c85def139476380b12f9ac60926689dd2e01d4923222f40580869d" +dependencies = [ + "winapi 0.3.9", +] + [[package]] name = "winsplit" version = "0.1.0" diff --git a/crates/core/src/bc/model.rs b/crates/core/src/bc/model.rs index a376b1f..4e8a0ea 100644 --- a/crates/core/src/bc/model.rs +++ b/crates/core/src/bc/model.rs @@ -47,6 +47,10 @@ pub const MSG_ID_STREAM_INFO_LIST: u32 = 146; pub const MSG_ID_ABILITY_INFO: u32 = 151; /// Get the available PTZ position presets pub const MSG_ID_GET_PTZ_PRESET: u32 = 190; +/// Setting general system info (clock mostly) messages have this ID +pub const MSG_ID_SET_GENERAL: u32 = 105; +/// Used to pass the token and client ID for push notifications +pub const MSG_ID_PUSH_INFO: u32 = 124; /// Will send the talk config for talk back data to follow this msg pub const MSG_ID_TALKCONFIG: u32 = 201; /// Used to send talk back binary data diff --git a/crates/core/src/bc/xml.rs b/crates/core/src/bc/xml.rs index eca6cfb..1b0a1e4 100644 --- a/crates/core/src/bc/xml.rs +++ b/crates/core/src/bc/xml.rs @@ -94,6 +94,9 @@ pub struct BcXml { /// Recieved on request for a users persmissions/capabilitoes #[yaserde(rename = "AbilityInfo")] pub ability_info: Option, + /// Recieved on request for a users persmissions/capabilitoes + #[yaserde(rename = "PushInfo")] + pub push_info: Option, /// Recieved on request for a link type #[yaserde(rename = "LinkType")] pub link_type: Option, @@ -719,6 +722,19 @@ pub struct AbilityInfoSubModule { pub ability_value: String, } +/// PushInfo XML +#[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] +pub struct PushInfo { + /// The token from FCM registration + pub token: String, + /// The phone type, known values: `reo_iphone` + #[yaserde(rename = "phoneType")] + pub phone_type: String, + /// A client ID, seems to be an all CAPS MD5 hash of something + #[yaserde(rename = "clientID")] + pub client_id: String, +} + /// The Link Type contains the type of connection present #[derive(PartialEq, Eq, Default, Debug, YaDeserialize, YaSerialize)] pub struct LinkType { diff --git a/crates/core/src/bc_protocol.rs b/crates/core/src/bc_protocol.rs index 589ef89..0a66e2b 100644 --- a/crates/core/src/bc_protocol.rs +++ b/crates/core/src/bc_protocol.rs @@ -27,6 +27,7 @@ mod motion; mod ping; mod pirstate; mod ptz; +mod pushinfo; mod reboot; mod resolution; mod snap; @@ -44,6 +45,7 @@ pub use login::MaxEncryption; pub use motion::{MotionData, MotionStatus}; pub use pirstate::PirState; pub use ptz::Direction; +pub use pushinfo::PhoneType; pub use resolution::*; use std::sync::Arc; pub use stream::{StreamData, StreamKind}; diff --git a/crates/core/src/bc_protocol/connection/discovery.rs b/crates/core/src/bc_protocol/connection/discovery.rs index 0160482..af21716 100644 --- a/crates/core/src/bc_protocol/connection/discovery.rs +++ b/crates/core/src/bc_protocol/connection/discovery.rs @@ -489,6 +489,8 @@ impl Discoverer { }, }; + trace!("Registering: {:?}", msg.payload.c2r_c); + // Send and await acceptance let (sid, dev, dmap, relay) = self .retry_send(msg, lookup.reg, |bc, socket| { diff --git a/crates/core/src/bc_protocol/pushinfo.rs b/crates/core/src/bc_protocol/pushinfo.rs new file mode 100644 index 0000000..ab8851c --- /dev/null +++ b/crates/core/src/bc_protocol/pushinfo.rs @@ -0,0 +1,72 @@ +use super::{BcCamera, Error, Result}; +use crate::bc::{model::*, xml::*}; + +/// Specifies the phone type for the push notification +pub enum PhoneType { + /// Specify that this is an ios push notfication + /// + /// In this case the token must be the APNS + Ios, + /// Specify that this is an andriod push notfication + /// + /// In this case the token must firebase cloud messaging token + Android, +} + +impl BcCamera { + /// Convenience method for andriod of `[send_pushinfo]` + pub async fn send_pushinfo_android(&self, token: &str, client_id: &str) -> Result<()> { + self.send_pushinfo(token, client_id, PhoneType::Android) + .await + } + /// Convenience method for andriod of `[send_pushinfo]` + pub async fn send_pushinfo_ios(&self, token: &str, client_id: &str) -> Result<()> { + self.send_pushinfo(token, client_id, PhoneType::Ios).await + } + /// Send the push info to regsiter for push notfications + pub async fn send_pushinfo( + &self, + token: &str, + client_id: &str, + phone_type: PhoneType, + ) -> Result<()> { + let connection = self.get_connection(); + let msg_num = self.new_message_num(); + let mut sub = connection.subscribe(msg_num).await?; + + let phone_type_str = match phone_type { + PhoneType::Ios => "reo_iphone", + PhoneType::Android => "reo_fcm", + }; + + let msg = Bc { + meta: BcMeta { + msg_id: MSG_ID_PUSH_INFO, + channel_id: self.channel_id, + msg_num, + response_code: 0, + stream_type: 0, + class: 0x6414, + }, + body: BcBody::ModernMsg(ModernMsg { + extension: None, + payload: Some(BcPayloads::BcXml(BcXml { + push_info: Some(PushInfo { + token: token.to_owned(), + phone_type: phone_type_str.to_owned(), + client_id: client_id.to_owned(), + }), + ..Default::default() + })), + }), + }; + + sub.send(msg).await?; + let msg = sub.recv().await?; + if msg.meta.response_code != 200 { + return Err(Error::CameraServiceUnavaliable); + } + + Ok(()) + } +} diff --git a/crates/pushnoti/Cargo.toml b/crates/pushnoti/Cargo.toml new file mode 100644 index 0000000..10f19d6 --- /dev/null +++ b/crates/pushnoti/Cargo.toml @@ -0,0 +1,21 @@ +[package] +name = "pushnoti" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +anyhow = "1.0.71" +clap = { version = "4.2.2", features = ["derive", "cargo"] } +env_logger = "0.10.0" +fcm-push-listener = "2.0.1" +lazy_static = "1.4.0" +log = { version = "0.4.17", features = [ "release_max_level_debug" ] } +neolink_core = { path = "../core", version = "0.5" } +regex = "1.8.1" +serde = "1.0.163" +tokio = { version = "1.28.1", features = ["full"] } +toml = "0.7.3" +validator = "0.16.0" +validator_derive = "0.16.0" diff --git a/crates/pushnoti/README.md b/crates/pushnoti/README.md new file mode 100644 index 0000000..0901e32 --- /dev/null +++ b/crates/pushnoti/README.md @@ -0,0 +1,273 @@ +# Reolink Push Notifications + +This is the test crate to experiment with RE-ing the push notifications for a +camera + +The goal here is to connect to Google's firebase cloud messaging system (FCM) +and recieve push notificaions for motion updates. This way we can get motion +notifications without being logged in to the camera and this will let us +disconnect from battery cameras and save power. + +The following is the reolink data for google extracted from ios. + +```xml + + + + + AD_UNIT_ID_FOR_BANNER_TEST + ca-app-pub-3940256099942544/2934735716 + AD_UNIT_ID_FOR_INTERSTITIAL_TEST + ca-app-pub-3940256099942544/4411468910 + API_KEY + AIzaSyAV5l5DbbAkYB5X61wgn81Lb2f7s1h-ANE + BUNDLE_ID + com.reo.link + CLIENT_ID + 696841269229-mfqfluqdkb0s2raassbsul48h09l2eiv.apps.googleusercontent.com + DATABASE_URL + https://reolink-for-ios.firebaseio.com + GCM_SENDER_ID + 696841269229 + GOOGLE_APP_ID + 1:696841269229:ios:690529b18debb2e3 + IS_ADS_ENABLED + + IS_ANALYTICS_ENABLED + + IS_APPINVITE_ENABLED + + IS_GCM_ENABLED + + IS_SIGNIN_ENABLED + + PLIST_VERSION + 1 + PROJECT_ID + reolink-for-ios + REVERSED_CLIENT_ID + com.googleusercontent.apps.696841269229-mfqfluqdkb0s2raassbsul48h09l2eiv + STORAGE_BUCKET + reolink-for-ios.appspot.com + + +``` + +Key information from this is + +```xml +GCM_SENDER_ID +696841269229 +``` + +Which we use to register for FCM + +--- + +p.s. maybe some one can do something fun with the API +key not sure what thats doing there since anyone can +extract that. + +```xml +API_KEY +AIzaSyAV5l5DbbAkYB5X61wgn81Lb2f7s1h-ANE +``` + +--- + +On android the details are little harder for me to extract (ios here). By +extracting the apk with apktook I found the following: + +```xml +743639030586 +AIzaSyBEUIuWHnnOEwFahxWgQB4Yt4NsgOmkPyE +1:743639030586:android:86f60a4fb7143876 +743639030586-ove5uqrausoqtjjkev4b1tk4vjdfpt4l.apps.googleusercontent.com +``` + +Where the key we need is `743639030586` + +To emulate the push recievier we use the `fcm-push-listener` crate. Which +is a rust implementation of the good +[RE work of Matthieu Lemoine.](https://medium.com/@MatthieuLemoine/my-journey-to-bring-web-push-support-to-node-and-electron-ce70eea1c0b0) +hats off to you. + +We also need to send the PushInfo command to the camera with the token we get +from FCM and some client ID. On IOS the token is the APNS number. + +The client ID is an all CAPS UID of hexadecimal of 33 chars. Not sure how +these are generated but they seem to be unique to the device, perhaps a MD5 of +something or some generated UID on app initial login. + +To experiment I did a data wipe on the reolink app and found it generates a new UID. +I also found out that if you do this while you have Push Notifications turned on +then you cannot turn them off anymore. To disable the push notifications you need +the UID which I just wiped.... Fortunatly I saved before I wiped it so I could restore. +p.d. If you every wipe your reolink data and need to stop the push notifications +you can try doing manually using the API listed at the end. + +This is the data of the `PushInfo` command that is sent to the camera: + +```xml + + + +TOKEN_FROM_FCM_OR_APNS +reo_iphone +SOMEID + + +``` + +For ios the phonetype is `reo_iphone` which I observed live but for android +no such luck. + +First I just tried `reo_android` but the camera replied with an error code. +Which at least told me that I can test other string quickly and see if it +returns the error code. + +Next thing to do was dumping the binaries from the apk and searching for a string +like `reo_` + +```bash +grep -Ria "reo_" . +./lib/armeabi-v7a/libavcodec.so:stereo_modeError splitting the input into NAL units. +./lib/arm64-v8a/libavcodec.so:stereo_modeError splitting the input into NAL units. +./smali_classes2/com/google/android/exoplayer2/extractor/mkv/MatroskaExtractor.smali:.field private static final ID_STEREO_MODE:I = 0x53b8 +./smali_classes2/com/google/android/exoplayer2/C.smali:.field public static final STEREO_MODE_LEFT_RIGHT:I = 0x2 +./smali_classes2/com/google/android/exoplayer2/C.smali:.field public static final STEREO_MODE_MONO:I = 0x0 +./smali_classes2/com/google/android/exoplayer2/C.smali:.field public static final STEREO_MODE_STEREO_MESH:I = 0x3 +./smali_classes2/com/google/android/exoplayer2/C.smali:.field public static final STEREO_MODE_TOP_BOTTOM:I = 0x1 +./smali_classes2/com/android/bc/util/DeviceIdUtil$UpdatePushClientIdRequest.smali: const-string v2, "reo_fcm" +./smali_classes2/com/android/bc/pushmanager/MyPushAdapterImpl.smali: const-string v0, "reo_fcm" +./smali/androidx/core/text/BidiFormatter.smali:.field private static final FLAG_STEREO_RESET:I = 0x2 +./smali/com/android/bc/component/BaseWebViewFragment.smali: const-string v2, "REO_LANGUAGE=" +``` + +The interesting one was `MyPushAdapterImpl.smali: const-string v0, "reo_fcm"` +which suggested that it is `reo_fcm` stuck that in and voilla +no error messages from the camera. + +Now to compile the test app with all this info +wait patiently for a motion event and... + +viola! + +Reolink was kinda enough to send this to my test app: + +```json +{ + "data": { + "SRVTIME": "2023-05-19T08:07:03.566Z", + "ALMNAME": "Motion Alert from Cam01", + "sound": "push.wav", + "CHNAME": "Cam0", + "messageType": "alarm", + "DEVNAME": "Cam01", + "pushVersion": "v1.1", + "UID": "REDACTED", + "ALMTYPE": "MD", + "ALMCHN": "1", + "alert": "Motion Alert from Cam01", + "title": "Camera Alert" + }, + "from": "743639030586", + "priority": "normal", + "notification": { "title": "Camera Alert", "body": "Motion Alert from Cam01" }, + "fcmMessageId": "REDACTED" +} +``` + +There's no push notifiation for motion stop event but I can wait for this message +then login and use normal motion detection to tell when it stops. + +Yay.... now to just add all this to actual neolink so we can save battery..... + +--- + +While experimenting with the ios app, in addition to observing all the +data send to the camera, I also looked at all https calls the app was making +(mitmproxy). This showed a set of APIs that could be useful. Including the api +for deleting a push notification. + +--- + +To disable a PUSH request the following is done: + +```bash +curl -v -X DELETE 'https://pushx.reolink.com/devices//notifications/listeners/' -H 'Cookie:' +``` + +Reply is: + +```json +{ + "status" : { + "detail" : "OK", + "code" : 0 + } +} +``` + +Nothing seems to be sent to the camera just this to the reolink api + +--- + +On ios application start reolink send this: + +```bash +curl -v -X GET 'https://pushx.reolink.com/listeners//devices' -H 'Accept-Encoding: gzip, deflate, br' -H 'Accept: */*' -H 'Accept-Language: en-GB,en;q=0.9' -H 'Cookie:' +``` + +Which resonds with this json which contains a list of all currently +enabled push notification camera UIDs for this client + +```json +{ + "status" : { + "detail" : "OK", + "code" : 0 + }, + "data" : [ + { + "uid" : "", + "secret" : "" + } + ] +} +``` + +--- + +You can also confirm a device has a listener with + +```bash +curl -v -X GET 'https://pushx.reolink.com/devices//listeners//config' -H 'Cookie:' +``` + +Which returns + +```json +{ + "status": { + "code":0, + "detail":"OK" + }, + "data": { + "sound": { + "soundType":0, + "soundName":"", + "soundVolume":0 + } + } +} +``` + +--- + +There's also a profile one that the app does when a new camera is added +but I forgot to save the details of it. + +It reports all the capabilities of the camera, such as it's model +and its resolution etc. Could be useful to test if a UID is valid +quickly diff --git a/crates/pushnoti/src/config.rs b/crates/pushnoti/src/config.rs new file mode 100644 index 0000000..ce9085f --- /dev/null +++ b/crates/pushnoti/src/config.rs @@ -0,0 +1,80 @@ +use lazy_static::lazy_static; +use neolink_core::bc_protocol::{DiscoveryMethods, PrintFormat}; +use regex::Regex; +use serde::Deserialize; +use std::clone::Clone; +use validator::{Validate, ValidationError}; +use validator_derive::Validate; + +lazy_static! { + static ref RE_STREAM_SRC: Regex = + Regex::new(r"^(mainStream|subStream|externStream|both|all)$").unwrap(); + static ref RE_TLS_CLIENT_AUTH: Regex = Regex::new(r"^(none|request|require)$").unwrap(); + static ref RE_PAUSE_MODE: Regex = Regex::new(r"^(black|still|test|none)$").unwrap(); + static ref RE_MAXENC_SRC: Regex = + Regex::new(r"^([nN]one|[Aa][Ee][Ss]|[Bb][Cc][Ee][Nn][Cc][Rr][Yy][Pp][Tt])$").unwrap(); +} + +#[derive(Debug, Deserialize, Validate, Clone)] +pub(crate) struct Config { + #[validate] + pub(crate) cameras: Vec, +} + +#[derive(Debug, Deserialize, Validate, Clone)] +#[validate(schema(function = "validate_camera_config"))] +pub(crate) struct CameraConfig { + pub(crate) name: String, + + #[serde(rename = "address")] + pub(crate) camera_addr: Option, + + #[serde(rename = "uid")] + pub(crate) camera_uid: Option, + + pub(crate) username: String, + pub(crate) password: Option, + + #[validate(range(min = 0, max = 31, message = "Invalid channel", code = "channel_id"))] + #[serde(default = "default_channel_id")] + pub(crate) channel_id: u8, + + #[serde(default = "default_discovery")] + pub(crate) discovery: DiscoveryMethods, + + #[serde(default = "default_maxenc")] + #[validate(regex( + path = "RE_MAXENC_SRC", + message = "Invalid maximum encryption method", + code = "max_encryption" + ))] + pub(crate) max_encryption: String, + + #[serde(default = "default_print", alias = "print")] + pub(crate) print_format: PrintFormat, +} + +fn default_print() -> PrintFormat { + PrintFormat::None +} + +fn default_discovery() -> DiscoveryMethods { + DiscoveryMethods::Relay +} + +fn default_maxenc() -> String { + "Aes".to_string() +} + +fn default_channel_id() -> u8 { + 0 +} + +fn validate_camera_config(camera_config: &CameraConfig) -> Result<(), ValidationError> { + match (&camera_config.camera_addr, &camera_config.camera_uid) { + (None, None) => Err(ValidationError::new( + "Either camera address or uid must be given", + )), + _ => Ok(()), + } +} diff --git a/crates/pushnoti/src/main.rs b/crates/pushnoti/src/main.rs new file mode 100644 index 0000000..d9e5bfd --- /dev/null +++ b/crates/pushnoti/src/main.rs @@ -0,0 +1,82 @@ +use anyhow::{Context, Result}; +use clap::Parser; +use fcm_push_listener::*; +use log::*; +use std::{fs, path::PathBuf}; +use validator::Validate; + +mod config; +mod opt; +mod utils; + +use config::Config; +use opt::Opt; +use utils::find_and_connect; + +#[tokio::main] +async fn main() -> Result<()> { + env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); + + let opt = Opt::parse(); + + let conf_path = opt.config.context("Must supply --config file")?; + let config: Config = toml::from_str( + &fs::read_to_string(&conf_path) + .with_context(|| format!("Failed to read {:?}", conf_path))?, + ) + .with_context(|| format!("Failed to parse the {:?} config file", conf_path))?; + + config + .validate() + .with_context(|| format!("Failed to validate the {:?} config file", conf_path))?; + + let camera = find_and_connect(&config, &opt.camera).await?; + + // 696841269229 is the reo_iphone FCM Sender_ID + // let registration = fcm_push_listener::register("696841269229").await?; + // 743639030586 is the reo_fcm FCM Sender_ID + // 263684512460 is my test Sender_ID + // let registration = fcm_push_listener::register("743639030586").await? + // I have confirmed that I can recieve test messages with this SenderID + // into this program + // let registration = fcm_push_listener::register("263684512460").await?; + + let sender_id = "743639030586"; // andriod + + // let sender_id = "696841269229"; // ios + + // let sender_id = "263684512460"; // test + + let token_path = PathBuf::from("./token.toml"); + let registration = if let Ok(Ok(registration)) = + fs::read_to_string(&token_path).map(|v| toml::from_str::(&v)) + { + info!("Loaded token"); + registration + } else { + info!("Registering new token"); + let registration = fcm_push_listener::register(sender_id).await?; + let new_token = toml::to_string(®istration)?; + fs::write(token_path, new_token)?; + registration + }; + + // Send registration.fcm_token to the server to allow it to send push messages to you. + info!("registration.fcm_token: {}", registration.fcm_token); + let uid = "6A5443E486511B0D828543445DC55A7D"; // MD5 Hash of "WHY_REOLINK" + camera + .send_pushinfo_android(®istration.fcm_token, uid) + .await?; + + info!("Listening"); + let mut listener = FcmPushListener::create( + registration, + |message: FcmMessage| { + info!("Message JSON: {}", message.payload_json); + info!("Persistent ID: {:?}", message.persistent_id); + }, + vec![], + ); + listener.connect().await?; + Ok(()) +} diff --git a/crates/pushnoti/src/opt.rs b/crates/pushnoti/src/opt.rs new file mode 100644 index 0000000..73b9c94 --- /dev/null +++ b/crates/pushnoti/src/opt.rs @@ -0,0 +1,16 @@ +use clap::{crate_authors, crate_version, Parser}; +use std::path::PathBuf; +use std::str::FromStr; + +/// A standards-compliant bridge to Reolink IP cameras +/// +/// Neolink is free software released under the GNU AGPL v3. +/// You can find its source code at https://github.com/thirtythreeforty/neolink +#[derive(Parser, Debug)] +#[command(name = "pushnoti", arg_required_else_help = true, version = crate_version!(), author = crate_authors!("\n"))] +pub struct Opt { + #[arg(short, long, value_parser = PathBuf::from_str)] + pub config: Option, + /// The name of the camera. Must be a name in the config + pub camera: String, +} diff --git a/crates/pushnoti/src/utils.rs b/crates/pushnoti/src/utils.rs new file mode 100644 index 0000000..7ff6c05 --- /dev/null +++ b/crates/pushnoti/src/utils.rs @@ -0,0 +1,152 @@ +//! Contains code that is not specific to any of the subcommands +//! +use log::*; + +use super::config::{CameraConfig, Config}; +use anyhow::{anyhow, Context, Error, Result}; +use neolink_core::bc_protocol::{ + BcCamera, BcCameraOpt, ConnectionProtocol, Credentials, DiscoveryMethods, MaxEncryption, +}; +use std::{ + fmt::{Display, Error as FmtError, Formatter}, + net::{IpAddr, ToSocketAddrs}, + str::FromStr, +}; + +pub(crate) enum AddressOrUid { + Address(String), + Uid(String, DiscoveryMethods), + AddressWithUid(String, String, DiscoveryMethods), +} + +impl Display for AddressOrUid { + fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> { + match self { + AddressOrUid::AddressWithUid(addr, uid, _) => { + write!(f, "Address: {}, UID: {}", addr, uid) + } + AddressOrUid::Address(host) => write!(f, "Address: {}", host), + AddressOrUid::Uid(host, _) => write!(f, "UID: {}", host), + } + } +} + +impl AddressOrUid { + // Created by translating the config fields directly + pub(crate) fn new( + address: &Option, + uid: &Option, + method: &DiscoveryMethods, + ) -> Result { + match (address, uid) { + (None, None) => Err(anyhow!("Neither address or uid given")), + (Some(host), Some(uid)) => Ok(AddressOrUid::AddressWithUid( + host.clone(), + uid.clone(), + *method, + )), + (Some(host), None) => Ok(AddressOrUid::Address(host.clone())), + (None, Some(host)) => Ok(AddressOrUid::Uid(host.clone(), *method)), + } + } + + // Convience method to get the BcCamera with the appropiate method + // from a camera_config + pub(crate) async fn connect_camera( + &self, + camera_config: &CameraConfig, + ) -> Result { + let (port, addrs) = { + if let Some(addr_str) = camera_config.camera_addr.as_ref() { + match addr_str.to_socket_addrs() { + Ok(addr_iter) => { + let mut port = None; + let mut ipaddrs = vec![]; + for addr in addr_iter { + port = Some(addr.port()); + ipaddrs.push(addr.ip()); + } + Ok((port, ipaddrs)) + } + Err(_) => match IpAddr::from_str(addr_str) { + Ok(ip) => Ok((None, vec![ip])), + Err(_) => Err(anyhow!("Could not parse address in config")), + }, + } + } else { + Ok((None, vec![])) + } + }?; + + let options = BcCameraOpt { + name: camera_config.name.clone(), + channel_id: camera_config.channel_id, + addrs, + port, + uid: camera_config.camera_uid.clone(), + protocol: ConnectionProtocol::TcpUdp, + discovery: camera_config.discovery, + aux_printing: camera_config.print_format, + credentials: Credentials { + username: camera_config.username.clone(), + password: camera_config.password.clone(), + }, + }; + + trace!("Camera Info: {:?}", options); + + Ok(BcCamera::new(&options).await?) + } +} + +pub(crate) async fn find_and_connect(config: &Config, name: &str) -> Result { + let camera_config = find_camera_by_name(config, name)?; + connect_and_login(camera_config).await +} + +pub(crate) async fn connect_and_login(camera_config: &CameraConfig) -> Result { + let camera_addr = AddressOrUid::new( + &camera_config.camera_addr, + &camera_config.camera_uid, + &camera_config.discovery, + ) + .unwrap(); + info!( + "{}: Connecting to camera at {}", + camera_config.name, camera_addr + ); + + let camera = camera_addr + .connect_camera(camera_config) + .await + .with_context(|| { + format!( + "Failed to connect to camera {} at {} on channel {}", + camera_config.name, camera_addr, camera_config.channel_id + ) + })?; + + let max_encryption = match camera_config.max_encryption.to_lowercase().as_str() { + "none" => MaxEncryption::None, + "bcencrypt" => MaxEncryption::BcEncrypt, + "aes" => MaxEncryption::Aes, + _ => MaxEncryption::Aes, + }; + info!("{}: Logging in", camera_config.name); + camera + .login_with_maxenc(max_encryption) + .await + .with_context(|| format!("Failed to login to {}", camera_config.name))?; + + info!("{}: Connected and logged in", camera_config.name); + + Ok(camera) +} + +pub(crate) fn find_camera_by_name<'a>(config: &'a Config, name: &str) -> Result<&'a CameraConfig> { + config + .cameras + .iter() + .find(|c| c.name == name) + .ok_or_else(|| anyhow!("Camera {} not found in the config file", name)) +} diff --git a/dissector/messages.md b/dissector/messages.md index f3004f4..1789c25 100644 --- a/dissector/messages.md +++ b/dissector/messages.md @@ -1705,6 +1705,64 @@ Message have zero to two payloads. ``` +- 109: `` + + - Client: + Usual header + + - Meta: + + ```xml + + + 0 + + ``` + + - Main: + + ```xml + + + + 0 + 0 + + 0 + main + + + ``` + + - Camera: + + **Notes:** XML & Binary reply over mutliple packets: + - Reply 1: + - Main: + ```xml + + + + 0 + 01_20230518140240.jpg + + 23644 + + + ``` + + - Reply 2: + - Meta: + ```xml + + + 1 + + ``` + - Main: + **Binary data containing the file may be broken over multiple packets** + + - 115: `` - Client @@ -1734,6 +1792,35 @@ Message have zero to two payloads. ``` +- 116: `` + + - Client: + Usual header + + - Camera: + Payload: + ```xml + + + + station + wpa2psk + aes + + + WIFINAME + NUMBER + ONE_OR_ZERO + + # Repeats for ALL wifi in range + + YOUR_CURRENT_WIFI + YOUR_CURRENT_WIFI_PASSWORD_UNENCRYPTED + YOUR_CURRENT_WIFI_CHANNEL + + + ``` + - 132: `` - Client @@ -1846,6 +1933,37 @@ Message have zero to two payloads. ``` +- 124: `` + + - Client + - Payload: + + ```xml + + + + A_PUSH_NOTIFICATION_TOKEN + reo_iphone + A_PUSH_NOTIFICATION_CLIENTID + + + ``` + + - Camera + - Payload + + ```xml + + + + -1 + CAMERA_UID + A_4_CHAR_STRING + + + ``` + + - 133: `` - Client @@ -2386,6 +2504,154 @@ Message have zero to two payloads. |--------------|--------------|----------------|-------------------|-------------------|---------------|---------------| | 0a bc de f0 | 00 00 00 d1 | 00 00 00 00 | 85 00 00 00 | c8 00 | 00 00 | 00 00 00 00 | +- 219: `` + - Client + Usual header + + - Meta: + ```xml + + + 0 + + ``` + - Camera + Usual header + + - Payload: + ```xml + + + + 0 + 1 + + + MD + + + 1 + Sunday + 0 + 23 + + + 1 + Monday + 0 + 23 + + + 1 + Tuesday + 0 + 23 + + + 1 + Wednesday + 0 + 23 + + + 1 + Thursday + 0 + 23 + + + 1 + Friday + 0 + 23 + + + 1 + Saturday + 0 + 23 + + + + + + + ``` + + +- 232: `` + - Client + Usual header + + - Meta: + ```xml + + + 0 + + ``` + - Camera + Usual header + + - Payload: + ```xml + + + + 0 + 0 + + + MD + + + 1 + Sunday + 0 + 23 + + + 1 + Monday + 0 + 23 + + + 1 + Tuesday + 0 + 23 + + + 1 + Wednesday + 0 + 23 + + + 1 + Thursday + 0 + 23 + + + 1 + Friday + 0 + 23 + + + 1 + Saturday + 0 + 23 + + + + + + + ``` - 264: `` (write) @@ -2421,6 +2687,55 @@ Message have zero to two payloads. ``` +- 268: `CloudBindInfo` + - Client: + Usual header only packet + + - Camera + + - Payload + + ```xml + + + + 1 + + + ``` + +- 282: `CloudLoginKey` + + - Client: + Usual header only packet + + - Camera + - Payload + + ```xml + + + 0 + + + ``` + +- 287: `` + - Client: + - Payload + + ```xml + + + + 1684393362 + + + ``` + + - Camera + Header only 200 Ok reply + - 288: `` (write) - Client