idpp/plugin/IDPPResourceIDMapper.java

a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 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: IDPPResourceIDMapper.java,v 1.2 2008/06/25 05:47:17 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.liberty.ws.idpp.plugin;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.interfaces.ResourceIDMapper;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.soapbinding.Message;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.liberty.ws.idpp.common.IDPPUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.Base64;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.URLEncDec;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The class <code>IDPPResourceIDMapper</code> is an implementation of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>ResourceIDMapper</code> which is used to map a IDPP
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * user with a user that has been registered with discovery.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class IDPPResourceIDMapper implements ResourceIDMapper {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the resourceID for a user in IDPP service provider
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param providerID Service provider ID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param userID user ID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String resource ID of a user, null if there is an error
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getResourceID(String providerID, String userID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (userID == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getResourceID:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            "null userID");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((providerID == null) || (providerID.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getResourceID:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            "null providerID.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        byte byteResult[] = SAMLUtils.stringToByteArray(userID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String result = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            result = Base64.encode(byteResult).trim();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getResourceID:" , e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String urlEncoded = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (providerID.endsWith("/")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            urlEncoded = providerID + URLEncDec.encode(result);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            urlEncoded = providerID + "/" + URLEncDec.encode(result);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return urlEncoded;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the user ID by decrypting resource id
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param providerID Service Provider ID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param resourceID Resource ID of a user
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String userID by decrypting the resource ID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *                null, if there's any failure
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getUserID(String providerID, String resourceID) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return getUserID(providerID, resourceID, null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Gets the user ID by decrypting resource id
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param providerID Service Provider ID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param resourceID Resource ID of a user
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param message Message of soapbinding
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @return String userID by decrypting the resource ID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *                null, if there's any failure
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public String getUserID(String providerID, String resourceID,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                Message message) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String result = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((resourceID == null) || (providerID == null) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            (providerID.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getUserID:" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            "resourceID or providerID is null");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (!resourceID.startsWith(providerID)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getUserID:resourceID" +
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            " does not startsWith providerID:" + providerID);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        String urlDecoded = null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (providerID.endsWith("/")) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            urlDecoded = URLEncDec.decode(resourceID.substring(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        providerID.length()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } else {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            urlDecoded = URLEncDec.decode(resourceID.substring(
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                                        (providerID+"/").length()));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            result = SAMLUtils.byteArrayToString(Base64.decode(urlDecoded));
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            IDPPUtils.debug.error("IDPPResourceIDMapper.getUserID:",e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            return null;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        return result;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}