Alternative Configurations for Microsoft Windows

Copy link to this sectionStarting NSD on Alternative TCP Port

By default, the NSD listens for incoming requests on TCP port 7038. You can override this by starting the service as follows:

CSPnsd –v [port_no]

Or:

CSPnsd –v -p[port_no]

- where port_no is the TCP port number of your choice.

On startup, the NSD creates the following file:

CSPnsd.ini

Typically, this file contains the following lines:

[SYSTEM]
Ip_Address=127.0.0.1
TCP_Port=7038

Copy code to clipboard

In this context, the clients are the Web Gateway modules contained within, or dynamically linked to, the web server and/or the CSP CGI modules invoked by the server. It is, therefore, essential that this file is not deleted or moved. It is also important that the web server processes can read this file. Set the privileges accordingly, bearing in mind the Windows user under which your web server is operating. The NSD clients attempt to find this file in a location contained within the Windows PATH variable. For example:

C:\Windows

The CSPnsd.ini file must be moved to this location before starting the web server

Clearly, storing the NSD port number in the CSPnsd.ini file is inappropriate for situations in which multiple instances of the NSD are running. For Apache servers, there is a much better mechanism for communicating the TCP port number of the NSD to its clients.

Set the following environment variables in the Apache configuration to indicate the address and port of the target NSD installation. The values specified in these environment variables take precedence over any values found in the CSPnsd.ini file.

CSP_NSD_NAME — This is the IP address of the NSD. Only use this parameter if the NSD is operating on a remote computer.

CSP_NSD_PORT — This is the TCP port of the NSD.

Distribute the load for two Apache virtual hosts (say, 123.123.1.1 and 123.123.1.2) between two independent NSD installations (listening on TCP port 7038 and 7039).

Add the following directives to the Apache configuration (httpd.conf):

<VirtualHost 123.123.1.1>
    ServerName 123.123.1.1
    SetEnv CSP_NSD_PORT 7038
</VirtualHost>
<VirtualHost 123.123.1.2>
    ServerName 123.123.1.2
    SetEnv CSP_NSD_PORT 7039
</VirtualHost>

Copy code to clipboard

Distribute the load for two web applications (say, /csp1 and /csp2) between two independent NSD installations (listening on TCP port 7038 and 7039).

1. Add the following directives to the Apache configuration (httpd.conf):

   <Location /csp1>
       SetEnv CSP_NSD_PORT 7038
   </Location>
   <Location /csp2>
       SetEnv CSP_NSD_PORT 7039
   </Location>

   Copy code to clipboard

2. Restart Apache after making changes to its configuration.

In cases where multiple instances of the NSD are running, it is recommended that the separate instances be installed in separate directories, each maintaining its own copy of the configuration and log files (CSP.ini and CSP.log). The Web Gateway Management pages for each instance can easily be accessed by using the NSD internal HTTP server. For example:

http://localhost:7038/csp/bin/Systems/Module.cxw

http://localhost:7039/csp/bin/Systems/Module.cxw

Copy link to this sectionEnabling the ISAPI Extensions

DLLs: CSPms.dll and CSPmsSys.dll

Before these extensions can be used they must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, highlight [MACHINE_NAME] ([machine_name]\[user_name]).

3. In the middle panel, double-click ISAPI and CGI Restrictions.

4. In the right panel, select Add.

5. In the Add ISAPI or CGI Restriction dialogue, enter the following details:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\CSPms.dll

   Description: WebGatewayRunTime

   Allow extension path to execute: Select

   Select OK

Copy link to this sectionMapping the CSP File Extensions

Choose one of the following configuration methods:

1. Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. Follow the file map procedure in the section “Registering Additional File Types with CSP” in this book.

2. Serve static content from the web server. Map only files of type .csp, .cls, .zen, .cxw to the Web Gateway.

If you are serving static files from the web server, map the CSP file extensions to the Web Gateway ISAPI extensions as follows:

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard
   Note:

   This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

3. In the middle panel, double-click the Handler Mappings icon.

4. In the right panel, select Add Script Map.

5. In the Add Script Map dialogue, enter:

   Request Path: *.csp

   Executable: C:\Inetpub\CSPGateway\CSPms.dll

   Name: WebGateway_csp

6. Select Request Restrictions.

   Clear: Invoke handler only if request is mapped to

   Select OK to return to Add Script Map dialogue.

   Select OK.

7. At this point you may be prompted as follows:

   “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

   Select Yes.

   You can later find the list of allowed applications as follows:

   In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

   In the middle panel, double-click ISAPI and CGI Restrictions.

   If the Web Gateway ISAPI components are not included in the list of allowed applications, add them.

   You can add text of your own choice in the Description field. For example:

   WebGatewayManagement for CSPmsSys.dll

   WebGatewayRunTime for CSPms.dll

8. Repeat the above process: Use the Add Script Map dialogue to enter the following two mappings:

   Request Path: *.cls

   Executable: C:\Inetpub\CSPGateway\CSPms.dll

   Name: WebGateway_cls

   Request Path: *.zen

   Executable: C:\Inetpub\CSPGateway\CSPms.dll

   Name: WebGateway_zen

   Request Path: *.cxw

   Executable: C:\Inetpub\CSPGateway\CSPms.dll

   Name: WebGatewayManagement

Copy link to this sectionOperating and Managing the Web Gateway

To access the Web Gateway’s systems management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp/bin/CSPmsSys.dll

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://<ip_address>/csp/samples/menu.csp

If you see an unauthorized user error message, refer to the section “Web Gateway and Security.”

Copy link to this sectionRegistering the Runtime Native Module

DLL: CSPcms.dll

Before this module can be used it must be registered with IIS. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

3. In the middle panel, double-click the Modules icon.

4. In the right panel, select Add Native Module.

5. Select Register and enter the following details in the Register Native Module dialogue:

   Name: CSPcms

   Path: C:\Inetpub\CSPGateway\CSPcms.dll

   Select OK.

6. In the left panel expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard

7. In the right panel, select Add Native Module.

8. In the Add Native Module dialogue select CSPcms then select OK.

Copy link to this sectionEnabling the CGI module for Web Gateway Management

Executable: nph-CSPcgiSys.exe

Before this module can be used it must be registered with IIS as being an Allowed application. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager.

2. In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

4. In the right panel, select Add.

5. In the Add ISAPI or CGI Restriction dialogue, enter:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

   Description: WebGatewayManagement

   Allow extension path to execute: Select

   Select OK.

Copy link to this sectionMapping the CSP File Extensions

Choose one of the following configuration methods:

1. Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application so that the InterSystems IRIS server serves all static files, then follow the file map procedure in the section “Registering Additional File Types with CSP” in this book.

2. Serve static content from the web server.

   Map only files of type .csp, .cls, .zen, .cxw to the Web Gateway.

If you are serving static files from the web server, map the CSP file extensions to the Web Gateway Modules as follows:

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard
   Note:

   This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

3. In the middle panel, double-click the Handler Mappings icon.

4. In the right panel, select Add Module Mapping.

5. In the Add Module Mappings dialogue, enter:

   Request Path: *.csp

   Module: Select CSPcms

   Name: WebGateway_csp

6. Select Request Restrictions.

   Clear: Invoke handler only if request is mapped to

   Select OK to return to the Add Module Mappings dialogue.

   Select OK.

7. Repeat the above process to add the following Module Mappings:

   Request Path: *.cls

   Module: Select CSPcms

   Name: WebGateway_cls

   and

   Request Path: *.zen

   Module: Select CSPcms

   Name: WebGateway_zen

8. In the left panel, highlight the Default Web Site section:

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard

9. In the middle panel, double-click the Handler Mappings icon.

10. In the right panel, select Add Script Map.

11. In the Add Script Map dialogue, enter:

    Request Path: *.cxw

    Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

    Name: WebGatewayManagement

12. Select Request Restrictions.

    Clear: Invoke handler only if request is mapped to

    Select OK to return to the Add Script Map dialogue.

    Select OK.

13. You may be prompted as follows: “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

    Select Yes.

    You can later find the list of allowed applications as follows:

    In the left panel, highlight:

    [MACHINE_NAME] ([machine_name]\[user_name])

    In the center panel, double-click the ISAPI and CGI Restrictions icon.

    If the Web Gateway Management CGI module is not included in the list of allowed applications, add it.

    You can add text of your own choice in the Description field. For example:

    WebGatewayManagement for nph-CSPcgiSys.exe

Copy link to this sectionOperating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

Start the CSP NSD as described in the section, Starting the NSD.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://<ip_address>/csp/samples/menu.csp

If you see an unauthorized user error message, refer to the section Web Gateway and Security.

Copy link to this sectionEnabling the Runtime ISAPI Extension

DLLs: CSPcms.dll

Before this extension can be used it must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, highlight: [MACHINE_NAME] ([machine_name]\[user_name])

3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

4. In the right panel, select Add.

5. In the Add ISAPI or CGI Restriction dialogue, enter:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\CSPcms.dll

   Description: WebGatewayRunTime

   Allow extension path to execute: Select

   Select OK

Copy link to this sectionEnabling the CGI module for Web Gateway Management

Executable: nph-CSPcgiSys.exe

Before this module can be used it must be registered with IIS as being an “Allowed” application. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, highlight: [MACHINE_NAME] ([machine_name]\[user_name])

3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

4. In the right panel, select Add.

5. In the Add ISAPI or CGI Restriction dialogue, enter:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

   Description: WebGatewayManagement

   Allow extension path to execute: Select

   Select OK.

Copy link to this sectionMapping the CSP File Extensions

Choose one of the following configuration methods:

1. Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application in InterSystems IRIS so that the InterSystems IRIS server serves all static files, then follow the file map procedure in the section “Registering Additional File Types with CSP” in this book.

2. Serve static content from the web server.

   Map only files of type .csp, .cls, .zen, .cxw to the Web Gateway.

If you are serving static files from the web server, map the CSP file extensions to the Web Gateway Modules as follows:

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, expand the top level and expand Web Sites. Highlight Default Web Site.

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard
   Note:

   This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

3. In the middle panel, double-click Handler Mappings.

4. In the right panel, select Add Script Map.

5. In the Add Script Map dialogue, enter:

   Request Path: *.csp

   Executable: C:\Inetpub\CSPGateway\CSPcms.dll

   Name: WebGateway_csp

6. Select Request Restrictions.

   Clear: Invoke handler only if request is mapped to

   Select OK to return to the ‘Add Script Map’ dialogue.

   Select OK.

7. At this point you may be prompted as follows:

   “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

   Select Yes.

   You can later find the list of allowed applications as follows:

   In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

   In the middle panel, double-click the ISAPI and CGI Restrictions icon.

   If the Web Gateway ISAPI module is not included in the list of allowed applications, add it.

   You can add text of your own choice in the Description field. For example:

   WebGatewayRunTime for CSPcms.dll

   WebGatewayManagement for nph-CSPcgiSys.exe

8. Repeat the above process: Use the Add Script Map dialogue to enter the following two mappings:

   Request Path: *.cls

   Executable: C:\Inetpub\CSPGateway\CSPcms.dll

   Name: WebGateway_cls

   Request Path: *.zen

   Executable: C:\Inetpub\CSPGateway\CSPcms.dll

   Name: WebGateway_zen

   Request Path: *.cxw

   Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

   Name: WebGatewayManagement

Copy link to this sectionOperating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

1. Start the CSP NSD as described in the section dedicated to this service.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://<ip_address>/csp/samples/menu.csp

If you see an unauthorized user error message, refer to the section “Web Gateway and Security.”

Copy link to this sectionEnabling the CGI Modules

Executables: nph-CSPcgi.exe and nph-CSPmsSys.exe

Before these modules can be used they must be registered with IIS as being “Allowed” applications. This is done in the Internet Information Services (IIS) Manager control panel.

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

3. In the middle panel, double-click the ISAPI and CGI Restrictions icon.

4. In the right panel, select Add.

5. In the Add ISAPI or CGI Restriction dialogue, enter:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

   Description: WebGatewayRunTime

   Allow extension path to execute: Select

   Select OK.

6. Repeat the above steps for nph-CSPcgiSys.exe, entering the following details in the Restrictions dialogue:

   ISAPI or CGI Path: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

   Description: WebGatewayManagement

   Allow extension path to execute: Select

Copy link to this sectionMapping the CSP File Extensions

Choose one of the following configuration methods:

1. Serve all content (including static content) from InterSystems IRIS. Map * to the Web Gateway. If you are configuring the web application in InterSystems IRIS so that the InterSystems IRIS server serves all static files, then follow the file map procedure in the section “Registering Additional File Types with CSP” in this book.

2. Serve static content from the web server.

   Map only files of type .csp, .cls, .zen, .cxw to the Web Gateway.

If you are serving static files from the web server, map the CSP file extensions to the Web Gateway CGI Modules as follows:

1. Open the Internet Information Services (IIS) Manager window.

2. In the left panel expand the top level to reveal the Web Sites section, then the Default Web Site section. Highlight the Default Web Site section:

   [MACHINE_NAME] ([machine_name]\[user_name])
               Web Sites
                       Default Web Site

   Copy code to clipboard
   Note:

   This activates CSP for the whole web site. To restrict the use of CSP to specific virtual sub-directories (such as /csp/) focus control on the appropriate subdirectory (under Default Web Site) before creating the mappings. Repeat the process for each virtual subdirectory from which CSP content is to be served.

3. In the middle panel, double-click the Handler Mappings icon.

4. In the right panel, select Add Script Map.

5. In the Add Script Map dialogue, enter:

   Request Path: *.csp

   Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

   Name:WebGateway_csp

6. Select Request Restrictions.

   Clear: Invoke handler only if request is mapped to

   Select OK to return to the Add Script Map dialogue.

   Select OK.

7. At this point you may be prompted as follows: “Would you like to enable this ISAPI extension? If yes, we add your extension as an “Allowed” entry in the ISAPI and CGI Restrictions list. If the extension already exists we allow it.”

   Select Yes.

8. You can later find the list of allowed applications as follows:

   In the left panel, highlight:

   [MACHINE_NAME] ([machine_name]\[user_name])

   In the middle panel, double-click the ISAPI and CGI Restrictions icon.

   If the Web Gateway CGI components are not included in the list of allowed applications, add them.

   You can add text of your own choice in the Description field. For example:

   WebGatewayManagement for nph-CSPcgiSys.exe

   WebGatewayRunTime for nph-CSPcgi.exe

9. Repeat the above process: Use the Add Script Map dialogue to enter the following two mappings:

   Request Path: *.cls

   Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

   Name: WebGateway_cls

   Request Path: *.zen

   Executable: C:\Inetpub\CSPGateway\nph-CSPcgi.exe

   Name: WebGateway_zen

   Request Path: *.cxw

   Executable: C:\Inetpub\CSPGateway\nph-CSPcgiSys.exe

   Name: WebGatewayManagement

Copy link to this sectionOperating and Managing the Web Gateway

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

1. Start the CSP NSD as described in the section dedicated to this service.

To access the Web Gateway’s Systems Management suite, point your browser at one of the following locations:

http://<ip_address>/csp/bin/Systems/Module.cxw

http://<ip_address>/csp-bin/nph-CSPcgiSys

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://<ip_address>/csp/samples/menu.csp

If you see an unauthorized user error message, refer to the section “Web Gateway and Security”.

Copy link to this sectionRegistering Additional File Types with CSP

Apache API modules always recognize the following reserved file extensions:

.csp .cls .zen .cxw 

Copy code to clipboard

You may have other files that you want to send to CSP for processing. For example, if you need to serve other static files through the Web Gateway or need to access the Management Portal through this web server, add mappings for file types .jpg, .gif, .png, .css, and .js.

You can configure Apache to recognize what files to pass on to CSP in any of the following ways:

• By CSP location directive

• By file extension – CSPFileTypes directive

• By MIME type

Use the CSP directive to request that all files within a certain location be processed by CSP. The following requests that all files and directories under the /csp path be processed by CSP.

<Location /csp>
   CSP On 
   SetHandler csp-handler-sa
</Location> 

Copy code to clipboard

For example, all the following would be sent to CSP for processing:

/csp/ 
/csp/samples/menu.csp 
/csp/sys/ 

Copy code to clipboard

The CSPFileTypes directive works for requests for files that have extensions (such as /csp/menu.csp). It does not work for requests for files that do not have file extensions (such as /csp/menu).

This parameter is processed by the Web Gateway’s Apache modules and can be globally defined at the server definition level (in httpd.conf) or restricted within the definition for a location or directory block.

By file type: The following directive requests that files of type xxx and yyy be processed by CSP.

CSPFileTypes xxx yyy 

Copy code to clipboard

By location: The following requests that files of type xxx and yyy be processed by CSP but only for locations under /csp (including subdirectories, such as /csp/samples and so on).

<Location /csp/> 
   CSPFileTypes xxx yyy
</Location>

Copy code to clipboard

Using the wildcard character, the following requests that all files under path /csp (and /csp/samples and so on) be processed by CSP.

<Location /csp/> 
   CSPFileTypes * 
</Location> 

Copy code to clipboard

In addition to recognizing the file extensions listed above, CSP can also recognize files for the following MIME types:

application/x-csp

Copy code to clipboard

and

text/csp

Copy code to clipboard

For example, to add the file extension xxx to the list of files processed by CSP, use:

LoadModule csp_module_sa /iris/csp/bin/CSPa24.dll
AddType application/x-csp csp cls zen xxx

Copy code to clipboard

One of the problems with using MIME types to associate types of file with CSP is that Apache checks to ensure that the path to the resource (that is, the hosting directory) physically exists, and returns a file not found error if it does not. It does not, however, check to ensure that the file requested physically exists – which is appropriate for resources served by the CSP engine since they are served by InterSystems IRIS and are virtual as far as the web server is concerned. The “By MIME type” approach is therefore only suitable for cases where the application’s path structure can be replicated on the web server.

Copy link to this sectionOperating and Managing the Web Gateway with Apache NSD

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

1. Start the CSP NSD as described in “Operating the NSD”.

2. Restart Apache after making changes to its configuration (httpd.conf).

   The order in which Apache and the NSD are started is unimportant.

3. To access the Web Gateway Management pages, point your browser at one of the following locations:

   http://localhost:<port_no>/csp/bin/Systems/Module.cxw
   http://localhost:<port_no>/csp-bin/nph-CSPcgiSys

   Copy code to clipboard

If you see an Unauthorized User error message, refer to the section on security considerations.

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://localhost:<port_no>/csp/samples/menu.csp

Copy code to clipboard

Copy link to this sectionRegistering additional file types with CSP

To configure additional file types to be processed by the CSP engine, include the new file extension(s) in the list of usual file extensions (.csp, .cls, .zen) to be processed by the CGI module. For example, add them to the following line:

ScriptAliasMatch /*\.([Cc][Ss][Pp]|[Cc][Ll][Ss]|[Zz][En][Nn])$  "C:/iris/csp/bin/nph-CSPcgi.exe"

Copy code to clipboard

If you need to serve other static files through the Web Gateway or need to access the Management Portal through this web server, add mappings for file types .jpg, .gif, .png, .css, and .js.

The following directive can be used to map requests for all files to CSP for a given path.

ScriptAliasMatch ^/csp/*/.* "C:/iris/csp/bin/nph-CSPcgi.exe"

Copy code to clipboard

Therefore, a basic configuration block for mapping requests for all files in the /csp path to CSP would be:

ScriptAliasMatch ^/csp/*/.* "C:/iris/csp/bin/nph-CSPcgi.exe"
<Directory "/iris/csp/bin/">
   AllowOverride None    
   Options None
   Require all granted
</Directory>

Copy code to clipboard

Copy link to this sectionOperating and Managing the Web Gateway with Apache API and NSD

This connectivity option depends on the Web Gateway’s network service daemon (NSD).

1. Start the CSP NSD as described in “Operating the NSD”.

2. Restart Apache after making changes to its configuration (httpd.conf).

   The order in which Apache and the NSD are started is unimportant.

3. To access the Web Gateway Management pages, point your browser at one of the following locations.

   http://localhost:<port_no>/csp/bin/Systems/Module.cxw 
   http://localhost:<port_no>/csp-bin/nph-CSPcgiSys.exe

   Copy code to clipboard

If you see an Unauthorized User error message, refer to the section on security considerations.

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://localhost:<port_no>/csp/samples/menu.csp

Copy code to clipboard

Copy link to this sectionRebuilding the Apache Executable

1. Upgrade the Apache ISAPI module (mod_isapi.c)

   Overwrite the Apache Group’s ISAPI module with the version contained in the CSP distribution:

   C:\Program Files\Apache Group\Apache\src\os\win32\mod_isapi.c

2. Rebuild the Apache executable

   In order to perform this step you need version 5.0 (or later) of the Microsoft C Compiler (Microsoft Visual C++).

   Change to the following directory:

   C:\Program Files\Apache Group\Apache\src\os\win32\mod_isapi.c

   Build Apache with:

   nmake /f Makefile.nt installr INSTDIR=d:\progra~1\apache~1\apache

   Copy code to clipboard

   You can safely ignore the many warning messages that the build process displays.

3. Runtime configuration

   Edit the Apache configuration file httpd.conf. For the standard Apache distribution this file is in:

   C:\Program Files\Apache Group\Apache\conf

   Assuming that you wish to invoke the CSP engine for requested files that contain a .csp, .cls, or .zen extension, add the following section to the end of httpd.conf:

   AddHandler isapi-isa dll
   AddHandler isapi-isa csp
   AddHandler isapi-isa cls
   AddHandler isapi-isa zen
   AddHandler isapi-isa cxw
   Alias /csp/ /iris/csp/
   <Directory "c:/iris/csp">
           AllowOverride None
           Options MultiViews 
   FollowSymLinks ExecCGI
           Require all granted
           <FilesMatch ".(log|ini|pid|exe)$">
                   Require all denied
           </FilesMatch>
   </Directory>
   Alias /csp/bin/Systems/Module.cxw 
   /csp/bin/CSPmsSys.dll
   

   Copy code to clipboard

4. Restart Apache after making changes to httpd.conf.

Copy link to this sectionOperating and Managing the Web Gateway with Apache and ISAPI

To access the Web Gateway Management pages, point your browser at one of the following locations:

http://localhost:<port_no>/csp/bin/Systems/Module.cxw 
http://localhost:<port_no>/csp/bin/CSPmsSys.dll

Copy code to clipboard

If you see an Unauthorized User error message, refer to the section on security considerations.

The CSP engine is automatically invoked for requested files that contain a .csp, .cls, or .zen extension. For example:

http://localhost:<port_no>/csp/samples/menu.csp

Copy code to clipboard

Copy link to this sectionConfiguration for Recommended Option: Apache API Modules (CSPa24.dll)

LoadModule csp_module_sa
    C:/Program Files/Apache Group/Apache/modules/CSPa24.dll
<Location "/csp/bin/Systems/">
    SetHandler csp-handler-sa
</Location>
<Location "/csp/bin/RunTime/">
    SetHandler csp-handler-sa
</Location>
CSPFileTypes csp cls zen cxw

Copy code to clipboard

Copy link to this sectionConfiguration for Atypical Option 2: CGI Modules with NSD (nph-CSPcgi.exe)

<LocationMatch "/*\.([Cc][Ss][Pp]|[Cc][Ll][Ss]|[Zz][En][Nn])$">
AllowOverride None
Options FollowSymLinks ExecCGI
Require all granted
</LocationMatch>
ScriptAliasMatch /csp/bin/Systems/Module.cxw "C:/Program Files/Apache Group/Apache/cgi-bin/nph-CSPcgiSys.exe"
ScriptAliasMatch /csp/bin/RunTime/Module.cxw "C:/Program Files/Apache Group/Apache/cgi-bin/nph-CSPcgi.exe"
ScriptAliasMatch /*\.([Cc][Ss][Pp]|[Cc][Ll][Ss])$ "C:/Program Files/Apache Group/Apache/cgi-bin/nph-CSPcgi.exe"
         

Copy code to clipboard

Copy link to this sectionConfiguration for Atypical Option 3: Apache API Module with NSD (mod_csp24.dll)

LoadModule csp_module
           C:/Program Files/Apache Group/Apache/modules/mod_csp24.dll
<LocationMatch "/*\.([Cc][Ss][Pp]|[Cc][Ll][Ss]|[Zz][En][Nn])$">
    SetHandler csp-handler
</LocationMatch>
ScriptAliasMatch /csp/bin/Systems/Module.cxw "C:/Program Files/Apache Group/Apache/cgi-bin/nph-CSPcgiSys.exe"
ScriptAliasMatch /csp/bin/RunTime/Module.cxw "C:/Program Files/Apache Group/Apache/cgi-bin/nph-CSPcgi.exe"

Copy code to clipboard

Copy link to this sectionConfiguration for Atypical Option 4: ISAPI Modules (CSPms.dll)

Legacy only

AddHandler isapi-isa dll
AddHandler isapi-isa csp
AddHandler isapi-isa cls
AddHandler isapi-isa zen
AddHandler isapi-isa cxw
Alias /csp/bin/Systems/Module.cxw /csp/bin/CSPmsSys.dll

Copy code to clipboard