com.sun.xml.wss.core.reference.KeyIdentifier Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* $Id: KeyIdentifier.java,v 1.2 2010-10-21 15:37:14 snajper Exp $
*/
package com.sun.xml.wss.core.reference;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.xml.soap.SOAPElement;
import jakarta.xml.soap.SOAPException;
import org.w3c.dom.Document;
import com.sun.xml.wss.logging.LogDomainConstants;
import com.sun.xml.wss.impl.MessageConstants;
import com.sun.xml.wss.core.ReferenceElement;
import com.sun.xml.wss.impl.XMLUtil;
import com.sun.xml.wss.XWSSecurityException;
import org.apache.xml.security.exceptions.Base64DecodingException;
import com.sun.xml.wss.impl.misc.Base64;
/**
* @author Vishal Mahajan
*/
public abstract class KeyIdentifier extends ReferenceElement {
protected static final Logger log =
Logger.getLogger(
LogDomainConstants.WSS_API_DOMAIN,
LogDomainConstants.WSS_API_DOMAIN_BUNDLE);
/**
* Creates an "empty" KeyIdentifier element with default encoding type
* and default value type.
*/
public KeyIdentifier(Document doc) throws XWSSecurityException {
try {
setSOAPElement(
(SOAPElement) doc.createElementNS(
MessageConstants.WSSE_NS,
MessageConstants.WSSE_PREFIX + ":KeyIdentifier"));
} catch (Exception e) {
log.log(Level.SEVERE,
"WSS0750.soap.exception",
new Object[] {"wsse:KeyIdentifier", e.getMessage()});
throw new XWSSecurityException(e);
}
}
/**
* Takes a SOAPElement and checks if it has the right name.
*/
public KeyIdentifier(SOAPElement element) throws XWSSecurityException {
setSOAPElement(element);
if (!(element.getLocalName().equals("KeyIdentifier") &&
XMLUtil.inWsseNS(element))) {
log.log(Level.SEVERE, "WSS0756.invalid.key.identifier", element.getLocalName());
throw new XWSSecurityException("Invalid keyIdentifier passed");
}
}
/**
* If this attr is not present, returns null.
*/
public String getValueType() {
String valueType = getAttribute("ValueType");
if (valueType.equals(""))
return null;
return valueType;
}
public void setValueType(String valueType) {
setAttribute("ValueType", valueType);
}
/**
* If this attr is not present, returns null.
*/
public String getEncodingType() {
String encodingType = getAttribute("EncodingType");
if (encodingType.equals(""))
return null;
return encodingType;
}
public void setEncodingType(String encodingType) {
setAttribute("EncodingType", encodingType);
}
public String getReferenceValue() {
return XMLUtil.getFullTextFromChildren(this);
}
public void setReferenceValue(String encodedValue)
throws XWSSecurityException {
removeContents();
try {
addTextNode(encodedValue);
} catch (SOAPException e) {
log.log(Level.SEVERE,
"WSS0757.error.setting.reference",
e.getMessage());
throw new XWSSecurityException(e);
}
}
/**
* If this attr is not present, returns null.
*/
public String getWsuId() {
String wsuId = getAttribute("wsu:Id");
if (wsuId.equals(""))
return null;
return wsuId;
}
public void setWsuId(String wsuId) {
setAttributeNS(
MessageConstants.NAMESPACES_NS,
"xmlns:" + MessageConstants.WSU_PREFIX,
MessageConstants.WSU_NS);
setAttributeNS(
MessageConstants.WSU_NS,
MessageConstants.WSU_ID_QNAME,
wsuId);
}
/**
* Look at EncodingType (if any) and return
* decoded result.
* Handle Base64Binary for now.
*/
public String getDecodedReferenceValue() throws XWSSecurityException {
String encType = getEncodingType();
if (encType == null) {
return getReferenceValue();
}
String encodedText= XMLUtil.getFullTextFromChildren(this);
if (MessageConstants.BASE64_ENCODING_NS.equals(encType)) {
return new String(getDecodedBase64EncodedData(encodedText));
} else {
log.log(Level.SEVERE,
"WSS0762.unsupported.encodingType",
new Object[] {encType});
throw new XWSSecurityException("Unsupported EncodingType: " + encType + " On KeyIdentifier");
}
}
private static byte[] getDecodedBase64EncodedData(String encodedData)
throws XWSSecurityException {
try {
return Base64.decode(encodedData);
} catch (Base64DecodingException e) {
log.log(Level.SEVERE,
"WSS0144.unableto.decode.base64.data",
new Object[] {e.getMessage()});
throw new XWSSecurityException(
"Unable to decode Base64 encoded data",
e);
}
}
}