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