com.eucalyptus.auth.login.Hmacv2LoginModule.java Source code

Java tutorial

Introduction

Here is the source code for com.eucalyptus.auth.login.Hmacv2LoginModule.java

Source

/*************************************************************************
 * Copyright 2009-2012 Eucalyptus Systems, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 3 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
 * CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you need
 * additional information or have any questions.
 *
 * This file may incorporate work covered under the following copyright
 * and permission notice:
 *
 *   Software License Agreement (BSD License)
 *
 *   Copyright (c) 2008, Regents of the University of California
 *   All rights reserved.
 *
 *   Redistribution and use of this software in source and binary forms,
 *   with or without modification, are permitted provided that the
 *   following conditions are met:
 *
 *     Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *     Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer
 *     in the documentation and/or other materials provided with the
 *     distribution.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *   COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *   CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE. USERS OF THIS SOFTWARE ACKNOWLEDGE
 *   THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
 *   COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE,
 *   AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
 *   IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA,
 *   SANTA BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY,
 *   WHICH IN THE REGENTS' DISCRETION MAY INCLUDE, WITHOUT LIMITATION,
 *   REPLACEMENT OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO
 *   IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT
 *   NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.
 ************************************************************************/

package com.eucalyptus.auth.login;

import java.io.UnsupportedEncodingException;
import java.util.Map;
import java.util.NavigableSet;
import java.util.TreeSet;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.net.URLCodec;
import org.apache.log4j.Logger;
import org.apache.xml.security.utils.Base64;
import com.eucalyptus.auth.principal.AccessKey;
import com.eucalyptus.auth.principal.User;
import com.eucalyptus.crypto.Hmac;
import com.google.common.base.Strings;

public class Hmacv2LoginModule extends HmacLoginModuleSupport {
    private static Logger LOG = Logger.getLogger(Hmacv2LoginModule.class);

    public Hmacv2LoginModule() {
        super(2);
    }

    @Override
    public boolean authenticate(HmacCredentials credentials) throws Exception {
        String sig = credentials.getSignature();
        checkForReplay(sig);
        AccessKey accessKey = lookupAccessKey(credentials);
        User user = accessKey.getUser();
        String secretKey = accessKey.getSecretKey();
        String canonicalString = this.makeSubjectString(credentials.getVerb(), credentials.getHeaderHost(),
                credentials.getServicePath(), credentials.getParameters());
        String canonicalStringWithPort = this.makeSubjectString(credentials.getVerb(),
                credentials.getHeaderHost() + ":" + credentials.getHeaderPort(), credentials.getServicePath(),
                credentials.getParameters());
        String computedSig = this.getSignature(secretKey, canonicalString, credentials.getSignatureMethod());
        String computedSigWithPort = this.getSignature(secretKey, canonicalStringWithPort,
                credentials.getSignatureMethod());
        if (!computedSig.equals(sig) && !computedSigWithPort.equals(sig)) {
            sig = sanitize(urldecode(sig));
            computedSig = this.getSignature(secretKey, canonicalString.replaceAll("\\+", "%2B"),
                    credentials.getSignatureMethod()).replaceAll("\\+", " ");
            computedSigWithPort = this.getSignature(secretKey, canonicalStringWithPort.replaceAll("\\+", "%2B"),
                    credentials.getSignatureMethod()).replaceAll("\\+", " ");
            if (!computedSig.equals(sig) && !computedSigWithPort.equals(sig)) {
                computedSig = this.getSignature(secretKey, canonicalString.replaceAll("\\+", "%20"),
                        credentials.getSignatureMethod()).replaceAll("\\+", " ");
                computedSigWithPort = this.getSignature(secretKey, canonicalStringWithPort.replaceAll("\\+", "%20"),
                        credentials.getSignatureMethod()).replaceAll("\\+", " ");
                if (!computedSig.equals(sig) && !computedSigWithPort.equals(sig)) {
                    computedSig = this.getSignature(secretKey, canonicalString.replaceAll("\\*", "%2A"),
                            credentials.getSignatureMethod()).replaceAll("\\+", " ");
                    computedSigWithPort = this.getSignature(secretKey,
                            canonicalStringWithPort.replaceAll("\\*", "%2A"), credentials.getSignatureMethod())
                            .replaceAll("\\+", " ");
                    if (!computedSig.equals(sig) && !computedSigWithPort.equals(sig)) {
                        return false;
                    }
                }
            }
        }
        super.setCredential(credentials.getQueryId());
        super.setPrincipal(user);
        //super.getGroups( ).addAll( Groups.lookupUserGroups( super.getPrincipal( ) ) );
        return true;
    }

    private String makeSubjectString(String httpMethod, String host, String path,
            final Map<String, String> parameters) throws UnsupportedEncodingException {
        URLCodec codec = new URLCodec();
        parameters.remove("");
        StringBuilder sb = new StringBuilder();
        sb.append(httpMethod);
        sb.append("\n");
        sb.append(host);
        sb.append("\n");
        sb.append(path);
        sb.append("\n");
        String prefix = sb.toString();
        sb = new StringBuilder();
        NavigableSet<String> sortedKeys = new TreeSet<String>();
        sortedKeys.addAll(parameters.keySet());
        String firstKey = sortedKeys.pollFirst();
        if (firstKey != null) {
            sb.append(codec.encode(firstKey, "UTF-8")).append("=").append(
                    codec.encode(Strings.nullToEmpty(parameters.get(firstKey)), "UTF-8").replaceAll("\\+", "%20"));
        }
        while ((firstKey = sortedKeys.pollFirst()) != null) {
            sb.append("&").append(codec.encode(firstKey, "UTF-8")).append("=").append(
                    codec.encode(Strings.nullToEmpty(parameters.get(firstKey)), "UTF-8").replaceAll("\\+", "%20"));
        }
        String subject = prefix + sb.toString();
        LOG.trace("VERSION2: " + subject);
        return subject;
    }

    public String getSignature(final String queryKey, final String subject, final Hmac mac)
            throws AuthenticationException {
        SecretKeySpec signingKey = new SecretKeySpec(queryKey.getBytes(), mac.toString());
        try {
            Mac digest = mac.getInstance();
            digest.init(signingKey);
            byte[] rawHmac = digest.doFinal(subject.getBytes());
            return sanitize(Base64.encode(rawHmac));
        } catch (Exception e) {
            LOG.error(e, e);
            throw new AuthenticationException("Failed to compute signature");
        }
    }

}