DOKUMENTATION. CaptchaAd mit Java. Entpacken und Hochladen. Die Schritte zur Integration des CaptchaAd-Modul im Einzelnen. Informationen von CaptchaAd

Transkript

1 CaptchaAd mit Java Stand: 24. September 2012 Damit die Integration von CaptchaAd Ihnen noch leichter fällt, haben wir die notwendigen Schritte in diesem Leitfaden zusammen gefasst. Mit etwas Programmierkenntnissen lässt sich die Integration von CaptchaAd auf Ihrer Internetseite in kurzer Zeit durchführen. Die Schritte zur Integration des CaptchaAd-Modul im Einzelnen 1. Notwendige Informationen und Keys 2. Entpacken und Hochladen 3. Die Konfiguration 4. Einbindung in ein Formular 5. FAQ Notwendige Informationen und Keys Bevor Sie mit der Integration beginnen, gehen Sie sicher, dass Ihnen die im Folgenden aufgelisteten Informationen vorliegen. Es handelt sich dabei um Informationen, die Sie von CaptchaAd auf Anfrage erhalten. Für Integration von CaptchaAd sind diese Daten zwingend erforderlich. Informationen von CaptchaAd CAPTCHAAD_API_KEY die gezippte Java-Library All diese Informationen erhalten Sie von Ihrem Ansprechpartner bei CaptchaAd. Der Keys dient zur Identifizierung und sicheren Kommunikation zwischen dem CaptchaAd auf ihrer Seite und dem CaptchaAd-AdServer und ist für jede CaptchaAd indiviudell. Sollten Sie mehr als ein CaptchaAd auf Ihrer Seiten einbauen, benötigten Sie daher auch für jedes CaptchaAd einen eigenen Key. Entpacken und Hochladen Entpacken Sie die ZIP-Datei und laden Sie das library-verzeichnis sowie die config.cfg und ggf. die demo.jsp auf Ihren Webserver. Den src-ordner enthält die unkompilierten Java-Klassen und erlaubt Ihnen Einblick in unseren Code und ermöglicht Ihnen ggf. weitere Anpassungen. Diesen Ordner sollten sie aus Sicherheitsgründen nicht auf den Webserver hochladen. 1/5

2 Die Konfiguration Öffnen Sie das CaptchaAd-Verzeichnis und bearbeiten die Datei config.cfg. Diese Datei ist die Konfigurationsdatei. Wichtig: Die nachfolgenden Zeilen mit dem roten CaptchaAd-Pfeil müssen angepasst werden. Die Zeilen mit dem grauen CaptchaAd-Pfeil sind optional. Die rot markierten Einträge sind nur Beispiele. Bitte ersetzen Sie diese mit Ihren persönlichen Informationen (siehe oben»notwendige Informationen und Keys«). Zeile 2: (API Schlüssel / CAPTCHAAD_API_KEY) Geben Sie nach dem Doppelpunkt den von CaptchaAd erhaltenen API Schlüssel ein. CAPTCHAAD_API_KEY: d5fa82ea407aegc6b Zeile 4: (Sprache / CAPTCHAAD_LANGUAGE) Geben Sie hier das Kürzel für die Sprache als String ein, das für die Darstellung der die Inhalte des CaptchaAd steht. Das betrifft die Sprache der Fragestellung, der Antworten und des Textes auf der Startseite. Zur Verfügung stehen derzeit Deutsch (de) und Englisch (en). CAPTCHAAD_LANGUAGE:de Zeile 5: (Breite / CAPTCHAAD_WIDTH) Geben Sie hier die dargestellte Breite des CaptchaAd als Integer ein. Standard ist 300 Pixel. CAPTCHAAD_WIDTH:300 Zeile 6: (Höhe / CAPTCHAAD_HEIGHT) Geben Sie hier die dargestellte Höhe des CaptchaAd als Integer ein. Standard ist 250 Pixel. CAPTCHAAD_HEIGHT:250 Zeile 8: (automatischer Start / CAPTCHAAD_AUTOSTART) Hier lässt sich einstellen, ob das Video innerhalb des CaptchaAd automatisch abgespielt wird, oder auf die Interaktion des Nutzers wartet. Standard ist true (an). CAPTCHAAD_AUTOSTART:true

3 Zeile 9: (Sound / CAPTCHAAD_SOUND) Hier lässt sich einstellen, ob der Ton innerhalb des CaptchaAd anfangs ein- oder ausgeschaltet ist. Standard ist true (an). CAPTCHAAD_SOUND:true Einbindung in ein Formular Die Einbindung und Verwendung der Bibliothek lässt sich einfach anhand der mitgelieferten demo.jsp erläuten: 1. <%@page import="org.springframework.web.servlet.httpservletbean"%> 2. <%@page contenttype="text/html" pageencoding="utf-8"%> 3. <%@page import="captchaad.*" %> 4. <% Diese einführenden Zeilen dienen für eine korrekte Ausgabe der Seite auf einem Tomcat-Server und binden die erforderliche Library ein. 5. String check = ""; 6. // neue config instanz 7. CaptchaAd_Conf cf = new CaptchaAd_Conf("/var/lib/tomcat6/webapps/example/WEB- INF/data/config.cfg"); 8. // neu CaptchaAd Instanz 9. CaptchaAd c = new CaptchaAd(cf); In diesen Zeilen wird ein neues Config-Objekt erzeugt (wobei der Pfad natürlich entsprechend Ihren Webservereinstellungen angepasst warden muss und die config.cfg auch anders heißen darf) und eine neue CaptchaAd-Instanz erstellt. 10. // Prüfung, ob Formular gesendet wurde 11. if(request.getparameter("ispost")!= null && request.getparameter("ispost").equals("submit")) { 12. CaptchaAd_Request cr = new CaptchaAd_Request(); 13. cr.setrecaptchachallengefield(request.getparameter("recaptcha_challenge_field")); 14. cr.setrecaptcharesponsefield(request.getparameter("recaptcha_response_field")); 15. cr.setcaptchaadsession(request.getparameter("captchaadsession")); 16. cr.setremoteaddr(request.getremoteaddr()); An dieser Stelle wird überprüft ob eine Eingabe des Benutzers stattgefunden hat und die Eingaben das zur Überprüfung notwenige CaptchaAd_Request-Objekt erstellt und mit den Werten befüllt 17. boolean result = c.checkanswer(cr); Mit diesem Aufruf erfolgt die eigentliche Prüfung ob eine Antwort des Besuchers korrekt ist.

4 18. if(result == true) { 19. check = "<span style=\"color:green;\">die Prüfung war erfolgreich</span>"; 20. } else { 21. check = "<span style=\"color:red;\">die Prüfung ist fehlgeschlagen</span>"; 22. } 23. } 24. %> Der vorherige Aufruf gibt bei einer validen Antwort true zurück, bei einer falschen Antwort false 25. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 26. " 27. <html> 28. <head> 29. <meta http-equiv="content-type" content="text/html; charset=utf-8"> 30. <title>welcome to CaptchaAd</title> 31. </head> 32. <body> 33. <h1>testform</h1> 34. %> a. <% b. out.print(check); 35. <form method="post" id="testfrm" action="index.jsp" > 36. Name: <input type="text" name="name"/><br> 37. Username: <input type="text" name="username"/><br> 38. Password: <input type="text" name="password"/><br> 39. <% 40. %><br> a. out.print(c.gethtmlbody()); 41. <input type="submit" name="ispost" value="submit" /> 42. </form> 43. </body> 44. </html> Die Zeilen geben ein Testformular aus und kann natürlich entsprechend durch ihren Formularcode ersetzt werden. Wichtig hierbei ist lediglich die Zeile 39 mit dem Aufruf c.gethtmlbody(), der den HTML-Code zurückliefert, der für die Darstellung des CaptchaAd notwendig ist.

5 FAQ Netzwerkkommunikation Der Hauptteil der Netzwerkkommunikation für die Darstellung des CaptchaAds läuft clientseitig. Serverseitig wird eine Session bei den Servern von CaptchaAd abgefragt, die entsprechend für die Client-Server-Kommunikation verwendet wird. Serverseitig wird per HTTP über den Standard-Port 80 kommuniziert. Für die Firewall ist CAPTCHAAD_HOST auf Verbindungen auf Port 80 freizugeben. TimeOut-Behandlung Bei der HTTP-Kommunikation wird standardmäßig ein TimeOut von 5 Sekunden gesetzt. Den TimeOut über die Konfiguration setzten zu können stellt kein Problem dar und kann ohne großen Aufwand implementiert werden. Die TimeOuts werden über Exceptions abgefangen und haben die Auslieferung des recaptchas zur Folge wegen einer ungültigen SessionID. HTTP-Kommunikation Es werden die Standard IO- und NET-Bibliotheken verwendet. 5/5