com.wavemaker.tools.cloudfoundry.spinup.authentication.SharedSecretPropagation.java Source code

Introduction

Here is the source code for com.wavemaker.tools.cloudfoundry.spinup.authentication.SharedSecretPropagation.java

Source

/*
 *  Copyright (C) 2012-2013 CloudJee, Inc. All rights reserved.
 *
 *  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 com.wavemaker.tools.cloudfoundry.spinup.authentication;

import java.util.HashMap;
import java.util.Map;

import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.cloudfoundry.client.lib.CloudApplication;
import org.cloudfoundry.client.lib.CloudFoundryClient;
import org.cloudfoundry.client.lib.CloudFoundryException;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 * Propagates a {@link SharedSecret} to a running cloud foundry application.
 * 
 * @author Phillip Webb
 */
public class SharedSecretPropagation {

    private final Log logger = LogFactory.getLog(getClass());

    // NOTE: Cloud foundry cannot cope with dots in env variables
    static final String ENV_KEY = (SharedSecretPropagation.class.getName() + ".SECRET").replaceAll("\\.", "_");

    /**
     * Send the specified shared secret to a running cloud foundry application.
     * 
     * @param client client
     * @param secret the secret to send
     * @param applicationName the application to send the secret to
     */
    public void sendTo(CloudFoundryClient client, SharedSecret secret, String applicationName)
            throws CloudFoundryException {
        Assert.notNull(client, "Client must not be null");
        Assert.notNull(applicationName, "ApplicationName must not be null");
        CloudApplication application = client.getApplication(applicationName);
        sendTo(client, secret, application);
    }

    /**
     * Send the specified shared secret to a running cloud foundry application.
     * 
     * @param client client
     * @param secret the secret to send
     * @param application the application to send the secret to
     */
    public void sendTo(CloudFoundryClient client, SharedSecret secret, CloudApplication application)
            throws CloudFoundryException {
        Assert.notNull(client, "Client must not be null");
        Assert.notNull(application, "Application must not be null");
        if (this.logger.isDebugEnabled()) {
            this.logger.debug("Propagating shared secret to " + application.getName());
        }
        Map<String, String> env = new HashMap<String, String>();
        env.putAll(application.getEnvAsMap());
        String envValue = Hex.encodeHexString(secret.getBytes());
        if (!envValue.equals(env.get(ENV_KEY))) {
            if (this.logger.isDebugEnabled()) {
                this.logger.debug("Restarting " + application.getName() + " due to new shared secret");
            }
            env.put(ENV_KEY, envValue);
            client.updateApplicationEnv(application.getName(), env);
            client.restartApplication(application.getName());
        }
    }

    /**
     * Get the shared secret for the currently running application. This method assumes that some other process has
     * {@link #sendTo(CloudFoundryClient, SharedSecret, CloudApplication) sent} the {@link SharedSecret} to the running
     * application.
     * 
     * @param required
     * 
     * @return the shared secret
     * @throw IllegalStateException if the secret cannot be obtained
     */
    public SharedSecret getForSelf(boolean required) throws IllegalStateException {
        try {
            String secret = getEnv(ENV_KEY);
            if (!StringUtils.hasLength(secret) && !required) {
                return null;
            }
            Assert.state(StringUtils.hasLength(secret), "No shared secret has been propagated");
            return SharedSecret.fromBytes(Hex.decodeHex(secret.toCharArray()));
        } catch (DecoderException e) {
            throw new IllegalStateException("Unable to decode shared secret key", e);
        }
    }

    /**
     * Access a system environment variable. This method exists to enable unit testing of the class.
     * 
     * @param name the name of the environment variable
     * @return the variable value
     */
    protected String getEnv(String name) {
        return System.getenv(name);
    }
}