Ark

A full-stack monolithic application that heavily emphasizes its (IAM) solution. Initially, it was supposed to be closed source because it was going to be used for a side project, but I decided to release it to the public for personal reasons. Note: it's missing some fundamental things, so it's not ready for production use yet.

Technically, it is not a full stack just yet, I haven't wrote the frontend yet.

Technical Breakdown

If you're interested in my thought process while I was building out the foundation of this project, you can view the post I made about this project on my substack here

Installation

This section guides you through the process of installing the necessary tools and building the project.

Prerequisites

Before you begin, ensure you have installed Rust, Cargo, PostgreSQL, and Redis on your system.

• Rust
• PostgreSQL
• Redis
• OAuth Provider (ex: Discord)

From the source

git clone https://github.com/notpointless/ark.git
cd ark
cargo build
cargo run

Setting environment variables

SET PG_HOST=
SET PG_USER=
SET PG_PASSWORD=
SET PG_DBNAME=
SET REDIS_HOST=
SET REDIS_USER=
SET REDIS_PASSWORD=
SET REDIS_DBNAME=
SET DISCORD_CLIENT_ID=
SET DISCORD_CLIENT_SECRET=
SET DISCORD_AUTH_URL=https://discord.com/oauth2/authorize
SET DISCORD_TOKEN_URL=https://discord.com/api/oauth2/token
SET DISCORD_REVOCATION_URL=https://discord.com/api/oauth2/token/revoke
SET OAUTH2_REDIRECT_URL=http://localhost:3000/auth/callback
SET COOKIE_ENCRYPTION_KEY=TESTKEY1324E31324123421244123TESTFEY1214E31324123421244123TESTKEY1224E31324123421244123

IAM

Some simple documentation for some of the functions for the IAM; all are commented. Note roles and permissions are case-sensitive.

Creating a user

If the permissions or roles added to a user do not already exist, they will not be added to the user.

let user = User::builder()
        .oauth_id("oauth_id")
        .oauth_provider("discord")
        .username("hello")
        .permission(vec!["special.permission".to_string()])
        .role(vec!["Admin".to_string()])
        .build();
UserManager::create_user(user).unwrap();

Creating a role

let role = Role::builder()
        .role_name("Admin")
        .build();
RoleManager::create_role(role).unwrap();

Updating a role

RoleManager::update_role("dd2546c3-e34a-4fcb-9b12-1a96eb6873e3", "role_name", "Admin");
RoleManager::update_role("Admin", "role_name", "Administrator");

Linking a permission to a role.

RoleManager::link_permission_to_role("Admin", "ban.user").unwrap();

Creating a permission

let role = Permission::builder()
        .permission_name("Ban User")
        .permission_key("ban.user")
        .build();
PermissionManager::create_permission(role).unwrap();

Updating a permission

PermissionManager::update_permission("dd2546c3-e34a-4fcb-9b12-1a96eb6873e3", "permission_name", "admin ban user.");
PermissionManager::update_permission("admin ban user.", "permission_key", "admin.ban.key");

Tests

None at the moment.