From 9b18b787a95da38e0e0483ef70642c9792cf4c8f Mon Sep 17 00:00:00 2001 From: Pierre Hubert Date: Thu, 27 Apr 2023 10:10:28 +0000 Subject: [PATCH] Add authentication from upstream providers (#107) Let BasicOIDC delegate authentication to upstream providers (Google, GitHub, GitLab, Keycloak...) Reviewed-on: https://gitea.communiquons.org/pierre/BasicOIDC/pulls/107 --- Cargo.lock | 333 ++++++++++++++++-- Cargo.toml | 3 +- README.md | 21 +- assets/img/brands/gitea.svg | 12 + assets/img/brands/github.svg | 1 + assets/img/brands/gitlab.svg | 1 + assets/img/brands/google.svg | 1 + assets/img/brands/microsoft.svg | 1 + src/actors/mod.rs | 1 + src/actors/providers_states_actor.rs | 130 +++++++ src/actors/users_actor.rs | 86 ++++- src/constants.rs | 15 + src/controllers/admin_controller.rs | 69 +++- src/controllers/login_controller.rs | 27 +- src/controllers/mod.rs | 1 + src/controllers/openid_controller.rs | 37 +- src/controllers/providers_controller.rs | 373 +++++++++++++++++++++ src/controllers/settings_controller.rs | 24 +- src/controllers/two_factors_controller.rs | 10 +- src/data/action_logger.rs | 100 +++++- src/data/app_config.rs | 20 +- src/data/jwt_signer.rs | 7 +- src/data/mod.rs | 4 +- src/data/open_id_user_info.rs | 23 -- src/data/openid_config.rs | 37 -- src/data/openid_primitive.rs | 107 ++++++ src/data/provider.rs | 89 +++++ src/data/provider_configuration.rs | 135 ++++++++ src/data/totp_key.rs | 8 +- src/data/user.rs | 29 ++ src/data/users_file_entity.rs | 23 +- src/main.rs | 27 +- templates/login/base_login_page.html | 4 +- templates/login/login.html | 32 ++ templates/login/prov_login_error.html | 13 + templates/settings/account_details.html | 12 +- templates/settings/base_settings_page.html | 16 +- templates/settings/edit_user.html | 58 +++- templates/settings/providers_list.html | 39 +++ 39 files changed, 1740 insertions(+), 189 deletions(-) create mode 100644 assets/img/brands/gitea.svg create mode 100644 assets/img/brands/github.svg create mode 100644 assets/img/brands/gitlab.svg create mode 100644 assets/img/brands/google.svg create mode 100644 assets/img/brands/microsoft.svg create mode 100644 src/actors/providers_states_actor.rs create mode 100644 src/controllers/providers_controller.rs delete mode 100644 src/data/openid_config.rs create mode 100644 src/data/openid_primitive.rs create mode 100644 src/data/provider.rs create mode 100644 src/data/provider_configuration.rs create mode 100644 templates/login/prov_login_error.html create mode 100644 templates/settings/providers_list.html diff --git a/Cargo.lock b/Cargo.lock index 28168a5..873c0f6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -317,9 +317,9 @@ dependencies = [ [[package]] name = "aho-corasick" -version = "0.7.20" +version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cc936419f96fa211c1b9166887b38e5e40b19958e5b895be7c1f93adec7071ac" +checksum = "67fc08ce920c31afb70f013dcce1bfc3a3195de6a228474e45e1f145b36f8d04" dependencies = [ "memchr", ] @@ -568,6 +568,7 @@ dependencies = [ "mime_guess", "qrcode-generator", "rand", + "reqwest", "serde", "serde_json", "serde_yaml", @@ -664,9 +665,9 @@ dependencies = [ [[package]] name = "bumpalo" -version = "3.12.0" +version = "3.12.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d261e256854913907f67ed06efbc3338dfe6179796deefc1ff763fc1aee5535" +checksum = "9b1ce199063694f33ffb7dd4e0ee620741495c32833cde5aa08f02a0bf96f0c8" [[package]] name = "bytemuck" @@ -737,9 +738,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.2.2" +version = "4.2.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9b802d85aaf3a1cdb02b224ba472ebdea62014fccfcb269b95a4d76443b5ee5a" +checksum = "956ac1f6381d8d82ab4684768f89c0ea3afe66925ceadb4eeb3fc452ffc55d62" dependencies = [ "clap_builder", "clap_derive", @@ -748,9 +749,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.2.2" +version = "4.2.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "14a1a858f532119338887a4b8e1af9c60de8249cd7bafd68036a489e261e37b6" +checksum = "84080e799e54cff944f4b4a4b0e71630b0e0443b25b985175c7dddc1a859b749" dependencies = [ "anstream", "anstyle", @@ -858,6 +859,16 @@ dependencies = [ "version_check", ] +[[package]] +name = "core-foundation" +version = "0.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "194a7a9e6de53fa55116934067c844d9d749312f75c6f6d0980e8c252f8c2146" +dependencies = [ + "core-foundation-sys", + "libc", +] + [[package]] name = "core-foundation-sys" version = "0.8.4" @@ -866,9 +877,9 @@ checksum = "e496a50fda8aacccc86d7529e2c1e0892dbd0f898a6b5645b5561b89c3210efa" [[package]] name = "cpufeatures" -version = "0.2.6" +version = "0.2.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "280a9f2d8b3a38871a3c8a46fb80db65e5e5ed97da80c4d08bf27fb63e35e181" +checksum = "3e4c1eaa2012c47becbbad2ab175484c2a84d1185b566fb2cc5b8707343dfe58" dependencies = [ "libc", ] @@ -1137,6 +1148,15 @@ dependencies = [ "libc", ] +[[package]] +name = "fastrand" +version = "1.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e51093e27b0797c359783294ca4f0a911c270184cb10f85783b118614a1501be" +dependencies = [ + "instant", +] + [[package]] name = "fdeflate" version = "0.3.0" @@ -1196,6 +1216,15 @@ dependencies = [ "percent-encoding", ] +[[package]] +name = "futures-channel" +version = "0.3.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "955518d47e09b25bbebc7a18df10b81f0c766eaf4c4f1cccef2fca5f2a4fb5f2" +dependencies = [ + "futures-core", +] + [[package]] name = "futures-core" version = "0.3.28" @@ -1283,9 +1312,9 @@ dependencies = [ [[package]] name = "h2" -version = "0.3.17" +version = "0.3.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "66b91535aa35fea1523ad1b86cb6b53c28e0ae566ba4a460f4457e936cad7c6f" +checksum = "17f8a914c2987b688368b5138aa05321db91f4090cf26118185672ad588bce21" dependencies = [ "bytes", "fnv", @@ -1401,6 +1430,17 @@ dependencies = [ "itoa", ] +[[package]] +name = "http-body" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5f38f16d184e36f2408a55281cd658ecbd3ca05cce6d6510a176eca393e26d1" +dependencies = [ + "bytes", + "http", + "pin-project-lite", +] + [[package]] name = "httparse" version = "1.8.0" @@ -1428,6 +1468,43 @@ version = "2.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4" +[[package]] +name = "hyper" +version = "0.14.26" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ab302d72a6f11a3b910431ff93aae7e773078c769f0a3ef15fb9ec692ed147d4" +dependencies = [ + "bytes", + "futures-channel", + "futures-core", + "futures-util", + "h2", + "http", + "http-body", + "httparse", + "httpdate", + "itoa", + "pin-project-lite", + "socket2", + "tokio", + "tower-service", + "tracing", + "want", +] + +[[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" @@ -1514,6 +1591,15 @@ dependencies = [ "generic-array", ] +[[package]] +name = "instant" +version = "0.1.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7a5bbe824c507c5da5956355e86a746d82e0e1464f65d862cc5e71da70e94b2c" +dependencies = [ + "cfg-if", +] + [[package]] name = "io-lifetimes" version = "1.0.10" @@ -1525,6 +1611,12 @@ dependencies = [ "windows-sys 0.48.0", ] +[[package]] +name = "ipnet" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "12b6ee2129af8d4fb011108c73d99a1b83a85977f23b82460c0ae2e25bb4b57f" + [[package]] name = "is-terminal" version = "0.4.7" @@ -1641,9 +1733,9 @@ dependencies = [ [[package]] name = "libc" -version = "0.2.141" +version = "0.2.142" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3304a64d199bb964be99741b7a14d26972741915b3649639149b2479bb46f4b5" +checksum = "6a987beff54b60ffa6d51982e1aa1146bc42f19bd26be28b0586f252fccf5317" [[package]] name = "libm" @@ -1662,9 +1754,9 @@ dependencies = [ [[package]] name = "linux-raw-sys" -version = "0.3.1" +version = "0.3.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d59d8c75012853d2e872fb56bc8a2e53718e2cafe1a4c823143141c6d90c322f" +checksum = "36eb31c1778188ae1e64398743890d0877fef36d11521ac60406b42016e8c2cf" [[package]] name = "local-channel" @@ -1762,6 +1854,24 @@ dependencies = [ "windows-sys 0.45.0", ] +[[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 = "nom" version = "7.1.3" @@ -1875,9 +1985,9 @@ checksum = "624a8340c38c1b80fd549087862da4ba43e08858af025b236e509b6649fc13d5" [[package]] name = "openssl" -version = "0.10.50" +version = "0.10.51" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e30d8bc91859781f0a943411186324d580f2bbeb71b452fe91ae344806af3f1" +checksum = "97ea2d98598bf9ada7ea6ee8a30fb74f9156b63bbe495d64ec2b87c269d2dda3" dependencies = [ "bitflags", "cfg-if", @@ -1900,10 +2010,16 @@ dependencies = [ ] [[package]] -name = "openssl-sys" -version = "0.9.85" +name = "openssl-probe" +version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d3d193fb1488ad46ffe3aaabc912cc931d02ee8518fe2959aea8ef52718b0c0" +checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" + +[[package]] +name = "openssl-sys" +version = "0.9.86" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "992bac49bdbab4423199c654a5515bd2a6c6a23bf03f2dd3bdb7e5ae6259bc69" dependencies = [ "cc", "libc", @@ -1953,7 +2069,7 @@ checksum = "9069cbb9f99e3a5083476ccb29ceb1de18b9118cafa53e90c9551235de2b9521" dependencies = [ "cfg-if", "libc", - "redox_syscall", + "redox_syscall 0.2.16", "smallvec", "windows-sys 0.45.0", ] @@ -2134,10 +2250,19 @@ dependencies = [ ] [[package]] -name = "regex" -version = "1.7.3" +name = "redox_syscall" +version = "0.3.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8b1f693b24f6ac912f4893ef08244d70b6067480d2f1a46e950c9691e6749d1d" +checksum = "567664f262709473930a4bf9e51bf2ebf3348f2e748ccc50dea20646858f8f29" +dependencies = [ + "bitflags", +] + +[[package]] +name = "regex" +version = "1.8.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af83e617f331cc6ae2da5443c602dfa5af81e517212d9d611a5b3ba1777b5370" dependencies = [ "aho-corasick", "memchr", @@ -2146,9 +2271,46 @@ dependencies = [ [[package]] name = "regex-syntax" -version = "0.6.29" +version = "0.7.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1" +checksum = "a5996294f19bd3aae0453a862ad728f60e6600695733dd5df01da90c54363a3c" + +[[package]] +name = "reqwest" +version = "0.11.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "27b71749df584b7f4cac2c426c127a7c785a5106cc98f7a8feb044115f0fa254" +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 = "rfc6979" @@ -2217,9 +2379,9 @@ dependencies = [ [[package]] name = "rustix" -version = "0.37.11" +version = "0.37.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "85597d61f83914ddeba6a47b3b8ffe7365107221c2e557ed94426489fefb5f77" +checksum = "d9b864d3c18a5785a05953adeed93e2dca37ed30f18e69bba9f30079d51f363f" dependencies = [ "bitflags", "errno", @@ -2235,6 +2397,15 @@ version = "1.0.13" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f91339c0467de62360649f8d3e185ca8de4224ff281f66000de5eb2a77a79041" +[[package]] +name = "schannel" +version = "0.1.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "713cfb06c7059f3588fb8044c0fad1d09e3c01d225e25b9220dbfdcf16dbb1b3" +dependencies = [ + "windows-sys 0.42.0", +] + [[package]] name = "scopeguard" version = "1.1.0" @@ -2261,6 +2432,29 @@ dependencies = [ "zeroize", ] +[[package]] +name = "security-framework" +version = "2.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a332be01508d814fed64bf28f798a146d73792121129962fdf335bb3c49a4254" +dependencies = [ + "bitflags", + "core-foundation", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework-sys" +version = "2.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "31c9bb296072e961fcbd8853511dd39c2d8be2deb1e17c6860b1d30732b323b4" +dependencies = [ + "core-foundation-sys", + "libc", +] + [[package]] name = "semver" version = "1.0.17" @@ -2477,6 +2671,19 @@ dependencies = [ "unicode-xid", ] +[[package]] +name = "tempfile" +version = "3.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9fbec84f381d5795b08656e4912bec604d162bff9291d6189a78f4c8ab87998" +dependencies = [ + "cfg-if", + "fastrand", + "redox_syscall 0.3.5", + "rustix", + "windows-sys 0.45.0", +] + [[package]] name = "termcolor" version = "1.2.0" @@ -2576,6 +2783,16 @@ dependencies = [ "windows-sys 0.45.0", ] +[[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-util" version = "0.7.7" @@ -2599,6 +2816,12 @@ dependencies = [ "ring", ] +[[package]] +name = "tower-service" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52" + [[package]] name = "tracing" version = "0.1.37" @@ -2632,6 +2855,12 @@ dependencies = [ "once_cell", ] +[[package]] +name = "try-lock" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3528ecfd12c466c6f163363caf2d02a71161dd5e1cc6ae7b34207ea2d42d81ed" + [[package]] name = "typenum" version = "1.16.0" @@ -2754,6 +2983,16 @@ version = "0.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f" +[[package]] +name = "want" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ce8a968cb1cd110d136ff8b819a556d6fb6d919363c61534f6860c7eb172ba0" +dependencies = [ + "log", + "try-lock", +] + [[package]] name = "wasi" version = "0.10.0+wasi-snapshot-preview1" @@ -2791,6 +3030,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.84" @@ -2920,6 +3171,21 @@ dependencies = [ "windows-targets 0.48.0", ] +[[package]] +name = "windows-sys" +version = "0.42.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a3e1820f08b8513f676f7ab6c1f99ff312fb97b553d30ff4dd86f9f15728aa7" +dependencies = [ + "windows_aarch64_gnullvm 0.42.2", + "windows_aarch64_msvc 0.42.2", + "windows_i686_gnu 0.42.2", + "windows_i686_msvc 0.42.2", + "windows_x86_64_gnu 0.42.2", + "windows_x86_64_gnullvm 0.42.2", + "windows_x86_64_msvc 0.42.2", +] + [[package]] name = "windows-sys" version = "0.45.0" @@ -3052,6 +3318,15 @@ version = "0.48.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a" +[[package]] +name = "winreg" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "80d0f4e272c85def139476380b12f9ac60926689dd2e01d4923222f40580869d" +dependencies = [ + "winapi", +] + [[package]] name = "x509-parser" version = "0.13.2" diff --git a/Cargo.toml b/Cargo.toml index 7c2c332..8536c90 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -37,4 +37,5 @@ url = "2.3.1" aes-gcm = { version = "0.10.1", features = ["aes"] } bincode = "1.3.3" chrono = "0.4.24" -lazy_static = "1.4.0" \ No newline at end of file +lazy_static = "1.4.0" +reqwest = { version = "0.11.16", features = ["json"] } \ No newline at end of file diff --git a/README.md b/README.md index 48a1ab6..8f52e20 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,12 @@ Basic & lightweight OpenID provider, written in Rust using the Actix framework. **WARNING :** This tool has not been audited, use it at your own risks! -BasicOIDC operates without any database, just with two files : +BasicOIDC operates without any database, just with three files : * `clients.yaml`: a list of authorized relying parties. +* `providers.yaml`: a list of upstream providers for authentication federation (this file is optional) * `users.json`: a list of users, managed through a web UI. +## Configuration You can configure a list of clients (Relying Parties) in a `clients.yaml` file with the following syntax : ```yaml - id: gitea @@ -26,7 +28,7 @@ On the first run, BasicOIDC will create a new administrator with credentials `ad In order to run BasicOIDC for development, you will need to create a least an empty `clients.yaml` file inside the storage directory. -Features : +## Features * [x] `authorization_code` flow * [x] Client authentication using secrets * [x] Bruteforce protection @@ -35,6 +37,21 @@ Features : * [x] Using a security key (Webauthn) * [ ] Fully responsive webui * [x] `robots.txt` prevents indexing +* [x] Support authentication from upstream provider + +## Add an upstream provider +You can add as much upstream provider as you want, using the following syntax in `providers.yaml`: +```yaml +- id: gitlab + name: GitLab + logo: gitlab # Can be either gitea, gitlab, github, microsoft, google or a full URL + client_id: CLIENT_ID_GIVEN_BY_PROVIDER + client_secret: CLIENT_SECRET_GIVEN_BY_PROVIDER + configuration_url: https://gitlab.com/.well-known/openid-configuration + +``` + +> Warning! Self-registration has not been implemented, therfore the accounts must have been previously created through the administration. ## Compiling You will need the Rust toolchain to compile this project. To build it for production, just run: diff --git a/assets/img/brands/gitea.svg b/assets/img/brands/gitea.svg new file mode 100644 index 0000000..b07d2ed --- /dev/null +++ b/assets/img/brands/gitea.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/assets/img/brands/github.svg b/assets/img/brands/github.svg new file mode 100644 index 0000000..d5e6491 --- /dev/null +++ b/assets/img/brands/github.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/img/brands/gitlab.svg b/assets/img/brands/gitlab.svg new file mode 100644 index 0000000..95a22f1 --- /dev/null +++ b/assets/img/brands/gitlab.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/img/brands/google.svg b/assets/img/brands/google.svg new file mode 100644 index 0000000..37bcbbc --- /dev/null +++ b/assets/img/brands/google.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/img/brands/microsoft.svg b/assets/img/brands/microsoft.svg new file mode 100644 index 0000000..13307b7 --- /dev/null +++ b/assets/img/brands/microsoft.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/actors/mod.rs b/src/actors/mod.rs index 4298570..fdfde90 100644 --- a/src/actors/mod.rs +++ b/src/actors/mod.rs @@ -1,3 +1,4 @@ pub mod bruteforce_actor; pub mod openid_sessions_actor; +pub mod providers_states_actor; pub mod users_actor; diff --git a/src/actors/providers_states_actor.rs b/src/actors/providers_states_actor.rs new file mode 100644 index 0000000..41cd642 --- /dev/null +++ b/src/actors/providers_states_actor.rs @@ -0,0 +1,130 @@ +//! # Providers state actor +//! +//! This actor stores the content of the states +//! during authentication with upstream providers + +use crate::constants::{ + MAX_OIDC_PROVIDERS_STATES, OIDC_PROVIDERS_STATE_DURATION, OIDC_PROVIDERS_STATE_LEN, + OIDC_STATES_CLEANUP_INTERVAL, +}; +use actix::{Actor, AsyncContext, Context, Handler, Message}; +use std::collections::hash_map::Entry; +use std::collections::HashMap; +use std::net::IpAddr; + +use crate::data::login_redirect::LoginRedirect; +use crate::data::provider::ProviderID; +use crate::utils::string_utils::rand_str; +use crate::utils::time::time; + +#[derive(Debug, Clone)] +pub struct ProviderLoginState { + pub provider_id: ProviderID, + pub state_id: String, + pub redirect: LoginRedirect, + pub expire: u64, +} + +impl ProviderLoginState { + pub fn new(prov_id: &ProviderID, redirect: LoginRedirect) -> Self { + Self { + provider_id: prov_id.clone(), + state_id: rand_str(OIDC_PROVIDERS_STATE_LEN), + redirect, + expire: time() + OIDC_PROVIDERS_STATE_DURATION, + } + } +} + +#[derive(Message)] +#[rtype(result = "()")] +pub struct RecordState { + pub ip: IpAddr, + pub state: ProviderLoginState, +} + +#[derive(Message)] +#[rtype(result = "Option")] +pub struct ConsumeState { + pub ip: IpAddr, + pub state_id: String, +} + +#[derive(Debug, Default)] +pub struct ProvidersStatesActor { + states: HashMap>, +} + +impl ProvidersStatesActor { + /// Clean outdated states + fn clean_old_states(&mut self) { + #[allow(clippy::map_clone)] + let keys = self.states.keys().map(|i| *i).collect::>(); + + for ip in keys { + // Remove old states + let states = self.states.get_mut(&ip).unwrap(); + states.retain(|i| i.expire < time()); + + // Remove empty entry keys + if states.is_empty() { + self.states.remove(&ip); + } + } + } + + /// Add a new provider login state + pub fn insert_state(&mut self, ip: IpAddr, state: ProviderLoginState) { + if let Entry::Vacant(e) = self.states.entry(ip) { + e.insert(vec![state]); + } else { + let states = self.states.get_mut(&ip).unwrap(); + + // We limit the number of states per IP address + if states.len() > MAX_OIDC_PROVIDERS_STATES { + states.remove(0); + } + + states.push(state); + } + } + + /// Get & consume a login state + pub fn consume_state(&mut self, ip: IpAddr, state_id: &str) -> Option { + let idx = self + .states + .get(&ip)? + .iter() + .position(|val| val.state_id.as_str() == state_id)?; + + Some(self.states.get_mut(&ip)?.remove(idx)) + } +} + +impl Actor for ProvidersStatesActor { + type Context = Context; + + fn started(&mut self, ctx: &mut Self::Context) { + // Clean up at a regular interval failed attempts + ctx.run_interval(OIDC_STATES_CLEANUP_INTERVAL, |act, _ctx| { + log::trace!("Cleaning up old states"); + act.clean_old_states(); + }); + } +} + +impl Handler for ProvidersStatesActor { + type Result = (); + + fn handle(&mut self, req: RecordState, _ctx: &mut Self::Context) -> Self::Result { + self.insert_state(req.ip, req.state); + } +} + +impl Handler for ProvidersStatesActor { + type Result = Option; + + fn handle(&mut self, req: ConsumeState, _ctx: &mut Self::Context) -> Self::Result { + self.consume_state(req.ip, &req.state_id) + } +} diff --git a/src/actors/users_actor.rs b/src/actors/users_actor.rs index 0ed4438..1257726 100644 --- a/src/actors/users_actor.rs +++ b/src/actors/users_actor.rs @@ -1,5 +1,6 @@ use std::net::IpAddr; +use crate::data::provider::{Provider, ProviderID}; use actix::{Actor, Context, Handler, Message, MessageResult}; use crate::data::user::{FactorID, GeneralSettings, GrantedClients, TwoFactor, User, UserID}; @@ -8,6 +9,7 @@ use crate::utils::err::Res; /// User storage interface pub trait UsersSyncBackend { fn find_by_username_or_email(&self, u: &str) -> Res>; + fn find_by_email(&self, u: &str) -> Res>; fn find_by_user_id(&self, id: &UserID) -> Res>; fn get_entire_users_list(&self) -> Res>; fn create_user_account(&mut self, settings: GeneralSettings) -> Res; @@ -19,6 +21,11 @@ pub trait UsersSyncBackend { fn save_new_successful_2fa_authentication(&mut self, id: &UserID, ip: IpAddr) -> Res; fn clear_2fa_login_history(&mut self, id: &UserID) -> Res; fn delete_account(&mut self, id: &UserID) -> Res; + fn set_authorized_authentication_sources( + &mut self, + id: &UserID, + sources: AuthorizedAuthenticationSources, + ) -> Res; fn set_granted_2fa_clients(&mut self, id: &UserID, clients: GrantedClients) -> Res; } @@ -28,16 +35,25 @@ pub enum LoginResult { AccountNotFound, InvalidPassword, AccountDisabled, + LocalAuthForbidden, + AuthFromProviderForbidden, Success(Box), } #[derive(Message)] #[rtype(LoginResult)] -pub struct LoginRequest { +pub struct LocalLoginRequest { pub login: String, pub password: String, } +#[derive(Message)] +#[rtype(LoginResult)] +pub struct ProviderLoginRequest { + pub email: String, + pub provider: Provider, +} + #[derive(Message)] #[rtype(GetUserResult)] pub struct GetUserRequest(pub UserID); @@ -88,6 +104,16 @@ pub struct AddSuccessful2FALogin(pub UserID, pub IpAddr); #[rtype(result = "bool")] pub struct Clear2FALoginHistory(pub UserID); +#[derive(Eq, PartialEq, Debug, Clone)] +pub struct AuthorizedAuthenticationSources { + pub local: bool, + pub upstream: Vec, +} + +#[derive(Message)] +#[rtype(result = "bool")] +pub struct SetAuthorizedAuthenticationSources(pub UserID, pub AuthorizedAuthenticationSources); + #[derive(Message)] #[rtype(result = "bool")] pub struct SetGrantedClients(pub UserID, pub GrantedClients); @@ -119,10 +145,10 @@ impl Actor for UsersActor { type Context = Context; } -impl Handler for UsersActor { - type Result = MessageResult; +impl Handler for UsersActor { + type Result = MessageResult; - fn handle(&mut self, msg: LoginRequest, _ctx: &mut Self::Context) -> Self::Result { + fn handle(&mut self, msg: LocalLoginRequest, _ctx: &mut Self::Context) -> Self::Result { match self.manager.find_by_username_or_email(&msg.login) { Err(e) => { log::error!("Failed to find user! {}", e); @@ -142,6 +168,35 @@ impl Handler for UsersActor { return MessageResult(LoginResult::AccountDisabled); } + if !user.allow_local_login { + return MessageResult(LoginResult::LocalAuthForbidden); + } + + MessageResult(LoginResult::Success(Box::new(user))) + } + } + } +} + +impl Handler for UsersActor { + type Result = MessageResult; + + fn handle(&mut self, msg: ProviderLoginRequest, _ctx: &mut Self::Context) -> Self::Result { + match self.manager.find_by_email(&msg.email) { + Err(e) => { + log::error!("Failed to find user! {}", e); + MessageResult(LoginResult::Error) + } + Ok(None) => MessageResult(LoginResult::AccountNotFound), + Ok(Some(user)) => { + if !user.can_login_from_provider(&msg.provider) { + return MessageResult(LoginResult::AuthFromProviderForbidden); + } + + if !user.enabled { + return MessageResult(LoginResult::AccountDisabled); + } + MessageResult(LoginResult::Success(Box::new(user))) } } @@ -241,6 +296,29 @@ impl Handler for UsersActor { } } +impl Handler for UsersActor { + type Result = ::Result; + fn handle( + &mut self, + msg: SetAuthorizedAuthenticationSources, + _ctx: &mut Self::Context, + ) -> Self::Result { + match self + .manager + .set_authorized_authentication_sources(&msg.0, msg.1) + { + Ok(_) => true, + Err(e) => { + log::error!( + "Failed to set authorized authentication sources for user! {}", + e + ); + false + } + } + } +} + impl Handler for UsersActor { type Result = ::Result; fn handle(&mut self, msg: SetGrantedClients, _ctx: &mut Self::Context) -> Self::Result { diff --git a/src/constants.rs b/src/constants.rs index a8fc7ef..5ee6a30 100644 --- a/src/constants.rs +++ b/src/constants.rs @@ -6,6 +6,9 @@ pub const USERS_LIST_FILE: &str = "users.json"; /// File in storage containing clients list pub const CLIENTS_LIST_FILE: &str = "clients.yaml"; +/// File in storage containing providers list +pub const PROVIDERS_LIST_FILE: &str = "providers.yaml"; + /// Default built-in credentials pub const DEFAULT_ADMIN_USERNAME: &str = "admin"; pub const DEFAULT_ADMIN_PASSWORD: &str = "admin"; @@ -68,3 +71,15 @@ pub const OPEN_ID_REFRESH_TOKEN_TIMEOUT: u64 = 360000; /// Webauthn constants pub const WEBAUTHN_REGISTER_CHALLENGE_EXPIRE: u64 = 3600; pub const WEBAUTHN_LOGIN_CHALLENGE_EXPIRE: u64 = 3600; + +/// OpenID providers login state constants +pub const OIDC_STATES_CLEANUP_INTERVAL: Duration = Duration::from_secs(60); +pub const MAX_OIDC_PROVIDERS_STATES: usize = 10; +pub const OIDC_PROVIDERS_STATE_LEN: usize = 40; +pub const OIDC_PROVIDERS_STATE_DURATION: u64 = 60 * 15; + +/// OpenID providers configuration constants +pub const OIDC_PROVIDERS_LIFETIME: u64 = 3600; + +/// OpenID provider callback URI +pub const OIDC_PROVIDER_CB_URI: &str = "/prov_cb"; diff --git a/src/controllers/admin_controller.rs b/src/controllers/admin_controller.rs index c6955c2..a9efd42 100644 --- a/src/controllers/admin_controller.rs +++ b/src/controllers/admin_controller.rs @@ -6,35 +6,46 @@ use actix_web::{web, HttpResponse, Responder}; use askama::Template; use crate::actors::users_actor; -use crate::actors::users_actor::UsersActor; +use crate::actors::users_actor::{AuthorizedAuthenticationSources, UsersActor}; use crate::constants::TEMPORARY_PASSWORDS_LEN; use crate::controllers::settings_controller::BaseSettingsPage; use crate::data::action_logger::{Action, ActionLogger}; +use crate::data::app_config::AppConfig; use crate::data::client::{Client, ClientID, ClientManager}; use crate::data::current_user::CurrentUser; +use crate::data::provider::{Provider, ProviderID, ProvidersManager}; use crate::data::user::{GeneralSettings, GrantedClients, User, UserID}; use crate::utils::string_utils::rand_str; #[derive(Template)] #[template(path = "settings/clients_list.html")] -struct ClientsListTemplate { - _p: BaseSettingsPage, +struct ClientsListTemplate<'a> { + _p: BaseSettingsPage<'a>, clients: Vec, } +#[derive(Template)] +#[template(path = "settings/providers_list.html")] +struct ProvidersListTemplate<'a> { + _p: BaseSettingsPage<'a>, + providers: Vec, + redirect_url: String, +} + #[derive(Template)] #[template(path = "settings/users_list.html")] -struct UsersListTemplate { - _p: BaseSettingsPage, +struct UsersListTemplate<'a> { + _p: BaseSettingsPage<'a>, users: Vec, } #[derive(Template)] #[template(path = "settings/edit_user.html")] -struct EditUserTemplate { - _p: BaseSettingsPage, +struct EditUserTemplate<'a> { + _p: BaseSettingsPage<'a>, u: User, clients: Vec, + providers: Vec, } pub async fn clients_route( @@ -51,6 +62,21 @@ pub async fn clients_route( ) } +pub async fn providers_route( + user: CurrentUser, + providers: web::Data>, +) -> impl Responder { + HttpResponse::Ok().body( + ProvidersListTemplate { + _p: BaseSettingsPage::get("OpenID Providers list", &user, None, None), + providers: providers.cloned(), + redirect_url: AppConfig::get().oidc_provider_redirect_url(), + } + .render() + .unwrap(), + ) +} + #[derive(serde::Deserialize, Debug)] pub struct UpdateUserQuery { uid: UserID, @@ -62,6 +88,8 @@ pub struct UpdateUserQuery { enabled: Option, two_factor_exemption_after_successful_login: Option, admin: Option, + allow_local_login: Option, + authorized_sources: String, grant_type: String, granted_clients: String, two_factor: String, @@ -136,6 +164,29 @@ pub async fn users_route( } } + // Update the list of authorized authentication sources + let auth_sources = AuthorizedAuthenticationSources { + local: update.0.allow_local_login.is_some(), + upstream: match update.0.authorized_sources.as_str() { + "" => vec![], + s => s.split(',').map(|s| ProviderID(s.to_string())).collect(), + }, + }; + + if edited_user.authorized_authentication_sources() != auth_sources { + logger.log(Action::AdminSetAuthorizedAuthenticationSources( + &edited_user, + &auth_sources, + )); + users + .send(users_actor::SetAuthorizedAuthenticationSources( + edited_user.uid.clone(), + auth_sources, + )) + .await + .unwrap(); + } + // Update list of granted clients let granted_clients = match update.0.grant_type.as_str() { "all_clients" => GrantedClients::AllClients, @@ -240,6 +291,7 @@ pub async fn users_route( pub async fn create_user( admin: CurrentUser, clients: web::Data>, + providers: web::Data>, ) -> impl Responder { let user = User { authorized_clients: Some( @@ -257,6 +309,7 @@ pub async fn create_user( _p: BaseSettingsPage::get("Create a new user", admin.deref(), None, None), u: user, clients: clients.cloned(), + providers: providers.cloned(), } .render() .unwrap(), @@ -271,6 +324,7 @@ pub struct EditUserQuery { pub async fn edit_user( admin: CurrentUser, clients: web::Data>, + providers: web::Data>, users: web::Data>, query: web::Query, ) -> impl Responder { @@ -293,6 +347,7 @@ pub async fn edit_user( ), u: edited_account.unwrap_or_default(), clients: clients.cloned(), + providers: providers.cloned(), } .render() .unwrap(), diff --git a/src/controllers/login_controller.rs b/src/controllers/login_controller.rs index 9237309..5bcf1f3 100644 --- a/src/controllers/login_controller.rs +++ b/src/controllers/login_controller.rs @@ -2,6 +2,7 @@ use actix::Addr; use actix_identity::Identity; use actix_web::{web, HttpRequest, HttpResponse, Responder}; use askama::Template; +use std::sync::Arc; use crate::actors::bruteforce_actor::BruteForceActor; use crate::actors::users_actor::{LoginResult, UsersActor}; @@ -12,17 +13,18 @@ use crate::controllers::base_controller::{ }; use crate::data::action_logger::{Action, ActionLogger}; use crate::data::login_redirect::LoginRedirect; +use crate::data::provider::{Provider, ProvidersManager}; use crate::data::remote_ip::RemoteIP; use crate::data::session_identity::{SessionIdentity, SessionStatus}; use crate::data::user::User; use crate::data::webauthn_manager::WebAuthManagerReq; -struct BaseLoginPage<'a> { - danger: Option, - success: Option, - page_title: &'static str, - app_name: &'static str, - redirect_uri: &'a LoginRedirect, +pub struct BaseLoginPage<'a> { + pub danger: Option, + pub success: Option, + pub page_title: &'static str, + pub app_name: &'static str, + pub redirect_uri: &'a LoginRedirect, } #[derive(Template)] @@ -30,6 +32,7 @@ struct BaseLoginPage<'a> { struct LoginTemplate<'a> { _p: BaseLoginPage<'a>, login: String, + providers: Vec, } #[derive(Template)] @@ -77,6 +80,7 @@ pub struct LoginRequestQuery { #[allow(clippy::too_many_arguments)] pub async fn login_route( remote_ip: RemoteIP, + providers: web::Data>, users: web::Data>, bruteforce: web::Data>, query: web::Query, @@ -121,7 +125,7 @@ pub async fn login_route( query.redirect.get_encoded() )); } - // Check if the user has to valide a second factor + // Check if the user has to validate a second factor else if SessionIdentity(id.as_ref()).need_2fa_auth() { return redirect_user(&format!( "/2fa_auth?redirect={}", @@ -132,7 +136,7 @@ pub async fn login_route( else if let Some(req) = &req { login = req.login.clone(); let response: LoginResult = users - .send(users_actor::LoginRequest { + .send(users_actor::LocalLoginRequest { login: login.clone(), password: req.password.clone(), }) @@ -163,6 +167,12 @@ pub async fn login_route( danger = Some("Your account is disabled!".to_string()); } + LoginResult::LocalAuthForbidden => { + log::warn!("Failed login for username {} : attempted to use local auth, but it is forbidden", &login); + logger.log(Action::TryLocalLoginFromUnauthorizedAccount(&login)); + danger = Some("You cannot login from local auth with your account!".to_string()); + } + LoginResult::Error => { danger = Some("An unkown error occured while trying to sign you in!".to_string()); } @@ -197,6 +207,7 @@ pub async fn login_route( redirect_uri: &query.redirect, }, login, + providers: providers.cloned(), } .render() .unwrap(), diff --git a/src/controllers/mod.rs b/src/controllers/mod.rs index c946f73..63b74d3 100644 --- a/src/controllers/mod.rs +++ b/src/controllers/mod.rs @@ -5,6 +5,7 @@ pub mod base_controller; pub mod login_api; pub mod login_controller; pub mod openid_controller; +pub mod providers_controller; pub mod settings_controller; pub mod two_factor_api; pub mod two_factors_controller; diff --git a/src/controllers/openid_controller.rs b/src/controllers/openid_controller.rs index 4c6c495..c3127cd 100644 --- a/src/controllers/openid_controller.rs +++ b/src/controllers/openid_controller.rs @@ -20,8 +20,7 @@ use crate::data::code_challenge::CodeChallenge; use crate::data::current_user::CurrentUser; use crate::data::id_token::IdToken; use crate::data::jwt_signer::{JWTSigner, JsonWebKey}; -use crate::data::open_id_user_info::OpenIDUserInfo; -use crate::data::openid_config::OpenIDConfig; +use crate::data::openid_primitive::{OpenIDConfig, OpenIDUserInfo, TokenResponse}; use crate::data::session_identity::SessionIdentity; use crate::data::user::User; use crate::utils::string_utils::rand_str; @@ -255,16 +254,6 @@ pub struct TokenQuery { refresh_token_query: Option, } -#[derive(Debug, serde::Serialize)] -pub struct TokenResponse { - access_token: String, - token_type: &'static str, - refresh_token: String, - expires_in: u64, - #[serde(skip_serializing_if = "Option::is_none")] - id_token: Option, -} - pub async fn token( req: HttpRequest, query: web::Form, @@ -451,9 +440,9 @@ pub async fn token( TokenResponse { access_token: session.access_token.expect("Missing access token!"), - token_type: "Bearer", - refresh_token: session.refresh_token, - expires_in: session.access_token_expire_at - time(), + token_type: "Bearer".to_string(), + refresh_token: Some(session.refresh_token), + expires_in: Some(session.access_token_expire_at - time()), id_token: Some(jwt_signer.sign_token(id_token.to_jwt_claims())?), } } @@ -501,9 +490,9 @@ pub async fn token( TokenResponse { access_token: session.access_token.expect("Missing access token!"), - token_type: "Bearer", - refresh_token: session.refresh_token, - expires_in: session.access_token_expire_at - time(), + token_type: "Bearer".to_string(), + refresh_token: Some(session.refresh_token), + expires_in: Some(session.access_token_expire_at - time()), id_token: None, } } @@ -637,12 +626,12 @@ async fn user_info( }; HttpResponse::Ok().json(OpenIDUserInfo { - name: user.full_name(), + name: Some(user.full_name()), sub: user.uid.0, - given_name: user.first_name, - family_name: user.last_name, - preferred_username: user.username, - email: user.email, - email_verified: true, + given_name: Some(user.first_name), + family_name: Some(user.last_name), + preferred_username: Some(user.username), + email: Some(user.email), + email_verified: Some(true), }) } diff --git a/src/controllers/providers_controller.rs b/src/controllers/providers_controller.rs new file mode 100644 index 0000000..f067ad7 --- /dev/null +++ b/src/controllers/providers_controller.rs @@ -0,0 +1,373 @@ +use std::sync::Arc; + +use actix::Addr; +use actix_identity::Identity; +use actix_web::{web, HttpRequest, HttpResponse, Responder}; +use askama::Template; + +use crate::actors::bruteforce_actor::BruteForceActor; +use crate::actors::providers_states_actor::{ProviderLoginState, ProvidersStatesActor}; +use crate::actors::users_actor::{LoginResult, UsersActor}; +use crate::actors::{bruteforce_actor, providers_states_actor, users_actor}; +use crate::constants::{APP_NAME, MAX_FAILED_LOGIN_ATTEMPTS}; +use crate::controllers::base_controller::{build_fatal_error_page, redirect_user}; +use crate::controllers::login_controller::BaseLoginPage; +use crate::data::action_logger::{Action, ActionLogger}; +use crate::data::login_redirect::LoginRedirect; +use crate::data::provider::{ProviderID, ProvidersManager}; +use crate::data::provider_configuration::ProviderConfigurationHelper; +use crate::data::remote_ip::RemoteIP; +use crate::data::session_identity::{SessionIdentity, SessionStatus}; + +#[derive(askama::Template)] +#[template(path = "login/prov_login_error.html")] +struct ProviderLoginError<'a> { + _p: BaseLoginPage<'a>, + message: &'a str, +} + +impl<'a> ProviderLoginError<'a> { + pub fn get(message: &'a str, redirect_uri: &'a LoginRedirect) -> HttpResponse { + let body = Self { + _p: BaseLoginPage { + danger: None, + success: None, + page_title: "Upstream login", + app_name: APP_NAME, + redirect_uri, + }, + message, + } + .render() + .unwrap(); + + HttpResponse::Unauthorized() + .content_type("text/html") + .body(body) + } +} + +#[derive(serde::Deserialize)] +pub struct StartLoginQuery { + #[serde(default)] + redirect: LoginRedirect, + id: ProviderID, +} + +/// Start user authentication using a provider +pub async fn start_login( + remote_ip: RemoteIP, + providers: web::Data>, + states: web::Data>, + query: web::Query, + logger: ActionLogger, + id: Option, +) -> impl Responder { + // Check if user is already authenticated + if SessionIdentity(id.as_ref()).is_authenticated() { + return redirect_user(query.redirect.get()); + } + + // Get provider information + let provider = match providers.find_by_id(&query.id) { + None => { + return HttpResponse::NotFound() + .body(build_fatal_error_page("Login provider not found!")); + } + Some(p) => p, + }; + + // Generate & save state + let state = ProviderLoginState::new(&provider.id, query.redirect.clone()); + states + .send(providers_states_actor::RecordState { + ip: remote_ip.0, + state: state.clone(), + }) + .await + .unwrap(); + + logger.log(Action::StartLoginAttemptWithOpenIDProvider { + provider_id: &provider.id, + state: &state.state_id, + }); + + // Get provider configuration + let config = match ProviderConfigurationHelper::get_configuration(&provider).await { + Ok(c) => c, + Err(e) => { + log::error!("Failed to load provider configuration! {}", e); + return HttpResponse::InternalServerError().body(build_fatal_error_page( + "Failed to load provider configuration!", + )); + } + }; + + log::debug!("Provider configuration: {:?}", config); + + let url = config.auth_url(&provider, &state); + log::debug!("Redirect user on {url} for authentication",); + + // Redirect user + redirect_user(&url) +} + +#[derive(serde::Deserialize)] +pub struct FinishLoginSuccess { + code: String, + state: String, +} + +#[derive(serde::Deserialize)] +pub struct FinishLoginError { + error: String, + error_description: Option, +} + +#[derive(serde::Deserialize)] +pub struct FinishLoginQuery { + #[serde(flatten)] + success: Option, + #[serde(flatten)] + error: Option, +} + +/// Finish user authentication using a provider +#[allow(clippy::too_many_arguments)] +pub async fn finish_login( + remote_ip: RemoteIP, + providers: web::Data>, + users: web::Data>, + states: web::Data>, + bruteforce: web::Data>, + query: web::Query, + logger: ActionLogger, + id: Option, + http_req: HttpRequest, +) -> impl Responder { + // Check if user is already authenticated + if SessionIdentity(id.as_ref()).is_authenticated() { + return redirect_user("/"); + } + + let query = match query.0.success { + Some(q) => q, + None => { + let error_message = query + .0 + .error + .map(|e| e.error_description.unwrap_or(e.error)) + .unwrap_or("Authentication failed (unspecified error)!".to_string()); + + logger.log(Action::ProviderError { + message: error_message.as_str(), + }); + + return ProviderLoginError::get(&error_message, &LoginRedirect::default()); + } + }; + + // Get & consume state + let state = states + .send(providers_states_actor::ConsumeState { + ip: remote_ip.0, + state_id: query.state.clone(), + }) + .await + .unwrap(); + + let state = match state { + Some(s) => s, + None => { + logger.log(Action::ProviderCBInvalidState { + state: query.state.as_str(), + }); + log::warn!("User returned invalid state!"); + return ProviderLoginError::get("Invalid state!", &LoginRedirect::default()); + } + }; + + // We perform rate limiting before attempting to use authorization code + let failed_attempts = bruteforce + .send(bruteforce_actor::CountFailedAttempt { + ip: remote_ip.into(), + }) + .await + .unwrap(); + + if failed_attempts > MAX_FAILED_LOGIN_ATTEMPTS { + logger.log(Action::ProviderRateLimited); + return HttpResponse::TooManyRequests().body(build_fatal_error_page( + "Too many failed login attempts, please try again later!", + )); + } + + // Retrieve provider information & configuration + let provider = providers + .find_by_id(&state.provider_id) + .expect("Unable to retrieve provider information!"); + + let provider_config = match ProviderConfigurationHelper::get_configuration(&provider).await { + Ok(c) => c, + Err(e) => { + log::error!("Failed to load provider configuration! {}", e); + return HttpResponse::InternalServerError().body(build_fatal_error_page( + "Failed to load provider configuration!", + )); + } + }; + + // Get access token & user information + let token = provider_config.get_token(&provider, &query.code).await; + let token = match token { + Ok(t) => t, + Err(e) => { + log::error!("Failed to retrieve login token! {:?}", e); + + bruteforce + .send(bruteforce_actor::RecordFailedAttempt { + ip: remote_ip.into(), + }) + .await + .unwrap(); + + logger.log(Action::ProviderFailedGetToken { + state: &state, + code: query.code.as_str(), + }); + + return ProviderLoginError::get( + "Failed to retrieve login token from identity provider!", + &state.redirect, + ); + } + }; + + // Use access token to get user information + let user_info = match provider_config.get_userinfo(&token).await { + Ok(info) => info, + Err(e) => { + log::error!("Failed to retrieve user information! {:?}", e); + + logger.log(Action::ProviderFailedGetUserInfo { + provider: &provider, + }); + + return ProviderLoginError::get( + "Failed to retrieve user information from identity provider!", + &state.redirect, + ); + } + }; + + // Check if user email is validated + if user_info.email_verified == Some(false) { + logger.log(Action::ProviderEmailNotValidated { + provider: &provider, + }); + return ProviderLoginError::get( + &format!( + "{} indicated that your email address has not been validated!", + provider.name + ), + &state.redirect, + ); + } + + // Check if email was provided by the userinfo endpoint + let email = match user_info.email { + Some(e) => e, + None => { + logger.log(Action::ProviderMissingEmailInResponse { + provider: &provider, + }); + return ProviderLoginError::get( + &format!( + "{} did not provide your email address in its reply, so we could not identify you!", + provider.name + ), + &state.redirect, + ); + } + }; + + // Get user from local database + let result: LoginResult = users + .send(users_actor::ProviderLoginRequest { + email: email.clone(), + provider: provider.clone(), + }) + .await + .unwrap(); + + let user = match result { + LoginResult::Success(u) => u, + LoginResult::AccountNotFound => { + logger.log(Action::ProviderAccountNotFound { + provider: &provider, + email: email.as_str(), + }); + + return ProviderLoginError::get( + &format!("The email address {email} was not found in the database!"), + &state.redirect, + ); + } + LoginResult::AccountDisabled => { + logger.log(Action::ProviderAccountDisabled { + provider: &provider, + email: email.as_str(), + }); + + return ProviderLoginError::get( + &format!("The account associated with the email address {email} is disabled!"), + &state.redirect, + ); + } + + LoginResult::AuthFromProviderForbidden => { + logger.log(Action::ProviderAccountNotAllowedToLoginWithProvider { + provider: &provider, + email: email.as_str(), + }); + + return ProviderLoginError::get( + &format!( + "The account associated with the email address {email} is not allowed to sign in using this provider!" + ), + &state.redirect, + ); + } + + c => { + log::error!( + "Login from provider {} failed with error {:?}", + provider.id.0, + c + ); + + logger.log(Action::ProviderLoginFailed { + provider: &provider, + email: email.as_str(), + }); + + return ProviderLoginError::get("Failed to complete login!", &state.redirect); + } + }; + + logger.log(Action::ProviderLoginSuccessful { + provider: &provider, + user: &user, + }); + + let status = if user.has_two_factor() && !user.can_bypass_two_factors_for_ip(remote_ip.0) { + logger.log(Action::UserNeed2FAOnLogin(&user)); + SessionStatus::Need2FA + } else { + logger.log(Action::UserSuccessfullyAuthenticated(&user)); + SessionStatus::SignedIn + }; + + SessionIdentity(id.as_ref()).set_user(&http_req, &user, status); + redirect_user(&format!("/login?redirect={}", state.redirect.get_encoded())) +} diff --git a/src/controllers/settings_controller.rs b/src/controllers/settings_controller.rs index d772687..db713e2 100644 --- a/src/controllers/settings_controller.rs +++ b/src/controllers/settings_controller.rs @@ -12,31 +12,29 @@ use crate::data::current_user::CurrentUser; use crate::data::remote_ip::RemoteIP; use crate::data::user::User; -pub(crate) struct BaseSettingsPage { +pub(crate) struct BaseSettingsPage<'a> { pub danger_message: Option, pub success_message: Option, pub page_title: &'static str, pub app_name: &'static str, - pub is_admin: bool, - pub user_name: String, + pub user: &'a User, pub version: &'static str, pub ip_location_api: Option<&'static str>, } -impl BaseSettingsPage { +impl<'a> BaseSettingsPage<'a> { pub fn get( page_title: &'static str, - user: &User, + user: &'a User, danger_message: Option, success_message: Option, - ) -> BaseSettingsPage { + ) -> BaseSettingsPage<'a> { Self { danger_message, success_message, page_title, app_name: APP_NAME, - is_admin: user.admin, - user_name: user.username.to_string(), + user, version: env!("CARGO_PKG_VERSION"), ip_location_api: AppConfig::get().ip_location_service.as_deref(), } @@ -45,15 +43,14 @@ impl BaseSettingsPage { #[derive(Template)] #[template(path = "settings/account_details.html")] -struct AccountDetailsPage { - _p: BaseSettingsPage, - u: User, +struct AccountDetailsPage<'a> { + _p: BaseSettingsPage<'a>, } #[derive(Template)] #[template(path = "settings/change_password.html")] -struct ChangePasswordPage { - _p: BaseSettingsPage, +struct ChangePasswordPage<'a> { + _p: BaseSettingsPage<'a>, min_pwd_len: usize, } @@ -63,7 +60,6 @@ pub async fn account_settings_details_route(user: CurrentUser) -> impl Responder HttpResponse::Ok().body( AccountDetailsPage { _p: BaseSettingsPage::get("Account details", &user, None, None), - u: user, } .render() .unwrap(), diff --git a/src/controllers/two_factors_controller.rs b/src/controllers/two_factors_controller.rs index 5ca30d1..9851195 100644 --- a/src/controllers/two_factors_controller.rs +++ b/src/controllers/two_factors_controller.rs @@ -17,14 +17,14 @@ use crate::data::webauthn_manager::WebAuthManagerReq; #[derive(Template)] #[template(path = "settings/two_factors_page.html")] struct TwoFactorsPage<'a> { - _p: BaseSettingsPage, + _p: BaseSettingsPage<'a>, user: &'a User, } #[derive(Template)] #[template(path = "settings/add_2fa_totp_page.html")] -struct AddTotpPage { - _p: BaseSettingsPage, +struct AddTotpPage<'a> { + _p: BaseSettingsPage<'a>, qr_code: String, account_name: String, secret_key: String, @@ -33,8 +33,8 @@ struct AddTotpPage { #[derive(Template)] #[template(path = "settings/add_webauthn_page.html")] -struct AddWebauhtnPage { - _p: BaseSettingsPage, +struct AddWebauhtnPage<'a> { + _p: BaseSettingsPage<'a>, opaque_state: String, challenge_json: String, max_name_len: usize, diff --git a/src/data/action_logger.rs b/src/data/action_logger.rs index f4189f5..694d074 100644 --- a/src/data/action_logger.rs +++ b/src/data/action_logger.rs @@ -7,9 +7,11 @@ use actix_identity::Identity; use actix_web::dev::Payload; use actix_web::{web, Error, FromRequest, HttpRequest}; +use crate::actors::providers_states_actor::ProviderLoginState; use crate::actors::users_actor; -use crate::actors::users_actor::UsersActor; +use crate::actors::users_actor::{AuthorizedAuthenticationSources, UsersActor}; use crate::data::client::Client; +use crate::data::provider::{Provider, ProviderID}; use crate::data::remote_ip::RemoteIP; use crate::data::session_identity::SessionIdentity; use crate::data::user::{FactorID, GrantedClients, TwoFactor, User, UserID}; @@ -20,22 +22,79 @@ pub enum Action<'a> { AdminDeleteUser(&'a User), AdminResetUserPassword(&'a User), AdminRemoveUserFactor(&'a User, &'a TwoFactor), + AdminSetAuthorizedAuthenticationSources(&'a User, &'a AuthorizedAuthenticationSources), AdminSetNewGrantedClientsList(&'a User, &'a GrantedClients), AdminClear2FAHistory(&'a User), - LoginWebauthnAttempt { success: bool, user_id: UserID }, + LoginWebauthnAttempt { + success: bool, + user_id: UserID, + }, + StartLoginAttemptWithOpenIDProvider { + provider_id: &'a ProviderID, + state: &'a str, + }, + ProviderError { + message: &'a str, + }, + ProviderCBInvalidState { + state: &'a str, + }, + ProviderRateLimited, + ProviderFailedGetToken { + state: &'a ProviderLoginState, + code: &'a str, + }, + ProviderFailedGetUserInfo { + provider: &'a Provider, + }, + ProviderEmailNotValidated { + provider: &'a Provider, + }, + ProviderMissingEmailInResponse { + provider: &'a Provider, + }, + ProviderAccountNotFound { + provider: &'a Provider, + email: &'a str, + }, + ProviderAccountDisabled { + provider: &'a Provider, + email: &'a str, + }, + + ProviderAccountNotAllowedToLoginWithProvider { + provider: &'a Provider, + email: &'a str, + }, + ProviderLoginFailed { + provider: &'a Provider, + email: &'a str, + }, + ProviderLoginSuccessful { + provider: &'a Provider, + user: &'a User, + }, Signout, UserNeed2FAOnLogin(&'a User), UserSuccessfullyAuthenticated(&'a User), UserNeedNewPasswordOnLogin(&'a User), TryLoginWithDisabledAccount(&'a str), + TryLocalLoginFromUnauthorizedAccount(&'a str), FailedLoginWithBadCredentials(&'a str), UserChangedPasswordOnLogin(&'a UserID), - OTPLoginAttempt { user: &'a User, success: bool }, - NewOpenIDSession { client: &'a Client }, + OTPLoginAttempt { + user: &'a User, + success: bool, + }, + NewOpenIDSession { + client: &'a Client, + }, ChangedHisPassword, ClearedHisLoginHistory, AddNewFactor(&'a TwoFactor), - Removed2FAFactor { factor_id: &'a FactorID }, + Removed2FAFactor { + factor_id: &'a FactorID, + }, } impl<'a> Action<'a> { @@ -64,6 +123,11 @@ impl<'a> Action<'a> { Action::AdminClear2FAHistory(user) => { format!("cleared 2FA history of {}", user.quick_identity()) } + Action::AdminSetAuthorizedAuthenticationSources(user, sources) => format!( + "update authorized authentication sources ({:?}) for user ({})", + sources, + user.quick_identity() + ), Action::AdminSetNewGrantedClientsList(user, clients) => format!( "set new granted clients list ({:?}) for user ({})", clients, @@ -73,6 +137,28 @@ impl<'a> Action<'a> { true => format!("successfully performed webauthn attempt for user {user_id:?}"), false => format!("performed FAILED webauthn attempt for user {user_id:?}"), }, + Action::StartLoginAttemptWithOpenIDProvider { provider_id, state } => format!( + "started new authentication attempt through an OpenID provider (prov={} / state={state})", provider_id.0 + ), + Action::ProviderError { message } => + format!("failed provider authentication with message '{message}'"), + Action::ProviderCBInvalidState { state } => + format!("provided invalid callback state after provider authentication: '{state}'"), + Action::ProviderRateLimited => "could not complete OpenID login because it has reached failed attempts rate limit!".to_string(), + Action::ProviderFailedGetToken {state, code} => format!("could not complete login from provider because the id_token could not be retrieved! (state={:?} code = {code})",state), + Action::ProviderFailedGetUserInfo {provider} => format!("could not get user information from userinfo endpoint of provider {}!", provider.id.0), + Action::ProviderEmailNotValidated {provider}=>format!("could not login using provider {} because its email was marked as not validated!", provider.id.0), + Action::ProviderMissingEmailInResponse {provider}=>format!("could not login using provider {} because the email was not provided by userinfo endpoint!", provider.id.0), + Action::ProviderAccountNotFound { provider, email } => + format!("could not login using provider {} because the email {email} could not be associated to any account!", &provider.id.0), + Action::ProviderAccountDisabled { provider, email } => + format!("could not login using provider {} because the account associated to the email {email} is disabled!", &provider.id.0), + Action::ProviderAccountNotAllowedToLoginWithProvider { provider, email } => + format!("could not login using provider {} because the account associated to the email {email} is not allowed to authenticate using this provider!", &provider.id.0), + Action::ProviderLoginFailed { provider, email } => + format!("could not login using provider {} with the email {email} for an unknown reason!", &provider.id.0), + Action::ProviderLoginSuccessful {provider, user} => + format!("successfully authenticated using provider {} as {}", provider.id.0, user.quick_identity()), Action::Signout => "signed out".to_string(), Action::UserNeed2FAOnLogin(user) => { format!( @@ -90,6 +176,9 @@ impl<'a> Action<'a> { Action::TryLoginWithDisabledAccount(login) => { format!("successfully authenticated as {login}, but this is a DISABLED ACCOUNT") } + Action::TryLocalLoginFromUnauthorizedAccount(login) => { + format!("successfully locally authenticated as {login}, but this is a FORBIDDEN for this account!") + } Action::FailedLoginWithBadCredentials(login) => { format!("attempted to authenticate as {login} but with a WRONG PASSWORD") } @@ -116,6 +205,7 @@ impl<'a> Action<'a> { factor.quick_description(), ), Action::Removed2FAFactor { factor_id } => format!("Removed his factor {factor_id:?}"), + } } } diff --git a/src/data/app_config.rs b/src/data/app_config.rs index f5298b5..461f009 100644 --- a/src/data/app_config.rs +++ b/src/data/app_config.rs @@ -2,7 +2,9 @@ use std::path::{Path, PathBuf}; use clap::Parser; -use crate::constants::{APP_NAME, CLIENTS_LIST_FILE, USERS_LIST_FILE}; +use crate::constants::{ + APP_NAME, CLIENTS_LIST_FILE, OIDC_PROVIDER_CB_URI, PROVIDERS_LIST_FILE, USERS_LIST_FILE, +}; /// Basic OIDC provider #[derive(Parser, Debug, Clone)] @@ -72,6 +74,10 @@ impl AppConfig { self.storage_path().join(CLIENTS_LIST_FILE) } + pub fn providers_file(&self) -> PathBuf { + self.storage_path().join(PROVIDERS_LIST_FILE) + } + pub fn full_url(&self, uri: &str) -> String { if uri.starts_with('/') { format!("{}{}", self.website_origin, uri) @@ -80,9 +86,21 @@ impl AppConfig { } } + /// Get the URL where a upstream OpenID provider should redirect + /// the user after an authentication + pub fn oidc_provider_redirect_url(&self) -> String { + AppConfig::get().full_url(OIDC_PROVIDER_CB_URI) + } + pub fn domain_name(&self) -> &str { self.website_origin.split('/').nth(2).unwrap_or(APP_NAME) } + + /// Get the domain without the port + pub fn domain_name_without_port(&self) -> &str { + let domain = self.domain_name(); + domain.split_once(':').map(|i| i.0).unwrap_or(domain) + } } #[cfg(test)] diff --git a/src/data/jwt_signer.rs b/src/data/jwt_signer.rs index c7d0017..c3f009f 100644 --- a/src/data/jwt_signer.rs +++ b/src/data/jwt_signer.rs @@ -11,8 +11,10 @@ use base64::Engine as _; use crate::utils::err::Res; use crate::utils::string_utils::rand_str; +const JWK_USE_SIGN: &str = "sig"; + /// Json Web Key -#[derive(serde::Serialize, serde::Deserialize)] +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] pub struct JsonWebKey { #[serde(rename = "alg")] algorithm: String, @@ -24,6 +26,8 @@ pub struct JsonWebKey { modulus: String, #[serde(rename = "e")] public_exponent: String, + #[serde(rename = "use", skip_serializing_if = "Option::is_none")] + usage: Option, } #[derive(Debug, Clone)] @@ -44,6 +48,7 @@ impl JWTSigner { key_id: self.0.key_id().as_ref().unwrap().to_string(), public_exponent: BASE64_URL_URL_SAFE.encode(components.e), modulus: BASE64_URL_SAFE_NO_PAD.encode(components.n), + usage: Some(JWK_USE_SIGN.to_string()), } } diff --git a/src/data/mod.rs b/src/data/mod.rs index 7e431b6..c45df9a 100644 --- a/src/data/mod.rs +++ b/src/data/mod.rs @@ -10,7 +10,9 @@ pub mod id_token; pub mod jwt_signer; pub mod login_redirect; pub mod open_id_user_info; -pub mod openid_config; +pub mod openid_primitive; +pub mod provider; +pub mod provider_configuration; pub mod remote_ip; pub mod session_identity; pub mod totp_key; diff --git a/src/data/open_id_user_info.rs b/src/data/open_id_user_info.rs index 04d35bc..8b13789 100644 --- a/src/data/open_id_user_info.rs +++ b/src/data/open_id_user_info.rs @@ -1,24 +1 @@ -/// Refer to for more information -#[derive(Debug, serde::Serialize)] -pub struct OpenIDUserInfo { - /// Subject - Identifier for the End-User at the Issuer - pub sub: String, - /// End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. - pub name: String, - - /// Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. - pub given_name: String, - - /// Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. - pub family_name: String, - - /// Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in - pub preferred_username: String, - - /// End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 RFC5322 addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. - pub email: String, - - /// True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. - pub email_verified: bool, -} diff --git a/src/data/openid_config.rs b/src/data/openid_config.rs deleted file mode 100644 index b3e6df0..0000000 --- a/src/data/openid_config.rs +++ /dev/null @@ -1,37 +0,0 @@ -#[derive(Debug, Clone, serde::Serialize)] -pub struct OpenIDConfig { - /// URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier. If Issuer discovery is supported (see Section 2), this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer - pub issuer: String, - - /// REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint `OpenID.Core` - pub authorization_endpoint: String, - - /// URL of the OP's OAuth 2.0 Token Endpoint `OpenID.Core`. This is REQUIRED unless only the Implicit Flow is used. - pub token_endpoint: String, - - /// RECOMMENDED. URL of the OP's UserInfo Endpoint `[`OpenID.Core`]`. This URL MUST use the https scheme and MAY contain port, path, and query parameter components - pub userinfo_endpoint: String, - - /// REQUIRED. URL of the OP's JSON Web Key Set `[`JWK`]` document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. - pub jwks_uri: String, - - /// RECOMMENDED. JSON array containing a list of the OAuth 2.0 `[`RFC6749`]` scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in `[`OpenID.Core`]` SHOULD be listed, if supported. - pub scopes_supported: Vec<&'static str>, - - /// REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. - pub response_types_supported: Vec<&'static str>, - - /// REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. - pub subject_types_supported: Vec<&'static str>, - - /// REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT `[`JWT`. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow). - pub id_token_signing_alg_values_supported: Vec<&'static str>, - - /// OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt - pub token_endpoint_auth_methods_supported: Vec<&'static str>, - - /// RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. - pub claims_supported: Vec<&'static str>, - - pub code_challenge_methods_supported: Vec<&'static str>, -} diff --git a/src/data/openid_primitive.rs b/src/data/openid_primitive.rs new file mode 100644 index 0000000..86e63e1 --- /dev/null +++ b/src/data/openid_primitive.rs @@ -0,0 +1,107 @@ +//! # OpenID primitives + +/// OpenID discovery information +#[derive(Debug, Clone, serde::Serialize)] +pub struct OpenIDConfig { + /// URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier. If Issuer discovery is supported (see Section 2), this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer + pub issuer: String, + + /// REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint `OpenID.Core` + pub authorization_endpoint: String, + + /// URL of the OP's OAuth 2.0 Token Endpoint `OpenID.Core`. This is REQUIRED unless only the Implicit Flow is used. + pub token_endpoint: String, + + /// RECOMMENDED. URL of the OP's UserInfo Endpoint `[`OpenID.Core`]`. This URL MUST use the https scheme and MAY contain port, path, and query parameter components + pub userinfo_endpoint: String, + + /// REQUIRED. URL of the OP's JSON Web Key Set `[`JWK`]` document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. + pub jwks_uri: String, + + /// RECOMMENDED. JSON array containing a list of the OAuth 2.0 `[`RFC6749`]` scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in `[`OpenID.Core`]` SHOULD be listed, if supported. + pub scopes_supported: Vec<&'static str>, + + /// REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. + pub response_types_supported: Vec<&'static str>, + + /// REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. + pub subject_types_supported: Vec<&'static str>, + + /// REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT `[`JWT`. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow). + pub id_token_signing_alg_values_supported: Vec<&'static str>, + + /// OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt + pub token_endpoint_auth_methods_supported: Vec<&'static str>, + + /// RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. + pub claims_supported: Vec<&'static str>, + + pub code_challenge_methods_supported: Vec<&'static str>, +} + +/// OpenID token response +/// +/// The content of this field is specified in +/// * OAuth specifications: https://datatracker.ietf.org/doc/html/rfc6749#section-5.1 +/// * OpenID Core specifications: https://openid.net/specs/openid-connect-core-1_0.html#TokenResponse +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +pub struct TokenResponse { + /// REQUIRED. The access token issued by the authorization server. + pub access_token: String, + + /// REQUIRED. The type of the token issued. It MUST be "Bearer" + pub token_type: String, + + /// OPTIONAL. The refresh token, which can be used to obtain new + /// access tokens using the same authorization grant + #[serde(skip_serializing_if = "Option::is_none")] + pub refresh_token: Option, + + /// RECOMMENDED. The lifetime in seconds of the access token. For + /// example, the value "3600" denotes that the access token will + /// expire in one hour from the time the response was generated. + /// If omitted, the authorization server SHOULD provide the + /// expiration time via other means or document the default value. + #[serde(skip_serializing_if = "Option::is_none")] + pub expires_in: Option, + + /// REQUIRED. ID Token value associated with the authenticated session. + /// + /// Note: this field is marked as optionnal because it is excluded in case + /// of request of refresh token. + #[serde(skip_serializing_if = "Option::is_none")] + pub id_token: Option, +} + +/// Refer to for more information +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +pub struct OpenIDUserInfo { + /// Subject - Identifier for the End-User at the Issuer + /// + /// This is the only mandatory field + pub sub: String, + + /// End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + + /// Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters. + #[serde(skip_serializing_if = "Option::is_none")] + pub given_name: Option, + + /// Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters. + #[serde(skip_serializing_if = "Option::is_none")] + pub family_name: Option, + + /// Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in + #[serde(skip_serializing_if = "Option::is_none")] + pub preferred_username: Option, + + /// End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 RFC5322 addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7. + #[serde(skip_serializing_if = "Option::is_none")] + pub email: Option, + + /// True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. + #[serde(skip_serializing_if = "Option::is_none")] + pub email_verified: Option, +} diff --git a/src/data/provider.rs b/src/data/provider.rs new file mode 100644 index 0000000..4f742ef --- /dev/null +++ b/src/data/provider.rs @@ -0,0 +1,89 @@ +use crate::data::entity_manager::EntityManager; +use crate::data::login_redirect::LoginRedirect; +use crate::utils::string_utils::apply_env_vars; + +#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, Eq, PartialEq)] +pub struct ProviderID(pub String); + +#[derive(Clone, Debug, serde::Serialize, serde::Deserialize)] +pub struct Provider { + /// The ID of the provider + pub id: ProviderID, + + /// The human-readable name of the client + pub name: String, + + /// A logo presented to the users of the provider + pub logo: String, + + /// The registration id of BasicOIDC on the provider + pub client_id: String, + + /// The registration secret of BasicOIDC on the provider + pub client_secret: String, + + /// Specify the URL of the OpenID configuration URL + /// + /// (.well-known/openid-configuration endpoint) + pub configuration_url: String, +} + +impl Provider { + /// Get URL-encoded provider id + pub fn id_encoded(&self) -> String { + urlencoding::encode(&self.id.0).to_string() + } + + /// Get the URL where the logo can be located + pub fn logo_url(&self) -> &str { + match self.logo.as_str() { + "gitea" => "/assets/img/brands/gitea.svg", + "gitlab" => "/assets/img/brands/gitlab.svg", + "github" => "/assets/img/brands/github.svg", + "microsoft" => "/assets/img/brands/microsoft.svg", + "google" => "/assets/img/brands/google.svg", + s => s, + } + } + + /// Get the URL to use to login with the provider + pub fn login_url(&self, redirect_url: &LoginRedirect) -> String { + format!( + "/login_with_prov?id={}&redirect={}", + self.id_encoded(), + redirect_url.get_encoded() + ) + } +} + +impl PartialEq for Provider { + fn eq(&self, other: &Self) -> bool { + self.id.eq(&other.id) + } +} + +impl Eq for Provider {} + +pub type ProvidersManager = EntityManager; + +impl EntityManager { + pub fn find_by_id(&self, u: &ProviderID) -> Option { + for entry in self.iter() { + if entry.id.eq(u) { + return Some(entry.clone()); + } + } + None + } + + pub fn apply_environment_variables(&mut self) { + for c in self.iter_mut() { + c.id = ProviderID(apply_env_vars(&c.id.0)); + c.name = apply_env_vars(&c.name); + c.logo = apply_env_vars(&c.logo); + c.client_id = apply_env_vars(&c.client_id); + c.client_secret = apply_env_vars(&c.client_secret); + c.configuration_url = apply_env_vars(&c.configuration_url); + } + } +} diff --git a/src/data/provider_configuration.rs b/src/data/provider_configuration.rs new file mode 100644 index 0000000..eaf079e --- /dev/null +++ b/src/data/provider_configuration.rs @@ -0,0 +1,135 @@ +use std::cell::RefCell; +use std::collections::HashMap; + +use base64::engine::general_purpose::STANDARD as BASE64_STANDARD; +use base64::Engine as _; + +use crate::actors::providers_states_actor::ProviderLoginState; +use crate::constants::OIDC_PROVIDERS_LIFETIME; +use crate::data::app_config::AppConfig; +use crate::data::jwt_signer::JsonWebKey; +use crate::data::openid_primitive::{OpenIDUserInfo, TokenResponse}; +use crate::data::provider::Provider; +use crate::utils::err::Res; +use crate::utils::time::time; + +#[derive(Debug, Clone, serde::Deserialize)] +pub struct ProviderDiscovery { + pub issuer: String, + pub authorization_endpoint: String, + pub token_endpoint: String, + pub userinfo_endpoint: Option, + pub jwks_uri: String, + pub claims_supported: Option>, +} + +#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] +pub struct ProviderJWKs { + pub keys: Vec, +} + +/// Provider configuration +#[derive(Debug, Clone)] +pub struct ProviderConfiguration { + pub discovery: ProviderDiscovery, + //pub keys: ProviderJWKs, + pub expire: u64, +} + +impl ProviderConfiguration { + /// Get the URL where a user should be redirected to authenticate + pub fn auth_url(&self, provider: &Provider, state: &ProviderLoginState) -> String { + let authorization_url = &self.discovery.authorization_endpoint; + let client_id = urlencoding::encode(&provider.client_id).to_string(); + let state = urlencoding::encode(&state.state_id).to_string(); + let callback_url = AppConfig::get().oidc_provider_redirect_url(); + + format!("{authorization_url}?response_type=code&scope=openid%20profile%20email&client_id={client_id}&state={state}&redirect_uri={callback_url}") + } + + /// Retrieve the authorization token after a successful authentication, using an authorization code + pub async fn get_token( + &self, + provider: &Provider, + authorization_code: &str, + ) -> Res { + let authorization = + BASE64_STANDARD.encode(format!("{}:{}", provider.client_id, provider.client_secret)); + + let redirect_url = AppConfig::get().oidc_provider_redirect_url(); + + let mut params = HashMap::new(); + params.insert("grant_type", "authorization_code"); + params.insert("code", authorization_code); + params.insert("redirect_uri", redirect_url.as_str()); + + Ok(reqwest::Client::new() + .post(&self.discovery.token_endpoint) + .header("Authorization", format!("Basic {authorization}")) + .form(¶ms) + .send() + .await? + .json() + .await?) + } + + /// Retrieve information about the user, using given [TokenResponse] + pub async fn get_userinfo(&self, token: &TokenResponse) -> Res { + Ok(reqwest::Client::new() + .get( + self.discovery + .userinfo_endpoint + .as_ref() + .expect("Userinfo endpoint is required by this implementation!"), + ) + .header("Authorization", format!("Bearer {}", token.access_token)) + .send() + .await? + .json() + .await?) + } +} + +thread_local! { + static THREAD_CACHE: RefCell> = RefCell::new(Default::default()); +} + +pub struct ProviderConfigurationHelper {} + +impl ProviderConfigurationHelper { + /// Get or refresh the configuration for a provider + pub async fn get_configuration(provider: &Provider) -> Res { + let config = THREAD_CACHE.with(|i| i.borrow().get(&provider.configuration_url).cloned()); + + // Refresh config cache if needed + if config.is_none() || config.as_ref().unwrap().expire < time() { + let conf = Self::fetch_configuration(provider).await?; + + THREAD_CACHE.with(|i| { + i.borrow_mut() + .insert(provider.configuration_url.clone(), conf.clone()) + }); + + return Ok(conf); + } + + // We can return immediately previously extracted value + Ok(config.unwrap()) + } + + /// Get fresh configuration from provider + async fn fetch_configuration(provider: &Provider) -> Res { + let discovery: ProviderDiscovery = reqwest::get(&provider.configuration_url) + .await? + .json() + .await?; + + // let keys: ProviderJWKs = reqwest::get(&discovery.jwks_uri).await?.json().await?; + + Ok(ProviderConfiguration { + discovery, + // keys, + expire: time() + OIDC_PROVIDERS_LIFETIME, + }) + } +} diff --git a/src/data/totp_key.rs b/src/data/totp_key.rs index 53adf13..00725ca 100644 --- a/src/data/totp_key.rs +++ b/src/data/totp_key.rs @@ -21,7 +21,7 @@ pub struct TotpKey { impl TotpKey { /// Generate a new TOTP key pub fn new_random() -> Self { - let random_bytes = rand::thread_rng().gen::<[u8; 10]>(); + let random_bytes = rand::thread_rng().gen::<[u8; 20]>(); Self { encoded: base32::encode(BASE32_ALPHABET, &random_bytes), } @@ -40,10 +40,10 @@ impl TotpKey { pub fn url_for_user(&self, u: &User, conf: &AppConfig) -> String { format!( "otpauth://totp/{}:{}?secret={}&issuer={}&algorithm=SHA1&digits={}&period={}", - urlencoding::encode(conf.domain_name()), + urlencoding::encode(conf.domain_name_without_port()), urlencoding::encode(&u.username), self.encoded, - urlencoding::encode(conf.domain_name()), + urlencoding::encode(conf.domain_name_without_port()), NUM_DIGITS, PERIOD, ) @@ -53,7 +53,7 @@ impl TotpKey { pub fn account_name(&self, u: &User, conf: &AppConfig) -> String { format!( "{}:{}", - urlencoding::encode(conf.domain_name()), + urlencoding::encode(conf.domain_name_without_port()), urlencoding::encode(&u.username) ) } diff --git a/src/data/user.rs b/src/data/user.rs index 1eb4ba7..c3aafb0 100644 --- a/src/data/user.rs +++ b/src/data/user.rs @@ -1,9 +1,11 @@ use std::collections::HashMap; use std::net::IpAddr; +use crate::actors::users_actor::AuthorizedAuthenticationSources; use crate::constants::SECOND_FACTOR_EXEMPTION_AFTER_SUCCESSFUL_LOGIN; use crate::data::client::{Client, ClientID}; use crate::data::login_redirect::LoginRedirect; +use crate::data::provider::{Provider, ProviderID}; use crate::data::totp_key::TotpKey; use crate::data::webauthn_manager::WebauthnPubKey; use crate::utils::time::{fmt_time, time}; @@ -114,6 +116,10 @@ impl Successful2FALogin { } } +fn default_true() -> bool { + true +} + #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)] pub struct User { pub uid: UserID, @@ -142,6 +148,14 @@ pub struct User { /// None = all services /// Some([]) = no service pub authorized_clients: Option>, + + /// Authorize connection through local login + #[serde(default = "default_true")] + pub allow_local_login: bool, + + /// Allowed third party providers + #[serde(default)] + pub allow_login_from_providers: Vec, } impl User { @@ -162,6 +176,19 @@ impl User { ) } + /// Get the list of sources from which a user can authenticate from + pub fn authorized_authentication_sources(&self) -> AuthorizedAuthenticationSources { + AuthorizedAuthenticationSources { + local: self.allow_local_login, + upstream: self.allow_login_from_providers.clone(), + } + } + + /// Check if a user can authenticate using a givne provider or not + pub fn can_login_from_provider(&self, provider: &Provider) -> bool { + self.allow_login_from_providers.contains(&provider.id) + } + pub fn granted_clients(&self) -> GrantedClients { match self.authorized_clients.as_deref() { None => GrantedClients::AllClients, @@ -296,6 +323,8 @@ impl Default for User { two_factor_exemption_after_successful_login: false, last_successful_2fa: Default::default(), authorized_clients: Some(Vec::new()), + allow_local_login: true, + allow_login_from_providers: vec![], } } } diff --git a/src/data/users_file_entity.rs b/src/data/users_file_entity.rs index b7c08c6..176664a 100644 --- a/src/data/users_file_entity.rs +++ b/src/data/users_file_entity.rs @@ -1,6 +1,6 @@ use std::net::IpAddr; -use crate::actors::users_actor::UsersSyncBackend; +use crate::actors::users_actor::{AuthorizedAuthenticationSources, UsersSyncBackend}; use crate::data::entity_manager::EntityManager; use crate::data::user::{FactorID, GeneralSettings, GrantedClients, TwoFactor, User, UserID}; use crate::utils::err::{new_error, Res}; @@ -41,6 +41,15 @@ fn verify_password>(pwd: P, hash: &str) -> bool { } impl UsersSyncBackend for EntityManager { + fn find_by_email(&self, u: &str) -> Res> { + for entry in self.iter() { + if entry.email.eq(u) { + return Ok(Some(entry.clone())); + } + } + Ok(None) + } + fn find_by_username_or_email(&self, u: &str) -> Res> { for entry in self.iter() { if entry.username.eq(u) || entry.email.eq(u) { @@ -143,6 +152,18 @@ impl UsersSyncBackend for EntityManager { self.remove(&user) } + fn set_authorized_authentication_sources( + &mut self, + id: &UserID, + sources: AuthorizedAuthenticationSources, + ) -> Res { + self.update_user(id, |mut user| { + user.allow_local_login = sources.local; + user.allow_login_from_providers = sources.upstream; + user + }) + } + fn set_granted_2fa_clients(&mut self, id: &UserID, clients: GrantedClients) -> Res { self.update_user(id, |mut user| { user.authorized_clients = clients.to_user(); diff --git a/src/main.rs b/src/main.rs index 975590c..1093f87 100644 --- a/src/main.rs +++ b/src/main.rs @@ -12,6 +12,7 @@ use actix_web::{get, middleware, web, App, HttpResponse, HttpServer}; use basic_oidc::actors::bruteforce_actor::BruteForceActor; use basic_oidc::actors::openid_sessions_actor::OpenIDSessionsActor; +use basic_oidc::actors::providers_states_actor::ProvidersStatesActor; use basic_oidc::actors::users_actor::{UsersActor, UsersSyncBackend}; use basic_oidc::constants::*; use basic_oidc::controllers::assets_controller::assets_route; @@ -20,6 +21,7 @@ use basic_oidc::data::app_config::AppConfig; use basic_oidc::data::client::ClientManager; use basic_oidc::data::entity_manager::EntityManager; use basic_oidc::data::jwt_signer::JWTSigner; +use basic_oidc::data::provider::ProvidersManager; use basic_oidc::data::user::User; use basic_oidc::data::webauthn_manager::WebAuthManager; use basic_oidc::middlewares::auth_middleware::AuthMiddleware; @@ -68,6 +70,7 @@ async fn main() -> std::io::Result<()> { let users_actor = UsersActor::new(users).start(); let bruteforce_actor = BruteForceActor::default().start(); + let providers_states_actor = ProvidersStatesActor::default().start(); let openid_sessions_actor = OpenIDSessionsActor::default().start(); let jwt_signer = JWTSigner::gen_from_memory().expect("Failed to generate JWKS key"); let webauthn_manager = Arc::new(WebAuthManager::init(config)); @@ -77,6 +80,11 @@ async fn main() -> std::io::Result<()> { clients.apply_environment_variables(); let clients = Arc::new(clients); + let mut providers = ProvidersManager::open_or_create(config.providers_file()) + .expect("Failed to load providers list!"); + providers.apply_environment_variables(); + let providers = Arc::new(providers); + log::info!("Server will listen on {}", config.listen_address); let listen_address = config.listen_address.to_string(); @@ -99,8 +107,10 @@ async fn main() -> std::io::Result<()> { App::new() .app_data(web::Data::new(users_actor.clone())) .app_data(web::Data::new(bruteforce_actor.clone())) + .app_data(web::Data::new(providers_states_actor.clone())) .app_data(web::Data::new(openid_sessions_actor.clone())) .app_data(web::Data::new(clients.clone())) + .app_data(web::Data::new(providers.clone())) .app_data(web::Data::new(jwt_signer.clone())) .app_data(web::Data::new(webauthn_manager.clone())) .wrap( @@ -110,7 +120,7 @@ async fn main() -> std::io::Result<()> { .wrap(AuthMiddleware {}) .wrap(identity_middleware) .wrap(session_mw) - // main route + // Main route .route( "/", web::get().to(|| async { @@ -120,7 +130,7 @@ async fn main() -> std::io::Result<()> { }), ) .route("/robots.txt", web::get().to(assets_controller::robots_txt)) - // health route + // Health route .service(health) // Assets serving .route("/assets/{path:.*}", web::get().to(assets_route)) @@ -151,6 +161,15 @@ async fn main() -> std::io::Result<()> { "/login/api/auth_webauthn", web::post().to(login_api::auth_webauthn), ) + // Providers controller + .route( + "/login_with_prov", + web::get().to(providers_controller::start_login), + ) + .route( + OIDC_PROVIDER_CB_URI, + web::get().to(providers_controller::finish_login), + ) // Settings routes .route( "/settings", @@ -207,6 +226,10 @@ async fn main() -> std::io::Result<()> { "/admin/clients", web::get().to(admin_controller::clients_route), ) + .route( + "/admin/providers", + web::get().to(admin_controller::providers_route), + ) .route("/admin/users", web::get().to(admin_controller::users_route)) .route( "/admin/users", diff --git a/templates/login/base_login_page.html b/templates/login/base_login_page.html index ea9caff..00b83d8 100644 --- a/templates/login/base_login_page.html +++ b/templates/login/base_login_page.html @@ -30,8 +30,6 @@ font-size: 3.5rem; } } - - @@ -45,7 +43,7 @@
-

{{ _p.page_title }}

+

{{ _p.page_title }}

{% if let Some(danger) = _p.danger %}