Go to file
kjuulh 393be43db1
All checks were successful
ci/woodpecker/push/test Pipeline was successful
feat: dummy change
Signed-off-by: kjuulh <contact@kjuulh.io>
2023-11-01 21:26:35 +01:00
.woodpecker feat: run everything at once 2023-11-01 21:01:13 +01:00
crates/nefarious-login feat: fix tests 2023-11-01 20:57:56 +01:00
examples feat: add readme 2023-10-22 22:56:25 +02:00
.gitignore feat: with base 2023-10-22 16:55:48 +02:00
Cargo.lock chore(deps): update all dependencies 2023-10-30 16:12:00 +00:00
Cargo.toml chore(deps): update all dependencies 2023-10-30 16:12:00 +00:00
cuddle.yaml feat: with base 2023-10-22 16:55:48 +02:00
LICENSE feat: with license 2023-10-22 22:57:10 +02:00
README.md feat: dummy change 2023-11-01 21:26:35 +01:00
renovate.json Add renovate.json 2023-10-22 17:00:49 +00:00

Nefarious Login

Overview

Nefarious Login is a plug-and-play authentication module designed for effortless integration into business applications. Part of a larger suite of Nefarious tools, it aims to remove the hassle from implementing logins by using various authentication engines like Zitadel.

Quick Start

Install the crate via Cargo:

cargo install nefarious-login

Code Sample

Integrate Nefarious Login into your application. The core setup is about configuring the AuthService as shown below:

#[derive(Debug, Clone, Parser)]
struct Command {
    #[clap(flatten)]
    auth: AuthClap,
}

async fn main() -> anyhow::Result<()> {
    let cmd = Command::parse_from(vec![
        "base",
        "--auth-engine=zitadel", // Can also use a yaml file, or env variables, see app --help for more info
        "--zitadel-authority-url=https://personal-wxuujs.zitadel.cloud",
        "--zitadel-redirect-url=http://localhost:3001/auth/authorized",
        "--zitadel-client-id=<your-client-id>",
        "--zitadel-client-secret=<your-secret>",
        "--session-backend=postgresql",
        "--session-postgres-conn=postgres://como:somenotverysecurepassword@localhost:5432/nefarious-test",
    ]);

    let auth_service = AuthService::new(&cmd.auth).await?;

    // .. Use in axum, raw apis etc. See examples for details
}

Complete code in the main function will be similar to the snippet you provided.

Configuring with CLI

Use these CLI options to set up your authentication:

app
--auth-engine=zitadel
--zitadel-authority-url=https://example.zitadel.cloud
--zitadel-redirect-url=http://localhost:3001/auth/authorized
--zitadel-client-id=your-client-id
--zitadel-client-secret=your-client-secret
--session-backend=postgresql
--session-postgres-conn=postgres://username:password@localhost:5432/dbname

Examples

All examples feature axum integration

License

MIT License.

For more details, see LICENSE.

Contributions

PRs welcome. For major changes, open an issue first.