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