com.buession.cas.web.utils.CaptchaUtils.java Source code

Introduction

Here is the source code for com.buession.cas.web.utils.CaptchaUtils.java

Source

/*
 * 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.
 * 
 * =================================================================================================
 * 
 * This software consists of voluntary contributions made by many individuals on behalf of the
 * Apache Software Foundation. For more information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 * 
 * +------------------------------------------------------------------------------------------------+
 * | License: http://cas-server-support.buession.com.cn/LICENSE                            |
 * | Author: Yong.Teng <webmaster@buession.com>                                        |
 * | Copyright @ 2013-2014 Buession.com Inc.                                          |
 * +------------------------------------------------------------------------------------------------+
 */
package com.buession.cas.web.utils;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;

import org.springframework.util.Assert;

import com.buession.mcrypt.Sha512Mcrypt;
import com.google.code.kaptcha.util.Config;

/**
 * ??
 * 
 * @author Yong.Teng <webmaster@buession.com>
 */
public class CaptchaUtils {

    public final static String REQUEST_CAPTCHA_PARAM_NAME = "validateCode";

    public final static String VALIDATE_CODE = "validateCode";

    private final static Sha512Mcrypt mcrypt = new Sha512Mcrypt("UTF-8", 2);

    private CaptchaUtils() {
    }

    /**
     * ??? Cookie
     * 
     * @param config
     * @return
     */
    public final static String getCaptchaCookieName(final Config config) {
        Assert.notNull(config, "Captcha config could not be null");

        String name = config.getSessionKey();
        return name == null ? VALIDATE_CODE : name;
    }

    /**
     * ???
     * 
     * @param request
     *        HttpServletRequest
     * @param requestParamName
     *        ?????
     * @param config
     *        ???
     * @return ???
     */
    public static boolean validate(final HttpServletRequest request, final String requestParamName,
            final Config config) {
        String value = request
                .getParameter(requestParamName == null ? REQUEST_CAPTCHA_PARAM_NAME : requestParamName);
        return validate(request, config, value);
    }

    /**
     * ???
     * 
     * @param request
     *        HttpServletRequest
     * @param captchaProducer
     *        ?????
     * @param validateCode
     *        ????
     * @return ???
     */
    public static boolean validate(final HttpServletRequest request, final Config config,
            final String validateCode) {
        if (validateCode == null || validateCode.length() == 0) {
            return false;
        }

        Cookie cookies[] = request.getCookies();
        if (cookies == null || cookies.length == 0) {
            return false;
        }

        String captchaCookieName = CaptchaUtils.getCaptchaCookieName(config);
        for (int i = 0; i < cookies.length; i++) {
            Cookie cookie = cookies[i];

            if (captchaCookieName.equals(cookie.getName()) == true) {
                mcrypt.setSalt(request.getSession().getId());
                return mcrypt.encode(validateCode).equalsIgnoreCase(cookie.getValue());
            }
        }

        return false;
    }

}