spid 0.17.3 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 373a471d3c7b5987767769a28f606c719a9470f82347e3f337e49a6391bb0a38
-  data.tar.gz: 596d1cde1ad8283d5b2fb1ab50d3d969be1072b096497aea9d14dec5ce22c052
+  metadata.gz: 89a40be6cd513657d224483f7964c0d63f9479554faa866490f5fe144ced2a44
+  data.tar.gz: 39cadb77a01ce43ffb023510a7b5b4a6e855ef026aea92f84aae944d13cb3bdf
 SHA512:
-  metadata.gz: 8a23bd7418801a537ba5714da4dbf67808b978819780bf9592ca32db148b9ebd14734c65a76730fe4c7ca93f902312acd3c00d908254322ea7a0e9a8670671f6
-  data.tar.gz: 99eee38fe1d01a30e26e9efa2a59a8537955e7c2ca623f74c92368bb20eb83bd12b4c80fb926b00f847ba818af72ca7f0b9ca13cbb6d9d615d6a3015e5c3d89e
+  metadata.gz: 6a56e687614772ead99c9d2b7601c207ad015f9051384eb3474ff0a29512b68f9c0fbcf16d1001a16274949df0273a2cbe1eb7ac7c54ca65dd5bbd616d9a559b
+  data.tar.gz: db706901ef49f6a6169b07315af2896a356c8ef1e3ac0e87127f34f953ec5270fe4943cdd2cd25a258e63ecea9b73e3c5852f8652ac2759e83d638f2fec4a035

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [Unreleased]
 
+## [0.18.0] - 2018-09-12
+### Removed
+- Rails specific code
+
 ## [0.17.3] - 2018-09-12
 ### Fixed
 - Metadata embed now signature
@@ -147,7 +151,8 @@
 - Coveralls Integration
 - Rubygems version badge in README
 
-[Unreleased]: https://github.com/italia/spid-ruby/compare/v0.17.3...HEAD
+[Unreleased]: https://github.com/italia/spid-ruby/compare/v0.18.0...HEAD
+[0.18.0]: https://github.com/italia/spid-ruby/compare/v0.17.3...v0.18.0
 [0.17.3]: https://github.com/italia/spid-ruby/compare/v0.17.2...v0.17.3
 [0.17.2]: https://github.com/italia/spid-ruby/compare/v0.17.1...v0.17.2
 [0.17.1]: https://github.com/italia/spid-ruby/compare/v0.17.0...v0.17.1

data/README.md

@@ -76,12 +76,35 @@ Per motivi di sicurezza il sistema SPID prevede che un Service Provider abbia un
 
 Al fine di facilitarne lo scaricamento la gemma `spid-ruby` prevede un task rake che li installa nella directory `config.idp_metadata_dir_path`.
 
-A questo punto è possibile lanciare 
-
 ```bash
 $ rake spid:fetch_idp_metadata
 ```
 
+Essendo dei segreti, è sconsigliato salvare i metadata di produzione nel codebase, quindi è preferibile rimandare il task durante la fase di deploy.
+
+Utilizzando [capistrano](https://capistranorb.com/) un modo potrebbe essere:
+```ruby
+# config/deploy.rb
+
+set :linked_dirs %(
+  /path/to/idp_metadata_dir
+)
+
+namespace :deploy do
+  task :fetch_idp_metadata do
+    on roles(:web) do
+      execute :rake, "spid:fetch_idp_metadata"
+    end
+  end
+end
+```
+
+Se invece state usando [heroku](https://heroku.com) potete usare un buildpack apposito
+```bash
+$ heroku buildpacks:add  https://github.com/cantierecreativo/spid-ruby-heroku-buildpack.git
+```
+che lancierà automaticamente il comando durante il deploy. In questo modo i metadata verranno **congelati** nel dyno e saranno sempre disponibili
+
 #### Sinatra
 Occorre modificare il `Rakefile` dell'applicazione aggiungendo
 ```ruby
@@ -90,6 +113,34 @@ Occorre modificare il `Rakefile` dell'applicazione aggiungendo
 require "spid/tasks"
 ```
 
+## Nota sulle chiavi OpenSSL
+Per generare delle chiavi di test è possibile utilizzare il seguende comando:
+```bash
+openssl req -x509 -nodes -sha512 -subj '/C=IT' -newkey rsa:4096 -keyout spid-private-key.pem -out spid-certificate.pem
+```
+
+La configurazione di `spid-ruby` prevede che venga fornita direttamente la codifica `.pem` del certificato. Questo perché in sistemi quali [Heroku](https://heroku.com) sarebbe necessario avere le chiavi all'interno del repository git, cosa altamente sconsigliata in quanto segreto.
+
+Nel caso di deploy su una macchina personale una possibile soluzione è l'utilizzo di [capistrano](https://capistranorb.com/) in modo che i certificati siano gestiti esternamente dal repository.
+
+Esempio di configurazione:
+```ruby
+# config/deploy.rb
+
+set :linked_files, %w(
+  /path/to/private-key.pem,
+  /path/to/certificate.pem
+)
+```
+e nella configurazione
+```ruby
+Spid.configure do |config|
+  config.private_key_pem = File.read("/path/to/private-key.pem")
+  config.certificate_pem = File.read("/path/to/certificate.pem")
+end
+```
+
+
 ## Funzionamento
 ### Login
 

data/lib/spid.rb

@@ -9,7 +9,6 @@ require "spid/version"
 require "spid/configuration"
 require "spid/identity_provider_manager"
 require "spid/synchronize_idp_metadata"
-require "spid/railtie" if defined?(Rails)
 
 module Spid # :nodoc:
   class UnknownAuthnComparisonMethodError < StandardError; end

data/lib/spid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spid
-  VERSION = "0.17.3"
+  VERSION = "0.18.0"
 end

data/spid.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rack", ">= 1", "< 3"
   spec.add_runtime_dependency "rake", ">= 10.0", "< 13"
   spec.add_runtime_dependency "xmldsig", ">= 0.6.6"
+  spec.add_runtime_dependency "listen", ">= 0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "bundler-audit", "~> 0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spid
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 0.18.0
 platform: ruby
 authors:
 - David Librera
@@ -84,6 +84,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.6
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -318,9 +332,6 @@ files:
 - idp_metadata/.gitkeep
 - lib/spid.rb
 - lib/spid/configuration.rb
-- lib/spid/generators.rb
-- lib/spid/generators/install_generator.rb
-- lib/spid/generators/templates/spid.rb
 - lib/spid/identity_provider_manager.rb
 - lib/spid/metadata.rb
 - lib/spid/rack.rb
@@ -330,7 +341,6 @@ files:
 - lib/spid/rack/session.rb
 - lib/spid/rack/slo.rb
 - lib/spid/rack/sso.rb
-- lib/spid/railtie.rb
 - lib/spid/saml2.rb
 - lib/spid/saml2/authn_request.rb
 - lib/spid/saml2/identity_provider.rb

data/lib/spid/generators.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators"
-require "spid/generators/install_generator"
-
-module Spid
-  module Generators # :nodoc:
-  end
-end

data/lib/spid/generators/install_generator.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Spid
-  module Generators
-    class InstallGenerator < ::Rails::Generators::Base # :nodoc:
-      source_root File.expand_path("templates", __dir__)
-
-      def code_that_runs
-        copy_file "spid.rb", "config/initializers/spid.rb"
-      end
-    end
-  end
-end

data/lib/spid/generators/templates/spid.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-Spid.configure do |config|
-  config.hostname = ENV.fetch("HOST")
-
-  config.idp_metadata_dir_path = Rails.root.join("config/idp_metadata")
-  config.private_key_pem = ENV.fetch("PRIVATE_KEY")
-  config.certificate_pem = ENV.fetch("CERTIFICATE")
-
-  config.metadata_path = "/spid/metadata"
-  config.login_path = "/spid/login"
-  config.logout_path = "/spid/logout"
-  config.acs_path = "/spid/sso"
-  config.slo_path = "/spid/slo"
-  config.default_relay_state_path = "/"
-
-  config.digest_method = Spid::SHA512
-  config.signature_method = Spid::RSA_SHA512
-  config.acs_binding = Spid::BINDINGS_HTTP_POST
-  config.slo_binding = Spid::BINDINGS_HTTP_REDIRECT
-  config.attribute_services = [
-    { name: "Service1", fields: ["email"] }
-  ]
-end

data/lib/spid/railtie.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require "spid/generators"
-
-module Spid
-  class Railtie < ::Rails::Railtie # :nodoc:
-    rake_tasks do |_app|
-      require "spid/tasks"
-    end
-  end
-end