Merge pull request #1 from sinisaos/mfa_providers

add `mfa_providers` to template

Author: sinisaos

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 sinisaos
+Copyright (c) 2024 piccolo-orm
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,7 +5,7 @@ Experimenting with using a dockerized Piccolo Admin with an existing (legacy) da
 Clone repository.
 
 ```bash
-git clone https://github.com/sinisaos/piccolo-admin-docker.git
+git clone https://github.com/piccolo-orm/piccolo-admin-docker.git
 ```
 
 Creating an `.env` file.
@@ -21,7 +21,7 @@ Creating a Docker image.
 docker build -t piccolo_admin .
 ```
 
-Running a Docker image (using the `--network=host` flag because I'm using an existing database from the local machine).
+Running a Docker image (use the `--network=host` flag for an existing database from the local machine).
 
 ```bash
 docker run -d --network=host --name admin_container piccolo_admin

app/.env.example

@@ -3,3 +3,7 @@ DB_USER="your_db_user"
 DB_PASSWORD="your_db_password"
 DB_HOST="your_host"
 DB_PORT=5432
+USERNAME="piccolo"
+PASSWORD="piccolo123"
+EMAIL="[email protected]"
+ENCRIPTION_KEY="\xb7(\xa5\xa6\xa4&\xeb\x8eI\xfe_Y\x16\x12\xf4\xf4\xa8|\xc6#\xd1\x02\xa2s\x03]\xea\x12\xb9\xf1\xa2\xb3"

app/admin_user.db

@@ -10,18 +10,19 @@
 from piccolo.table import create_db_tables
 from piccolo.table_reflection import TableStorage
 from piccolo_admin import create_admin
+from piccolo_api.encryption.providers import XChaCha20Provider
+from piccolo_api.mfa.authenticator.provider import AuthenticatorProvider
+from piccolo_api.mfa.authenticator.tables import (
+    AuthenticatorSecret as AuthenticatorSecret_,
+)
 from piccolo_api.session_auth.tables import SessionsBase
 
-DB = SQLiteEngine("app/admin_user.db")
+DB = SQLiteEngine()
 
 
 load_dotenv(find_dotenv())
 
 
-USERNAME = "piccolo"
-PASSWORD = "piccolo123"
-
-
 class Sessions(SessionsBase, db=DB):
     pass
 
@@ -30,15 +31,22 @@ class User(BaseUser, tablename="piccolo_user", db=DB):
     pass
 
 
+class AuthenticatorSecret(AuthenticatorSecret_, db=DB):
+    pass
+
+
 async def main():
     # Create auth tables in separate Sqlite DB
-    await create_db_tables(*[User, Sessions], if_not_exists=True)
+    await create_db_tables(
+        *[User, Sessions, AuthenticatorSecret],
+        if_not_exists=True,
+    )
     # Create a admin user in separate Sqlite DB
-    if not await User.exists().where(User.email == "[email protected]"):
+    if not await User.exists().where(User.email == os.environ["EMAIL"]):
         user = User(
-            username=USERNAME,
-            password=PASSWORD,
-            email="[email protected]",
+            username=os.environ["USERNAME"],
+            password=os.environ["PASSWORD"],
+            email=os.environ["EMAIL"],
             admin=True,
             active=True,
             superuser=True,
@@ -72,6 +80,16 @@ async def main():
         auth_table=User,
         session_table=Sessions,
         auto_include_related=False,
+        mfa_providers=[
+            AuthenticatorProvider(
+                encryption_provider=XChaCha20Provider(
+                    encryption_key=os.environb[b"ENCRIPTION_KEY"]
+                    .decode("unicode-escape")
+                    .encode("latin-1")
+                ),
+                secret_table=AuthenticatorSecret,
+            ),
+        ],
     )
 
     # Server

app/main.py

@@ -1,6 +1,7 @@
-https://github.com/piccolo-orm/piccolo/archive/master.zip
-piccolo-admin
 asyncpg
 aiosqlite
 hypercorn
+piccolo
+piccolo-admin
+piccolo_api[authenticator,pynacl]
 python-dotenv