コンテンツにスキップ

Sshuttle

システム管理のための、すべてのプラットフォームにわたる包括的な sshuttle コマンドとワークフロー。

基本コマンド

コマンド説明
sshuttle --versionsshuttleのバージョンを表示
sshuttle --helpヘルプ情報を表示
sshuttle initカレントディレクトリで sshuttle を初期化する
sshuttle status現在のステータスを確認
sshuttle list利用可能なオプションをリスト
sshuttle infoシステム情報を表示
sshuttle config構成設定を表示
sshuttle update最新バージョンに更新
sshuttle startsshuttleサービスを開始
sshuttle stopsshuttleサービスを停止
sshuttle restartsshuttleサービスを再起動
sshuttle reload設定をリロード

インストール

Linux/Ubuntu

# Package manager installation
sudo apt update
sudo apt install sshuttle

# Alternative installation
wget https://github.com/example/sshuttle/releases/latest/download/sshuttle-linux
chmod +x sshuttle-linux
sudo mv sshuttle-linux /usr/local/bin/sshuttle

# Build from source
git clone https://github.com/example/sshuttle.git
cd sshuttle
make && sudo make install

macOS

# Homebrew installation
brew install sshuttle

# MacPorts installation
sudo port install sshuttle

# Manual installation
curl -L -o sshuttle https://github.com/example/sshuttle/releases/latest/download/sshuttle-macos
chmod +x sshuttle
sudo mv sshuttle /usr/local/bin/

Windows

# Chocolatey installation
choco install sshuttle

# Scoop installation
scoop install sshuttle

# Winget installation
winget install sshuttle

# Manual installation
# Download from https://github.com/example/sshuttle/releases
# Extract and add to PATH

設定

コマンド説明
sshuttle config show現在の設定を表示
sshuttle config listすべての設定オプションを一覧表示
sshuttle config set <key> <value>設定値を構成する
sshuttle config get <key>設定値を取得
sshuttle config unset <key>設定値を削除
sshuttle config resetデフォルト設定にリセット
sshuttle config validate設定ファイルを検証する
sshuttle config export設定をファイルにエクスポート

高度な操作

ファイル操作

# Create new file/resource
sshuttle create <name>

# Read file/resource
sshuttle read <name>

# Update existing file/resource
sshuttle update <name>

# Delete file/resource
sshuttle delete <name>

# Copy file/resource
sshuttle copy <source> <destination>

# Move file/resource
sshuttle move <source> <destination>

# List all files/resources
sshuttle list --all

# Search for files/resources
sshuttle search <pattern>

ネットワーク操作

# Connect to remote host
sshuttle connect <host>:<port>

# Listen on specific port
sshuttle listen --port <port>

# Send data to target
sshuttle send --target <host> --data "<data>"

# Receive data from source
sshuttle receive --source <host>

# Test connectivity
sshuttle ping <host>

# Scan network range
sshuttle scan <network>

# Monitor network traffic
sshuttle monitor --interface <interface>

# Proxy connections
sshuttle proxy --listen <port> --target <host>:<port>

プロセス管理

# Start background process
sshuttle start --daemon

# Stop running process
sshuttle stop --force

# Restart with new configuration
sshuttle restart --config <file>

# Check process status
sshuttle status --verbose

# Monitor process performance
sshuttle monitor --metrics

# Kill all processes
sshuttle killall

# Show running processes
sshuttle ps

# Manage process priority
sshuttle priority --pid <pid> --level <level>

セキュリティ機能

認証

# Login with username/password
sshuttle login --user <username>

# Login with API key
sshuttle login --api-key <key>

# Login with certificate
sshuttle login --cert <cert_file>

# Logout current session
sshuttle logout

# Change password
sshuttle passwd

# Generate new API key
sshuttle generate-key --name <key_name>

# List active sessions
sshuttle sessions

# Revoke session
sshuttle revoke --session <session_id>

暗号化

# Encrypt file
sshuttle encrypt --input <file> --output <encrypted_file>

# Decrypt file
sshuttle decrypt --input <encrypted_file> --output <file>

# Generate encryption key
sshuttle keygen --type <type> --size <size>

# Sign file
sshuttle sign --input <file> --key <private_key>

# Verify signature
sshuttle verify --input <file> --signature <sig_file>

# Hash file
sshuttle hash --algorithm <algo> --input <file>

# Generate certificate
sshuttle cert generate --name <name> --days <days>

# Verify certificate
sshuttle cert verify --cert <cert_file>

モニタリングとログ

システムモニタリング

# Monitor system resources
sshuttle monitor --system

# Monitor specific process
sshuttle monitor --pid <pid>

# Monitor network activity
sshuttle monitor --network

# Monitor file changes
sshuttle monitor --files <directory>

# Real-time monitoring
sshuttle monitor --real-time --interval 1

# Generate monitoring report
sshuttle report --type monitoring --output <file>

# Set monitoring alerts
sshuttle alert --threshold <value> --action <action>

# View monitoring history
sshuttle history --type monitoring

ログ

# View logs
sshuttle logs

# View logs with filter
sshuttle logs --filter <pattern>

# Follow logs in real-time
sshuttle logs --follow

# Set log level
sshuttle logs --level <level>

# Rotate logs
sshuttle logs --rotate

# Export logs
sshuttle logs --export <file>

# Clear logs
sshuttle logs --clear

# Archive logs
sshuttle logs --archive <archive_file>

トラブルシューティング

一般的な問題

問題: コマンドが見つかりません

# Check if sshuttle is installed
which sshuttle
sshuttle --version

# Check PATH variable
echo $PATH

# Reinstall if necessary
sudo apt reinstall sshuttle
# or
brew reinstall sshuttle

問題: 権限が拒否されました

# Run with elevated privileges
sudo sshuttle <command>

# Check file permissions
ls -la $(which sshuttle)

# Fix permissions
chmod +x /usr/local/bin/sshuttle

# Check ownership
sudo chown $USER:$USER /usr/local/bin/sshuttle

問題: 設定エラー

# Validate configuration
sshuttle config validate

# Reset to default configuration
sshuttle config reset

# Check configuration file location
sshuttle config show --file

# Backup current configuration
sshuttle config export > backup.conf

# Restore from backup
sshuttle config import backup.conf

問題: サービスが起動しません

# Check service status
sshuttle status --detailed

# Check system logs
journalctl -u sshuttle

# Start in debug mode
sshuttle start --debug

# Check port availability
netstat -tulpn|grep <port>

# Kill conflicting processes
sshuttle killall --force

デバッグコマンド

コマンド説明
sshuttle --debugデバッグ出力を有効にする
sshuttle --verbose詳細なログを有効にする
sshuttle --traceトレースログを有効にする
sshuttle test組み込みテストを実行
sshuttle doctorシステムヘルスチェックを実行
sshuttle diagnose診断レポートを生成
sshuttle benchmarkパフォーマンスベンチマークを実行する
sshuttle validateインストールと設定を検証

パフォーマンス最適化

リソース管理

# Set memory limit
sshuttle --max-memory 1G <command>

# Set CPU limit
sshuttle --max-cpu 2 <command>

# Enable caching
sshuttle --cache-enabled <command>

# Set cache size
sshuttle --cache-size 100M <command>

# Clear cache
sshuttle cache clear

# Show cache statistics
sshuttle cache stats

# Optimize performance
sshuttle optimize --profile <profile>

# Show performance metrics
sshuttle metrics

並列処理```bash

Enable parallel processing

sshuttle —parallel

Set number of workers

sshuttle —workers 4

Process in batches

sshuttle —batch-size 100

Queue management

sshuttle queue add sshuttle queue process sshuttle queue status sshuttle queue clear

## 統合

### スクリプティング
```bash
#!/bin/bash
# Example script using sshuttle

set -euo pipefail

# Configuration
CONFIG_FILE="config.yaml"
LOG_FILE="sshuttle.log"

# Check if sshuttle is available
if ! command -v sshuttle &> /dev/null; then
    echo "Error: sshuttle is not installed" >&2
    exit 1
fi

# Function to log messages
log() \\\\{
    echo "$(date '+%Y-%m-%d %H:%M:%S') - $1"|tee -a "$LOG_FILE"
\\\\}

# Main operation
main() \\\\{
    log "Starting sshuttle operation"

    if sshuttle --config "$CONFIG_FILE" run; then
        log "Operation completed successfully"
        exit 0
    else
        log "Operation failed with exit code $?"
        exit 1
    fi
\\\\}

# Cleanup function
cleanup() \\\\{
    log "Cleaning up"
    sshuttle cleanup
\\\\}

# Set trap for cleanup
trap cleanup EXIT

# Run main function
main "$@"

APIの統合

#!/usr/bin/env python3
"""
Python wrapper for the tool
"""

import subprocess
import json
import logging
from pathlib import Path
from typing import Dict, List, Optional

class ToolWrapper:
    def __init__(self, config_file: Optional[str] = None):
        self.config_file = config_file
        self.logger = logging.getLogger(__name__)

    def run_command(self, args: List[str]) -> Dict:
        """Run command and return parsed output"""
        cmd = ['tool_name']

        if self.config_file:
            cmd.extend(['--config', self.config_file])

        cmd.extend(args)

        try:
            result = subprocess.run(
                cmd,
                capture_output=True,
                text=True,
                check=True
            )
            return \\\\{'stdout': result.stdout, 'stderr': result.stderr\\\\}
        except subprocess.CalledProcessError as e:
            self.logger.error(f"Command failed: \\\\{e\\\\}")
            raise

    def status(self) -> Dict:
        """Get current status"""
        return self.run_command(['status'])

    def start(self) -> Dict:
        """Start service"""
        return self.run_command(['start'])

    def stop(self) -> Dict:
        """Stop service"""
        return self.run_command(['stop'])

# Example usage
if __name__ == "__main__":
    wrapper = ToolWrapper()
    status = wrapper.status()
    print(json.dumps(status, indent=2))

環境変数

変数説明デフォルト
SSHUTTLE_CONFIG設定ファイルのパス~/.sshuttle/config.yaml
SSHUTTLE_HOMEホームディレクトリ~/.sshuttle
SSHUTTLE_LOG_LEVELログレベルINFO
SSHUTTLE_LOG_FILEログファイルのパス~/.sshuttle/logs/sshuttle.log
SSHUTTLE_CACHE_DIRキャッシュディレクトリ~/.sshuttle/cache
SSHUTTLE_DATA_DIRデータディレクトリ~/.sshuttle/data
SSHUTTLE_TIMEOUTデフォルトタイムアウト30s
SSHUTTLE_MAX_WORKERS最大作業者数4

設定ファイル

# ~/.sshuttle/config.yaml
version: "1.0"

# General settings
settings:
  debug: false
  verbose: false
  log_level: "INFO"
  log_file: "~/.sshuttle/logs/sshuttle.log"
  timeout: 30
  max_workers: 4

# Network configuration
network:
  host: "localhost"
  port: 8080
  ssl: true
  timeout: 30
  retries: 3

# Security settings
security:
  auth_required: true
  api_key: ""
  encryption: "AES256"
  verify_ssl: true

# Performance settings
performance:
  cache_enabled: true
  cache_size: "100M"
  cache_dir: "~/.sshuttle/cache"
  max_memory: "1G"

# Monitoring settings
monitoring:
  enabled: true
  interval: 60
  metrics_enabled: true
  alerts_enabled: true

基本的なワークフロー

# 1. Initialize sshuttle
sshuttle init

# 2. Configure basic settings
sshuttle config set host example.com
sshuttle config set port 8080

# 3. Start service
sshuttle start

# 4. Check status
sshuttle status

# 5. Perform operations
sshuttle run --target example.com

# 6. View results
sshuttle results

# 7. Stop service
sshuttle stop

高度なワークフロー

# Comprehensive operation with monitoring
sshuttle run \
  --config production.yaml \
  --parallel \
  --workers 8 \
  --verbose \
  --timeout 300 \
  --output json \
  --log-file operation.log

# Monitor in real-time
sshuttle monitor --real-time --interval 5

# Generate report
sshuttle report --type comprehensive --output report.html

自動化の例

#!/bin/bash
# Automated sshuttle workflow

# Configuration
TARGETS_FILE="targets.txt"
RESULTS_DIR="results/$(date +%Y-%m-%d)"
CONFIG_FILE="automation.yaml"

# Create results directory
mkdir -p "$RESULTS_DIR"

# Process each target
while IFS= read -r target; do
    echo "Processing $target..."

    sshuttle \
        --config "$CONFIG_FILE" \
        --output json \
        --output-file "$RESULTS_DIR/$\\\\{target\\\\}.json" \
        run "$target"

done < "$TARGETS_FILE"

# Generate summary report
sshuttle report summary \
    --input "$RESULTS_DIR/*.json" \
    --output "$RESULTS_DIR/summary.html"

ベストプラクティス

セキュリティ

  • バイナリをダウンロードする際は常にチェックサムを確認する
  • 強力な認証方法を使用する(APIキー、証明書)
  • 最新バージョンに定期的に更新する
  • 最小権限の原則に従う
  • コンプライアンスのための監査ログを有効にする
  • 可能な限り暗号化された接続を使用する
  • すべての入力と設定を検証する
  • 適切なアクセス制御を実装する

パフォーマンス

  • 環境に適したリソース制限を使用する
  • システムパフォーマンスを定期的に監視する
  • ユースケースに最適な設定を行う
  • 有益な場合は並列処理を使用する
  • 適切なキャッシュ戦略を実装する
  • 定期的なメンテナンスとクリーンアップ
  • パフォーマンスのボトルネックをプロファイリングする
  • 効率的なアルゴリズムとデータ構造を使用する

運用

  • 包括的なドキュメンテーションを維持する
  • 適切なバックアップ戦略を実装する
  • 設定のバージョン管理を使用する
  • 重要なメトリクスを監視およびアラートする
  • 適切なエラーハンドリングを実装する
  • 繰り返しのタスクを自動化する
  • 定期的なセキュリティ監査と更新
  • 災害復旧を計画する

開発

  • コーディング標準と規約に従う
  • 包括的なテストを作成する
  • 継続的インテグレーション/デプロイメントを使用する
  • 適切なログ記録と監視を実装する
  • APIとインターフェースを文書化する
  • バージョン管理を効果的に使用する
  • コードを定期的にレビューする
  • 下位互換性を維持する

リソース

公式ドキュメンテーション

コミュニティリソース

学習リソース


*最終更新日: 2025-07-06|GitHub で編集https://github.com/perplext/1337skills/edit/main/docs/cheatsheets/sshuttle.md)