sphragis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c42aaaa6c03beb1f59d52fb1199d1d2e698cedc948c1090fd15ab220380d66c5
+  data.tar.gz: af16ca3d9aa7dbad982c4cf996bbda71bf42400ddd81b5598d25150e2723aa58
+SHA512:
+  metadata.gz: 3ad587b5f0a3bfdb3ee7f24ea1ba193d09f42896042eeacfdb61222ca1f3decafb0144f41f696291707ab68c0cf05a34cc379be9929acd8db5c09f10995853e4
+  data.tar.gz: 4578175283a882a5fc14e53b1951cc9bd8e8a141db71d262d317f529c96f706fc6d7c6f182f897533d12706d379c83337722d30bb2f4d08e9738b81109ba76e1

data/.rubocop.yml

@@ -0,0 +1,61 @@
+# Sphragis RuboCop Configuration
+
+require:
+  - rubocop-rails
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+
+# Metrics
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - 'test/**/*'
+
+Metrics/ClassLength:
+  Max: 150
+  Exclude:
+    - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'test/**/*'
+
+# Style
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Layout
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'test/**/*'
+
+# Rails
+Rails/ApplicationController:
+  Enabled: false
+
+# Minitest
+Minitest/MultipleAssertions:
+  Max: 10

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# 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 release of Sphragis (Σφραγίς) - Digital PDF Signatures for Rails
+- Multi-provider architecture supporting:
+  - Fortify WebCrypto (FREE open-source, hardware tokens)
+  - Harica (FREE for Greek academic institutions, eIDAS qualified)
+  - Itsme (template for free e-signature services)
+- Rails Engine with interactive PDF signature placement
+- PDF.js-based viewer with drag-and-drop signature positioning
+- Provider factory pattern for easy extension
+- Configuration system with environment variable support
+- Comprehensive documentation suite
+- Logo design inspired by ancient Greek σφραγιδόλιθοι (sealstones)
+- Complete test suite (Minitest)
+- RuboCop code quality checks
+- Bundler-audit security scanning
+
+### Documentation
+- README.md with quick start guide
+- PROVIDERS.md for provider comparison
+- FORTIFY_WEBCRYPTO.md for Fortify setup
+- LICENSING_SUMMARY.md for cost breakdown
+- MULTIPLE_PROVIDERS.md for multi-provider usage
+- LOGO.md for branding guidelines
+- LOGO_FILES.md for logo assets reference
+
+## Notes
+
+### Breaking Changes Policy
+Major version bumps (1.0.0, 2.0.0, etc.) will include breaking changes.
+Minor version bumps (0.2.0, 0.3.0, etc.) add features in a backwards-compatible manner.
+Patch version bumps (0.1.1, 0.1.2, etc.) are backwards-compatible bug fixes.
+
+### Migration Guides
+When breaking changes occur, migration guides will be provided in the changelog entry.
+
+### Free for Greek Academic Institutions
+This gem provides **FREE** integration with Harica for Greek academic institutions (.gr.ac domains).
+See README.md for details on FREE eIDAS qualified certificates.
+
+---
+
+**Legend**:
+- `Added` - New features
+- `Changed` - Changes in existing functionality
+- `Deprecated` - Soon-to-be removed features
+- `Removed` - Removed features
+- `Fixed` - Bug fixes
+- `Security` - Security fixes and improvements
+- `Documentation` - Documentation changes
+
+### Disclaimer
+
+> **⚠️ EARLY DEVELOPMENT VERSION**
+>
+> This gem is in early development and has not been thoroughly tested in production environments.
+> Use at your own risk and test extensively before deploying to production.
+
+**Sphragis is an independent open-source project.** We are NOT affiliated with, endorsed by, or sponsored by Peculiar Ventures (Fortify), Harica, Yubico, Nitrokey, ItsMe, OpenSC Project, or any other third-party service or product mentioned in this project. All trademarks are property of their respective owners.
+
+### Credits
+
+- **[Fortify by Peculiar Ventures](https://github.com/PeculiarVentures/fortify)** - FREE WebCrypto bridge (MIT License)
+- **[HARICA](https://www.harica.gr)** - Greek Academic CA (FREE for academic institutions)
+- **[Prawn PDF](https://github.com/prawnpdf/prawn)** - Ruby PDF generation (GPL/Commercial)
+- **[PDF.js](https://mozilla.github.io/pdf.js/)** - JavaScript PDF rendering (Apache 2.0)
+- **[OpenSC](https://github.com/OpenSC/OpenSC)** - PKCS#11 middleware (LGPL)
+- Ancient Greek craftsmen who created the original σφραγιδόλιθοι (sealstones)

data/README.md

@@ -0,0 +1,378 @@
+![Sphragis Banner](media/logo-banner.svg)
+
+# Sphragis (Σφραγίς)
+
+> **⚠️ EARLY DEVELOPMENT VERSION**
+>
+> This gem is in early development and has not been thoroughly tested in production environments.
+> Use at your own risk and test extensively before deploying to production.
+
+**Digital PDF Signatures for Rails Applications**
+
+Sphragis (Σφραγίς - Greek for "seal") is a Rails Engine that provides multi-provider PDF digital signatures with interactive placement preview. Perfect for academic institutions and commercial use.
+
+```ruby
+gem 'sphragis'
+```
+
+## Features
+
+- **🔐 Multi-Provider Support**: Hardware tokens (Fortify WebCrypto), cloud e-signatures (Harica), and more
+- **🎯 Interactive Placement**: Drag-and-drop signature placement with PDF.js preview
+- **🏛️ Greek Academic Focus**: FREE integration with Harica for Greek universities
+- **💰 Cost-Effective**: Multiple FREE and low-cost options (€0-50)
+- **🔒 High Security**: Support for qualified electronic signatures (eIDAS)
+- **🎨 Rails Engine**: Drop-in integration with existing Rails apps
+- **⚡ Simple API**: Easy programmatic and UI-based signing
+
+## Quick Start
+
+### Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'sphragis'
+```
+
+Run:
+
+```bash
+bundle install
+rails sphragis:install:migrations
+rails db:migrate
+```
+
+Mount the engine in `config/routes.rb`:
+
+```ruby
+mount Sphragis::Engine, at: "/signatures"
+```
+
+### Configuration
+
+Create `config/initializers/sphragis.rb`:
+
+```ruby
+Sphragis.configure do |config|
+  # Choose your provider
+  config.default_provider = :harica  # or :fortify_webcrypto, :itsme
+
+  # Harica configuration (FREE for Greek academic institutions)
+  config.harica_username = Rails.application.credentials.dig(:harica, :username)
+  config.harica_password = Rails.application.credentials.dig(:harica, :password)
+  config.harica_api_key = Rails.application.credentials.dig(:harica, :api_key)
+
+  # OR Fortify WebCrypto (FREE software + ~€50 hardware token)
+  # config.fortify_url = "https://localhost:31337"
+  # config.fortify_certificate_id = "your_cert_id"
+end
+```
+
+### Basic Usage
+
+```ruby
+# Programmatic signing
+signer = Sphragis::PdfSigner.new("document.pdf", {
+  provider: :harica,
+  reason: "Official approval",
+  location: "University of Aegean",
+  contact: "admin@aegean.gr"
+})
+signed_path = signer.sign
+
+# Interactive UI
+redirect_to sphragis.preview_path(path: "document.pdf")
+```
+
+## Supported Providers
+
+| Provider | Software Cost | Hardware Cost | Total Cost | Security Level |
+|----------|---------------|---------------|------------|----------------|
+| **Harica (Academic)** | FREE | €0 | **€0** | Qualified (eIDAS) |
+| **Fortify WebCrypto** | FREE | €50 (one-time) | **€50** | Qualified* |
+| **Itsme (Template)** | FREE | €0 | **€0** | Simple |
+
+*With qualified certificate from CA like Harica
+
+### 1. Harica - FREE for Greek Academia
+
+Perfect for Greek universities and research institutions:
+
+```ruby
+config.default_provider = :harica
+config.harica_username = "you@aegean.gr"
+config.harica_password = Rails.application.credentials.dig(:harica, :password)
+```
+
+- ✅ **Cost**: €0 for .gr.ac domains
+- ✅ **Security**: eIDAS qualified electronic signatures
+- ✅ **Setup time**: 15 minutes
+- 📚 **Documentation**: [PROVIDERS.md](doc/PROVIDERS.md)
+
+### 2. Fortify WebCrypto - FREE Software + Hardware
+
+For maximum security with hardware tokens:
+
+```ruby
+config.default_provider = :fortify_webcrypto
+config.fortify_url = "https://localhost:31337"
+```
+
+- ✅ **Software**: FREE (MIT license)
+- ✅ **Hardware**: YubiKey ~€50 (one-time)
+- ✅ **Source**: https://github.com/PeculiarVentures/fortify-releases
+- 📚 **Documentation**: [FORTIFY_WEBCRYPTO.md](doc/FORTIFY_WEBCRYPTO.md)
+
+### 3. Custom Providers
+
+Extend `BaseProvider` for your own signature service:
+
+```ruby
+module Sphragis::Providers
+  class MyProvider < BaseProvider
+    def sign(data)
+      # Your implementation
+    end
+  end
+end
+```
+
+See [PROVIDERS.md](doc/PROVIDERS.md) for details.
+
+## Interactive UI
+
+Sphragis includes a complete web interface for signature placement:
+
+```ruby
+# In your controller
+def sign_document
+  @document = Document.find(params[:id])
+  redirect_to sphragis.preview_path(path: @document.pdf.path)
+end
+```
+
+Features:
+- 📄 PDF.js viewer
+- 🖱️ Drag-and-drop signature placement
+- 📏 Real-time coordinate preview
+- 🔄 Provider selection dropdown
+- ✅ Live signature preview
+
+## API Documentation
+
+### PdfSigner
+
+```ruby
+signer = Sphragis::PdfSigner.new(pdf_path, options)
+signed_path = signer.sign
+```
+
+**Options:**
+- `provider`: `:harica`, `:fortify_webcrypto`, `:itsme` (default: configured default)
+- `reason`: Reason for signing (e.g., "Approved")
+- `location`: Signing location (e.g., "Athens, Greece")
+- `contact`: Contact info (e.g., "admin@example.com")
+- `x`, `y`, `width`, `height`: Signature box coordinates (points)
+- `page`: Page number (0-indexed)
+
+### Configuration
+
+```ruby
+Sphragis.configure do |config|
+  config.default_provider = :harica
+
+  # Harica
+  config.harica_username = "user@aegean.gr"
+  config.harica_password = "secret"
+  config.harica_api_key = "api_key"
+  config.harica_certificate_id = "cert_id"
+  config.harica_environment = "production"  # or 'sandbox'
+
+  # Fortify WebCrypto
+  config.fortify_url = "https://localhost:31337"
+  config.fortify_certificate_id = "cert_id"
+
+  # Itsme
+  config.itsme_client_id = "client_id"
+  config.itsme_client_secret = "secret"
+  config.itsme_user_email = "user@example.com"
+  config.itsme_environment = "production"
+end
+```
+
+### Provider Factory
+
+```ruby
+# List available providers
+Sphragis::ProviderFactory.available_providers
+# => [:harica, :fortify_webcrypto]
+
+# Create provider instance
+provider = Sphragis::ProviderFactory.create(:harica)
+provider.connect
+signature = provider.sign(data)
+provider.disconnect
+```
+
+## Cost Breakdown
+
+### Greek Academic Institution (Recommended)
+
+```
+Sphragis gem: FREE
+Harica: FREE (academic)
+Total: €0
+```
+
+### Commercial with Hardware Token
+
+```
+Sphragis gem: FREE
+Fortify WebCrypto: FREE
+YubiKey: €50 (one-time)
+Certificate: €0-200/year
+Total: €50-250 first year
+```
+
+### Development/Testing
+
+```
+Sphragis gem: FREE
+Simulated provider: FREE
+Total: €0
+```
+
+See [LICENSING_SUMMARY.md](doc/LICENSING_SUMMARY.md) for complete details.
+
+## Requirements
+
+- Ruby 3.2+
+- Rails 6.1+
+- For Fortify WebCrypto:
+  - Fortify app (FREE): https://github.com/PeculiarVentures/fortify-releases
+  - Hardware token: YubiKey or similar (~€50)
+- For Harica:
+  - Greek academic email (.gr.ac)
+  - Harica account (FREE)
+
+## Testing
+
+```bash
+bundle exec rake test
+```
+
+All tests use Minitest with Mocha for mocking.
+
+## Code Quality & Security
+
+```bash
+# Run RuboCop
+bundle exec rubocop
+
+# Security audit
+bundle exec bundle-audit check
+```
+
+## Documentation
+
+- [PROVIDERS.md](doc/PROVIDERS.md) - Provider comparison and configuration
+- [FORTIFY_WEBCRYPTO.md](doc/FORTIFY_WEBCRYPTO.md) - Fortify setup guide
+- [LICENSING_SUMMARY.md](doc/LICENSING_SUMMARY.md) - Complete cost breakdown
+- [MULTIPLE_PROVIDERS.md](doc/MULTIPLE_PROVIDERS.md) - Multi-provider usage
+- [LOGO.md](doc/LOGO.md) - Logo design and branding
+
+## Logo & Branding
+
+The Sphragis logo is inspired by ancient Greek σφραγιδόλιθοι (sealstones) - precious carved stones used for 3,000 years to authenticate documents. Just as ancient seals authenticated documents through physical impression, Sphragis authenticates digital documents through cryptographic signatures.
+
+See [LOGO.md](doc/LOGO.md) for design details.
+
+## Development Status
+
+**Current Version**: 0.1.0 (Early Development)
+
+**⚠️ Important Notes:**
+- This gem is in early development
+- Not yet tested in production environments
+- API may change in future versions
+- Test thoroughly before production use
+- Contributions and feedback welcome
+
+**Completed:**
+- ✅ Multi-provider architecture
+- ✅ Harica integration
+- ✅ Fortify WebCrypto integration
+- ✅ Interactive UI with PDF.js
+- ✅ Minitest test suite
+- ✅ RuboCop configuration
+- ✅ Security audit setup
+
+**Planned:**
+- 🔄 Production testing and hardening
+- 🔄 Additional provider support
+- 🔄 Batch signing operations
+- 🔄 Signature verification
+- 🔄 Audit logging
+- 🔄 Performance optimization
+
+## Contributing
+
+Contributions welcome! This gem is developed at the University of the Aegean.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Run tests (`bundle exec rake test`)
+4. Run RuboCop (`bundle exec rubocop`)
+5. Commit your changes (`git commit -am 'Add amazing feature'`)
+6. Push to the branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+Please ensure:
+- All tests pass
+- RuboCop violations are resolved
+- New features include tests
+- Documentation is updated
+
+## License
+
+MIT License - See [LICENSE](LICENSE) for details.
+
+## Author
+
+**Michail Pantelakis**
+- Email: mpantel@aegean.gr
+- Institution: University of the Aegean
+- GitHub: https://github.com/mpantel/sphragis
+
+## Acknowledgments
+
+- **Peculiar Ventures** for Fortify WebCrypto (FREE, open source)
+- **HARICA** for FREE academic certificates
+- **University of the Aegean** for supporting this project
+- Ancient Greek craftsmen who created the original σφραγιδόλιθοι
+
+## Disclaimer
+
+**Sphragis is an independent open-source project.** We are NOT affiliated with, endorsed by, or sponsored by any of the third-party providers, services, or products mentioned in this documentation, including but not limited to:
+
+- Peculiar Ventures (Fortify) • Harica • Yubico (YubiKey) • Nitrokey • ItsMe • OpenSC Project • Any certificate authorities or hardware manufacturers
+
+All trademarks and product names are property of their respective owners. This gem provides integration code only. Users are responsible for complying with third-party terms of service and any associated costs.
+
+## Support
+
+- **Issues**: https://github.com/mpantel/sphragis/issues
+- **Email**: mpantel@aegean.gr
+- **Documentation**: See docs/ directory
+
+## Related Projects
+
+- [Fortify by Peculiar Ventures](https://github.com/PeculiarVentures/fortify)
+- [HARICA](https://www.harica.gr)
+- [Prawn PDF](https://github.com/prawnpdf/prawn)
+- [PDF.js](https://mozilla.github.io/pdf.js/)
+
+---
+
+**Σφραγίς** - Bringing 3,000 years of document authentication tradition to the digital age 🔏

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test