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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
use std::sync::Arc;

use axum::{
    http::{
        header::{AUTHORIZATION, REFERER},
        Request,
    },
    middleware::Next,
};

use adapter::{prelude::*, primitives::Session as AdapterSession};
use primitives::{analytics::AuthenticateAs, ValidatorId};

use crate::{response::ResponseError, Application, Auth, Session};

pub async fn is_admin<C: Locked + 'static, B>(
    request: axum::http::Request<B>,
    next: Next<B>,
) -> Result<axum::response::Response, ResponseError> {
    let auth = request
        .extensions()
        .get::<Auth>()
        .ok_or(ResponseError::Unauthorized)?;

    let config = &request
        .extensions()
        .get::<Arc<Application<C>>>()
        .expect("Application should always be present")
        .config;

    if !config.sentry.admins.contains(auth.uid.as_address()) {
        return Err(ResponseError::Unauthorized);
    }
    Ok(next.run(request).await)
}

pub async fn authentication_required<C: Locked + 'static, B>(
    request: axum::http::Request<B>,
    next: Next<B>,
) -> Result<axum::response::Response, ResponseError> {
    if request.extensions().get::<Auth>().is_some() {
        Ok(next.run(request).await)
    } else {
        Err(ResponseError::Unauthorized)
    }
}

/// Creates a [`Session`] and additionally [`Auth`] if a Bearer token was provided.
///
/// Check `Authorization` header for `Bearer` scheme with `Adapter::session_from_token`.
/// If the `Adapter` fails to create an `AdapterSession`, `ResponseError::BadRequest` will be returned.
pub async fn authenticate<C: Locked + 'static, B>(
    mut request: axum::http::Request<B>,
    next: Next<B>,
) -> Result<axum::response::Response, ResponseError> {
    let (adapter, redis) = {
        let app = request
            .extensions()
            .get::<Arc<Application<C>>>()
            .expect("Application should always be present");

        (app.adapter.clone(), app.redis.clone())
    };

    let referrer = request
        .headers()
        .get(REFERER)
        .and_then(|hv| hv.to_str().ok().map(ToString::to_string));

    let session = Session {
        ip: get_request_ip(&request),
        country: None,
        referrer_header: referrer,
        os: None,
    };
    request.extensions_mut().insert(session);

    let authorization = request.headers().get(AUTHORIZATION);

    let prefix = "Bearer ";

    let token = authorization
        .and_then(|hv| {
            hv.to_str()
                .map(|token_str| token_str.strip_prefix(prefix))
                .transpose()
        })
        .transpose()?;

    if let Some(token) = token {
        let adapter_session = match redis::cmd("GET")
            .arg(token)
            .query_async::<_, Option<String>>(&mut redis.clone())
            .await?
            .and_then(|session_str| serde_json::from_str::<AdapterSession>(&session_str).ok())
        {
            Some(adapter_session) => adapter_session,
            None => {
                // If there was a problem with the Session or the Token, this will error
                // and a BadRequest response will be returned
                let adapter_session = adapter.session_from_token(token).await?;

                // save the Adapter Session to Redis for the next request
                // if serde errors on deserialization this will override the value inside
                redis::cmd("SET")
                    .arg(token)
                    .arg(serde_json::to_string(&adapter_session)?)
                    .query_async(&mut redis.clone())
                    .await?;

                adapter_session
            }
        };

        let auth = Auth {
            era: adapter_session.era,
            uid: ValidatorId::from(adapter_session.uid),
            chain: adapter_session.chain,
        };

        request.extensions_mut().insert(auth);
    }

    Ok(next.run(request).await)
}

pub async fn authenticate_as_advertiser<B>(
    mut request: axum::http::Request<B>,
    next: Next<B>,
) -> Result<axum::response::Response, ResponseError> {
    let auth_uid = request
        .extensions()
        .get::<Auth>()
        .ok_or(ResponseError::Unauthorized)?
        .uid;

    let previous = request
        .extensions_mut()
        .insert(AuthenticateAs::Advertiser(auth_uid));

    assert!(
        previous.is_none(),
        "Should not contain previous value of AuthenticateAs"
    );

    Ok(next.run(request).await)
}

pub async fn authenticate_as_publisher<B>(
    mut request: axum::http::Request<B>,
    next: Next<B>,
) -> Result<axum::response::Response, ResponseError> {
    let auth_uid = request
        .extensions()
        .get::<Auth>()
        .ok_or(ResponseError::Unauthorized)?
        .uid;

    let previous = request
        .extensions_mut()
        .insert(AuthenticateAs::Publisher(auth_uid));

    assert!(
        previous.is_none(),
        "Should not contain previous value of AuthenticateAs"
    );

    Ok(next.run(request).await)
}

/// Get's the Request IP from either `true-client-ip` or `x-forwarded-for`,
/// splits the IPs separated by `,` (comma) and returns the first one.
fn get_request_ip<B>(req: &Request<B>) -> Option<String> {
    req.headers()
        .get("true-client-ip")
        .or_else(|| req.headers().get("x-forwarded-for"))
        .and_then(|hv| {
            hv.to_str()
                // filter out empty headers
                .map(ToString::to_string)
                .ok()
                .filter(|ip| !ip.is_empty())
        })
        .and_then(|token| {
            token
                .split(',')
                .next()
                // filter out empty IP
                .filter(|ip| !ip.is_empty())
                .map(ToString::to_string)
        })
}

#[cfg(test)]
mod test {
    use std::collections::HashMap;

    use axum::{
        body::Body,
        http::{Request, StatusCode},
        middleware::from_fn,
        routing::get,
        Extension, Router,
    };
    use tower::{Service, ServiceBuilder};

    use adapter::{
        dummy::{Dummy, HeaderToken},
        ethereum::test_util::GANACHE_1,
    };
    use primitives::test_util::{ADVERTISER, DUMMY_AUTH, FOLLOWER, IDS, LEADER, PUBLISHER};

    use crate::{
        test_util::{body_to_string, setup_dummy_app},
        Session,
    };

    use super::*;

    #[tokio::test]
    async fn test_is_admin() {
        let app_guard = setup_dummy_app().await;
        let app = Arc::new(app_guard.app);

        let admin = {
            assert!(
                app.config.sentry.admins.contains(&LEADER),
                "Should contain the Leader as an Admin for this test!"
            );
            IDS[&LEADER]
        };

        let not_admin = {
            assert!(
                !app.config.sentry.admins.contains(&FOLLOWER),
                "Should not contain the Follower as an Admin for this test!"
            );

            IDS[&FOLLOWER]
        };

        async fn handle() -> String {
            "Ok".into()
        }

        let mut router = Router::new()
            .route("/", get(handle))
            .layer(from_fn(is_admin::<Dummy, _>));

        // No Auth - Unauthorized
        {
            let no_auth = Request::builder()
                .extension(app.clone())
                .body(Body::empty())
                .expect("should never fail!");

            let response = router
                .call(no_auth)
                .await
                .expect("Should make request to Router");
            assert_eq!(StatusCode::UNAUTHORIZED, response.status());
        }

        // Not an Admin - Unauthorized
        {
            let not_admin_request = Request::builder()
                .extension(app.clone())
                .extension(Auth {
                    era: 1,
                    uid: not_admin,
                    chain: GANACHE_1.clone(),
                })
                .body(Body::empty())
                .expect("should never fail!");

            let response = router
                .call(not_admin_request)
                .await
                .expect("Should make request to Router");
            assert_eq!(StatusCode::UNAUTHORIZED, response.status());
        }

        // An Admin - Ok
        {
            let not_admin_request = Request::builder()
                .extension(app.clone())
                .extension(Auth {
                    era: 1,
                    uid: admin,
                    chain: GANACHE_1.clone(),
                })
                .body(Body::empty())
                .expect("should never fail!");

            let response = router
                .call(not_admin_request)
                .await
                .expect("Should make request to Router");
            assert_eq!(StatusCode::OK, response.status());
        }
    }

    #[tokio::test]
    async fn no_authentication_or_incorrect_value_should_not_add_session() {
        let app_guard = setup_dummy_app().await;
        let app = Arc::new(app_guard.app);

        async fn handle() -> String {
            "Ok".into()
        }

        let mut router = Router::new()
            .route("/", get(handle))
            .layer(from_fn(authenticate::<Dummy, _>));

        {
            let no_auth_req = Request::builder()
                .extension(app.clone())
                .body(Body::empty())
                .expect("should never fail!");

            let no_auth = router
                .call(no_auth_req)
                .await
                .expect("Handling the Request shouldn't have failed");

            assert!(
                no_auth.extensions().get::<Auth>().is_none(),
                "There shouldn't be a Auth in the extensions"
            );
        }

        // there is a Header, but it has wrong format
        {
            let incorrect_auth_req = Request::builder()
                .header(AUTHORIZATION, "Wrong Header")
                .extension(app.clone())
                .body(Body::empty())
                .expect("should never fail!");

            let incorrect_auth = router
                .call(incorrect_auth_req)
                .await
                .expect("Handling the Request shouldn't have failed");

            assert!(
                incorrect_auth.extensions().get::<Auth>().is_none(),
                "There shouldn't be an Auth in the extensions"
            );
        }

        // Token doesn't exist in the Adapter nor in Redis
        {
            let non_existent_token_req = Request::builder()
                .header(AUTHORIZATION, "Bearer wrong-token")
                .extension(app.clone())
                .body(Body::empty())
                .unwrap();

            let response = router
                .call(non_existent_token_req)
                .await
                .expect("Handling the Request shouldn't have failed");

            assert_eq!(response.status(), StatusCode::BAD_REQUEST);
            let response_body =
                serde_json::from_str::<HashMap<String, String>>(&body_to_string(response).await)
                    .expect("Should deserialize");
            assert_eq!("Authentication: Dummy Authentication token format should be in the format: `{Auth Token}:chain_id:{Chain Id}` but 'wrong-token' was provided", response_body["message"])
        }
    }

    #[tokio::test]
    async fn session_from_correct_authentication_token() {
        let app_guard = setup_dummy_app().await;
        let app = Arc::new(app_guard.app);

        let header_token = HeaderToken {
            token: DUMMY_AUTH[&LEADER].clone(),
            chain_id: GANACHE_1.chain_id,
        };

        async fn handle(
            Extension(auth): Extension<Auth>,
            Extension(session): Extension<Session>,
        ) -> String {
            assert_eq!(Some("120.0.0.1".to_string()), session.ip);
            assert_eq!(*LEADER, auth.uid.to_address());

            "Ok".into()
        }

        let mut router = Router::new()
            .route("/", get(handle))
            .layer(from_fn(authenticate::<Dummy, _>));

        let auth_header = format!("Bearer {header_token}");
        let request = Request::builder()
            .header(AUTHORIZATION, auth_header)
            .header("true-client-ip", "120.0.0.1")
            .extension(app.clone())
            .body(Body::empty())
            .unwrap();

        // The handle takes care of the assertions for the Extensions for us
        let response = router
            .call(request)
            .await
            .expect("Valid requests should succeed");

        assert_eq!("Ok", body_to_string(response).await);
    }

    #[test]
    fn test_get_request_ip_headers() {
        let build_request = |header: &str, ips: &str| -> Request<Body> {
            Request::builder()
                .header(header, ips)
                .body(Body::empty())
                .unwrap()
        };

        // No set headers
        {
            let request = Request::builder().body(Body::empty()).unwrap();
            let no_headers = get_request_ip(&request);
            assert_eq!(None, no_headers);
        }

        // Empty headers
        {
            let true_client_ip = build_request("true-client-ip", "");
            let x_forwarded_for = build_request("x-forwarded-for", "");

            let actual_true_client = get_request_ip(&true_client_ip);
            let actual_x_forwarded = get_request_ip(&x_forwarded_for);

            assert_eq!(None, actual_true_client);
            assert_eq!(None, actual_x_forwarded);
        }

        // Empty IPs `","`
        {
            let true_client_ip = build_request("true-client-ip", ",");
            let x_forwarded_for = build_request("x-forwarded-for", ",");

            let actual_true_client = get_request_ip(&true_client_ip);
            let actual_x_forwarded = get_request_ip(&x_forwarded_for);

            assert_eq!(None, actual_true_client);
            assert_eq!(None, actual_x_forwarded);
        }

        // "true-client-ip" - Single IP
        {
            let ips = "120.0.0.1";
            let true_client_ip = build_request("true-client-ip", ips);
            let actual_ips = get_request_ip(&true_client_ip);

            assert_eq!(Some(ips.to_string()), actual_ips);
        }

        // "x-forwarded-for" - Multiple IPs
        {
            let ips = "192.168.0.1,120.0.0.1,10.0.0.10";
            let true_client_ip = build_request("x-forwarded-for", ips);
            let actual_ips = get_request_ip(&true_client_ip);

            assert_eq!(Some("192.168.0.1".to_string()), actual_ips);
        }
    }

    #[tokio::test]
    async fn test_authenticate_as_advertiser_and_publisher() {
        let build_request = |auth: Option<Auth>| {
            let mut request = Request::builder().uri(format!("/"));

            if let Some(auth) = auth {
                request = request.extension(auth);
            }

            request.body(Body::empty()).expect("Should build Request")
        };

        #[derive(Debug, Clone, Copy)]
        pub enum TestFor {
            Advertiser,
            Publisher,
        }

        async fn handle(
            Extension(auth_as): Extension<AuthenticateAs>,
            Extension(test_for): Extension<TestFor>,
        ) -> StatusCode {
            match (auth_as, test_for) {
                (AuthenticateAs::Advertiser(_addr), TestFor::Advertiser)
                | (AuthenticateAs::Publisher(_addr), TestFor::Publisher) => StatusCode::OK,
                _ => StatusCode::BAD_REQUEST,
            }
        }

        // Advertiser
        {
            let mut router = Router::new().route(
                "/",
                get(handle).route_layer(
                    ServiceBuilder::new()
                        .layer(Extension(TestFor::Advertiser))
                        .layer(from_fn(authenticate_as_advertiser)),
                ),
            );

            // No Auth, should return Unauthorized
            {
                let request = build_request(None);

                let response = router
                    .call(request)
                    .await
                    .expect("Should make request to Router");

                assert_eq!(
                    StatusCode::UNAUTHORIZED,
                    response.status(),
                    "Should be unauthorized"
                )
            }

            // AuthenticateAs::Advertiser - OK
            {
                let request = build_request(Some(Auth {
                    era: 1,
                    uid: IDS[&ADVERTISER],
                    chain: GANACHE_1.clone(),
                }));

                let response = router
                    .call(request)
                    .await
                    .expect("Should make request to Router");

                assert_eq!(
                    StatusCode::OK,
                    response.status(),
                    "Should be authenticated as Advertiser!"
                )
            }
        }

        // Publisher
        {
            let mut router = Router::new().route(
                "/",
                get(handle).route_layer(
                    ServiceBuilder::new()
                        .layer(Extension(TestFor::Publisher))
                        .layer(from_fn(authenticate_as_publisher)),
                ),
            );

            // No Auth, should return Unauthorized
            {
                let request = build_request(None);

                let response = router
                    .call(request)
                    .await
                    .expect("Should make request to Router");

                assert_eq!(
                    StatusCode::UNAUTHORIZED,
                    response.status(),
                    "Should be unauthorized"
                )
            }

            // AuthenticateAs::Publisher - OK
            {
                let request = build_request(Some(Auth {
                    era: 1,
                    uid: IDS[&PUBLISHER],
                    chain: GANACHE_1.clone(),
                }));

                let response = router
                    .call(request)
                    .await
                    .expect("Should make request to Router");

                assert_eq!(
                    StatusCode::OK,
                    response.status(),
                    "Should be authenticated as Publisher!"
                )
            }
        }
    }

    #[tokio::test]
    #[should_panic]
    async fn test_authenticate_as_advertiser_panic() {
        async fn handle(Extension(_auth_as): Extension<AuthenticateAs>) -> String {
            "It should have panicked at this point".into()
        }

        let mut router = Router::new().route(
            "/",
            get(handle).route_layer(from_fn(authenticate_as_advertiser)),
        );

        let auth = Auth {
            era: 1,
            uid: IDS[&ADVERTISER],
            chain: GANACHE_1.clone(),
        };

        let request = Request::builder()
            .uri(format!("/"))
            .extension(auth.clone())
            .extension(AuthenticateAs::Advertiser(auth.uid))
            .body(Body::empty())
            .expect("Should build Request");

        let _response = router
            .call(request)
            .await
            .expect("Should make request to Router");
    }

    #[tokio::test]
    #[should_panic]
    async fn test_authenticate_as_publisher_panic() {
        async fn handle(Extension(_auth_as): Extension<AuthenticateAs>) -> String {
            "It should have panicked at this point".into()
        }

        let mut router = Router::new().route(
            "/",
            get(handle).route_layer(from_fn(authenticate_as_publisher)),
        );

        let auth = Auth {
            era: 1,
            uid: IDS[&PUBLISHER],
            chain: GANACHE_1.clone(),
        };

        let request = Request::builder()
            .uri(format!("/"))
            .extension(auth.clone())
            .extension(AuthenticateAs::Publisher(auth.uid))
            .body(Body::empty())
            .expect("Should build Request");

        let _response = router
            .call(request)
            .await
            .expect("Should make request to Router");
    }
}