1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
use crate::api::discord::global_discord_client;
use crate::api::rcos::users::accounts::for_user::UserAccounts;
use crate::api::rcos::users::accounts::unlink::UnlinkUserAccount;
use crate::api::rcos::users::UserAccountType;
use crate::env::global_config;
use crate::error::TelescopeError;
use crate::web::services::auth::identity::{AuthenticationCookie, Identity};
use crate::web::services::auth::oauth2_providers::discord::DiscordOAuth;
use crate::web::services::auth::rpi_cas::RpiCas;
use actix_web::http::header::{HOST, LOCATION};
use actix_web::web::ServiceConfig;
use actix_web::{web as aweb, Responder};
use actix_web::{HttpRequest, HttpResponse};
use futures::future::LocalBoxFuture;
use oauth2::RedirectUrl;
use oauth2_providers::github::GitHubOauth;
use std::collections::HashMap;
use std::future::Future;
pub mod identity;
pub mod oauth2_providers;
pub mod rpi_cas;
/// The types of user accounts that provide authentication.
const AUTHENTICATOR_ACCOUNT_TYPES: [UserAccountType; 3] = [
UserAccountType::Rpi,
UserAccountType::GitHub,
UserAccountType::Discord,
];
/// Register auth services.
pub fn register(config: &mut ServiceConfig) {
// GitHub OAuth2 provider services.
GitHubOauth::register_services(config);
// Discord OAuth2 provider services.
DiscordOAuth::register_services(config);
// RPI CAS provider services.
RpiCas::register_services(config);
}
/// Function to create the redirect URL for a given request and identity provider's
/// redirect path.
fn make_redirect_url(req: &HttpRequest, redir_path: String) -> RedirectUrl {
// Get the host header to determine where to redirect the user to.
// This should be the base for one of the identity provider's redirect
// paths.
let address: &str = req
.headers()
.get(HOST)
.expect("Could not get host header from request.")
.to_str()
.expect("Host request header is not ascii characters");
// Create and return redirect URL.
return RedirectUrl::new(format!("https://{}{}", address, redir_path))
.expect("Could not create redirect URL");
}
/// Trait for identity providers (GitHub OAuth2, Discord OAuth2, RPI CAS, etc).
pub trait IdentityProvider: 'static {
/// The lowercase, one word name of the service. This is used in generating
/// redirect paths and registering the service with actix. It must be unique.
const SERVICE_NAME: &'static str;
/// The type of user account represented by this authentication service.
const USER_ACCOUNT_TY: UserAccountType;
/// Get the login path of this service. This is the route in actix that will
/// redirect to the authorization page using the handler function also defined
/// in this trait.
fn login_path() -> String {
format!("/login/{}", Self::SERVICE_NAME)
}
/// Get the registration path of this service. This is the route in actix that
/// will redirect to the authorization page using the handler also defined by
/// this trait. This is similar to [`Self::login_path`] but is for account
/// registration rather than sign in.
fn register_path() -> String {
format!("/register/{}", Self::SERVICE_NAME)
}
/// The path to link this identity service. This is similar to the other two,
/// but is intended to be used to link an existing account.
fn link_path() -> String {
format!("/link/{}", Self::SERVICE_NAME)
}
/// The path to unlink this service from the user's account.
fn unlink_path() -> String {
format!("/unlink/{}", Self::SERVICE_NAME)
}
/// The path for the identity provider to redirect back to after authenticating
/// a user for login. This path is also registered under actix with the
/// authentication callback handler defined by this trait.
fn login_redirect_path() -> String {
format!("/auth/{}/login", Self::SERVICE_NAME)
}
/// The path for the identity provider to redirect back to after authenticating
/// a user for account creation. This path is also registered under actix with
/// the authentication callback handler defined by this trait.
fn registration_redirect_path() -> String {
format!("/auth/{}/register", Self::SERVICE_NAME)
}
/// The path to redirect back to after account linking success. This is
/// similar to the login and registration authenticated redirect paths.
fn link_redirect_path() -> String {
format!("/auth/{}/link", Self::SERVICE_NAME)
}
/// The type used to respond to login requests.
type LoginResponse: Responder;
/// The type used to respond to registration requests.
type RegistrationResponse: Responder;
/// The type used to respond to account linking requests.
type LinkResponse: Responder;
/// The type of future returned by the login handler.
type LoginFut: Future<Output = Self::LoginResponse> + 'static;
/// The type of the future returned by the registration handler.
type RegistrationFut: Future<Output = Self::RegistrationResponse> + 'static;
/// The type of the future returned by the account linking handler.
type LinkFut: Future<Output = Self::LinkResponse> + 'static;
/// The type of future returned by the login authenticated response handler.
type LoginAuthenticatedFut: Future<Output = Result<HttpResponse, TelescopeError>> + 'static;
/// The type of future returned by the registration authenticated response handler.
type RegistrationAuthenticatedFut: Future<Output = Result<HttpResponse, TelescopeError>>
+ 'static;
/// The type of future returned by the registration authenticated response handler.
type LinkAuthenticatedFut: Future<Output = Result<HttpResponse, TelescopeError>> + 'static;
/// Register the necessary actix services to support this identity
/// provider.
fn register_services(config: &mut ServiceConfig) {
config
.route(
Self::register_path().as_str(),
aweb::get().to(Self::registration_handler),
)
.route(
Self::login_path().as_str(),
aweb::get().to(Self::login_handler),
)
.route(
Self::link_path().as_str(),
aweb::get().to(Self::link_handler),
)
.route(
Self::unlink_path().as_str(),
aweb::get().to(Self::unlink_handler),
)
.route(
Self::login_redirect_path().as_str(),
aweb::get().to(Self::login_authenticated_handler),
)
.route(
Self::registration_redirect_path().as_str(),
aweb::get().to(Self::registration_authenticated_handler),
)
.route(
Self::link_redirect_path().as_str(),
aweb::get().to(Self::linking_authenticated_handler),
);
}
/// Actix-web handler for the route that redirects to authentication for
/// login. Guarded by this trait to GET requests.
fn login_handler(req: HttpRequest) -> Self::LoginFut;
/// Actix-web handler for the route that redirects to authentication for
/// account creation (user registration). Guarded by this
/// trait to GET requests.
fn registration_handler(req: HttpRequest) -> Self::RegistrationFut;
/// Actix-web handler for the route that redirects to the authentication provider
/// to link an account.
///
/// Linking an account will authenticate with the identity provider and then insert
/// the account into the RCOS database via the API. If there is already an account linked,
/// then the account's platform ID will be checked against the ID of the linked account.
/// If it matches then the auth cookie is modified, and we return a successful response.
/// If it does not match, we forget the new account and tell the user to unlink their
/// existing account on this platform first.
fn link_handler(req: HttpRequest, ident: Identity) -> Self::LinkFut;
/// Actix-web handler for the route that unlinks an identity service.
fn unlink_handler(
id: Identity,
mut cookie: AuthenticationCookie,
) -> LocalBoxFuture<'static, Result<HttpResponse, TelescopeError>> {
return Box::pin(async move {
// Lookup the ID of the user trying to unlink an account.
let user_id = cookie.get_user_id_or_error().await?;
// Get all of the accounts linked to this user. Make sure at least one
// can function for authentication.
let all_accounts: HashMap<UserAccountType, String> = UserAccounts::send(user_id)
.await?
// Iterate
.into_iter()
// filter down to the authentication providers
.filter(|(u, _)| AUTHENTICATOR_ACCOUNT_TYPES.contains(u))
// Collect into map.
.collect();
// If there is not a secondary account for the user to authenticate with,
// return an error.
if all_accounts.len() <= 1 {
return Err(TelescopeError::BadRequest {
header: format!("Cannot unlink {} account", Self::USER_ACCOUNT_TY),
message: "You have no other authentication methods linked, so unlinking \
this platform would prevent you from logging in."
.into(),
show_status_code: false,
});
}
// If the user is unlinking their Discord or RPI CAS, we remove them from the
// RCOS Discord Server.
match Self::USER_ACCOUNT_TY {
UserAccountType::Rpi | UserAccountType::Discord => {
// Lookup and parse the user's Discord ID.
let user_discord = all_accounts
.get(&UserAccountType::Discord)
.and_then(|string| string.as_str().parse::<u64>().ok());
if let Some(discord_id) = user_discord {
// Get RCOS Discord ID.
let rcos_discord = global_config().discord_config.rcos_guild_id();
// Kick user from RCOS Discord.
global_discord_client()
.kick_member(rcos_discord, discord_id)
.await
.map_err(TelescopeError::serenity_error)?
}
}
_ => {}
}
// Important: The root must be replaced with another platform (if possible)
// before the unlink mutation is executed. Doing this in the other order will
// lead to an account not found error while trying to replace the root of the
// auth cookie because the account lookup will fail/error out.
// See https://github.com/rcos/Telescope/issues/185.
// Try to replace the unlinking account in the authentication cookie's root
// (if it's authenticated as root).
let removed_auth: bool = cookie.remove_platform(Self::USER_ACCOUNT_TY).await?;
// If this is a success, then save the modified authentication cookie and redirect
// the user to their profile at the end.
// If not, the user has been logged out. Redirect them to the homepage at the end.
if removed_auth {
id.save(&cookie);
} else {
id.forget();
}
// There is a secondary authenticator linked, delete this user account record.
// Log a message about the unlinked platform.
let platform_id = UnlinkUserAccount::send(user_id, Self::USER_ACCOUNT_TY).await?;
if let Some(platform_id) = platform_id {
info!(
"User {} unlinked {} account with id {}.",
user_id,
Self::USER_ACCOUNT_TY,
platform_id
);
}
// Get the path to redirect the user to.
let redirect: String = removed_auth
// If the auth was replaced successfully, the user's profile.
.then(|| format!("/user/{}", user_id))
// Otherwise the homepage.
.unwrap_or("/".into());
return Ok(HttpResponse::Found().header(LOCATION, redirect).finish());
});
}
/// Actix-web handler for authentication callback to login. Guarded by this
/// trait to GET requests.
fn login_authenticated_handler(req: HttpRequest) -> Self::LoginAuthenticatedFut;
/// Actix-web handler for authentication callback to account creation.
/// Guarded by this trait to GET requests.
fn registration_authenticated_handler(req: HttpRequest) -> Self::RegistrationAuthenticatedFut;
/// Actix-web handler
fn linking_authenticated_handler(
req: HttpRequest,
ident: Identity,
) -> Self::LinkAuthenticatedFut;
}