lib.php 40.4 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20
 *
 * @package    mahara
 * @subpackage auth
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
25
26
 *
 */

27
28
defined('INTERNAL') || die();

29
function xmlrpc_exception (Exception $e) {
Donal McMullan's avatar
Donal McMullan committed
30
31
32
33
34
35
    if (($e instanceof XmlrpcServerException) && get_class($e) == 'XmlrpcServerException') {
        $e->handle_exception();
        return;
    } elseif (($e instanceof MaharaException) && get_class($e) == 'MaharaException') {
        throw new XmlrpcServerException($e->getMessage(), $e->getCode());
        return;
36
    }
Donal McMullan's avatar
Donal McMullan committed
37
38
    xmlrpc_error('An unexpected error has occurred: '.$e->getMessage(), $e->getCode());
    log_message($e->getMessage(), LOG_LEVEL_WARN, true, true, $e->getFile(), $e->getLine(), $e->getTrace());
39
40
}

41
function get_hostname_from_uri($uri = null) {
42
43
44
45
    static $cache = array();
    if (array_key_exists($uri, $cache)) {
        return $cache[$uri];
    }
46
    $count = preg_match("@^(?:http[s]?://)?([A-Z0-9\-\.]+).*@i", $uri, $matches);
47
    $cache[$uri] = $matches[1];
48
49
50
51
52
53
54
55
56
57
58
    if ($count > 0) return $matches[1];
    return false;
}

function dropslash($wwwroot) {
    if (substr($wwwroot, -1, 1) == '/') {
        return substr($wwwroot, 0, -1);
    }
    return $wwwroot;
}

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
function generate_token() {
    return sha1(str_shuffle('' . mt_rand(999999,99999999) . microtime(true)));
}

function start_jump_session($peer, $instanceid, $wantsurl="") {
    global $USER;

    $rpc_negotiation_timeout = 15;
    $providers = get_service_providers($USER->authinstance);

    $approved = false;
    foreach ($providers as $provider) {
        if ($provider['wwwroot'] == $peer->wwwroot) {
            $approved = true;
            break;
        }
    }

    if (false == $approved) {
Donal McMullan's avatar
Donal McMullan committed
78
79
        // This shouldn't happen: the user shouldn't have been presented with 
        // the link
80
        throw new AccessTotallyDeniedException('Host not approved for sso');
81
82
83
84
    }

    // set up the session
    $sso_session = get_record('sso_session',
85
                              'userid',     $USER->id);
86
87
88
89
90
91
92
93
94
95
96
    if ($sso_session == false) {
        $sso_session = new stdClass();
        $sso_session->instanceid = $instanceid;
        $sso_session->userid = $USER->id;
        $sso_session->username = $USER->username;
        $sso_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
        $sso_session->token = generate_token();
        $sso_session->confirmtimeout = time() + $rpc_negotiation_timeout;
        $sso_session->expires = time() + (integer)ini_get('session.gc_maxlifetime');
        $sso_session->sessionid = session_id();
        if (! insert_record('sso_session', $sso_session)) {
Donal McMullan's avatar
Donal McMullan committed
97
            throw new SQLException("database error");
98
99
100
101
        }
    } else {
        $sso_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
        $sso_session->token = generate_token();
102
        $sso_session->instanceid = $instanceid;
103
104
        $sso_session->confirmtimeout = time() + $rpc_negotiation_timeout;
        $sso_session->expires = time() + (integer)ini_get('session.gc_maxlifetime');
105
        $sso_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
106
107
        $sso_session->sessionid = session_id();
        if (false == update_record('sso_session', $sso_session, array('userid' => $USER->id))) {
Donal McMullan's avatar
Donal McMullan committed
108
            throw new SQLException("database error");
109
110
111
        }
    }

112
    $wwwroot = dropslash(get_config('wwwroot'));
113
114
115
116
117
118
119

    // construct the redirection URL
    $url = "{$peer->wwwroot}{$peer->application->ssolandurl}?token={$sso_session->token}&idp={$wwwroot}&wantsurl={$wantsurl}";

    return $url;
}

120
function api_dummy_method($methodname, $argsarray, $functionname) {
121
122
123
    return call_user_func_array($functionname, $argsarray);
}

124
125
function find_remote_user($username, $wwwroot) {
    $institution = get_field('host', 'institution', 'wwwroot', $wwwroot);
126
127
128
129
130
131
132

    if (false == $institution) {
        // This should never happen, because if we don't know the host we'll
        // already have exited
        throw new XmlrpcServerException('Unknown error');
    }

133
134
    $authinstances = auth_get_auth_instances_for_institution($institution);
    $candidates    = array();
135
    $auths         = array();
136
137
138
139

    $sql = 'SElECT
                ai.*
            FROM
140
141
142
                {auth_instance} ai,
                {auth_instance} ai2,
                {auth_instance_config} aic
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
            WHERE
                ai.id = ? AND
                ai.institution = ? AND
                ai2.institution = ai.institution AND
                ai.id = aic.value AND
                aic.field = \'parent\' AND
                aic.instance = ai2.id AND
                ai2.authname = \'xmlrpc\'';

    foreach ($authinstances as $authinstance) {
        if ($authinstance->authname != 'xmlrpc') {
            $records = get_records_sql_array($sql, array($authinstance->id, $institution));
            if (false == $records) {
                continue;
            }
        }
        try {
            $user = new User;
161
            $user->find_by_instanceid_username($authinstance->id, $username, true);
162
            $candidates[$user->id] = $user;
163
            $auths[] = $authinstance->id;
164
165
166
        } catch (Exception $e) {
            // we don't care
            continue;
167
        }
168
169
170
171
172
173
    }

    if (count($candidates) != 1) {
        return false;
    }

174
175
    safe_require('auth', 'xmlrpc');
    return array(array_pop($candidates), new AuthXmlrpc(array_pop($auths)));
176
177
178
179
180
}

function fetch_user_image($username) {
    global $REMOTEWWWROOT;

181
182
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
183
184
185
        return false;
    }

186
187
    $ic = $user->profileicon;
    if (!empty($ic)) {
188
        $filename = get_config('dataroot') . 'artefact/file/profileicons/' . ($user->profileicon % 256) . '/'.$user->profileicon;
189
190
191
192
193
194
195
196
197
198
        $return = array();
        try {
            $fi = file_get_contents($filename);
        } catch (Exception $e) {
            // meh
        }

        $return['f1'] = base64_encode($fi);

        require_once('file.php');
199
        $im = get_dataroot_image_path('artefact/file/profileicons' , $user->profileicon, 100);
200
201
202
203
        $fi = file_get_contents($im);
        $return['f2'] = base64_encode($fi);
        return $return;
    } else {
204
        // no icon
205
206
207
    }
}

208
function user_authorise($token, $useragent) {
209
    global $USER;
210
211
212

    $sso_session = get_record('sso_session', 'token', $token, 'useragent', $useragent);
    if (empty($sso_session)) {
Donal McMullan's avatar
Donal McMullan committed
213
        throw new XmlrpcServerException('No such session exists');
214
215
216
217
    }

    // check session confirm timeout
    if ($sso_session->expires < time()) {
Donal McMullan's avatar
Donal McMullan committed
218
        throw new XmlrpcServerException('This session has timed out');
219
220
221
222
223
224
225
    }

    // session okay, try getting the user
    $user = new User();
    try {
        $user->find_by_id($sso_session->userid);
    } catch (Exception $e) {
Donal McMullan's avatar
Donal McMullan committed
226
        throw new XmlrpcServerException('Unable to get information for the specified user');
227
228
    }

229
230
    require(get_config('docroot') . 'artefact/lib.php');
    require(get_config('docroot') . 'artefact/internal/lib.php');
231
232
233
234
235
236
237

    $element_list = call_static_method('ArtefactTypeProfile', 'get_all_fields');
    $element_required = call_static_method('ArtefactTypeProfile', 'get_mandatory_fields');

    // load existing profile information
    $profilefields = array();
    $profile_data = get_records_select_assoc('artefact', "owner=? AND artefacttype IN (" . join(",",array_map(create_function('$a','return db_quote($a);'),array_keys($element_list))) . ")", array($USER->get('id')), '','artefacttype, title');
238
239
240
    if ($profile_data == false) {
        $profile_data = array();
    }
241
242

    $email = get_field('artefact_internal_profile_email', 'email', 'owner', $sso_session->userid, 'principal', 1);
243
    if (false == $email) {
Donal McMullan's avatar
Donal McMullan committed
244
        throw new XmlrpcServerException("No email adress for user");
245
246
247
248
    }

    $userdata = array();
    $userdata['username']                = $user->username;
249
    $userdata['email']                   = $email;
250
251
252
253
254
    $userdata['auth']                    = 'mnet';
    $userdata['confirmed']               = 1;
    $userdata['deleted']                 = 0;
    $userdata['firstname']               = $user->firstname;
    $userdata['lastname']                = $user->lastname;
255
256
    $userdata['city']                    = array_key_exists('city', $profile_data) ? $profile_data['city']->title : '';
    $userdata['country']                 = array_key_exists('country', $profile_data) ? $profile_data['country']->title : '';
257

258
    if (is_numeric($user->profileicon)) {
259
        $filename = get_config('dataroot') . 'artefact/file/profileicons/' . ($user->profileicon % 256) . '/'.$user->profileicon;
260
        if (file_exists($filename) && is_readable($filename)) {
261
            $userdata['imagehash'] = sha1_file($filename);
262
263
264
265
266
267
268
269
270
271
272
        }
    }

    get_service_providers($USER->authinstance);

    // Todo: push application name to list of hosts... update Moodle block to display more info, maybe in 'Other' list
    $userdata['myhosts'] = array();

    return $userdata;
}

273
274
function send_content_intent($username) {
    global $REMOTEWWWROOT;
275
    require_once(get_config('docroot') . 'import/lib.php');
276

277
278
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
279
        throw new ImportException("Could not find user $username for $REMOTEWWWROOT");
280
281
    }

282
283
284
    if (!is_executable(get_config('pathtounzip'))) {
        throw new ImportException("Cannot find unzip executable");
    }
285

286
    if (!$authinstance->weimportcontent) {
287
288
289
        $e = new ImportException('Importing content is disabled');
        $e->set_log_off(); // we don't want these ones.
        throw $e;
290
291
    }

292
    $queue = PluginImport::create_new_queue($user->id, null, $REMOTEWWWROOT, 0);
293
294

    return array(
295
        'sendtype' => (($queue->queue) ? 'queue' : 'immediate'),
296
297
298
299
        'token' => $queue->token,
    );
}

300
function send_content_ready($token, $username, $format, $importdata, $fetchnow=false) {
301
    global $REMOTEWWWROOT;
302
    require_once(get_config('docroot') . 'import/lib.php');
303

304
305
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
306
307
308
309
310
        throw new ImportException("Could not find user $username for $REMOTEWWWROOT");
    }

    // go verify the token
    if (!$queue = get_record('import_queue', 'token', $token, 'host', $REMOTEWWWROOT)) {
311
        throw new ImportException("Could not find queue record with given token for username $username for $REMOTEWWWROOT");
312
313
314
315
316
317
318
    }

    if (strtotime($queue->expirytime) < time()) {
        throw new ImportException("Queue record has expired");
    }

    $queue->format = $format;
319
320
    $class = null;
    try {
321
        $class = PluginImport::class_from_format($format);
322
323
324
325
326
327
328
329
330
    } catch (Exception $e) {
        throw new ImportException('Invalid format $format');
    }
    try {
        call_static_method($class, 'validate_import_data', $importdata);
    } catch (Exception $e) {
        throw new ImportException('Invalid importdata: ' . $e->getMessage());
    }

331
332
333
334
335
336
337
338
339
340
    if (!array_key_exists('totalsize', $importdata)) {
        throw new ImportException('Invalid importdata: missing totalsize');
    }

    if (!$user->quota_allowed($importdata['totalsize'])) {
        $e = new ImportException('Exceeded user quota');
        $e->set_log_off();
        throw $e;
    }

341
    $queue->data = serialize($importdata);
342
343
344
345

    update_record('import_queue', $queue);

    $result = new StdClass;
346
    if ($fetchnow && PluginImport::import_immediately_allowed()) {
347
        // either immediately spawn a curl request to go fetch the file
348
        $importer = PluginImport::create_importer($queue->id, $queue);
349
350
        $importer->prepare();
        $importer->process();
351
        $importer->cleanup();
352
        delete_records('import_queue', 'id', $queue->id);
353
354
        $result->status = true;
        $result->type = 'complete';
355
356
357
358
359
        $returndata = $importer->get_return_data();
        $result->querystring = '?';
        foreach ($importer->get_return_data() as $k => $v) {
            $result->querystring .= $k . '=' . $v . '&';
        }
360
361
362
363
364
    } else {
        // or set ready to 1 for the next cronjob to go fetch it.
        $result->status = set_field('import_queue', 'ready', 1, 'id', $queue->id);
        $result->type = 'queued';
    }
365
    $importer->get('importertransport')->cleanup();
366
367
368
    return $result;
}

369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
/**
 * If we're an IDP, kill_children will kill the session of the given user here, 
 * as well as at any other children
 *
 * NOTE: well, currently it doesn't call kill_child on any other children, but 
 * it will kill the local sessions for the user
 *
 * @param   string  $username       Username for session to kill
 * @param   string  $useragent      SHA1 hash of user agent to look for
 * @return  string                  A plaintext report of what has happened
 */
function kill_children($username, $useragent) {
    global $REMOTEWWWROOT; // comes from server.php
    //require_once(get_config('docroot') .'api/xmlrpc/client.php');

    // We've received a logout request for user X. In Mahara, usernames are unique. So we check that user X 
    // has an authinstance that would have been able to SSO to the remote site.
    $userid = get_field('usr', 'id', 'username', $username);
    $providers = get_service_providers(get_field('usr', 'authinstance', 'username', $username));

    $approved = false;
    foreach ($providers as $provider) {
        if ($provider['wwwroot'] == $REMOTEWWWROOT) {
            $approved = true;
            break;
        }
    }

    if (false == $approved) {
        return 'This host is not permitted to kill sessions for this username';
    }

    $mnetsessions = get_records_select_array('sso_session', 'userid = ? AND useragent = ?', array($userid, $useragent));

    // Prepare to destroy local sessions associated with the user
    $start = ob_start();
    $uc = ini_get('session.use_cookies');
    ini_set('session.use_cookies', false);
    $sesscache = isset($_SESSION) ? clone($_SESSION) : null;
    $sessidcache = session_id();
    session_write_close();
    unset($_SESSION);

    foreach($mnetsessions as $mnetsession) {
        // Kills all local sessions associated with this user
        // TODO: We should send kill_child requests to the remote servers too
        session_id($mnetsession->sessionid);
        session_start();
        session_unregister("USER");
        session_unregister("SESSION");
        unset($_SESSION);
        $_SESSION = array();
        session_destroy();
        session_write_close();
    }

    // We're done destroying local sessions
    ini_set('session.use_cookies', $uc);
    if ($sessidcache) {
        session_name(get_config('cookieprefix') . 'mahara');
        session_id($sessidcache);
        session_start();
        $_SESSION = ($sesscache) ? clone($sesscache) : null;
        session_write_close();
    }
    $end = ob_end_clean();

    delete_records('sso_session',
                   'useragent', $useragent,
                   'userid',    $userid);

    return true;
}

443
444
445
446
function xmlrpc_not_implemented() {
    return true;
}

447
448
449
450
451
452
453
/**
 * Given a USER, get all Service Providers for that User, based on child auth
 * instances of its canonical auth instance
 */
function get_service_providers($instance) {
    static $cache = array();

454
455
456
457
    if (defined('INSTALLER')) {
        return array();
    }

458
459
460
461
    if (array_key_exists($instance, $cache)) {
        return $cache[$instance];
    }

462
    $query = "
463
464
465
466
467
468
        SELECT
            h.name,
            a.ssolandurl,
            h.wwwroot,
            aic.instance
        FROM
469
470
471
472
473
            {auth_instance_config} aic,
            {auth_instance_config} aic2,
            {auth_instance_config} aic3,
            {host} h,
            {application} a
474
        WHERE
475
476
          ((aic.value = '1' AND
            aic.field = 'theyautocreateusers' ) OR
477
           (aic.value = ?  AND
478
            aic.field = 'parent')) AND
479
480

            aic.instance = aic2.instance AND
481
            aic2.field = 'wwwroot' AND
482
483
484
            aic2.value = h.wwwroot AND

            aic.instance = aic3.instance AND
485
486
            aic3.field = 'wessoout' AND
            aic3.value = '1' AND
487

488
            a.name = h.appname";
489
490
491
492
493
494
    try {
        $results = get_records_sql_assoc($query, array('value' => $instance));
    } catch (SQLException $e) {
        // Table doesn't exist yet
        return array();
    }
495
496
497
498
499
500
501
502
503
504
505
506
507

    if (false == $results) {
        $results = array();
    }

    foreach($results as $key => $result) {
        $results[$key] = get_object_vars($result);
    }

    $cache[$instance] = $results;
    return $cache[$instance];
}

508
function get_public_key($uri, $application=null) {
509

510
511
512
513
514
515
516
    static $keyarray = array();
    if (isset($keyarray[$uri])) {
        return $keyarray[$uri];
    }

    $openssl = OpenSslRepo::singleton();

517
    if (empty($application)) {
518
        $application = 'moodle';
519
    }
520

521
    $xmlrpcserverurl = get_field('application', 'xmlrpcserverurl', 'name', $application);
522
523
524
    if (empty($xmlrpcserverurl)) {
        throw new XmlrpcClientException('Unknown application');
    } 
525
    $wwwroot = dropslash(get_config('wwwroot'));
526

527
    $rq = xmlrpc_encode_request('system/keyswap', array($wwwroot, $openssl->certificate), array("encoding" => "utf-8"));
528

529
530
531
532
533
534
535
536
    $config = array(
        CURLOPT_URL => $uri . $xmlrpcserverurl,
        CURLOPT_POST => true,
        CURLOPT_USERAGENT => 'Moodle',
        CURLOPT_POSTFIELDS => $rq,
        CURLOPT_HTTPHEADER => array("Content-Type: text/xml charset=UTF-8", 'Expect: '),
    );

537
    $result = mahara_http_request($config);
538

539
    if (empty($result->data)) {
540
541
        throw new XmlrpcClientException('CURL connection failed');
    }
542

543
    $response_code        = $result->info['http_code'];
544
545
546
547
548
    $response_code_prefix = substr($response_code, 0, 1);

    if ('2' != $response_code_prefix) {
        if ('4' == $response_code_prefix) {
            throw new XmlrpcClientException('Client error code: ', $response_code);
549
        } elseif ('5' == $response_code_prefix) {
550
551
552
553
            throw new XmlrpcClientException('An error occurred at the remote server. Code: ', $response_code);
        }
    }

554
    $res = xmlrpc_decode($result->data);
555

556
557
558
    // XMLRPC error messages are returned as an array
    // We are expecting a string
    if (!is_array($res)) {
559
560
561
562
563
564
565
566
567
        $keyarray[$uri] = $res;
        $credentials=array();
        if (strlen(trim($keyarray[$uri]))) {
            $credentials = openssl_x509_parse($keyarray[$uri]);
            $host = $credentials['subject']['CN'];
            if (strpos($uri, $host) !== false) {
                return $keyarray[$uri];
            }
        }
568
569
    } else {
        throw new XmlrpcClientException($res['faultString'], $res['faultCode']);
570
571
572
573
    }
    return false;
}

574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
/**
 * Output a valid XML-RPC error message.
 *
 * @param  string   $message              The error message
 * @param  int      $code                 Unique identifying integer
 * @return string                         An XMLRPC error doc
 */
function xmlrpc_error($message, $code) {
    echo <<<EOF
<?xml version="1.0"?>
<methodResponse>
   <fault>
      <value>
         <struct>
            <member>
               <name>faultCode</name>
               <value><int>$code</int></value>
            </member>
            <member>
               <name>faultString</name>
               <value><string>$message</string></value>
            </member>
         </struct>
      </value>
   </fault>
</methodResponse>
EOF;
}

603
function xmlenc_envelope_strip(&$xml, $oldkeyok=false) {
604
605
606
607
608
    $openssl           = OpenSslRepo::singleton();
    $payload_encrypted = true;
    $data              = base64_decode($xml->EncryptedData->CipherData->CipherValue);
    $key               = base64_decode($xml->EncryptedKey->CipherData->CipherValue);
    $payload           = '';    // Initialize payload var
609
    $payload           = $openssl->openssl_open($data, $key, $oldkeyok);
610
611
612
613
614
615
616
617
618
    $xml               = parse_payload($payload);
    return $payload;
}

function parse_payload($payload) {
    try {
        $xml = new SimpleXMLElement($payload);
        return $xml;
    } catch (Exception $e) {
Donal McMullan's avatar
Donal McMullan committed
619
        throw new MaharaException('Encrypted payload is not a valid XML document', 6002);
620
621
622
    }
}

623
function get_peer($wwwroot, $cache=true) {
624

625
626
    $wwwroot = (string)$wwwroot;
    static $peers = array();
627
628
629
    if ($cache) {
        if (isset($peers[$wwwroot])) return $peers[$wwwroot];
    }
630

631
    require_once(get_config('libroot') . 'peer.php');
632
    $peer = new Peer();
633

634
    if (!$peer->findByWwwroot($wwwroot)) {
635
        // Bootstrap unknown hosts?
636
        throw new MaharaException("We don't have a record for your webserver ($wwwroot) in our database", 6003);
637
638
639
640
641
    }
    $peers[$wwwroot] = $peer;
    return $peers[$wwwroot];
}

642
643
644
/**
 * Check that the signature has been signed by the remote host.
 */
645
function xmldsig_envelope_strip(&$xml) {
646

647
648
649
650
651
652
    $signature      = base64_decode($xml->Signature->SignatureValue);
    $payload        = base64_decode($xml->object);
    $wwwroot        = (string)$xml->wwwroot;
    $timestamp      = $xml->timestamp;
    $peer           = get_peer($wwwroot);

653

654
655
656
657
658
659
660
661
662
    // Does the signature match the data and the public cert?
    $signature_verified = openssl_verify($payload, $signature, $peer->certificate);

    if ($signature_verified == 1) {
        // Parse the XML
        try {
            $xml = new SimpleXMLElement($payload);
            return $payload;
        } catch (Exception $e) {
Donal McMullan's avatar
Donal McMullan committed
663
            throw new MaharaException('Signed payload is not a valid XML document', 6007);
664
665
        }
    }
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
    else if ($signature_verified == 0) {
        // Maybe the remote host is using a new key?
        //$new_public_key = get_public_key($wwwroot, $peer->application->name);
        // Make a dummy request so we'll be given a new key
        log_info("Signature verification for message from $wwwroot failed, checking to see if they have a new signature for us");
        require_once(get_config('docroot') . 'api/xmlrpc/client.php');
        $client = new Client();
        $client->set_method('system/listServices')
               ->send($wwwroot);

        // Now use the new key and re-try verification
        $peer = get_peer($wwwroot, false);
        $signature_verified = openssl_verify($payload, $signature, $peer->certificate);
        if ($signature_verified == 1) {
            log_info("Succefully retrieved a new key for $wwwroot");
            // Parse the XML
            try {
                $xml = new SimpleXMLElement($payload);
                return $payload;
            } catch (Exception $e) {
                throw new MaharaException('Signed payload is not a valid XML document', 6007);
            }
        }
    }

    throw new MaharaException('An error occurred while trying to verify your message signature', 6004);
692
693
}

694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
/**
 * Encrypt a message and return it in an XML-Encrypted document
 *
 * This function can encrypt any content, but it was written to provide a system
 * of encrypting XML-RPC request and response messages. The message does not 
 * need to be text - binary data should work.
 * 
 * Asymmetric keys can encrypt only small chunks of data. Usually 1023 or 2047 
 * characters, depending on the key size. So - we generate a symmetric key and 
 * use the asymmetric key to secure it for transport with the data.
 *
 * We generate a symmetric key
 * We encrypt the symmetric key with the public key of the remote host
 * We encrypt our content with the symmetric key
 * We base64 the key & message data.
 * We identify our wwwroot - this must match our certificate's CN
 *
 * Normally, the XML-RPC document will be parceled inside an XML-SIG envelope.
 * We parcel the XML-SIG document inside an XML-ENC envelope.
 *
 * See the {@Link http://www.w3.org/TR/xmlenc-core/ XML-ENC spec} at the W3c
 * site
 *
 * @param  string   $message              The data you want to sign
 * @param  string   $remote_certificate   Peer's certificate in PEM format
 * @return string                         An XML-ENC document
 */
function xmlenc_envelope($message, $remote_certificate) {

    // Generate a key resource from the remote_certificate text string
    $publickey = openssl_get_publickey($remote_certificate);

    if ( gettype($publickey) != 'resource' ) {
        // Remote certificate is faulty.
Donal McMullan's avatar
Donal McMullan committed
728
        throw new MaharaException('Could not generate public key resource from certificate', 1);
729
730
731
    }

    // Initialize vars
732
    $wwwroot = dropslash(get_config('wwwroot'));
733
734
735
736
737
738
739
    $encryptedstring = '';
    $symmetric_keys = array();

    //      passed by ref ->      &$encryptedstring &$symmetric_keys
    $bool = openssl_seal($message, $encryptedstring, $symmetric_keys, array($publickey));
    $message = base64_encode($encryptedstring);
    $symmetrickey = base64_encode(array_pop($symmetric_keys));
740
    $zed = 'nothing';
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767

    return <<<EOF
<?xml version="1.0" encoding="iso-8859-1"?>
    <encryptedMessage>
        <EncryptedData Id="ED" xmlns="http://www.w3.org/2001/04/xmlenc#">
            <EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#arcfour"/>
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:RetrievalMethod URI="#EK" Type="http://www.w3.org/2001/04/xmlenc#EncryptedKey"/>
                <ds:KeyName>XMLENC</ds:KeyName>
            </ds:KeyInfo>
            <CipherData>
                <CipherValue>$message</CipherValue>
            </CipherData>
        </EncryptedData>
        <EncryptedKey Id="EK" xmlns="http://www.w3.org/2001/04/xmlenc#">
            <EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5"/>
            <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
                <ds:KeyName>SSLKEY</ds:KeyName>
            </ds:KeyInfo>
            <CipherData>
                <CipherValue>$symmetrickey</CipherValue>
            </CipherData>
            <ReferenceList>
                <DataReference URI="#ED"/>
            </ReferenceList>
            <CarriedKeyName>XMLENC</CarriedKeyName>
        </EncryptedKey>
768
        <wwwroot>{$wwwroot}</wwwroot>
769
        <X1>$zed</X1>
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
    </encryptedMessage>
EOF;
}

/**
 * Sign a message and return it in an XML-Signature document
 *
 * This function can sign any content, but it was written to provide a system of
 * signing XML-RPC request and response messages. The message will be base64
 * encoded, so it does not need to be text.
 *
 * We compute the SHA1 digest of the message.
 * We compute a signature on that digest with our private key.
 * We link to the public key that can be used to verify our signature.
 * We base64 the message data.
 * We identify our wwwroot - this must match our certificate's CN
 *
 * The XML-RPC document will be parceled inside an XML-SIG document, which holds
 * the base64_encoded XML as an object, the SHA1 digest of that document, and a
 * signature of that document using the local private key. This signature will
 * uniquely identify the RPC document as having come from this server.
 *
 * See the {@Link http://www.w3.org/TR/xmldsig-core/ XML-DSig spec} at the W3c
 * site
 *
 * @param  string   $message              The data you want to sign
 * @return string                         An XML-DSig document
 */
function xmldsig_envelope($message) {
799

800
    $openssl = OpenSslRepo::singleton();
801
    $wwwroot = dropslash(get_config('wwwroot'));
802
    $digest = sha1($message);
803

804
    $sig = base64_encode($openssl->sign_message($message));
805
806
    $message = base64_encode($message);
    $time = time();
807
    // TODO: Provide RESTful access to our public key as per KeyInfo element
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822

return <<<EOF
<?xml version="1.0" encoding="iso-8859-1"?>
    <signedMessage>
        <Signature Id="MoodleSignature" xmlns="http://www.w3.org/2000/09/xmldsig#">
            <SignedInfo>
                <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
                <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#dsa-sha1"/>
                <Reference URI="#XMLRPC-MSG">
                    <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
                    <DigestValue>$digest</DigestValue>
                </Reference>
            </SignedInfo>
            <SignatureValue>$sig</SignatureValue>
            <KeyInfo>
823
                <RetrievalMethod URI="{$wwwroot}/api/xmlrpc/publickey.php"/>
824
825
826
            </KeyInfo>
        </Signature>
        <object ID="XMLRPC-MSG">$message</object>
827
        <wwwroot>{$wwwroot}</wwwroot>
828
829
830
831
832
833
        <timestamp>$time</timestamp>
    </signedMessage>
EOF;

}

834
835
836
/**
 * Good candidate to be a singleton
 */
837
class OpenSslRepo {
838
839
840

    private $keypair = array();

841
842
843
844
845
846
847
848
    /**
     * Sign a message with our private key so that peers can verify that it came
     * from us.
     *
     * @param  string   $message
     * @return string
     * @access public
     */
849
850
851
852
853
    public function sign_message($message) {
        $signature = '';
        $bool      = openssl_sign($message, $signature, $this->keypair['privatekey']);
        return $signature;
    }
854

855
856
857
858
859
860
861
862
863
    /**
     * Decrypt some data using our private key and an auxiliary symmetric key. 
     * The symmetric key encrypted the data, and then was itself encrypted with
     * our public key.
     * This is because asymmetric keys can only safely be used to encrypt 
     * relatively short messages.
     *
     * @param string   $data
     * @param string   $key
864
865
866
     * @param bool     $oldkeyok If true, we will simply return the data rather 
     *                           than complaining about the key being old (if 
     *                           we could decrypt it with an older key)
867
868
869
     * @return string
     * @access public
     */
870
    public function openssl_open($data, $key, $oldkeyok=false) {
871
872
873
874
875
876
877
        $payload = '';
        $isOpen = openssl_open($data, $payload, $key, $this->keypair['privatekey']);

        if (!empty($isOpen)) {
            return $payload;
        } else {
            // Decryption failed... let's try our archived keys
878
            $openssl_history = $this->get_history();
879
880
881
882
883
            foreach($openssl_history as $keyset) {
                $keyresource = openssl_pkey_get_private($keyset['keypair_PEM']);
                $isOpen      = openssl_open($data, $payload, $key, $keyresource);
                if ($isOpen) {
                    // It's an older code, sir, but it checks out
884
885
886
887
888
889
890
                    if ($oldkeyok) {
                        return $payload;
                    }
                    else {
                        // We notify the remote host that the key has changed
                        throw new CryptException($this->keypair['certificate'], 7025);
                    }
891
892
893
                }
            }
        }
894
        throw new CryptException('We know nothing about the key used to encrypt this message', 7025);
895
896
    }

897
    /**
898
     * Singleton function keeps us from generating multiple instances of this
899
900
901
902
903
     * class
     *
     * @return object   The class instance
     * @access public
     */
904
905
906
907
908
    public static function singleton() {
        //single instance
        static $instance;

        //if we don't have the single instance, create one
909
        if (!isset($instance)) {
910
911
912
913
914
915
916
917
918
919
920
921
922
            $instance = new OpenSslRepo();
        }
        return($instance);
    }

    /**
     * This is a singleton - don't try to create an instance by doing:
     * $openssl = new OpenSslRepo();
     * Instead, use:
     * $openssl = OpenSslRepo::singleton();
     * 
     */
    private function __construct() {
923
        if (empty($this->keypair)) {
924
            $this->get_keypair();
925
926
927
            $this->keypair['privatekey'] = openssl_pkey_get_private($this->keypair['keypair_PEM']);
            $this->keypair['publickey']  = openssl_pkey_get_public($this->keypair['certificate']);
        }
928
        return $this;
929
930
    }

931
932
933
934
935
936
937
    /**
     * Utility function to get old SSL keys from the config table, or create a 
     * blank record if none exists.
     *
     * @return array    Array of keypair hashes
     * @access private
     */
938
939
    private function get_history() {
        $openssl_history = get_field('config', 'value', 'field', 'openssl_history');
940
        if (empty($openssl_history)) {
941
942
943
944
945
946
947
948
949
950
951
            $openssl_history = array();
            $record = new stdClass();
            $record->field = 'openssl_history';
            $record->value = serialize($openssl_history);
            insert_record('config', $record);
        } else {
            $openssl_history = unserialize($openssl_history);
        }
        return $openssl_history;
    }

952
953
954
955
956
957
958
959
    /**
     * Utility function to stash old SSL keys in the config table. It will retain
     * a max of 'openssl_generations' which is itself a value in config.
     *
     * @param  array    Array of keypair hashes
     * @return bool
     * @access private
     */
960
961
    private function save_history($openssl_history) {
        $openssl_generations = get_field('config', 'value', 'field', 'openssl_generations');
962
        if (empty($openssl_generations)) {
963
964
965
            set_config('openssl_generations', 6);
            $openssl_generations = 6;
        }
966
        if (count($openssl_history) > $openssl_generations) {
967
968
969
970
971
            $openssl_history = array_slice($openssl_history, 0, $openssl_generations);
        }
        return set_config('openssl_history', serialize($openssl_history));
    }

972
973
974
975
976
977
978
979
980
    /**
     * The get Overloader will let you pull out the 'certificate' and 'expires'
     * values
     *
     * @param  string    Name of the value you want
     * @return mixed     The value of the thing you asked for or null (if it 
     *                   doesn't exist or is private)
     * @access public
     */
981
    public function __get($name) {
982
983
        if ('certificate' === $name) return $this->keypair['certificate'];
        if ('expires' === $name)     return $this->keypair['expires'];
984
985
        return null;
    }
986

987
988
989
990
991
992
993
994
    /**
     * Get the keypair. If it doesn't exist, create it. If it's out of date, 
     * archive it and create a fresh pair.
     *
     * @param  bool      True if you want to force fresh keys to be generated
     * @return bool     
     * @access private
     */
995
    public function get_keypair($regenerate = null) {
996
997
998
        $this->keypair = array();
        $records       = null;
        
999
1000
1001
1002
1003
        if ($records = get_records_select_menu('config', "field IN ('openssl_keypair', 'openssl_keypair_expires')", 'field', 'field, value')) {
            list($this->keypair['certificate'], $this->keypair['keypair_PEM']) = explode('@@@@@@@@', $records['openssl_keypair']);
            $this->keypair['expires'] = $records['openssl_keypair_expires'];
            if (empty($regenerate) && $this->keypair['expires'] > time()) {
                return true;
1004
1005
1006
            }
        }

1007
1008
1009
1010
1011
        // Save out the old key
        $openssl_history = $this->get_history();
        array_unshift($openssl_history, $this->keypair);
        $this->save_history($openssl_history);

1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
        // Initialize a new set of SSL keys
        $this->keypair = array();
        $this->generate_keypair();

        // A record for the keys
        $keyrecord = new stdClass();
        $keyrecord->field = 'openssl_keypair';
        $keyrecord->value = implode('@@@@@@@@', $this->keypair);

        // A convenience record for the keys' expire time (UNIX timestamp)
        $expiresrecord        = new stdClass();
        $expiresrecord->field = 'openssl_keypair_expires';

        // Getting the expire timestamp is convoluted, but required:
        $credentials = openssl_x509_parse($this->keypair['certificate']);
1027
        if (is_array($credentials) && isset($credentials['validTo_time_t'])) {
1028
1029
1030
1031
            $expiresrecord->value = $credentials['validTo_time_t'];
            $this->keypair['expires'] = $credentials['validTo_time_t'];
        }

1032
        if (empty($records)) {
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
            db_begin();
            insert_record('config', $keyrecord);
            insert_record('config', $expiresrecord);
            db_commit();
        }
        else {
            db_begin();
            update_record('config', $keyrecord,     array('field' => 'openssl_keypair'));
            update_record('config', $expiresrecord, array('field' => 'openssl_keypair_expires'));
            db_commit();
1043
        }
1044
        log_info("New public key has been generated. It expires " . date('Y/m/d h:i:s', $credentials['validTo_time_t']));
1045
        return true;
1046
1047
    }

1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
    /**
     * Generate public/private keys and store in the config table
     *
     * Use the distinguished name provided to create a CSR, and then sign that CSR
     * with the same credentials. Store the keypair you create in the config table.
     * If a distinguished name is not provided, create one using the fullname of
     * 'the course with ID 1' as your organization name, and your hostname (as
     * detailed in $CFG->wwwroot).
     *
     * @param   array  $dn  The distinguished name of the server
     * @return  string      The signature over that text
     */
1060
    private function generate_keypair() {
1061
        $host = get_hostname_from_uri(get_config('wwwroot'));
1062
1063
1064
1065
1066
1067
1068
1069
1070

        $organization = get_config('sitename');
        $email        = get_config('noreplyaddress');
        $country      = get_config('country');
        $province     = get_config('province');
        $locality     = get_config('locality');

        //TODO: Create additional fields on site setup and read those from 
        //      config. Then remove the next 3 linez
1071
1072
1073
        if (empty($country))  $country  = 'NZ';
        if (empty($province)) $province = 'Wellington';
        if (empty($locality)) $locality = 'Te Aro';
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087

        $dn = array(
           "countryName" => $country,
           "stateOrProvinceName" => $province,
           "localityName" => $locality,
           "organizationName" => $organization,
           "organizationalUnitName" => 'Mahara',
           "commonName" => get_config('wwwroot'),
           "emailAddress" => $email
        );

        // ensure we remove trailing slashes
        $dn["commonName"] = preg_replace(':/$:', '', $dn["commonName"]);

1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
        if (!$new_key = openssl_pkey_new()) {
            throw new ConfigException('Could not generate a new SSL key. Are '
                . 'you sure that both openssl and the PHP module for openssl are '
                . 'installed on this machine?');
        }

        if (!$csr_rsc = openssl_csr_new($dn, $new_key, array('private_key_bits',2048))) {
            // This behaviour has been observed once before, on an ubuntu hardy box. 
            // The php5-openssl package was installed but somehow openssl 
            // wasn't.
            throw new ConfigException('Could not generate a new SSL key. Are '
                . 'you sure that both openssl and the PHP module for openssl are '
                . 'installed on this machine?');
        }
1102
        $selfSignedCert = openssl_csr_sign($csr_rsc, null, $new_key, 365 /*days*/);
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
        unset($csr_rsc); // Free up the resource

        // We export our self-signed certificate to a string.
        openssl_x509_export($selfSignedCert, $this->keypair['certificate']);
        openssl_x509_free($selfSignedCert);

        // Export your public/private key pair as a PEM encoded string. You
        // can protect it with an optional passphrase if you wish.
        $export = openssl_pkey_export($new_key, $this->keypair['keypair_PEM'] /* , $passphrase */);
        openssl_pkey_free($new_key);
        unset($new_key); // Free up the resource

        return $this;
    }
1117
1118
1119
}

class PublicKey {
1120

1121
1122
1123
    private   $credentials = array();
    private   $wwwroot     = '';
    private   $certificate = '';
1124
1125

    function __construct($keystring, $wwwroot) {
1126

1127
1128
1129
1130
1131
        $this->credentials = openssl_x509_parse($keystring);
        $this->wwwroot     = dropslash($wwwroot);
        $this->certificate = $keystring;

        if ($this->credentials == false) {
1132
            throw new CryptException(get_string('errornotvalidsslcertificate', 'auth'), 1);
1133
            return false;
1134
        } elseif ($this->credentials['subject']['CN'] != $this->wwwroot) {
1135
            throw new CryptException(get_string('errorcertificateinvalidwwwroot', 'auth', $this->credentials['subject']['CN'], $this->wwwroot), 1);
1136
1137
            return false;
        } else {
1138
            return $this->credentials;
1139
1140
1141
        }
    }

1142
    function __get($name) {
1143
        if ('expires' == $name) return $this->credentials['validTo_time_t'];
1144
        return $this->{$name};
1145
1146
1147
    }
}
?>