omniauth-mpassid 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20db7b39bbaa982cf5e05417c903cc08f3b543d7eac10ba621e8c5868aa1c45
-  data.tar.gz: 2c54ae01ece53cccc2d3f323c46e0d876a87443b38d306ce6ee9656fda8c1a3b
+  metadata.gz: 3ff6ff316ec561eadb8093c30bcbe1097823cf11796a81386b11d40228c4cdc6
+  data.tar.gz: dd16b5f03d5e8b7814e9b210fe981b15a10521e841f9560cd40a86af67c54ce0
 SHA512:
-  metadata.gz: acd40c82d1dd81d7e4a9184c014dd0797930a2743327e61ab54319b9bebf2dc0726990386670ff94c4f216a27f910635daed878513dcd87fcbfc3a74180e5369
-  data.tar.gz: c1b6d98478a1c39c1aabb7cafd2d1631f92613897936ac497661271da0b848fa3a2740a9910d091dcae4e6c470490bc5571d9f3310b81743bc88e347a9d7b5fb
+  metadata.gz: 2bcf7c78c1072b8c52db7e9381321fa2a9bcef19c7e5e2d62d98e161808419484c1ecb5ff7472a4fa2bd90e32ebbd735e6a6b7e8150e8a0673a4e7f46d303c6e
+  data.tar.gz: 6c4d56294369192b594a2b6afc9c0ea371d21d44b46e49078c31af3d78794c255d3000ebae7cb8dc318f5a8f36ee8c2416bbcf27086528ca389a8a4203fdf4c8

data/README.md

@@ -1,6 +1,6 @@
 # OmniAuth MPASSid (SAML 2.0)
 
-[![Build Status](https://travis-ci.com/mainio/omniauth-mpassid.svg?branch=master)](https://travis-ci.com/mainio/omniauth-mpassid)
+[![Build Status](https://github.com/mainio/omniauth-mpassid/actions/workflows/ci_omniauth_mpassid.yml/badge.svg)](https://github.com/mainio/omniauth-mpassid/actions)
 [![codecov](https://codecov.io/gh/mainio/omniauth-mpassid/branch/master/graph/badge.svg)](https://codecov.io/gh/mainio/omniauth-mpassid)
 
 This is an unofficial OmniAuth strategy for authenticating with the MPASSid

data/lib/omniauth/strategies/mpassid.rb

@@ -23,13 +23,13 @@ module OmniAuth
       # - fi_FI
       #
       # In case a valid language cannot be parsed from the parameter, the lang
-      # parameter will default to `:idp_sso_target_url_default_lang`.
-      option :idp_sso_target_url_lang_params, %w[locale language lang]
+      # parameter will default to `:idp_sso_service_url_default_lang`.
+      option :idp_sso_service_url_lang_params, %w[locale language lang]
 
       # This is the default language to be passed to IdP sign in redirect URL as
       # defined above. In case a valid language is not found from the request
       # parameters, this will be used instead.
-      option :idp_sso_target_url_default_lang, 'fi'
+      option :idp_sso_service_url_default_lang, 'fi'
 
       # The request attributes for MPASSid
       option :request_attributes, [
@@ -39,13 +39,15 @@ module OmniAuth
         # (single value)
         {
           name: 'urn:mpass.id:uid',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassUsername'
         },
         # Funet EDU person learner ID
         # (single value)
         {
           name: 'urn:oid:1.3.6.1.4.1.16161.1.1.27',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'learnerId'
         },
         # The first/given name of the user.
         # (single value)
@@ -68,26 +70,6 @@ module OmniAuth
           name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
           friendly_name: 'sn'
         },
-        # The municipality code of the authenticated user. See
-        # http://tilastokeskus.fi/meta/luokitukset/kunta/001-2017/index.html
-        # for mappings in Finland.
-        # (multi value)
-        {
-          name: 'urn:mpass.id:municipalityCode',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
-          friendly_name: 'municipalityCode'
-        },
-        # The human-readable name of the municipality of the authenticated user.
-        # (multi value)
-        {
-          name: 'urn:mpass.id:municipality',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
-        },
-        {
-          name: 'urn:educloudalliance.org:municipality',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
-          friendly_name: 'ecaMunicipality'
-        },
         # The school code of the authenticated user. See
         # https://virkailija.opintopolku.fi/koodisto-service/rest/json/oppilaitosnumero/koodi
         # (JSON format)
@@ -99,7 +81,8 @@ module OmniAuth
         # (multi value)
         {
           name: 'urn:mpass.id:schoolCode',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassSchoolCode'
         },
         # The human-readable name of the school of the authenticated user.
         # (multi value)
@@ -108,12 +91,21 @@ module OmniAuth
           name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
           friendly_name: 'school'
         },
+        # Combination of the school code and official name of the educational
+        # institution separated with semicolon.
+        # For instance: 00000;Tuntematon
+        {
+          name: 'urn:mpass.id:schoolInfo',
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassSchoolInfo'
+        },
         # The class/group-information of the authenticated user.
         # For instance: 8A or 3B.
         # (multi value)
         {
           name: 'urn:mpass.id:class',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassClass'
         },
         {
           name: 'urn:educloudalliance.org:group',
@@ -125,7 +117,8 @@ module OmniAuth
         # (multi value)
         {
           name: 'urn:mpass.id:classLevel',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassClassLevel'
         },
         # The role name of the user.
         # For instance Oppilas.
@@ -136,18 +129,43 @@ module OmniAuth
           friendly_name: 'ecaRole'
         },
         # The role of the user in four parts, divided with a semicolon (;)
-        # character. First municipality, followed by school code, group and role
-        # in the group.
-        # For instance Helsinki;32132;9A;Oppilas.
+        # character. First educational provider's organization OID, followed by
+        # school code, group and role in the group.
+        # For instance 1.2.246.562.10.12345678907;99900;7B;Oppilas.
         # (multi value)
+        #
+        # The educational providers' organization OIDs can be found from:
+        # https://github.com/Opetushallitus/aitu/blob/master/ttk-db/resources/db/migration/V11_2__koulutustoimijat.sql
         {
           name: 'urn:mpass.id:role',
-          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassRole'
+        },
+        # The educational provider's permanent organization OID.
+        # (multi value)
+        #
+        # The educational providers' organization OIDs can be found from:
+        # https://github.com/Opetushallitus/aitu/blob/master/ttk-db/resources/db/migration/V11_2__koulutustoimijat.sql
+        {
+          name: 'urn:mpass.id:educationProviderId',
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassEducationProviderOid'
         },
+        # The educational provider's human-readable name.
+        # (multi value)
+        {
+          name: 'urn:mpass.id:educationProvider',
+          name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
+          friendly_name: 'mpassEducationProviderName'
+        },
+        # Combination of the education provider's organisation-OID and official
+        # name. Separated by semicolon.
+        # For instance: 1.2.246.562.10.494695390410;Virallinen nimi
+        # (multi value)
         {
-          name: 'urn:educloudalliance.org:structuredRole',
+          name: 'urn:mpass.id:educationProviderInfo',
           name_format: 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri',
-          friendly_name: 'ecaStructuredRole'
+          friendly_name: 'mpassEducationProviderInfo'
         }
       ]
 
@@ -158,8 +176,8 @@ module OmniAuth
         # Given name or all first names (in case given name is not found)
         first_name: ['urn:oid:2.5.4.42', 'http://eidas.europa.eu/attributes/naturalperson/CurrentGivenName'],
         last_name: ['urn:oid:2.5.4.4'],
-        # The municipality of the person (literal format in Finnish)
-        location: ['urn:mpass.id:municipality', 'urn:educloudalliance.org:municipality']
+        # The education provider (e.g. municipality) of the person (literal format in Finnish)
+        location: ['urn:mpass.id:educationProvider']
       )
 
       info do
@@ -197,14 +215,14 @@ module OmniAuth
       option(
         :saml_attributes_map,
         given_name: ['urn:oid:2.5.4.42'],
-        first_names: ['http://eidas.europa.eu/attributes/naturalperson/CurrentGivenName'],
+        first_names: ['urn:oid:2.5.4.42'],
         last_name: ['urn:oid:2.5.4.4'],
-        municipality_code: {
-          name: ['urn:mpass.id:municipalityCode'],
+        provider_id: {
+          name: ['urn:mpass.id:educationProviderId'],
           type: :multi
         },
-        municipality_name: {
-          name: ['urn:mpass.id:municipality', 'urn:educloudalliance.org:municipality'],
+        provider_name: {
+          name: ['urn:mpass.id:educationProvider'],
           type: :multi
         },
         school_code: {
@@ -231,7 +249,8 @@ module OmniAuth
           name: ['urn:educloudalliance.org:role'],
           type: :multi
         },
-        # Extra (undocumented)
+        # Extra
+        # Unique learner ID
         funet_person_learner_id: ['urn:oid:1.3.6.1.4.1.16161.1.1.27']
       )
 
@@ -346,8 +365,8 @@ module OmniAuth
       end
 
       def lang_for_authn_request
-        if options.idp_sso_target_url_lang_params.is_a?(Array)
-          options.idp_sso_target_url_lang_params.each do |param|
+        if options.idp_sso_service_url_lang_params.is_a?(Array)
+          options.idp_sso_service_url_lang_params.each do |param|
             next unless request.params.key?(param.to_s)
 
             lang = parse_language_value(request.params[param.to_s])
@@ -355,7 +374,7 @@ module OmniAuth
           end
         end
 
-        options.idp_sso_target_url_default_lang
+        options.idp_sso_service_url_default_lang
       end
 
       def parse_language_value(string)

data/lib/omniauth-mpassid/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module MPASSid
-    VERSION = '0.2.0'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-mpassid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Antti Hukkanen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-saml
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.19.0
 description: MPASSid identification service integration for OmniAuth.
 email:
 - antti.hukkanen@mainiotech.fi