In the Magnify section of the WebFOCUS Administration Console, select Lucene Security. The following image shows the Lucene Security Settings page displaying existing Security plug-ins.

Select New or Modify to open the Lucene Security Plug-in creation and modification page.

The Lucene security options and parameters are: x

Security Plug-in Name

Type a name for the Security plug-in. A Security Plug-in Name binds individual search results to security and provides an alternative name for the Java class name. This field is required and must match the value provided for the SECURITY_PLUGIN field in the index.

x

Java Class Name

Type a name for the Java class. The Java Class Name is the file name of the Java class assigned to the Security Plug-in. The Java class contains functions for authentication, authorization, and alarms. This field is required.

x

Realm Information

Provide instructions to be displayed in the browser for a search when prompting for a user ID and password. All characters except quotation marks and colons are allowed. This field is required and should provide some detail about the type of data for which the user is accessing. In this way, the user knows which credentials are required. It can also contain a warning message.

x

Time to wait for response

Type the time limit in milliseconds to wait for a response. The time limit determines how long Magnify waits for a response before timing out for each Security plug-in. The actual wait time is twice the specified time limit because it is applied independently to both authentication and authorization. This field is required and it must be populated with a positive numeric value. Note that one thousand (1000) milliseconds is equal to one second.

x

Optional parameters

Provide a list of optional parameters that can be passed to the Security plug-in. The Optional parameters are command line statements. This field is optional.

x

Userid

Type a valid user ID. If this field is populated, the user ID is passed to the Security plug-in. This field is optional.

x

Password

Type a valid password. If this field is populated, the password is passed to the Security plug-in. This field is optional.

x

Notification Email Address(es)

Provide one or more email addresses to be used for sending notifications based on the results of the security plug-in alarm. Multiple addresses must be separated by a comma or semi-colon. This field is optional.

x

Reply to Email Address

Provide the email address that notification email recipients can reply to after receiving an email alarm for a Security plug-in. This field is optional.

x

Allowed Failures

Type the number of failure attempts that must occur before Magnify Search:

• Declares that the Security plug-in experienced a catastrophic failure.
• Stops calling the failed Security plug-in until a retry occurs at a fixed time period.
• Suppresses all of the data that the Security plug-in is responsible for authorizing from the search results.

This field is optional and it must be populated with a positive numeric value when provided.

x

Time to wait before retry

Type the number of milliseconds that Magnify Search must wait before retrying the Security plug-in after it has failed the number of times set in the Allowed Failures field. The Security plug-in must be successful on the first retry attempt or the specified wait time goes into effect again. This field is optional and it must be populated with a positive numeric value when provided.

1. In the Magnify section of the WebFOCUS Administration Console, select Lucene Security.
2. Click New at the bottom of the right pane.
3. Specify SimpleSecurity in the Security Plug-in Name input box.
4. Specify ibi.search.securityplugins.SimpleSecurity in the Java Class Name input box.
5. Specify the information to display when the user is prompted for credentials in the Realm Information input box.

   The message should provide the user with information about the system for which they are providing credentials, since each search record can require authentication to a different system. For example, Enter a valid userid and password to access the Century Electronics employee information.

6. Specify the path to the magnify_security.xml file in the Optional parameters input box as follows:

   -passwordfile c:\ibi\WebFOCUS\config\magnify\magnify_security.xml

7. Use the default values for all other configuration parameters. The SimpleSecurity plug-in sample is now configured.

   

Magnify calls the SimpleSecurity plug-in when a user submits a query to the Magnify search application and secure records are retrieved from the Lucene index. Users are prompted as follows:

The following syntax in the SimpleSecurity plug-in uses the Magnify Security API promptForPassword() method to display the authentication dialog box.

private final void promptForPassword(){
  final boolean noAccountCheckbox=this.securitycallback.
        getNoAccountCheckbox(this.realmName);
  if (!noAccountCheckbox)
  {
    this.securitycallback.promptForPasswords(this.realmName);
    this.securitycallback.
         setRealmRequestJSP("search/jsp/passwordPrompt.jsp",
    this.realmName);
  }
}

The following syntax in the SimpleSecurity plug-in uses the Magnify Security API getUserid() method to retrieve authentication information from the browser session:

public String getUserid(){
  return this.userid;
}

public void setUserid(String userid)
{
  this.userid = userid;
}

The user credentials are then verified against the information stored in the magnify_security.xml file as follows:

private final boolean isAuthenticated(final String username,
  final String password, final String SecurityPluginName_param)
{
  final Map <String,NamedNodeMap>
        usernameMap =  getUserNameMap(SecurityPluginName_param);
  if (usernameMap != null && username != null)
  {
    if (usernameMap.containsKey(username))
    {
       final NamedNodeMap attMap=usernameMap.get(username);
       final Node passwordNode=attMap.getNamedItem("password");
       if (passwordNode.getNodeValue().equalsIgnoreCase(password))
       {
         this.rolesSet=new TreeSet<String>();
         final Node rolesNode=attMap.getNamedItem("roles");
         final String rolesString=rolesNode.getNodeValue();
         if (rolesString != null)
         {
           final String [] rolesList=rolesString.split(",");
           final int nRoles=rolesList.length;
             for (int roleIndex=0;roleIndex<nRoles;roleIndex++)
             {
               this.rolesSet.add(rolesList[roleIndex]);
             }
          }
          return true;
       }
     }
  }
  return false;
}