OpenID:n tukeminen sivustoilla

- OpenID:lle on olemassa valmiita kirjastoja eri ohjelmointikielille, joiden avulla voit helposti lisätä sivustoillesi tuen OpenID:lle. Kun sivustosi tukevat OpenID:tä, voivat käyttäjät kirjautua sinne OpenID-tunnuksillaan.

- Valmiita kirjastoja löytyy osoitteesta http://www.openidenabled.com/openid/libraries/ .

PHP - tuki

tunnus.com palvelua ylläpitävä Baware on muokannut osoitteesta http://www.openidenabled.com/openid/libraries/ löytyvää PHP kirjastoa siten, että sen käyttöönotto olisi mahdollisimman helppoa.

Muokatun version PHP OpenID 1.2.2 voit ladata tästä.

(Alkuperäisen kirjaston voit ladata osoitteesta http://www.openidenabled.com/openid/libraries/ .)

Muokatun kirjaston käyttöönotto

Kopioi tiedosto PHP OpenID 1.2.2 ja pura se palvelimellesi.
Luo symbolinen linkki palvelimellesi osoittamaan hakemistoon “/PHP-openid-1.2.2/consumer”. Esim. linux-ympäristössä tämä onnistuu komennolla:

ln -s openid /var/www/PHP-openid-1.2.2/consumer

Muokkaa ylläolevaa komentoa siten se osoittaa ympäristössäsi oikeaan hakemistoon. Hakemisto “/var/www/PHP-openid-1.2.2/consumer” on tässä vain esimerkkinä.

Jos loit symbolisen linkin “openid” www-palvelimesi juurihakemistossa, voit nyt kokeilla OpenID-kirjaston käyttöä siirtymällä selaimellasi osoitteeseen: http://www.palvelusi_nimi.com/openid

Selaimessa pitäisi aueta sivu, minne voit syöttää aiemmin rekisteröimäsi OpenID-tunnuksen (esim. “kalle.tunnus.com”).

Jos kaikki toimii, voit alkaa muokkaamaan kirjastoa osaksi sivustoasi.

Muokatun kirjaston liitos sivustoon

Hakemistossa “/PHP-openid-1.2.2/consumer” löytyy tiedosto “openidConsumerTrigger.php”, mitä muokkaamalla voit helposti liittää OpenID-tunnistuksen osaksi sivustoasi. tiedostossa on määritelty PHP luokka OpenidConsumerTrigger, jota muokattu kirjasto kutsuu aina kun OpenID-tunnistuksessa tapahtuu jotakin.

OpenidConsumerTrigger luokan kuvaus

function success($openid,$response)

Tätä metodia kutsutaan kun OpenID-tunnistus on onnistunut. Parametri “openid” sisältää käyttäjän OpenID:n

function cancelled($openid,$response)

Tätä metodia kutsutaan kun käyttäjä on keskeyttänyt OpenID-tunnistuksen. Parametri “openid” sisältää käyttäjän OpenID:n

function failed($openid,$response)

Tätä metodia kutsutaan kun OpenID-tunnistus on epäonnistunut. Parametri “openid” sisältää käyttäjän OpenID:n

function addExtensionRequests()

Tätä metodia kutsutaan kun käyttäjän tunnistus aloitetaan. Metodissa voit lisätä OpenID-tunnistuspyyntöön lisätietoja, joita haluaisit OpenID-palvelimen luovuttavan käyttäjästä. (HUOM! kaikki OpenID-palvelut eivät tue tätä toimitoa. Lisäksi käyttäjä voi estää pyytämiesi tietojen luovutuksen, eli älä missään tilanteessa luota siihen, että tietoja sivustollesi luovutettaisiin vaikka niitä pyytäisitkin OpenID-palvelimelta.)

Voit pyytää tietoja “vapaaehtoisena” tai “vaadittuna”. (”optional” tai “required” ).

Tämä asetus kertoo käyttäjälle mitä tietoja sivustosi haluaisi ja ovatko tiedot vaadittuja. Vaikka vaatisit joitain tietoja, voi käyttäjä kieltää niiden luovutuksen, jolloin OpenID-palvelin ei niitä sivustollesi luovuta.

Pyydettäviä lisätietoja ovat:

“nickname” - Käyttäjän mielellään käyttämä lempinimi/tunnus
“email” - Käyttäjän sähköpostiosoite
“fullname” - Käyttäjän koko nimi
“dob” - Käyttäjän syntymäaika
“gender” - Käyttäjän sukupuoli
“postcode” - Käyttäjän postinumero
“country” - Käyttäjän maa
“language” - Käyttäjän kieli
“timezone” - Käyttäjän aikavyöhyke

function processExtensions

Tätä metodia kutsutaan kun käyttäjän tunnistus on onnistunut. Metodissa voit käsitellä mahdollisia lisätietoja, joita pyysit metodissa “addExtensionRequests”.

(HUOM! kaikki OpenID-palvelut eivät tue lisätietojen luovutusta. Lisäksi käyttäjä voi estää pyytämiesi tietojen luovutuksen, eli älä missään tilanteessa luota siihen, että tietoja sivustollesi luovutettaisiin vaikka niitä pyytäisitkin OpenID-palvelimelta.)

function getError_expectedOpenIDURL()

Palauttaa virheilmoituksen virheellisestä OpenID-tunnuksesta.

function getError_authenticationError()

Palauttaa virheilmoituksen tunnistuksen epäonnistumisesta.

function getError_verificationCancelled()

Palauttaa virheilmoituksen, että käyttäjä on keskeyttänyt OpenID tunnistuksen. (Älä suorita metodissa muita toimintoja kuin virheilmoitustekstin muotoilun. Muut toiminnot voit sijoittaa metodiin “cancelled”.)

function getError_AuthenticationFailed()

Palauttaa virheilmoituksen, että käyttäjän tunnistus epäonnistui. (Älä suorita metodissa muita toimintoja kuin virheilmoitustekstin muotoilun. Muut toiminnot voit sijoittaa metodiin “failed”.)

function getMessage_verificationSuccess($esc_identity)

Palauttaa viestin, että käyttäjän tunnistun onnistui. (Älä suorita metodissa muita toimintoja kuin virheilmoitustekstin muotoilun. Muut toiminnot voit sijoittaa metodiin “succeeded”.)