wsfederation/plugins/DefaultAccountMapper.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * opensso/legal/CDDLv1.0.txt
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * at opensso/legal/CDDLv1.0.txt.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: DefaultAccountMapper.java,v 1.5 2009/10/28 23:58:59 exu Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.wsfederation.plugins;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.assertion.NameIdentifier;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.NameIDInfoKey;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Constants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.jaxb.entityconfig.BaseConfigType;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.key.KeyUtil;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.meta.WSFederationMetaException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.meta.WSFederationMetaUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.common.AccountUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.ResourceBundle;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.Map;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.HashMap;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.HashSet;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport java.util.List;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.debug.Debug;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.plugin.datastore.DataStoreProvider;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.xmlsig.KeyProvider;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.common.WSFederationException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.wsfederation.common.WSFederationUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class <code>DefaultAccountMapper</code> is a base class extended by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>DefaultSPAccountMapper</code> and <code>DefaultIDPAccountMapper</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class implements the common interface
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * methods that are required for the SP and IDP account mappers and also
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * provide some utility classes that can be shared between those mappers.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class DefaultAccountMapper {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static Debug debug = WSFederationUtils.debug;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static ResourceBundle bundle = WSFederationUtils.bundle;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static DataStoreProvider dsProvider = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static final String IDP = SAML2Constants.IDP_ROLE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static final String SP = SAML2Constants.SP_ROLE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected String role = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     protected static KeyProvider keyProvider =
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         KeyUtil.getKeyProviderInstance();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     static {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             dsProvider = WSFederationUtils.dsProvider;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         } catch (Exception se) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             debug.error("DefaultAccountMapper.static intialization " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             "failed", se);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             throw new ExceptionInInitializerError(se);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      * Default constructor
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster      */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     public DefaultAccountMapper() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         debug.message("DefaultAccountMapper.constructor: ");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the <code>NameIDInfoKey</code> key value pair that can
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * be used for searching the user.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param nameID <code>NameID</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param hostEntityID hosted <code>EntityID</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param remoteEntityID remote <code>EntityID</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @exception <code>WSFederationException</code> if any failure.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected Map getSearchParameters(NameIdentifier nameID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         String realm, String hostEntityID, String remoteEntityID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         throws WSFederationException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         if(nameID == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new WSFederationException(bundle.getString(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                  "nullNameID"));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         NameIDInfoKey infoKey = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         try
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             infoKey = new NameIDInfoKey(nameID.getName(), hostEntityID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                 remoteEntityID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         catch (SAML2Exception se)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster             throw new WSFederationException(se);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         HashSet set = new HashSet();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         set.add(infoKey.toValueString());
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         Map keyMap = new HashMap();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         keyMap.put(AccountUtils.getNameIDInfoKeyAttribute(), set);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         if(debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            debug.message("DefaultAccountMapper.getNameIDKeyMap: " + keyMap);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster         return keyMap;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Returns the attribute value configured in the given entity
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * SP or IDP configuration.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param realm realm name.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param entityID hosted <code>EntityID</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param attributeName name of the attribute.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected String getAttribute(String realm,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster       String entityID, String attributeName) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(realm == null || entityID == null || attributeName == null ) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           if(debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              debug.message("DefaultAccountMapper.getAttribute: " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster              "null input parameters.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster           return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            BaseConfigType config = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(role.equals(IDP)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               config = WSFederationUtils.getMetaManager().getIDPSSOConfig(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                   realm, entityID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               config = WSFederationUtils.getMetaManager().getSPSSOConfig(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                   realm, entityID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            Map attributes  = WSFederationMetaUtils.getAttributes(config);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(attributes == null || attributes.isEmpty()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          debug.message("DefaultAccountMapper.getAttribute:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          " attribute configuration is not defined for " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster          "Entity " + entityID + " realm =" + realm + " role=" + role);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster               return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            List list = (List)attributes.get(attributeName);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(list != null && list.size() > 0) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return (String)list.iterator().next();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        debug.message("DefaultSPAccountMapper.getAttribute: " +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        attributeName + " is not configured.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    } catch (WSFederationMetaException sme) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if(debug.warningEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        debug.warning("DefaultSPAccountMapper.getAttribute:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        "Meta Exception", sme);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}