SeedShield 0.0.1__py3-none-any.whl

SeedShield-0.0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 SeedShield
+
+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.

SeedShield-0.0.1.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.1
+Name: SeedShield
+Version: 0.0.1
+Summary: Secure BIP39 word viewer with masking and reveal functionality
+Author-email: Barlog951 <barlog951@gmail.com>
+Project-URL: Documentation, https://github.com/Barlog951/SeedShield/blob/main/README.md
+Project-URL: Source Code, https://github.com/Barlog951/SeedShield
+Project-URL: Bug Tracker, https://github.com/Barlog951/SeedShield/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyperclip>=1.8.0
+Provides-Extra: test
+Requires-Dist: pytest>=6.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.1.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pylint; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: mypy; extra == "test"
+Provides-Extra: windows
+Requires-Dist: windows-curses; extra == "windows"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# SeedShield
+
+A secure BIP39 seed phrase viewer with enterprise-grade security features, designed for safe interaction with cryptocurrency seed phrases. SeedShield emphasizes security and usability while maintaining zero data persistence.
+
+## Key Features
+
+### Security-First Design
+- Zero data persistence - all operations occur in volatile memory
+- Secure memory handling with automatic cleanup and sanitization
+- Advanced masking system with consistent pattern length
+- Timed reveal system with 3-second auto-mask
+- Intelligent clipboard management with automatic clearing
+- Comprehensive input validation and sanitization
+- Anti-keylogging protection via mouse-based interaction
+- Secure error handling with proper cleanup
+- TTY/non-TTY mode handling for secure input
+- Adaptive timeout mechanisms
+
+### User Interface
+- Interactive word reveal with hover functionality
+- Sequential phrase revelation mode
+- Multi-source input support (file/clipboard)
+- Responsive terminal interface
+- Cross-platform support (Windows/Linux/MacOS)
+- Dynamic scrolling for long word lists
+- Clear command feedback
+
+## Security Guidelines
+
+### Operating Environment
+- Use an air-gapped computer whenever possible
+- Run on a secure, clean operating system
+  - Recommended: Live Linux distribution
+  - Avoid shared or public computers
+- Maintain physical security awareness
+  - Check for surveillance devices
+  - Use privacy screens when necessary
+- Implement proper memory management
+  - Clear system RAM after usage
+  - Utilize secure memory wiping tools
+
+### Usage Best Practices
+
+#### Input Management
+1. Prefer clipboard input for multiple words (use 'v' command)
+2. Clipboard contents are automatically cleared after use
+3. Double-check word positions before revelation
+4. All input is automatically validated and sanitized
+5. Invalid inputs are safely rejected
+
+#### Word Revelation Protocol
+1. Use sequential reveal mode ('s' command) for systematic checking
+2. Utilize mouse hover for temporary word exposure
+3. Allow auto-masking timer to complete
+4. One word visible at a time for maximum security
+5. Use scroll navigation for longer lists
+
+## Installation
+
+```bash
+# Install via pip
+pip install seedshield
+
+# Install with development dependencies
+pip install -e ".[test]"
+
+# Using Docker
+docker run -it --rm seedshield
+docker run -it --rm -v $(pwd)/input.txt:/input.txt seedshield -i /input.txt
+```
+
+## Usage Guide
+
+### Basic Commands
+```bash
+# Start interactive mode
+seedshield
+
+# Use custom wordlist
+seedshield -w custom_words.txt
+
+# Load from positions file
+seedshield -i positions.txt
+```
+
+### Interactive Controls
+- `v` - Import and validate clipboard data
+- `n` - New input mode
+- `s` - Sequential reveal mode
+- `r` - Reset current sequence
+- `q` - Safe exit with cleanup
+- Mouse hover - Temporary reveal (3s timeout)
+- ↑↓ Arrow keys - Scroll through lists
+
+## Development
+
+### Getting Started
+```bash
+# Clone repository
+git clone https://github.com/Barlog951/SeedShield.git
+
+# Setup development environment
+cd seedshield
+pip install -e ".[test]"
+
+# Run test suite
+pytest
+```
+
+### Docker Build
+
+#### Building from Source
+```bash
+# Clone the repository
+git clone https://github.com/Barlog951/SeedShield.git
+cd SeedShield
+
+# Build local image
+chmod +x build.sh
+./build.sh
+
+# Test run
+docker run -it --rm seedshield --help
+
+# Run with mounted input file
+docker run -it --rm -v $(pwd)/input.txt:/input.txt seedshield -i /input.txt
+
+# Run interactive mode
+docker run -it --rm seedshield
+```
+Note: Built image contains minimal dependencies and runs as non-root user for security.
+
+### Technical Architecture
+- Python 3.6+ with type hints
+- Comprehensive test suite (90% coverage)
+- Automated security scanning
+- Platform-agnostic clipboard handling
+- Curses-based terminal interface
+- Modular design with separate secure interface
+
+### Code Organization
+- `main.py` - Entry point and argument handling
+- `secure_word_interface.py` - Core interface coordination
+- `input_handler.py` - Secure input processing
+- `display_handler.py` - UI rendering and masking
+- `state_handler.py` - State management and security
+- `tests/` - Comprehensive test suite
+- `data/` - Default wordlists
+
+## Security Philosophy
+SeedShield implements a defense-in-depth approach:
+- Multiple independent security layers
+- Fail-secure design principles
+- Memory-safe operations
+- Input validation at all levels
+- Automatic security timeout mechanisms
+- No data persistence
+- Secure error handling
+
+## Legal Notice
+
+### Disclaimer
+SeedShield provides secure seed phrase verification capabilities but should be used as part of a comprehensive security strategy. Users are responsible for implementing appropriate system-level security measures. While SeedShield incorporates robust security features, it should not be relied upon as a sole security measure.
+
+### License
+Released under the MIT License. See the LICENSE file for complete terms.

SeedShield-0.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+seedshield/__init__.py,sha256=IQaMo8wz0PZttdxxajXj_4_IwrYDsbZw8Axn-gRe7_A,379
+seedshield/display_handler.py,sha256=yYtJAUf4JCtzD5OfWCsyoHRHo1Z-ssil3z9pB7HZmpw,4623
+seedshield/input_handler.py,sha256=1yXt2XVaqn7TRwpvzKPl5Ofa4qyGToTzay74DpIqxlc,4006
+seedshield/main.py,sha256=599e4F2M9Ypkc29oqaPT8yem5DWqTToGJx2MNVr8cYE,1370
+seedshield/secure_word_interface.py,sha256=dij9UyGsPI3xGAhY3BvIfvf38HXjDt9A_5JcOWq6KPw,6766
+seedshield/state_handler.py,sha256=L3n7tZkoIDXnGkZRW5bBLa4IkckAd_XTkXMgzQxWKn4,2490
+seedshield/data/english.txt,sha256=L17tU6Rye0v4iA2PPxme_JDlhQNkbZ_47_Oi7Tsk29o,13116
+SeedShield-0.0.1.dist-info/LICENSE,sha256=ZhuARPhLvptZDL8Ekv-1SFkMx7K0urpT9vFEQGSA5_Q,1066
+SeedShield-0.0.1.dist-info/METADATA,sha256=RRsOeYNzzWqXFY5XwjlUZ3HGmjhP8Cvh-2aZaRDhPyU,6533
+SeedShield-0.0.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+SeedShield-0.0.1.dist-info/entry_points.txt,sha256=XXhL9pmZd73vrlhqOOXYtUS5UN1A8uoH6bH_Tugosrs,52
+SeedShield-0.0.1.dist-info/top_level.txt,sha256=PW5TkAwK23bzoxttobap8lWbZyP75zWiBP5eTGZsUII,11
+SeedShield-0.0.1.dist-info/RECORD,,

SeedShield-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.6.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

SeedShield-0.0.1.dist-info/entry_points.txt

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

SeedShield-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+seedshield

seedshield/__init__.py

@@ -0,0 +1,11 @@
+"""
+SeedShield: Secure BIP39 seed phrase viewer with enterprise-grade security features.
+"""
+
+from .secure_word_interface import SecureWordInterface
+from .input_handler import InputHandler
+from .display_handler import DisplayHandler
+from .state_handler import StateHandler
+
+__version__ = "0.0.1"
+__all__ = ['SecureWordInterface', 'InputHandler', 'DisplayHandler', 'StateHandler']