EE-ID-verification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67e43f423cbb1762439d37935312822805febf6e8fda4992527b2d8377a9ee76
+  data.tar.gz: 322953d63b57bbc3d289ca734012f98cc07ae350a933fa98a455e12ab94c8d5c
+SHA512:
+  metadata.gz: d8d3fbeb81a4d472e3f00efd3105f2f2f9d5e4f9a69ae64acd9eb1968a1df9d4cc7a3009d40a21102da1a94768e858bc005583633b87b6e73c2a49f2897b6ce0
+  data.tar.gz: d16c66eece2f11e1143ec345089418671dc7dcd7dc53a8660e110553428f06e0195aaf27701d2961ed164860188000d59d7f02dc99d76e992d537a8e7e2f2f61

data/.rubocop.yml

@@ -0,0 +1,57 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Disable some overly strict cops for this Estonian ID library
+Metrics/MethodLength:
+  Max: 50  # Some methods handle complex authentication flows
+
+Metrics/ClassLength:
+  Max: 250 # CertificateReader needs comprehensive PKCS#11 functionality
+
+Metrics/AbcSize:
+  Max: 65  # Certificate parsing and authentication are inherently complex
+
+Metrics/CyclomaticComplexity:
+  Max: 15  # Estonian ID cards require complex logic
+
+Metrics/PerceivedComplexity:
+  Max: 15  # Same as above
+
+# Allow longer lines for documentation and examples
+Layout/LineLength:
+  Max: 125
+
+# Allow multiple empty lines for better organization in long files
+Layout/EmptyLines:
+  Enabled: false
+
+# Relax some cops for hardware integration testing
+Lint/SuppressedException:
+  Enabled: false
+
+# Allow predicate methods that aren't boolean for card connections
+Naming/PredicateMethod:
+  Enabled: false
+
+# Allow private class methods for PKCS#11 singleton
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+
+# Allow unused method arguments in placeholder implementations
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+# Allow duplicate branch body in error handling
+Lint/DuplicateBranch:
+  Enabled: false
+
+# Allow redundant else in complex conditionals
+Style/EmptyElse:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-05
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,67 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Common Development Commands
+
+### Setup
+```bash
+bin/setup  # Install dependencies
+```
+
+### Testing
+```bash
+rake test              # Run all tests
+rake test TEST=test/ee_id_verification/test_verification.rb  # Run specific test file
+```
+
+### Linting and Code Quality
+```bash
+rake rubocop           # Run RuboCop linter
+rake rubocop:autocorrect  # Auto-fix linting issues
+```
+
+### Default Task (Tests + Linting)
+```bash
+rake  # Runs both tests and RuboCop
+```
+
+### Development Console
+```bash
+bin/console  # Interactive Ruby console with gem loaded
+```
+
+### Building the Gem
+```bash
+gem build EE-ID-verification.gemspec  # Build the gem package
+```
+
+## Project Scope
+
+This Ruby gem provides Estonian identity verification functionality supporting three authentication methods:
+- **DigiDoc**: ID-card based authentication using digital certificates
+- **Mobile-ID**: Mobile phone-based authentication using SIM cards
+- **Smart-ID**: App-based authentication for smartphones
+
+The gem interfaces with Estonia's official e-identity infrastructure to enable secure authentication and digital signature verification in Ruby applications.
+
+## Code Architecture
+
+This is a Ruby gem for Estonian ID verification following standard Ruby gem conventions.
+
+### Module Structure
+The main module is `EeIdVerification` with:
+- Entry point: `lib/ee_id_verification.rb`
+- Version constant: `lib/ee_id_verification/version.rb`
+- Authenticators: `lib/ee_id_verification/*_authenticator.rb`
+
+### Key Development Considerations
+- Ruby version requirement: >= 3.1.0
+- Testing framework: Minitest
+- Code style: RuboCop with double quotes for strings
+- Type signatures: RBS files in `sig/` directory
+
+### File Naming Convention
+Files follow the standard Ruby gem conventions:
+- `lib/ee_id_verification/feature_name.rb` for new features
+- `test/ee_id_verification/test_feature_name.rb` for corresponding tests

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,98 @@
+# Estonian ID Card Authentication - Development Makefile
+# =====================================================
+#
+# This Makefile provides convenient development commands for the Estonian ID
+# card authentication library. It handles dependency management, testing,
+# building, and provides easy access to hardware testing with real cards.
+#
+# The library uses PKCS#11 interface to communicate with Estonian ID cards
+# through OpenSC, providing secure authentication and personal data extraction.
+
+# Declare all targets as phony to avoid conflicts with files of same names
+.PHONY: help install test test_hardware run_local_card_test build clean
+
+# Default target - shows help when just running 'make'
+help:
+	@echo "Estonian ID Card Authentication"
+	@echo "==============================="
+	@echo ""
+	@echo "Available targets:"
+	@echo "  help                   Show this help message"
+	@echo "  install               Install Ruby dependencies via Bundler"
+	@echo "  test                  Run unit tests (hardware tests skipped)"
+	@echo "  test_hardware         Run all tests including hardware integration"
+	@echo "  run_local_card_test   Interactive test with real Estonian ID card"
+	@echo "  build                 Build the gem package for distribution"
+	@echo "  clean                 Remove built gem files"
+	@echo ""
+	@echo "Prerequisites for hardware testing:"
+	@echo "  - OpenSC installed (brew install opensc on macOS)"
+	@echo "  - Estonian ID card inserted in reader" 
+	@echo "  - PC/SC card reader connected and working"
+	@echo "  - PIN1 available for authentication"
+
+# Install Ruby dependencies using Bundler
+# This ensures all required gems are available for development and testing
+install:
+	@echo "📦 Installing Ruby dependencies..."
+	@echo "   This will install: pkcs11 gem and development dependencies"
+	bundle install
+	@echo "✅ Dependencies installed successfully"
+
+# Run basic test suite without hardware requirements
+# Skips tests that require actual Estonian ID card insertion
+test:
+	@echo "🧪 Running unit tests..."
+	@echo "   Hardware tests are skipped unless HARDWARE_TESTS=1 is set"
+	@echo "   This tests: API, models, personal code parsing, basic functionality"
+	bundle exec ruby -Ilib:test test/ee_id_verification_test.rb
+	@echo "✅ Unit tests completed"
+
+# Run complete test suite including hardware integration tests
+# Requires physical Estonian ID card and will prompt for PIN entry
+test_hardware:
+	@echo "🧪 Running complete test suite with hardware integration..."
+	@echo "⚠️  This requires:"
+	@echo "     - Estonian ID card inserted in reader"
+	@echo "     - Working PC/SC card reader"
+	@echo "     - Your PIN1 for authentication testing"
+	@echo ""
+	@echo "   The test will prompt you to enter your PIN1 when needed"
+	HARDWARE_TESTS=1 bundle exec ruby -Ilib:test test/ee_id_verification_test.rb
+	@echo "✅ Hardware integration tests completed"
+
+# Interactive test with real Estonian ID card
+# This is the simplest way to verify everything works with your card
+run_local_card_test:
+	@echo "🔍 Testing Estonian ID Card (Interactive)"
+	@echo "========================================="
+	@echo ""
+	@echo "This will attempt to:"
+	@echo "  1. Detect your Estonian ID card"
+	@echo "  2. Connect via PKCS#11 interface"
+	@echo "  3. Prompt for your PIN1"
+	@echo "  4. Read and display your personal information"
+	@echo ""
+	@echo "⚠️  Requirements:"
+	@echo "     - Estonian ID card must be inserted"
+	@echo "     - Card reader must be connected"
+	@echo "     - You'll need your PIN1 (4 digits)"
+	@echo ""
+	ruby script/test_id_card.rb
+
+# Build the gem package for distribution
+# Creates .gem file that can be installed or published to RubyGems
+build:
+	@echo "🔨 Building gem package..."
+	@echo "   This creates EE-ID-verification-x.x.x.gem file"
+	gem build ee-id-verification.gemspec
+	@echo "✅ Gem built successfully"
+	@echo "   Install locally with: gem install *.gem"
+	@echo "   Publish with: gem push *.gem"
+
+# Clean up built artifacts
+# Removes any .gem files created during build process
+clean:
+	@echo "🧹 Cleaning build artifacts..."
+	rm -f *.gem
+	@echo "✅ Cleanup completed"