Difference between revisions of "OS4X HTTP Proxy support"

From OS4X
Jump to navigation Jump to search
(New page: == Environmental variables == Proxy support in general is handled by most Unix programs by setting environment variables. These variables are: *<code>HTTP_PROXY</code>: hostname or IP addr...)
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== Why use an http proxy? ==
 +
OS4X needs to update information from online ressources quite often, such as
 +
*TSL download
 +
*CRL download
 +
*CSR transmission
 +
 +
OS4X needs these information up-to-date, otherwise most modern OFTP2 functionalities won't work at all. For this, OS4X needs a working http connection for every online ressource. The URLs needed are dynamic, so there is no absolute definite list of URLs for which OS4X must be allowed to access these ressources.
 +
 
== Environmental variables ==
 
== Environmental variables ==
Proxy support in general is handled by most Unix programs by setting environment variables. These variables are:
+
Proxy support in general is handled by most Unix programs by setting a special environment variable "<code>http_proxy</code>". This variable is build with some parts of information needed. The syntax for this variable is:
*<code>HTTP_PROXY</code>: hostname or IP address of proxy user
+
<protocol>://[<username>:<password>@]<hostname or IP>:<port>
*<code>HTTP_PROXY_PORT</code>: port number the proxy server is listening on
+
 
*<code>HTTP_PROXY_TYPE</code>: type of proxy, valid values:
+
Examples:
**SOCKS4
+
http://proxyuser:proxypwd@proxyserver:3128
**SOCKS5
+
 
**HTTP
+
http://proxyserver:3128
*<code>HTTP_PROXY_USER</code>: username for proxy authentification
+
 
*<code>HTTP_PROXY_PASSWD</code>: password for proxy authentification
 
  
 
== Behaviour in OS4X ==
 
== Behaviour in OS4X ==
If proxy support is disabled, the above variables are overwritten with empty values by all OS4X binaries. In subsequent processes (like event scripts or plugins), these environment share the same variables as the parent processes have. If you need special variable values for the above listed variables, you have to take care about them in your use cases.
+
If proxy support is disabled, the above variable is overwritten with empty values by all OS4X binaries. In subsequent processes (like event scripts or plugins), these environment share the same variables as the parent processes have. If you need special variable values for the above listed variable, you have to take care about them in your use cases.
  
 
If you have [[OS4X_Core_configuration#Use_proxy.3F|enabled proxy support]] in OS4X and [[OS4X_Core_configuration#Use_user_settings.2Fenvironment_variables.3F|enabled usage of these special environmental variables]], OS4X doesn't change these values and doesn't use other definitions for HTTP proxy definitions.
 
If you have [[OS4X_Core_configuration#Use_proxy.3F|enabled proxy support]] in OS4X and [[OS4X_Core_configuration#Use_user_settings.2Fenvironment_variables.3F|enabled usage of these special environmental variables]], OS4X doesn't change these values and doesn't use other definitions for HTTP proxy definitions.
  
If you have [[OS4X_Core_configuration#Use_proxy.3F|enabled proxy support]] in OS4X and [[OS4X_Core_configuration#Use_user_settings.2Fenvironment_variables.3F|disabled usage of these special environmental variables]], OS4X will change eventually set environment variables by setting them to the defined values in the OS4X definition, so it overwrites these variables in all processes.
+
If you have [[OS4X_Core_configuration#Use_proxy.3F|enabled proxy support]] in OS4X and [[OS4X_Core_configuration#Use_user_settings.2Fenvironment_variables.3F|disabled usage of these special environmental variables]], OS4X will change eventually set environment variables by setting them to the defined values in the OS4X definition, so it overwrites these variables in all processes. This environment variable is also available in all subsequent processes, like event scripts.

Latest revision as of 12:42, 12 July 2016

Why use an http proxy?

OS4X needs to update information from online ressources quite often, such as

  • TSL download
  • CRL download
  • CSR transmission

OS4X needs these information up-to-date, otherwise most modern OFTP2 functionalities won't work at all. For this, OS4X needs a working http connection for every online ressource. The URLs needed are dynamic, so there is no absolute definite list of URLs for which OS4X must be allowed to access these ressources.

Environmental variables

Proxy support in general is handled by most Unix programs by setting a special environment variable "http_proxy". This variable is build with some parts of information needed. The syntax for this variable is:

<protocol>://[<username>:<password>@]<hostname or IP>:<port>

Examples:

http://proxyuser:proxypwd@proxyserver:3128
http://proxyserver:3128


Behaviour in OS4X

If proxy support is disabled, the above variable is overwritten with empty values by all OS4X binaries. In subsequent processes (like event scripts or plugins), these environment share the same variables as the parent processes have. If you need special variable values for the above listed variable, you have to take care about them in your use cases.

If you have enabled proxy support in OS4X and enabled usage of these special environmental variables, OS4X doesn't change these values and doesn't use other definitions for HTTP proxy definitions.

If you have enabled proxy support in OS4X and disabled usage of these special environmental variables, OS4X will change eventually set environment variables by setting them to the defined values in the OS4X definition, so it overwrites these variables in all processes. This environment variable is also available in all subsequent processes, like event scripts.