keysloth 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49887eb92bcda0765f1598cff713b8820be1bf341259d22797c0b7cbce8a0ed6
+  data.tar.gz: eaa959d6e6bd4495635dd09c53f5c6e66911f517b10639651e691d7d67cfefd4
+SHA512:
+  metadata.gz: 4be3619d2eb8e824132985421b8ea5b7853921dae1e42962543ee313bb6e59bdb8e9091b454781e441a112fe7e35f4aba769e0293ae55bb084de0c4c1cb5f107
+  data.tar.gz: 933bf6a35dce1daebd282f90627fad87f13660089b6972044ba68b939d05572b50bf0fa39b357a8bd01417f31e64dae58c339c801dc987b7dd0312fec622ccea

data/.keyslothrc.example

@@ -0,0 +1,14 @@
+# Пример конфигурационного файла KeySloth
+# Скопируйте этот файл в .keyslothrc и настройте под ваш проект
+
+# URL Git репозитория для хранения зашифрованных секретов (SSH)
+repo_url: "git@github.com:company/secrets.git"
+
+# Ветка по умолчанию для работы с секретами
+branch: "main"
+
+# Локальный путь для расшифрованных секретов
+local_path: "./secrets"
+
+# Количество резервных копий для хранения
+backup_count: 3

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,98 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'spec/fixtures/**/*'
+
+# Настройки стиля
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'keysloth.gemspec'
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'Rakefile'
+    - 'keysloth.gemspec'
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'spec/**/*'
+
+# Настройки документации
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: false
+
+# Настройки безопасности
+
+Security/Eval:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
+
+# Настройки производительности
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/RedundantBlockCall:
+  Enabled: true
+
+# Настройки для RSpec
+
+RSpec/ExampleLength:
+  Max: 15
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/DescribeClass:
+  Enabled: true
+
+# Отключаем некоторые правила для большей гибкости
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,8 @@
+--markup markdown
+--title "KeySloth API Documentation"
+--readme README.md
+--output-dir doc
+--protected
+lib/**/*.rb
+- 
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+Все значимые изменения в проекте KeySloth будут документированы в этом файле.
+
+Формат основан на [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2025-09-02
+
+### Changed
+- Переведена работа с Git на системный git (через Open3), удалена зависимость от Rugged/libgit2
+- Обновлены тесты `spec/keysloth/git_manager_spec.rb` под системный git
+- Улучшена SSH-аутентификация: поддержка `KEYSLOTH_SSH_KEY_PATH`, `SSH_PRIVATE_KEY`/`SSH_PUBLIC_KEY` через `GIT_SSH_COMMAND`
+- Поведение pull: `git fetch` + `git pull --ff-only`, с fallback на `--unshallow`
+- Очистка `.enc` и запись файлов выполняются через файловую систему
+- Добавлена проверка настроек автора коммита (`user.name`/`user.email`)
+
+### Docs
+- Удалены инструкции про Rugged из `task/test_plan.md`; уточнены требования к Git/SSH
+
+## [0.1.0] - 2023-12-15
+
+### Added
+- Первоначальный релиз KeySloth
+- Базовая функциональность шифрования/дешифрования с использованием AES-256-GCM
+- Поддержка работы с Git репозиториями через SSH
+- CLI интерфейс с командами pull, push, status, restore
+- Поддержка файлов секретов: .cer, .p12, .mobileprovisioning, .json
+- Автоматическое создание резервных копий
+- Многоуровневое логирование (DEBUG, INFO, ERROR)
+- Поддержка конфигурационных файлов .keyslothrc
+- Интеграция с CI/CD системами через переменные окружения
+- Валидация входных данных и обработка ошибок
+- Полная документация API и пользовательская документация
+- Тесты RSpec с покрытием кода
+- Линтинг кода с RuboCop
+- Поддержка Ruby 2.7+
+
+### Security
+- Реализована защита целостности данных с помощью GCM режима
+- Безопасная деривация ключей из паролей с использованием PBKDF2
+- Поддержка только SSH аутентификации для Git операций
+- Валидация путей файлов для предотвращения атак directory traversal

data/Makefile

@@ -0,0 +1,193 @@
+# Makefile для KeySloth - управление зашифрованными секретами
+#
+# Этот файл содержит примеры команд для работы с KeySloth в проекте.
+# Настройте переменные ниже под ваш проект.
+
+# =============================================================================
+# КОНФИГУРАЦИЯ
+# =============================================================================
+
+# URL вашего репозитория с секретами (измените на свой)
+SECRETS_REPO := git@github.com:company/secrets.git
+
+# Ветка с секретами
+SECRETS_BRANCH := main
+
+# Локальная директория для секретов (добавьте в .gitignore!)
+SECRETS_DIR := ./secrets
+
+# Пароль для шифрования (установите в переменной окружения)
+# Проверка будет выполняться только для команд, которые требуют пароль
+
+# =============================================================================
+# ОСНОВНЫЕ КОМАНДЫ
+# =============================================================================
+
+.PHONY: help
+help: ## Показать справку по доступным командам
+	@echo "KeySloth Makefile - Управление зашифрованными секретами"
+	@echo ""
+	@echo "НАСТРОЙКА:"
+	@echo "  1. Установите SECRET_PASSWORD: export SECRET_PASSWORD=your_password"
+	@echo "  2. Измените SECRETS_REPO на URL вашего репозитория"
+	@echo "  3. Убедитесь что $(SECRETS_DIR) добавлен в .gitignore"
+	@echo ""
+	@echo "КОМАНДЫ:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Установить KeySloth gem
+	gem install keysloth
+
+.PHONY: init
+init: ## Инициализировать KeySloth в проекте
+	keysloth init -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -d $(SECRETS_DIR)
+
+.PHONY: pull
+pull: check-password ## Получить и расшифровать секреты из репозитория
+	@echo "🔽 Получаем секреты из $(SECRETS_REPO)..."
+	keysloth pull -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -p "$(SECRET_PASSWORD)" -d $(SECRETS_DIR)
+	@echo "✅ Секреты успешно получены в $(SECRETS_DIR)"
+
+.PHONY: push
+push: check-password ## Зашифровать и отправить секреты в репозиторий
+	@echo "🔼 Отправляем секреты в $(SECRETS_REPO)..."
+	@read -p "Введите сообщение коммита: " msg; \
+	keysloth push -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -p "$(SECRET_PASSWORD)" -d $(SECRETS_DIR) -m "$$msg"
+	@echo "✅ Секреты успешно отправлены"
+
+.PHONY: status
+status: ## Проверить состояние локальных секретов
+	@echo "📊 Проверяем состояние секретов..."
+	keysloth status -d $(SECRETS_DIR)
+
+.PHONY: validate
+validate: ## Проверить целостность файлов секретов
+	@echo "🔍 Проверяем целостность секретов..."
+	keysloth validate -d $(SECRETS_DIR)
+
+.PHONY: backup-list
+backup-list: ## Показать доступные резервные копии
+	@echo "📁 Доступные резервные копии:"
+	@ls -la $(SECRETS_DIR)_backup_* 2>/dev/null || echo "Резервные копии не найдены"
+
+.PHONY: restore
+restore: ## Восстановить секреты из backup'а (использование: make restore BACKUP=backup_name)
+	@if [ -z "$(BACKUP)" ]; then \
+		echo "❌ Укажите backup для восстановления: make restore BACKUP=secrets_backup_20231215_143022"; \
+		exit 1; \
+	fi
+	@echo "🔄 Восстанавливаем из $(BACKUP)..."
+	keysloth restore $(BACKUP) -d $(SECRETS_DIR)
+	@echo "✅ Восстановление завершено"
+
+# =============================================================================
+# РАЗРАБОТКА И ОТЛАДКА
+# =============================================================================
+
+.PHONY: check-password
+check-password: ## Проверить что установлен SECRET_PASSWORD
+	@if [ -z "$(SECRET_PASSWORD)" ]; then \
+		echo "❌ SECRET_PASSWORD не установлен. Выполните: export SECRET_PASSWORD=your_password"; \
+		exit 1; \
+	fi
+
+.PHONY: pull-verbose
+pull-verbose: check-password ## Получить секреты с подробным логированием
+	keysloth pull -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -p "$(SECRET_PASSWORD)" -d $(SECRETS_DIR) --verbose
+
+.PHONY: push-verbose
+push-verbose: check-password ## Отправить секреты с подробным логированием
+	@read -p "Введите сообщение коммита: " msg; \
+	keysloth push -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -p "$(SECRET_PASSWORD)" -d $(SECRETS_DIR) -m "$$msg" --verbose
+
+.PHONY: version
+version: ## Показать версию KeySloth
+	keysloth version
+
+# =============================================================================
+# CI/CD КОМАНДЫ
+# =============================================================================
+
+.PHONY: ci-setup-ssh
+ci-setup-ssh: ## Настроить SSH ключи в CI/CD (требует SSH_PRIVATE_KEY)
+	@if [ -z "$(SSH_PRIVATE_KEY)" ]; then \
+		echo "❌ SSH_PRIVATE_KEY не установлен"; \
+		exit 1; \
+	fi
+	@echo "🔑 Настраиваем SSH ключи для CI/CD..."
+	@mkdir -p ~/.ssh
+	@echo "$(SSH_PRIVATE_KEY)" > ~/.ssh/id_rsa
+	@chmod 600 ~/.ssh/id_rsa
+	@ssh-keyscan github.com >> ~/.ssh/known_hosts 2>/dev/null || true
+	@ssh-keyscan gitlab.com >> ~/.ssh/known_hosts 2>/dev/null || true
+	@echo "✅ SSH ключи настроены"
+
+.PHONY: ci-pull
+ci-pull: ci-setup-ssh check-password ## Получить секреты в CI/CD среде
+	@echo "🤖 CI/CD: Получаем секреты..."
+	keysloth pull -r $(SECRETS_REPO) -b $(SECRETS_BRANCH) -p "$(SECRET_PASSWORD)" -d $(SECRETS_DIR) --quiet
+
+.PHONY: ci-validate
+ci-validate: ## Проверить секреты в CI/CD среде
+	@echo "🤖 CI/CD: Проверяем секреты..."
+	keysloth validate -d $(SECRETS_DIR) --quiet
+
+# =============================================================================
+# ОЧИСТКА
+# =============================================================================
+
+.PHONY: clean
+clean: ## Удалить локальные секреты и backup'ы
+	@echo "🧹 Очищаем локальные секреты..."
+	@rm -rf $(SECRETS_DIR)
+	@rm -rf $(SECRETS_DIR)_backup_*
+	@echo "✅ Локальные секреты удалены"
+
+.PHONY: clean-docs
+clean-docs: ## Удалить сгенерированную документацию
+	@echo "🧹 Очищаем документацию..."
+	@rm -rf doc/
+	@echo "✅ Документация удалена"
+
+# =============================================================================
+# ПРИМЕРЫ КОМАНД
+# =============================================================================
+
+.PHONY: example-setup
+example-setup: ## Пример полной настройки проекта
+	@echo "📖 Пример настройки KeySloth в проекте:"
+	@echo ""
+	@echo "1. Установите переменные окружения:"
+	@echo "   export SECRET_PASSWORD=your_strong_password"
+	@echo ""
+	@echo "2. Инициализируйте проект:"
+	@echo "   make init"
+	@echo ""
+	@echo "3. Добавьте файлы секретов в $(SECRETS_DIR)/"
+	@echo ""
+	@echo "4. Отправьте секреты в репозиторий:"
+	@echo "   make push"
+	@echo ""
+	@echo "5. Другие участники команды могут получить секреты:"
+	@echo "   make pull"
+
+.PHONY: example-ci
+example-ci: ## Пример использования в CI/CD
+	@echo "📖 Пример настройки в CI/CD:"
+	@echo ""
+	@echo "GitHub Actions (.github/workflows/deploy.yml):"
+	@echo "  env:"
+	@echo "    SECRET_PASSWORD: \$${{ secrets.SECRET_PASSWORD }}"
+	@echo "    SSH_PRIVATE_KEY: \$${{ secrets.SSH_PRIVATE_KEY }}"
+	@echo "  run: |"
+	@echo "    make ci-pull"
+	@echo "    make ci-validate"
+	@echo ""
+	@echo "GitLab CI (.gitlab-ci.yml):"
+	@echo "  variables:"
+	@echo "    SECRET_PASSWORD: \$$SECRET_PASSWORD"
+	@echo "    SSH_PRIVATE_KEY: \$$SSH_PRIVATE_KEY"
+	@echo "  script:"
+	@echo "    - make ci-pull"
+	@echo "    - make ci-validate"