actix_web_security/
lib.rs

1//! # actix-web-security
2//! Basic-Auth / OAuth2 easy-to-use authentication modules for actix web.
3//!
4//! ## Features
5//!
6//! * HTTP Authentication with the following authentication schemes
7//!   * Basic Authentication
8//!   * Bearer Authentication
9//! * OAuth2 Resource Server "Auto-Configuration"
10//! * JWK-Downloader to verify JWTs
11//! * JWT verification
12//!
13//! ## Note: Neither audited nor penetration tested
14//! This library is provided "as is" without warranties of any kind and is not verified to be secure.
15//! It has neither been audited to be safe in an audit nor been penetration tested.
16//! The library was developed to the best of knowledge and belief.
17//! It's in your own responsibility to check the code for potential security issues or bugs and your own decision
18//! whether you see the code as safe and trustworthy or whether you prefer to not use it.
19//! The library is provided as open-source and the liability of any kind is excluded as described in the licenses
20//! the software is provided under.
21//!
22//! ## Install
23//! Add the following dependency to your `cargo.toml`.
24//!
25//! ```toml
26//! actix-web-security = "0.1.0"
27//! ```
28//!
29//! The following features can be activated:
30//! * `jwk-loader`  
31//!   This feature can be activated to download custom JWKs from an authorization server
32//!   ```toml
33//!   actix-web-security = { version="0.1.0", features = ["jwk-loader"] }
34//!   ```
35//!
36//! * `jwk-default-loader`  
37//!   This feature can be activated to download `DefaultJwks` from an authorization server.
38//!   ```toml
39//!   actix-web-security = { version="0.1.0", features = ["jwk-default-loader"] }
40//!   ```
41//!
42//! Both features require `openssl` to be installed on the system.
43//! The documentation about how to install it can be found [here](https://docs.rs/openssl/0.10.32/openssl/#automatic).
44//!
45//! ## Samples
46//! Sample applications can be found [here](https://github.com/cschaible/actix-web-security-samples).
47
48pub mod authentication;
49pub mod user_details;