Custom SSO Image Set Guidelines

It is possible to add your own SSO image set to customize the look and feel of the login form. The custom SSO image set must be in the format of a .tar file. Template .tar files are available from here: Single Sign-On Custom Images. There is one template for regular login forms and one for dual factor authentication.

After you download the file, you must unzip it before you can upload it to the LoadMaster.

These templates can be modified to gain the desired look and feel. Guidelines on the tar file are below:

• The .tar file should have the following folder structure:

imagesets/

<IMAGESETNAME>/

lm_initial.html

lm_logout.html

MANIFEST

…

lm_initial.html: The lm_initial.html is a dummy ESP login page which you can modify or use as is. This page will be presented for authentication when you connect to the ESP Virtual Service. The public/private option becomes available on the ESP login page if Display Public/Private Option is enabled. By default, this option is enabled.

lm_logout.html: The lm_logout.html is a dummy ESP logout page which you can modify or use as is. This page prompts when you successfully log out from ESP service.

• Multiple image sets can be included:
  • imagesets/<IMAGESETNAME_1>/<files>

    /<IMAGESETNAME_2>/<files>

  • The name that you specify as <IMAGESETNAME_*> is the name that will appear in the SSO Image Set drop-down list in the WUI. This name can contain Unicode characters.
    Note: If the name of the custom SSO image set is the same as one of the default SSO image set names, the default one has precedence.

• All image set resources should contain non-encoded characters, that is, ASCII.
• The full list of required files for the image set is as follows:

  

  • A file called MANIFEST is mandatory. This file should contain a list of files that exist in the directory that should be loaded as part of the set. If the MANIFEST file does not exist, the image set will not work. Lines in this file can be commented out by adding # to the start of the line. Blank lines are ignored. The last line of the MANIFEST file must be a new line.
  • The first uncommented line should contain the file for the main login page
  • The second uncommented line should contain the file for the logout page
  • All other files defined in the file, for example image, CSS or Javascript files, can be used by the login and logout pages
  • If a listed file is missing, it will simply not be present on the page. For example, if a line in the MANIFEST refers to image.jpg and that image file is missing from the tar, it will be a broken image on the page.
    Note: The logical format of the main login page cannot be changed. If the format is not maintained, problems will occur. The formatting and any CSS can be changed at will.

  

  

• A file called INFO is read. This is a simple text file which contains a description of the image set and perhaps a version number. The contents of this file are displayed on the admin WUI to help identify which package/version has been installed. For example, this could contain version information.

• The maximum size restriction on images is approximately 1 MB. This is dependent on the amount of space on /tmp for storing the file as it is being downloaded. There is also an additional limit for how much space is available on the flash (the 512 MB boot partition). Multiple large image sets can cause problems.
• Image file names can be a maximum of 31 characters long.
• The syntax for adding an image to a custom authentication form is as follows:<img src=URL width=NN height=NN>Replace URL with the URL of the image.Replace NN for width and height with the desired values.
• If a package is installed multiple times, the older packages are overwritten.
• It is the responsibility of the package builder to verify that all components included are valid. A missing file will not be displayed. Broken pages may cause problems.