tests/org/cacert/gigi/testUtils/ManagedTest.java

   1 package org.cacert.gigi.testUtils;
   2
   3 import static org.junit.Assert.*;
   4
   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;
  15 import java.net.URL;
  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;
  30
  31 import javax.net.ssl.HttpsURLConnection;
  32 import javax.net.ssl.KeyManager;
  33 import javax.net.ssl.SSLContext;
  34 import javax.net.ssl.X509KeyManager;
  35
  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.Manager;
  46 import org.cacert.gigi.pages.account.MyDetails;
  47 import org.cacert.gigi.pages.main.RegisterPage;
  48 import org.cacert.gigi.testUtils.TestEmailReceiver.TestMail;
  49 import org.cacert.gigi.util.SimpleSigner;
  50 import org.hamcrest.CoreMatchers;
  51 import org.junit.After;
  52 import org.junit.AfterClass;
  53 import org.junit.BeforeClass;
  54
  55 /**
  56  * Base class for test suites who require a launched Gigi instance. The instance
  57  * is cleared once per test suite.
  58  */
  59 public class ManagedTest extends ConfiguredTest {
  60
  61     static {
  62         System.setProperty("sun.net.http.allowRestrictedHeaders", "true");
  63     }
  64
  65     private static TestEmailReceiver ter;
  66
  67     private static Process gigi;
  68
  69     private static String url = "localhost:4443";
  70
  71     private static String acceptLanguage = null;
  72
  73     public static void setAcceptLanguage(String acceptLanguage) {
  74         ManagedTest.acceptLanguage = acceptLanguage;
  75     }
  76
  77     public static String getServerName() {
  78         return url;
  79     }
  80
  81     static {
  82         InitTruststore.run();
  83         HttpURLConnection.setFollowRedirects(false);
  84     }
  85
  86     @BeforeClass
  87     public static void initEnvironmentHook() {
  88         initEnvironment();
  89     }
  90
  91     private static boolean inited = false;
  92
  93     public static Properties initEnvironment() {
  94         try {
  95             Properties mainProps = ConfiguredTest.initEnvironment();
  96             if (inited) {
  97                 return mainProps;
  98             }
  99             inited = true;
 100             purgeDatabase();
 101             String type = testProps.getProperty("type");
 102             generateMainProps(mainProps);
 103             if (type.equals("local")) {
 104                 url = testProps.getProperty("name.www") + ":" + testProps.getProperty("serverPort.https");
 105                 String[] parts = testProps.getProperty("mail").split(":", 2);
 106                 ter = new TestEmailReceiver(new InetSocketAddress(parts[0], Integer.parseInt(parts[1])));
 107                 ter.start();
 108                 if (testProps.getProperty("withSigner", "false").equals("true")) {
 109                     SimpleSigner.runSigner();
 110                 }
 111                 return mainProps;
 112             }
 113             url = testProps.getProperty("name.www") + ":" + testProps.getProperty("serverPort.https");
 114             gigi = Runtime.getRuntime().exec(testProps.getProperty("java"));
 115             DataOutputStream toGigi = new DataOutputStream(gigi.getOutputStream());
 116             System.out.println("... starting server");
 117
 118             byte[] cacerts = Files.readAllBytes(Paths.get("config/cacerts.jks"));
 119             byte[] keystore = Files.readAllBytes(Paths.get("config/keystore.pkcs12"));
 120
 121             DevelLauncher.writeGigiConfig(toGigi, "changeit".getBytes("UTF-8"), "changeit".getBytes("UTF-8"), mainProps, cacerts, keystore);
 122             toGigi.flush();
 123
 124             final BufferedReader br = new BufferedReader(new InputStreamReader(gigi.getErrorStream(), "UTF-8"));
 125             String line;
 126             while ((line = br.readLine()) != null && !line.contains("System successfully started.")) {
 127                 System.err.println(line);
 128             }
 129             new Thread() {
 130
 131                 @Override
 132                 public void run() {
 133                     String line;
 134                     try {
 135                         while ((line = br.readLine()) != null) {
 136                             System.err.println(line);
 137                         }
 138                     } catch (IOException e) {
 139                         e.printStackTrace();
 140                     }
 141                 }
 142             }.start();
 143             if (line == null) {
 144                 throw new Error("Server startup failed");
 145             }
 146             ter = new TestEmailReceiver(new InetSocketAddress("localhost", 8473));
 147             ter.start();
 148             SimpleSigner.runSigner();
 149             return mainProps;
 150         } catch (IOException e) {
 151             throw new Error(e);
 152         } catch (SQLException e1) {
 153             throw new Error(e1);
 154         } catch (InterruptedException e) {
 155             throw new Error(e);
 156         }
 157
 158     }
 159
 160     protected static void await(Job j) throws InterruptedException {
 161         SimpleSigner.ping();
 162         j.waitFor(5000);
 163     }
 164
 165     public static void purgeDatabase() throws SQLException, IOException {
 166         purgeOnlyDB();
 167         clearCaches();
 168     }
 169
 170     public static void clearCaches() throws IOException {
 171         ObjectCache.clearAllCaches();
 172         // String type = testProps.getProperty("type");
 173         URL u = new URL("https://" + getServerName() + "/manage");
 174         u.openConnection().getHeaderField("Location");
 175     }
 176
 177     private static void generateMainProps(Properties mainProps) {
 178         mainProps.setProperty("testrunner", "true");
 179         mainProps.setProperty("host", "127.0.0.1");
 180
 181         mainProps.setProperty("emailProvider", "org.cacert.gigi.email.TestEmailProvider");
 182         mainProps.setProperty("emailProvider.port", "8473");
 183         mainProps.setProperty("sql.driver", testProps.getProperty("sql.driver"));
 184         mainProps.setProperty("sql.url", testProps.getProperty("sql.url"));
 185         mainProps.setProperty("sql.user", testProps.getProperty("sql.user"));
 186         mainProps.setProperty("sql.password", testProps.getProperty("sql.password"));
 187         mainProps.setProperty("testing", "true");
 188     }
 189
 190     @AfterClass
 191     public static void tearDownServer() {
 192         String type = testProps.getProperty("type");
 193         ter.destroy();
 194         if (type.equals("local")) {
 195             return;
 196         }
 197         gigi.destroy();
 198         try {
 199             SimpleSigner.stopSigner();
 200         } catch (InterruptedException e) {
 201             e.printStackTrace();
 202         }
 203     }
 204
 205     public final String uniq = createUniqueName();
 206
 207     @After
 208     public void removeMails() {
 209         ter.reset();
 210     }
 211
 212     @After
 213     public void clearAcceptLanguage() {
 214         ManagedTest.setAcceptLanguage(null);
 215     }
 216
 217     @Override
 218     public MailReceiver getMailReceiver() {
 219         return ter;
 220     }
 221
 222     public static String runRegister(String param) throws IOException {
 223         URL regist = new URL("https://" + getServerName() + RegisterPage.PATH);
 224         HttpURLConnection uc = (HttpURLConnection) regist.openConnection();
 225         HttpURLConnection csrfConn = (HttpURLConnection) regist.openConnection();
 226         if (acceptLanguage != null) {
 227             csrfConn.setRequestProperty("Accept-Language", acceptLanguage);
 228             uc.setRequestProperty("Accept-Language", acceptLanguage);
 229         }
 230
 231         String headerField = csrfConn.getHeaderField("Set-Cookie");
 232         headerField = stripCookie(headerField);
 233
 234         String csrf = getCSRF(csrfConn);
 235         uc.addRequestProperty("Cookie", headerField);
 236         uc.setDoOutput(true);
 237         uc.getOutputStream().write((param + "&csrf=" + csrf).getBytes("UTF-8"));
 238         String d = IOUtils.readURL(uc);
 239         return d;
 240     }
 241
 242     public static org.hamcrest.Matcher<String> hasError() {
 243         return CoreMatchers.containsString("<div class='alert alert-danger error-msgs'>");
 244     }
 245
 246     public static org.hamcrest.Matcher<String> hasNoError() {
 247         return CoreMatchers.not(hasError());
 248     }
 249
 250     public static String fetchStartErrorMessage(String d) throws IOException {
 251         String formFail = "<div class='alert alert-danger error-msgs'>";
 252         int idx = d.indexOf(formFail);
 253         if (idx == -1) {
 254             return null;
 255         }
 256         String startError = d.substring(idx + formFail.length(), idx + formFail.length() + 150).trim();
 257         return startError;
 258     }
 259
 260     public static void registerUser(String firstName, String lastName, String email, String password) {
 261         try {
 262             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";
 263             String data = fetchStartErrorMessage(runRegister(query));
 264             assertNull(data);
 265         } catch (UnsupportedEncodingException e) {
 266             throw new Error(e);
 267         } catch (IOException e) {
 268             throw new Error(e);
 269         }
 270     }
 271
 272     public static int createVerifiedUser(String firstName, String lastName, String email, String password) {
 273         registerUser(firstName, lastName, email, password);
 274         try {
 275             ter.receive().verify();
 276
 277             try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `id` FROM `users` WHERE `email`=?")) {
 278                 ps.setString(1, email);
 279
 280                 GigiResultSet rs = ps.executeQuery();
 281                 if (rs.next()) {
 282                     return rs.getInt(1);
 283                 }
 284             }
 285
 286             throw new Error();
 287         } catch (IOException e) {
 288             throw new Error(e);
 289         }
 290     }
 291
 292     public static void grant(String email, Group g) throws IOException {
 293         HttpURLConnection huc = (HttpURLConnection) new URL("https://" + getServerName() + Manager.PATH).openConnection();
 294         huc.setDoOutput(true);
 295         huc.getOutputStream().write(("addpriv=y&priv=" + URLEncoder.encode(g.getDatabaseName(), "UTF-8") + "&email=" + URLEncoder.encode(email, "UTF-8")).getBytes("UTF-8"));
 296         assertEquals(200, huc.getResponseCode());
 297     }
 298
 299     /**
 300      * Creates a new user with 100 Verification Points given by an (invalid)
 301      * verification.
 302      *
 303      * @param firstName
 304      *            the first name
 305      * @param lastName
 306      *            the last name
 307      * @param email
 308      *            the email
 309      * @param password
 310      *            the password
 311      * @return a new userid.
 312      */
 313     public static int createAssuranceUser(String firstName, String lastName, String email, String password) {
 314         int uid = createVerifiedUser(firstName, lastName, email, password);
 315
 316         makeAssurer(uid);
 317
 318         return uid;
 319     }
 320
 321     protected static String stripCookie(String headerField) {
 322         return headerField.substring(0, headerField.indexOf(';'));
 323     }
 324
 325     public static final String SECURE_REFERENCE = MyDetails.PATH;
 326
 327     public static boolean isLoggedin(String cookie) throws IOException {
 328         URL u = new URL("https://" + getServerName() + SECURE_REFERENCE);
 329         HttpURLConnection huc = (HttpURLConnection) u.openConnection();
 330         huc.addRequestProperty("Cookie", cookie);
 331         return huc.getResponseCode() == 200;
 332     }
 333
 334     public static String login(String email, String pw) throws IOException {
 335         URL u = new URL("https://" + getServerName() + "/login");
 336         HttpURLConnection huc = (HttpURLConnection) u.openConnection();
 337
 338         String csrf = getCSRF(huc);
 339         String headerField = stripCookie(huc.getHeaderField("Set-Cookie"));
 340
 341         huc = (HttpURLConnection) u.openConnection();
 342         cookie(huc, headerField);
 343         huc.setDoOutput(true);
 344         OutputStream os = huc.getOutputStream();
 345         String data = "username=" + URLEncoder.encode(email, "UTF-8") + "&password=" + URLEncoder.encode(pw, "UTF-8") + "&csrf=" + URLEncoder.encode(csrf, "UTF-8");
 346         os.write(data.getBytes("UTF-8"));
 347         os.flush();
 348         headerField = huc.getHeaderField("Set-Cookie");
 349         if (headerField == null) {
 350             return "";
 351         }
 352         return stripCookie(headerField);
 353     }
 354
 355     public static String login(final PrivateKey pk, final X509Certificate ce) throws NoSuchAlgorithmException, KeyManagementException, IOException, MalformedURLException {
 356
 357         HttpURLConnection connection = (HttpURLConnection) new URL("https://" + getServerName().replaceFirst("^www.", "secure.") + "/login").openConnection();
 358         authenticateClientCert(pk, ce, connection);
 359         if (connection.getResponseCode() == 302) {
 360             assertEquals("https://" + getServerName().replaceFirst("^www.", "secure.").replaceFirst(":443$", "") + "/", connection.getHeaderField("Location").replaceFirst(":443$", ""));
 361             return stripCookie(connection.getHeaderField("Set-Cookie"));
 362         } else {
 363             return null;
 364         }
 365     }
 366
 367     public static void authenticateClientCert(final PrivateKey pk, final X509Certificate ce, HttpURLConnection connection) throws NoSuchAlgorithmException, KeyManagementException {
 368         KeyManager km = new X509KeyManager() {
 369
 370             @Override
 371             public String chooseClientAlias(String[] arg0, Principal[] arg1, Socket arg2) {
 372                 return "client";
 373             }
 374
 375             @Override
 376             public String chooseServerAlias(String arg0, Principal[] arg1, Socket arg2) {
 377                 return null;
 378             }
 379
 380             @Override
 381             public X509Certificate[] getCertificateChain(String arg0) {
 382                 return new X509Certificate[] {
 383                         ce
 384                 };
 385             }
 386
 387             @Override
 388             public String[] getClientAliases(String arg0, Principal[] arg1) {
 389                 return new String[] {
 390                         "client"
 391                 };
 392             }
 393
 394             @Override
 395             public PrivateKey getPrivateKey(String arg0) {
 396                 if (arg0.equals("client")) {
 397                     return pk;
 398                 }
 399                 return null;
 400             }
 401
 402             @Override
 403             public String[] getServerAliases(String arg0, Principal[] arg1) {
 404                 return new String[] {
 405                         "client"
 406                 };
 407             }
 408         };
 409         SSLContext sc = SSLContext.getInstance("TLS");
 410         sc.init(new KeyManager[] {
 411                 km
 412         }, null, null);
 413         if (connection instanceof HttpsURLConnection) {
 414             ((HttpsURLConnection) connection).setSSLSocketFactory(sc.getSocketFactory());
 415         }
 416     }
 417
 418     public static String getCSRF(URLConnection u) throws IOException {
 419         return getCSRF(u, 0);
 420     }
 421
 422     public static String getCSRF(URLConnection u, int formIndex) throws IOException {
 423         String content = IOUtils.readURL(u);
 424         return getCSRF(formIndex, content);
 425     }
 426
 427     public static String getCSRF(int formIndex, String content) throws Error {
 428         Pattern p = Pattern.compile("<input type='hidden' name='csrf' value='([^']+)'>");
 429         Matcher m = p.matcher(content);
 430         for (int i = 0; i < formIndex + 1; i++) {
 431             if ( !m.find()) {
 432                 throw new Error("No CSRF Token");
 433             }
 434         }
 435         return m.group(1);
 436     }
 437
 438     public static String executeBasicWebInteraction(String cookie, String path, String query) throws MalformedURLException, UnsupportedEncodingException, IOException {
 439         return executeBasicWebInteraction(cookie, path, query, 0);
 440     }
 441
 442     public static String executeBasicWebInteraction(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
 443         URLConnection uc = post(cookie, path, query, formIndex);
 444         String error = fetchStartErrorMessage(IOUtils.readURL(uc));
 445         return error;
 446     }
 447
 448     public static HttpURLConnection post(String cookie, String path, String query, int formIndex) throws IOException, MalformedURLException, UnsupportedEncodingException {
 449         URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
 450         uc.addRequestProperty("Cookie", cookie);
 451         String csrf = getCSRF(uc, formIndex);
 452
 453         uc = new URL("https://" + getServerName() + path).openConnection();
 454         uc.addRequestProperty("Cookie", cookie);
 455         uc.setDoOutput(true);
 456         OutputStream os = uc.getOutputStream();
 457         os.write(("csrf=" + URLEncoder.encode(csrf, "UTF-8") + "&" //
 458                 + query//
 459         ).getBytes("UTF-8"));
 460         os.flush();
 461         return (HttpURLConnection) uc;
 462     }
 463
 464     public static HttpURLConnection get(String cookie, String path) throws IOException {
 465         URLConnection uc = new URL("https://" + getServerName() + path).openConnection();
 466         uc.addRequestProperty("Cookie", cookie);
 467         return (HttpURLConnection) uc;
 468     }
 469
 470     public EmailAddress createVerifiedEmail(User u) throws InterruptedException, GigiApiException {
 471         return createVerifiedEmail(u, createUniqueName() + "test@test.tld");
 472     }
 473
 474     public EmailAddress createVerifiedEmail(User u, String email) throws InterruptedException, GigiApiException {
 475         EmailAddress addr = new EmailAddress(u, email, Locale.ENGLISH);
 476         TestMail testMail = getMailReceiver().receive();
 477         assertEquals(addr.getAddress(), testMail.getTo());
 478         String hash = testMail.extractLink().substring(testMail.extractLink().lastIndexOf('=') + 1);
 479         addr.verify(hash);
 480         getMailReceiver().clearMails();
 481         return addr;
 482     }
 483
 484     public static URLConnection cookie(URLConnection openConnection, String cookie) {
 485         openConnection.setRequestProperty("Cookie", cookie);
 486         return openConnection;
 487     }
 488
 489 }