rocket_auth

rocketauth provides a ready-to-use backend agnostic API for authentication management. For more information visit the documentation at https://docs.rs/rocketauth. It supports connections for SQLite and Postgresql. It lets you create, delete, and authenticate users. The available features are: * sqlite-db: for interacting with a SQLite database. * postgres-db: for interacting with a Postgresql database. * redis-session: for storing sessions on a redis server.

By default this crate stores sessions on a concurrent hashmap. As a result, sessions will only be stored as long as the rocket application runs uninterrupted. In order to store persistent sessions, it is recommended to connect the Users(Users::open_redis) instance to a redis server . This requires the redis-session feature to be enabled.

rocket_auth uses private cookies to store session data. This means that in order for cookies to be properly decrypted between launches, a secret_key must be set. For more information visit rocket's configuration guide.

To use rocket_auth include it as a dependency in your Cargo.toml file: ini [dependencies.rocket_auth] version = "0.2.1" features = ["sqlite-db", "redis-session"]

Quick overview

This crate provides two guards: * Auth: manages authentication. * Session: retrieves session data from client cookies. * User: It restricts content, so it can be viewed by authenticated clients only.

It also includes two structs to be parsed from forms and json data: * Signup: used to create new users. * Login: used to authenticate users.

Finally it has two structures for queries: * Users: it allows to query users to the database. * User: it is the response of a query.

The Auth guard allows to log in, log out, sign up, modify, and delete the currently (un)authenticated user. For more information see Auth. Because of rust's ownership rules, you may not retrieve both rocket::http::Cookies and the Auth guard simultaneously. However, retrieveng cookies is not needed since Auth stores them in the public field Auth::cookies. A working example: ```rust,norun use rocket::{get, post, Form}; use rocketauth::{Users, Error, Auth, Signup, Login};

[post("/signup", data="

")]

fn signup(form: Form, mut auth: Auth) { auth.signup(&form); }

[post("/login", data="")]

fn login(form: Form, mut auth: Auth) { auth.login(&form); }

[get("/logout")]

fn logout(mut auth: Auth) { auth.logout(); }

fn main() -> Result<(), Error>{ let users = Users::open_sqlite("mydb.db")?;

rocket::ignite() .mount("/", routes/[signup, login, logout]) .manage(users) .launch(); Ok(()) } ```

Users struct

The Users struct administers interactions with the database. It lets you query, create, modify and delete users. Unlike the Auth guard, a Users instance can manage any user in the database. Note that the Auth guards includes a Users instance stored on the public users field. So it is not necesary to retrieve Users when using Auth. A simple example of how to query a user with the Users struct:

```rust

[get("see-user/")]

fn seeuser(id: i32, users: State) -> String { let user = users.getby_id(id); fortmat!("{}", json!(user)) } ```

A Users instance can be constructed by connecting it to the database with the methods open_sqlite(Users::opensqlite), open_postgres(Users::openpostgres). Furthermore, it can be constructed from a working connection.

User guard

The User guard can be used to restrict content so it can only be viewed by authenticated users. Additionally, yo can use it to render special content if the client is authenticated or not. ```rust #[get("/private-content")] fn private_content(user: User) -> &'static str { "If you can see this, you are logged in." }

[get("/special-content")]

fn special_content(option: Option) -> String { if let Some(user) = option { format!("hello, {}.", user.email) } else { "hello, anonymous user".into() } } ```