nemid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c78afef5b94a8fd54877a0e184b149aefc5ee34686a787630136a34b787822ac
+  data.tar.gz: 0fdd17de853ca723c17c3b26aa412b7440e066b529cf35cf042b73b12061ce72
+SHA512:
+  metadata.gz: a4a2f32a5d4e80c6f2f93b93925f24e7a6d6c3bdf0592fbf535f2264846b3fcef406596298cacecc11188b95fdcfaaac36a81cdb0ee53e0bf00aa88f90569b30
+  data.tar.gz: e9c4952fb06c560569225c3edbc2d58cf1663fe631e286358d99420d13299b9952a42cb6106d1467bc38aa2d71460357ad0d1c15d59b2a63d8ace817bc6a33e5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community 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
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+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.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cabezadavide@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nemid.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    nemid (0.1.0)
+      openssl (~> 2.2, >= 2.2.0)
+      savon (~> 2.12.0, >= 2.12.0)
+      xmldsig (~> 0.6.6, >= 0.6.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.4)
+    diff-lcs (1.4.4)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.5)
+      rack
+      socksify
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    nori (2.6.0)
+    openssl (2.2.0)
+    public_suffix (4.0.6)
+    rack (2.2.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.1)
+    wasabi (3.6.1)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    xmldsig (0.6.6)
+      nokogiri (>= 1.6.8, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nemid!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Cabeza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,174 @@
+# NemID
+
+NemID is a Ruby gem that makes it easy to integrate the NemID JavaScript client with ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nemid'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nemid
+
+## Usage
+
+This gem implements the following modules:
+
+- `Authentication:` generate client initialization parameters and response handling.
+
+- `PIDCPR:` match PID to a CPR number. Match and translation are available only to selected service providers.
+
+- `OCSP:` use this if you want to manually perform an OCSP request.
+
+### Authentication::Parameters
+
+Generate client initialization parameters
+
+```ruby
+nemid = NemID::Authentication::Parameters.new(
+  'path/to/your/voces/certificate',
+  'your_voces_certificate_password',
+)
+
+nemid.client_initialization_parameters # ruby hash with signed parameters
+```
+
+### Authentication::Response
+
+Parse and validate NemID response, then extract user information from certificate. As of this version, it is only possible to extract the PID (or RID).
+
+```ruby
+response = NemID::Authentication::Response.new(base64_str) # Base64 string from NemID
+
+# or
+
+response = NemID::Authentication::Response.new(xml_str) # XML string from NemID
+
+# First, validate NemID response, as stated in NemID Documentation
+
+begin
+  response.validate_response
+rescue NemID::Errors::ResponseValidationError => e
+  puts e # Developer-friendly message, example: Signature is invalid.
+end
+
+# Note that response.validate_response raises exceptions instead of returning true or false, the exceptions are raised according to the order that the  methods are invoked. The following methods perform the same validations and do not raise exceptions:
+
+response.valid_signature? # true
+response.valid_certificate_chain? # true
+response.user_certificate_expired? # false
+response.user_certificate_revoked? # false
+
+# If response is valid, then proceed to extract user information:
+
+# Extract PID or RID
+response.extract_pid_or_rid # "PID:9208-2002-2-316380231171"
+
+# Has PID?
+response.has_pid? # true
+
+# Extract PID
+response.extract_pid # "9208-2002-2-316380231171"
+
+# Has RID?
+response.has_rid? # false
+
+# Extract RID
+response.extract_rid # nil
+```
+
+### PIDCPR
+
+Match a PID to a CPR number.
+
+```ruby
+pid_cpr = NemID::PIDCPR.new(
+  'your_service_provider_id',
+  'path/to/your/voces/certificate',
+  'your_voces_certificate_password'
+)
+
+pid_cpr.match(pid: '9208-2002-2-316380231171', cpr: '2205943423')
+
+# Expected result - success
+true
+
+# Expected result - failure
+false
+
+# To complete:
+# - how is the error going to be handled? raising a class error?
+```
+
+### OCSP
+
+An OCSP request is performed when the `.validate_response` or `.user_certificate_revoked?` methods are invoked. If you wish to perform the OCSP request yourself, to catch specific OCSP errors, you can do it this way:
+
+```ruby
+user_certificate = OpenSSL::X509::Certificate.new(raw) # User's certificate
+
+issuer = OpenSSL::X509::Certificate.new(raw) # The issuer of the user's certificate (Normally the intermediate certificate)
+
+ca = OpenSSL::X509::Certificate.new(raw) # Certificate Authority
+
+ocsp = NemID::OCSP
+ocsp.request(
+  subject: user_certificate,
+  issuer: issuer,
+  ca: ca
+) # Returns +true+ if the certificate status is revoked or unknown, +false+ if the certificate status is OK.
+
+# Catching OCSP errors:
+
+# This implementation raises the following OCSP errors, be sure to catch them so the execution of your program is not interrupted.
+
+begin
+  ocsp.request(
+    subject: user_certificate,
+    issuer: issuer,
+    ca: ca
+  )
+rescue NemID::OCSP::Error 
+  # Catches all OCSP errors
+rescue NemID::OCSP::InvalidSignatureError => e
+  # If you get a failure here you may be missing the intermediate certificates.
+  puts e # Response is not signed by a trusted certificate
+rescue NemID::OCSP::NoStatusError => e
+  # Means that we could not extract the status information for the certificate from the basic response
+  puts e # basic_response does not have the status for the certificate
+rescue NemID::OCSP::InvalidUpdateError => e
+  # A status issued in the future must be rejected.
+  puts e # this_update is in the future or next_update time has passed
+rescue NemID::OCSP::NonceError => e
+  # Adding a nonce to the request protects against replay attacks but not all CA process the nonce.
+  # Therefore, this implementation only checks if the both nonces are present and not equal
+  puts e # Nonces both present and not equal
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davideluque/nemid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/davideluque/nemid/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NemID project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davideluque/nemid/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nemid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nemid.rb

@@ -0,0 +1,12 @@
+require 'base64'
+require "nemid/version"
+require "nemid/authentication"
+require "nemid/crypto"
+require "nemid/errors"
+require "nemid/ocsp"
+require "nemid/xmldsig"
+require 'nemid/pid_cpr'
+
+module NemID
+  class Error < StandardError; end
+end

data/lib/nemid/authentication.rb

@@ -0,0 +1,7 @@
+module NemID
+  module Authentication
+  end
+end
+
+require_relative "authentication/params"
+require_relative "authentication/response"

data/lib/nemid/authentication/params.rb

@@ -0,0 +1,52 @@
+require 'date'
+
+module NemID
+  module Authentication
+    class Params
+      def initialize(certificate, pass)
+        @nemid_crypto = NemID::Crypto.new(certificate, pass)
+      end
+  
+      def client_initialization_parameters
+        params = unsigned_params
+        normalized_unsigned_params = normalize(unsigned_params)
+        
+        params.merge({
+          "DIGEST_SIGNATURE": digest_signature(normalized_unsigned_params),
+          "PARAMS_DIGEST": params_digest(normalized_unsigned_params),
+        })
+      end
+  
+      private
+      def digest_signature(normalized_unsigned_params)
+        @nemid_crypto.base64_encoded_rsa_signature(normalized_unsigned_params)
+      end
+  
+      def normalize(params)
+        params = params.transform_keys(&:upcase)
+        
+        str = String.new
+        
+        params.keys.sort.each { |k| str += "#{k.to_s}#{params[k]}" }
+  
+        return str
+      end
+  
+      def params_digest(normalized_unsigned_params)
+        @nemid_crypto.base64_encoded_digest_representation(normalized_unsigned_params)
+      end
+  
+      def sp_cert
+        @nemid_crypto.base64_encoded_der_representation
+      end
+  
+      def unsigned_params
+        {
+          "CLIENTFLOW": "OCESLOGIN2",
+          "SP_CERT": sp_cert,
+          "TIMESTAMP": DateTime.now.new_offset(0).strftime('%F %T%z'),
+        }
+      end
+    end
+  end
+end