frp-tunnel 1.0.4__tar.gz

frp_tunnel-1.0.4/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,87 @@
+name: Bug Report
+description: File a bug report to help us improve
+title: "[Bug]: "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+      
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: What platform are you running on?
+      options:
+        - Google Colab
+        - Linux (Ubuntu/Debian)
+        - Linux (CentOS/RHEL)
+        - macOS
+        - Windows
+        - Other
+    validations:
+      required: true
+      
+  - type: dropdown
+    id: component
+    attributes:
+      label: Component
+      description: Which component is affected?
+      options:
+        - FRP Server Setup
+        - FRP Client (Colab)
+        - FRP Client (Linux/macOS)
+        - FRP Client (Windows)
+        - SSH Configuration
+        - Documentation
+        - Other
+    validations:
+      required: true
+      
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+      
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to Reproduce
+      description: Please provide detailed steps to reproduce the issue
+      placeholder: |
+        1. Run command '...'
+        2. See error '...'
+        3. Expected '...' but got '...'
+    validations:
+      required: true
+      
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+      
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/cicy-dev/frp-tunnel/blob/main/CONTRIBUTING.md#code-of-conduct)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

frp_tunnel-1.0.4/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,63 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature!
+        
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem?
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: false
+      
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+      
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+      
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority
+      description: How important is this feature to you?
+      options:
+        - Low
+        - Medium
+        - High
+        - Critical
+    validations:
+      required: true
+      
+  - type: checkboxes
+    id: implementation
+    attributes:
+      label: Implementation
+      description: Are you willing to help implement this feature?
+      options:
+        - label: I'm willing to submit a pull request for this feature
+        - label: I can help with testing
+        - label: I can help with documentation
+        
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

frp_tunnel-1.0.4/.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-scripts:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Make scripts executable
+      run: chmod +x scripts/*.sh examples/*.sh
+      
+    - name: Test script syntax
+      run: |
+        for script in scripts/*.sh examples/*.sh; do
+          echo "Testing $script"
+          bash -n "$script"
+        done
+        
+    - name: Install shellcheck
+      run: sudo apt-get install -y shellcheck
+      
+    - name: Run shellcheck
+      run: |
+        for script in scripts/*.sh examples/*.sh; do
+          echo "Checking $script"
+          shellcheck "$script" || true
+        done
+
+  test-powershell:
+    runs-on: windows-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Test PowerShell script syntax
+      run: |
+        Get-ChildItem -Path scripts -Filter "*.ps1" | ForEach-Object {
+          Write-Host "Testing $($_.Name)"
+          powershell -NoProfile -ExecutionPolicy Bypass -Command "& { . '$($_.FullName)'; exit 0 }" -WhatIf
+        }
+      shell: powershell
+
+  test-documentation:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Install markdown linter
+      run: npm install -g markdownlint-cli
+      
+    - name: Lint markdown files
+      run: |
+        markdownlint README.md docs/*.md || true
+        
+    - name: Check links in documentation
+      run: |
+        # Simple link check - can be enhanced with proper tools
+        grep -r "http" docs/ README.md || true
+
+  security-scan:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Run security scan
+      run: |
+        # Check for hardcoded secrets/tokens
+        if grep -r "frp_[a-f0-9]\{32\}" scripts/ examples/ || \
+           grep -r "password.*=" scripts/ examples/ || \
+           grep -r "secret.*=" scripts/ examples/; then
+          echo "⚠️ Potential hardcoded secrets found"
+          exit 1
+        fi
+        echo "✅ No hardcoded secrets detected"

frp_tunnel-1.0.4/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v*.*.*'
+  workflow_dispatch:
+    inputs:
+      test_pypi:
+        description: 'Publish to TestPyPI instead of PyPI'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package
+      run: twine check dist/*
+    
+    - name: Publish to TestPyPI
+      if: github.event.inputs.test_pypi == 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+    
+    - name: Publish to PyPI
+      if: github.event.inputs.test_pypi != 'true'
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

frp_tunnel-1.0.4/.gitignore

@@ -0,0 +1,126 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# FRP specific
+*.log
+*.pid
+frps
+frpc
+frps.exe
+frpc.exe
+
+# Local configuration
+.frp-tunnel/
+config/local_*
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# macOS
+.DS_Store
+
+# Windows
+Thumbs.db
+ehthumbs.db
+Desktop.ini

frp_tunnel-1.0.4/CHANGELOG.md

@@ -0,0 +1,72 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial project structure
+- Comprehensive documentation
+- Multi-platform support
+- GitHub Actions CI/CD pipeline
+
+## [1.0.0] - 2026-02-04
+
+### Added
+- FRP server setup script for GCP/VPS
+- FRP client scripts for multiple platforms:
+  - Google Colab
+  - Linux/macOS
+  - Windows PowerShell
+- Automated SSH tunnel configuration
+- Token-based authentication system
+- Multi-client support (ports 6001-6010)
+- Smart configuration management
+- Real-time monitoring and diagnostics
+- Comprehensive documentation:
+  - Installation guide
+  - Configuration reference
+  - Troubleshooting guide
+- Example implementations:
+  - Jupyter notebook for Colab
+  - Automation script for batch operations
+- Security features:
+  - RSA key authentication
+  - Token validation
+  - Firewall configuration
+- Project templates:
+  - GitHub issue templates
+  - Pull request template
+  - Contributing guidelines
+  - Security policy
+
+### Features
+- **One-click deployment**: Single command setup for all platforms
+- **Cross-platform compatibility**: Works on Linux, Windows, macOS, and Google Colab
+- **Secure by default**: Implements RSA key authentication and token validation
+- **Scalable architecture**: Supports up to 10 concurrent client connections
+- **Smart configuration**: Preserves existing configs, optional force overwrite
+- **Comprehensive logging**: Detailed logs for debugging and monitoring
+- **Auto-recovery**: Built-in health checks and restart mechanisms
+
+### Documentation
+- Complete README with quick start guide
+- Detailed installation instructions
+- Configuration reference with examples
+- Troubleshooting guide with common solutions
+- Contributing guidelines for developers
+- Security policy and best practices
+- Example implementations and automation scripts
+
+### Infrastructure
+- GitHub Actions CI/CD pipeline
+- Automated testing for shell scripts and PowerShell
+- Security scanning for hardcoded secrets
+- Documentation linting and link checking
+- Issue and PR templates for better collaboration
+
+[Unreleased]: https://github.com/cicy-dev/frp-tunnel/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/cicy-dev/frp-tunnel/releases/tag/v1.0.0

frp_tunnel-1.0.4/CONTRIBUTING.md

@@ -0,0 +1,149 @@
+# Contributing to FRP SSH Tunnel
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## Development Process
+
+We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
+
+## Pull Requests
+
+Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using GitHub's [issue tracker](https://github.com/cicy-dev/frp-tunnel/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/cicy-dev/frp-tunnel/issues/new); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+## Development Setup
+
+### Prerequisites
+
+- Linux/macOS/Windows with WSL
+- Bash 4.0+
+- SSH client
+- Git
+
+### Local Development
+
+```bash
+# Clone the repository
+git clone https://github.com/cicy-dev/frp-tunnel.git
+cd frp-tunnel
+
+# Make scripts executable
+chmod +x scripts/*.sh
+
+# Test server script
+./scripts/frp-server-gcp.sh -t
+
+# Test client script
+./scripts/frp-client-colab.sh --help
+```
+
+### Testing
+
+```bash
+# Run basic tests
+./tests/run-tests.sh
+
+# Test specific platform
+./tests/test-linux.sh
+./tests/test-windows.ps1
+```
+
+## Code Style
+
+### Shell Scripts
+
+- Use `#!/bin/bash` shebang
+- Use `set -e` for error handling
+- Use meaningful variable names
+- Add comments for complex logic
+- Follow [Google Shell Style Guide](https://google.github.io/styleguide/shellguide.html)
+
+### PowerShell Scripts
+
+- Use approved verbs
+- Include help documentation
+- Handle errors gracefully
+- Follow [PowerShell Best Practices](https://docs.microsoft.com/en-us/powershell/scripting/developer/cmdlet/strongly-encouraged-development-guidelines)
+
+### Documentation
+
+- Use clear, concise language
+- Include code examples
+- Update README.md for new features
+- Add troubleshooting entries for common issues
+
+## Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
+
+## Feature Requests
+
+We welcome feature requests! Please:
+
+1. Check if the feature already exists
+2. Search existing issues to avoid duplicates
+3. Provide detailed use cases
+4. Consider implementation complexity
+
+## Code of Conduct
+
+### Our Pledge
+
+We pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+### Enforcement
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+## References
+
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)