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