├── src
├── test
│ ├── resources
│ │ ├── test.txt
│ │ └── hoge.zip
│ └── java
│ │ └── com
│ │ └── after_sunrise
│ │ └── brutus
│ │ ├── impl
│ │ ├── txt
│ │ │ ├── TextAttackerTest.java
│ │ │ └── TextBarrackTest.java
│ │ ├── zip
│ │ │ ├── Zip4jAttackerTest.java
│ │ │ ├── SystemZipAttackerTest.java
│ │ │ └── ZipBarrackTest.java
│ │ ├── BarrackImplTest.java
│ │ ├── MastermindImplTest.java
│ │ └── BlacksmithImplTest.java
│ │ └── BrutusTest.java
└── main
│ ├── resources
│ └── log4j.properties
│ └── java
│ └── com
│ └── after_sunrise
│ └── brutus
│ ├── Attacker.java
│ ├── impl
│ ├── txt
│ │ ├── TextAttacker.java
│ │ └── TextBarrack.java
│ ├── pdf
│ │ ├── Pdf4jAttacker.java
│ │ └── PdfBarrack.java
│ ├── zip
│ │ ├── ZipBarrack.java
│ │ ├── Zip4jAttacker.java
│ │ └── SystemZipAttacker.java
│ ├── BarrackImpl.java
│ ├── MastermindImpl.java
│ └── BlacksmithImpl.java
│ ├── Barrack.java
│ ├── Mastermind.java
│ ├── Blacksmith.java
│ └── Brutus.java
├── .travis.yml
├── .gitignore
├── README.md
├── pom.xml
└── LICENSE
/src/test/resources/test.txt:
--------------------------------------------------------------------------------
1 | A9%
2 | foo
3 | bar
--------------------------------------------------------------------------------
/src/test/resources/hoge.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/after-the-sunrise/brutus/HEAD/src/test/resources/hoge.zip
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 |
3 | jdk:
4 | - openjdk8
5 |
6 | notifications:
7 | email:
8 | - scm@after-sunrise.com
9 |
10 | after_success:
11 | - mvn cobertura:cobertura coveralls:report
12 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # OS
2 | .DS_Store
3 | Thumbs.db
4 |
5 | # IDE (Eclipse)
6 | .classpath
7 | .project
8 | .settings/
9 | build/
10 |
11 | # IDE (Intellij IDEA)
12 | *.iml
13 | .idea/
14 | out/
15 |
16 | # Maven
17 | target/
18 | pom.xml.releaseBackup
19 | release.properties
20 |
21 | # Runtime
22 | logs/
23 |
24 |
--------------------------------------------------------------------------------
/src/main/resources/log4j.properties:
--------------------------------------------------------------------------------
1 | # Console
2 | log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
3 | log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
4 | log4j.appender.CONSOLE.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss.SSS}][%-5p][%t][%c{1}] - %m%n
5 | # Root
6 | log4j.rootLogger=INFO, CONSOLE
7 | # Package
8 | log4j.logger.com.after_sunrise.brutus=DEBUG
9 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/Attacker.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import java.util.function.Predicate;
4 |
5 | /**
6 | *
7 | * Execute the actual attack with the given passwords.
8 | *
9 | *
10 | * 'Cowards die many times before their deaths.'
11 | *
12 | *
13 | * @author takanori.takase
14 | */
15 | public interface Attacker extends Predicate {
16 |
17 | /**
18 | * Execute the actual attack with the given password.
19 | *
20 | * @param knife Password used for the attack.
21 | * @return {@code true} if the attack succeeded, otherwise {@code false}.
22 | */
23 | @Override
24 | boolean test(char[] knife);
25 |
26 | }
27 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/txt/TextAttackerTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.txt;
2 |
3 | import org.junit.Before;
4 | import org.junit.Test;
5 |
6 | import static org.junit.Assert.*;
7 |
8 | /**
9 | * @author takanori.takase
10 | */
11 | public class TextAttackerTest {
12 |
13 | private TextAttacker target;
14 |
15 | @Before
16 | public void setUp() throws Exception {
17 | target = new TextAttacker("test");
18 | }
19 |
20 | @Test
21 | public void testToString() throws Exception {
22 | assertEquals("TextAttacker{text=test}", target.toString());
23 | }
24 |
25 | @Test
26 | public void test() throws Exception {
27 |
28 | assertTrue(target.test("test".toCharArray()));
29 |
30 | assertFalse(target.test("hoge".toCharArray()));
31 |
32 | }
33 |
34 | }
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/txt/TextAttacker.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.txt;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 |
5 | import java.util.Arrays;
6 |
7 | /**
8 | * {@link Attacker} implementation which simply compares the input with a predefined text.
9 | *
10 | * @author takanori.takase
11 | */
12 | public class TextAttacker implements Attacker {
13 |
14 | private final char[] text;
15 |
16 | public TextAttacker(String text) {
17 | this.text = text.toCharArray();
18 | }
19 |
20 | @Override
21 | public String toString() {
22 | return String.format("%s{text=%s}", //
23 | getClass().getSimpleName(), String.valueOf(text));
24 | }
25 |
26 | @Override
27 | public boolean test(char[] knife) {
28 | return Arrays.equals(text, knife);
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/txt/TextBarrackTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.txt;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import org.junit.Before;
5 | import org.junit.Test;
6 |
7 | import static org.junit.Assert.assertTrue;
8 |
9 | /**
10 | * @author takanori.takase
11 | */
12 | public class TextBarrackTest {
13 |
14 | private TextBarrack target;
15 |
16 | @Before
17 | public void setUp() {
18 | target = new TextBarrack();
19 | }
20 |
21 | @Test
22 | public void apply() throws Exception {
23 |
24 | Attacker attacker = target.apply("src/test/resources/test.txt");
25 |
26 | assertTrue(attacker instanceof TextAttacker);
27 |
28 | }
29 |
30 | @Test(expected = IllegalArgumentException.class)
31 | public void apply_Exception() throws Exception {
32 |
33 | target.apply("src/test/resources/unknown.txt");
34 |
35 | }
36 |
37 | }
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/Barrack.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import java.util.function.Function;
4 |
5 | /**
6 | *
7 | * Factory for creating {@link Attacker} instances.
8 | *
9 | *
10 | * 'Conspiracy? It all sounds greek to me.'
11 | *
12 | *
13 | * @author takanori.takase
14 | */
15 | public interface Barrack extends Function {
16 |
17 |
18 | /**
19 | * Criteria for preparing {@link Attacker} instance.
20 | *
21 | * @author takanori.takase
22 | */
23 | interface BarrackContext {
24 |
25 | /**
26 | * @return Use native library if available.
27 | */
28 | boolean useNative();
29 |
30 | }
31 |
32 | /**
33 | * Generate an attacker instance for the given file.
34 | *
35 | * @param path Path of the file for that attacker to attack.
36 | * @return New attacker instance.
37 | */
38 | @Override
39 | Attacker apply(String path);
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/zip/Zip4jAttackerTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import org.junit.Test;
4 |
5 | import java.io.IOException;
6 |
7 | import static org.junit.Assert.*;
8 |
9 | /**
10 | * @author takanori.takase
11 | */
12 | public class Zip4jAttackerTest {
13 |
14 | @Test
15 | public void testToString() throws Exception {
16 |
17 | Zip4jAttacker target = new Zip4jAttacker("src/test/resources/hoge.zip");
18 |
19 | assertNotNull(target.toString());
20 |
21 | }
22 |
23 | @Test
24 | public void test() throws Exception {
25 |
26 | Zip4jAttacker target = new Zip4jAttacker("src/test/resources/hoge.zip");
27 |
28 | assertTrue(target.test("aZ".toCharArray()));
29 |
30 | assertFalse(target.test("00".toCharArray()));
31 |
32 | }
33 |
34 | @Test
35 | public void test_NoFile() throws Exception {
36 |
37 | try {
38 |
39 | new Zip4jAttacker("src/test/resources/unknown.zip");
40 |
41 | fail();
42 |
43 | } catch (IOException e) {
44 |
45 | assertEquals("Not a zip file.", e.getMessage());
46 |
47 | }
48 |
49 |
50 | }
51 |
52 | }
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/Mastermind.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import java.util.concurrent.Callable;
4 |
5 | /**
6 | *
7 | * Coordinate the brute-force attack.
8 | *
9 | *
10 | * 'Men at some time are masters of their fates.'
11 | *
12 | *
13 | * @author takanori.takase
14 | */
15 | public interface Mastermind extends Callable {
16 |
17 | /**
18 | * Preconditions for coordinating the attack.
19 | *
20 | * @author takanori.takase
21 | */
22 | interface MastermindContext {
23 |
24 | /**
25 | * @return Path of the input file.
26 | */
27 | String getInputPath();
28 |
29 | /**
30 | * @return Number of concurrent workers to use for concurrent attacks.
31 | */
32 | int getConcurrency();
33 |
34 | /**
35 | * @return Time-out threshold in millis to abort the attack.
36 | */
37 | long getTimeoutInMillis();
38 |
39 | }
40 |
41 | /**
42 | * Start the attack.
43 | *
44 | * @return Successful password if found, or {@code null} otherwise.
45 | * @throws Exception If the attack failed.
46 | */
47 | String call() throws Exception;
48 |
49 | }
50 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/txt/TextBarrack.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.txt;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import com.google.common.io.Files;
6 | import org.slf4j.Logger;
7 | import org.slf4j.LoggerFactory;
8 |
9 | import java.io.File;
10 | import java.io.IOException;
11 | import java.nio.charset.StandardCharsets;
12 |
13 | /**
14 | * Factory to create {@link Attacker} instances for text files.
15 | * Note that only the first line of the text file will be used for comparison.
16 | *
17 | * @author takanori.takase
18 | */
19 | public class TextBarrack implements Barrack {
20 |
21 | private final Logger log = LoggerFactory.getLogger(getClass());
22 |
23 | @Override
24 | public Attacker apply(String path) {
25 |
26 | try {
27 |
28 | File file = new File(path);
29 |
30 | String line = Files.readFirstLine(file, StandardCharsets.UTF_8);
31 |
32 | return new TextAttacker(line);
33 |
34 | } catch (IOException e) {
35 |
36 | log.warn("Could not instantiate an attacker. Reason = {}", e.getMessage());
37 |
38 | throw new IllegalArgumentException(e);
39 |
40 | }
41 |
42 | }
43 |
44 | }
45 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/pdf/Pdf4jAttacker.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.pdf;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.google.common.annotations.VisibleForTesting;
5 | import org.apache.pdfbox.Loader;
6 | import org.apache.pdfbox.pdmodel.PDDocument;
7 |
8 | import java.io.File;
9 | import java.io.IOException;
10 |
11 | /**
12 | * {@link Attacker} implementation for Pdf files using PDFBox.
13 | *
14 | * @author takanori.takase
15 | */
16 | public class Pdf4jAttacker implements Attacker {
17 |
18 | private final File input;
19 |
20 | public Pdf4jAttacker(String input) throws IOException {
21 |
22 | this.input = toInput(input);
23 |
24 | }
25 |
26 | @VisibleForTesting
27 | private File toInput(String path) throws IOException {
28 |
29 | return new File(path);
30 |
31 | }
32 |
33 | @Override
34 | public String toString() {
35 | return String.format("%s{input=%s}", getClass().getSimpleName(), input);
36 | }
37 |
38 | @Override
39 | public boolean test(char[] knife) {
40 |
41 | String password = new String(knife);
42 |
43 | try (PDDocument doc = Loader.loadPDF(input, password)) {
44 |
45 | doc.setAllSecurityToBeRemoved(true);
46 |
47 | } catch (IOException e) {
48 |
49 | return false;
50 |
51 | }
52 |
53 | return true;
54 |
55 | }
56 |
57 | }
58 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/zip/SystemZipAttackerTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import org.junit.Test;
5 |
6 | import java.nio.file.Paths;
7 |
8 | import static org.junit.Assert.*;
9 |
10 | /**
11 | * @author takanori.takase
12 | */
13 | public class SystemZipAttackerTest {
14 |
15 | @Test(timeout = 5000L)
16 | public void testIsAvailable() throws Exception {
17 |
18 | // Either true or false, depending on the testing machine.
19 | SystemZipAttacker.isAvailable();
20 |
21 | // Command not finished. (Could fail due to 'sleep' command not available.)
22 | assertFalse(SystemZipAttacker.isAvailable(new String[]{"sleep", "10"}, 1L));
23 |
24 | // Command does not exist.
25 | assertFalse(SystemZipAttacker.isAvailable(new String[]{"unzip_test", "-v"}, 1000L));
26 |
27 | }
28 |
29 | @Test
30 | public void testToString() {
31 |
32 | String absolute = Paths.get("src/test/resources/hoge.zip").toAbsolutePath().toString();
33 |
34 | assertEquals("SystemZipAttacker{input=" + absolute + "}", //
35 | new SystemZipAttacker("src/test/resources/hoge.zip").toString());
36 |
37 | }
38 |
39 | @Test
40 | public void test() throws Exception {
41 |
42 | Attacker target = new SystemZipAttacker("src/test/resources/hoge.zip");
43 |
44 | assertTrue(target.test("aZ".toCharArray()));
45 |
46 | assertFalse(target.test("00".toCharArray()));
47 |
48 | }
49 |
50 | }
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/pdf/PdfBarrack.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.pdf;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import org.slf4j.Logger;
6 | import org.slf4j.LoggerFactory;
7 |
8 | import java.io.File;
9 | import java.io.IOException;
10 | import java.util.Objects;
11 |
12 | /**
13 | * Factory to create {@link Attacker} instances for Pdf files.
14 | *
15 | * @author takanori.takase
16 | */
17 | public class PdfBarrack implements Barrack {
18 |
19 | private final Logger log = LoggerFactory.getLogger(getClass());
20 |
21 | private final BarrackContext context;
22 |
23 | public PdfBarrack(BarrackContext context) {
24 | this.context = Objects.requireNonNull(context);
25 | }
26 |
27 | @Override
28 | public Attacker apply(String path) {
29 |
30 | try {
31 |
32 | checkPath(path);
33 |
34 | return new Pdf4jAttacker(path);
35 |
36 | } catch (Exception e) {
37 |
38 | log.warn("Could not instantiate an attacker. Reason = {}", e.getMessage());
39 |
40 | throw new IllegalArgumentException(e);
41 |
42 | }
43 |
44 | }
45 |
46 | private void checkPath(String path) throws IOException {
47 |
48 | File file = new File(path);
49 |
50 | if (!file.exists()) {
51 | throw new IOException("File does not exist.");
52 | }
53 |
54 | if (file.isDirectory()) {
55 | throw new IOException("File is directory.");
56 | }
57 |
58 | }
59 |
60 | }
61 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/Blacksmith.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import java.util.function.Supplier;
4 |
5 | /**
6 | *
7 | * Supply a stream of passwords.
8 | *
9 | *
10 | * An unique password is supplied for each {@link Blacksmith#get()} method invocation,
11 | * and a same password is given only once throughout the lifetime of this instance,
12 | * meaning there is no undo-ing the method invocation.
13 | *
14 | *
15 | * 'The pen is mightier than the sword.'
16 | *
17 | *
18 | * @author takanori.takase
19 | */
20 | public interface Blacksmith extends Supplier {
21 |
22 | /**
23 | * Criteria for composing the password character combination.
24 | *
25 | * @author takanori.takase
26 | */
27 | interface BlacksmithContext {
28 |
29 | /**
30 | * @return Minimum length of the password. (inclusive)
31 | */
32 | int getMinLength();
33 |
34 | /**
35 | * @return Maximum length of the password. (inclusive)
36 | */
37 | int getMaxLength();
38 |
39 | /**
40 | * @return Include lower-case alphabets. [a-z]
41 | */
42 | boolean isIncludeLower();
43 |
44 | /**
45 | * @return Include upper-case alphabets. [A-Z]
46 | */
47 | boolean isIncludeUpper();
48 |
49 | /**
50 | * @return Include numbers. [0-9]
51 | */
52 | boolean isIncludeNumber();
53 |
54 | /**
55 | * @return Include printable symbols, such as sharp(#) and plus(+).
56 | */
57 | boolean isIncludeSymbol();
58 |
59 |
60 | /**
61 | * @return Include non-printable control characters, such as NUL and DEL.
62 | */
63 | boolean isIncludeControl();
64 |
65 | }
66 |
67 | /**
68 | * Retrieve the next password.
69 | *
70 | * @return Password text, or {@code null} if no more passwords are available.
71 | */
72 | @Override
73 | char[] get();
74 |
75 | }
76 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/zip/ZipBarrack.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import org.slf4j.Logger;
6 | import org.slf4j.LoggerFactory;
7 |
8 | import java.io.File;
9 | import java.io.IOException;
10 | import java.util.Objects;
11 |
12 | /**
13 | * Factory to create {@link Attacker} instances for Zip files.
14 | *
15 | * @author takanori.takase
16 | */
17 | public class ZipBarrack implements Barrack {
18 |
19 | private final Logger log = LoggerFactory.getLogger(getClass());
20 |
21 | private final BarrackContext context;
22 |
23 | public ZipBarrack(BarrackContext context) {
24 | this.context = Objects.requireNonNull(context);
25 | }
26 |
27 | @Override
28 | public Attacker apply(String path) {
29 |
30 | try {
31 |
32 | checkPath(path);
33 |
34 | if (context.useNative()) {
35 |
36 | if (SystemZipAttacker.isAvailable()) {
37 |
38 | log.info("Using system library.");
39 |
40 | return new SystemZipAttacker(path);
41 |
42 | }
43 |
44 | log.info("System library not available. Using Zip4j library.");
45 |
46 | } else {
47 |
48 | log.info("Using Zip4j library.");
49 |
50 | }
51 |
52 | return new Zip4jAttacker(path);
53 |
54 | } catch (Exception e) {
55 |
56 | log.warn("Could not instantiate an attacker. Reason = {}", e.getMessage());
57 |
58 | throw new IllegalArgumentException(e);
59 |
60 | }
61 |
62 | }
63 |
64 | private void checkPath(String path) throws IOException {
65 |
66 | File file = new File(path);
67 |
68 | if (!file.exists()) {
69 | throw new IOException("File does not exist.");
70 | }
71 |
72 | if (file.isDirectory()) {
73 | throw new IOException("File is directory.");
74 | }
75 |
76 | }
77 |
78 |
79 | }
80 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/zip/Zip4jAttacker.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.google.common.annotations.VisibleForTesting;
5 | import net.lingala.zip4j.ZipFile;
6 | import net.lingala.zip4j.exception.ZipException;
7 |
8 | import java.io.IOException;
9 | import java.nio.file.Path;
10 | import java.nio.file.Paths;
11 |
12 | /**
13 | * {@link Attacker} implementation for Zip files using Zip4j.
14 | *
15 | * @author takanori.takase
16 | */
17 | public class Zip4jAttacker implements Attacker {
18 |
19 | private static final String TMPDIR = "java.io.tmpdir";
20 |
21 | private final ZipFile input;
22 |
23 | private final String output;
24 |
25 | public Zip4jAttacker(String input) throws ZipException, IOException {
26 |
27 | this.input = toInput(input);
28 |
29 | this.output = toOutput(input);
30 |
31 | }
32 |
33 | @VisibleForTesting
34 | private ZipFile toInput(String path) throws ZipException, IOException {
35 |
36 | ZipFile zipFile = new ZipFile(path);
37 |
38 | if (!zipFile.isValidZipFile()) {
39 |
40 | throw new IOException("Not a zip file.");
41 |
42 | }
43 |
44 | return zipFile;
45 |
46 | }
47 |
48 | @VisibleForTesting
49 | private String toOutput(String path) {
50 |
51 | String name = Paths.get(path).getFileName().toString();
52 |
53 | String temp = System.getProperty(TMPDIR);
54 |
55 | Path output = Paths.get(temp, getClass().getSimpleName(), name);
56 |
57 | return output.toAbsolutePath().toString();
58 |
59 | }
60 |
61 | @Override
62 | public String toString() {
63 | return String.format("%s{input=%s, output=%s}", //
64 | getClass().getSimpleName(), input.getFile(), output);
65 | }
66 |
67 | @Override
68 | public boolean test(char[] knife) {
69 |
70 | try {
71 |
72 | input.setPassword(knife);
73 |
74 | input.extractAll(output);
75 |
76 | return true;
77 |
78 | } catch (ZipException e) {
79 |
80 | return false;
81 |
82 | }
83 |
84 | }
85 |
86 | }
87 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/BarrackImpl.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import com.after_sunrise.brutus.impl.pdf.PdfBarrack;
6 | import com.after_sunrise.brutus.impl.txt.TextBarrack;
7 | import com.after_sunrise.brutus.impl.zip.ZipBarrack;
8 | import com.google.common.annotations.VisibleForTesting;
9 | import com.google.inject.Inject;
10 | import org.slf4j.Logger;
11 | import org.slf4j.LoggerFactory;
12 |
13 | import java.util.HashMap;
14 | import java.util.Map;
15 |
16 | /**
17 | * Delegate method invocation to other {@link Barrack} by the path suffix.
18 | *
19 | * @author takanori.takase
20 | */
21 | public class BarrackImpl implements Barrack {
22 |
23 | private static final char DELIMITER = '.';
24 |
25 | private final Logger log = LoggerFactory.getLogger(getClass());
26 |
27 | private final Map delegates;
28 |
29 | @Inject
30 | public BarrackImpl(BarrackContext context) {
31 |
32 | this.delegates = new HashMap<>();
33 |
34 | this.delegates.put("txt", new TextBarrack());
35 |
36 | this.delegates.put("zip", new ZipBarrack(context));
37 |
38 | this.delegates.put("pdf", new PdfBarrack(context));
39 |
40 | }
41 |
42 | @Override
43 | public Attacker apply(String path) {
44 |
45 | String suffix = extractSuffix(path);
46 |
47 | Barrack barrack = delegates.get(suffix);
48 |
49 | if (barrack == null) {
50 |
51 | String msg = "No implementation found for suffix : " + suffix;
52 |
53 | throw new IllegalArgumentException(msg);
54 |
55 | }
56 |
57 | log.debug("Delegating for suffix '{}' : {}", suffix, barrack);
58 |
59 | return barrack.apply(path);
60 |
61 | }
62 |
63 | @VisibleForTesting
64 | String extractSuffix(String path) {
65 |
66 | if (path == null) {
67 | return null;
68 | }
69 |
70 | int index = path.lastIndexOf(DELIMITER);
71 |
72 | if (index < 0) {
73 | return null;
74 | }
75 |
76 | if (index == path.length() - 1) {
77 | return null;
78 | }
79 |
80 | return path.substring(index + 1).toLowerCase();
81 |
82 | }
83 |
84 | }
85 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/BrutusTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import org.junit.Test;
4 |
5 | /**
6 | * Attack the test files.
7 | *
8 | * @author takanori.takase
9 | */
10 | public class BrutusTest {
11 |
12 | @Test(timeout = 60000L)
13 | public void testMain_Text() throws Exception {
14 |
15 | String[] args = { //
16 | "-in", "src/test/resources/test.txt" //
17 | };
18 |
19 | Brutus.main(args);
20 |
21 | }
22 |
23 | @Test(timeout = 60000L)
24 | public void testMain_Text_NotFound() throws Exception {
25 |
26 | String[] args = { //
27 | "-in", "src/test/resources/test.txt", //
28 | "-min", "1", //
29 | "-max", "2" // Password is "A9%"
30 | };
31 |
32 | Brutus.main(args);
33 |
34 | }
35 |
36 | @Test(timeout = 60000L)
37 | public void testMain_Zip() throws Exception {
38 |
39 | String[] args = { //
40 | "-in", "src/test/resources/hoge.zip", //
41 | "-lower", "true", //
42 | "-upper", "true", //
43 | "-number", "false", //
44 | "-symbol", "false", //
45 | "-control", "false", //
46 | "-min", "2", //
47 | "-max", "2" // Password is "aZ"
48 | };
49 |
50 | Brutus.main(args);
51 |
52 | }
53 |
54 | @Test(timeout = 60000L)
55 | public void testMain_Zip_NotFound() throws Exception {
56 |
57 | String[] args = { //
58 | "-in", "src/test/resources/hoge.zip", //
59 | "-lower", "true", //
60 | "-upper", "false", //
61 | "-number", "false", //
62 | "-symbol", "false", //
63 | "-control", "false", //
64 | "-min", "2", //
65 | "-max", "2" // Password is "aZ"
66 | };
67 |
68 | Brutus.main(args);
69 |
70 | }
71 |
72 | @Test(timeout = 60000L)
73 | public void testMain_NoFile() throws Exception {
74 |
75 | String[] args = {"-in", "src/test/resources/unknown.txt"};
76 |
77 | Brutus.main(args);
78 |
79 | }
80 |
81 | @Test(timeout = 5000L)
82 | public void testMain_Help() throws Exception {
83 |
84 | Brutus.main(new String[]{"--help"});
85 |
86 | }
87 |
88 | }
89 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/zip/ZipBarrackTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import org.junit.Assert;
5 | import org.junit.Before;
6 | import org.junit.Test;
7 | import org.mockito.Mockito;
8 |
9 | import java.io.IOException;
10 |
11 | /**
12 | * @author takanori.takase
13 | */
14 | public class ZipBarrackTest {
15 |
16 | private ZipBarrack target;
17 |
18 | private ZipBarrack.BarrackContext context;
19 |
20 | @Before
21 | public void setUp() throws Exception {
22 |
23 | context = Mockito.mock(ZipBarrack.BarrackContext.class);
24 |
25 | target = new ZipBarrack(context);
26 |
27 | }
28 |
29 |
30 | @Test
31 | public void testApply_Zip4j() throws Exception {
32 |
33 | Mockito.when(context.useNative()).thenReturn(false);
34 |
35 | Attacker attacker = target.apply("src/test/resources/hoge.zip");
36 |
37 | Assert.assertTrue(Zip4jAttacker.class.isInstance(attacker));
38 |
39 | }
40 |
41 | @Test
42 | public void testApply_Native() throws Exception {
43 |
44 | Mockito.when(context.useNative()).thenReturn(true);
45 |
46 | Attacker attacker = target.apply("src/test/resources/hoge.zip");
47 |
48 | if (SystemZipAttacker.isAvailable()) {
49 |
50 | Assert.assertTrue(SystemZipAttacker.class.isInstance(attacker));
51 |
52 | } else {
53 |
54 | Assert.assertTrue(Zip4jAttacker.class.isInstance(attacker));
55 |
56 | }
57 |
58 | }
59 |
60 |
61 | @Test
62 | public void testApply_NotFound() throws Exception {
63 |
64 | try {
65 |
66 | target.apply("src/test/resources/unknown.zip");
67 |
68 | Assert.fail();
69 |
70 | } catch (RuntimeException e) {
71 |
72 | Throwable t = e.getCause();
73 |
74 | Assert.assertEquals(t.toString(), IOException.class, t.getClass());
75 |
76 | }
77 |
78 | }
79 |
80 | @Test
81 | public void testApply_Directory() throws Exception {
82 |
83 | try {
84 |
85 | target.apply("target");
86 |
87 | Assert.fail();
88 |
89 | } catch (RuntimeException e) {
90 |
91 | Throwable t = e.getCause();
92 |
93 | Assert.assertEquals(t.toString(), IOException.class, t.getClass());
94 |
95 | }
96 |
97 | }
98 |
99 | }
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/zip/SystemZipAttacker.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl.zip;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.google.common.annotations.VisibleForTesting;
5 | import org.slf4j.LoggerFactory;
6 |
7 | import java.nio.file.Paths;
8 | import java.util.concurrent.TimeUnit;
9 |
10 | /**
11 | * {@link Attacker} implementation for Zip files using the system's 'unzip' command.
12 | *
13 | * @author takanori.takase
14 | */
15 | public class SystemZipAttacker implements Attacker {
16 |
17 | static final String EXEC = "unzip";
18 |
19 | static final String ARG_VERSION = "-v";
20 |
21 | static final String ARG_PASSWORD = "-P";
22 |
23 | static final String ARG_TEST = "-t";
24 |
25 | static final int SUCCESS = 0;
26 |
27 | static final long WAIT_MILLIS = 5000L;
28 |
29 | static boolean isAvailable() {
30 | return isAvailable(new String[]{EXEC, ARG_VERSION}, WAIT_MILLIS);
31 | }
32 |
33 | @VisibleForTesting
34 | static boolean isAvailable(String[] commands, long wait) {
35 |
36 | try {
37 |
38 | Process process = Runtime.getRuntime().exec(commands);
39 |
40 | boolean terminated = process.waitFor(wait, TimeUnit.MILLISECONDS);
41 |
42 | return terminated && process.exitValue() == SUCCESS;
43 |
44 | } catch (Exception e) {
45 |
46 | String msg = "System library not available : {}";
47 |
48 | LoggerFactory.getLogger(SystemZipAttacker.class).debug(msg, e.getMessage());
49 |
50 | return false;
51 |
52 | }
53 |
54 | }
55 |
56 | private final String input;
57 |
58 | public SystemZipAttacker(String input) {
59 | this.input = Paths.get(input).toAbsolutePath().toString();
60 | }
61 |
62 | @Override
63 | public String toString() {
64 | return String.format("%s{input=%s}", getClass().getSimpleName(), input);
65 | }
66 |
67 | @Override
68 | public boolean test(char[] knife) {
69 |
70 | try {
71 |
72 | String p = String.valueOf(knife);
73 |
74 | // unzip -t -P $PASSWORD $INPUT
75 | Process process = Runtime.getRuntime().exec( //
76 | new String[]{EXEC, ARG_TEST, ARG_PASSWORD, p, input});
77 |
78 | process.waitFor();
79 |
80 | return process.exitValue() == SUCCESS;
81 |
82 | } catch (Exception e) {
83 |
84 | return false;
85 |
86 | }
87 |
88 | }
89 |
90 | }
91 |
92 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/BarrackImplTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Barrack;
4 | import org.junit.Assert;
5 | import org.junit.Before;
6 | import org.junit.Test;
7 | import org.mockito.Mockito;
8 |
9 | /**
10 | * @author takanori.takase
11 | */
12 | public class BarrackImplTest {
13 |
14 | private BarrackImpl target;
15 |
16 | private Barrack.BarrackContext context;
17 |
18 | @Before
19 | public void setUp() throws Exception {
20 |
21 | context = Mockito.mock(Barrack.BarrackContext.class);
22 |
23 | target = new BarrackImpl(context);
24 |
25 | }
26 |
27 | @Test
28 | public void testApply() throws Exception {
29 |
30 | Assert.assertNotNull(target.apply("src/test/resources/test.txt"));
31 |
32 | Assert.assertNotNull(target.apply("src/test/resources/hoge.zip"));
33 |
34 | }
35 |
36 | @Test(expected = IllegalArgumentException.class)
37 | public void testApply_Exception() throws Exception {
38 |
39 | Assert.assertNotNull(target.apply("src/test/resources/test.dat"));
40 |
41 | }
42 |
43 | @Test
44 | public void testExtractSuffix() {
45 |
46 | Assert.assertEquals("txt", target.extractSuffix("foo/bar/hoge.txt"));
47 | Assert.assertEquals("txt", target.extractSuffix("foo/bar/hoge.TXT"));
48 | Assert.assertEquals("txt", target.extractSuffix("foo.bar.hoge.txt"));
49 | Assert.assertEquals("txt", target.extractSuffix("foo.bar.hoge.TXT"));
50 |
51 | Assert.assertEquals("zip", target.extractSuffix("foo/bar/hoge.zip"));
52 | Assert.assertEquals("zip", target.extractSuffix("foo/bar/hoge.ZIP"));
53 | Assert.assertEquals("zip", target.extractSuffix("foo.bar.hoge.zip"));
54 | Assert.assertEquals("zip", target.extractSuffix("foo.bar.hoge.ZIP"));
55 |
56 | Assert.assertEquals("dat", target.extractSuffix("foo/bar/hoge.dat"));
57 | Assert.assertEquals("dat", target.extractSuffix("foo/bar/hoge.DAT"));
58 | Assert.assertEquals("dat", target.extractSuffix("foo.bar.hoge.dat"));
59 | Assert.assertEquals("dat", target.extractSuffix("foo.bar.hoge.DAT"));
60 |
61 | Assert.assertNull(target.extractSuffix(null));
62 | Assert.assertNull(target.extractSuffix(""));
63 | Assert.assertNull(target.extractSuffix("."));
64 | Assert.assertNull(target.extractSuffix("foo/bar/hoge"));
65 | Assert.assertNull(target.extractSuffix("foo/bar/hoge."));
66 |
67 | }
68 |
69 | }
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # brutus
2 | [![Build Status][travis-icon]][travis-page] [![Coverage Status][coverall-icon]][coverall-page]
3 |
4 | ## Overview
5 |
6 | *'Brutus, so you forgot your password too?'*
7 |
8 | Brutus is a [brute-force attack](https://en.wikipedia.org/wiki/Brute-force_attack) password cracker tool,
9 | which simply generates a sequence of words following the predefined character combination,
10 | and attempts to decrypt the file with each password until the correct one is found.
11 |
12 | Needless to say, brute-force is *NOT* one of the most efficient algorithm out there, so
13 | keep in mind that this tool is limited to be functional with simple passwords.
14 |
15 |
16 | ## Feature
17 |
18 | Brutus currently supports the following file formats:
19 | * `*.zip`
20 | * `*.pdf`
21 | * `*.txt`
22 |
23 | Note that `*.txt` is to be used for testing purpose, which tries to match the clear-text value
24 | written in the text file. This is intended to be used for measuring the speed of password generation.
25 |
26 | Complexity of the password can be optionally specified, such as min/max number of characters and
27 | types of characters (lower-case, upper-case, numbers, etc).
28 |
29 | Execution parameters can also be specified, which includes the number of concurrent threads to use,
30 | and time-out in case if the password is not found within the specified time interval.
31 |
32 | See the [Configuration](#configuration) section of this documentation for the list of configurable parameters.
33 |
34 |
35 | ## Usage
36 |
37 | ### Prerequisites
38 | * JDK 1.8 or later
39 | * Maven 3 or later
40 | * Internet connection for downloading dependencies.
41 |
42 | ### Preparation
43 |
44 | Download the sources, and build the project to sanity check the environment.
45 | Make sure that the build and test passes.
46 |
47 | ```bash
48 | git clone "https://github.com/after-the-sunrise/brutus.git" "brutus"
49 |
50 | cd brutus && mvn clean test
51 | ```
52 |
53 | ### Execution
54 |
55 | Execute the application with [Exec Maven Plugin](http://www.mojohaus.org/exec-maven-plugin/),
56 | specifying the file to decrypt. The file name's extension (cf: `.txt`, `.zip`)
57 | is used to automatically determine and switch the decryption logic.
58 |
59 | ```bash
60 | mvn exec:java -Dexec.args="-in /path/to/the/file.zip"
61 | ```
62 |
63 | To configure the maximum length of password to attempt, specify the `-max` parameter.
64 |
65 | ```bash
66 | mvn exec:java -Dexec.args="-in /path/to/the/file.zip -max 8"
67 | ```
68 |
69 | ### Configuration
70 |
71 | For the list of configurable parameters, refer to the '--help' option.
72 |
73 | ```bash
74 | mvn exec:java -Dexec.args="--help"
75 | ```
76 |
77 | [travis-page]:https://travis-ci.org/after-the-sunrise/brutus
78 | [travis-icon]:https://travis-ci.org/after-the-sunrise/brutus.svg?branch=master
79 | [coverall-page]:https://coveralls.io/github/after-the-sunrise/brutus?branch=master
80 | [coverall-icon]:https://coveralls.io/repos/github/after-the-sunrise/brutus/badge.svg?branch=master
81 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/MastermindImpl.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import com.after_sunrise.brutus.Blacksmith;
6 | import com.after_sunrise.brutus.Mastermind;
7 | import com.google.common.annotations.VisibleForTesting;
8 | import com.google.inject.Inject;
9 | import org.slf4j.Logger;
10 | import org.slf4j.LoggerFactory;
11 |
12 | import java.util.Objects;
13 | import java.util.concurrent.*;
14 | import java.util.concurrent.atomic.AtomicInteger;
15 |
16 | /**
17 | *
18 | * Multi-threaded implementation of the {@link Mastermind}.
19 | *
20 | *
21 | * Threads are used for concurrently, where each thread consumes the password
22 | * from the {@link Blacksmith} individually until all passwords deplete.
23 | *
24 | *
25 | * @author takanori.takase
26 | */
27 | public class MastermindImpl implements Mastermind, ThreadFactory {
28 |
29 | static final int MULTIPLIER = 2;
30 |
31 | private final Logger log = LoggerFactory.getLogger(getClass());
32 |
33 | private final AtomicInteger threadCount = new AtomicInteger();
34 |
35 | private final MastermindContext context;
36 |
37 | private final Blacksmith blacksmith;
38 |
39 | private final Barrack barrack;
40 |
41 | @Inject
42 | public MastermindImpl(MastermindContext context, Blacksmith blacksmith, Barrack barrack) {
43 |
44 | this.context = Objects.requireNonNull(context);
45 |
46 | this.blacksmith = Objects.requireNonNull(blacksmith);
47 |
48 | this.barrack = Objects.requireNonNull(barrack);
49 |
50 | }
51 |
52 | @Override
53 | public String call() throws Exception {
54 |
55 | int threads = adjustThreads(context.getConcurrency());
56 |
57 | log.info("Scheduling tasks with {} threads.", threads);
58 |
59 | CompletableFuture future = new CompletableFuture<>();
60 |
61 | ExecutorService executor = Executors.newCachedThreadPool(this);
62 |
63 | for (int i = 0; i < threads; i++) {
64 |
65 | Runnable runnable = createTask(context.getInputPath(), future);
66 |
67 | executor.execute(runnable);
68 |
69 | }
70 |
71 | log.info("Scheduled tasks. Waiting for completion...");
72 |
73 | executor.shutdown();
74 |
75 | executor.awaitTermination(context.getTimeoutInMillis(), TimeUnit.MILLISECONDS);
76 |
77 | return future.getNow(null);
78 |
79 | }
80 |
81 | @VisibleForTesting
82 | int adjustThreads(int threads) {
83 |
84 | int max = Runtime.getRuntime().availableProcessors() * MULTIPLIER;
85 |
86 | return Math.min(max, Math.max(1, threads));
87 |
88 | }
89 |
90 | @Override
91 | public Thread newThread(Runnable r) {
92 |
93 | Thread t = new Thread(r);
94 |
95 | t.setDaemon(true);
96 |
97 | t.setName(getClass().getSimpleName() + "_" + threadCount.incrementAndGet());
98 |
99 | return t;
100 |
101 | }
102 |
103 | @VisibleForTesting
104 | Runnable createTask(String input, CompletableFuture future) {
105 | return () -> {
106 |
107 | try {
108 |
109 | log.debug("Starting task.");
110 |
111 | Attacker attacker = barrack.apply(input);
112 |
113 | while (!future.isDone()) {
114 |
115 | char[] attempt = blacksmith.get();
116 |
117 | if (attempt == null) {
118 | break;
119 | }
120 |
121 | boolean success = attacker.test(attempt);
122 |
123 | if (success) {
124 |
125 | String s = String.valueOf(attempt);
126 |
127 | log.debug("Attack succeeded : '{}' - {}", s, attacker);
128 |
129 | future.complete(s);
130 |
131 | }
132 |
133 | }
134 |
135 | log.debug("Terminating task.");
136 |
137 | } catch (Exception e) {
138 |
139 | log.warn("Unexpected failure.", e.getMessage());
140 |
141 | future.completeExceptionally(e);
142 |
143 | }
144 |
145 | };
146 |
147 | }
148 |
149 | }
150 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/Brutus.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus;
2 |
3 | import com.after_sunrise.brutus.Blacksmith.BlacksmithContext;
4 | import com.after_sunrise.brutus.impl.BarrackImpl;
5 | import com.after_sunrise.brutus.impl.BlacksmithImpl;
6 | import com.after_sunrise.brutus.impl.MastermindImpl;
7 | import com.beust.jcommander.JCommander;
8 | import com.beust.jcommander.Parameter;
9 | import com.google.inject.AbstractModule;
10 | import com.google.inject.Guice;
11 | import org.slf4j.LoggerFactory;
12 |
13 | import java.util.concurrent.TimeUnit;
14 |
15 | /**
16 | *
17 | * Password cracker using brute force attack.
18 | *
19 | *
20 | * 'Brutus, you forgot your password too?'
21 | *
22 | *
23 | * @author takanori.takase
24 | */
25 | public class Brutus extends AbstractModule implements BlacksmithContext, Mastermind.MastermindContext, Barrack.BarrackContext {
26 |
27 | @Parameter(names = "--help", help = true, hidden = true)
28 | boolean help = false;
29 |
30 | @Parameter(names = "-in", description = "Path of the input.", required = true)
31 | String inputPath;
32 |
33 | @Parameter(names = "-threads", description = "Number of concurrent threads to use. Defaults to number of processors.")
34 | int threads = Runtime.getRuntime().availableProcessors();
35 |
36 | @Parameter(names = "-timeout", description = "Timeout in millis to abort.")
37 | long timeoutInMillis = TimeUnit.DAYS.toMillis(7);
38 |
39 | @Parameter(names = "-min", description = "Minimum number of letters to attempt.")
40 | int minLength = 0;
41 |
42 | @Parameter(names = "-max", description = "Maximum number of letters to attempt.")
43 | int maxLength = 8;
44 |
45 | @Parameter(names = "-lower", arity = 1, description = "Flag to include lower-case characters. (a-z)")
46 | boolean includeLower = true;
47 |
48 | @Parameter(names = "-upper", arity = 1, description = "Flag to include upper-case characters. (A-Z)")
49 | boolean includeUpper = true;
50 |
51 | @Parameter(names = "-number", arity = 1, description = "Flag to include numeric characters. (0-9)")
52 | boolean includeNumber = true;
53 |
54 | @Parameter(names = "-symbol", arity = 1, description = "Flag to include symbol characters. (cf: !#$%&')")
55 | boolean includeSymbol = true;
56 |
57 | @Parameter(names = "-control", arity = 1, description = "Flag to include control characters. (cf: NUL SOH DEL)")
58 | boolean includeControl = false;
59 |
60 | @Parameter(names = "-native", arity = 1, description = "Use native library if available.")
61 | boolean useNative = false;
62 |
63 | @Override
64 | public String getInputPath() {
65 | return inputPath;
66 | }
67 |
68 | @Override
69 | public int getConcurrency() {
70 | return threads;
71 | }
72 |
73 | @Override
74 | public long getTimeoutInMillis() {
75 | return timeoutInMillis;
76 | }
77 |
78 | @Override
79 | public int getMinLength() {
80 | return minLength;
81 | }
82 |
83 | @Override
84 | public int getMaxLength() {
85 | return maxLength;
86 | }
87 |
88 | @Override
89 | public boolean isIncludeLower() {
90 | return includeLower;
91 | }
92 |
93 | @Override
94 | public boolean isIncludeUpper() {
95 | return includeUpper;
96 | }
97 |
98 | @Override
99 | public boolean isIncludeNumber() {
100 | return includeNumber;
101 | }
102 |
103 | @Override
104 | public boolean isIncludeSymbol() {
105 | return includeSymbol;
106 | }
107 |
108 | @Override
109 | public boolean isIncludeControl() {
110 | return includeControl;
111 | }
112 |
113 | @Override
114 | public boolean useNative() {
115 | return useNative;
116 | }
117 |
118 | @Override
119 | protected void configure() {
120 |
121 | bind(Barrack.BarrackContext.class).toInstance(this);
122 |
123 | bind(Barrack.class).to(BarrackImpl.class).asEagerSingleton();
124 |
125 | bind(BlacksmithContext.class).toInstance(this);
126 |
127 | bind(Blacksmith.class).to(BlacksmithImpl.class).asEagerSingleton();
128 |
129 | bind(Mastermind.MastermindContext.class).toInstance(this);
130 |
131 | bind(Mastermind.class).to(MastermindImpl.class).asEagerSingleton();
132 |
133 | }
134 |
135 | /**
136 | * Application entry point, parsing the command line arguments to be supplied as context objects.
137 | */
138 | public static void main(String[] args) {
139 |
140 | try {
141 |
142 | Brutus brutus = new Brutus();
143 |
144 | JCommander jc = new JCommander(brutus, args);
145 |
146 | if (brutus.help) {
147 |
148 | jc.setProgramName(Brutus.class.getName());
149 |
150 | jc.usage();
151 |
152 | return;
153 |
154 | }
155 |
156 | String result = Guice.createInjector(brutus).getInstance(Mastermind.class).call();
157 |
158 | LoggerFactory.getLogger(Brutus.class).info("Attack result. [{}]", result);
159 |
160 | } catch (Exception e) {
161 |
162 | LoggerFactory.getLogger(Brutus.class).error("Attack failed.", e);
163 |
164 | }
165 |
166 | }
167 |
168 | }
169 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/MastermindImplTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Attacker;
4 | import com.after_sunrise.brutus.Barrack;
5 | import com.after_sunrise.brutus.Blacksmith;
6 | import com.after_sunrise.brutus.Mastermind;
7 | import org.junit.Assert;
8 | import org.junit.Before;
9 | import org.junit.Test;
10 | import org.mockito.Matchers;
11 | import org.mockito.Mockito;
12 |
13 | import java.util.concurrent.CompletableFuture;
14 | import java.util.concurrent.CompletionException;
15 |
16 | /**
17 | * @author takanori.takase
18 | */
19 | public class MastermindImplTest {
20 |
21 | private MastermindImpl target;
22 |
23 | private Mastermind.MastermindContext context;
24 |
25 | private Blacksmith blacksmith;
26 |
27 | private Barrack barrack;
28 |
29 | private Attacker attacker;
30 |
31 | @Before
32 | public void setUp() throws Exception {
33 |
34 | context = Mockito.mock(Mastermind.MastermindContext.class);
35 | Mockito.when(context.getInputPath()).thenReturn("/tmp/test.dat");
36 | Mockito.when(context.getConcurrency()).thenReturn(2);
37 | Mockito.when(context.getTimeoutInMillis()).thenReturn(60L * 1000);
38 |
39 | blacksmith = Mockito.mock(Blacksmith.class);
40 | Mockito.when(blacksmith.get()) //
41 | .thenReturn("foo".toCharArray()) //
42 | .thenReturn("bar".toCharArray()) //
43 | .thenReturn("abc".toCharArray()) //
44 | .thenReturn("???".toCharArray()) //
45 | .thenReturn(null);
46 |
47 | attacker = Mockito.mock(Attacker.class);
48 | Mockito.when(attacker.test(Mockito.any(char[].class))).thenReturn(false);
49 |
50 | barrack = Mockito.mock(Barrack.class);
51 | Mockito.when(barrack.apply(Matchers.anyString())).thenReturn(attacker);
52 |
53 | target = new MastermindImpl(context, blacksmith, barrack);
54 |
55 | }
56 |
57 | @Test(timeout = 5000L)
58 | public void testCall_Found() throws Exception {
59 |
60 | Mockito.when(attacker.test("abc".toCharArray())).thenReturn(true);
61 |
62 | String result = target.call();
63 |
64 | Assert.assertEquals("abc", result);
65 |
66 | }
67 |
68 | @Test(timeout = 5000L)
69 | public void testCall_NotFound() throws Exception {
70 |
71 | String result = target.call();
72 |
73 | Assert.assertNull(result);
74 |
75 | }
76 |
77 | @Test(timeout = 5000L)
78 | public void testCall_Exception() throws Exception {
79 |
80 | Exception e = new IllegalArgumentException("unit test");
81 |
82 | Mockito.when(attacker.test("abc".toCharArray())).thenThrow(e);
83 |
84 | try {
85 |
86 | target.call();
87 |
88 | Assert.fail();
89 |
90 | } catch (CompletionException ce) {
91 |
92 | Assert.assertSame(e, ce.getCause());
93 |
94 | }
95 |
96 |
97 | }
98 |
99 | @Test(timeout = 5000L)
100 | public void testAdjustThreads() throws Exception {
101 |
102 | Assert.assertEquals(1, target.adjustThreads(-1));
103 | Assert.assertEquals(1, target.adjustThreads(0));
104 | Assert.assertEquals(1, target.adjustThreads(1));
105 |
106 | int processors = Runtime.getRuntime().availableProcessors();
107 | int max = processors * MastermindImpl.MULTIPLIER;
108 | Assert.assertEquals(processors, target.adjustThreads(processors));
109 | Assert.assertEquals(max, target.adjustThreads(max));
110 | Assert.assertEquals(max, target.adjustThreads(max + 1));
111 |
112 | }
113 |
114 | @Test(timeout = 5000L)
115 | public void testNewThread() throws Exception {
116 |
117 | Runnable r1 = Mockito.mock(Runnable.class);
118 | Thread t1 = target.newThread(r1);
119 | Assert.assertTrue(t1.isDaemon());
120 | Assert.assertEquals("MastermindImpl_1", t1.getName());
121 |
122 | Runnable r2 = Mockito.mock(Runnable.class);
123 | Thread t2 = target.newThread(r2);
124 | Assert.assertTrue(t2.isDaemon());
125 | Assert.assertEquals("MastermindImpl_2", t2.getName());
126 |
127 | Mockito.verifyZeroInteractions(r1, r2);
128 | t1.start();
129 | t2.start();
130 | t1.join();
131 | t2.join();
132 | Mockito.verify(r1).run();
133 | Mockito.verify(r2).run();
134 |
135 | }
136 |
137 | @Test(timeout = 5000L)
138 | public void testCreateTask() throws Exception {
139 |
140 | Mockito.when(attacker.test("abc".toCharArray())).thenReturn(true);
141 |
142 | CompletableFuture future = new CompletableFuture<>();
143 |
144 | Runnable task = target.createTask(context.getInputPath(), future);
145 |
146 | task.run();
147 |
148 | Assert.assertTrue(future.isDone());
149 |
150 | Assert.assertEquals("abc", future.get());
151 |
152 | }
153 |
154 | @Test(timeout = 5000L)
155 | public void testCreateTask_NotFound() throws Exception {
156 |
157 | CompletableFuture future = new CompletableFuture<>();
158 |
159 | Runnable task = target.createTask(context.getInputPath(), future);
160 |
161 | task.run();
162 |
163 | Assert.assertFalse(future.isDone());
164 |
165 | }
166 |
167 | @Test(timeout = 5000L)
168 | public void testCreateTask_AlreadyDone() throws Exception {
169 |
170 | CompletableFuture future = CompletableFuture.completedFuture("hoge");
171 |
172 | Runnable task = target.createTask(context.getInputPath(), future);
173 |
174 | task.run();
175 |
176 | Assert.assertTrue(future.isDone());
177 |
178 | Assert.assertEquals("hoge", future.get());
179 |
180 | }
181 |
182 | }
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
3 |
4 | 4.0.0
5 |
6 | com.after_sunrise.brutus
7 | brutus
8 | 0.0.1-SNAPSHOT
9 | jar
10 |
11 | brutus
12 | Brute-force password cracker. 'You forgot your password too?'
13 | https://github.com/after-the-sunrise/${project.artifactId}
14 | 2016
15 |
16 |
17 |
18 | after-sunrise
19 | Takanori Takase
20 | +9
21 |
22 |
23 |
24 |
25 |
26 | after_sunrise
27 | https://twitter.com/after_sunrise
28 |
29 | build-bot
30 |
31 |
32 |
33 |
34 |
35 |
36 | GNU AFFERO GENERAL PUBLIC LICENSE, Version 3
37 | http://www.gnu.org/licenses/agpl-3.0.html
38 | repo
39 |
40 |
41 |
42 |
43 | https://github.com/after-the-sunrise/${project.artifactId}
44 | scm:git:git://github.com/after-the-sunrise/${project.artifactId}.git
45 | scm:git:git@github.com:after-the-sunrise/${project.artifactId}.git
46 | HEAD
47 |
48 |
49 |
50 | GitHub
51 | https://github.com/after-the-sunrise/${project.artifactId}/issues
52 |
53 |
54 |
55 | Travis CI
56 | https://travis-ci.org/after-the-sunrise/${project.artifactId}
57 |
58 |
59 |
60 | UTF-8
61 | 1.8
62 | 1.8
63 | true
64 | true
65 | 1.5.0
66 | 2.7
67 | 4.3.0
68 | 4.13.1
69 | 1.10.19
70 | 1.7.21
71 | 4.1.0
72 | 1.58
73 | 2.11.5
74 | 3.0.1
75 |
76 |
77 |
78 |
79 |
80 | org.codehaus.mojo
81 | exec-maven-plugin
82 | ${plugin.exec.version}
83 |
84 | com.after_sunrise.brutus.Brutus
85 |
86 |
87 |
88 | org.apache.maven.plugins
89 | maven-surefire-plugin
90 |
91 | -XX:-UseSplitVerifier
92 |
93 |
94 |
95 | org.codehaus.mojo
96 | cobertura-maven-plugin
97 | ${plugin.coberture.version}
98 |
99 |
100 | xml
101 |
102 |
103 |
104 |
105 | org.eluder.coveralls
106 | coveralls-maven-plugin
107 | ${plugin.coveralls.version}
108 |
109 |
110 |
111 |
112 |
113 |
114 | junit
115 | junit
116 | ${dependency.junit.version}
117 | test
118 |
119 |
120 | org.mockito
121 | mockito-all
122 | ${dependency.mockito.version}
123 | test
124 |
125 |
126 | org.slf4j
127 | slf4j-api
128 | ${dependency.slf4j.version}
129 |
130 |
131 | org.slf4j
132 | slf4j-log4j12
133 | ${dependency.slf4j.version}
134 | runtime
135 |
136 |
137 | com.google.inject
138 | guice
139 | ${dependency.guice.version}
140 |
141 |
142 | com.beust
143 | jcommander
144 | ${dependency.jcommander.version}
145 |
146 |
147 | net.lingala.zip4j
148 | zip4j
149 | ${dependency.zip4j.version}
150 |
151 |
152 | org.apache.pdfbox
153 | pdfbox
154 | ${dependency.pdfbox.version}
155 |
156 |
157 |
158 |
159 |
--------------------------------------------------------------------------------
/src/main/java/com/after_sunrise/brutus/impl/BlacksmithImpl.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Blacksmith;
4 | import com.google.common.annotations.VisibleForTesting;
5 | import com.google.inject.Inject;
6 | import org.slf4j.Logger;
7 | import org.slf4j.LoggerFactory;
8 |
9 | import java.util.ArrayList;
10 | import java.util.Arrays;
11 | import java.util.List;
12 | import java.util.concurrent.BlockingQueue;
13 | import java.util.concurrent.LinkedBlockingQueue;
14 | import java.util.concurrent.atomic.AtomicLong;
15 |
16 | /**
17 | *
18 | * In-memory implementation for {@link Blacksmith}. Criteria for generating the passwords,
19 | * and the keeping track of already-consumed passwords are kept in memory locally.
20 | *
21 | *
22 | * Contexts are initialized within the instance construction,
23 | * and the calls to the {@code BlacksmithImpl#get()} are re-entrant (=thread-safe).
24 | *
25 | *
26 | * 'The pen is mightier than the sword.'
27 | *
28 | *
29 | * @author takanori.takase
30 | */
31 | public class BlacksmithImpl implements Blacksmith, Runnable {
32 |
33 | private static final String FORMAT = "%,3d";
34 |
35 | private static final long INTERVAL = 100_000_000;
36 |
37 | private static final int BUFFER = 100;
38 |
39 | private static final char[] END = new char[0];
40 |
41 | private final Logger log = LoggerFactory.getLogger(getClass());
42 |
43 | private final AtomicLong count = new AtomicLong();
44 |
45 | private final BlockingQueue queue = new LinkedBlockingQueue<>(BUFFER);
46 |
47 | private final char[] chars;
48 |
49 | private final int min;
50 |
51 | private final int max;
52 |
53 | private final long total;
54 |
55 | private final long interval;
56 |
57 | private int[] current;
58 |
59 | @Inject
60 | public BlacksmithImpl(BlacksmithContext context) {
61 |
62 | chars = prepareCharacters(context);
63 |
64 | min = chars.length == 0 ? 0 : Math.max(context.getMinLength(), 0);
65 |
66 | max = chars.length == 0 ? 0 : Math.max(context.getMaxLength(), min);
67 |
68 | total = calculateTotal();
69 |
70 | interval = calculateInterval(total);
71 |
72 | Thread thread = new Thread(this);
73 | thread.setDaemon(true);
74 | thread.setName(getClass().getSimpleName());
75 | thread.setPriority(Thread.MAX_PRIORITY);
76 | thread.start();
77 |
78 | log.info("Initialized with {} candidates. (chars={}, min={}, max={})", //
79 | String.format(FORMAT, total), chars.length, min, max);
80 |
81 | }
82 |
83 | private char[] prepareCharacters(BlacksmithContext context) {
84 |
85 | List bytes = new ArrayList<>(Byte.MAX_VALUE);
86 |
87 | if (context.isIncludeLower()) {
88 |
89 | for (byte b = 0x61; b <= 0x7a; b++) {
90 | bytes.add(b);
91 | }
92 |
93 | log.debug("Added lower-case chars.");
94 |
95 | }
96 |
97 | if (context.isIncludeUpper()) {
98 |
99 | for (byte b = 0x41; b <= 0x5a; b++) {
100 | bytes.add(b);
101 | }
102 |
103 | log.debug("Added upper-case chars.");
104 |
105 | }
106 |
107 | if (context.isIncludeNumber()) {
108 |
109 | for (byte b = 0x30; b <= 0x39; b++) {
110 | bytes.add(b);
111 | }
112 |
113 | log.debug("Added numeric chars.");
114 |
115 | }
116 |
117 | if (context.isIncludeSymbol()) {
118 |
119 | for (byte b = 0x20; b <= 0x2f; b++) {
120 | bytes.add(b);
121 | }
122 | for (byte b = 0x3a; b <= 0x40; b++) {
123 | bytes.add(b);
124 | }
125 | for (byte b = 0x5b; b <= 0x60; b++) {
126 | bytes.add(b);
127 | }
128 | for (byte b = 0x7b; b <= 0x7e; b++) {
129 | bytes.add(b);
130 | }
131 |
132 | log.debug("Added symbol chars.");
133 |
134 | }
135 |
136 | if (context.isIncludeControl()) {
137 |
138 | for (byte b = 0x00; b <= 0x1f; b++) {
139 | bytes.add(b);
140 | }
141 |
142 | bytes.add((byte) 0x7f);
143 |
144 | log.debug("Added control chars.");
145 |
146 | }
147 |
148 | char[] result = new char[bytes.size()];
149 |
150 | for (int i = 0; i < result.length; i++) {
151 | result[i] = (char) bytes.get(i).byteValue();
152 | }
153 |
154 | return result;
155 |
156 | }
157 |
158 | @VisibleForTesting
159 | long calculateTotal() {
160 |
161 | long total = 0L;
162 |
163 | if (min == 0) {
164 | total++;
165 | }
166 |
167 | for (int i = 1; i <= max; i++) {
168 | total += Math.pow(chars.length, i);
169 | }
170 |
171 | return total;
172 |
173 | }
174 |
175 | @VisibleForTesting
176 | long calculateInterval(long total) {
177 |
178 | long interval = 1L;
179 |
180 | while (interval * 10 < total) {
181 |
182 | interval *= 10;
183 |
184 | if (interval >= INTERVAL) {
185 | break;
186 | }
187 |
188 | }
189 |
190 | return interval;
191 |
192 | }
193 |
194 | private char[] next() {
195 |
196 | if (current == null) {
197 |
198 | current = new int[min];
199 |
200 | } else {
201 |
202 | if (current.length > max) {
203 | return null;
204 | }
205 |
206 | for (int i = 0; i <= current.length; i++) {
207 |
208 | if (i == current.length) {
209 |
210 | current = new int[current.length + 1];
211 |
212 | break;
213 |
214 | }
215 |
216 | if (current[i] < chars.length - 1) {
217 |
218 | current[i] = current[i] + 1;
219 |
220 | break;
221 |
222 | }
223 |
224 | current[i] = 0;
225 |
226 | }
227 |
228 | if (current.length > max) {
229 | return null;
230 | }
231 |
232 | }
233 |
234 | char[] result = new char[current.length];
235 |
236 | for (int i = 0; i < result.length; i++) {
237 |
238 | char c = chars[current[i]];
239 |
240 | result[i] = c;
241 |
242 | }
243 |
244 | return result;
245 |
246 | }
247 |
248 | @Override
249 | public void run() {
250 |
251 | try {
252 |
253 | char[] c;
254 |
255 | while ((c = next()) != null) {
256 |
257 | queue.put(c);
258 |
259 | }
260 |
261 | queue.put(END);
262 |
263 | } catch (InterruptedException e) {
264 |
265 | log.trace("Could not append an element.", e);
266 |
267 | }
268 |
269 | }
270 |
271 | @Override
272 | public char[] get() {
273 |
274 | char[] c;
275 |
276 | while (true) {
277 |
278 | c = queue.poll();
279 |
280 | if (c != null) {
281 | break;
282 | }
283 |
284 | Thread.yield();
285 |
286 | }
287 |
288 | if (c == END) {
289 |
290 | queue.add(END);
291 |
292 | return null;
293 |
294 | }
295 |
296 | long i = count.incrementAndGet();
297 |
298 | if (i == total || i % interval == 0) {
299 |
300 | log.info("Supplied {} / {} ({}%) passwords : {}", //
301 | String.format(FORMAT, i), //
302 | String.format(FORMAT, total), //
303 | String.format(FORMAT, (i * 100) / total), //
304 | Arrays.toString(c));
305 |
306 | }
307 |
308 | return c;
309 |
310 | }
311 |
312 | }
313 |
--------------------------------------------------------------------------------
/src/test/java/com/after_sunrise/brutus/impl/BlacksmithImplTest.java:
--------------------------------------------------------------------------------
1 | package com.after_sunrise.brutus.impl;
2 |
3 | import com.after_sunrise.brutus.Blacksmith;
4 | import com.after_sunrise.brutus.Blacksmith.BlacksmithContext;
5 | import org.junit.Assert;
6 | import org.junit.Test;
7 | import org.mockito.Mockito;
8 |
9 | import java.util.HashSet;
10 | import java.util.Set;
11 | import java.util.concurrent.ConcurrentSkipListSet;
12 | import java.util.concurrent.ExecutorService;
13 | import java.util.concurrent.Executors;
14 | import java.util.concurrent.TimeUnit;
15 | import java.util.concurrent.atomic.AtomicLong;
16 | import java.util.function.Function;
17 |
18 | import static org.mockito.Mockito.when;
19 |
20 | /**
21 | * @author takanori.takase
22 | */
23 | public class BlacksmithImplTest {
24 |
25 | @Test(timeout = 5000L)
26 | public void testPrepareCharacters() {
27 |
28 | Function> f = (c) -> {
29 |
30 | BlacksmithImpl target = new BlacksmithImpl(c);
31 |
32 | Set values = new HashSet<>();
33 |
34 | char[] next;
35 |
36 | while ((next = target.get()) != null) {
37 |
38 | Assert.assertEquals(1, next.length);
39 |
40 | values.add(next[0]);
41 |
42 | }
43 |
44 | return values;
45 |
46 | };
47 |
48 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
49 | when(context.getMinLength()).thenReturn(1);
50 | when(context.getMaxLength()).thenReturn(1);
51 |
52 | // All
53 | when(context.isIncludeLower()).thenReturn(true);
54 | when(context.isIncludeUpper()).thenReturn(true);
55 | when(context.isIncludeNumber()).thenReturn(true);
56 | when(context.isIncludeSymbol()).thenReturn(true);
57 | when(context.isIncludeControl()).thenReturn(true);
58 | Set all = f.apply(context);
59 | Assert.assertEquals((0x7f) + 1, all.size());
60 |
61 | // Lower only
62 | when(context.isIncludeLower()).thenReturn(true);
63 | when(context.isIncludeUpper()).thenReturn(false);
64 | when(context.isIncludeNumber()).thenReturn(false);
65 | when(context.isIncludeSymbol()).thenReturn(false);
66 | when(context.isIncludeControl()).thenReturn(false);
67 | Set lower = f.apply(context);
68 | Assert.assertEquals(26, lower.size());
69 |
70 | // Upper only
71 | when(context.isIncludeLower()).thenReturn(false);
72 | when(context.isIncludeUpper()).thenReturn(true);
73 | when(context.isIncludeNumber()).thenReturn(false);
74 | when(context.isIncludeSymbol()).thenReturn(false);
75 | when(context.isIncludeControl()).thenReturn(false);
76 | Set upper = f.apply(context);
77 | Assert.assertEquals(26, upper.size());
78 |
79 | // Number only
80 | when(context.isIncludeLower()).thenReturn(false);
81 | when(context.isIncludeUpper()).thenReturn(false);
82 | when(context.isIncludeNumber()).thenReturn(true);
83 | when(context.isIncludeSymbol()).thenReturn(false);
84 | when(context.isIncludeControl()).thenReturn(false);
85 | Set number = f.apply(context);
86 | Assert.assertEquals(10, number.size());
87 |
88 | // Symbol only
89 | when(context.isIncludeLower()).thenReturn(false);
90 | when(context.isIncludeUpper()).thenReturn(false);
91 | when(context.isIncludeNumber()).thenReturn(false);
92 | when(context.isIncludeSymbol()).thenReturn(true);
93 | when(context.isIncludeControl()).thenReturn(false);
94 | Set symbol = f.apply(context);
95 | Assert.assertEquals(33, symbol.size());
96 |
97 | // Control only
98 | when(context.isIncludeLower()).thenReturn(false);
99 | when(context.isIncludeUpper()).thenReturn(false);
100 | when(context.isIncludeNumber()).thenReturn(false);
101 | when(context.isIncludeSymbol()).thenReturn(false);
102 | when(context.isIncludeControl()).thenReturn(true);
103 | Set control = f.apply(context);
104 | Assert.assertEquals(33, control.size());
105 |
106 | // Make sure the characters are 'Mutually Exclusive and Collectively Exhaustive'.
107 | Set sum = new HashSet<>();
108 | sum.addAll(lower);
109 | sum.addAll(upper);
110 | sum.addAll(number);
111 | sum.addAll(symbol);
112 | sum.addAll(control);
113 | Assert.assertEquals(all.size(), sum.size());
114 |
115 | // Corner case : No characters
116 | when(context.isIncludeLower()).thenReturn(false);
117 | when(context.isIncludeUpper()).thenReturn(false);
118 | when(context.isIncludeNumber()).thenReturn(false);
119 | when(context.isIncludeSymbol()).thenReturn(false);
120 | when(context.isIncludeControl()).thenReturn(false);
121 | Blacksmith target = new BlacksmithImpl(context);
122 | Assert.assertEquals("", String.valueOf(target.get()));
123 | Assert.assertNull(target.get());
124 |
125 | }
126 |
127 | /**
128 | * Examine the character composition with multiple letters.
129 | */
130 | @Test(timeout = 5000L)
131 | public void testGet() {
132 |
133 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
134 | when(context.getMinLength()).thenReturn(1);
135 | when(context.getMaxLength()).thenReturn(3);
136 | when(context.isIncludeLower()).thenReturn(true);
137 | when(context.isIncludeUpper()).thenReturn(false);
138 | when(context.isIncludeNumber()).thenReturn(true);
139 | when(context.isIncludeSymbol()).thenReturn(false);
140 | when(context.isIncludeControl()).thenReturn(false);
141 | BlacksmithImpl target = new BlacksmithImpl(context);
142 |
143 | Assert.assertEquals("a", new String(target.get()));
144 | Assert.assertEquals("b", new String(target.get()));
145 | Assert.assertEquals("c", new String(target.get()));
146 | for (int i = 0; i < 22; i++) {
147 | Assert.assertNotNull(target.get());
148 | }
149 | Assert.assertEquals("z", new String(target.get()));
150 | Assert.assertEquals("0", new String(target.get()));
151 | Assert.assertEquals("1", new String(target.get()));
152 | for (int i = 0; i < 7; i++) {
153 | Assert.assertNotNull(target.get());
154 | }
155 | Assert.assertEquals("9", new String(target.get()));
156 | Assert.assertEquals("aa", new String(target.get()));
157 | Assert.assertEquals("ba", new String(target.get()));
158 | Assert.assertEquals("ca", new String(target.get()));
159 | for (int i = 0; i < 1292; i++) {
160 | Assert.assertNotNull(target.get());
161 | }
162 | Assert.assertEquals("99", new String(target.get()));
163 | Assert.assertEquals("aaa", new String(target.get()));
164 | Assert.assertEquals("baa", new String(target.get()));
165 | for (int i = 0; i < 46650; i++) {
166 | Assert.assertNotNull(target.get());
167 | }
168 | Assert.assertEquals("699", new String(target.get()));
169 | Assert.assertEquals("799", new String(target.get()));
170 | Assert.assertEquals("899", new String(target.get()));
171 | Assert.assertEquals("999", new String(target.get()));
172 | Assert.assertNull(target.get());
173 | Assert.assertNull(target.get());
174 | Assert.assertNull(target.get());
175 |
176 | }
177 |
178 | /**
179 | * Examine the character composition with multiple threads.
180 | */
181 | @Test(timeout = 5000L)
182 | public void testGet_Concurrent() throws InterruptedException {
183 |
184 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
185 | when(context.getMinLength()).thenReturn(1);
186 | when(context.getMaxLength()).thenReturn(2);
187 | when(context.isIncludeLower()).thenReturn(true);
188 | when(context.isIncludeUpper()).thenReturn(true);
189 | when(context.isIncludeNumber()).thenReturn(false);
190 | when(context.isIncludeSymbol()).thenReturn(false);
191 | when(context.isIncludeControl()).thenReturn(false);
192 | BlacksmithImpl target = new BlacksmithImpl(context);
193 |
194 | Set results = new ConcurrentSkipListSet<>();
195 |
196 | ExecutorService executor = Executors.newCachedThreadPool();
197 |
198 | for (int i = 0; i < 10; i++) {
199 |
200 | executor.execute(() -> {
201 |
202 | char[] chars;
203 |
204 | while ((chars = target.get()) != null) {
205 |
206 | results.add(String.valueOf(chars));
207 |
208 | }
209 |
210 | });
211 |
212 | }
213 |
214 | executor.shutdown();
215 |
216 | executor.awaitTermination(1L, TimeUnit.MINUTES);
217 |
218 | Assert.assertEquals((52) + (52 * 52), results.size());
219 |
220 | }
221 |
222 | /**
223 | * Measure the performance to fetch all values.
224 | */
225 | @Test
226 | public void testGet_Benchmark() throws InterruptedException {
227 |
228 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
229 | when(context.getMinLength()).thenReturn(0);
230 | when(context.getMaxLength()).thenReturn(2);
231 | when(context.isIncludeLower()).thenReturn(true);
232 | when(context.isIncludeUpper()).thenReturn(true);
233 | when(context.isIncludeNumber()).thenReturn(true);
234 | when(context.isIncludeSymbol()).thenReturn(true);
235 | when(context.isIncludeControl()).thenReturn(false);
236 | BlacksmithImpl target = new BlacksmithImpl(context);
237 |
238 | final AtomicLong count = new AtomicLong();
239 |
240 | ExecutorService executor = Executors.newCachedThreadPool();
241 |
242 | long start = System.nanoTime();
243 |
244 | for (int i = 0; i < Runtime.getRuntime().availableProcessors(); i++) {
245 | executor.execute(() -> {
246 | while (target.get() != null) {
247 | count.incrementAndGet();
248 | }
249 | });
250 | }
251 |
252 | executor.shutdown();
253 |
254 | executor.awaitTermination(365L, TimeUnit.DAYS);
255 |
256 | long end = System.nanoTime();
257 |
258 | long elapsed = (end - start) / 1_000_000;
259 |
260 | System.out.println(String.format("Count = %,3d, Time = %,3d", count.get(), elapsed));
261 |
262 | }
263 |
264 | @Test(timeout = 5000L)
265 | public void testCalculateTotal() {
266 |
267 | Function f = (b) -> {
268 |
269 | long i = 0L;
270 |
271 | while (b.get() != null) {
272 | i++;
273 | }
274 |
275 | return i;
276 |
277 | };
278 |
279 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
280 | when(context.isIncludeLower()).thenReturn(false);
281 | when(context.isIncludeUpper()).thenReturn(false);
282 | when(context.isIncludeNumber()).thenReturn(true);
283 | when(context.isIncludeSymbol()).thenReturn(false);
284 | when(context.isIncludeControl()).thenReturn(false);
285 |
286 | // 0 letter
287 | when(context.getMinLength()).thenReturn(0);
288 | when(context.getMaxLength()).thenReturn(0);
289 | BlacksmithImpl target_0 = new BlacksmithImpl(context);
290 | Assert.assertEquals((Long) 1L, (Long) target_0.calculateTotal());
291 | Assert.assertEquals((Long) 1L, f.apply(target_0));
292 | Assert.assertEquals((Long) 1L, (Long) target_0.calculateTotal());
293 |
294 | // 1 letter
295 | when(context.getMinLength()).thenReturn(1);
296 | when(context.getMaxLength()).thenReturn(1);
297 | BlacksmithImpl target_1 = new BlacksmithImpl(context);
298 | Assert.assertEquals((Long) 10L, (Long) target_1.calculateTotal());
299 | Assert.assertEquals((Long) 10L, f.apply(target_1));
300 | Assert.assertEquals((Long) 10L, (Long) target_1.calculateTotal());
301 |
302 | // 1 + 2 letter
303 | when(context.getMinLength()).thenReturn(1);
304 | when(context.getMaxLength()).thenReturn(2);
305 | BlacksmithImpl target_2 = new BlacksmithImpl(context);
306 | Assert.assertEquals((Long) ((10L) + (10L * 10L)), (Long) target_2.calculateTotal());
307 | Assert.assertEquals((Long) ((10L) + (10L * 10L)), f.apply(target_2));
308 | Assert.assertEquals((Long) ((10L) + (10L * 10L)), (Long) target_2.calculateTotal());
309 |
310 | // 0 + 1 + 2 letter
311 | when(context.getMinLength()).thenReturn(0);
312 | when(context.getMaxLength()).thenReturn(2);
313 | BlacksmithImpl target_3 = new BlacksmithImpl(context);
314 | Assert.assertEquals((Long) ((1L) + (10L) + (10L * 10L)), (Long) target_3.calculateTotal());
315 | Assert.assertEquals((Long) ((1L) + (10L) + (10L * 10L)), f.apply(target_3));
316 | Assert.assertEquals((Long) ((1L) + (10L) + (10L * 10L)), (Long) target_3.calculateTotal());
317 |
318 | }
319 |
320 | @Test(timeout = 5000L)
321 | public void testCalculateInterval() {
322 |
323 | BlacksmithContext context = Mockito.mock(BlacksmithContext.class);
324 |
325 | BlacksmithImpl target = new BlacksmithImpl(context);
326 |
327 | Assert.assertEquals(1L, target.calculateInterval(1L));
328 | Assert.assertEquals(1L, target.calculateInterval(10L));
329 | Assert.assertEquals(10L, target.calculateInterval(100L));
330 | Assert.assertEquals(100L, target.calculateInterval(1_000L));
331 | Assert.assertEquals(1_000L, target.calculateInterval(10_000L));
332 | Assert.assertEquals(10_000L, target.calculateInterval(100_000L));
333 | Assert.assertEquals(100_000L, target.calculateInterval(1_000_000L));
334 | Assert.assertEquals(1_000_000L, target.calculateInterval(10_000_000L));
335 | Assert.assertEquals(10_000_000L, target.calculateInterval(100_000_000L));
336 | Assert.assertEquals(100_000_000L, target.calculateInterval(1_000_000_000L));
337 | Assert.assertEquals(100_000_000L, target.calculateInterval(10_000_000_000L));
338 | Assert.assertEquals(100_000_000L, target.calculateInterval(100_000_000_000L));
339 |
340 | }
341 |
342 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------