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.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;
  53
  54 /**
  55  * Base class for test suites who require a launched Gigi instance. The instance
  56  * is cleared once per test suite.
  57  */
  58 public class ManagedTest extends ConfiguredTest {
  59
  60     static {
  61         System.setProperty("sun.net.http.allowRestrictedHeaders", "true");
  62     }
  63
  64     private static TestEmailReceiver ter;
  65
  66     private static Process gigi;
  67
  68     private static String url = "localhost:4443";
  69
  70     private static String acceptLanguage = null;
  71
  72     public static void setAcceptLanguage(String acceptLanguage) {
  73         ManagedTest.acceptLanguage = acceptLanguage;
  74     }
  75
  76     public static String getServerName() {
  77         return url.replaceFirst(":443$", "");
  78     }
  79
  80     public static String getSecureServerName() {
  81         return getServerName().replaceAll("^www\\.", "secure.");
  82     }
  83
  84     static {
  85         InitTruststore.run();
  86         HttpURLConnection.setFollowRedirects(false);
  87     }
  88
  89     @BeforeClass
  90     public static void initEnvironmentHook() {
  91         initEnvironment();
  92     }
  93
  94     private static boolean inited = false;
  95
  96     public static Properties initEnvironment() {
  97         try {
  98             Properties mainProps = ConfiguredTest.initEnvironment();
  99             if (inited) {
 100                 return mainProps;
 101             }
 102             inited = true;
 103             purgeDatabase();
 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])));
 110                 ter.start();
 111                 if (testProps.getProperty("withSigner", "false").equals("true")) {
 112                     SimpleSigner.runSigner();
 113                 }
 114                 return mainProps;
 115             }
 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");
 120
 121             byte[] cacerts = Files.readAllBytes(Paths.get("config/cacerts.jks"));
 122             byte[] keystore = Files.readAllBytes(Paths.get("config/keystore.pkcs12"));
 123
 124             DevelLauncher.writeGigiConfig(toGigi, "changeit".getBytes("UTF-8"), "changeit".getBytes("UTF-8"), mainProps, cacerts, keystore);
 125             toGigi.flush();
 126
 127             final BufferedReader br = new BufferedReader(new InputStreamReader(gigi.getErrorStream(), "UTF-8"));
 128             String line;
 129             while ((line = br.readLine()) != null && !line.contains("System successfully started.")) {
 130                 System.err.println(line);
 131             }
 132             new Thread() {
 133
 134                 @Override
 135                 public void run() {
 136                     String line;
 137                     try {
 138                         while ((line = br.readLine()) != null) {
 139                             System.err.println(line);
 140                         }
 141                     } catch (IOException e) {
 142                         e.printStackTrace();
 143                     }
 144                 }
 145             }.start();
 146             if (line == null) {
 147                 throw new Error("Server startup failed");
 148             }
 149             ter = new TestEmailReceiver(new InetSocketAddress("localhost", 8473));
 150             ter.start();
 151             SimpleSigner.runSigner();
 152             return mainProps;
 153         } catch (IOException e) {
 154             throw new Error(e);
 155         } catch (SQLException e1) {
 156             throw new Error(e1);
 157         } catch (InterruptedException e) {
 158             throw new Error(e);
 159         }
 160
 161     }
 162
 163     protected static void await(Job j) throws InterruptedException {
 164         SimpleSigner.ping();
 165         j.waitFor(5000);
 166     }
 167
 168     public static void purgeDatabase() throws SQLException, IOException {
 169         purgeOnlyDB();
 170         clearCaches();
 171     }
 172
 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");
 178     }
 179
 180     private static void generateMainProps(Properties mainProps) {
 181         mainProps.setProperty("testrunner", "true");
 182         mainProps.setProperty("host", "127.0.0.1");
 183
 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");
 191     }
 192
 193     @AfterClass
 194     public static void tearDownServer() {
 195         String type = testProps.getProperty("type");
 196         ter.destroy();
 197         if (type.equals("local")) {
 198             return;
 199         }
 200         gigi.destroy();
 201         try {
 202             SimpleSigner.stopSigner();
 203         } catch (InterruptedException e) {
 204             e.printStackTrace();
 205         }
 206     }
 207
 208     public final String uniq = createUniqueName();
 209
 210     @After
 211     public void removeMails() {
 212         ter.reset();
 213     }
 214
 215     @After
 216     public void clearAcceptLanguage() {
 217         ManagedTest.setAcceptLanguage(null);
 218     }
 219
 220     @Override
 221     public MailReceiver getMailReceiver() {
 222         return ter;
 223     }
 224
 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);
 232         }
 233
 234         String headerField = csrfConn.getHeaderField("Set-Cookie");
 235         headerField = stripCookie(headerField);
 236
 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) {
 242             return "";
 243         }
 244         String d = IOUtils.readURL(uc);
 245         return d;
 246     }
 247
 248     public static org.hamcrest.Matcher<String> hasError() {
 249         return CoreMatchers.containsString("<div class='alert alert-danger error-msgs'>");
 250     }
 251
 252     public static org.hamcrest.Matcher<String> hasNoError() {
 253         return CoreMatchers.not(hasError());
 254     }
 255
 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);
 259         if (idx == -1) {
 260             return null;
 261         }
 262         String startError = d.substring(idx + formFail.length(), idx + formFail.length() + 150).trim();
 263         return startError;
 264     }
 265
 266     public static void registerUser(String firstName, String lastName, String email, String password) {
 267         try {
 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));
 270             assertNull(data);
 271         } catch (UnsupportedEncodingException e) {
 272             throw new Error(e);
 273         } catch (IOException e) {
 274             throw new Error(e);
 275         }
 276     }
 277
 278     public static int createVerifiedUser(String firstName, String lastName, String email, String password) {
 279         registerUser(firstName, lastName, email, password);
 280         try {
 281             ter.receive().verify();
 282
 283             try (GigiPreparedStatement ps = new GigiPreparedStatement("SELECT `id` FROM `users` WHERE `email`=?")) {
 284                 ps.setString(1, email);
 285
 286                 GigiResultSet rs = ps.executeQuery();
 287                 if (rs.next()) {
 288                     return rs.getInt(1);
 289                 }
 290             }
 291
 292             throw new Error();
 293         } catch (IOException e) {
 294             throw new Error(e);
 295         }
 296     }
 297
 298     public static void grant(User u, Group g) throws IOException, GigiApiException {
 299         u.grantGroup(getSupporter(), g);
 300         clearCaches();
 301     }
 302
 303     /**
 304      * Creates a new user with 100 Verification Points given by an (invalid)
 305      * verification.
 306      *
 307      * @param firstName
 308      *            the first name
 309      * @param lastName
 310      *            the last name
 311      * @param email
 312      *            the email
 313      * @param password
 314      *            the password
 315      * @return a new userid.
 316      */
 317     public static int createAssuranceUser(String firstName, String lastName, String email, String password) {
 318         int uid = createVerifiedUser(firstName, lastName, email, password);
 319
 320         makeAssurer(uid);
 321
 322         return uid;
 323     }
 324
 325     protected static String stripCookie(String headerField) {
 326         return headerField.substring(0, headerField.indexOf(';'));
 327     }
 328
 329     public static final String SECURE_REFERENCE = MyDetails.PATH;
 330
 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;
 336     }
 337
 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();
 341
 342         String csrf = getCSRF(huc);
 343         String headerField = stripCookie(huc.getHeaderField("Set-Cookie"));
 344
 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"));
 351         os.flush();
 352         headerField = huc.getHeaderField("Set-Cookie");
 353         if (headerField == null) {
 354             return "";
 355         }
 356         if (huc.getResponseCode() != 302) {
 357             fail(fetchStartErrorMessage(IOUtils.readURL(huc)));
 358         }
 359         return stripCookie(headerField);
 360     }
 361
 362     public static String login(final PrivateKey pk, final X509Certificate ce) throws NoSuchAlgorithmException, KeyManagementException, IOException, MalformedURLException {
 363
 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"));
 369         } else {
 370             return null;
 371         }
 372     }
 373
 374     public static void authenticateClientCert(final PrivateKey pk, final X509Certificate ce, HttpURLConnection connection) throws NoSuchAlgorithmException, KeyManagementException {
 375         KeyManager km = new X509KeyManager() {
 376
 377             @Override
 378             public String chooseClientAlias(String[] arg0, Principal[] arg1, Socket arg2) {
 379                 return "client";
 380             }
 381
 382             @Override
 383             public String chooseServerAlias(String arg0, Principal[] arg1, Socket arg2) {
 384                 return null;
 385             }
 386
 387             @Override
 388             public X509Certificate[] getCertificateChain(String arg0) {
 389                 return new X509Certificate[] {
 390                         ce
 391                 };
 392             }
 393
 394             @Override
 395             public String[] getClientAliases(String arg0, Principal[] arg1) {
 396                 return new String[] {
 397                         "client"
 398                 };
 399             }
 400
 401             @Override
 402             public PrivateKey getPrivateKey(String arg0) {
 403                 if (arg0.equals("client")) {
 404                     return pk;
 405                 }
 406                 return null;
 407             }
 408
 409             @Override
 410             public String[] getServerAliases(String arg0, Principal[] arg1) {
 411                 return new String[] {
 412                         "client"
 413                 };
 414             }
 415         };
 416         SSLContext sc = SSLContext.getInstance("TLS");
 417         sc.init(new KeyManager[] {
 418                 km
 419         }, null, null);
 420         if (connection instanceof HttpsURLConnection) {
 421             ((HttpsURLConnection) connection).setSSLSocketFactory(sc.getSocketFactory());
 422         }
 423     }
 424
 425     public static String getCSRF(URLConnection u) throws IOException {
 426         return getCSRF(u, 0);
 427     }
 428
 429     public static String getCSRF(URLConnection u, int formIndex) throws IOException {
 430         String content = IOUtils.readURL(u);
 431         return getCSRF(formIndex, content);
 432     }
 433
 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++) {
 438             if ( !m.find()) {
 439                 throw new Error("No CSRF Token:\n" + content);
 440             }
 441         }
 442         return m.group(1);
 443     }
 444
 445     public static String executeBasicWebInteraction(String cookie, String path, String query) throws MalformedURLException, UnsupportedEncodingException, IOException {
 446         return executeBasicWebInteraction(cookie, path, query, 0);
 447     }
 448
 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) {
 452             return null;
 453         }
 454         String error = fetchStartErrorMessage(IOUtils.readURL(uc));
 455         return error;
 456     }
 457
 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);
 462
 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") + "&" //
 468                 + query//
 469         ).getBytes("UTF-8"));
 470         os.flush();
 471         return (HttpURLConnection) uc;
 472     }
 473
 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;
 478     }
 479
 480     public EmailAddress createVerifiedEmail(User u) throws InterruptedException, GigiApiException {
 481         return createVerifiedEmail(u, createUniqueName() + "test@test.tld");
 482     }
 483
 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);
 489         addr.verify(hash);
 490         getMailReceiver().clearMails();
 491         return addr;
 492     }
 493
 494     public static URLConnection cookie(URLConnection openConnection, String cookie) {
 495         openConnection.setRequestProperty("Cookie", cookie);
 496         return openConnection;
 497     }
 498
 499     private static User supporter;
 500
 501     public static User getSupporter() throws GigiApiException, IOException {
 502         if (supporter != null) {
 503             return supporter;
 504         }
 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`=?")) {
 507             ps.setInt(1, i);
 508             ps.setString(2, Group.SUPPORTER.getDBName());
 509             ps.setInt(3, i);
 510             ps.execute();
 511         }
 512         clearCaches();
 513         supporter = User.getById(i);
 514         return supporter;
 515     }
 516 }