nemid 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c78afef5b94a8fd54877a0e184b149aefc5ee34686a787630136a34b787822ac
-  data.tar.gz: 0fdd17de853ca723c17c3b26aa412b7440e066b529cf35cf042b73b12061ce72
+  metadata.gz: cfaf481277e75ca6856da3dc36e6659565bb1d8e6c7b4b7e508cae97674c989a
+  data.tar.gz: 9310faf0c65697c0ff198bf01a026d717086df156fe27f15e119ee81d45d12e6
 SHA512:
-  metadata.gz: a4a2f32a5d4e80c6f2f93b93925f24e7a6d6c3bdf0592fbf535f2264846b3fcef406596298cacecc11188b95fdcfaaac36a81cdb0ee53e0bf00aa88f90569b30
-  data.tar.gz: e9c4952fb06c560569225c3edbc2d58cf1663fe631e286358d99420d13299b9952a42cb6106d1467bc38aa2d71460357ad0d1c15d59b2a63d8ace817bc6a33e5
+  metadata.gz: 9d9a69c8e17494a32537d6341084f27b5c9a2c3011756124235198c27ff3b8f7371b83b89ffd10a9fc51ea97ad874fb29b0b85009008da7cc07f43b1ba359500
+  data.tar.gz: e5c36741e8853791830acf1e1a3e4ed29dcace861b0afdff211d589fd2a4c0e699ae3c04963c6b8242b8958c9d1d997518bc4b07df9a45a9fb4a4276556177ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nemid (0.1.0)
+    nemid (0.2.1)
       openssl (~> 2.2, >= 2.2.0)
       savon (~> 2.12.0, >= 2.12.0)
       xmldsig (~> 0.6.6, >= 0.6.6)

data/README.md

@@ -28,14 +28,14 @@ This gem implements the following modules:
 
 - `OCSP:` use this if you want to manually perform an OCSP request.
 
-### Authentication::Parameters
+### Authentication::Params
 
-Generate client initialization parameters
+Generate client initialization parameters. See [here](https://github.com/davideluque/nemid#exporting-certificate-and-private-key) if you do not know how to get your certificate and private key in pem format.
 
 ```ruby
-nemid = NemID::Authentication::Parameters.new(
-  'path/to/your/voces/certificate',
-  'your_voces_certificate_password',
+nemid = NemID::Authentication::Params.new(
+  cert: 'your_voces_certificate_in_pem_format',
+  key: 'your_private_key_in_pem_format',
 )
 
 nemid.client_initialization_parameters # ruby hash with signed parameters
@@ -43,7 +43,7 @@ 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).
+Parse and validate NemID response, then export user information from certificate. As of this version, it is only possible to export the PID (or RID).
 
 ```ruby
 response = NemID::Authentication::Response.new(base64_str) # Base64 string from NemID
@@ -60,7 +60,9 @@ 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:
+# 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
@@ -91,18 +93,18 @@ 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'
+  cert: 'your_voces_certificate_in_pem_format',
+  key: 'your_private_key_in_pem_format',
+  spid: 'your_service_provider_id'
 )
 
 pid_cpr.match(pid: '9208-2002-2-316380231171', cpr: '2205943423')
 
 # Expected result - success
-true
+{:cpr=>"2205943423", :pid=>"9208-2002-2-316380231171", :id=>nil, :redir_url=>nil, :status_code=>"0", :status_text_dk=>"OK", :status_text_uk=>"OK"}
 
-# Expected result - failure
-false
+# Expected result - failure ( status_code and status_text varies on error occuring )
+{:cpr=>"123", :pid=>"9208-2002-2-316380231171", :id=>nil, :redir_url=>nil, :status_code=>"1", :status_text_dk=>"CPR svarer ikke til PID", :status_text_uk=>"CPR does not match PID"}
 
 # To complete:
 # - how is the error going to be handled? raising a class error?
@@ -154,6 +156,43 @@ rescue NemID::OCSP::NonceError => e
 end
 ```
 
+## Exporting Certificate and Private Key
+
+To be able to export the certificate and the key, you will be prompted the password that NemID used to encrypt the p12 archive. It should have been sent to you together with the p12 file.
+
+Exporting the certificate:
+
+```bash
+# Replace <filename.p12> with the file name of the p12 that NemID sent to you
+$ openssl pkcs12 -in <filename.p12> -clcerts -nokeys | openssl x509 -out cert.cer
+```
+
+Exporting the key:
+
+```bash
+# Replace <filename.p12> with the file name of the p12 that NemID sent to you
+$ openssl pkcs12 -in <filename.p12> -nocerts -nodes | openssl pkcs8 -nocrypt -out private_key.key
+```
+
+After you export both files, you will need to manually replace the newlines with `\n`, in both. 
+
+
+If everything went well, you should have two one-line strings that look like this (but longer):
+
+```
+-----BEGIN CERTIFICATE-----\nMIIGETCCBPmgAwIBAgIEX(a-lot-of-alphanumeric-characters-and-\n)wIBAgIE\n-----END CERTIFICATE-----\n
+
+and
+
+-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC8fX6t4Hkhxl+FM=\n-----END PRIVATE KEY-----\n
+```
+
+**Notice the trailing \n, it is very important that you include it**. 
+
+If you get an error like `(nested asn1 error)`, it means that you have done something wrong when editing the file. Try exporting again and carefully replace the newlines with \n.
+
+Keep these files private to you, use environment variables!
+
 ## 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.

data/lib/nemid/authentication/params.rb

@@ -3,8 +3,8 @@ require 'date'
 module NemID
   module Authentication
     class Params
-      def initialize(certificate, pass)
-        @nemid_crypto = NemID::Crypto.new(certificate, pass)
+      def initialize(cert:, key:)
+        @nemid_crypto = NemID::Crypto.new(cert: cert, key: key)
       end
   
       def client_initialization_parameters

data/lib/nemid/crypto.rb

@@ -3,14 +3,13 @@ require 'openssl'
 module NemID
  class Crypto
 
-  def initialize(certificate, pass)
-    certificate = read_file(certificate)
-    @pkcs12 = read_pkcs12(certificate, pass)
-    @rsa_instance = rsa_keypair(@pkcs12, pass)
+  def initialize(cert:, key:)
+    @certificate = read_x509(cert)
+    @rsa_instance = rsa_keypair(key)
   end
 
   def base64_encoded_der_representation
-    Base64.strict_encode64(@pkcs12.certificate.to_der)
+    Base64.strict_encode64(@certificate.to_der)
   end
 
   def base64_encoded_digest_representation(data)
@@ -22,11 +21,11 @@ module NemID
   end
 
   def get_certificate
-    @pkcs12.certificate
+    @certificate
   end
 
   def get_key
-    @pkcs12.key
+    @rsa_instance
   end
   
   private
@@ -38,12 +37,12 @@ module NemID
     File.read(certificate)
   end
 
-  def read_pkcs12(certificate, pass)
-    OpenSSL::PKCS12::new(certificate, pass)
+  def read_x509(raw)
+    OpenSSL::X509::Certificate.new(raw)
   end
 
-  def rsa_keypair(pkcs12, passphrase)
-    OpenSSL::PKey::RSA.new(pkcs12.key, passphrase)
+  def rsa_keypair(raw)
+    OpenSSL::PKey::RSA.new(raw)
   end
 
   def sign(data)

data/lib/nemid/pid_cpr.rb

@@ -4,8 +4,8 @@ module NemID
   class PIDCPR
     PID_SERVICE_URL = 'https://pidws.pp.certifikat.dk/pid_serviceprovider_server/pidws'
 
-    def initialize(spid, cert, pass)
-      @crypto = NemID::Crypto.new(cert, pass)
+    def initialize(cert:, key:, spid:)
+      @crypto = NemID::Crypto.new(cert: cert, key: key)
       @spid = spid
     end
 
@@ -30,13 +30,7 @@ module NemID
         message: build_soap_message(pid: pid, cpr: cpr)
       )
     
-      result = response.to_hash[:pid_response][:result][:pid_reply]
-      
-      if result[:status_code] == "0"
-        true
-      else
-        false
-      end
+      response.to_hash[:pid_response][:result][:pid_reply]
     end
 
     private

data/lib/nemid/version.rb

@@ -1,3 +1,3 @@
 module NemID
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nemid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - David Cabeza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl