Kony Fabric Sync Console User Guide: Custom Authentication Manager

Custom Authentication Manager

Kony Fabric Sync server supports custom authentication where you can authenticate using the custom code written in Java.

You can use custom authentication manager in the below situations.

Data source has a login web service call that returns authentication token and you need to pass the same authentication token in subsequent web service calls.
To authenticate the user using Single sign on, and OAuth.

To configure custom authentication, follow these steps:

Write the java class by implementing spring com.kony.sync.console.auth.IAuthenticationManager interface.
Bundle the java class with dependent classes in a jar and copy the jar to the <sync.home>/apache-tomcat-7.0.26/webapps/syncconsole/WEB-INF/lib folder. If you also have any other dependent third-party jars, then copy those also to the <sync.home>/apache-tomcat-7.0.26/webapps/syncconsole/WEB-INF/lib folder.
Create an Authentication Profile.
Assign an Authentication Profile to an Application.
Restart Kony Fabric Sync server.
Note: You may have to add syncconsole classes, in classpath of the project to compile your project.
For example, <sync.home>/apache-tomcat-7.0.26/webapps/syncconsole/WEB-INF/classes.

Other Features of Custom Authentication Manager

The other features of Custom Authentication Manager are:

Using the Custom Authentication Manager, you can override the ConfigParam defined under Service/ServiceConfig in the Kony Fabric Sync configuration file.
For example, endpointURL, and userid
You can also put any variable, for example, authentication token in context, and map the same in subsequent web service calls.
For example,
- Use the below code to put the context variable into the context from custom authentication manager
```
ctxParams.put("TOKEN", <token-value>);
```
- Use the below param mapping in the Kony Fabric Sync configuration to take the mapping from the context.
```
<Param Name="token" Source="CONTEXT" SourceValue="TOKEN"/>
```

An Example of SalesForce Authentication Manager

package com.kony.sync.console.auth;

import java.net.URL;
import java.util.HashMap;
import java.util.Map;

import javax.xml.soap.MessageFactory;
import javax.xml.soap.Name;
import javax.xml.soap.SOAPBody;
import javax.xml.soap.SOAPBodyElement;
import javax.xml.soap.SOAPConnection;
import javax.xml.soap.SOAPConnectionFactory;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPFault;
import javax.xml.soap.SOAPMessage;

import org.apache.log4j.Logger;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.AuthenticationException;
import org.springframework.stereotype.Service;
import org.w3c.dom.NodeList;

import com.kony.sync.syncconfig.IConfigConstants.SourceValue;

@Service("salesforceAuthenticationManager")
public class SalesforceAuthenticationManager implements 
IAuthenticationManager {
	
	private static final String SALESFORCE_DUMMY_PASSWORD = 
       "DummySalesforcePassword";
	private static Logger logger = Logger.getLogger
       (SalesforceAuthentication
       Manager.class);
	
	@Override
	public Authentication authenticate(Authentication arg0) throws 
       AuthenticationException {
		SyncAuthentication token = (SyncAuthentication) arg0;
		String userName = token.getPrincipal().toString();
		String password = token.getCredentials().toString();		
		try {
		        Authentication respToken = callLoginService(  
                       userName, password, token);
			return respToken;
		} catch (Exception e) {
			logger.error("Salesforce authentication failed : " + 
                       e,e);
			token.setAuthenticated(false);
		}
		return token;
	}

	private Authentication callLoginService(String userName,
               String password, SyncAuthentication token) throws Exception {
		Map<String, Object> authDetails = token.getAuthContextParams();
		//ConsoleConfigProperties props = ConsoleConfigProperties
                 .getInstance();
		String propURN = authDetails.get("namespace").toString();
               //props.getPropertyValue("salesforce.namespace");
		String URN = (propURN!=null?propURN:"urn:partner
               .soap.sforce.com");
		try {
			//Preparing the SOAP request
			SOAPMessage message = MessageFactory.newInstance()
                       .createMessage();
			SOAPBody body = message.getSOAPBody();
			SOAPEnvelope envelope = message.getSOAPPart()
                       .getEnvelope();
			Name bodyElement = envelope.createName
                      ("login", "urn", URN);
			SOAPBodyElement loginElement = body.addBodyElement
                       (bodyElement);			
			Name user = envelope.createName("username"
                       , "urn", URN);
			loginElement.addChildElement(user).addTextNode
                       (userName);
			Name pass = envelope.createName("password"
                       , "urn", URN);
			loginElement.addChildElement(pass)
                       .addTextNode(password);
			//Setting the login soap action
			message.getMimeHeaders().addHeader("SOAPAction",
                        URN + "/Soap/loginRequest");
			//Connection to invoke the login service
			SOAPConnectionFactory soapConnectionFactory =
                        SOAPConnectionFactory.newInstance();
			SOAPConnection connection =
                        soapConnectionFactory.createConnection();

			String salesforceURL = authDetails.get("url")
                        .toString();//props.getPropertyValue          
                       ("salesforce.url");			
			URL endpoint = new URL(salesforceURL != null 
                       ?salesforceURL:
                       "https://login.salesforce.com/services/Soap/u/25.0");
			SOAPMessage response = 
			connection.call(message, endpoint);
			connection.close();
			//response.writeTo(System.out);
			NodeList nodeList = response.getSOAPBody()
                       .getElementsByTagNameNS(URN, "sessionId");
			if(nodeList.getLength() == 0){
				SOAPFault fault = response.getSOAPBody(
                               ).getFault();
				throw new Exception("Error while Salesforce 
                               Login :" + fault.getFaultString());
			}
			//System.out.println(nodeList
                         .item(0).getTextContent());
			NodeList urlList = response.getSOAPBody()
                       .getElementsByTagNameNS(URN, "serverUrl");
			NodeList emailList = response.getSOAPBody()
                       .getElementsByTagNameNS(URN, "userEmail");
			Map<String, Object> ctxParams = new HashMap
                       <String, Object>();
			//Adding SessionId in context so that webservice 
                         mapping can use for mapping
			ctxParams.put(SourceValue.SESSION_ID.toString(),
                       nodeList.item(0).getTextContent());
			// Overriding the endpoint url by setting the 
                          middleware config parameter
			ctxParams.put("endpointUrl", urlList.item(0)
                       .getTextContent());
			//USER_EMAIL and USER_PASSWORD are used to create 
                         the user in the sync console
			ctxParams.put("USER_EMAIL", emailList.item(0)
                       .getTextContent());
			ctxParams.put("USER_PASSWORD",
                        SALESFORCE_DUMMY_PASSWORD);
			//List<GrantedAuthority> authorityList 
                         = new ArrayList<GrantedAuthority>();
			//authorityList.add(new GrantedAuthorityImpl
                         ("ROLE_USER"));
			//If any context parameters need to pass to   
                        sync services then create the SyncAuthentication instance    			    	
			SyncAuthentication responseToken = 
                       new SyncAuthentication(token.getPrincipal(), 
                       token.getCredentials(), null);
			responseToken.setAuthContextParams(ctxParams);
			return responseToken;
		} catch (Exception e) {
			logger.error(e.getMessage(), e);
			throw e;
		}
	}
}