uwdoem/connection

Helper library for connecting to the university's x.509 secured web services

, _(*1)

UWDOEM/Connection

Connection is a PHP helper library for connecting to the university's x.509 secured web services. Connection is used by uwdoem/person to connect to the university's person and student web services., _(*2)

Installation

You can use Connection directly by including it in your composer.json file require statements:, _(*3)

  "require": {
    ...
    "uwdoem/connection": "2.*",
    ...
  },

Of course it is possible to use Connection without Composer by downloading it directly, but use of Composer to manage packages is highly recommended. See Composer for more information., _(*4)

Troubleshooting

This library will throw warnings and exceptions when it recognizes an error. Turn on error reporting to see these. The following conditions will halt execution:, _(*5)

cURL Error Code 77

Problem: cURL cannot find the UWCA root certificate to verify the identify of the PWS/SWS servers., _(*6)

Solution: Download the .crt root CA bundle to your server, ensure that your web-server process has read access to this bundle, and uncomment/edit the curl.cainfo line in your php.ini to reflect the location of this bundle., _(*7)

cURL Error Code 58

Problem: cURL is having a problem using your private key., _(*8)

Solution: You may have provided an incorrect private key password to ::createConnection. If your private key requires a password, provide one, and ensure that it is correct., _(*9)

No such file found for SSL key/certificate

Problem: Connection cannot find the key and/or certificate at the path you provided to ::createConnection., _(*10)

Solution: Ensure that you provided the correct path to these files and that your web-server process has read-access to these files., _(*11)

Incorrect password for SSL key, but you're providing the correct SSL key password

Problem: This might be caused by a bug in the system cURL, which might cache your SSL keys; it seems that cURL can confuse these keys and use apply the wrong password to a key., _(*12)

Solution: Only use one SSL key on one server, or make all SSL keys passwordless., _(*13)

Script execution halts/no output

Problem: This might be caused by an internal error in cURL while accessing your private key/certificate which causes PHP to die unexpectedly., _(*14)

Solution: I was able to solve this by setting permissions on my key/certificate to read only. Specifically, I turned off write access for all parties., _(*15)

Requirements

• PHP 5.5, 5.6, 7.0
• cURL

Todo

See GitHub issue tracker., _(*16)

Getting Involved

Feel free to open pull requests or issues. GitHub is the canonical location of this project., _(*17)

Here's the general sequence of events for code contribution:, _(*18)

1. Open an issue in the issue tracker.
2. In any order:
   • Submit a pull request with a failing test that demonstrates the issue/feature.
   • Get acknowledgement/concurrence.
3. Revise your pull request to pass the test in (2). Include documentation, if appropriate.