Add ownership to templates and ranges + Implement auth endpoints

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 #### 🐛 Bug Fix
 
-- Add template delete endpoints [#55](https://github.com/OpenLabsX/API/pull/55) ([@alexchristy](https://github.com/alexchristy))
+- Add template delete endpoints [#55](https://github.com/OpenLabsHQ/API/pull/55) ([@alexchristy](https://github.com/alexchristy))
 
 #### Authors: 1
 
@@ -14,7 +14,7 @@
 
 #### 🐛 Bug Fix
 
-- Naming refactor [#52](https://github.com/OpenLabsX/API/pull/52) ([@alexchristy](https://github.com/alexchristy))
+- Naming refactor [#52](https://github.com/OpenLabsHQ/API/pull/52) ([@alexchristy](https://github.com/alexchristy))
 
 #### Authors: 1
 
@@ -26,7 +26,7 @@
 
 #### 🚀 Enhancement
 
-- Cdktf [#50](https://github.com/OpenLabsX/API/pull/50) ([@Nareshp1](https://github.com/Nareshp1) [@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
+- Cdktf [#50](https://github.com/OpenLabsHQ/API/pull/50) ([@Nareshp1](https://github.com/Nareshp1) [@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
 
 #### Authors: 3
 
@@ -40,11 +40,11 @@
 
 #### 🚀 Enhancement
 
-- SQLAlchemy  ORM Models ✅ [#46](https://github.com/OpenLabsX/API/pull/46) ([@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
+- SQLAlchemy  ORM Models ✅ [#46](https://github.com/OpenLabsHQ/API/pull/46) ([@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
 
 #### 📝 Documentation
 
-- Add debug docker config to work with vscode debugging extension [#32](https://github.com/OpenLabsX/API/pull/32) ([@Adamkadaban](https://github.com/Adamkadaban))
+- Add debug docker config to work with vscode debugging extension [#32](https://github.com/OpenLabsHQ/API/pull/32) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### Authors: 2
 
@@ -57,11 +57,11 @@
 
 #### 🚀 Enhancement
 
-- Specify minimum disk size for each OS [#35](https://github.com/OpenLabsX/API/pull/35) ([@Adamkadaban](https://github.com/Adamkadaban))
+- Specify minimum disk size for each OS [#35](https://github.com/OpenLabsHQ/API/pull/35) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### 📝 Documentation
 
-- ignore .vscode folder to make my life easier [#30](https://github.com/OpenLabsX/API/pull/30) ([@Adamkadaban](https://github.com/Adamkadaban))
+- ignore .vscode folder to make my life easier [#30](https://github.com/OpenLabsHQ/API/pull/30) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### Authors: 1
 
@@ -73,8 +73,8 @@
 
 #### 🐛 Bug Fix
 
-- Ignore enums directory when running black so we can have nice spacing [#23](https://github.com/OpenLabsX/API/pull/23) ([@Adamkadaban](https://github.com/Adamkadaban))
-- add .swp to gitignore to make my life easier [#21](https://github.com/OpenLabsX/API/pull/21) ([@Adamkadaban](https://github.com/Adamkadaban))
+- Ignore enums directory when running black so we can have nice spacing [#23](https://github.com/OpenLabsHQ/API/pull/23) ([@Adamkadaban](https://github.com/Adamkadaban))
+- add .swp to gitignore to make my life easier [#21](https://github.com/OpenLabsHQ/API/pull/21) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### Authors: 1
 
@@ -86,7 +86,7 @@
 
 #### 🐛 Bug Fix
 
-- Update Mypy Precommit Dependencies [#25](https://github.com/OpenLabsX/API/pull/25) ([@alexchristy](https://github.com/alexchristy))
+- Update Mypy Precommit Dependencies [#25](https://github.com/OpenLabsHQ/API/pull/25) ([@alexchristy](https://github.com/alexchristy))
 
 #### Authors: 1
 
@@ -98,11 +98,11 @@
 
 #### 🚀 Enhancement
 
-- add some operating system AMIs and URNs [#11](https://github.com/OpenLabsX/API/pull/11) ([@Adamkadaban](https://github.com/Adamkadaban))
+- add some operating system AMIs and URNs [#11](https://github.com/OpenLabsHQ/API/pull/11) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### 📝 Documentation
 
-- Clarify Docker Documentation [#19](https://github.com/OpenLabsX/API/pull/19) ([@alexchristy](https://github.com/alexchristy))
+- Clarify Docker Documentation [#19](https://github.com/OpenLabsHQ/API/pull/19) ([@alexchristy](https://github.com/alexchristy))
 
 #### Authors: 2
 
@@ -115,7 +115,7 @@
 
 #### 🚀 Enhancement
 
-- Add Docker configurations [#17](https://github.com/OpenLabsX/API/pull/17) ([@alexchristy](https://github.com/alexchristy))
+- Add Docker configurations [#17](https://github.com/OpenLabsHQ/API/pull/17) ([@alexchristy](https://github.com/alexchristy))
 
 #### Authors: 1
 
@@ -127,7 +127,7 @@
 
 #### 🐛 Bug Fix
 
-- add codeowners file so we are auto requested for review [#12](https://github.com/OpenLabsX/API/pull/12) ([@Adamkadaban](https://github.com/Adamkadaban))
+- add codeowners file so we are auto requested for review [#12](https://github.com/OpenLabsHQ/API/pull/12) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### Authors: 1
 
@@ -139,15 +139,15 @@
 
 #### 🚀 Enhancement
 
-- Project Boilerplate [#3](https://github.com/OpenLabsX/API/pull/3) ([@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
+- Project Boilerplate [#3](https://github.com/OpenLabsHQ/API/pull/3) ([@alexchristy](https://github.com/alexchristy) [@Adamkadaban](https://github.com/Adamkadaban))
 
 #### 🐛 Bug Fix
 
-- Working Auto Release GH App Bypass [#6](https://github.com/OpenLabsX/API/pull/6) ([@alexchristy](https://github.com/alexchristy))
-- Auto release GitHub App [#5](https://github.com/OpenLabsX/API/pull/5) ([@alexchristy](https://github.com/alexchristy))
-- Remove workflow permission from release.yml workflow [#4](https://github.com/OpenLabsX/API/pull/4) ([@alexchristy](https://github.com/alexchristy))
-- Add aws and azure size mappings [#2](https://github.com/OpenLabsX/API/pull/2) ([@Adamkadaban](https://github.com/Adamkadaban))
-- add classes and enums [#1](https://github.com/OpenLabsX/API/pull/1) ([@Adamkadaban](https://github.com/Adamkadaban))
+- Working Auto Release GH App Bypass [#6](https://github.com/OpenLabsHQ/API/pull/6) ([@alexchristy](https://github.com/alexchristy))
+- Auto release GitHub App [#5](https://github.com/OpenLabsHQ/API/pull/5) ([@alexchristy](https://github.com/alexchristy))
+- Remove workflow permission from release.yml workflow [#4](https://github.com/OpenLabsHQ/API/pull/4) ([@alexchristy](https://github.com/alexchristy))
+- Add aws and azure size mappings [#2](https://github.com/OpenLabsHQ/API/pull/2) ([@Adamkadaban](https://github.com/Adamkadaban))
+- add classes and enums [#1](https://github.com/OpenLabsHQ/API/pull/1) ([@Adamkadaban](https://github.com/Adamkadaban))
 
 #### ⚠️ Pushed to `main`
 

Dockerfile.dev

@@ -2,18 +2,41 @@ FROM python:3.12-slim
 
 WORKDIR /code
 
-# For dynamic versioning
-RUN apt-get update && apt-get install -y git \
+RUN apt-get update && apt-get install -y git curl \
+    && curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \
+    && apt-get install -y nodejs \
+    && apt-get install -y gnupg software-properties-common \
+    && apt-get install -y wget \
+    && apt-get install -y gnupg2 \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
+RUN wget -O- https://apt.releases.hashicorp.com/gpg | \
+    gpg --dearmor | \
+    tee /usr/share/keyrings/hashicorp-archive-keyring.gpg > /dev/null
+
+RUN echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] \
+    https://apt.releases.hashicorp.com bookworm main" | \
+    tee /etc/apt/sources.list.d/hashicorp.list
+
+RUN apt-get update && apt-get install -y terraform
+
+
 # Install debugpy for debugging
 RUN pip install --no-cache-dir debugpy
 
 # Install python dependencies
 COPY ./requirements.txt /code/requirements.txt
 RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
 
+# Set up terraform cache
+WORKDIR src/app/core/cdktf
+RUN mkdir -p "/root/.terraform.d/plugin-cache"
+COPY src/app/core/cdktf/.terraformrc /root/.terraformrc
+RUN terraform init
+RUN rm -rf .terraform*
+WORKDIR /code
+
 EXPOSE 80
 
 CMD ["uvicorn", "src.app.main:app", "--host", "0.0.0.0", "--port", "80", "--reload"]

README.md

@@ -32,6 +32,15 @@ POSTGRES_DB=openlabsx
 
 # Docker Compose Configuration
 POSTGRES_DEBUG_PORT=5432  # Expose PostgreSQL on host port for debugging
+
+# Admin User Configuration (optional)
+[email protected]        # Default admin email 
+ADMIN_PASSWORD=admin123           # Default admin password
+ADMIN_NAME=Administrator          # Default admin name
+# Admin user is automatically created when database is initialized
+
+# Authentication Configuration
+SECRET_KEY=your-secret-key-here   # JWT token signing key (CHANGE THIS!)
 ```
 </details>
 
@@ -150,35 +159,67 @@ All tests are located in `tests/`. The structure of the `tests/` directory mirro
 src/
 └── app
     ├── api
-    │   └── v1                  # API Version 1 routes (/v1)
-    |       |                   # ------------------------- #
-    │       ├── health.py       # /health routes
-    │       └── templates.py    # /templates routes
+    │   └── v1                   # API Version 1 routes (/v1)
+    |       |                    # ------------------------- #
+    │       ├── auth.py          # /auth routes
+    │       ├── health.py        # /health routes
+    │       ├── ranges.py        # /ranges routes
+    │       ├── templates.py     # /templates routes
+    │       └── users.py         # /users routes
     |
-    ├── core                    # Core Application Logic
-    |   |                       # ---------------------- #
-    │   ├── cdktf/              # CDKTF Libraries
-    │   ├── config.py           # Application settings
-    │   ├── db                  # Database configuration
+    ├── core                     # Core Application Logic
+    |   |                        # ---------------------- #
+    │   ├── auth/                # Authentication utilities
+    │   │   └── auth.py
+    │   ├── cdktf/               # CDKTF Libraries
+    │   │   └── aws/             # AWS provider configuration
+    │   ├── config.py            # Application settings
+    │   ├── db                   # Database configuration
     │   │   └── database.py
-    │   ├── logger.py           # Shared logger utility
-    │   └── setup.py            # Application setup logic
+    │   ├── logger.py            # Shared logger utility
+    │   └── setup.py             # Application setup logic
     | 
-    ├── enums                   # Enums (Constants)
-    |   |                       # ---------------- #
-    │   ├── providers.py        # Defined cloud providers
-    │   └── specs.py            # Preset VM hardware configurations
+    ├── crud                     # Database CRUD operations
+    │   ├── crud_host_templates.py
+    │   ├── crud_range_templates.py
+    │   ├── crud_subnet_templates.py
+    │   ├── crud_users.py
+    │   └── crud_vpc_templates.py
+    |
+    ├── enums                    # Enums (Constants)
+    |   |                        # ---------------- #
+    │   ├── operating_systems.py # OS configurations
+    │   ├── providers.py         # Defined cloud providers
+    │   └── specs.py             # Preset VM hardware configurations
+    |
+    ├── models                   # Database Models
+    │   ├── secret_model.py        # Encrypted cloud provider credentials (AWS, Azure)
+    │   ├── template_base_model.py
+    │   ├── template_host_model.py
+    │   ├── template_range_model.py
+    │   ├── template_subnet_model.py
+    │   ├── template_vpc_model.py
+    │   └── user_model.py
+    |
+    ├── schemas                  # API Schema (Objects)
+    |   |                        # ------------------ #
+    │   ├── secret_schema.py      # Cloud provider credential schemas
+    │   ├── template_host_schema.py
+    │   ├── template_range_schema.py
+    │   ├── template_subnet_schema.py
+    │   ├── template_vpc_schema.py
+    │   └── user_schema.py
     |
-    ├── schemas                 # API Schema (Objects)
-    |   |                       # ------------------ #
-    │   ├── openlabs.py         # OpenLabs network objects
-    │   └── templates.py        # Template objects
+    ├── utils                    # Utility Functions
+    │   ├── cdktf_utils.py       # CDKTF configuration utilities
+    │   └── crypto.py            # Cryptography utilities for encrypting cloud provider credentials
     |
-    └── validators              # Data Validation
-    |   |                       # --------------- #
-    |   └── network.py          # Networking config input validation
+    ├── validators               # Data Validation
+    |   |                        # --------------- #
+    │   ├── id.py                # ID validation
+    │   └── network.py           # Networking config input validation
     |
-    └── main.py                 # Main App Entry Point
+    └── main.py                  # Main App Entry Point
 ```
 
 ## VScode Extensions
@@ -261,7 +302,7 @@ This workflow automatically creates GitHub tagged releases based on the tag of t
 
 5) Create a GitHub App
 
-    ***Note:** OpenLabsX already has the `auto-release-app` installed. Skip to step 7.*
+    ***Note:** OpenLabs already has the `auto-release-app` installed. Skip to step 7.*
 
     This allows us to enforce branch protection rules while allowing the Auto release tool to bypass the protections when running automated workflows. (Source: [Comment Link](https://github.com/orgs/community/discussions/13836#discussioncomment-8535364))
 

requirements.txt

@@ -6,4 +6,12 @@ setuptools-scm~=8.1
 
 # CDKTF
 cdktf>=0.20
-cdktf-cdktf-provider-aws>=19.52
+cdktf-cdktf-provider-aws>=19.52
+
+# Auth
+pyjwt
+bcrypt
+
+# Crypto
+cryptography>=41.0.0
+argon2-cffi>=23.1.0

src/__init__.py

@@ -1 +1 @@
-"""Source code of the OpenLabsX API."""
+"""Source code of the OpenLabs API."""

src/app/__init__.py

@@ -1 +1 @@
-"""Base app of the OpenLabsX API."""
+"""Base app of the OpenLabs API."""

src/app/api/__init__.py

@@ -1,4 +1,4 @@
-"""Base of OpenLabsX API."""
+"""Base of OpenLabs API."""
 
 from fastapi import APIRouter
 

src/app/api/v1/__init__.py

@@ -1,12 +1,16 @@
-"""Version 1 of the OpenLabsX API routes."""
+"""Version 1 of the OpenLabs API routes."""
 
 from fastapi import APIRouter
 
+from .auth import router as auth_router
 from .health import router as health_router
 from .ranges import router as ranges_router
 from .templates import router as templates_router
+from .users import router as user_router
 
 router = APIRouter(prefix="/v1")
 router.include_router(health_router)
 router.include_router(templates_router)
 router.include_router(ranges_router)
+router.include_router(auth_router)
+router.include_router(user_router)