1 package org.cacert.gigi.testUtils;
3 import static org.junit.Assert.*;
5 import java.io.BufferedReader;
6 import java.io.DataOutputStream;
7 import java.io.IOException;
8 import java.io.InputStreamReader;
9 import java.io.OutputStream;
10 import java.io.UnsupportedEncodingException;
11 import java.net.HttpURLConnection;
12 import java.net.InetSocketAddress;
13 import java.net.MalformedURLException;
14 import java.net.Socket;
16 import java.net.URLConnection;
17 import java.net.URLEncoder;
18 import java.nio.file.Files;
19 import java.nio.file.Paths;
20 import java.security.KeyManagementException;
21 import java.security.NoSuchAlgorithmException;
22 import java.security.Principal;
23 import java.security.PrivateKey;
24 import java.security.cert.X509Certificate;
25 import java.sql.SQLException;
26 import java.util.Locale;
27 import java.util.Properties;
28 import java.util.regex.Matcher;
29 import java.util.regex.Pattern;
31 import javax.net.ssl.HttpsURLConnection;
32 import javax.net.ssl.KeyManager;
33 import javax.net.ssl.SSLContext;
34 import javax.net.ssl.X509KeyManager;
36 import org.cacert.gigi.DevelLauncher;
37 import org.cacert.gigi.GigiApiException;
38 import org.cacert.gigi.database.GigiPreparedStatement;
39 import org.cacert.gigi.database.GigiResultSet;
40 import org.cacert.gigi.dbObjects.EmailAddress;
41 import org.cacert.gigi.dbObjects.Group;
42 import org.cacert.gigi.dbObjects.Job;
43 import org.cacert.gigi.dbObjects.ObjectCache;
44 import org.cacert.gigi.dbObjects.User;
45 import org.cacert.gigi.pages.account.MyDetails;
46 import org.cacert.gigi.pages.main.RegisterPage;
47 import org.cacert.gigi.testUtils.TestEmailReceiver.TestMail;
48 import org.cacert.gigi.util.SimpleSigner;
49 import org.hamcrest.CoreMatchers;
50 import org.junit.After;
51 import org.junit.AfterClass;
52 import org.junit.BeforeClass;
55 * Base class for test suites who require a launched Gigi instance. The instance
56 * is cleared once per test suite.
58 public class ManagedTest extends ConfiguredTest {
61 System.setProperty("sun.net.http.allowRestrictedHeaders", "true");
64 private static TestEmailReceiver ter;
66 private static Process gigi;
68 private static String url = "localhost:4443";
70 private static String acceptLanguage = null;
72 public static void setAcceptLanguage(String acceptLanguage) {
73 ManagedTest.acceptLanguage = acceptLanguage;
76 public static String getServerName() {
77 return url.replaceFirst(":443$", "");
80 public static String getSecureServerName() {
81 return getServerName().replaceAll("^www\\.", "secure.");
86 HttpURLConnection.setFollowRedirects(false);
90 public static void initEnvironmentHook() {
94 private static boolean inited = false;
96 public static Properties initEnvironment() {
98 Properties mainProps = ConfiguredTest.initEnvironment();
104 String type = testProps.getProperty("type");
105 generateMainProps(mainProps);
106 if (type.equals("local")) {
107 url = testProps.getProperty("name.www") + ":" + testProps.getProperty("serverPort.https");
108 String[] parts = testProps.getProperty("mail").split(":", 2);
109 ter = new TestEmailReceiver(new InetSocketAddress(parts[0], Integer.parseInt(parts[1])));
111 if (testProps.getProperty("withSigner", "false").equals("true")) {
112 SimpleSigner.runSigner();
116 url = testProps.getProperty("name.www") + ":" + testProps.getProperty("serverPort.https");
117 gigi = Runtime.getRuntime().exec(testProps.getProperty("java"));
118 DataOutputStream toGigi = new DataOutputStream(gigi.getOutputStream());
119 System.out.println("... starting server");
121 byte[] cacerts = Files.readAllBytes(Paths.get("config/cacerts.jks"));
122 byte[] keystore = Files.readAllBytes(Paths.get("config/keystore.pkcs12"));
124 DevelLauncher.writeGigiConfig(toGigi, "changeit".getBytes("UTF-8"), "changeit".getBytes("UTF-8"), mainProps, cacerts, keystore);
127 final BufferedReader br = new BufferedReader(new InputStreamReader(gigi.getErrorStream(), "UTF-8"));
129 while ((line = br.readLine()) != null && !line.contains("System successfully started.")) {
130 System.err.println(line);
138 while ((line = br.readLine()) != null) {
139 System.err.println(line);
141 } catch (IOException e) {
147 throw new Error("Server startup failed");
149 ter = new TestEmailReceiver(new InetSocketAddress("localhost", 8473));
151 SimpleSigner.runSigner();
153 } catch (IOException e) {
155 } catch (SQLException e1) {
157 } catch (InterruptedException e) {
163 protected static void await(Job j) throws InterruptedException {
168 public static void purgeDatabase() throws SQLException, IOException {
173 public static void clearCaches() throws IOException {
174 ObjectCache.clearAllCaches();
175 // String type = testProps.getProperty("type");
176 URL u = new URL("https://" + getServerName() + "/manage");
177 u.openConnection().getHeaderField("Location");
180 private static void generateMainProps(Properties mainProps) {
181 mainProps.setProperty("testrunner", "true");
182 mainProps.setProperty("host", "127.0.0.1");
184 mainProps.setProperty("emailProvider", "org.cacert.gigi.email.TestEmailProvider");
185 mainProps.setProperty("emailProvider.port", "8473");
186 mainProps.setProperty("sql.driver", testProps.getProperty("sql.driver"));
187 mainProps.setProperty("sql.url", testProps.getProperty("sql.url"));
188 mainProps.setProperty("sql.user", testProps.getProperty("sql.user"));
189 mainProps.setProperty("sql.password", testProps.getProperty("sql.password"));
190 mainProps.setProperty("testing", "true");
194 public static void tearDownServer() {
195 String type = testProps.getProperty("type");
197 if (type.equals("local")) {
202 SimpleSigner.stopSigner();
203 } catch (InterruptedException e) {
208 public final String uniq = createUniqueName();
211 public void removeMails() {
216 public void clearAcceptLanguage() {
217 ManagedTest.setAcceptLanguage(null);
221 public MailReceiver getMailReceiver() {
225 public static String runRegister(String param) throws IOException {
226 URL regist = new URL("https://" + getServerName() + RegisterPage.PATH);
227 HttpURLConnection uc = (HttpURLConnection) regist.openConnection();
228 HttpURLConnection csrfConn = (HttpURLConnection) regist.openConnection();
229 if (acceptLanguage != null) {
230 csrfConn.setRequestProperty("Accept-Language", acceptLanguage);
231 uc.setRequestProperty("Accept-Language", acceptLanguage);
234 String headerField = csrfConn.getHeaderField("Set-Cookie");
235 headerField = stripCookie(headerField);
237 String csrf = getCSRF(csrfConn);
238 uc.addRequestProperty("Cookie", headerField);
239 uc.setDoOutput(true);
240 uc.getOutputStream().write((param + "&csrf=" + csrf).getBytes("UTF-8"));
241 if (uc.getResponseCode() == 302) {
244 String d = IOUtils.readURL(uc);
248 public static org.hamcrest.Matcher<String> hasError() {
249 return CoreMatchers.containsString("<div class='alert alert-danger error-msgs'>");
252 public static org.hamcrest.Matcher<String> hasNoError() {
253 return CoreMatchers.not(hasError());
256 public static String fetchStartErrorMessage(String d) throws IOException {
257 String formFail = "<div class='alert alert-danger error-msgs'>";
258 int idx = d.indexOf(formFail);
262 String startError = d.substring(idx + formFail.length(), idx + formFail.length() + 150).trim();
266 public static void registerUser(String firstName, String lastName, String email, String password) {
268 String query = "name-type=western&fname=" + URLEncoder.encode(firstName, "UTF-8") + "&lname=" + URLEncoder.encode(lastName, "UTF-8") + "&email=" + URLEncoder.encode(email, "UTF-8") + "&pword1=" + URLEncoder.encode(password, "UTF-8") + "&pword2=" + URLEncoder.encode(password, "UTF-8") + "&day=1&month=1&year=1910&tos_agree=1";
269 String data = fetchStartErrorMessage(runRegister(query));
271 } catch (UnsupportedEncodingException e) {
273 } catch (IOException e) {
278 public static int createVerifiedUser(String firstName, String lastName, String email, String password) {
279 registerUser(firstName, lastName, email, password);
281 ter.receive().verify();
283 try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `id` FROM `users` WHERE `email`=?")) {
284 ps.setString(1, email);
286 GigiResultSet rs = ps.executeQuery();
293 } catch (IOException e) {
298 public static void grant(User u, Group g) throws IOException, GigiApiException {
299 u.grantGroup(getSupporter(), g);
304 * Creates a new user with 100 Verification Points given by an (invalid)
315 * @return a new userid.
317 public static int createAssuranceUser(String firstName, String lastName, String email, String password) {
318 int uid = createVerifiedUser(firstName, lastName, email, password);
325 protected static String stripCookie(String headerField) {
326 return headerField.substring(0, headerField.indexOf(';'));
329 public static final String SECURE_REFERENCE = MyDetails.PATH;
331 public static boolean isLoggedin(String cookie) throws IOException {
332 URL u = new URL("https://" + getServerName() + SECURE_REFERENCE);
333 HttpURLConnection huc = (HttpURLConnection) u.openConnection();
334 huc.addRequestProperty("Cookie", cookie);
335 return huc.getResponseCode() == 200;
338 public static String login(String email, String pw) throws IOException {
339 URL u = new URL("https://" + getServerName() + "/login");
340 HttpURLConnection huc = (HttpURLConnection) u.openConnection();
342 String csrf = getCSRF(huc);
343 String headerField = stripCookie(huc.getHeaderField("Set-Cookie"));
345 huc = (HttpURLConnection) u.openConnection();
346 cookie(huc, headerField);
347 huc.setDoOutput(true);
348 OutputStream os = huc.getOutputStream();
349 String data = "username=" + URLEncoder.encode(email, "UTF-8") + "&password=" + URLEncoder.encode(pw, "UTF-8") + "&csrf=" + URLEncoder.encode(csrf, "UTF-8");
350 os.write(data.getBytes("UTF-8"));
352 headerField = huc.getHeaderField("Set-Cookie");
353 if (headerField == null) {
356 if (huc.getResponseCode() != 302) {
357 fail(fetchStartErrorMessage(IOUtils.readURL(huc)));
359 return stripCookie(headerField);
362 public static String login(final PrivateKey pk, final X509Certificate ce) throws NoSuchAlgorithmException, KeyManagementException, IOException, MalformedURLException {
364 HttpURLConnection connection = (HttpURLConnection) new URL("https://" + getSecureServerName() + "/login").openConnection();
365 authenticateClientCert(pk, ce, connection);
366 if (connection.getResponseCode() == 302) {
367 assertEquals("https://" + getSecureServerName() + "/", connection.getHeaderField("Location").replaceFirst(":443$", ""));
368 return stripCookie(connection.getHeaderField("Set-Cookie"));
374 public static void authenticateClientCert(final PrivateKey pk, final X509Certificate ce, HttpURLConnection connection) throws NoSuchAlgorithmException, KeyManagementException {
375 KeyManager km = new X509KeyManager() {
378 public String chooseClientAlias(String[] arg0, Principal[] arg1, Socket arg2) {
383 public String chooseServerAlias(String arg0, Principal[] arg1, Socket arg2) {
388 public X509Certificate[] getCertificateChain(String arg0) {
389 return new X509Certificate[] {
395 public String[] getClientAliases(String arg0, Principal[] arg1) {
396 return new String[] {
402 public PrivateKey getPrivateKey(String arg0) {
403 if (arg0.equals("client")) {
410 public String[] getServerAliases(String arg0, Principal[] arg1) {
411 return new String[] {
416 SSLContext sc = SSLContext.getInstance("TLS");
417 sc.init(new KeyManager[] {
420 if (connection instanceof HttpsURLConnection) {
421 ((HttpsURLConnection) connection).setSSLSocketFactory(sc.getSocketFactory());
425 public static String getCSRF(URLConnection u) throws IOException {
426 return getCSRF(u, 0);
429 public static String getCSRF(URLConnection u, int formIndex) throws IOException {
430 String content = IOUtils.readURL(u);
431 return getCSRF(formIndex, content);
434 public static String getCSRF(int formIndex, String content) throws Error {
435 Pattern p = Pattern.compile("<input type='hidden' name='csrf' value='([^']+)'>");
436 Matcher m = p.matcher(content);
437 for (int i = 0; i < formIndex + 1; i++) {
439 throw new Error("No CSRF Token");
445 public static String executeBasicWebInteraction(String cookie, String path, String query) throws MalformedURLException, UnsupportedEncodingException, IOException {
446 return executeBasicWebInteraction(cookie, path, query, 0);
449 public static String executeBasicWebInteraction(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
450 HttpURLConnection uc = post(cookie, path, query, formIndex);
451 if (uc.getResponseCode() == 302) {
454 String error = fetchStartErrorMessage(IOUtils.readURL(uc));
458 public static HttpURLConnection post(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
459 URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
460 uc.addRequestProperty("Cookie", cookie);
461 String csrf = getCSRF(uc, formIndex);
463 uc = new URL("https://" + getServerName() + path).openConnection();
464 uc.addRequestProperty("Cookie", cookie);
465 uc.setDoOutput(true);
466 OutputStream os = uc.getOutputStream();
467 os.write(("csrf=" + URLEncoder.encode(csrf, "UTF-8") + "&" //
469 ).getBytes("UTF-8"));
471 return (HttpURLConnection) uc;
474 public static HttpURLConnection get(String cookie, String path) throws IOException {
475 URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
476 uc.addRequestProperty("Cookie", cookie);
477 return (HttpURLConnection) uc;
480 public EmailAddress createVerifiedEmail(User u) throws InterruptedException, GigiApiException {
481 return createVerifiedEmail(u, createUniqueName() + "test@test.tld");
484 public EmailAddress createVerifiedEmail(User u, String email) throws InterruptedException, GigiApiException {
485 EmailAddress addr = new EmailAddress(u, email, Locale.ENGLISH);
486 TestMail testMail = getMailReceiver().receive();
487 assertEquals(addr.getAddress(), testMail.getTo());
488 String hash = testMail.extractLink().substring(testMail.extractLink().lastIndexOf('=') + 1);
490 getMailReceiver().clearMails();
494 public static URLConnection cookie(URLConnection openConnection, String cookie) {
495 openConnection.setRequestProperty("Cookie", cookie);
496 return openConnection;
499 private static User supporter;
501 public static User getSupporter() throws GigiApiException, IOException {
502 if (supporter != null) {
505 int i = createVerifiedUser("fn", "ln", createUniqueName() + "@email.com", TEST_PASSWORD);
506 try (GigiPreparedStatement ps = new GigiPreparedStatement("INSERT INTO `user_groups` SET `user`=?, `permission`=?::`userGroup`, `grantedby`=?")) {
508 ps.setString(2, Group.SUPPORTER.getDBName());
513 supporter = User.getById(i);