--- loncom/interface/lonexttool.pm 2017/12/06 02:15:35 1.8
+++ loncom/interface/lonexttool.pm 2017/12/07 15:36:34 1.9
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Launch External Tool Provider (LTI)
#
-# $Id: lonexttool.pm,v 1.8 2017/12/06 02:15:35 raeburn Exp $
+# $Id: lonexttool.pm,v 1.9 2017/12/07 15:36:34 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -43,14 +43,13 @@ package Apache::lonexttool;
use strict;
use Apache::Constants qw(:common :http);
-use Net::OAuth;
use Encode;
use Digest::SHA;
-use UUID::Tiny ':std';
use HTML::Entities;
use Apache::lonlocal;
use Apache::lonnet;
use Apache::loncommon;
+use LONCAPA::ltiutils;
sub handler {
my $r=shift;
@@ -114,14 +113,18 @@ sub handler {
} else {
my $now = time;
if ($toolhash{'passback'}) {
- unless (&set_callback_secret($cdom,$cnum,$marker,'grade',$now,
- \%toolsettings,\%toolhash) eq 'ok') {
+ if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'grade',$now,
+ \%toolsettings,\%toolhash) eq 'ok') {
+ $toolhash{'gradesecret'} = $toolsettings{'gradesecret'};
+ } else {
undef($launchok);
}
}
if ($toolhash{'roster'}) {
- &set_callback_secret($cdom,$cnum,$marker,'roster',$now,
- \%toolsettings,\%toolhash);
+ if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'roster',$now,
+ \%toolsettings,\%toolhash) eq 'ok') {
+ $toolhash{'rostersecret'} = $toolsettings{'rostersecret'};
+ }
}
my $submittext = &mt('Launch [_1]',$toolhash{'title'});
if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') &&
@@ -150,54 +153,6 @@ sub handler {
return OK;
}
-sub set_callback_secret {
- my ($cdom,$cnum,$marker,$name,$now,$toolsettings,$toolhash) = @_;
- return unless ((ref($toolsettings) eq 'HASH') && (ref($toolhash) eq 'HASH'));
- my $warning;
- my ($needsnew,$oldsecret,$lifetime);
- if ($name eq 'grade') {
- $lifetime = $toolhash->{'passbackvalid'}
- } elsif ($name eq 'roster') {
- $lifetime = $toolhash->{'rostervalid'};
- }
- if ($toolsettings->{$name} eq '') {
- $needsnew = 1;
- } elsif (($toolsettings->{$name.'date'} + $lifetime) < $now) {
- $oldsecret = $toolsettings->{$name.'secret'};
- $needsnew = 1;
- }
- if ($needsnew) {
- if (&get_tool_lock($cdom,$cnum,$marker,$now) eq 'ok') {
- my $secret = UUID::Tiny::create_uuid_as_string(UUID_V4);
- $toolhash->{$name.'secret'} = $secret;
- my %secrethash = (
- $name.'secret' => $secret,
- $name.'secretdate' => $now,
- );
- if ($oldsecret ne '') {
- $secrethash{'old'.$name.'secret'} = $oldsecret;
- }
- my $putres = &Apache::lonnet::put('exttool_'.$marker,
- \%secrethash,$cdom,$cnum);
- my $delresult = &release_tool_lock($cdom,$cnum,$marker);
- if ($delresult ne 'ok') {
- $warning = $delresult ;
- }
- if ($putres eq 'ok') {
- return 'ok';
- }
- } else {
- $warning = ''.
- &mt('Could not obtain exclusive lock').
- '';
- }
- } else {
- $toolhash->{$name.'secret'} = $toolsettings->{$name.'secret'};
- return 'ok';
- }
- return;
-}
-
sub lti_params {
my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_;
my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,
@@ -319,18 +274,16 @@ sub lti_params {
$ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback';
$ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'};
if ($gradesecret) {
- my $result_sig =
- Digest::SHA::sha1_hex($gradesecret.':::'.$digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'});
- $ltiparams{'lis_result_sourcedid'} =
- $result_sig.':::'.$digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};
+ my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};
+ $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_unique_callback($gradesecret,$uniqid);
}
}
if ($roster) {
if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
$ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/roster';
if ($rostersecret) {
- my $roster_sig = Digest::SHA::sha1_hex($rostersecret.':::'.$digest_symb.':::'.$env{'request.course.id'});
- $ltiparams{'ext_ims_lis_memberships_id'} = $roster_sig.':::'.$digest_symb.':::'.$env{'request.course.id'};
+ my $uniqid = $digest_symb.':::'.$env{'request.course.id'};
+ $ltiparams{'ext_ims_lis_memberships_id'} = &LONCAPA::ltiutils::get_unique_callback($rostersecret,$uniqid);
}
}
}
@@ -405,7 +358,7 @@ sub lti_params {
sub launch_html {
my ($url,$key,$secret,$submittext,$paramsref) = @_;
- my $hashref = &sign_params($url,$key,$secret,$paramsref);
+ my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$paramsref);
my $action = &HTML::Entities::encode($url,'<>&"');
my $form = <<"END";
@@ -439,57 +392,4 @@ ENDJS
return $form;
}
-sub sign_params {
- my ($url,$key,$secret,$paramsref) = @_;
- my $nonce = Digest::SHA::sha1_hex(sprintf("%06x%06x",rand(0xfffff0),rand(0xfffff0)));
-
- my $request = Net::OAuth->request("request token")->new(
- consumer_key => $key,
- consumer_secret => $secret,
- request_url => $url,
- request_method => 'POST',
- signature_method => 'HMAC-SHA1',
- timestamp => time,
- nonce => $nonce,
- callback => 'about:blank',
- extra_params => $paramsref,
- version => '1.0',
- );
- $request->sign;
- return $request->to_hash();
-}
-
-sub get_tool_lock {
- my ($cdom,$cnum,$marker,$now) = @_;
- # get lock for tool for which gradesecret is being set
- my $lockhash = {
- $marker."\0".'lock' => $now.':'.$env{'user.name'}.
- ':'.$env{'user.domain'},
- };
- my $tries = 0;
- my $gotlock = &Apache::lonnet::newput('exttools',$lockhash,$cdom,$cnum);
-
- while (($gotlock ne 'ok') && $tries <3) {
- $tries ++;
- sleep(1);
- $gotlock = &Apache::lonnet::newput('exttools',$lockhash,$cdom,$cnum);
- }
- return $gotlock;
-}
-
-sub release_tool_lock {
- my ($cdom,$cnum,$marker) = @_;
- # remove lock
- my @del_lock = ($marker."\0".'lock');
- my $dellockoutcome=&Apache::lonnet::del('exttools',\@del_lock,$cdom,$cnum);
- if ($dellockoutcome ne 'ok') {
- return (''
- .&mt('Warning: failed to release lock for exttool: [_1].',''.$marker.'')
- .'
'
- );
- } else {
- return 'ok';
- }
-}
-
1;