sfnx 0.1.0__tar.gz

sfnx-0.1.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Mohit Nair
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sfnx-0.1.0/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: sfnx
+Version: 0.1.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]
+Requires-Dist: rich
+Requires-Dist: cryptography
+Requires-Dist: argon2-cffi
+Requires-Dist: sqlmodel
+
+# sfnx-terminal
+A minimal terminal password manager that uses Typer, SQLModel, Argon2 Key Derivation, AES and SQLite

sfnx-0.1.0/README.md

@@ -0,0 +1,2 @@
+# sfnx-terminal
+A minimal terminal password manager that uses Typer, SQLModel, Argon2 Key Derivation, AES and SQLite

sfnx-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sfnx-0.1.0/setup.py

@@ -0,0 +1,30 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="sfnx",
+    version="0.1.0",
+    packages=find_packages(),
+    install_requires=[
+        "typer[all]",
+        "rich",
+        "cryptography",
+        "argon2-cffi",
+        "sqlmodel"
+    ],
+    entry_points={
+        "console_scripts": [
+            "sfnx=sfnx.main:app",
+        ],
+    },
+    python_requires='>=3.7',  # Specify Python version requirements
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    long_description=open('README.md').read(),
+    long_description_content_type='text/markdown',
+)

sfnx-0.1.0/sfnx/db.py

@@ -0,0 +1,174 @@
+from sqlmodel import SQLModel, create_engine, Session, select, Field, UniqueConstraint
+from sfnx.security import derive_key, encrypt, decrypt
+from sqlmodel import SQLModel, Field
+from typing import Optional
+import os
+import sys
+
+db_file = "sfnx.db"
+db_url = f"sqlite:///{db_file}"
+
+engine = create_engine(db_url, echo=False)
+
+def init_db():
+    try:
+        SQLModel.metadata.create_all(engine)
+    except Exception as e:
+        print(f"Error initializing the database: {e}")
+        sys.exit(1)
+
+class Secrets(SQLModel, table=True):
+    service: str = Field(nullable=False, max_length=64, primary_key=True)
+    username: str = Field(nullable=False, max_length=64, primary_key=True)
+    password: bytes = Field(nullable=False, max_length=255)
+    salt: bytes = Field(nullable=False)
+
+def configure(master_password: str, verification_secret: str) -> bytes:
+    try:
+        init_db()
+        salt = os.urandom(16)
+        reference = encrypt(derive_key(master_password, salt), verification_secret)
+        configuration = Secrets(
+            service="sfnx_secret",
+            username=verification_secret,
+            password=reference,
+            salt=salt
+        )
+        with Session(engine) as session:
+            session.add(configuration)
+            session.commit()
+    except Exception as e:
+        print(f"Error during configuration: {e}")
+        sys.exit(1)
+
+def check_exists() -> bool:
+    try:
+        with Session(engine) as session:
+            statement = select(Secrets).where(Secrets.service == "sfnx_secret")
+            result = session.exec(statement).first()
+            return result is not None
+    except Exception as e:
+        print(f"Error checking existence: {e}")
+        return False
+
+def check_db_exists():
+    db_path = "sfnx.db"
+    return os.path.isfile(db_path)
+
+def verify_user_master_password(master_password_attempt: str) -> bool:
+    try:
+        with Session(engine) as session:
+            statement = select(Secrets).where(Secrets.service == "sfnx_secret")
+            result = session.exec(statement).first()
+
+            if result is None:
+                return False
+            
+            encrypted_secret = getattr(result, "password")
+            verification_secret = getattr(result, "username")
+            salt = getattr(result, "salt")
+            key = derive_key(master_password_attempt, salt)
+            try:
+                decrypted_secret = decrypt(key, encrypted_secret)
+            except ValueError:
+                print("Wrong master password.")
+                return False
+
+            return decrypted_secret == verification_secret
+    except Exception as e:
+        print(f"Error verifying master password: {e}")
+        return False
+
+def get_user_name(master_password_attempt: str) -> str:
+    try:
+        with Session(engine) as session:
+            if check_exists():
+                statement = select(Secrets).where(Secrets.service == "sfnx_secret")
+                result = session.exec(statement).first()
+                
+                verification_secret = getattr(result, "username")
+                encrypted_secret = getattr(result, "password")
+                salt = getattr(result, "salt")
+                key = derive_key(master_password_attempt, salt)
+
+                try:
+                    decrypted_secret = decrypt(key, encrypted_secret)
+                except ValueError:
+                    return ""
+                
+                if decrypted_secret == verification_secret:
+                    return decrypted_secret
+                else:
+                    return ""
+    except Exception as e:
+        print(f"Error retrieving user name: {e}")
+        return ""
+
+def check_if_service_and_uname_already_exist(service: str, username: Optional[str]) -> bool:
+    try:
+        with Session(engine) as session:
+            statement = select(Secrets).where(Secrets.username == username).where(Secrets.service == service)
+            result = session.exec(statement).first()
+            return result is not None
+    except Exception as e:
+        print(f"Error checking service and username existence: {e}")
+        return False
+
+def add_password(master_password_attempt: str, service: str, username: Optional[str], password: str):
+    try:
+        if verify_user_master_password(master_password_attempt) and not service == "sfnx_secret":
+            with Session(engine) as session:
+                if not check_if_service_and_uname_already_exist(service, username):
+                    salt = os.urandom(16)
+                    key = derive_key(master_password_attempt, salt)
+                    s_password = encrypt(key, password)
+                    secret = Secrets(
+                        service=service,
+                        username=username,
+                        password=s_password,
+                        salt=salt
+                    )
+                    session.add(secret)
+                    session.commit()
+                    print("Password added successfully!")
+                else:
+                    print("Secrets associated with the same service and username already exist.")
+                    return
+    except Exception as e:
+        print(f"Error adding password: {e}")
+
+def delete_password(master_password_attempt: str, service: str, username: str):
+    try:
+        if verify_user_master_password(master_password_attempt):
+            with Session(engine) as session:
+                statement = select(Secrets).where(Secrets.service == service).where(Secrets.username == username)
+                result = session.exec(statement).first()
+                if result:
+                    session.delete(result)
+                    session.commit()
+                    print("Password deleted successfully!")
+    except Exception as e:
+        print(f"Error deleting password: {e}")
+
+def retrieve_password(master_password_attempt: str, service: str, username: str):
+    try:
+        if verify_user_master_password(master_password_attempt):
+            with Session(engine) as session:
+                statement = select(Secrets).where(Secrets.service == service).where(Secrets.username == username)
+                results = session.exec(statement).all()
+
+                if results:
+                    for result in results:
+                        username = result.username
+                        key = derive_key(master_password_attempt, result.salt)
+                        try:
+                            password = decrypt(key, result.password)
+                        except ValueError:
+                            password = None
+
+                        print(f"Password: {password}")
+                    print("Password(s) retrieved successfully!")
+                else:
+                    print("No records found for this service.")
+    except Exception as e:
+        print(f"Error retrieving password: {e}")

sfnx-0.1.0/sfnx/main.py

@@ -0,0 +1,95 @@
+from typer import Typer
+from rich.console import Console
+from rich.text import Text
+from rich.panel import Panel
+import getpass
+import os
+from sfnx.db import init_db, verify_user_master_password, check_db_exists, configure, get_user_name, add_password, retrieve_password, delete_password
+from sfnx.security import encrypt, decrypt, derive_key
+
+app = Typer()
+console = Console()
+
+rules = [
+    ("Rule 1:", "The master password is the prime password which you will be using to access all your passwords in sfnx. Forgetting it means irreversibly losing access to all your other passwords. Always remember it."),
+    ("Rule 2:", "Creating an easy-to-remember password doesn't mean making it short and weak. It is better to follow this for all passwords you store in this password manager."),
+    ("Rule 3:", "Your master password must have at least 15 characters. It is recommended to use a long passphrase; for example: \"myc@tn@medg@mbitst@rtedthes0vietunion@ccident@lly\""),
+]
+
+@app.command("init")
+def init():
+    try:
+        if not check_db_exists():
+            rules_text = "\n".join([f"{rule} {point}" for rule, point in rules])
+            panel_content = Text(rules_text, style="cyan")
+            console.print(Panel(panel_content, title="Important Rules", expand=False))
+
+            master_password = getpass.getpass("Enter the master password you wish to use: ")
+            confirm = getpass.getpass("Enter the password again [confirm]: ")
+
+            if confirm != master_password:
+                console.print("[bold red]Error:[/bold red] Passwords do not match. Please try again.", style="bold red")
+                return
+
+            name = input("Enter your name or alias [required]: ")
+            console.print(f"\nThank you for setting up sfnx, {name}!", style="bold green")
+            salt = os.urandom(16)
+            key = derive_key(master_password, salt)
+            encrypted_secret = encrypt(key, name)
+            configure(master_password, name)
+        else:
+            print("This is a configuration test to see if you have setup your password manager properly. See sfnx --help for more details.")
+            master_password_attempt = getpass.getpass("Enter your master password: ")
+            if verify_user_master_password(master_password_attempt):
+                username = get_user_name(master_password_attempt)
+                print(f"Welcome, {username}!")
+    except Exception as e:
+        console.print(f"[bold red]Error:[/bold red] {e}", style="bold red")
+
+@app.command("addpass")
+def addpass():
+    try:
+        if not check_db_exists():
+            init()
+        else:
+            service = input("Enter the name of the service: ")
+            username = input("Enter the username used for the service: ")
+            password = getpass.getpass("Enter the password used for this service and username: ")
+            c_password = getpass.getpass("Enter the above password again for confirmation: ")
+            if password == c_password:
+                master_password_attempt = getpass.getpass("Enter your master password: ")
+                add_password(master_password_attempt, service, username, password)
+            else:
+                console.print("[bold red]Error:[/bold red] Passwords do not match. Please try again.", style="bold red")
+                return
+    except Exception as e:
+        console.print(f"[bold red]Error:[/bold red] {e}", style="bold red")
+
+@app.command("delpass")
+def delpass():
+    try:
+        if not check_db_exists():
+            init()
+        else:
+            service = input("Enter the name of the service: ")
+            username = input("Enter the username used for the service: ")
+            master_password_attempt = getpass.getpass("Enter your master password: ")
+            delete_password(master_password_attempt, service, username)
+    except Exception as e:
+        console.print(f"[bold red]Error:[/bold red] {e}", style="bold red")
+
+@app.command("viewpass")
+def viewpass():
+    try:
+        if not check_db_exists():
+            init()
+        else:
+            service = input("Enter the name of the service: ")
+            username = input("Enter the username used for the service: ")
+            master_password_attempt = getpass.getpass("Enter your master password: ")
+            retrieve_password(master_password_attempt, service, username)
+    except Exception as e:
+        console.print(f"[bold red]Error:[/bold red] {e}", style="bold red")
+
+if __name__ == "__main__":
+    app()

sfnx-0.1.0/sfnx/security.py

@@ -0,0 +1,60 @@
+from argon2 import PasswordHasher
+from argon2 import Type, low_level
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from cryptography.hazmat.primitives import padding
+from cryptography.hazmat.backends import default_backend
+import os
+
+def derive_key(m_password: str, salt: bytes) -> bytes:
+    try:
+        key = low_level.hash_secret_raw(
+            m_password.encode(),
+            salt,
+            time_cost=2,
+            memory_cost=102400,
+            parallelism=8,
+            hash_len=32,
+            type=Type.ID
+        )
+        return key
+    except Exception as e:
+        raise RuntimeError("Error deriving key.")
+
+def encrypt(key: bytes, plaintext: str) -> bytes:
+    try:
+        if len(key) != 32:
+            raise ValueError("Key must be 32 bytes long")
+        
+        iv = os.urandom(16)
+        
+        cipher = Cipher(algorithms.AES(key), modes.CBC(iv), backend=default_backend())
+        encryptor = cipher.encryptor()
+        
+        padder = padding.PKCS7(algorithms.AES.block_size).padder()
+        padded_data = padder.update(plaintext.encode()) + padder.finalize()
+        
+        encrypted_data = encryptor.update(padded_data) + encryptor.finalize()
+        
+        return iv + encrypted_data
+    except Exception as e:
+        raise RuntimeError("Error encrypting data.")
+
+def decrypt(key: bytes, encrypted_data: bytes) -> str:
+    try:
+        if len(key) != 32:
+            raise ValueError("Key must be 32 bytes long")
+        
+        iv = encrypted_data[:16]
+        encrypted_data = encrypted_data[16:]
+        
+        cipher = Cipher(algorithms.AES(key), modes.CBC(iv), backend=default_backend())
+        decryptor = cipher.decryptor()
+        
+        padded_plaintext = decryptor.update(encrypted_data) + decryptor.finalize()
+        
+        unpadder = padding.PKCS7(algorithms.AES.block_size).unpadder()
+        plaintext = unpadder.update(padded_plaintext) + unpadder.finalize()
+        
+        return plaintext.decode()
+    except Exception as e:
+        raise RuntimeError("Error decrypting data.")

sfnx-0.1.0/sfnx.egg-info/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.1
+Name: sfnx
+Version: 0.1.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]
+Requires-Dist: rich
+Requires-Dist: cryptography
+Requires-Dist: argon2-cffi
+Requires-Dist: sqlmodel
+
+# sfnx-terminal
+A minimal terminal password manager that uses Typer, SQLModel, Argon2 Key Derivation, AES and SQLite

sfnx-0.1.0/sfnx.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+setup.py
+sfnx/__init__.py
+sfnx/db.py
+sfnx/main.py
+sfnx/security.py
+sfnx.egg-info/PKG-INFO
+sfnx.egg-info/SOURCES.txt
+sfnx.egg-info/dependency_links.txt
+sfnx.egg-info/entry_points.txt
+sfnx.egg-info/requires.txt
+sfnx.egg-info/top_level.txt

sfnx-0.1.0/sfnx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sfnx-0.1.0/sfnx.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sfnx = sfnx.main:app

sfnx-0.1.0/sfnx.egg-info/requires.txt

@@ -0,0 +1,5 @@
+typer[all]
+rich
+cryptography
+argon2-cffi
+sqlmodel

sfnx-0.1.0/sfnx.egg-info/top_level.txt

@@ -0,0 +1 @@
+sfnx