DK-LTI 1.0. Dansk applikationsprofil for LTI VERSION: 1.0

Transkript

1 DK-LTI 1.0 Dansk applikationsprofil for LTI VERSION: 1.0 DATO: 9. december

2 Indholdsfortegnelse 1 Introduktion Formål Afgrænsninger Sikkerhed Opstart af ekstern tool Parametre Generering af opstart Tilbageførsel af resultater LTI Basic Outcome DK-LTI Multi Outcome Uopfordret resultatoverførsel XML skemaer til validering af Outcome beskeder Referencer Version Dato Forfatter Note oktober 2015 SMI/CHG Lakeside Første udkast til DK-LTI november 2015 SMI/CHG Lakeside Efter kommentar fra standardiseringsgruppen indarbejdet november 2015 SMI/CHG Lakeside Klar til ekstern review i standardiseringsgruppen november 2015 SMI/CHG Lakeside Rettet pga. review i standardiseringsgruppen december 2015 SMI/CHG Lakeside Input fra leverandørhøring indarbejdet 2

3 1 Introduktion Dette dokument beskriver applikationsprofilen DK-LTI, som er en profilering af den internationale IMS LTI standard til danske forhold. IMS LTI standardiserer to protokoller: En protokol for opstart af et ekstern web-baseret læringsværktøj fra en læringsplatform. I LTI kaldes udbyderen af læringsværktøjet for toolprovider (TP) og læringsplatformen optræder som toolconsumer (TC). En protokol for tilbageførsel af elevens opnåede resultater fra toolprovider til toolconsumer. Applikationsprofilen DK-LTI er baseret på version af IMS LTI, og udvider og indskrænker IMS LTI standarden ved at: 1. Fastlægge forpligtelsen af opstartsparametre i opstartsprotokollen 2. Udvide protokollen for resultattilbageførsel med mulighed for at returnere flere resultater 3. Udvide interaktionsmodellen med mulighed for uopfordret resultatoverførsel 4. Gøre signering af såvel opstart og tilbageførsel af resultater obligatorisk Version 1.0 af DK-LTI bygger desuden på anvendelsen af UNI-Login til brugeridentifikation, brugeradgangs- og rollestyring og håndtering af stamdata for brugeren. Nærværende dokument er et supplement til [LTI-IMPL] og kan således ikke stå alene. Læseren forventes at have grundlæggende kendskab til LTI. For at lette læserens forståelse refereres der i dette dokument til de relevante afsnit af LTI standarden. 2 Formål Initiativet til specificering af DK-LTI kommer fra den fællesoffentlige standardiseringsgruppe under Brugerportalsinitiativet for grundskoler og dagtilbud, repræsenteret ved Styrelsen for It og Læring under Ministeriet for børn, undervisning og ligestilling (STIL) samt KL. Målet med standardisering af protokollerne for toolopstart og tilbageførsel af resultater i DK-LTI er at gøre integration af eksterne værktøjer i læringsplatforme lettere. Hvis både TC og TP overholder DK-LTI bør integrationer kunne etableres alene igennem konfigurationer hos de to parter. 3 Afgrænsninger DK-LTI baserer sig på version af IMS LTI, som er en relativ simpel og let implementerbar standard. Den seneste version 2.0 af IMS LTI bygger på en forholdsvis kompleks interaktionsmodel, som vil øge implementationsbyrden hos såvel TC er og TP er, uden at det vil bibringe den danske anvendelse mærkbare funktionalitetsgevinster. LTI 2.0 er derfor fravalgt. For at understøtte tilbageførsel af flere resultater er en anvendelse af den særskilte IMS LTI Outcome Management 2.0 blevet overvejet. Idet Outcome Management 2.0 forudsætter store dele af LTI 2.0 og i skrivende stund kun foreligger i en draft udgave, så er en anvendelse af denne specifikationen ligeledes fravalgt. DK-LTI forudsætter anvendelse af UNI-Login til håndtering af brugerdata. Governance for brugerdata samt håndtering af privacy aspekter ligger derfor alene hos UNI-Login. Anvendelsen af version 1.0 af DK-LTI er begrænset til uddannelsesområder, hvor der anvendes UNI- Login, dvs. grundskoleområdet. I senere udgaver af applikationsprofilen kunne anvendelsesområdet udvides til andre uddannelsesområder, eksempelvis universitetsområdet (med WAYF som brugerstyringsplatform). 3

4 4 Sikkerhed LTI benytter OAuth 1.0 signering (se [OAuth]) til sikring af end-to-end beskeds-integritet og sikker identifikation af beskeds-afsenderen. Dette gælder både for protokollen til toolopstart og protokollen til tilbageførsel af resultater, se afsnit 4 i [LTI-IMPL]. OAuth signering er baseret på HMAC-SHA1 algoritmen som opererer med symmetriske nøgler. Den symmetriske nøgle består af en key og et secret, som i LTI genereres af TP og overføres til TC (hvordan nøglen overføres ligger udenfor standarden). I LTI er key en identifikation for TC/TP-integrationen og indgår som parameter i alle beskeder, hvorimod secret er den hemmelige del af nøglen. Et formål med at anvende OAuth signering i toolopstart er desuden at sikre kommunikationen mod manipulation i browseren, og signering må derfor ikke foretages i browseren. I DK-LTI er OAuth signering obligatorisk for begge protokoller. 5 Opstart af ekstern tool Opstart af et eksternt tool foregår gennem OAuth signering af et HTTP POST kald med en række parametre, herunder kontekstinformation for det læringsforløb brugeren er i gang med, se afsnit 3 i [LTI- IMPL]. I modsætning til standard LTI ligger autentifikation af brugeren ikke hos TC, men hos en tredjepart (UNI- Login). Via UNI-Login modtager TP en ligeledes brugerens rolle og organisatorisk tilhørsforhold. For at sikre at TC og TP servicerer den samme bruger, så medsendes brugerens UNI-Login ID som parameter fra TC til TP. 5.1 Parametre I det følgende listes standard LTI parametrene til opstartskaldet med parameternavn, beskrivelse og forpligtelse. DK-LTI indfører tre parametre som danske udvidelser: ext_dk_unilogin_id, ext_dk_unilogin_groupid og ext_dk_multi_outcome_service_url, som henholdsvis angiver brugerens UNI-Login ID, brugerens aktuelle UNI-Login gruppe og multiresultat service-endpointet hos TC en. Parameternavn Beskrivelse Forpligtelse lti_message_type lti_version resource_link_id resource_link_title LTI beskedtypen - denne er en del af protokollen og sættes altid til basic-ltilaunch-request. LTI version - denne er også en del af protokollen og sættes altid til LTI-1p0. ( LTI-1p0 står for version 1.0 af LTI som er opad kompatibel med version 1.1 og 1.1.1) Et ID som skal være unikt for en placering af LTI linket hos TC. Hvis der linkes til toolet flere gange i samme kontekst/læringsforløb skal der benyttes et separat resource_link_id til hvert link. En titel for LTI linket som er beregnet til visning hos TC. Parameteren sendes ikke med i opstarts-kaldet, men benyttes til udveksling af LTI links igennem Cartridges. Anbefalet (i Cartridges) 4

5 Parameternavn Beskrivelse Forpligtelse resource_link_description user_id user_image roles lis_person_name_given lis_person_name_family lis_person_name_full lis_person_contact_ _primary role_scope_mentor context_id context_type context_title context_label launch_presentation_locale launch_presentation_document_target launch_presentation_css_url launch_presentation_width launch_presentation_height launch_presentation_return_url En beskrivelse af indholdet for LTI linket. Beskrivelsen er alene beregnet til visning hos TC og parameteren sendes ligeledes ikke med i opstarts-kaldet, men benyttes til udveksling af LTI links igennem Cartridges. En ID for brugeren. Parameteren benyttes ikke - i stedet angives brugerens UNI-Login ID, se ext_dk_unilogin_id nedenunder. En URL til et billede af brugeren. Parameteren benyttes ikke. Brugerens roller. Parameteren benyttes ikke, TP henter i stedet brugerens roller fra UNI-Login. Brugerstamdata. De fire parametre anvendes ikke, i stedet får TP brugerstamdata fra UNI-Login. En liste af bruger ID ersom den aktuellebruger kan tilgå i rollen som mentor. Fx i rollen som forælder eller lærer. Parameteren benyttes ikke - en TP får relationer fra UNI-Login. En unik ID for den kontekst / det læringsforløb brugeren befinder sig i. En angivelse af kontekst-/lærings- forløbstypen jf. LIS klassifikation. Parameteren benyttes ikke. En overskrift for konteksten/læringsforløbet til visning i TP. Eksempelvis Matematik - Pythagoras sætning Et kort label for konteksten/læringsforløbet til visning i TP. Parameteren benyttes ikke. En angivelse af sprogkode, landkode og eventuel variant for det sprog som toolet ønskes vist i. Formatet er specificeret i [BCP-47], fx en-gb eller da. Præsentations-relaterede stylings parametre. Benyttes ikke - styling af toolet overlades til TP. En URL hos TC, som TP kan redirecte brugerens browser til når brugeren er færdig med toolet. Anbefalet Anbefalet 5

6 Parameternavn Beskrivelse Forpligtelse tool_consumer_info_product_family_code tool_consumer_info_version tool_consumer_instance_guid tool_consumer_instance_name tool_consumer_instance_description tool_consumer_instance_url tool_consumer_instance_contact_ Sikkerhed Produkt-informationer om TC. Kan være nyttigt i forbindelse med fejlfinding hos TP. Et unikt ID for TC instansen, fx i form af identifikationsnummer for skolen. Kan være nyttigt i forbindelse med fejlfinding. Navn, beskrivelse, URL og kontakt for TC instansen. Parametrene benyttes ikke. Anbefalet Anbefalet oauth_consumer_key oauth_signature_method oauth_timestamp oauth_nonce oauth_version oauth_signature oauth_callback Resultat-tilbageførsel OAuth signeringsparametre som defineret i [OAuth]. TC sætter parametrene som del af signeringen af LTI kaldet, før det sendes til TP. Ved modtagelse skal TP validere TC signatur og identifikation. (oauth_callback er valgfri og kan ignoreres) e lis_result_sourcedid lis_outcome_service_url lis_person_sourcedid lis_course_offering_sourcedid lis_course_section_sourcedid Danske udvidelser Et unikt ID hos TC som resultat(er) kan knyttes til. Parameteren skal være unik for hver kombination af context_id, resource_link_id og ext_dk_unilogin_id. URL for service-endpointet hos TC, hvor TP kan aflevere resultater igennem LTI Basic Outcome protokollen. Et ID for den bruger, som resultater skal tilbageføres for. Parameteren indgår ikke i protokollen for resultat tilbageførsel og benyttes ikke. Forløbsinformation som defineret i LIS modellen. Parametrene indgår ikke i protokollen for resultat tilbageførsel og benyttes ikke. ext_dk_unilogin_id ext_dk_unilogin_groupid Brugerens UNI-Login ID, som skal valideres af TP mod brugerens UNI-Login session. ID for brugerens i læringskonteksten aktuelle UNI-Login gruppe. 6

7 Parameternavn Beskrivelse Forpligtelse ext_dk_multi_outcome_service_url URL for service-endpointet, hvor TP kan aflevere multiresultater igennem DK-LTI Multi Outcome protokollen. (En TC kan godt udstille LTI Basic Outcome og DK-LTI Multi Outcome i samme endpoint.) En TP kan ignorere ikke anbefalede og valgfrie parametre, hvis TP en ikke supporterer disse. En TP må dog ikke fejle på disse parametre. 5.2 Generering af opstart En TC skal gennemføre følgende trin for at tilvejebringe opstarten af et eksternt tool: 1. Parametre opsamles i læringsplatformen 2. OAuth Signature Base String for kaldet genereres 3. Ud fra key og secret beregnes OAuth signaturen for Signature Base String 4. Der genereres en (lokal) webside med en HTML form som indeholder det signerede POST kald 5. Brugerens browser tilgår den genererede webside hvorfra POST kaldet sendes til TP en Detaljerne for trin 2 og 3 er beskrevet i afsnit 3 i [OAuth]; det anbefales at TC og TP benytter standard OAuth 1.0 kode-biblioteker til henholdsvis signering og signatur-validering af kaldet, se [OAuth-Code]. Et eksempel på et opstarts-kald findes i appendiks B.5 i [LTI-IMPL]. 6 Tilbageførsel af resultater I LTI kan en TP returnere et resultat via en simpel protokol baseret på XML objekter der sendes over HTTP, se afsnit 6 i [LTI-IMPL]. Standard LTI tillader kun, at der tilbageføres et enkelt decimalt resultat for hvert tool opstart. DK-LTI udvider standarden med en rigere resultatmodel, som muliggør tilbageførelse af en liste af resultater. I LTI defineres følgende tre operationer for tilbageførsel; hvis en TC eller TP understøtter tilbageførsel af resultater skal replace operation som minimum implementeres. Alle resultater som indgår i operationerne knyttes til en sourcedid, som TP sætter til værdien af lis_result_sourcedid parameteren modtaget fra TC ved toolopstart. Operation Beskrivelse Forpligtelse replaceresult Sætter et resultat (eller en liste af resultater) hos TC. Benyttes både til at tilbageføre og eventuel opdatere resultater. readresult Returner det sidste overførte resultat (eller liste af resultater). deleteresult Sletter et overført resultat (eller liste af resultater). Beskedsintegriteten for kald fra TP til TC sikres i LTI igennem OAuth signering med body hashing, se [OAUTH-BODY]. OAuth signeringen indeholder i oauth_consumer_key desuden en identifikation for den konfigurerede integration mellem TP og TC. TC en bør som aftager af kaldet sikre sig, at den medsendte sourcedid hører til netop den med oauth_consumer_key identificerede tool-integration. Der anvendes i LTI ikke nogen form for signering af svaret fra TC til TP. I DK-LTI regi anbefales altid at lade kommunikation mellem TP og TC foregå via SSL/TLS. Herved sikres integritet af svarene på transportniveau. 7

8 Nedenstående eksempel illustrerer et tilbageførselskald: POST /lp/dk-lti/outcome/ HTTP/1.1 Host: Content-Length: 1937 Authorization: OAuth realm=" oauth_version="1.0", oauth_nonce="ce73d00a09364d49b29f90c047a44b2e", oauth_timestamp=" ", oauth_consumer_key="rosenvangskolen-matematiktool", oauth_body_hash="v%2bxfnmdshv%2fj29qhxlwkfilrtpo%3d", oauth_signature_method="hmac-sha1", oauth_signature="8aurprdpy2krxuroyz3hkcs92y8%3d" Content-type: application/xml <?xml version = "1.0" encoding = "UTF-8"?> <imsx_poxenveloperequest xmlns=" </imsx_poxenveloperequest> Følgende er et eksempel på et efterfølgende svar fra en TC: HTTP/ OK Date: Fri, 6 Nov :12:25 GMT Content-type: application/xml Content-Length: 1354 <?xml version = "1.0" encoding = "UTF-8"?> <imsx_poxenveloperesponse xmlns=" </imsx_poxenveloperesponse> 6.1 LTI Basic Outcome I standard LTI Basic Outcome kan en TP tilbageføre et enkelt decimalt resultat (med en angivelse af formateringssprog for decimaltegnet). Nedenstående eksempel viser opbygningen af et LTI Basic Outcome kald: <?xml version = "1.0" encoding = "UTF-8"?> <imsx_poxenveloperequest xmlns=" <imsx_poxheader> <imsx_poxrequestheaderinfo> <imsx_version>v1.0</imsx_version> <imsx_messageidentifier> </imsx_messageidentifier> </imsx_poxrequestheaderinfo> </imsx_poxheader> <imsx_poxbody> <replaceresultrequest> <resultrecord> <sourcedguid> <sourcedid> </sourcedid> </sourcedguid> <result> <resultscore> <language>en</language> <textstring>0.92</textstring> </resultscore> </result> </resultrecord> </replaceresultrequest> </imsx_poxbody> </imsx_poxenveloperequest> 8

9 Et eksempel på et efterfølgende svar fra en TC som aftager af kaldet ses her: <?xml version="1.0" encoding="utf-8"?> <imsx_poxenveloperesponse xmlns=" <imsx_poxheader> <imsx_poxresponseheaderinfo> <imsx_version>v1.0</imsx_version> <imsx_messageidentifier>4560</imsx_messageidentifier> <imsx_statusinfo> <imsx_codemajor>success</imsx_codemajor> <imsx_severity>status</imsx_severity> <imsx_description>score for is now 0.92</imsx_description> <imsx_messagerefidentifier> </imsx_messagerefidentifier> <imsx_operationrefidentifier>replaceresult</imsx_operationrefidentifier> </imsx_statusinfo> </imsx_poxresponseheaderinfo> </imsx_poxheader> <imsx_poxbody> <replaceresultresponse/> </imsx_poxbody> </imsx_poxenveloperesponse> 6.2 DK-LTI Multi Outcome I DK-LTI har en TP mulighed for at returnere flere resultater, hvis en TC understøtter dette (ved at have angivet parameteren ext_dk_multi_outcome_service_url i opstartskaldet). I sted for et enkelt resultat indeholder et DK-LTI Multi Outcome kald en liste af resultater, som hver især består af: 1. En overskrift/emne for resultatet (topic) 2. En resultatskala (scale) 3. Selve resultatværdien (value) 4. En valgfri kommentar (comment) 5. Et valgfri link til en resultatside (link) DK-LTI definerer følgende typer af resultatskalaer og udfaldsrum: Skala (scale) Mulige værdier Procent Heltal mellem 0 og trin -3, 00, 02, 4, 7, 10 eller 12 bestået/ikke bestået gennemført/ikke gennemført bestået eller ikke bestået gennemført eller ikke gennemført Hvis der returneres et link til en webside med brugerens resultater skal adgangen til resultatsiden sikres i gennem UNI-Login. Nedenstående eksempel illustrerer opbygningen af et DK-LTI Multi Outcome kald: <?xml version = "1.0" encoding = "UTF-8"?> <imsx_poxenveloperequest xmlns=" <imsx_poxheader> <imsx_poxrequestheaderinfo> <imsx_version>v1.0</imsx_version> <imsx_messageidentifier> </imsx_messageidentifier> </imsx_poxrequestheaderinfo> </imsx_poxheader> <imsx_poxbody> <replaceresultrequest> <resultrecord> 9

10 <sourcedguid> <sourcedid> </sourcedid> </sourcedguid> <resultlist xmlns="urn:dk:lti:outcomes:1.0"> <result> <topic>algebra</topic> <scale>procent</scale> <value>34</value> </result> <result> <topic>geometri</topic> <scale>procent</scale> <value>98</value> <comment>virkelig flot præstation!</comment> </result> <result> <topic>samlet karakter</topic> <scale>7-trin</scale> <value>7</value> </link> </link> </result> </resultlist> </resultrecord> </replaceresultrequest> </imsx_poxbody> </imsx_poxenveloperequest> 6.3 Uopfordret resultatoverførsel I DK-LTI er der mulighed for uopfordret resultatoverførsel fra en toolprovider. Det vil sige, at der understøttes brugsscenariet, hvor et tool ikke startes fra en læringsplatform, men tilgås direkte af eleven i browseren. Resultater fra elevens arbejde med toolet overføres til elevens læringsplatform med den (begrænsede) kontekstinformation, der kan etableres i toolet. Uopfordret resultatoverførsel forudsætter, at der gennemføres en engangsopsætning mellem læringsplatformen og toolprovideren på skoleniveau (svarende til Institution i UNI-Login) hvor: 1. TP generer den symmetriske nøgle ( key og secret ), der skal benyttes til beskeds-signering og TP-identifikation for integrationen. 2. Læringsplatformen konfigureres med den symmetriske nøgle som TP har genereret. 3. TP konfigureres med læringsplatformens service-endpoint til aflevering af resultater (enten endpointet for LTI Basic Outcome servicen eller endpointet for DK-LTI Multi Outcome servicen). 4. TP konfigureres med hvorvidt alle resultater eller kun resultater for lærer-tilrettelagte opgavesæt skal sendes til læringsplatformen. Når en elev efterfølgende tilgår et tool hos TP en, kan denne fremfinde den etablerede integration (nøgle og resultatservice endpoint) ud fra elevens primære institution i UNI-Login. Resultater overføres via standard LTI protokollen, med signering af beskeder. Resultat-beskeder som TP sender til læringsplatformen, følger henholdsvis LTI Basic Outcome eller DK-LTI Multi Outcome. Men i den uopfordrede resultatoverførsel opbygges sourcedid elementet til at indeholde kontekstinformation. Denne kontekstinformation skal til en vis grad gøre det muligt for læringsplatformen, at knytte de overførte resultater til det rette læringsforløb for eleven. DK-LTI definerer følgende parametre der indgår i sourcedid : Parameter Beskrivelse Forpligtelse tool_id En unik ID for toolet. Sættes til URL en hvor toolet kan nås for at garantere unikhed på tværs af tools. 10

11 Parameter Beskrivelse Forpligtelse learner_unilogin_id learner_unilogin_groupid teacher_unilogin_id unsolicited_context_id UNI-Login ID for brugeren som resultaterne i beskeden vedrører. Aktuel UNI-Login gruppe ID for brugeren som resultaterne i beskeden vedrører. UNI-Login ID for læreren som har tilrettelagt opgavesættet i toolet som resultaterne i beskeden vedrører. Hvis resultaterne hører til et lærer-tilrettelagt opgavesæt bør denne parameter altid medsendes. En kontekst ID for det læringsforløb som resultaterne i beskeden knytter sig til. Denne valgfrie kontekst ID dannes i toolconsumeren og er beregnet til entydig at kunne knytte til et læringsforløb hos TC. Kontekst ID et kan overføres ved at TP giver læreren mulighed for at angive den under tilrettelæggelsen af et opgavesæt. Dvs. læreren kopierer en ID for læringsforløbet fra læringsplatformen til TP (med den risiko for fejl, der ligger i en manuel overførsel - for at imødegå denne risiko kunne en læringsplatform danne et meningsfuld ID som også indeholder fag, emne og klasse for det aktuelle læringsforløb. Fx noget i stil med biologi-frøer-7aid: ). Værdien af sourcedid elementet sættes til dk.lti.1.0.unsolicited-outcome: efterfulgt af en kommasepareret liste på formen parameter={værdi}. Rækkefølgen af parametrene er uspecificeret. Tegnet } må ikke indgå i en parameterværdi. Nedenstående eksempel illustrerer opbygningen af sourceid elementet (her vist med linjeskift): <sourcedid>dk.lti.1.0.unsolicited-outcome:tool_id={ {gruppe123},teacher_unilogin_id={grete234},unsolicited_context_id={biologi-frøer-7aid: }</sourcedid> Nedestående er et fuldt eksempel for en uopfordret resultatoverførselsbesked: <?xml version = "1.0" encoding = "UTF-8"?> <imsx_poxenveloperequest xmlns=" <imsx_poxheader> <imsx_poxrequestheaderinfo> <imsx_version>v1.0</imsx_version> <imsx_messageidentifier>urn:uuid:5e419df5-4bc9-4c3f a4ad5ce8b1 </imsx_messageidentifier> </imsx_poxrequestheaderinfo> </imsx_poxheader> <imsx_poxbody> <replaceresultrequest> <resultrecord> <sourcedguid> <sourcedid>dk.lti.1.0.unsolicited-outcome:tool_id={ eksempel-biologi-tool.dk},learner_unilogin_id={hans023},learner_unilogin_groupid= {gruppe123},teacher_unilogin_id={grete234},unsolicited_context_id={ aeec23} </sourcedid> </sourcedguid> 11

12 <result> <resultscore> <language>dk</language> <textstring>0,31</textstring> </resultscore> </result> </resultrecord> </replaceresultrequest> </imsx_poxbody> </imsx_poxenveloperequest> 7 XML skemaer til validering af Outcome beskeder XML skemaer, som kan benyttes til at validere både LTI Basic Outcome og DK-LTI Multi Outcome requests og responses, er offentliggjort sammen med DK-LTI profilen. De anvendte XML namespaces er: Standard LTI namespace til LTI Basic Outcome urn:dk:lti:outcomes:1.0 DK-LTI namespace til DK-LTI Multi Outcome elementer 12

13 8 Referencer [BCP-47] Best Current Practice 47 - Tags for Identifying Languages [CC] IMS Common Cartridge Specification [DK-Cart] DK-Cartridge Distributionsformat for læringsindhold Fås ved henvendelse til STIL [LTI] IMS Learning Tools Interoperability Specification [LTI-IMPL] IMS Learning Tools Interoperability Implementation Guide - version [OAuth] The OAuth 1.0 Protocol [OAuth-Code] Liste af OAuth kode-biblioteker [OAUTH-BODY] OAuth Request Body Hash [UNI-Login] UNI-Login - Brugere og adgangsstyring [WAYF] WAYF - den digitale genbrugsstation 13