MNet

Draft -- for 1.8 functionality Please help us improve it! --Martin Langhoff 22:44, 26 December 2006 (CST)

Overview

Moodle Network is a new feature found in the 1.8 release of Moodle. The network feature allows a Moodle administrator to establish a link with another Moodle, and to share some resources with the users of that Moodle.

The initial release of Moodle Network is bundled with a new Authentication Plugin, which makes single-sign-on between Moodles possible. A user with the username jody logs in to her Moodle server as normal, and clicks on a link that takes her to a page on another Moodle server. Normally, she would have only the privileges of a guest on the remote Moodle, but behind the scenes, single-sign-on has established a fully authenticated session for Jody on the remote site.

Security

The Moodle network feature requires that your server has the Curl and OpenSSL extensions installed. When you install or upgrade to Moodle 1.8, your system will generate a new OpenSSL certificate for encrypted communication with other Moodles, and will thereafter rotate encryption keys on a monthly basis (approx).

Communication takes place over an XML-RPC transport, and the XML-RPC documents are wrapped first in an XMLDSIG (XML digital signature) envelope, and then in an XMLENC (XML encryption) envelope. The encryption all happens within PHP, and does not require an https (Apache SSL) server.

References:

• XML Digital Signatures
• XML Encryption

A special mode can be enabled which would allow a machine with a specified IP address to make calls to the XML-RPC layer without using either encryption or signature envelopes. This mode is provided to enable Moodle to communicate with other software systems in which the integration of signatures and encryption might be prohibitively difficult. It is not envisioned that unencrypted inter-Moodle networking will ever be enabled.

Peer to Peer Network

This is the basic layout of the system. It can be very useful to run one Moodle per faculty or departments, each with its own user management, and yet permit users to roam across the Moodle installs... subject to permissions of course.

Setup

The instructions will cover 2 Moodle installations: MoodleA and MoodleB. Both are installed correctly and have never had a Moodle Network configuration.

1. Get them to talk to each other
   1. Ensure Admin / Server / Environment indicates you have curl installed
   2. If MoodleA and MoodleB are hosted in the same domain, ensure they have a different cookie prefix. Note that changing the cookie prefix will log you out!
   3. On both, go to Admin / Network / Settings and turn Networking ON.
   4. On MoodleA go to Admin / Network / Peers - put the URL of MoodleB under "Add New Host" and click Add.
   5. Do the equivalent on MoodleB.
2. Get user roaming going
   1. On both, go to Admin / Users / Authentication and enable Moodle Network authentication plugin. Click on 'Settings' and enable auto_add_remote_users.
   2. On MoodleA go to Admin / Network / Peers, click on 'MoodleB', and click on 'Services'. Enable SSO-IDP publish and subscribe, and SSO-SP publish and subscribe.
   3. Do the equivalent on MoodleB.
   4. On both, got to Admin / Users / Permissions / Define Roles, only roles that have "Roam to a remote Moodle moodle/site:mnetlogintoremote" will be allowed to roam. Grant the privilege as appropriate.
   5. On both, go to the homepage, and add the 'Network Servers' block.
   6. To test, it is recommended to use a different browser (even on a different machine) that is logged in to neither. Login to MoodleA with a non-administrator account that has the permissions to roam. You should see the Network Servers block, and clicking on it you should go to MoodleB with a newly autocreated account.
3. Get remote enrolments going -- this is optional. It allows administrator of MoodleB can enrol users that are "native" to MoodleB in courses in MoodleA, and viceversa.
   1. On both, go to Admin / Courses / Enrolment and enable Moodle Network enrolment plugin (click Save). Click on 'Edit' and enable 'allow_allcourses' or select some courses or categories to be remotely enrolled.
   2. On MoodleA go to Admin / Network / Peers, click on 'MoodleB', and click on 'Services'. Enable Enrolment publish and subscribe.
   3. Do the equivalent on MoodleB.
   4. To use, in MoodleA go to Admin / Courses / Enrolment / Moodle Network -> Edit / Manage Network Enrolments and you will see MoodleB listed. Click on MoodleB and you will see a list of your users, and the courses that MoodleB offers for remote enrolment.

Connecting to a Community hub

A Community hub is a Moodle server that is configured to accept connections from other Moodle servers, and to provide a set of services to users of these other servers. This guideline will direct you to connect to a Community hub, assess the services it has to offer, and enable those services for your users.

Setup

1. Get talking to the Hub
   1. Ensure that the Admin / Server / Environment page indicates you have curl and openssl installed
   2. Go to Admin / Network / Settings and turn Networking on
   3. Go to Admin / Network / Peers and enter the URL of Community Hub under "Add New Host". Click Add
   4. The host details for the Community Hub should appear with the Site Name field already populated. Click Save changes
   5. The details will be written to your database and two new tabs will appear in this window: 'Services' and 'Logs'. Click Services
   6. A list of services will appear, each with a checkbox for 'publish' and 'subscribe'. Check the checkboxes for any services you want to publish or subscribe to

Using it

If the Community Hub has already enabled a service for you, there will be a tick alongside the appropriate checkbox, for example: if the Hub is publishing Moodle Networked Enrolment, then a tick will appear alongside the subscribe checkbox for this service. Note that in order to enable some functionality, prominently single-sign-on, you may have to publish a service, e.g. the Identity Provider service. The Community Hub will access this service on your Moodle, asking it to authenticate your users.

1. Enable Roaming
   1. Subscribe to SSO (Service Provider) by checking the box
   2. Publish SSO (Identity Provider) by checking the box
   3. Click Save changes
   4. Go to Admin / Users / Permissions / Define Roles, and grant the capability Roam to a remote Moodle moodle/site:mnetlogintoremote to an appropriate role
   5. Go to Admin / Users / Authentication and enable the Moodle Network authentication plugin
   6. Go to your homepage, turn on editing, and add the 'Network Servers' block
   7. Using a different web-browser, log on as a non-admin user who inhabits the role you granted the roaming capability to
   8. Note that the Community Hub is listed in the Network Servers block on the homepage. Click on the link to that server
   9. Some of your user details will be transferred to the Community Hub server, and a browsing session will be started for you as if you had logged on there directly
2. Enable Networked Enrolment
   1. Return to the web browser you've been using as the site administrator
   2. Go to Admin / Network / Peers and click on the entry for the Community Hub.
   3. Click on the Services tab
   4. Subscribe to Moodle Networked Enrolment
   5. Go to Admin / Courses / Enrolment and enable the Moodle Network enrolment plugin. Click Save changes
   6. Click on edit to view the details for networked enrolments.
   7. Click on Manage Moodle Network Enrolments to see a list of Moodle servers that offer this service to you
   8. Click on a server name to view a list of courses that the server offers to your users
   9. Click on a course name, to view a list users that you can enrol in this course
   10. Enrol users
   11. Profit!

Running a Community hub

A Community hub is a regular Moodle site that runs in a special mode. As a Moodle Administrator, when you add another Moodle site to your list of network peers, your Moodle will contact that site to find out what it is called, and to request its public key for encrypted communication. Normally, the remote server will simply provide this information without making any record of the transaction.

A Community hub is different. As soon as you add an entry for a Community hub to your system, the Community hub will create an entry for your server in its list of hosts, and may immediately begin to offer services to the users of your site.

This section will guide you to set up a Community hub, and select services to offer to all comers.

Setup

1. Enable Networking
   1. Ensure that the Admin / Server / Environment page indicates you have curl and openssl installed
   2. Go to Admin / Network / Settings and turn Networking on
   3. Go to Admin / Network / Peers and tick the checkbox for Register all hosts. Click on Save Changes
   4. On the same page, the first entry in your list of hosts should be All hosts. Click this link
   5. Click on Services and enable any services you want to offer to all comers

See also

• Moodle Network development notes