Novell BorderManager 3.9 VPN Client for Windows Readme

April 05, 2007
1.0 Introduction
2.0 Features
2.1 XAuth Authentication Mode
2.2 X.509 Certificate Authentication Mode
2.2.1 Certificate Retrieval
2.2.2 Local Policy
2.3 NMAS Authentication Mode
2.4 NMAS LDAP Authentication Mode
2.5 Backward Compatibility Mode
2.6 Pre-Shared Authentication Mode
2.7 Xauth PSK Mode
2.8 Xauth Hybrid Mode
2.9 VPN Client Integrated with the Novell Client
2.10 All VPN Clients for Windows Platforms Use NICI for Encryption
2.10.1 NICI Versions
2.11 Selecting Dial-Up Entries
2.12 Automatic Creation of a Novell VPN Dial-Up Entry
2.13 Password Expiry Notice
2.14 Policy
2.15 Silent Install
2.16 Client Configuration Distribution
3.0 Issues Fixed in Version 3.9
4.0 Known Issues and Limitations
5.0 Documentation
6.0 Documentation Conventions
7.0 Document Updates
8.0 Legal Notices


1.0 Introduction

The Novell® BorderManager® Virtual Private Network (VPN) client software allows a workstation to communicate securely over the Internet to a network protected by a Novell VPN server.


2.0 Features

Following is the list of new features for Novell BorderManager 3.9 VPN client for Windows*:


2.1 XAuth Authentication Mode

Client changes: Hybrid and pre-shared key in the xauth mode of authentication are supported in the client.

Client GUI changes: Drop-down boxes have replaced the radio buttons used for selecting the authentication mode.


2.2 X.509 Certificate Authentication Mode

The Novell BorderManager 3.9 VPN Client provides the user with an X.509 certificate to perform the IKE main mode of authentication. The certificate should be copied to the local workstation (<drive>:\novell\vpnc\certificates\users) from which the VPN software is to be executed.


2.2.1 Certificate Retrieval

The VPN client supports using IP address of the server instead of the tree name for Certificate retrieval. It uses LDAP for certificate retrieval so that there is no client dependency.


2.2.2 Local Policy

In the X.509 and XAuth modes of authentication, the user can provide IKE and IPSEC parameters by clicking the policy editor on the VPN tab.


2.3 NMAS Authentication Mode

The Novell VPN client is integrated with Novell Modular Authentication Services (NMASTM). NMAS works with the Novell Client. Install the Novell Client to benefit from the NMAS functionality.

Select the NMAS option in the Configuration tab and provide NMAS user information and credentials in the eDirectory tab. In the VPN tab, provide the VPN server IP address and NMAS sequence (for example, NDS/eDirectory, Universal Smart Card, Simple Password).


2.4 NMAS LDAP Authentication Mode

Select NMAS, then select the LDAP box on the Configuration tab. Go to the VPN tab and specify the VPN server IP address and LDAP user DN (for example, CN=Admin,O=Novell). The LDAP method displays a dialog box for the credential.


2.5 Backward Compatibility Mode

Select the Backward Compatibility mode on the Configuration tab. Provide eDirectory credentials in the eDirectory tab. In this mode, the Novell BorderManager 3.9 client can talk to the Novell BorderManager 3.8. The ActiveCard token authentication is enabled if NMAS is installed on the client. The ActiveCard token authentication method works if the ActiveCard token method is configured for the user in eDirectory. The VPN tab requires credentials for ActiveCard token method.


2.6 Pre-Shared Authentication Mode

Select Pre-shared Authentication mode on the Configuration tab. Go to the VPN tab and provide password for the pre-shared key configured in the VPN server.


2.7 Xauth PSK Mode

Provide the VPN server IP address, username, password and the pre-shared key. The username is in full DN name format. For example, user3.novlcontext.

The pre-shared key is used for IKE phase1 authentication. The same pre-shared key should also be configured on the server.

NOTE:  While connecting to the Novell BorderManager Server, use the policy editor to put the IKE mode in main mode along with PFS=yes.


2.8 Xauth Hybrid Mode

Provide the VPN server IP address, username, and password. The user must copy the trusted root certificate corresponding to the server.

NOTE:  Xauth Hybrid mode is supported in aggressive mode only. This is enabled in the policy editor.


2.9 VPN Client Integrated with the Novell Client

This version of the Novell VPN Client can integrate with the Novell Client for Windows 98, Windows NT, Windows 2000, Windows XP Professional or Windows XP Home. Re-start the machine after installing the new VPN client. During re-start, the VPN client integrates with the Novell Client. After the system comes up, the Novell Login screen has a Location drop-down list. The list contains the default entry as well an entry for the VPN capabilities. You can select any of the locations, depending on the operation to be performed.

Four new tabs are available that can be configured in a Service Instance by selecting Novell Client32 Properties. The four tabs do the following:

  • Configuration: Provides the authentication mechanism for VPN client as well as dial-up, Novell login, the IPX option and launcher to launch application after VPN connection.
  • VPN: Provides credentials for the authentication type selected on the Configuration tab.
  • Dial-Up: Performs dial-up operations. This tab appears on the configuration tab if dial-up is enabled.
  • VPN Status: Displays the status of the VPN dial-up and authentication.

The Novell Client 4.91 and later updates the NMAS Client to version 3.0. If the VPN Client is installed after Novell Client installation and you choose to install the NMAS Client at that time, NMAS does not work with the Novell Client 4.91. To use the Novell Client 4.91, do one of the following:

  • Do not choose to install the NMAS Client while installing the VPN Client. This retains the latest version of NMAS Client.
  • First install the Novell VPN Client, then install the Novell Client 4.9 SP1 or later.


2.10 All VPN Clients for Windows Platforms Use NICI for Encryption

This version of the VPN client for Windows 98, Windows NT, Windows 2000, and Windows XP uses NICI (128-bit) encryption because there is no export restriction with NICI.


2.10.1 NICI Versions

The VPN client requires "kernel NICI" (NICI 1.7.0) for the cryptographic requirements of the kernel module vptunnel.sys and "user NICI" (NICI 2.6.0) for the cryptographic requirements of user-space modules such as ikeapp.exe and vpnlogin.exe. If NICI 1.7.0 (128-bit version) is not installed, the VPN Setup program installs it. This version of NICI overwrites NICI 1.5.7 (56-bit) or NICI 1.5.3 (56/128-bit), but not NICI 2.6.0. If NICI 2.6.0 is installed, NICI 1.7.0 and 2.6.0 will co-exist.


2.11 Selecting Dial-Up Entries

On Windows 98 and Windows Me, you can select a dial-up entry of any server type. Previously (with Novell BorderManager Enterprise Edition 3.0), you could only select dial-up entries of type Novell Virtual Private Network. All entries must be configured to negotiate only for TCP/IP connections. If you want to invoke the VPN client from Dial-Up Networking instead of vpnlogin.exe, then the dial-up entry that you select from Dial-Up Networking must be of server type Novell Virtual Private Network; otherwise, vpnlogin.exe is not spawned after the dial-up connection has been established.

On Windows NT, you can select a dial-up entry of any server type. There is no Novell Virtual Private Network server type in the Dial-Up Networking selection on Windows NT.

If there is a dial-up requirement, install dial-up networking before installing the VPN client.

When you make your dial-up entry selection from VPNLogin.exe, choose entries that do not enable Point-to-Point Protocol (PPP) compression. Compressing data that has been encrypted incurs unnecessary CPU overhead and does not offer any savings in the size of the packets being sent.

Install the modem, then install the VPN Client.


2.12 Automatic Creation of a Novell VPN Dial-Up Entry

During VPN client installation, if you choose to use Dial-Up Networking, the VPN client installation creates a Novell VPN dial-up entry for you.


2.13 Password Expiry Notice

During VPN Client login, the eDirectory user is notified if the user's eDirectory password has expired and grace logins are being used. The user is also be given an option to change the eDirectory password during VPN Client login. This option is also provided on the VPN Client system tray icon. The user see the change password option only if he or she is using eDirectory credentials for VPN/NetWare login from the VPN Client application. Change password will fail in the case of contextless login. It requires all eDirectory user credentials.


2.14 Policy

The policy (traffic rule) specified by the administrator in eDirectory is applied on the client. If a policy is changed for that particular VPN user while a VPN session is active, the changes are not be reflected until the next session.


2.15 Silent Install

The silent install feature allows the installation to be completed without user input. If the Dial-Up option is selected, some user intervention might be required if the workstation does not have the Dial-Up Networking or RAS components.

To use this feature, run setup.exe with a switch to create a response file that contains the answers to all the questions normally asked during installation. Because this includes selection of the dial-up client, the LAN client, or both, you might need to create multiple response files based on user needs.

After creating the response file, you can then run setup.exe with a different switch to use the response file so that installation requires minimal user intervention. There is also a switch to generate a log file for the silent install. This can be used to verify that the install completed successfully, or to diagnose why the installation failed. Examples on how to use these switches are given in the procedure below.

You might often need to do a silent install on workstations that have different versions of Windows. If Windows or the Novell Client was installed from CD, then the VPN client install asks for those installation CDs. In this situation, the responses to the install prompts will depend on the version of Windows that is installed, so it is best to create a response file that queries the user for these installation CDs if needed.

To create this kind of a response file:

  1. Perform a normal install of the VPN client without creating the response file. This installation might ask for the Windows and/or Novell Client CDs. Proceed normally through the installation.

  2. After rebooting, run setup.exe again, this time creating the response file. This re-install will not query for the Windows or Novell Client install CDs, so the generated response file does not know what to answer when the user installation asks for the Windows or Novell Client CD. Because there is no answer in the response file, the user will be queried for the Windows or Novell Client CDs if they are needed.

    To verify that the response file is working properly, run the installation in the silent mode on a workstation that does not have the VPN client installed. The install log file should show ResultCode=0.

    The silent install feature only works with the setup.exe under the disk1 directory. It does not work with the self-extracting exe. The silent install feature is enabled by executing setup.exe under the disk1 directory with certain command line options.The available options for setup.exe are:

    -r - Run the installation and capture the response.
    -s - Run the installation in the silent mode.

    Depending on which of the two options is being used, the -f1 and -f2 options might also be used to specify filenames.

To use the silent install feature:

  1. Create a response file by issuing the following command from disk1 of the VPN client disks:

    setup.exe -r -f1"<RESPONSE_FILE>"

    where <RESPONSE_FILE> contains the absolute path and name of the response file. The-f1"<RESPONSE_FILE>" option can be omitted, in which case a response file named setup.iss is created in the Windows or WinNT directory.

    For example,

    setup.exe -r -f1"c:\temp\setup.iss" executes the installation and saves the input to c:\temp\setup.iss

    When using the -f1 and -f2 switches, do not put a space before the quotation marks. For example: -f1 "filename" will not work. -f1 "filename" will work.

  2. Execute the installation based on previously captured input by issuing the following command from disk1 of the VPN client disks.

    setup.exe -s -f1"<RESPONSE_FILE>" -f2"<LOG_FILE>"

    where <RESPONSE_FILE> contains the absolute path and name of response file, and <LOG_FILE> contains the absolute path and name of log file.

    For example, setup.exe -s -f1"c:\temp\setup.iss" -f2".\setup.log" executes the installation, taking input from setup.iss in the c:\temp directory, and records the result in the file setup.log in the same directory as setup.exe.

  3. Verify that the silent install was successful by checking the contents of setup.log. You should see a result section with the following:

    [ResponseResult]

    ResultCode=0

    A value of 0 for ResultCode indicates that installation was successful. A nonzero value indicates failure. The possible ResultCode values are:

    0 Success.
    -1 General error.
    -2 Invalid mode.
    -3 Required data not found in the SETUP.ISS file.
    -4 Not enough memory available.
    -5 File does not exist.
    -6 Cannot write to the response file.
    -7 Unable to write to the log file.
    -8 Invalid path to the InstallShield Silent response file.
    -9 Not a valid list type (string or number).
    -10 Data type is invalid.
    -11 Unknown error during setup.
    -12 Dialog boxes are out of order.
    -51 Cannot create the specified folder.
    -52 Cannot access the specified file or folder.
    -53 Invalid option selected.

    The most common installation error code seen is -12. An error condition usually displays an error message dialog box requiring user input, such as Click OK to acknowledge the error. Because the response is not in the response file, the silent install process assumes that the response file has the dialog boxes out of order and reports error -12.

    A batch file can be used to further automate the silent install process. For example, you could create the following install.bat in the DISK1 subdirectory: setup.exe -s -f1"c:\vpninst\disk1\response.txt" -f2"c:\temp\vpninst.log" rem. This assumes that the VPN client has been extracted to c:\vpninst. rem. It could be on a network drive, or somewhere else. Don't put a space between -f1 and the quotation mark. If the VPN Login icon shows up on your desktop, reboot, and the VPN client installation is finished.


2.16 Client Configuration Distribution

If you have a file named vpnconfig.txt in your VPN client installation directory Disk1, the installation program will take VPN server addresses, authentication mode, NetWare server IP address, NMAS sequences, eDirectory context, whether to enable eDirectory login or not, and so forth from this file. The program will then update them into the workstation's Registry.

A sample vpnconfig.txt file is included on Disk1. You can modify this file according to your corporate requirements.


3.0 Issues Fixed in Version 3.9

  1. During the first instance of VPN dial-up connection, traffic now goes through VPN client.
  2. A server does not disconnect a VPN client after seven hours.
  3. A dial-up connection is not broken if the VPN connection is already up and NWClient is launched from systray.
  4. DNS resolution now works in French environment.
  5. Windows no longer crashes on Dell D820 laptop while transferring large files using FTP.
  6. VPN dial-up connection window no longer crashes while logging in through NetWare GINA if the username or the password given is wrong.
  7. The VPN Client throws a proper error message when the server runs out of IP addresses in the pool.
  8. DNS information is now updated if you attempt a VPN connection using the Novell Client at the time of initial Windows login.
  9. When you shut down Windows XP SP2 laptop with the VPN client connected, the VPN client no longer gives an error in the net.exe.
  10. The Use My Policy check box is now functional in Novell BorderManager VPN client.
  11. VPN login no longer fails if you use an internal modem.
  12. A dial-up connection now works when the Novell Client is used for VPN login.
  13. Novell BorderManager VPN Client can now connect to a BorderManager server with eDirectory 8.8.
  14. A list of commonly used methods/choices for NMAS authentication is provided.
  15. Support was added for Windows 2003.
  16. A DNS server address pushed to VPN client, is now be updated into the DNS Registry.
  17. When the system goes to hibernation/standby mode, VPN client now disconnects automatically.
  18. A silent install of the VPN Client shows messages about the status of the software install at any point in time.
  19. If client is getting DA details from the server, and if you reboot the workstation via ACPI or it crashes, the pushed DA no longer stays in the client configuration and old DA details are not restored.
  20. A user that was originally created on DS 7.x no longer fails when trying to connect with Client-to-Site VPN when backward compatibility mode fails with an error.
  21. The VPN client does now saves the dial-up password.
  22. The VPN client now provides an option to retrieve supported NMAS methods from the server.
  23. If the user chooses to shut down the client machine after connecting, IPCONFIG error no longer occurs and the Socket Notification Sink Error is not displayed.
  24. If you use the VPN location profile in the Novell Client, by default the cursor now displays in the correct field (username/password).
  25. The IKE NAT Keep-alive time-out is now 60 seconds. This can be modified (in seconds) in Windows Registry > HKLM\Software\Novell\VPN\Current > create a key IKE NAT KeepAlive Time > set the desired value.
  26. The error messages displayed for failures during NMAS authentication are now correct.
  27. FTP no longer fails on Windows XP Professional SP2 when the VPN connection is up.
  28. Dial-in notification issue fixed with the UMTS Dial Up adapter.


4.0 Known Issues and Limitations

  1. IPX support through the VPN client on Windows 2000 and Windows XP, XP Home edition, and Windows Me is not available.
  2. If you are upgrading the machine and you already have the VPN client 3.7 or earlier installed, you must remove that VPN client software from your workstation and then upgrade to the new OS. After upgrading, install the VPN client again.
  3. Restricted Users on Windows 2000 and Windows XP are unable to use the VPN client because these users do not have privileges to update the KEY_LOCAL_MACHINE section of the Registry. Standard Users and Administrators can use the VPN client.
  4. The Novell IP Gateway client cannot be used with the VPN client. Disable the client from using its Novell IP Gateway component before you dial in to a VPN with the VPN client software. You can disable the client's gateway component from the Network Neighborhood Properties selection.
  5. If your VPN server is behind a firewall, you must configure the firewall to allow the following traffic through (inbound and outbound):
    TCP port 353
    UDP port 353
    UDP port 2010
    UDP Port 500
    UDP Port 4500
    IP protocol ID 57
    IP protocol ID 50
    IP protocol ID 51

    If your VPN server is your firewall, then the exception filters are already configured to allow this traffic to pass through. Filters need to be updated during VPN configuration.

  6. If you use the VPN client with the Novell Client, you must log out from NetWare before disconnecting from the VPN server, regardless of whether you are using an IP-only or IP and IPX VPN connection. Otherwise, your NetWare connections are not cleaned up and you might reach your concurrent login limit after several attempts at using the VPN.
  7. Clearance support is not provided for NMAS authentication.
  8. NMAS 2.3.2 does not work on Windows Me. If you need NMAS, install NMAS 2.1 manually and proceed.
  9. Support for Novell NDS Login to the server and changing password is not available because the Novell Client is not supported on Windows Me.
  10. If the VPN client is installed before the Novell Client, it does not integrate with the Novell Client. If this has happens run regvpn from the WINSYS directory.
  11. If the NMAS sequence in the Novell Client is different from the NMAS sequence in the VPN client, you might not be able to log in to the NetWare server from the VPN client.
  12. Novell login from the VPN client to the NetWare server takes place only if both the VPN server and the NetWare server are on the same tree.
  13. If Kernel NICI 1.7.0 is already installed on a Windows 98 workstation, we recommend that you uninstall Kernel NICI 1.7.0 before installing the VPN client.
  14. In NMAS 2.3.2 the USC method of authentication might not work. The workaround is to delete the windows registry setting local/machine/software/Novell/NMAS/1.0/IDIDDLLPath. Once this registry setting is changed, the user ID from the card is not used and the user is asked for the user ID.
  15. A VPN client and the Nortel Contivity VPN client (NOMAD2.1) cannot co-exist in a workstation. If you try to install both in the same machine, the workstation might lose the IP configuration or any one of the clients might not uninstall properly.
  16. A VPN client silent install from a mapped drive or Novell Application Launcher (NAL) might not work. Copy the DISK1 folder to the local machine and run it locally. Or, package the DISK1 folder using InstallShield or Winzip, and then run it from a mapped drive or NAL.
  17. The VPN client change password functionality might not work with Novell Client 4.9 and above.
  18. At the time of login to the VPN server, the client processor utilization might go up to 100 percent, and if the processor is already at 80 to 90% utilization the VPN authentication might fail.
  19. The client machine stops responding to other packets during authentication to the VPN server, even if the VPN server is down.
  20. The VPN Client does not rekey in XAUTH mode with other third-party servers like Openswan. You should set a high rekey time for IKE SA in the VPN Client.


5.0 Documentation

Refer the following documents for detailed information on Novell BorderManager 3.9 at the the Novell Documentation Web site:


6.0 Documentation Conventions

In this documentation, a greater-than symbol (>) is used to separate actions within a step and items in a cross-reference path.


7.0 Document Updates

For the latest documentation and Readme on Novell BorderManager 3.9 VPN client on Linux, see the Novell Documentation Web site.


8.0 Legal Notices

Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time, without obligation to notify any person or entity of such revisions or changes.

Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc. reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to notify any person or entity of such changes.

Any products or technical information provided under this Agreement may be subject to U.S. export controls and the trade laws of other countries. You agree to comply with all export control regulations and to obtain any required licenses or classification to export, re-export, or import deliverables. You agree not to export or re-export to entities on the current U.S. export exclusion lists or to any embargoed or terrorist countries as specified in the U.S. export laws. You agree to not use deliverables for prohibited nuclear, missile, or chemical biological weaponry end uses. See the Novell International Trade Services Web page for more information on exporting Novell software. Novell assumes no responsibility for your failure to obtain any necessary export approvals.

Copyright © 1997-2007 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied, stored on a retrieval system, or transmitted without the express written consent of the publisher. Novell, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed on the Novell Legal Patents Web page and one or more additional patents or pending patent applications in the U.S. and in other countries.

For Novell trademarks, see the Novell Trademark and Service Mark list.

All third-party trademarks are the property of their respective owners.