org.soulwing.cas.extension.Profile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cas-subsystem Show documentation
Wildfly subsystem that monitors web application deployments and attaches CAS authentication support.
There is a newer version: 2.0.3
/*
 * File created on Dec 24, 2014 
 *
 * Copyright (c) 2015 Carl Harris, Jr.
 *
 * Licensed 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.soulwing.cas.extension;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;

import org.jboss.msc.inject.Injector;
import org.jboss.msc.value.InjectedValue;
import org.soulwing.cas.api.Transformer;
import org.soulwing.cas.service.AuthenticationProtocol;
import org.soulwing.cas.service.Configuration;

/**
 * A {@link Configuration} for a CAS client.
 *
 * @author Carl Harris
 */
public class Profile implements Configuration {

  private final InjectedValue sslContext =
      new InjectedValue<>();
  
  private final Map> allowedProxyChains = 
      new LinkedHashMap<>();
  
  private final Map> attributeTransformers =
      new HashMap<>();

  private String securityRealm;
  
  private HostnameVerifier hostnameVerifier;
  
  private AuthenticationProtocol protocol;
  
  private String encoding;

  private String serverUrl;

  private String serviceUrl;

  private boolean proxyCallbackEnabled;
  
  private String proxyCallbackPath;

  private boolean acceptAnyProxy;

  private boolean allowEmptyProxyChain;

  private boolean renew;
  
  private long clockSkewTolerance;
  
  private boolean postAuthRedirect;
    
  /**
   * Gets the {@code sslContext} property.
   * @return property value
   */
  public Injector getSslContextInjector() {
    return sslContext;
  }

  /**
   * Gets the SSL context.
   * @return SSL context
   */
  public SSLContext getSslContext() {
    if (getSecurityRealm() == null) return null;
    return sslContext.getValue();
  }
  
  /**
   * Gets the {@code securityRealm} property.
   * @return property value
   */
  public String getSecurityRealm() {
    return securityRealm;
  }

  /**
   * Sets the {@code securityRealm} property.
   * @param securityRealm the value to set
   */
  public void setSecurityRealm(String securityRealm) {
    this.securityRealm = securityRealm;
  }

  /**
   * Gets the {@code hostnameVerifier} property.
   * @return property value
   */
  public HostnameVerifier getHostnameVerifier() {
    return hostnameVerifier;
  }

  /**
   * Sets the {@code hostnameVerifier} property.
   * @param hostnameVerifier the value to set
   */
  public void setHostnameVerifier(HostnameVerifier hostnameVerifier) {
    this.hostnameVerifier = hostnameVerifier;
  }

  /**
   * Gets the {@code protocol} property.
   * @return property value
   */
  @Override
  public AuthenticationProtocol getProtocol() {
    return protocol;
  }

  /**
   * Sets the {@code protocol} property.
   * @param protocol the value to set
   */
  public void setProtocol(AuthenticationProtocol protocol) {
    this.protocol = protocol;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String getEncoding() {
    return encoding;
  }

  /**
   * Sets the {@code encoding} property.
   * @param encoding the value to set
   */
  public void setEncoding(String encoding) {
    this.encoding = encoding;
  }

  /**
   * Gets the {@code serverUrl} property.
   * @return property value
   */
  @Override
  public String getServerUrl() {
    return serverUrl;
  }

  /**
   * Sets the {@code serverUrl} property.
   * @param serverUrl the value to set
   */
  public void setServerUrl(String serverUrl) {
    this.serverUrl = serverUrl;
  }

  /**
   * Gets the {@code serviceUrl} property.
   * @return property value
   */
  @Override
  public String getServiceUrl() {
    return serviceUrl;
  }

  /**
   * Sets the {@code serviceUrl} property.
   * @param serviceUrl the value to set
   */
  public void setServiceUrl(String serviceUrl) {
    this.serviceUrl = serviceUrl;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean isProxyCallbackEnabled() {
    return proxyCallbackEnabled;
  }

  /**
   * Sets the {@code proxyCallbackEnabled} property.
   * @param proxyCallbackEnabled the value to set
   */
  public void setProxyCallbackEnabled(boolean proxyCallbackEnabled) {
    this.proxyCallbackEnabled = proxyCallbackEnabled;
  }

  /**
   * Gets the {@code proxyCallbackUrl} property.
   * @return property value
   */
  @Override
  public String getProxyCallbackPath() {
    return proxyCallbackPath;
  }

  /**
   * Sets the {@code proxyCallbackPath} property.
   * @param proxyCallbackPath the value to set
   */
  public void setProxyCallbackPath(String proxyCallbackPath) {
    this.proxyCallbackPath = proxyCallbackPath;
  }

  /**
   * Gets the {@code acceptAnyProxy} property.
   * @return property value
   */
  @Override
  public boolean isAcceptAnyProxy() {
    return acceptAnyProxy;
  }

  /**
   * Sets the {@code acceptAnyProxy} property.
   * @param acceptAnyProxy the value to set
   */
  public void setAcceptAnyProxy(boolean acceptAnyProxy) {
    this.acceptAnyProxy = acceptAnyProxy;
  }

  /**
   * Gets the {@code allowEmptyProxyChain} property.
   * @return property value
   */
  @Override
  public boolean isAllowEmptyProxyChain() {
    return allowEmptyProxyChain;
  }

  /**
   * Sets the {@code allowEmptyProxyChain} property.
   * @param allowEmptyProxyChain the value to set
   */
  public void setAllowEmptyProxyChain(boolean allowEmptyProxyChain) {
    this.allowEmptyProxyChain = allowEmptyProxyChain;
  }

  /**
   * Gets the {@code allowedProxyChains} property.
   * @return property value
   */
  @Override
  public List getAllowedProxyChains() {
    List chains = new ArrayList<>();
    for (List chain : allowedProxyChains.values()) {
      chains.add(chain.toArray(new String[chain.size()]));
    }
    return chains;
  }

  /**
   * Puts an allowed proxy chain into the map associated with profile,
   * replacing any existing chain with the same name.
   * @param name name of the chain
   * @param chain the subject chain
   */
  public void putAllowedProxyChain(String name, List chain) {
    allowedProxyChains.put(name, chain);
  }

  /**
   * Gets the {@code renew} property.
   * @return property value
   */
  @Override
  public boolean isRenew() {
    return renew;
  }

  /**
   * Sets the {@code renew} property.
   * @param renew the value to set
   */
  public void setRenew(boolean renew) {
    this.renew = renew;
  }

  
  /**
   * {@inheritDoc}
   */
  @Override
  public long getClockSkewTolerance() {
    return clockSkewTolerance;
  }

  /**
   * {@inheritDoc}
   */
  public void setClockSkewTolerance(long clockSkewTolerance) {
    this.clockSkewTolerance = clockSkewTolerance;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean isPostAuthRedirect() {
    return postAuthRedirect;
  }

  /**
   * {@inheritDoc}
   */
  public void setPostAuthRedirect(boolean postAuthRedirect) {
    this.postAuthRedirect = postAuthRedirect;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public Map> getAttributeTransformers() {
    return attributeTransformers;
  }

  /**
   * Puts an attribute transformer into the map associated with this profile,
   * replacing any existing transformer for the given attribute name.
   * @param attributeName name of the attribute to transform
   * @param transformer the subject transformer
   */
  @SuppressWarnings({ "rawtypes", "unchecked" })
  public void putAttributeTransformer(String attributeName, 
     Transformer transformer) {
    attributeTransformers.put(attributeName, transformer);
  }
  
  /**
   * {@inheritDoc}
   */
  @Override
  public String toString() {
    return String.format("{ protocol=%s encoding=%s"
        + " serverUrl=%s serviceUrl=%s proxyCallbackEnabled=%s"
        + " proxyCallbackPath=%s acceptAnyProxy=%s allowEmptyProxyChain=%s"
        + " allowedProxyChains=%s"
        + " renew=%s clockSkewTolerance=%d postAuthRedirect=%s"
        + " securityRealm=%s hostnameVerifier=%s attributeTransformers=%s }",
        protocol, encoding, serverUrl, serviceUrl, proxyCallbackEnabled, 
        proxyCallbackPath, acceptAnyProxy, allowEmptyProxyChain, 
        allowedProxyChains, renew, clockSkewTolerance, postAuthRedirect,
        securityRealm != null ? securityRealm : "(none)", 
        hostnameVerifier != null ? 
            hostnameVerifier.getClass().getSimpleName() : "(none)",
        attributeTransformers);
  }

}