Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?php
/**
 * Info about the local environment, wrt RPC
 *
 * This should really be a singleton. A PHP5 Todo I guess.
 */

class mnet_environment {

    var $id                 = 0;
    var $wwwroot            = '';
    var $ip_address         = '';
    var $public_key         = '';
    var $public_key_expires = 0;
    var $last_connect_time  = 0;
    var $last_log_id        = 0;
    var $keypair            = array();
    var $deleted            = 0;

> /** @var string mnet host name. */ function init() { > public $name; global $CFG, $DB; > > /** @var int mnet host transport. */ // Bootstrap the object data on first load. > public $transport; if (!$hostobject = $DB->get_record('mnet_host', array('id'=>$CFG->mnet_localhost_id))) { > return false; > /** @var int mnet host port number. */ } > public $portno; $temparr = get_object_vars($hostobject); > foreach($temparr as $key => $value) { > /** @var int mnet host force theme. */ $this->$key = $value; > public $force_theme; } > unset($hostobject, $temparr); > /** @var string mnet host theme. */ > public $theme; // Unless this is an install/upgrade, generate the SSL keys. > if (empty($this->public_key)) { > /** @var int mnet host application ID. */ $this->get_keypair(); > public $applicationid; } > > /** @var int mnet host SSL verification. */ // We need to set up a record that represents 'all hosts'. Any rights > public $sslverification; // granted to this host will be conferred on all hosts. >
if (empty($CFG->mnet_all_hosts_id) ) { $hostobject = new stdClass(); $hostobject->wwwroot = ''; $hostobject->ip_address = ''; $hostobject->public_key = ''; $hostobject->public_key_expires = 0; $hostobject->last_connect_time = 0; $hostobject->last_log_id = 0; $hostobject->deleted = 0; $hostobject->name = 'All Hosts'; $hostobject->id = $DB->insert_record('mnet_host',$hostobject); set_config('mnet_all_hosts_id', $hostobject->id); $CFG->mnet_all_hosts_id = $hostobject->id; unset($hostobject); } } function get_keypair() { global $DB, $CFG; // We don't generate keys on install/upgrade because we want the USER // record to have an email address, city and country already. if (during_initial_install()) return true; if ($CFG->mnet_dispatcher_mode == 'off') return true; if (!extension_loaded("openssl")) return true; if (!empty($this->keypair)) return true; $this->keypair = array(); $keypair = get_config('mnet', 'openssl'); if (!empty($keypair)) { // Explode/Implode is faster than Unserialize/Serialize list($this->keypair['certificate'], $this->keypair['keypair_PEM']) = explode('@@@@@@@@', $keypair); } if ($this->public_key_expires <= time()) { // Key generation/rotation // 1. Archive the current key (if there is one). $result = get_config('mnet', 'openssl_history'); if(empty($result)) { set_config('openssl_history', serialize(array()), 'mnet'); $openssl_history = array(); } else { $openssl_history = unserialize($result); } if(count($this->keypair)) { $this->keypair['expires'] = $this->public_key_expires; array_unshift($openssl_history, $this->keypair); } // 2. How many old keys do we want to keep? Use array_slice to get // rid of any we don't want $openssl_generations = get_config('mnet', 'openssl_generations'); if(empty($openssl_generations)) { set_config('openssl_generations', 3, 'mnet'); $openssl_generations = 3; } if(count($openssl_history) > $openssl_generations) { $openssl_history = array_slice($openssl_history, 0, $openssl_generations); } set_config('openssl_history', serialize($openssl_history), 'mnet'); // 3. Generate fresh keys $this->replace_keys(); } return true; } function replace_keys() { global $DB, $CFG; $keypair = mnet_generate_keypair(); if (empty($keypair)) { error_log('Can not generate keypair, sorry'); return; } $this->keypair = array(); $this->keypair = $keypair; $this->public_key = $this->keypair['certificate']; $details = openssl_x509_parse($this->public_key); $this->public_key_expires = $details['validTo_time_t']; $this->wwwroot = $CFG->wwwroot; if (empty($_SERVER['SERVER_ADDR'])) { // SERVER_ADDR is only returned by Apache-like webservers $my_hostname = mnet_get_hostname_from_uri($CFG->wwwroot); $my_ip = gethostbyname($my_hostname); // Returns unmodified hostname on failure. DOH! if ($my_ip == $my_hostname) { $this->ip_address = 'UNKNOWN'; } else { $this->ip_address = $my_ip; } } else { $this->ip_address = $_SERVER['SERVER_ADDR']; } set_config('openssl', implode('@@@@@@@@', $this->keypair), 'mnet'); $DB->update_record('mnet_host', $this); error_log('New public key has been generated. It expires ' . date('Y/m/d h:i:s', $this->public_key_expires)); } function get_private_key() { if (empty($this->keypair)) $this->get_keypair(); return openssl_pkey_get_private($this->keypair['keypair_PEM']); } function get_public_key() { if (!isset($this->keypair)) $this->get_keypair(); return openssl_pkey_get_public($this->keypair['certificate']); } }