Difference between revisions of "Features/Proxy Settings"

From Sugar Labs
Jump to: navigation, search
(UI Design: update screenshots)
(Merged!)
 
(67 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>[[Category:Feature Ready for Release Manager]]
+
<noinclude>
 
[[Category:Feature|Proxy Settings]]
 
[[Category:Feature|Proxy Settings]]
 
</noinclude>
 
</noinclude>
Line 5: Line 5:
 
== Summary ==
 
== Summary ==
  
Setting proxy parameters via special Control Panel component.
+
Allow the user to configure proxy settings using the Sugar Control Panel.
  
 
== Owner ==
 
== Owner ==
  
* Code: [[User:alsroot|Aleksey Lim]]
+
 
* Icons: [[User:M_anish| Anish Mangal]]
+
[[User:sascha_silbe|Sascha Silbe]], [[User:ajay_garg|Ajay Garg]] (ajay@activitycentral.com), [[User:ManashRaja|Manash Pratim Das]]
  
 
== Current status ==
 
== Current status ==
  
* Targeted release: 0.96
+
* Targeted release: 0.110
* Last updated: 2Tue Nov 22 20:40:01 UTC 2011
+
* Last updated: 2016-04-18
* Percentage of completion: 95%
+
* Percentage of completion: 100% and merged
 +
 
 +
Merged into something that will probably be 0.110
  
 
== Detailed Description ==
 
== Detailed Description ==
  
In some cases people might be behind HTTP proxy. For now, there is no any users friendly way in Sugar to setup proxy setting.
+
Both individual users and deployments need to be able to set a proxy for
 +
Sugar and activities to use. While we'd like the system to work that all
 +
out automatically (e.g. using [https://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol WPAD]), this often isn't possible. Common
 +
reasons include legacy ("inherited") setups and network uplinks being
 +
out of control of the user.
 +
 
 +
The existing Network Control Panel is enhanced by adding a new section for the
 +
proxy settings. For consistency between Sugar and Gnome, the basic layout of
 +
the Gnome 3 proxy settings has been mirrored: A combo box allows the user to
 +
select how the proxy setting should be determined (None=no proxy settings,
 +
Use system proxy=let proxy be set by other means, Automatic=WPAD or PAC,
 +
Manual=enter host names and ports for each protocol).
 +
Based on which method was selected, additional configuration options are
 +
presented to the user.
 +
 
 +
The settings are stored in 'GSettings' and passed to activities using the 'http_proxy' and similar variables.
  
 
== Benefit to Sugar ==
 
== Benefit to Sugar ==
  
Set proxy parameters without using low level tools like gconftool or switching to Gnome session. This is especially required in Australia and is being developed by ActivityCentral following their input.
+
Widens the environment where Sugar may be used, by removing a reason why Sugar cannot be used in managed information technology environments.
  
 
== Scope ==
 
== Scope ==
  
New Control Panel component.
+
Modifying the existing Network Control Panel.
 +
 
 +
== "Manual" mode==
 +
 
 +
* Fill in the settings "manually", and restart when prompted so.
 +
:[[File:Manual1-proxy.png|1200px]]
 +
 
 +
 
 +
* Now open "www.google.com" shoud open.
 +
:[[File:Google-proxy.png|1200px]]
 +
 
 +
 
 +
== Automatic mode - PAC==
 +
 
 +
* Fill in the URL of the proxy-file, and restart when prompted so.
 +
:[[File:Auto-proxy.png|1200px]]
 +
 
 +
 
 +
* Now open "www.google.com" shoud open.
 +
:[[File:Google-proxy.png|1200px]]
 +
 
 +
 
 +
 
 +
 
 +
==Automatic mode - WPAD==
 +
 
 +
* Motive
 +
** To provide proxy-configuration, without needing the client-user
 +
*** to manualyy enter the proxy-settings ('''Manual''' mode)
 +
*** to manually enter the location of proxy-configuration file herself ('''Automatic (PAC)''' mode).
  
== UI Design ==
 
  
The Feature adds a new section to the Network Control Panel.
+
* Benefits
 +
** By not needing the client-user to manually specify the settings, every client-user is saved  a headache :) Instead, all the configuration is done via a network-administrator, on the server-side.
 +
** By delegating the responsibility of specifying every proxy-rule (even the proxy-configuration file) to the network-administrator, security is increased dramatically.
  
[[File:Proxy-section-1.png|center|600px|Upper part of the Network Control Panel]]
 
[[File:Proxy-section-2.png|center|600px|No proxy (direct connection)]]
 
[[File:Proxy-section-3.png|center|600px|Automatic proxy selection (WPAD)]]
 
[[File:Proxy-section-4.png|center|600px|Manual proxy settings (no authentication)]]
 
[[File:Proxy-section-5.png|center|600px|Manual proxy settings (with authentication)]]
 
  
For comparison, this is what the Gnome 3 proxy settings dialog looks like:
+
* Notes
 +
** Setting this particular mode ('''Automatic-WPAD''' Proxy) is quite complicated; and many possibilities exist. '''However, the bottom-rule is, client should himself not need to specifiy the location of proxy-configuration file as per say'''.
  
[[File:Gnome-3-proxy-settings.png|600px]]
 
  
== How To Test ==
+
* Testing (one of the possible ways :) )
 +
** '''(For those not interested in the technicalities, please proceed to the next bullet :D)''' To verify that current dextrose-4 supports Auto-WPAD mode, we test using the method, as per the following 4 requirements, as listed at http://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol#Requirements ::
 +
***In order to use the DNS only method, a DNS entry is needed for a host named WPAD.
 +
***The host at the WPAD address must be able to serve a Web page.
 +
***In both cases, the Web server must be configured to serve the WPAD file with a MIME type of "application/x-ns-proxy-autoconfig".
 +
***If the DNS method is used, a file named wpad.dat must be located in the WPAD Web site's root directory.
  
* clone [http://git.sugarlabs.org/alsroot/proxy_cp sources]
+
 
* symlink cloned directory to CP components directory, {{Code|/usr/share/sugar/extensions/cpsection}} by default
+
* Select "Automatic" mode in "My Settings" -> "Proxy" (without specifying anything else), and restart when prompted so.
* restart sugar shell
+
:[[File:Wpad-proxy.png|1200px]]
* open Proxy CP component and setup proxy connection
+
 
* open gnome-network-setting and check if it has the same options set
+
 
 +
* The above step is all that is needed for "Automatic (WPAD)" mode to  take effect; the WPAD-configuration-file will be located by the DHCP/DNS Server. However, for easy QA testing,  we specify an easy way to replicate this DNS behavior ::
 +
 
 +
** Add the line "build.activitycentral.com wpad" to the file "/etc/hosts" on the XO, and reboot. '''It is repeated innumerable times, that this  step is required just for easy testing; in actual deployments, the DNS-name resolution will be provided by network-administrators/School-Server-running-DHCPD'''
 +
** Also, thanks a ton to '''Santiago Rodriguez (scollazo@activitycentral.com)''' for setting up the proxy-configuration-files at build.activitycentral.com.
 +
 
 +
 
 +
* Open "Browse", and type in "www.google.com". You should be prompted for credentials (suppose as required by the WPAD-configuration-file)
 +
 
 +
:[[File:proxy2.png|640px]]
 +
 
 +
 
 +
* Entering wrong credentials in the previous step, re-prompts :). This time, enter correct credentials.
 +
:[[File:proxy3.png|640px]]
 +
 
 +
 
 +
* The page opens successfully.
 +
:[[File:Google-proxy.png|1200px]]
 +
 
 +
==Settings verification==
 +
 
 +
The proxy settings entered by user are verified before saving to prevent accidental change in proxy settings.
 +
* For "manual" type the proxy host addresses are pinged to check for their existence.
 +
* For "auto" type the existence of the *.pac file is checked.
 +
If the above verification fails then the user is prompted with an alert message and option to either "Break the Internet connection" or "Reset".
 +
 
 +
* Manual proxy verification failed:
 +
:[[File:Manual-proxy-error.png|640px]]
 +
 
 +
* Auto proxy verification failed:
 +
:[[File:Auto-proxy-error.png|640px]]
  
 
== User Experience ==
 
== User Experience ==
  
The feature is entirely localized only within Control Panel.
+
See [[#UI Design|UI Design]]
  
 
== Dependencies ==
 
== Dependencies ==
  
None.
+
There are no new dependencies.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
  
Do not use new Control Panel component.
+
Users can continue to use the Gnome Control Center to configure proxy settings.
  
 
== Documentation ==
 
== Documentation ==
  
''Is there upstream documentation on this feature, or notes you have written yourself?  Has this topic been discussed in the mailing list or during a meeting? Link to that material here so other interested developers can get involved.''
+
There is no documentation beyond this page.
  
 
== Release Notes ==
 
== Release Notes ==
''The Sugar Release Notes inform end-users about what is new in the release. An Example is [[0.84/Notes]]. The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the release team and shipped with the release.''
+
 
 +
There have been no changes to public API. The Release Notes merely need to mention that users can now configure proxy settings from within Sugar. As detailed above, the UI is very similar to the Gnome UI.
  
 
== Comments and Discussion ==
 
== Comments and Discussion ==
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->
 
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page. -->

Latest revision as of 07:02, 9 May 2016


Summary

Allow the user to configure proxy settings using the Sugar Control Panel.

Owner

Sascha Silbe, Ajay Garg (ajay@activitycentral.com), Manash Pratim Das

Current status

  • Targeted release: 0.110
  • Last updated: 2016-04-18
  • Percentage of completion: 100% and merged

Merged into something that will probably be 0.110

Detailed Description

Both individual users and deployments need to be able to set a proxy for Sugar and activities to use. While we'd like the system to work that all out automatically (e.g. using WPAD), this often isn't possible. Common reasons include legacy ("inherited") setups and network uplinks being out of control of the user.

The existing Network Control Panel is enhanced by adding a new section for the proxy settings. For consistency between Sugar and Gnome, the basic layout of the Gnome 3 proxy settings has been mirrored: A combo box allows the user to select how the proxy setting should be determined (None=no proxy settings, Use system proxy=let proxy be set by other means, Automatic=WPAD or PAC, Manual=enter host names and ports for each protocol). Based on which method was selected, additional configuration options are presented to the user.

The settings are stored in 'GSettings' and passed to activities using the 'http_proxy' and similar variables.

Benefit to Sugar

Widens the environment where Sugar may be used, by removing a reason why Sugar cannot be used in managed information technology environments.

Scope

Modifying the existing Network Control Panel.

"Manual" mode

  • Fill in the settings "manually", and restart when prompted so.
Manual1-proxy.png


  • Now open "www.google.com" shoud open.
Google-proxy.png


Automatic mode - PAC

  • Fill in the URL of the proxy-file, and restart when prompted so.
Auto-proxy.png


  • Now open "www.google.com" shoud open.
Google-proxy.png



Automatic mode - WPAD

  • Motive
    • To provide proxy-configuration, without needing the client-user
      • to manualyy enter the proxy-settings (Manual mode)
      • to manually enter the location of proxy-configuration file herself (Automatic (PAC) mode).


  • Benefits
    • By not needing the client-user to manually specify the settings, every client-user is saved a headache :) Instead, all the configuration is done via a network-administrator, on the server-side.
    • By delegating the responsibility of specifying every proxy-rule (even the proxy-configuration file) to the network-administrator, security is increased dramatically.


  • Notes
    • Setting this particular mode (Automatic-WPAD Proxy) is quite complicated; and many possibilities exist. However, the bottom-rule is, client should himself not need to specifiy the location of proxy-configuration file as per say.


  • Testing (one of the possible ways :) )
    • (For those not interested in the technicalities, please proceed to the next bullet :D) To verify that current dextrose-4 supports Auto-WPAD mode, we test using the method, as per the following 4 requirements, as listed at http://en.wikipedia.org/wiki/Web_Proxy_Autodiscovery_Protocol#Requirements ::
      • In order to use the DNS only method, a DNS entry is needed for a host named WPAD.
      • The host at the WPAD address must be able to serve a Web page.
      • In both cases, the Web server must be configured to serve the WPAD file with a MIME type of "application/x-ns-proxy-autoconfig".
      • If the DNS method is used, a file named wpad.dat must be located in the WPAD Web site's root directory.


  • Select "Automatic" mode in "My Settings" -> "Proxy" (without specifying anything else), and restart when prompted so.
Wpad-proxy.png


  • The above step is all that is needed for "Automatic (WPAD)" mode to take effect; the WPAD-configuration-file will be located by the DHCP/DNS Server. However, for easy QA testing, we specify an easy way to replicate this DNS behavior ::
    • Add the line "build.activitycentral.com wpad" to the file "/etc/hosts" on the XO, and reboot. It is repeated innumerable times, that this step is required just for easy testing; in actual deployments, the DNS-name resolution will be provided by network-administrators/School-Server-running-DHCPD
    • Also, thanks a ton to Santiago Rodriguez (scollazo@activitycentral.com) for setting up the proxy-configuration-files at build.activitycentral.com.


  • Open "Browse", and type in "www.google.com". You should be prompted for credentials (suppose as required by the WPAD-configuration-file)
Proxy2.png


  • Entering wrong credentials in the previous step, re-prompts :). This time, enter correct credentials.
Proxy3.png


  • The page opens successfully.
Google-proxy.png

Settings verification

The proxy settings entered by user are verified before saving to prevent accidental change in proxy settings.

  • For "manual" type the proxy host addresses are pinged to check for their existence.
  • For "auto" type the existence of the *.pac file is checked.

If the above verification fails then the user is prompted with an alert message and option to either "Break the Internet connection" or "Reset".

  • Manual proxy verification failed:
Manual-proxy-error.png
  • Auto proxy verification failed:
Auto-proxy-error.png

User Experience

See UI Design

Dependencies

There are no new dependencies.

Contingency Plan

Users can continue to use the Gnome Control Center to configure proxy settings.

Documentation

There is no documentation beyond this page.

Release Notes

There have been no changes to public API. The Release Notes merely need to mention that users can now configure proxy settings from within Sugar. As detailed above, the UI is very similar to the Gnome UI.

Comments and Discussion