federation/message/FSAssertionArtifact.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: FSAssertionArtifact.java,v 1.3 2008/06/25 05:46:43 qcheng Exp $
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * Portions Copyrighted 2014 ForgeRock AS
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpackage com.sun.identity.federation.message;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.IFSConstants;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.message.common.FSMsgException;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.federation.common.FSUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.protocol.AssertionArtifact;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml.common.SAMLUtils;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.shared.encode.Base64;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class represents the <code>AssertionArtifact</code> element in the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SAML</code> protocol schema. Current implementation supports
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * TYPE 1 artifact only. Other type of artifact can be supported by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * extending this class.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna * @deprecated since 12.0.0
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster */
f948ca04a28ccfeed9633bf4b0fb0d2c59c37478David Luna@Deprecated
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterpublic class FSAssertionArtifact extends AssertionArtifact {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Artifact length
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public final static int ARTIFACT_1_LENGTH = 42;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Artifact Type Code 0 Constant
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public final static byte ARTIFACT_1_TYPE_CODE_0 = 0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Artifact Type Code 1 Constant
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public final static byte ARTIFACT_1_TYPE_CODE_1 = 3;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Artifact Type Code Byte Array
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public final static byte[] ARTIFACT_1_TYPE_CODE = {0, 3};
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Default Constructor.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    protected FSAssertionArtifact() {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor to create <code>AssertionArtifact</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param theArtifact is the string that is generated by a provider.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws SAMLException if there is an error decoding
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         the artifact string , the length of the artifact string
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         is incorrect , the <code>TYPE CODE</code> in the artifact
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         or other errors which prevent creation of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *         this object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public FSAssertionArtifact(String theArtifact) throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // check if the input is empty
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((theArtifact == null) || (theArtifact.length() == 0)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.message("FSAssertionArtifact: empty input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // decode the artifact
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        byte raw[] = Base64.decode(theArtifact);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if(raw == null) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("FSAssertionArtifact: decode error");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // check if the length is 42bytes
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if (raw.length != ARTIFACT_1_LENGTH) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("FSAssertionArtifact: the length is"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + " not 42:" + raw.length);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // check if the typecode is correct
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((raw[0] != ARTIFACT_1_TYPE_CODE_0) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                (raw[1] != ARTIFACT_1_TYPE_CODE_1)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.message("FSAssertionArtifact: wrong typecode.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput", null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        typeCode = ARTIFACT_1_TYPE_CODE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        artifact = theArtifact;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        // get the sourceID and assertionHandle
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        byte sBytes[] = new byte[IFSConstants.ART_ID_LENGTH];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        byte aBytes[] = new byte[IFSConstants.ART_ID_LENGTH];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        System.arraycopy(raw, 2, sBytes, 0, IFSConstants.ART_ID_LENGTH);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        System.arraycopy(raw, 22, aBytes, 0, IFSConstants.ART_ID_LENGTH);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sourceID = SAMLUtils.byteArrayToString(sBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        assertionHandle = SAMLUtils.byteArrayToString(aBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    /**
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * Constructor to create <code>FSAssertionArtifact</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     *
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param idBytes the source identifier in the <code>Assertion</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @param handleBytes the assertion identifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     * @throws SAMLException if wrong input or couldn't encode the artifact.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster     */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    public FSAssertionArtifact(byte[] idBytes, byte[] handleBytes)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    throws FSMsgException {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((idBytes == null) || (handleBytes == null)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.message("FSAssertionArtifact: null input.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("nullInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        if ((idBytes.length != IFSConstants.ART_ID_LENGTH) ||
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                (handleBytes.length != IFSConstants.ART_ID_LENGTH)) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            FSUtils.debug.message("FSAssertionArtifact: wrong input length.");
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("wrongInput",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        sourceID = SAMLUtils.byteArrayToString(idBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        assertionHandle = SAMLUtils.byteArrayToString(handleBytes);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        byte raw[] = new byte[42];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        raw[0] = ARTIFACT_1_TYPE_CODE_0;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        raw[1] = ARTIFACT_1_TYPE_CODE_1;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        for (int i = 0; i < IFSConstants.ART_ID_LENGTH; i++) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            raw[2+i] = idBytes[i];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            raw[22+i] = handleBytes[i];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        try {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            artifact = Base64.encode(raw).trim();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        } catch (Exception e) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            if (FSUtils.debug.messageEnabled()) {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                FSUtils.debug.message("FSAssertionArtifact: exception encode"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster                        + " input:", e);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster            throw new FSMsgException("errorCreateArtifact",null);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster        typeCode = ARTIFACT_1_TYPE_CODE;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster    }
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster}