OSS Release

COPYING

@@ -0,0 +1,172 @@
+Copyright 2013 Tartu Ülikool. http://www.ut.ee
+
+This work is licensed under LGPL v3 or any later version.
+http://www.gnu.org/licenses/lgpl.html
+
+-----------------------------------------------------------------------------
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -0,0 +1,91 @@
+Mobiil-ID module for SimpleSAMLphp
+==================================
+
+This module implements Estonian [Mobiil-ID](http://www.id.ee/index.php?id=35739) authentication for [SimpleSAMLphp](http://simplesamlphp.org) <abbr title="Authentication and Authorization Infrastructure">AAI</abbr> framework.
+
+Refer to the [DigiDocService documentation](http://www.sk.ee/upload/files/DigiDocService_spec_eng.pdf) for details on the underlying architecture.
+
+
+This code is considered production-ready.
+
+
+USAGE
+=====
+
+This module handles all Mobiil-ID traffic, starting by asking for the phone number and ending in one of the two results:
+
+* _successful authentication_ - the user's personal ID code is placed into `Attributes` array as `isikukood`
+* _authentication failure_ for any number of reasons - the user will be presented with appropriate message and the session stops there.
+
+  It is possible to further customize the `status.php` page and include links to some troubleshooter or help center etc via normal [SSP theming](http://simplesamlphp.org/docs/stable/simplesamlphp-theming).
+
+**NB!** **SECURITY BREACH** might result unless the ID code is further processed and authorization aplied. If this is not done, _all_  Estonian Mobiil-ID users will be passed as valid users of the SSP site.
+
+
+Installation
+============
+
+Dependencies
+------------
+
+This module depends on a few PEAR modules. To get the latest versions, first instruct PEAR to prefer beta versions (older stables might not work):
+
+    pear config-set preferred_state beta
+
+And then install modules:
+
+    pear install -a SOAP
+    pear install -a XML_Serializer
+
+    pear channel-discover phpseclib.sourceforge.net
+    pear install phpseclib/Crypt_RSA
+
+
+Clone the module
+----------------
+
+Clone the module from GitHub into SSP `modules` folder:
+
+    cd modules
+    git clone https://github.com/borgand/sspmod_MobiilID MobiilID
+
+**Note:** the resulting folder name must be **MobiilID** or SimpleSAMLphp won't find the source files and the module won't work (see: [SSP autoloader](http://code.google.com/p/simplesamlphp/source/browse/trunk/lib/_autoload.php)).
+
+
+Enable the module
+-----------------
+
+The module is disabled by default. Enable it by:
+
+    touch MobiilID/enable
+
+Authsource
+----------
+
+Configure Mobiil-ID as an authsource in the `config/authsources.php` file, e.g using the [test DigiDocService](https://www.openxades.org):
+
+    'mobiilid' => array(
+      'MobiilID:MobiilID',
+      'endpoint' => 'https://www.openxades.org:8443/?wsdl',
+      'endpoint_certificate' => '/path/to/endpoint.cert',
+      'service_name' => 'Testimine',
+      'message_to_display' => 'Verify that codes match!',
+      'status_refresh' => 5,
+    ),
+
+This configures the authsource, but to actually use it, you must configure this as the default authsource in `metadata/saml20-idp-hosted.php` or alternatively use SSP's [MultiAuth](http://simplesamlphp.org/docs/stable/multiauth:multiauth) module to use multiple authsources simultaneously.
+
+Credit
+======
+
+It is based on the demo auth application published by AS Sertifitseerimiskeskus:
+
+  * [http://demo.digidoc.ee/auth_sample/](http://demo.digidoc.ee/auth_sample/)
+
+
+Authors & Contributors
+======================
+
+This module was at [University of Tartu](http://www.ut.ee/en) by:
+
+ * Laas Toom

default-disable

@@ -0,0 +1,3 @@
+This file indicates that the default state of this module
+is enabled. To disable, create a file named disable in the
+same directory as this file.

dictionaries/MobiilID.definition.json

@@ -0,0 +1,47 @@
+{
+  "mobile_no":{
+    "en": "Mobile number"
+  },
+  "enter": {
+    "en": "Enter"
+  },
+  "refresh": {
+    "en": "Refresh"
+  },
+  "auth_progress_intro":{
+    "en": "Mobiil-ID sent authentication request along with verification code to your mobile."
+  },
+  "verification_code":{
+    "en": "Verification code"
+  },
+  "auth_progress_instruction":{
+    "en": "Verify that the code on the mobile screen matches the one visible here and then enter your Mobiil-ID PIN1 into the phone."
+  },
+  "auth_failure":{
+    "en": "Authentication failed"
+  },
+  "mid_not_ready": {
+    "en": "Mobiil-ID functionality is not yet ready. Please try again later."
+  },
+  "mid_user_cancel": {
+    "en": "You canceled Mobiil-ID authentication."
+  },
+  "mid_phone_absent": {
+    "en": "The phone is out of coverage area."
+  },
+  "mid_unknown_error": {
+    "en": "Unknown error. Please try again later."
+  },
+  "mid_no_certificate":{
+    "en": "User certificate missing!"
+  },
+  "mid_not_registered":{
+    "en": "Given phone number is not registered for the service!"
+  },
+  "mid_cert_revoked":{
+    "en": "Mobiil-ID certificates have been revoked!"
+  },
+  "mid_not_activated":{
+    "en": "Mobiil-ID has not been activated. To activate Mobiil-ID visit <a href=\"http://mobiil.id.ee/\">mobiil.id.ee</a>."
+  }
+}

dictionaries/MobiilID.translation.json

@@ -0,0 +1,77 @@
+{
+  "mobile_no":{
+    "et": "Mobiilinumber",
+    "ru": "Номер мобильного телефона",
+    "fi": "Puhelinnumeronne"
+  },
+  "enter": {
+    "et": "Sisene",
+    "ru": "Вход",
+    "fi": "Kirjaudu"
+  },
+  "refresh": {
+    "et": "Värskenda",
+    "ru": "Перезагрузка",
+    "fi": "Päivitys"
+  },
+  "auth_progress_intro":{
+    "et": "Mobiil-ID saatis autentimispäringu koos kontrollkoodiga sinu telefonile.",
+    "ru": "Через некоторoе время в вашем телефоне начнется процедура авторизации.",
+    "fi": "Mobiil-ID lähetti varmennuspyynnön ja tarkistuskoodin puhelimeenne"
+  },
+  "verification_code":{
+    "et": "Kontrollkood",
+    "ru": "Контрольный код",
+    "fi": "Tarkistuskoodi"
+  },
+  "auth_progress_instruction":{
+    "et": "Veendu, et telefonis nähtav kontrollkood ühtib ekraanilolevaga ning sisesta seejärel telefonis Mobiil-ID PIN1.",
+    "ru": "Пожалуйста проверьте, что Вы видите тот же самый контрольный код на экране Вашего мобильного телефона. Введите Mobiil-ID PIN 1 код.",
+    "fi": "Tarkistakaa, että puhelimeen saamassanne viestissä on sama tarkistuskoodi. Syöttäkää Mobiil-ID koodi PIN1."
+  },
+  "auth_failure":{
+    "et": "Autentimisprotseduur ebaõnnestus",
+    "ru": "Процедура авторизации не удалась",
+    "fi": "Tunnistautumisessa tapahtui virhe"
+  },
+  "mid_not_ready": {
+    "et": "Mobiil-ID funktsionaalsus ei ole veel valmis. Palun proovige varsti uuesti.",
+    "ru": "Mobiil-ID функциональность еще не готова. Пожалуйста, повторите попытку позже.",
+    "fi": "Mobiil-ID ei toimi vielä. Yrittäkää myöhemmin uudelleen."
+  },
+  "mid_user_cancel": {
+    "et": "Katkestasite Mobiil-ID autentimise.",
+    "ru": "Авторизация прервана пользователем",
+    "fi": "Olette peruttaneet todentamisen."
+  },
+  "mid_phone_absent": {
+    "et": "Telefon on levist väljas.",
+    "ru": "Телефон находится вне зоны действя.",
+    "fi": "Puhelimeen ei saada yhteyttä."
+  },
+  "mid_unknown_error": {
+    "et": "Tundmatu viga; Proovi hiljem uuesti.",
+    "ru": "Неизвестная ошибка. Пожалуйста, повторите попытку позже.",
+    "fi": "Tuntematon virhe. Yrittäkää myöhemmin uudelleen."
+  },
+  "mid_no_certificate":{
+    "et": "Kasutaja sertifikaat puudub!",
+    "ru": "Сертификат пользователя отсутствует!",
+    "fi": "Kysyjän varmenne puuttuu!"
+  },
+  "mid_not_registered":{
+    "et": "Antud telefoninumbril puudub Mobiil-ID leping!",
+    "ru": "Этот мобильный номер не зарегистрирован для использования Mobiil-ID!",
+    "fi": "Mobiil-ID liitymäänne ei ole rekisteröity!"
+  },
+  "mid_cert_revoked":{
+    "et": "Mobiil-ID sertifikaadid on kehtetud!",
+    "ru": "Mobiil-ID сертификаты отменены!",
+    "fi": "Mobiil-ID varmenteet eivät ole voimassa!"
+  },
+  "mid_not_activated":{
+    "et": "Mobiil-ID on aktiveerimata. Mobiil-ID aktiveerimiseks pöörduge aadressile <a href=\"http://mobiil.id.ee/\">mobiil.id.ee</a>.",
+    "ru": "Mobiil-ID не активирована. Для активации Mobiil-ID посетите этот адрес <a href=\"http://mobiil.id.ee/\">mobiil.id.ee</a>.",
+    "fi": "Mobiil-ID ei ole aktivoitu. Aktivoikaa Mobiil-ID osoitteessa <a  href=\"http:://mobiil.id.ee/\">mobiil.id.ee</a>."
+  }
+}