JCaptcha & Spring MVC

Have you ever heard about Captcha.
Is this familiar?

Now that you remember what I'm talking about, let's begin.
I chose JCaptcha, because I used before with Struts back in Mexico for one of my projects when I was working in Government (SICOSIEM) and it was really useful (but I used a servlet)
Now the idea will be implementing the same project on an existing Spring MVC App, which is really simple :)
First things first!. Get JCaptcha and install it in your Local MVN Repo (version 1.0-all), because if you add as dependency version 1.0, it will not work, due to the lack of some jars on Maven Central Repo.
My Controller which will behave like my old servlet (I just have to create an IMG tag with src="/myAppContext/captcha/captcha.htm") @Controller @RequestMapping("/captcha/*") public class CaptchaController { @Autowired private CaptchaService captchaService; @RequestMapping(value="captcha.htm", method=RequestMethod.GET) public void showCaptcha(HttpServletRequest request, HttpServletResponse response) throws Exception { byte[] captchaChallengeAsJpeg = null; // the output stream to render the captcha image as jpeg into ByteArrayOutputStream jpegOutputStream = new ByteArrayOutputStream(); try { // get the session id that will identify the generated captcha. // the same id must be used to validate the response, the session id // is a good candidate! String sessionId = request.getSession().getId(); // call the ImageCaptchaService getChallenge method BufferedImage challenge = ((ImageCaptchaService) captchaService).getImageChallengeForID(sessionId); // a jpeg encoder JPEGImageEncoder jpegEncoder = JPEGCodec.createJPEGEncoder(jpegOutputStream); jpegEncoder.encode(challenge); } catch (IllegalArgumentException e) { response.sendError(HttpServletResponse.SC_NOT_FOUND); } catch (CaptchaServiceException e) { response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } captchaChallengeAsJpeg = jpegOutputStream.toByteArray(); // flush it in the response response.setHeader("Cache-Control", "no-store"); response.setHeader("Pragma", "no-cache"); response.setDateHeader("Expires", 0); // response.setContentType("image/jpeg"); // response.getOutputStream().write(jpegOutputStream); ServletOutputStream responseOutputStream = response.getOutputStream(); responseOutputStream.write(captchaChallengeAsJpeg); responseOutputStream.flush(); responseOutputStream.close(); } }
This is how you have to use it (on my previous jsp I have an input text called "captchaText" which holds the value entered by the user) @RequestMapping(value = "registerCustomer.htm",method=RequestMethod.POST) public String signUpCustomer(HttpServletRequest request, ModelMap modelMap, @ModelAttribute("CustomerDTO") CustomerDTO paramCustomerDTO, @RequestParam(value="captchaText", required=true) final String verificationText){ Boolean isResponseCorrect = false; String sessionId = request.getSession().getId(); try { isResponseCorrect = this.captchaService.validateResponseForID(request.getSession().getId(), verificationText); }catch(CaptchaServiceException ex) { //should not happen, may be thrown if the id is not valid log.warn("Session Id "+sessionId+" Not valid",ex); } try { if(isResponseCorrect){ result = this.customerService.doSignUp(paramCustomerDTO); }else{ modelMap.put(GenericConstants.KEY_ERROR, "Verification text incorrect, please type it again"); } }catch... .... }
This is a minimal configuration (I have the bad habit of splitting all my configurations to make my life easier, on this case I'll call this configuration file "jcaptcha.xml"), if you want to dig deeper, you can explore the official web site and play around with other classes (just look into this package: com.octo.captcha.engine.image.gimpy) <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <!-- =================== Captcha (Predefined) Engines =================== --> <bean id="imageEngineBean3" class="com.octo.captcha.engine.image.gimpy.BaffleListGimpyEngine"/> <bean id="imageEngineBean4" class="com.octo.captcha.engine.image.gimpy.BasicGimpyEngine"/> <bean id="imageEngineBean5" class="com.octo.captcha.engine.image.gimpy.DefaultGimpyEngine"/> <bean id="imageEngineBean6" class="com.octo.captcha.engine.image.gimpy.DeformedBaffleListGimpyEngine"/> <bean id="imageEngineBean7" class="com.octo.captcha.engine.image.gimpy.DoubleRandomListGimpyEngine"/> <bean id="imageEngineBean8" class="com.octo.captcha.engine.image.gimpy.FilteredBaffleListGimpyEngine"/> <bean id="imageEngineBean9" class="com.octo.captcha.engine.image.gimpy.FilteredDoubleRandomListGimpyEngine"/> <bean id="imageEngineBean10" class="com.octo.captcha.engine.image.gimpy.FilteredGimpyEngine"/> <bean id="imageEngineBean11" class="com.octo.captcha.engine.image.gimpy.FilteredListGimpyEngine"/> <!-- Only 12 and 13 are pretty decent --> <bean id="imageEngineBean12" class="com.octo.captcha.engine.image.gimpy.NonLinearTextGimpyEngine"/> <bean id="imageEngineBean13" class="com.octo.captcha.engine.image.gimpy.SimpleListImageCaptchaEngine"/> <!-- =================== Captcha Service =================== --> <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService"> <constructor-arg index="0" ref="imageEngineBean12"/> <constructor-arg index="1"><value>180</value></constructor-arg> <constructor-arg index="2"><value>180000</value></constructor-arg> <constructor-arg index="3"><value>200</value></constructor-arg> </bean> </beans>
FYI: This is the captcha service I'm injecting in my Controllers <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService">
Don't forget adding your new configuration file for JCaptcha in your Spring App Context (this is my web.xml) <!-- Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml, /WEB-INF/conf/captcha/jcaptcha.xml </param-value> </context-param>
If you want to see a more complex ("customized") configuration, you can use see this one (It took me a while to create it - but I used as reference what is on JCaptcha WebSite) <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <!-- =================== Captcha Engines =================== --> <bean id="imageEngineBean" class="com.octo.captcha.engine.GenericCaptchaEngine"> <constructor-arg index="0"> <list> <ref bean="captchaFactoryBean"/> </list> </constructor-arg> </bean> <bean id="imageEngineBean3" class="com.octo.captcha.engine.image.gimpy.BaffleListGimpyEngine"/> <bean id="imageEngineBean4" class="com.octo.captcha.engine.image.gimpy.BasicGimpyEngine"/> <bean id="imageEngineBean5" class="com.octo.captcha.engine.image.gimpy.DefaultGimpyEngine"/> <bean id="imageEngineBean6" class="com.octo.captcha.engine.image.gimpy.DeformedBaffleListGimpyEngine"/> <bean id="imageEngineBean7" class="com.octo.captcha.engine.image.gimpy.DoubleRandomListGimpyEngine"/> <bean id="imageEngineBean8" class="com.octo.captcha.engine.image.gimpy.FilteredBaffleListGimpyEngine"/> <bean id="imageEngineBean9" class="com.octo.captcha.engine.image.gimpy.FilteredDoubleRandomListGimpyEngine"/> <bean id="imageEngineBean10" class="com.octo.captcha.engine.image.gimpy.FilteredGimpyEngine"/> <bean id="imageEngineBean11" class="com.octo.captcha.engine.image.gimpy.FilteredListGimpyEngine"/> <!-- Only 12 and 13 are pretty decent --> <bean id="imageEngineBean12" class="com.octo.captcha.engine.image.gimpy.NonLinearTextGimpyEngine"/> <bean id="imageEngineBean13" class="com.octo.captcha.engine.image.gimpy.SimpleListImageCaptchaEngine"/> <!-- =================== Captcha Factory Bean =================== --> <bean id="captchaFactoryBean" class="com.octo.captcha.image.gimpy.GimpyFactory" > <constructor-arg ref="wordGeneratorBean"/> <constructor-arg ref="wordToImageBean"/> </bean> <!-- =================== Dictionary Word Generator =================== --> <bean id="wordGeneratorBean" class= "com.octo.captcha.component.word.wordgenerator.DictionaryWordGenerator" > <constructor-arg ref="fileDictionaryBean"/> </bean> <!-- =================== File Dictionary =================== --> <bean id="fileDictionaryBean" class="com.octo.captcha.component.word.FileDictionary" > <constructor-arg index="0"><value>toddlist</value></constructor-arg> </bean> <!-- =================== Deformed Compose Word To Image =================== --> <bean id="wordToImageBean" class="com.octo.captcha.component.image.wordtoimage.DeformedComposedWordToImage" > <constructor-arg index="0" ref="randomFontGeneratorBean"/> <constructor-arg index="1" ref="backGeneratorFunkyBean"/> <constructor-arg index="2" ref="simpleColoredPasterBean"/> <constructor-arg index="3" ref="rippleDeformationBack"/> <constructor-arg index="4" ref="none"/> <constructor-arg index="5" ref="waterDeformation"/> </bean> <!-- =================== Random Font Generator =================== --> <bean id="randomFontGeneratorBean" class="com.octo.captcha.component.image.fontgenerator.RandomFontGenerator" > <constructor-arg index="0"><value>40</value></constructor-arg> <constructor-arg index="1"><value>50</value></constructor-arg> <constructor-arg index="2"> <list> <ref bean="fontArial"/> <ref bean="fontTahoma"/> <ref bean="fontVerdana"/> <ref bean="fontComic"/> <ref bean="fontLucida"/> </list> </constructor-arg> </bean> <!-- =================== Fonts =================== --> <bean id="fontArial" class="java.awt.Font" > <constructor-arg index="0"><value>Arial</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontTahoma" class="java.awt.Font" > <constructor-arg index="0"><value>Tahoma</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontVerdana" class="java.awt.Font" > <constructor-arg index="0"><value>Verdana</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontComic" class="java.awt.Font" > <constructor-arg index="0"><value>Comic sans MS</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontLucida" class="java.awt.Font" > <constructor-arg index="0"><value>Lucida console</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <!-- =================== Backgrounds =================== --> <bean id="uniColorBackGeneratorBean" class="com.octo.captcha.component.image.backgroundgenerator.UniColorBackgroundGenerator" > <constructor-arg index="0"><value>300</value></constructor-arg> <constructor-arg index="1"><value>100</value></constructor-arg> </bean> <bean id="backGeneratorFunkyBean" class="com.octo.captcha.component.image.backgroundgenerator.FunkyBackgroundGenerator" > <constructor-arg index="0"><value>300</value></constructor-arg> <constructor-arg index="1"><value>100</value></constructor-arg> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="2" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="3" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="4" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="5" ref="randomListColorGeneratorBean"/> <constructor-arg index="6"><value>0.2f</value></constructor-arg> </bean> <!-- =================== Text Pasters =================== --> <bean id="simpleWhitePasterBean" class="com.octo.captcha.component.image.textpaster.SimpleTextPaster" > <constructor-arg type="java.lang.Integer" index="0"> <value>4</value> </constructor-arg> <constructor-arg type="java.lang.Integer" index="1"> <value>6</value> </constructor-arg> <constructor-arg type="java.awt.Color" index="2"> <ref bean="colorBlack"/> </constructor-arg> </bean> <bean id="simpleColoredPasterBean" class="com.octo.captcha.component.image.textpaster.RandomTextPaster" > <constructor-arg type="java.lang.Integer" index="0"><value>4</value></constructor-arg> <constructor-arg type="java.lang.Integer" index="1"><value>6</value></constructor-arg> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="2" ref="randomRangeColorGeneratorDarkBean"/> <constructor-arg index="3"><value>true</value></constructor-arg> </bean> <!-- =================== Random Range Color Generator =================== --> <bean id="randomRangeColorGeneratorDarkBean" class="com.octo.captcha.component.image.color.RandomRangeColorGenerator" > <constructor-arg index="0"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="1"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="2"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="3"> <list> <value>255</value> <value>255</value> </list> </constructor-arg> </bean> <!-- =================== RandomList Color Generator =================== --> <bean id="randomListColorGeneratorBean" class="com.octo.captcha.component.image.color.RandomListColorGenerator" > <constructor-arg index="0"> <list> <ref bean="yellow"/> <ref bean="blue"/> <ref bean="lightBlue"/> <ref bean="colorBlack"/> </list> </constructor-arg> </bean> <!-- =================== Colors =================== --> <bean id="blue" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>0</value></constructor-arg> <constructor-arg type="int" index="1"><value>0</value></constructor-arg> <constructor-arg type="int" index="2"><value>255</value></constructor-arg> </bean> <bean id="lightBlue" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>200</value></constructor-arg> <constructor-arg type="int" index="1"><value>200</value></constructor-arg> <constructor-arg type="int" index="2"><value>255</value></constructor-arg> </bean> <bean id="yellow" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>255</value></constructor-arg> <constructor-arg type="int" index="1"><value>255</value></constructor-arg> <constructor-arg type="int" index="2"><value>0</value></constructor-arg> </bean> <bean id="colorBlack" class="java.awt.Color" > <constructor-arg index="0"><value>0</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>0</value></constructor-arg> </bean> <!-- =================== Captcha Service =================== --> <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService"> <constructor-arg index="0" ref="imageEngineBean"/> <constructor-arg index="1"><value>180</value></constructor-arg> <constructor-arg index="2"><value>180000</value></constructor-arg> <constructor-arg index="3"><value>200</value></constructor-arg> </bean> <!-- =================== Deformations =================== --> <bean id="sphere" class="com.jhlabs.image.SphereFilter"> <property name="refractionIndex"> <value>1</value> </property> </bean> <bean id="emboss" class="com.jhlabs.image.EmbossFilter"> <property name="bumpHeight"> <value>1.0</value> </property> </bean> <bean id="rippleBack" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>3</value> </property> <property name="XAmplitude"> <value>10</value> </property> <property name="YAmplitude"> <value>3</value> </property> <property name="XWavelength"> <value>20</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="smear" class="com.jhlabs.image.SmearFilter"> <property name="shape"> <value>0</value> </property> <property name="distance"> <value>15</value> </property> <property name="density"> <value>0.4</value> </property> <property name="scatter"> <value>0.5</value> </property> <property name="angle"> <value>0.0</value> </property> <property name="mix"> <value>0.6</value> </property> <property name="fadeout"> <value>0</value> </property> </bean> <bean id="ripple" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>1</value> </property> <property name="XAmplitude"> <value>2</value> </property> <property name="YAmplitude"> <value>2</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="ripple2" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>2</value> </property> <property name="XAmplitude"> <value>2</value> </property> <property name="YAmplitude"> <value>2</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="ripple3" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>5</value> </property> <property name="XAmplitude"> <value>5</value> </property> <property name="YAmplitude"> <value>5</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="twirl" class="com.jhlabs.image.TwirlFilter"> <property name="angle"> <value>0.8</value> </property> </bean> <bean id="water" class="com.jhlabs.image.WaterFilter"> <property name="amplitude"> <value>2</value> </property> <property name="antialias"> <value>true</value> </property> <property name="wavelength"> <value>20</value> </property> </bean> <bean id="weaves" class="com.jhlabs.image.WeaveFilter"> <property name="useImageColors"> <value>true</value> </property> <property name="XGap"> <value>2</value> </property> <property name="XWidth"> <value>10</value> </property> <property name="YWidth"> <value>16</value> </property> <property name="YGap"> <value>6</value> </property> </bean> <bean id="crystal" class="com.jhlabs.image.CrystalizeFilter"> <property name="scale"> <value>0.5</value> </property> <property name="gridType"> <value>1</value> </property> <property name="fadeEdges"> <value>false</value> </property> <property name="edgeThickness"> <value>0.4</value> </property> <property name="randomness"> <value>1.0</value> </property> </bean> <bean id="smearDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="smear" /> </list> </constructor-arg> </bean> <bean id="rippleDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple" /> </list> </constructor-arg> </bean> <bean id="ripple2Deformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple2" /> </list> </constructor-arg> </bean> <bean id="ripple3Deformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple3" /> </list> </constructor-arg> </bean> <bean id="sphereDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="sphere" /> </list> </constructor-arg> </bean> <bean id="waterDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="water" /> </list> </constructor-arg> </bean> <bean id="embossDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="emboss" /> </list> </constructor-arg> </bean> <bean id="rippleDeformationBack" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="rippleBack" /> </list> </constructor-arg> </bean> <bean id="cristalDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="crystal" /> </list> </constructor-arg> </bean> <bean id="weavesDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="weaves" /> </list> </constructor-arg> </bean> <bean id="twirlDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="twirl" /> </list> </constructor-arg> </bean> <bean id="none" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <null /> </constructor-arg> </bean> </beans>