org.apache.wss4j.policy.model.HttpsToken Maven / Gradle / Ivy

Go to download
/**
 * 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.policy.model;

import org.apache.neethi.Assertion;
import org.apache.neethi.Policy;
import org.apache.wss4j.policy.SPConstants;
import org.w3c.dom.Element;

import javax.xml.namespace.QName;
import java.util.*;

public class HttpsToken extends AbstractToken {

    public enum AuthenticationType {
        HttpBasicAuthentication,
        HttpDigestAuthentication,
        RequireClientCertificate;

        private static final Map LOOKUP = new HashMap<>();

        static {
            for (AuthenticationType u : EnumSet.allOf(AuthenticationType.class)) {
                LOOKUP.put(u.name(), u);
            }
        }

        public static AuthenticationType lookUp(String name) {
            return LOOKUP.get(name);
        }
    }

    private AuthenticationType authenticationType;

    public HttpsToken(SPConstants.SPVersion version, SPConstants.IncludeTokenType includeTokenType,
                      Element issuer, String issuerName, Element claims, Policy nestedPolicy,
                      boolean requireClientCert) {
        super(version, includeTokenType, issuer, issuerName, claims, nestedPolicy);

        parseNestedPolicy(nestedPolicy, this);

        if (requireClientCert) {
            setAuthenticationType(AuthenticationType.RequireClientCertificate);
        }
    }

    @Override
    public QName getName() {
        return getVersion().getSPConstants().getHttpsToken();
    }

    @Override
    public boolean equals(Object object) {
        if (object == this) {
            return true;
        }
        if (!(object instanceof HttpsToken)) {
            return false;
        }

        HttpsToken that = (HttpsToken)object;
        if (authenticationType != that.authenticationType) {
            return false;
        }

        return super.equals(object);
    }

    @Override
    public int hashCode() {
        int result = 17;
        if (authenticationType != null) {
            result = 31 * result + authenticationType.hashCode();
        }

        return 31 * result + super.hashCode();
    }

    @Override
    protected AbstractSecurityAssertion cloneAssertion(Policy nestedPolicy) {
        boolean requireClientCert = authenticationType == AuthenticationType.RequireClientCertificate;
        return new HttpsToken(getVersion(), getIncludeTokenType(), getIssuer(), getIssuerName(),
                              getClaims(), nestedPolicy, requireClientCert);
    }

    protected void parseNestedPolicy(Policy nestedPolicy, HttpsToken httpsToken) {
        Iterator> alternatives = nestedPolicy.getAlternatives();
        //we just process the first alternative
        //this means that if we have a compact policy only the first alternative is visible
        //in contrary to a normalized policy where just one alternative exists
        if (alternatives.hasNext()) {
            List assertions = alternatives.next();
            for (Assertion assertion : assertions) {
                String assertionName = assertion.getName().getLocalPart();
                AuthenticationType authenticationType = AuthenticationType.lookUp(assertionName);
                if (authenticationType != null) {
                    if (httpsToken.getAuthenticationType() != null) {
                        throw new IllegalArgumentException(SPConstants.ERR_INVALID_POLICY);
                    }
                    httpsToken.setAuthenticationType(authenticationType);
                    continue;
                }
            }
        }
    }

    public AuthenticationType getAuthenticationType() {
        return authenticationType;
    }

    protected void setAuthenticationType(AuthenticationType authenticationType) {
        this.authenticationType = authenticationType;
    }
}