lib.php 54 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
 *
Francois Marier's avatar
Francois Marier committed
7
8
9
10
 * 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.
11
 *
Francois Marier's avatar
Francois Marier committed
12
13
14
15
 * 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.
16
 *
Francois Marier's avatar
Francois Marier committed
17
18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
20
21
 *
 * @package    mahara
 * @subpackage auth
22
 * @author     Catalyst IT Ltd
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25
26
27
 *
 */

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

30
function xmlrpc_exception (Exception $e) {
Donal McMullan's avatar
Donal McMullan committed
31
32
33
34
35
36
    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;
37
    }
Donal McMullan's avatar
Donal McMullan committed
38
39
    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());
40
41
}

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

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

60
61
62
63
64
65
66
function generate_token() {
    return sha1(str_shuffle('' . mt_rand(999999,99999999) . microtime(true)));
}

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

67
68
69
70
71
    if ($USER->get('parentuser')) {
        // Prevent masquerading users from jumping
        throw new AccessTotallyDeniedException(get_string('cannotjumpasmasqueradeduser', 'auth'));
    }

72
73
74
75
76
77
78
79
80
81
82
83
    $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
84
85
        // This shouldn't happen: the user shouldn't have been presented with 
        // the link
86
        throw new AccessTotallyDeniedException('Host not approved for sso');
87
88
89
90
    }

    // set up the session
    $sso_session = get_record('sso_session',
91
                              'userid',     $USER->id);
92
93
94
95
96
97
98
99
100
101
102
    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
103
            throw new SQLException("database error");
104
105
106
107
        }
    } else {
        $sso_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
        $sso_session->token = generate_token();
108
        $sso_session->instanceid = $instanceid;
109
110
        $sso_session->confirmtimeout = time() + $rpc_negotiation_timeout;
        $sso_session->expires = time() + (integer)ini_get('session.gc_maxlifetime');
111
        $sso_session->useragent = sha1($_SERVER['HTTP_USER_AGENT']);
112
113
        $sso_session->sessionid = session_id();
        if (false == update_record('sso_session', $sso_session, array('userid' => $USER->id))) {
Donal McMullan's avatar
Donal McMullan committed
114
            throw new SQLException("database error");
115
116
117
        }
    }

118
    $wwwroot = dropslash(get_config('wwwroot'));
119
120
121
122
123
124
125

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

    return $url;
}

126
function api_dummy_method($methodname, $argsarray, $functionname) {
127
128
129
    return call_user_func_array($functionname, $argsarray);
}

130
function find_remote_user($username, $wwwroot) {
131
    $authinstances = auth_get_auth_instances_for_wwwroot($wwwroot);
132

133
    $candidates = array();
134
135
136

    foreach ($authinstances as $authinstance) {
        if ($authinstance->authname != 'xmlrpc') {
137
            continue;
138
139
140
        }
        try {
            $user = new User;
141
            $user->find_by_instanceid_username($authinstance->id, $username, true);
142
            $candidates[$authinstance->id] = $user;
143
144
145
        } catch (Exception $e) {
            // we don't care
            continue;
146
        }
147
148
149
150
151
152
    }

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

153
    safe_require('auth', 'xmlrpc');
154
    return array(end($candidates), new AuthXmlrpc(key($candidates)));
155
156
157
158
159
}

function fetch_user_image($username) {
    global $REMOTEWWWROOT;

160
161
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
162
163
164
        return false;
    }

165
166
    $ic = $user->profileicon;
    if (!empty($ic)) {
167
        $filename = get_config('dataroot') . 'artefact/file/profileicons/' . ($user->profileicon % 256) . '/'.$user->profileicon;
168
169
170
171
172
173
174
175
176
177
        $return = array();
        try {
            $fi = file_get_contents($filename);
        } catch (Exception $e) {
            // meh
        }

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

        require_once('file.php');
178
        $im = get_dataroot_image_path('artefact/file/profileicons' , $user->profileicon, 100);
179
180
181
182
        $fi = file_get_contents($im);
        $return['f2'] = base64_encode($fi);
        return $return;
    } else {
183
        // no icon
184
185
186
    }
}

187
function user_authorise($token, $useragent) {
188
    global $USER;
189
190
191

    $sso_session = get_record('sso_session', 'token', $token, 'useragent', $useragent);
    if (empty($sso_session)) {
Donal McMullan's avatar
Donal McMullan committed
192
        throw new XmlrpcServerException('No such session exists');
193
194
195
196
    }

    // check session confirm timeout
    if ($sso_session->expires < time()) {
Donal McMullan's avatar
Donal McMullan committed
197
        throw new XmlrpcServerException('This session has timed out');
198
199
200
201
202
203
204
    }

    // 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
205
        throw new XmlrpcServerException('Unable to get information for the specified user');
206
207
    }

208
209
    require_once(get_config('docroot') . 'artefact/lib.php');
    require_once(get_config('docroot') . 'artefact/internal/lib.php');
210
211
212
213
214
215
216

    $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');
217
218
219
    if ($profile_data == false) {
        $profile_data = array();
    }
220
221

    $email = get_field('artefact_internal_profile_email', 'email', 'owner', $sso_session->userid, 'principal', 1);
222
    if (false == $email) {
Donal McMullan's avatar
Donal McMullan committed
223
        throw new XmlrpcServerException("No email adress for user");
224
225
226
227
    }

    $userdata = array();
    $userdata['username']                = $user->username;
228
    $userdata['email']                   = $email;
229
230
231
232
233
    $userdata['auth']                    = 'mnet';
    $userdata['confirmed']               = 1;
    $userdata['deleted']                 = 0;
    $userdata['firstname']               = $user->firstname;
    $userdata['lastname']                = $user->lastname;
234
235
    $userdata['city']                    = array_key_exists('city', $profile_data) ? $profile_data['city']->title : '';
    $userdata['country']                 = array_key_exists('country', $profile_data) ? $profile_data['country']->title : '';
236

237
    if (is_numeric($user->profileicon)) {
238
        $filename = get_config('dataroot') . 'artefact/file/profileicons/' . ($user->profileicon % 256) . '/'.$user->profileicon;
239
        if (file_exists($filename) && is_readable($filename)) {
240
            $userdata['imagehash'] = sha1_file($filename);
241
242
243
244
245
246
247
248
249
250
251
        }
    }

    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;
}

252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
/**
 * Retrieve a file for a user calling this function
 * The file is encoded in base64
 * @global object $REMOTEWWWROOT
 * @param string $username
 * @param integer $id Artefact to send
 * @return array The file content encoded in base 64 + file name
 */
function get_file($username, $id) {

    global $REMOTEWWWROOT;

    //check that the user exists
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        throw new ExportException("Could not find user $username for $REMOTEWWWROOT");
    }

    //check that the user is owner of the requested file
    safe_require('artefact', 'file');
    $file = artefact_instance_from_id($id);
    if (!record_exists('artefact', 'owner', $user->id, 'id', $id)) {
        throw new ExportException("You are not allowed to get this file.");
    }

    //retrieve the content and send the file encoded in base 64
    $filecontent = base64_encode(file_get_contents($file->get_path()));
    return array($filecontent, $file->name);
}


/**
 * Retrieve list of files/folders matching the search
 * @global object $REMOTEWWWROOT
 * @param string $username
 * @param string $search
 * @return array list of files/folders matching the search
 */
function search_folders_and_files($username, $search='') {

    global $REMOTEWWWROOT;

    //check that the user exists
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        throw new ExportException("Could not find user $username for $REMOTEWWWROOT");
    }

    $list = array();
    safe_require('artefact', 'file');
    $filetypes = array_diff(PluginArtefactFile::get_artefact_types(), array('profileicon'));
    foreach ($filetypes as $k => $v) {
        if ($v == 'folder') {
            unset($filetypes[$k]);
        }
    }
    $filetypesql = "('" . join("','", $filetypes) . "')";

    $ownersql = artefact_owner_sql($user->id);

    //retrieve folders and files of a specific Mahara folder
    $sql = "SELECT
                *
            FROM
                {artefact} a
            LEFT JOIN {artefact_tag} at ON (at.artefact = a.id)
            WHERE
                $ownersql
                AND
                (a.title like ? OR at.tag like ?)";
    $list =  array(

            'files'   => get_records_sql_array($sql." AND artefacttype IN $filetypesql ORDER BY title", array('%'.$search.'%','%'.$search.'%')),
            'folders' => get_records_sql_array($sql." AND artefacttype = 'folder' ORDER BY title", array('%'.$search.'%','%'.$search.'%'))
    );

    return $list;
}

/**
 * Retrieve file list in a folder
 * @global object $REMOTEWWWROOT
 * @param string $username
 * @param integer $folderid  folder to browse
 * @return array The complete folder path + list of files for a specific Mahara folder
 */
function get_folder_files($username, $folderid) {

    global $REMOTEWWWROOT;

    //check that the user exists
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        throw new ExportException("Could not find user $username for $REMOTEWWWROOT");
    }

    $list = array();
    safe_require('artefact', 'file');
    $filetypes = array_diff(PluginArtefactFile::get_artefact_types(), array('profileicon'));
    foreach ($filetypes as $k => $v) {
        if ($v == 'folder') {
            unset($filetypes[$k]);
        }
    }
    $filetypesql = "('" . join("','", $filetypes) . "')";

    $ownersql = artefact_owner_sql($user->id);

    $folderpath = array(); //the complete folder path (some client could need it)
    if (!empty($folderid)) {
        $pathsql = " AND parent = $folderid";

        //build the path
        $parentids = artefact_get_parents_for_cache($folderid); //the closest parent is on the first key
                                                            //the further parent is on the last key
        foreach ($parentids as $id => $dump) {
            $artefact = get_record('artefact', 'id', $id);
            array_unshift($folderpath, array('path' => $artefact->id, 'name' => $artefact->title));
        }

    } else {
        $pathsql = "AND parent IS NULL";
    }
    array_unshift($folderpath, array('path' => null, 'name' => 'Root'));

    //retrieve folders and files of a specific Mahara folder
    $list =  array(
            'files'   => get_records_select_array('artefact', "artefacttype IN $filetypesql AND $ownersql $pathsql", array(),'title'),
            'folders' => get_records_select_array('artefact', "artefacttype = 'folder' AND $ownersql $pathsql", array(),'title')
    );

    return array($folderpath, $list);
}

386
387
function send_content_intent($username) {
    global $REMOTEWWWROOT;
388
    require_once(get_config('docroot') . 'import/lib.php');
389

390
391
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
392
        throw new ImportException(null, "Could not find user $username for $REMOTEWWWROOT");
393
394
    }

395
    if (!is_executable(get_config('pathtounzip'))) {
396
        throw new ImportException(null, "Cannot find unzip executable");
397
    }
398

399
    if (!$authinstance->weimportcontent) {
400
        $e = new ImportException(null, 'Importing content is disabled');
401
402
        $e->set_log_off(); // we don't want these ones.
        throw $e;
403
404
    }

405
    $queue = PluginImport::create_new_queue($user->id, null, $REMOTEWWWROOT, 0);
406
407

    return array(
408
        'sendtype' => (($queue->queue) ? 'queue' : 'immediate'),
409
410
411
412
        'token' => $queue->token,
    );
}

413
function send_content_ready($token, $username, $format, $importdata, $fetchnow=false) {
414
    global $REMOTEWWWROOT;
415
    require_once(get_config('docroot') . 'import/lib.php');
416

417
418
    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
419
        throw new ImportException(null, "Could not find user $username for $REMOTEWWWROOT");
420
421
422
423
    }

    // go verify the token
    if (!$queue = get_record('import_queue', 'token', $token, 'host', $REMOTEWWWROOT)) {
424
        throw new ImportException(null, "Could not find queue record with given token for username $username for $REMOTEWWWROOT");
425
426
427
    }

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

431
432
433
434
435
436
437
    $class = null;
    try {
        $class = PluginImport::class_from_format($format);
    } catch (Exception $e) {
        throw new ImportException(null, "Invalid format $format");
    }

438
    $queue->format = $format;
439
440
441
442
    if ($class == 'PluginImportLeap') {
        // don't import persondata over mnet
        // because it will just silently overwrite stuff
        // which is not really desirable.
443
        $queue->loglevel = get_config('leapovermnetloglevel');
444
445
        $importdata['skippersondata'] = true;
    }
446
447
448
    $queue->data = serialize($importdata);
    update_record('import_queue', $queue);
    $tr = new MnetImporterTransport($queue);
449
    try {
450
        $tr->validate_import_data();
451
    } catch (Exception $e) {
452
        throw new ImportException(null, 'Invalid importdata: ' . $e->getMessage());
453
    }
454
455


456

457
    if (!array_key_exists('totalsize', $importdata)) {
458
        throw new ImportException(null, 'Invalid importdata: missing totalsize');
459
460
461
    }

    if (!$user->quota_allowed($importdata['totalsize'])) {
462
        $e = new ImportException(null, 'Exceeded user quota');
463
464
465
466
        $e->set_log_off();
        throw $e;
    }

467
468

    $result = new StdClass;
469
    if ($fetchnow && PluginImport::import_immediately_allowed()) {
470
        // either immediately spawn a curl request to go fetch the file
471
        $importer = PluginImport::create_importer($queue->id, $tr, $queue);
472
        $importer->prepare();
473
474
475
476
477
        try {
            $importer->validate_transported_data($tr);
        } catch (Exception $e) {
            throw new ImportException(null, 'Invalid importdata: ' . $e->getMessage());
        }
478
        $importer->process();
479
        $importer->cleanup();
480
        delete_records('import_queue', 'id', $queue->id);
481
482
        $result->status = true;
        $result->type = 'complete';
483
484
485
486
487
        $returndata = $importer->get_return_data();
        $result->querystring = '?';
        foreach ($importer->get_return_data() as $k => $v) {
            $result->querystring .= $k . '=' . $v . '&';
        }
488
        $importer->get('importertransport')->cleanup();
489
490
491
492
493
494
495
496
    } 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';
    }
    return $result;
}

497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
/**
 * 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;
}

571
572
573
574
function xmlrpc_not_implemented() {
    return true;
}

575
576
577
578
579
580
581
582
function get_views_for_user($username, $query=null) {
    global $REMOTEWWWROOT, $USER;

    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        return false;
    }

583
    $USER->reanimate($user->id, $authinstance->instanceid);
584
585
586
587
588
589
590
591
592
593
594
595
    require_once('view.php');
    $data = View::view_search($query, null, (object) array('owner' => $USER->get('id')));
    $data->displayname = display_name($user);
    if ($data->count) {
        foreach ($data->data as &$v) {
            $v['url'] = '/view/view.php?id=' . $v['id'];
            $v['fullurl'] = get_config('wwwroot') . 'view/view.php?id=' . $v['id'];
        }
    }
    return $data;
}

596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
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
692
693
694
695
696
function get_groups_for_user($username) {
    global $REMOTEWWWROOT, $USER;

    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        return false;
    }

    require_once('group.php');
    $USER->reanimate($user->id, $authinstance->instanceid);
    $groupdata = group_get_associated_groups($USER->get('id'), 'all', null, null);
    $data = new stdclass();
    $data->data = array();
    $data->count = $groupdata['count'];
    $data->displayname = display_name($user);
    if ($data->count) {
        foreach ($groupdata['groups'] as $g) {
            $record = array();
            $record['id'] = $g->id;
            $record['name'] = $g->name;
            $record['description'] = $g->description;
            $record['public'] = $g->public;
            $record['jointype'] = $g->jointype;
            $record['grouptype'] = $g->grouptype;
            $record['membershiptype'] = $g->membershiptype;
            $record['role'] = $g->role;
            $record['url'] = '/group/view.php?id=' . $g->id;
            $record['fullurl'] = get_config('wwwroot') . 'group/view.php?id=' . $g->id;
            $data->data[] = $record;
        }
    }
    return $data;
}

function get_notifications_for_user($username, $notificationtypes, $maxitems) {
    global $REMOTEWWWROOT, $USER;

    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        return false;
    }

    $USER->reanimate($user->id, $authinstance->instanceid);

    $sql = "SELECT n.id, n.subject, n.message, n.url, n.urltext, n.read, t.name AS type
              FROM {notification_internal_activity} n JOIN {activity_type} t ON n.type = t.id
             WHERE n.usr = ? AND t.name IN (" . join(',', array_fill(0, count($notificationtypes), '?')) . ")
          ORDER BY n.ctime DESC
             LIMIT ?";

    $params = array($USER->get('id'));
    $params = array_merge($params, $notificationtypes);
    $params[] = $maxitems;
    $records = get_records_sql_array($sql, $params);

    $data = new stdclass;
    $data->data = $records;
    $data->count = count($records);
    $data->displayname = display_name($user);
    return $data;
}

function get_watchlist_for_user($username, $maxitems) {

    global $REMOTEWWWROOT, $USER;

    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        return false;
    }

    $USER->reanimate($user->id, $authinstance->instanceid);

    $sql = 'SELECT v.title AS viewtitle, v.id AS viewid, g.name AS groupname, u.*
              FROM {view} v
              JOIN {usr_watchlist_view} wv ON wv.view = v.id
         LEFT JOIN {usr} u ON u.id = v.owner
         LEFT JOIN {group} g ON g.id = v.group
             WHERE wv.usr = ?
          ORDER BY v.title
             LIMIT ?';

    $records = get_records_sql_array($sql, array($USER->get('id'), $maxitems));

    $data = new stdclass;
    $data->data = array();
    $data->count = count($records);
    $data->displayname = display_name($user);
    foreach ($records as $r) {
        $v = array();
        $v['id'] = $r->viewid;
        $v['title'] = $r->viewtitle;
        $v['group'] = $r->groupname;
        $v['author'] = $r->id ? display_name($r) : '';
        $v['url'] = '/view/view.php?id=' . $r->viewid;
        $v['fullurl'] = get_config('wwwroot') . 'view/view.php?id=' . $r->viewid;
        $data->data[] = $v;
    }
    return $data;
}

697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
function submit_view_for_assessment($username, $viewid) {
    global $REMOTEWWWROOT;

    list ($user, $authinstance) = find_remote_user($username, $REMOTEWWWROOT);
    if (!$user) {
        return false;
    }

    $viewid = (int) $viewid;
    if (!$viewid) {
        return false;
    }

    require_once('view.php');
    $view = new View($viewid);

    $view->set('submittedhost', $authinstance->config['wwwroot']);
714
    $view->set('submittedtime', db_format_timestamp(time()));
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735

    // Create secret key
    $access = View::new_token($view->get('id'), false);

    $data = array(
        'id'          => $view->get('id'),
        'title'       => $view->get('title'),
        'description' => $view->get('description'),
        'fullurl'     => get_config('wwwroot') . 'view/view.php?id=' . $view->get('id') . '&mt=' . $access->token,
        'url'         => '/view/view.php?id=' . $view->get('id') . '&mt=' . $access->token,
        'accesskey'   => $access->token,
    );

    foreach (plugins_installed('artefact') as $plugin) {
        safe_require('artefact', $plugin->name);
        $classname = generate_class_name('artefact', $plugin->name);
        if (is_callable($classname . '::view_submit_external_data')) {
            $data[$plugin->name] = call_static_method($classname, 'view_submit_external_data', $view->get('id'));
        }
    }

736
737
738
739
740
741
    $view->commit();

    // Lock view contents
    require_once(get_config('docroot') . 'artefact/lib.php');
    ArtefactType::update_locked($user->get('id'));

742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
    return $data;
}

function release_submitted_view($viewid, $assessmentdata, $teacherusername) {
    global $REMOTEWWWROOT, $USER;

    require_once('view.php');
    $view = new View($viewid);
    list ($teacher, $authinstance) = find_remote_user($teacherusername, $REMOTEWWWROOT);

    db_begin();
    foreach (plugins_installed('artefact') as $plugin) {
        safe_require('artefact', $plugin->name);
        $classname = generate_class_name('artefact', $plugin->name);
        if (is_callable($classname . '::view_release_external_data')) {
            call_static_method($classname, 'view_release_external_data', $view, $assessmentdata, $teacher ? $teacher->id : 0);
        }
    }

    // Release the view for editing
    $view->set('submittedhost', null);
763
    $view->set('submittedtime', null);
764
    $view->commit();
765
    ArtefactType::update_locked($view->get('owner'));
766
767
768
    db_commit();
}

769
770
771
772
773
774
775
/**
 * 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();

776
777
778
779
    if (defined('INSTALLER')) {
        return array();
    }

780
781
782
783
    if (array_key_exists($instance, $cache)) {
        return $cache[$instance];
    }

784
    $query = "
785
786
787
788
789
790
        SELECT
            h.name,
            a.ssolandurl,
            h.wwwroot,
            aic.instance
        FROM
791
792
793
794
795
            {auth_instance_config} aic,
            {auth_instance_config} aic2,
            {auth_instance_config} aic3,
            {host} h,
            {application} a
796
        WHERE
797
798
          ((aic.value = '1' AND
            aic.field = 'theyautocreateusers' ) OR
799
           (aic.value = ?  AND
800
            aic.field = 'parent')) AND
801
802

            aic.instance = aic2.instance AND
803
            aic2.field = 'wwwroot' AND
804
805
806
            aic2.value = h.wwwroot AND

            aic.instance = aic3.instance AND
807
808
            aic3.field = 'wessoout' AND
            aic3.value = '1' AND
809

810
            a.name = h.appname";
811
812
813
814
815
816
    try {
        $results = get_records_sql_assoc($query, array('value' => $instance));
    } catch (SQLException $e) {
        // Table doesn't exist yet
        return array();
    }
817
818
819
820
821
822
823
824
825
826
827
828
829

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

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

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

830
function get_public_key($uri, $application=null) {
831

832
833
834
835
836
837
838
    static $keyarray = array();
    if (isset($keyarray[$uri])) {
        return $keyarray[$uri];
    }

    $openssl = OpenSslRepo::singleton();

839
    if (empty($application)) {
840
        $application = 'moodle';
841
    }
842

843
    $xmlrpcserverurl = get_field('application', 'xmlrpcserverurl', 'name', $application);
844
845
846
    if (empty($xmlrpcserverurl)) {
        throw new XmlrpcClientException('Unknown application');
    } 
847
    $wwwroot = dropslash(get_config('wwwroot'));
848

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

851
852
853
854
855
856
    $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: '),
857
858
        CURLOPT_SSL_VERIFYPEER => false,
        CURLOPT_SSL_VERIFYHOST => 0,
859
860
    );

861
    $result = mahara_http_request($config);
862

863
864
865
    if (!empty($result->errno)) {
        throw new XmlrpcClientException('Curl error: ' . $result->errno . ': ' . $result->error);
    }
866
    if (empty($result->data)) {
867
868
        throw new XmlrpcClientException('CURL connection failed');
    }
869

870
    $response_code        = $result->info['http_code'];
871
872
873
874
875
    $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);
876
        } elseif ('5' == $response_code_prefix) {
877
878
879
880
            throw new XmlrpcClientException('An error occurred at the remote server. Code: ', $response_code);
        }
    }

881
    $res = xmlrpc_decode($result->data);
882

883
884
885
    // XMLRPC error messages are returned as an array
    // We are expecting a string
    if (!is_array($res)) {
886
887
888
889
890
891
892
893
        $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];
            }
894
            throw new XmlrpcClientException('The remote site sent us a key that is valid for ' . $host . ' instead of their hostname (' . $uri . ')', 500);
895
        }
896
897
    } else {
        throw new XmlrpcClientException($res['faultString'], $res['faultCode']);
898
899
900
901
    }
    return false;
}

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
/**
 * 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;
}

931
function xmlenc_envelope_strip(&$xml, $oldkeyok=false) {
932
933
934
935
936
    $openssl           = OpenSslRepo::singleton();
    $payload_encrypted = true;
    $data              = base64_decode($xml->EncryptedData->CipherData->CipherValue);
    $key               = base64_decode($xml->EncryptedKey->CipherData->CipherValue);
    $payload           = '';    // Initialize payload var
937
    $payload           = $openssl->openssl_open($data, $key, $oldkeyok);
938
939
940
941
942
943
944
945
946
    $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
947
        throw new MaharaException('Encrypted payload is not a valid XML document', 6002);
948
949
950
    }
}

951
function get_peer($wwwroot, $cache=true) {
952

953
954
    $wwwroot = (string)$wwwroot;
    static $peers = array();
955
956
957
    if ($cache) {
        if (isset($peers[$wwwroot])) return $peers[$wwwroot];
    }
958

959
    require_once(get_config('libroot') . 'peer.php');
960
    $peer = new Peer();
961

962
    if (!$peer->findByWwwroot($wwwroot)) {
963
        // Bootstrap unknown hosts?
964
        throw new MaharaException("We don't have a record for your webserver ($wwwroot) in our database", 6003);
965
966
967
968
969
    }
    $peers[$wwwroot] = $peer;
    return $peers[$wwwroot];
}

970
971
function get_peer_from_instanceid($authinstanceid) {
    $sql = 'SELECT
972
                h.wwwroot, h.name
973
            FROM
974
                {auth_instance_config} aic,
975
976
                {host} h
            WHERE
977
978
                aic.value = h.wwwroot AND
                aic.instance = ? AND aic.field = \'wwwroot\'';
979
980
981
    return get_record_sql($sql, array($authinstanceid));
}

982
983
984
/**
 * Check that the signature has been signed by the remote host.
 */
985
function xmldsig_envelope_strip(&$xml) {
986

987
988
989
990
991
992
    $signature      = base64_decode($xml->Signature->SignatureValue);
    $payload        = base64_decode($xml->object);
    $wwwroot        = (string)$xml->wwwroot;
    $timestamp      = $xml->timestamp;
    $peer           = get_peer($wwwroot);

993

994
995
996
    // Does the signature match the data and the public cert?
    $signature_verified = openssl_verify($payload, $signature, $peer->certificate);

997
    if ($signature_verified == 0) {
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
        // Maybe the remote host is using a new key?
        // 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);
1009
1010
1011
1012
1013
1014
1015
1016
1017
    }

    if ($signature_verified == 1) {
        // 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);
1018
1019
1020
1021
        }
    }

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

1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
/**
 * 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
1058
        throw new MaharaException('Could not generate public key resource from certificate', 1);
1059
1060
1061
    }

    // Initialize vars
1062
    $wwwroot = dropslash(get_config('wwwroot'));
1063
1064
1065
1066
1067
1068
1069
    $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));
1070
    $zed = 'nothing';
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097

    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>
1098
        <wwwroot>{$wwwroot}</wwwroot>
1099
        <X1>$zed</X1>
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
    </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) {
1129

1130
    $openssl = OpenSslRepo::singleton();
1131
    $wwwroot = dropslash(get_config('wwwroot'));
1132
    $digest = sha1($message);
1133

1134
    $sig = base64_encode($openssl->sign_message($message));
1135
1136
    $message = base64_encode($message);
    $time = time();
1137
    // TODO: Provide RESTful access to our public key as per KeyInfo element
1138
1139
1140
1141
1142
1143
1144

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"/>
1145
                <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/>
1146
1147
1148
1149
1150
1151
1152
                <Reference URI="#XMLRPC-MSG">
                    <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/>
                    <DigestValue>$digest</DigestValue>
                </Reference>
            </SignedInfo>
            <SignatureValue>$sig</SignatureValue>
            <KeyInfo>
1153
                <RetrievalMethod URI="{$wwwroot}/api/xmlrpc/publickey.php"/>
1154
1155
1156
            </KeyInfo>
        </Signature>
        <object ID="XMLRPC-MSG">$message</object>
1157
        <wwwroot>{$wwwroot}</wwwroot>
1158
1159
1160
1161
1162
1163
        <timestamp>$time</timestamp>
    </signedMessage>
EOF;

}

1164
1165
1166
/**
 * Good candidate to be a singleton
 */
1167
class OpenSslRepo {
1168
1169
1170

    private $keypair = array();

1171
1172
1173
1174
1175
1176
1177
1178
    /**
     * Sign a message with our private key so that peers can verify that it came
     * from us.
     *
     * @param  string   $message
     * @return string
     * @access public
     */
1179
1180
1181
1182
1183
    public function sign_message($message) {
        $signature = '';
        $bool      = openssl_sign($message, $signature, $this->keypair['privatekey']);
        return $signature;
    }
1184

1185
1186
1187
1188
1189
1190
1191
1192
1193
    /**
     * 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
1194
1195
1196
     * @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)
1197
1198
1199
     * @return string
     * @access public
     */
1200
    public function openssl_open($data, $key, $oldkeyok=false) {
1201
1202
1203
1204
1205
1206
1207
        $payload = '';
        $isOpen = openssl_open($data, $payload, $key, $this->keypair['privatekey']);

        if (!empty($isOpen)) {
            return $payload;
        } else {
            // Decryption failed... let's try our archived keys
1208
            $openssl_history = $this->get_history();
1209
1210
1211
1212
1213
            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
1214
1215
1216
1217
1218
1219
1220
                    if ($oldkeyok) {
                        return $payload;
                    }
                    else {
                        // We notify the remote host that the key has changed
                        throw new CryptException($this->keypair['certificate'], 7025);
                    }
1221
1222
1223
                }
            }
        }
1224
        throw new CryptException('We know nothing about the key used to encrypt this message', 7025);
1225
1226
    }

1227
    /**
1228
     * Singleton function keeps us from generating multiple instances of this
1229
1230
1231
1232
1233
     * class
     *
     * @return object   The class instance
     * @access public
     */
1234
1235
1236
1237
1238
    public static function singleton() {
        //single instance
        static $instance;

        //if we don't have the single instance, create one
1239
        if (!isset($instance)) {
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
            $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() {
1253
        if (empty($this->keypair)) {
1254
            $this->get_keypair();
1255
	    $this->calculate_fingerprints();
1256
1257
1258
            $this->keypair['privatekey'] = openssl_pkey_get_private($this->keypair['keypair_PEM']);
            $this->keypair['publickey']  = openssl_pkey_get_public($this->keypair['certificate']);
        }
1259
        return $this;
1260
1261
    }

1262
1263
1264
1265
1266
1267
1268
    /**
     * 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
     */
1269
1270
    private function get_history() {
        $openssl_history = get_field('config', 'value', 'field', 'openssl_history');
1271
        if (empty($openssl_history)) {
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
            $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;
    }

1283
1284
1285
1286
1287
1288
1289
1290
    /**
     * 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
     */
1291
1292
    private function save_history($openssl_history) {
        $openssl_generations = get_field('config', 'value', 'field', 'openssl_generations');
1293
        if (empty($openssl_generations)) {
1294
1295
1296
            set_config('openssl_generations', 6);
            $openssl_generations = 6;
        }
1297
        if (count($openssl_history) > $openssl_generations) {
1298
1299
1300
1301
1302
            $openssl_history = array_slice($openssl_history, 0, $openssl_generations);
        }
        return set_config('openssl_history', serialize($openssl_history));
    }

1303
1304
1305
1306
1307
1308
1309
1310
1311
    /**
     * 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
     */
1312
    public function __get($name) {
1313
1314
        if ('certificate' === $name) return $this->keypair['certificate'];
        if ('expires' === $name)     return $this->keypair['expires'];
1315
1316
        if ('sha1_fingerprint' === $name) return $this->keypair['sha1_fingerprint'];
        if ('md5_fingerprint' === $name ) return $this->keypair['md5_fingerprint'];
1317
1318
        return null;
    }
1319

1320
1321
1322
1323
1324
1325
1326
1327
    /**
     * 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
     */
1328
    public function get_keypair($regenerate = null) {
1329
1330
1331
        $this->keypair = array();
        $records       = null;
        
1332
1333
1334
1335
1336
        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;
1337
1338
1339
            }
        }

1340
1341
1342
1343
1344
        // Save out the old key
        $openssl_history = $this->get_history();
        array_unshift($openssl_history, $this->keypair);
        $this->save_history($openssl_history);

1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
        // 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']);
1360
        if (is_array($credentials) && isset($credentials['validTo_time_t'])) {
1361
1362
1363
1364
            $expiresrecord->value = $credentials['validTo_time_t'];
            $this->keypair['expires'] = $credentials['validTo_time_t'];
        }

1365
        if (empty($records)) {
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
            db_begin();
            insert_record('config', $keyrecord);
            insert_record('config', $expiresrecord);