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