Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-73270

Warn where XMLRPC is currently in use

    XMLWordPrintable

Details

    • MOODLE_400_STABLE
    • MOODLE_400_STABLE
    • MDL-73270-master
    • Hide

      Most of the tests were covered by the newly created PHPUnit.

      Manual testing

      Initial setup

      1. Log in as an admin account.
      2. Turn off mnet_dispatcher_mode in Advanced features.
      3. Turn off XML-RPC protocol in Administration > Server > Web services > Manage protocols.

      Web service

      1. Navigate to Site administration > Server > Environment.
      2. Verify that you will not see any warning in the Other checks section that contains "XML-RPC".
      3. Turn on XML-RPC protocol in Administration > Server > Web services > Manage protocols.
      4. Verify that you will see a warning message "It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP.".
      5. Navigate to Site administration > Server > Environment.
      6. Verify that you will see a warning in the Other checks section as below:
        • Information: xmlrpc_webservice_usage
        • Report: It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP.
      7. Navigate to Site administration > Generals > Notifications.
      8. Verify that you will see a warning message "It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP".
      9. Turn off XML-RPC protocol in Administration > Server > Web services > Manage protocols for the next testing.

      MNet is turned on but no host was setup

      Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mnet.

      1. Turn on mnet_dispatcher_mode in Advanced features.
      2. Navigate to More -> Networking -> Manage Peers.
      3. Delete all the hosts if any.
      4. Navigate to Site administration > Server > Environment.
      5. Verify that you will not see any warning in the Other checks section that contains "XML-RPC".
      6. Navigate to Site administration > Generals > Notifications.
      7. Verify that you will not see any warning message for XML-RPC.

      MNet is turned on and host was setup

      Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mnet.

      1. Setup the MNet as https://docs.moodle.org/311/en/MNet
      2. Navigate to More -> Networking -> Manage Peers.
      3. Add an MNet host.
      4. Navigate to Site administration > Server > Environment.
      5. Verify that you will see a warning in the Other checks section as below:
        • Information: xmlrpc_mnet_usage
        • Report: It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP.
      6. Navigate to Site administration > Generals > Notifications.
      7. Verify that you will see a warning message "It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP".

      Warning message on the MNet configuration pages

      1. If you ** skipped the earlier test titled "MNet is turned on but no host was setup", turn on mnet_dispatcher_mode in Advanced features now.
      2. Verify that you will see a warning message "It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP." on the below pages:
        • More -> Networking -> Settings.
        • More -> Networking -> Manage Peers.
        • More -> Networking -> SSO access control.
        • More -> Networking -> Remote enrolments client.
        • More -> Networking -> XML-RPC hosts.
        • More -> Networking -> Profile fields.

      Mahara portfolios

      Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mahara portfolios.

      1. Navigate to More -> Networking -> Manage Peers.
      2. Delete all the hosts if any.
      3. Setup the Mahara portfolios as https://docs.moodle.org/311/en/Mahara_portfolio
      4. Enable the Mahara Portfolios.
      5. Navigate to Site administration > Server > Environment.
      6. Verify that you will see a warning in the Other checks section as below:
        • Information: xmlrpc_mahara_usage
        • Report: It has been detected that the Mahara ePortfolio is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP.
      7. Navigate to Site administration > Generals > Notifications.
      8. Verify that you will see a warning message "It has been detected that the Mahara ePortfolio is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP".

      MNet authentication

      1. Navigate to Plugins -> Manage authentication.
      2. Click on the 'eye' button to enable MNet authentication.
      3. Verify that you will see a warning message " It has been detected that the MNet authentication is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. "
      4. Click on the Settings link of the MNet authentication.
      5. Verify that you will see a warning message " It has been detected that the MNet authentication is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. "
      Show
      Most of the tests were covered by the newly created PHPUnit. Manual testing Initial setup Log in as an admin account. Turn off mnet_dispatcher_mode in Advanced features. Turn off XML-RPC protocol in Administration > Server > Web services > Manage protocols. Web service Navigate to Site administration > Server > Environment. Verify that you will not see any warning in the Other checks section that contains "XML-RPC". Turn on XML-RPC protocol in Administration > Server > Web services > Manage protocols. Verify that you will see a warning message "It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP.". Navigate to Site administration > Server > Environment. Verify that you will see a warning in the Other checks section as below: Information: xmlrpc_webservice_usage Report: It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. Navigate to Site administration > Generals > Notifications. Verify that you will see a warning message "It has been detected that the XML-RPC Web Service protocol is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP". Turn off XML-RPC protocol in Administration > Server > Web services > Manage protocols for the next testing. MNet is turned on but no host was setup Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mnet. Turn on mnet_dispatcher_mode in Advanced features. Navigate to More -> Networking -> Manage Peers. Delete all the hosts if any. Navigate to Site administration > Server > Environment. Verify that you will not see any warning in the Other checks section that contains "XML-RPC". Navigate to Site administration > Generals > Notifications. Verify that you will not see any warning message for XML-RPC. MNet is turned on and host was setup Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mnet. Setup the MNet as https://docs.moodle.org/311/en/MNet Navigate to More -> Networking -> Manage Peers. Add an MNet host. Navigate to Site administration > Server > Environment. Verify that you will see a warning in the Other checks section as below: Information: xmlrpc_mnet_usage Report: It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. Navigate to Site administration > Generals > Notifications. Verify that you will see a warning message "It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP". Warning message on the MNet configuration pages If you ** skipped the earlier test titled "MNet is turned on but no host was setup", turn on mnet_dispatcher_mode in Advanced features now. Verify that you will see a warning message "It has been detected that the Moodle Networking is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP." on the below pages: More -> Networking -> Settings. More -> Networking -> Manage Peers. More -> Networking -> SSO access control. More -> Networking -> Remote enrolments client. More -> Networking -> XML-RPC hosts. More -> Networking -> Profile fields. Mahara portfolios Note: This test can be skipped because it was already covered by the newly created PHPUnit and it is complicated to set up Mahara portfolios. Navigate to More -> Networking -> Manage Peers. Delete all the hosts if any. Setup the Mahara portfolios as https://docs.moodle.org/311/en/Mahara_portfolio Enable the Mahara Portfolios. Navigate to Site administration > Server > Environment. Verify that you will see a warning in the Other checks section as below: Information: xmlrpc_mahara_usage Report: It has been detected that the Mahara ePortfolio is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. Navigate to Site administration > Generals > Notifications. Verify that you will see a warning message " It has been detected that the Mahara ePortfolio is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP ". MNet authentication Navigate to Plugins -> Manage authentication. Click on the 'eye' button to enable MNet authentication. Verify that you will see a warning message " It has been detected that the MNet authentication is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. " Click on the Settings link of the MNet authentication. Verify that you will see a warning message " It has been detected that the MNet authentication is enabled on your site. This feature relies on the PHP XML-RPC extension which is no longer maintained by PHP. "
    • 1
    • HQ Team International CIH2-215

    Description

      XMLRPC is in an unsupportable state and we will need to warn users of its impending doom.

      We can do so in a selection of places:

      1. admin/environment.xml
        1. Warn if xmlrpc webservice protocol is enabled
        2. Warn if any mnet features are enabled
      2. on the webservice protocols page
      3. on the various MNet configuration pages

      Attachments

        1. MDL-73270-MNauth-step-3.png
          MDL-73270-MNauth-step-3.png
          46 kB
        2. MDL-73270-MNauth-step-5.png
          MDL-73270-MNauth-step-5.png
          30 kB
        3. MDL-73270-MNconfig-1.png
          MDL-73270-MNconfig-1.png
          30 kB
        4. MDL-73270-MNconfig-2.png
          MDL-73270-MNconfig-2.png
          30 kB
        5. MDL-73270-MNconfig-3.png
          MDL-73270-MNconfig-3.png
          30 kB
        6. MDL-73270-MNconfig-4.png
          MDL-73270-MNconfig-4.png
          31 kB
        7. MDL-73270-MNconfig-5.png
          MDL-73270-MNconfig-5.png
          30 kB
        8. MDL-73270-MNconfig-6.png
          MDL-73270-MNconfig-6.png
          15 kB
        9. MDL-73270-WS-step-2.png
          MDL-73270-WS-step-2.png
          31 kB
        10. MDL-73270-WS-step-4.png
          MDL-73270-WS-step-4.png
          24 kB
        11. MDL-73270-WS-step-6.png
          MDL-73270-WS-step-6.png
          58 kB
        12. MDL-73270-WS-step-8.png
          MDL-73270-WS-step-8.png
          62 kB

        Issue Links

          Activity

            People

              huongn@moodle.com Huong Nguyen
              dobedobedoh Andrew Lyons
              Simey Lameze Simey Lameze
              Jun Pataleta Jun Pataleta
              Michael Hawkins Michael Hawkins
              Andrew Lyons, Huong Nguyen, Jun Pataleta, Michael Hawkins, Shamim Rezaie, Simey Lameze, Stevani Andolo
              Votes:
              0 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                19/Apr/22

                Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 3 days, 5 hours, 48 minutes
                  3d 5h 48m