on_boarding.md

graph LR
    Application_Core["Application Core"]
    API_Endpoints["API Endpoints"]
    Web_UI_Endpoints["Web UI Endpoints"]
    Password_Service["Password Service"]
    Cryptography_Module["Cryptography Module"]
    Shared_Utilities["Shared Utilities"]
    Frontend_Assets["Frontend Assets"]
    Application_Core -- "Orchestrates" --> API_Endpoints
    Application_Core -- "Orchestrates" --> Web_UI_Endpoints
    Application_Core -- "Utilizes" --> Shared_Utilities
    API_Endpoints -- "Invokes" --> Password_Service
    API_Endpoints -- "Utilizes" --> Shared_Utilities
    Web_UI_Endpoints -- "Invokes" --> Password_Service
    Web_UI_Endpoints -- "Renders" --> Frontend_Assets
    Web_UI_Endpoints -- "Utilizes" --> Shared_Utilities
    Password_Service -- "Utilizes" --> Cryptography_Module
    Password_Service -- "Utilizes" --> Shared_Utilities
    click Application_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/snappass/Application_Core.md" "Details"
    click API_Endpoints href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/snappass/API_Endpoints.md" "Details"
    click Web_UI_Endpoints href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/snappass/Web_UI_Endpoints.md" "Details"
    click Shared_Utilities href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/snappass/Shared_Utilities.md" "Details"

Loading

Details

The snappass project is a Flask-based web application designed for secure, ephemeral secret sharing. Users can set a password or secret via a web interface or API, which is then encrypted and stored temporarily. A unique URL is generated for retrieval. Upon the first access, the secret is decrypted and displayed, after which it is immediately and permanently deleted, ensuring its ephemeral nature. The application provides both a user-friendly web interface and a programmatic API for interaction.

Application Core [Expand]

The central module responsible for initializing the Flask application, configuring global settings, and defining the main URL routes. It acts as the primary orchestrator, directing incoming requests to the appropriate handling layers.

Related Classes/Methods:

• snappass.main (355:357)

API Endpoints [Expand]

Handles all RESTful API requests for setting, checking, and retrieving ephemeral passwords. It processes JSON payloads, interacts with the Password Service for business logic, and returns structured JSON responses, including error handling.

Related Classes/Methods:

• snappass.main:api_handle_password (242:251)
• snappass.main:api_v2_set_password (255:298)
• snappass.main:api_v2_check_password (302:309)
• snappass.main:api_v2_retrieve_password (313:326)

Web UI Endpoints [Expand]

Manages the user-facing web interface, handling requests for HTML pages (e.g., set password form, preview, show password). It processes form submissions, interacts with the Password Service, and dynamically renders Frontend Assets to display information to the user.

Related Classes/Methods:

• snappass.main:handle_password (224:238)
• snappass.main:preview_password (330:335)
• snappass.main:show_password (339:345)

Password Service

Encapsulates the core business logic for managing ephemeral passwords. It handles the creation (storage), retrieval, and existence checks of passwords, acting as the intermediary between the endpoint layers and the underlying data storage and cryptographic operations.

Related Classes/Methods:

• snappass.main:set_password (138:150)
• snappass.main:get_password (154:170)
• snappass.main:password_exists (174:176)

Cryptography Module

Provides secure cryptographic operations, specifically encryption and decryption, to protect sensitive password data. It ensures data confidentiality during storage and transmission, making the secrets unreadable without proper decryption.

Related Classes/Methods:

• snappass.main:encrypt (74:82)
• snappass.main:decrypt (85:91)

Shared Utilities [Expand]

A collection of common helper functions and utilities used across various parts of the application. This includes input validation, standardized error response formatting, dynamic URL generation, and token extraction, promoting code reusability and consistency.

Related Classes/Methods:

• snappass.main:clean_input (184:199)
• snappass.main:empty (179:181)
• snappass.main:as_validation_problem (106:114)
• snappass.main:as_not_found_problem (117:125)
• snappass.main:as_problem_response (128:134)
• snappass.main:set_base_url (202:215)
• snappass.main:parse_token (94:103)

Frontend Assets

Comprises the presentation layer resources for the web application. This includes Jinja2 HTML templates for page structure and content, along with static files like CSS stylesheets for styling, JavaScript files for interactivity, and fonts/images for visual elements.

Related Classes/Methods:

• templates/index.html (1:1)
• templates/password.html (1:1)
• templates/preview.html (1:1)
• templates/show.html (1:1)
• templates/problem.html (1:1)
• static/css/style.css (1:1)
• static/js/script.js (1:1)
• static/fonts/ (1:1)
• static/img/ (1:1)

FAQ