org.apache.wss4j.dom.message.WSSecSecurityContextToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wss4j-ws-security-dom Show documentation
There is a newer version: 3.0.4
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.wss4j.dom.message;

import org.apache.wss4j.common.crypto.Crypto;
import org.apache.wss4j.common.ext.WSSecurityException;
import org.apache.wss4j.common.derivedKey.ConversationConstants;
import org.apache.wss4j.dom.engine.WSSConfig;
import org.apache.wss4j.dom.message.token.SecurityContextToken;
import org.apache.wss4j.dom.util.WSSecurityUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * Builder class to add a wsc:SecurityContextToken into the
 * wsse:Security
 */
public class WSSecSecurityContextToken {

    /**
     * The wsc:SecurityContextToken to be added to the
     * wsse:SecurityHeader
     */
    private SecurityContextToken sct;

    /**
     * The wsu:Id of the wsc:SecurityContextToken
     */
    private String sctId;

    /**
     * The wsc:Identifier of the
     * wsc:SecurityContextToken
     */
    private String identifier;

    private int wscVersion = ConversationConstants.DEFAULT_VERSION;
    private WSSConfig wssConfig;
    private final WSSecHeader securityHeader;
    private final Document doc;

    public WSSecSecurityContextToken(WSSecHeader securityHeader, WSSConfig config) {
        this.securityHeader = securityHeader;
        if (securityHeader != null && securityHeader.getSecurityHeaderElement() != null) {
            doc = securityHeader.getSecurityHeaderElement().getOwnerDocument();
        } else {
            doc = null;
        }
        wssConfig = config;
    }

    public WSSecSecurityContextToken(Document doc, WSSConfig config) {
        this.securityHeader = null;
        this.doc = doc;
        wssConfig = config;
    }

    public void prepare(Crypto crypto) throws WSSecurityException {

        if (sct == null) {
            if (identifier != null) {
                sct = new SecurityContextToken(wscVersion, doc, identifier);
            } else {
                sct = new SecurityContextToken(wscVersion, doc);
                identifier = sct.getIdentifier();
            }
        }

        // The wsu:Id of the wsc:SecurityContextToken
        if (sctId == null) {
            sctId = getWsConfig().getIdAllocator().createId("sctId-", sct);
        }
        sct.setID(sctId);
    }

    public void prependSCTElementToHeader()
        throws WSSecurityException {
        Element secHeaderElement = securityHeader.getSecurityHeaderElement();
        WSSecurityUtil.prependChildElement(secHeaderElement, sct.getElement());
    }

    /**
     * @return Returns the sct.
     */
    public SecurityContextToken getSct() {
        return sct;
    }

    /**
     * @param sct The sct to set.
     */
    public void setSct(SecurityContextToken sct) {
        this.sct = sct;
    }

    /**
     * @return Returns the identifier.
     */
    public String getIdentifier() {
        return identifier;
    }

    /**
     * @param identifier The identifier to set.
     */
    public void setIdentifier(String identifier) {
        this.identifier = identifier;
    }

    /**
     * @return Returns the sctId.
     */
    public String getSctId() {
        if (sct != null) {
            return sct.getID();
        }
        return sctId;
    }

    /**
     * @param sctId The sctId to set.
     */
    public void setSctId(String sctId) {
        this.sctId = sctId;
    }

    /**
     * @param wscVersion The wscVersion to set.
     */
    public void setWscVersion(int wscVersion) {
        this.wscVersion = wscVersion;
    }

    private WSSConfig getWsConfig() {
        if (wssConfig == null) {
            wssConfig = WSSConfig.getNewInstance();
        }
        return wssConfig;
    }
}