Koha-clms/C4
Robin Sheat 4cbeeedbe8 Bug 6296: allow users to be authenticated by SSL client certs
This adds a new syspref: AllowPKIAuth. It can have one of three states:
* None
* Common Name
* emailAddress

If a) this is set to something that's not "None", and b) the webserver
is passing SSL client cert details on to Koha, then the relevant field
in the user's certificate will be matched up against the field in the
database and they will be automatically logged in. This is used as a
secure form of single sign-on in some organisations.

The "Common Name" field is matched up against the userid, while
"emailAddress" is matched against the primary email.

This is an example of what might go in the Apache configuration for the
virtual host:

    #SSLVerifyClient require # only allow PKI authentication
    SSLVerifyClient optional
    SSLVerifyDepth 2
    SSLCACertificateFile /etc/apache2/ssl/test/ca.crt
    SSLOptions +StdEnvVars

The last line ensures that the required details are
passed to Koha.

To test the PKI authentication, use the following curl command:
    curl -k --cert client.crt --key client.key  https://URL/
(look through the output to find the "Welcome," line to indicate that a user
has been authenticated or the "Log in to Your Account" to indicate that a
user has not been authenticated)

To create the certificates needed for the above command, the following series
of commands will work:
    # Create the CA Key and Certificate for signing Client Certs
    openssl genrsa -des3 -out ca.key 4096
    openssl req -new -x509 -days 365 -key ca.key -out ca.crt
    # This is the ca.crt file that the Apache config needs to know about,
    # so put the file at /etc/apache2/ssl/test/ca.crt

    # Create the Server Key, CSR, and Certificate
    openssl genrsa -des3 -out server.key 1024
    openssl req -new -key server.key -out server.csr

    # We're self signing our own server cert here.  This is a no-no in
    # production.
    openssl x509 -req -days 365 -in server.csr -CA ca.crt -CAkey ca.key \
        -set_serial 01 -out server.crt

    # Create the Client Key and CSR
    openssl genrsa -des3 -out client.key 1024
    openssl req -new -key client.key -out client.csr

    # Sign the client certificate with our CA cert. Unlike signing our own
    # server cert, this is what we want to do.
    openssl x509 -req -days 365 -in client.csr -CA ca.crt -CAkey ca.key \
        -set_serial 02 -out client.crt
    openssl pkcs12 -export -in client.crt -inkey client.key -out client.p12
    # In theory we can install this client.p12 file in Firefox or Chrome, but
    # the exact steps for doing so are unclear, and outside the scope of this
    # patch

Signed-off-by: Jared Camins-Esakov <jcamins@cpbibliography.com>
Tested with Common Name and E-mail authentication, as well as with PKI
authentication disabled. Regular logins continue to work in all cases when
SSL authentication is set to optional on the server.

Signed-off-by: Ian Walls <koha.sekjal@gmail.com>
QA comment: synchronized updatedatabase.pl version of syspref with sysprefs.sql
version, to avoid divergent databases between new and upgrading users.
2012-03-19 17:02:44 +01:00
..
AuthoritiesMarc Bug 5385: POD Cleanups (part 1) 2010-11-12 10:06:55 +13:00
Barcodes Bug 5385 - Fixing an error that crept in with the POD cleanup 2010-11-12 10:42:19 +13:00
Cache Bug 5385: POD Cleanups (part 1) 2010-11-12 10:06:55 +13:00
ClassSortRoutine Bug 4265: Fix padding of short callnumbers and Bib-1 attribute for sorting 2011-03-29 21:54:12 +13:00
Creators Bug 7215 - changed callnumber PRESET field to itemcallnumber 2011-12-12 17:36:09 +01:00
External Bug 5385: POD Cleanups (part 1) 2010-11-12 10:06:55 +13:00
Form Fix for Bug 6458 - incorrect parsing result in translation processing 2011-09-15 08:38:58 +12:00
Heading signed off Bug 7284: Authority matching improvements 2012-03-07 17:34:11 +01:00
ILSDI Bug #6142 - Delete sub CanBookBeReserved and delete function's reference on @EXPORT 2011-12-27 18:38:42 +01:00
Installer Bug 7532 - remove dependency on Date::ICal 2012-02-17 11:49:05 +01:00
Labels Bug 7615 - Give option to use description for homebranch/holding branch in label creator instead of the branchcode 2012-03-08 16:12:50 +01:00
Linker signed off Bug 7284: Authority matching improvements 2012-03-07 17:34:11 +01:00
Members bug_7001: Issue and Reserve slips are notices. 2012-03-09 10:11:20 +01:00
Output Fix FSF address in directory C4/ 2010-03-16 20:17:56 -04:00
Patroncards fixing various links to point to *.koha-community.org 2010-10-21 22:08:24 -04:00
Reports Bug 6755 : Fixing a bug with guided reports 2011-09-27 07:04:02 +13:00
SIP Bug 7454 Initialize return arrays in ILS/Transaction/RenewAll 2012-02-21 17:35:56 +01:00
Search Bug 5385: POD Cleanups (part 1) 2010-11-12 10:06:55 +13:00
Utils Bug 6836 follow-up fixing POD 2012-01-27 13:58:20 +01:00
VirtualShelves Bug 4912 [REVISED] After editing private list, user should be redirect to private lists 2012-03-02 18:27:24 +01:00
Accounts.pm Bug 6634 manager_id and itemnumber not populated when paying fines 2012-02-13 15:16:21 +01:00
Acquisition.pm Bug 7402 : Fixing the date formatting so links to the invoice page work 2012-01-23 17:52:19 +01:00
Auth.pm Bug 6296: allow users to be authenticated by SSL client certs 2012-03-19 17:02:44 +01:00
Auth_cas_servers.yaml.orig Bug 5630 CAS improvements 2011-10-13 10:49:49 +13:00
Auth_with_cas.pm Bug 5630 CAS improvements 2011-10-13 10:49:49 +13:00
Auth_with_ldap.pm Bug 6022: Auth_with_ldap check if categorycode is valid 2011-12-06 19:51:15 +01:00
AuthoritiesMarc.pm signed off Bug 7284: Authority matching improvements 2012-03-07 17:34:11 +01:00
BackgroundJob.pm replace references to defunct info email address 2010-06-25 05:18:44 -04:00
Barcodes.pm Bug 5681: Fixes leading zeroes in Add Mulpiple Copies 2011-02-03 10:08:50 +13:00
Biblio.pm signed off Bug 7284: Authority matching improvements 2012-03-07 17:34:11 +01:00
Bookseller.pm Bug 4969: deletion of suppliers 2012-03-13 15:12:26 +01:00
Boolean.pm Bug 5448: Refactor Boolean.pm 2010-12-02 08:51:33 +13:00
Branch.pm Bug 7034: de-nesting C4/Branch.pm 2011-10-19 03:23:31 +13:00
Breeding.pm Fix for Bug 4290 - search for author in repository 2011-03-06 08:22:06 +13:00
Budgets.pm bug_4831: Use unitprice (actual cost) when totalling spent amounts for "All available funds", as in "Already received" 2011-09-22 19:35:40 +12:00
Cache.pm Bug 5363 - Removing unused module (C4::Cache::FastMemcached) 2010-11-04 20:05:36 +13:00
Calendar.pm Fix for Bug 4991, Overhaul of Calendar interface 2010-11-02 15:02:54 +13:00
Category.pm Bug 6989 Patron categories not properly displayed if not pure ASCII 2011-11-04 12:07:08 +01:00
Charset.pm bug 5579 : Fixes several exports to embed items 2011-04-19 22:35:15 +12:00
Circulation.pm bug_7001: Issue and Reserve slips are notices. 2012-03-09 10:11:20 +01:00
ClassSortRoutine.pm Bug 7035 de-nesting C4::ClassSource & ClassSortRoutine 2011-10-19 03:25:59 +13:00
ClassSource.pm Bug 7035 de-nesting C4::ClassSource & ClassSortRoutine 2011-10-19 03:25:59 +13:00
Context.pm Bug 6193 follow-up of the follow-up = reindentation only 2012-02-21 13:16:11 +01:00
Contract.pm replace references to defunct info email address 2010-06-25 05:18:44 -04:00
Creators.pm Fix some compile time errors reported in test suite 2010-12-02 08:53:53 +13:00
Csv.pm Bug 2505 - Add commented use warnings where missing in *.pm 2010-04-21 20:28:51 +12:00
Dates.pm Bug 929 : Follow up adding unit tests, discovered C4::Dates cached the syspref with no way to clear it, fixed also. 2012-01-13 16:17:48 +01:00
Debug.pm More POD cleanups 2010-06-09 08:38:58 -04:00
Heading.pm signed off Bug 7284: Authority matching improvements 2012-03-07 17:34:11 +01:00
Images.pm Bug 1633: QA follow-up 2012-01-24 11:16:10 +01:00
ImportBatch.pm Bug 7513 Marc Import Hangs 2012-02-21 17:02:46 +01:00
ImportExportFramework.pm Bug 7476 Remove executable bit from files that probably should not be executed 2012-02-03 14:22:15 +01:00
Input.pm replace references to defunct info email address 2010-06-25 05:18:44 -04:00
Installer.pm Bug 6008 - Locating mysql/psql commands on Installer.pm 2012-02-27 15:38:07 +01:00
ItemCirculationAlertPreference.pm POD Cleanups 2010-06-09 08:38:59 -04:00
ItemType.pm Bug 6371 Item Types description not properly displayed if not pure ASCII 2011-10-08 20:10:29 +13:00
Items.pm Merge remote-tracking branch 'origin/new/bug_6875' 2012-03-14 16:16:21 +01:00
Koha.pm Bug 3216: UNIMARC author facets 2012-03-13 16:35:02 +01:00
Labels.pm Bringing label, patroncard, and creator modules into conformity with the rest of C4 style. 2010-02-08 20:54:34 -05:00
Languages.pm Bug 6193 - Follow up: use SetEnv and remove memcached from koha-conf.xml 2012-02-20 23:24:02 +01:00
Letters.pm Bug 7167: Followup: FIX conflicts with Bug 5347 2012-03-13 12:27:13 +01:00
Linker.pm Bug 7284: Fix unit test broken by erroneous POD 2012-03-08 15:24:18 +01:00
Log.pm Bug 6460: alternative fix, updating template and script instead of C4::Log 2011-09-24 10:01:09 +12:00
Maintainance.pm replace references to defunct info email address 2010-06-25 05:18:44 -04:00
Matcher.pm Bug 5415 Let calls of SimpleSearch utilize considtent interface 2011-04-08 13:52:57 +12:00
Members.pm Bug 6296: allow users to be authenticated by SSL client certs 2012-03-19 17:02:44 +01:00
Message.pm bug_7001: Issue and Reserve slips are notices. 2012-03-09 10:11:20 +01:00
NewsChannels.pm Fix FSF address in directory C4/ 2010-03-16 20:17:56 -04:00
Output.pm Bug 7535: ampersands not showing properly in non-XSLT OPAC 2012-02-21 15:45:11 +01:00
Overdues.pm Bug 6987 Make return from Overdues::GetFine consistent 2011-12-08 11:19:10 +01:00
Patroncards.pm Fix some compile time errors reported in test suite 2010-12-02 08:53:53 +13:00
Print.pm bug 7001 follow-up fixing POD mistake 2012-03-13 11:18:39 +01:00
Record.pm Bug 7345: Enable exporting records sans private fields 2012-02-13 11:32:18 +01:00
Reports.pm More POD cleanups 2010-06-09 08:38:58 -04:00
Reserves.pm Bug 7408 - Don't cancel found reserves. 2012-03-09 16:13:54 +01:00
Review.pm Bug 1623 - Provide view of approved comments 2011-12-27 18:26:50 +01:00
Ris.pm bug 5780 followup: RIS export now includes all URLs 2011-10-14 10:37:31 +13:00
RotatingCollections.pm Fix some compile time errors reported in test suite 2010-12-02 08:53:53 +13:00
SMS.pm More POD cleanups 2010-06-09 08:38:58 -04:00
SQLHelper.pm Bug 7432 : Fixing caching for SQLHelper 2012-02-15 10:26:24 +01:00
Scheduler.pm POD Cleanups 2010-06-09 08:38:59 -04:00
Scrubber.pm Bug 5611: Simple typo fix in the comments 2011-01-13 08:17:27 +13:00
Search.pm Enh 7031: More options for Advanced Search 2012-03-14 14:35:27 +01:00
Serials.pm Bug 6875 de nesting C4::Biblio 2012-02-20 16:35:17 +01:00
Service.pm POD Cleanups 2010-06-09 08:38:59 -04:00
ShelfBrowser.pm Bug 5551 - allow shelf browser filters to be changed 2011-01-21 11:08:42 +13:00
Stats.pm replace references to defunct info email address 2010-06-25 05:18:44 -04:00
Suggestions.pm bug_7001: Issue and Reserve slips are notices. 2012-03-09 10:11:20 +01:00
TTParser.pm Merge remote-tracking branch 'origin/new/bug_5327' 2012-02-15 13:55:48 +01:00
Tags.pm Bug 7259 - Show a count of items pending approval on staff client home and tools pages 2011-12-08 12:04:28 +01:00
Templates.pm Bug 7511 [ENH] Template caching (T::T feature) 2012-02-13 11:01:46 +01:00
TmplToken.pm Bug 6458 Template Toolkit files test case 2011-08-18 21:11:50 +12:00
TmplTokenType.pm Bug 6458 Template Toolkit files test case 2011-08-18 21:11:50 +12:00
UploadedFile.pm Bug 1633: [SIGNED-OFF] Add support for uploading images to Koha 2012-01-24 11:16:02 +01:00
Utils.pm Big LDAP changes, module test for Context.pm, still more yet to come. 2007-12-04 17:27:06 -06:00
VirtualShelves.pm Bug 6875 de-nesting C4::VirtualShelves 2012-02-15 14:58:40 +01:00
XISBN.pm Fix for Bug 5570 - item types not showing on other editions 2011-01-07 14:18:09 +13:00
XSLT.pm Bug 7476 Remove executable bit from files that probably should not be executed 2012-02-03 14:22:15 +01:00
Z3950.pm fixing various links to point to *.koha-community.org 2010-10-21 22:08:24 -04:00