nz.co.breakpoint.jmeter.modifiers.CryptoWSSecurityPreProcessor Maven / Gradle / Ivy

package nz.co.breakpoint.jmeter.modifiers;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.wss4j.common.crypto.Crypto;
import org.apache.wss4j.common.ext.WSSecurityException;
import org.apache.wss4j.dom.WSConstants;
import org.apache.wss4j.dom.message.WSSecBase;

/**
 * Abstract parent class of any preprocessors that perform crypto operations (e.g. signature or encryption).
 */
public abstract class CryptoWSSecurityPreProcessor extends AbstractWSSecurityPreProcessor {

    protected CryptoTestElement crypto = new CryptoTestElement();
    protected String certAlias, certPassword; // Keystore alias to use for this preprocessor's crypto operation

    protected List partsToSecure; // Holds the names of XML elements to secure (e.g. SOAP Body)
    protected String keyIdentifier;

    static final Map keyIdentifierMap = new HashMap<>();
    static {
        keyIdentifierMap.put("Binary Security Token",         WSConstants.BST_DIRECT_REFERENCE);
        keyIdentifierMap.put("Issuer Name and Serial Number", WSConstants.ISSUER_SERIAL);
        keyIdentifierMap.put("X509 Certificate",              WSConstants.X509_KEY_IDENTIFIER);
        keyIdentifierMap.put("Subject Key Identifier",        WSConstants.SKI_KEY_IDENTIFIER);
        keyIdentifierMap.put("Thumbprint SHA1 Identifier",    WSConstants.THUMBPRINT_IDENTIFIER);
        keyIdentifierMap.put("Encrypted Key SHA1",            WSConstants.ENCRYPTED_KEY_SHA1_IDENTIFIER); // only for encryption (symmetric signature not implemented yet - would require UI fields for setSecretKey or setEncrKeySha1value)
        keyIdentifierMap.put("Custom Key Identifier",         WSConstants.CUSTOM_KEY_IDENTIFIER); // not implemented yet (requires UI fields for setCustomTokenId and setCustomTokenValueType)
        keyIdentifierMap.put("Key Value",                     WSConstants.KEY_VALUE); // only for signature
        keyIdentifierMap.put("Endpoint Key Identifier",       WSConstants.ENDPOINT_KEY_IDENTIFIER); // not supported by Merlin https://ws.apache.org/wss4j/apidocs/org/apache/wss4j/common/crypto/Merlin.html#getX509Certificates-org.apache.wss4j.common.crypto.CryptoType-
    }

    public CryptoWSSecurityPreProcessor() throws ParserConfigurationException {
        super();
    }

    /* Reverse lookup for above keyIdentifierMap. Mainly used for populating the GUI dropdown.
     */
    protected static String getKeyIdentifierLabelForType(int keyIdentifierType) {
        for (Map.Entry id : keyIdentifierMap.entrySet()) {
            if (id.getValue() == keyIdentifierType)
                return id.getKey();
        }
        return null;
    }

    protected Crypto getCrypto() throws WSSecurityException {
        return crypto.getInstance();
    }

    /* This assigns common parameters to the WSS builder, such as
     * credentials, parts etc.
     */
    protected WSSecBase prepareBuilder(WSSecBase secBuilder) {
        secBuilder.setExpandXopInclude(true); // don't sign just the xop reference but inline the attachment content first
        secBuilder.setUserInfo(getCertAlias(), getCertPassword());
        setKeyIdentifier(secBuilder);
        setPartsToSecure(secBuilder);
        updateAttachmentCallbackHandler();
        secBuilder.setAttachmentCallbackHandler(getAttachmentCallbackHandler());
        return secBuilder;
    }

    // Accessors
    public String getCertAlias() { return certAlias; }

    public void setCertAlias(String certAlias) { this.certAlias = certAlias; }

    public String getCertPassword() { return certPassword; }

    public void setCertPassword(String certPassword) { this.certPassword = certPassword; }

    public String getKeystoreFile() { return crypto.getKeystoreFile(); }

    public void setKeystoreFile(String keystoreFile) { crypto.setKeystoreFile(keystoreFile); }

    public String getKeystorePassword() { return crypto.getKeystorePassword(); }

    public void setKeystorePassword(String keystorePassword) { crypto.setKeystorePassword(keystorePassword); }

    protected void setKeyIdentifier(WSSecBase secBuilder) {
        secBuilder.setKeyIdentifierType(keyIdentifierMap.get(keyIdentifier));
    }

    protected void setPartsToSecure(WSSecBase secBuilder) {
        secBuilder.getParts().clear();
        if (partsToSecure == null) return;
        for (SecurityPart part : partsToSecure) {
            secBuilder.getParts().add(part.getPart());
        }
    }
}