├── .gitignore ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── requirements.txt ├── settings.gradle └── src ├── main ├── java │ └── io │ │ └── appium │ │ └── mitmproxy │ │ ├── InterceptedMessage.java │ │ ├── MessageSerializer.java │ │ ├── MitmproxyJava.java │ │ └── MitmproxyServer.java └── resources │ └── scripts │ ├── install_python_deps.py │ └── proxy.py └── test └── java └── io └── appium └── mitmproxy └── MitmproxyJavaTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle 2 | .idea 3 | out 4 | build 5 | __pycache__ 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright JS Foundation and other contributors, https://js.foundation 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Java rendition of [node-mitmproxy](https://github.com/jvilk/mitmproxy-node) 2 | 3 | Make sure to read the prerequisites section below. 4 | 5 | Detailed information included in the [AppiumPro article which introduces this library](https://appiumpro.com/editions/65). 6 | 7 | ## Why? 8 | 9 | `mitmproxy` is great for capturing network traffic, but has no easy interface for Java users. 10 | The software testing community, specifically Appium mobile testers, want to be able to capture network requests made by devices during their Java tests. 11 | 12 | This library will run `mitmproxy` in the background as a separate process, and allow you to pass in a lambda function which gets called on every network request captured by `mitmproxy`. This allows you to check the captured requests within you Java code without having to stop the proxy or end capture. 13 | 14 | See @jonahss's Appium Pro posts on this topic: 15 | - https://appiumpro.com/editions/62 16 | - https://appiumpro.com/editions/63 17 | - https://appiumpro.com/editions/65 18 | 19 | ## What can I use this for? 20 | 21 | For transparently rewriting HTTP/HTTPS responses. The mitmproxy plugin lets every HTTP request go through to the server uninhibited, and then passes it to Java via a WebSocket for rewriting. 22 | 23 | ## How does it work? 24 | 25 | `mitmproxy-java` starts a Websocket server and a Python plugin for `mitmproxy` connects to it and sends requests over. The two communicate via binary messages to reduce marshaling-related overhead. 26 | 27 | ## Pre-requisites 28 | 29 | * [`mitmproxy` V9](https://mitmproxy.org/) must be installed and runnable from the terminal. The install method cannot be a prebuilt binary or homebrew, since those packages are missing the Python websockets module. Install via `pip` or from source. 30 | * Python 3.6 and above, since we use the new async/await syntax in the mitmproxy plugin 31 | * `pip3 install websockets` 32 | 33 | Maven: 34 | ``` 35 | 36 | io.appium 37 | mitmproxy-java 38 | 2.0.2 39 | 40 | ``` 41 | 42 | Gradle: 43 | ``` 44 | testCompile group: 'io.appium', name: 'mitmproxy-java', version: '2.0.2' 45 | ``` 46 | 47 | ## Usage 48 | 49 | ```java 50 | List messages = new ArrayList(); 51 | 52 | //optional, default port is 8080 53 | int mitmproxyPort = 8090; 54 | 55 | //optional, you can pass null if no extra params 56 | List extraMitmproxyParams = Arrays.asList("param1", "value1", "param2", "value2"); 57 | 58 | // remember to set local OS proxy settings in the Network Preferences 59 | proxy = new MitmproxyJava("/usr/local/bin/mitmdump", (InterceptedMessage m) -> { 60 | System.out.println("intercepted request for " + m.getRequest().getUrl()); 61 | messages.add(m); 62 | return m; 63 | }, mitmproxyPort, extraMitmproxyParams); 64 | 65 | proxy.start(); 66 | 67 | // do stuff 68 | 69 | proxy.stop(); 70 | ``` 71 | 72 | If the above code doesn't work, and you are getting 73 | `Error=2, No such file or directory` please re-check your mitmdump path in new MitmproxyJava initialization. 74 | You can get mitmdump path using below command: 75 | ```shell 76 | whereis mitmdump 77 | ``` 78 | 79 | See AppiumPro article for more guidelines: https://appiumpro.com/editions/65 80 | Example can be found here: https://github.com/cloudgrey-io/appiumpro/blob/master/java/src/test/java/Edition065_Capture_Network_Requests.java 81 | 82 | ## Your Java code is bad and you should feel bad 83 | 84 | I'm no Java expert! You may see some bad patterns, like my terrible disregard for exception handling. Let's make it better. File your issues and land some PRs! I wrote this in just a couple days for our weekly newsletter. 85 | 86 | ## Your Python plugin is bad and you should feel bad 87 | 88 | See [node-mitmproxy](https://github.com/jvilk/mitmproxy-node/blob/master/README.md#your-python-plugin-is-bad-and-you-should-feel-bad). Pull requests welcome! 89 | 90 | ## Develop 91 | 92 | Upload to Central Repository with command `./gradlew uploadArchives` 93 | Set username and password in `build.gradle` file -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java-library' 3 | id 'signing' 4 | id 'maven' 5 | } 6 | 7 | group = 'io.appium' 8 | version = '2.0.2' 9 | archivesBaseName = 'mitmproxy-java' 10 | 11 | sourceCompatibility = 1.8 12 | 13 | repositories { 14 | mavenCentral() 15 | } 16 | 17 | dependencies { 18 | implementation 'org.java-websocket:Java-WebSocket:1.4.0' 19 | implementation group: 'javax.ws.rs', name: 'javax.ws.rs-api', version: '2.0-m02' 20 | implementation group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.9.8' 21 | implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.9.8' 22 | implementation group: 'org.zeroturnaround', name: 'zt-exec', version: '1.10' 23 | implementation group: 'org.zeroturnaround', name: 'zt-process-killer', version: '1.9' 24 | implementation group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.26' 25 | testCompile group: 'junit', name: 'junit', version: '4.12' 26 | testCompile group: 'org.mockito', name: 'mockito-all', version: '1.10.19' 27 | testCompile group: 'com.mashape.unirest', name: 'unirest-java', version: '1.4.9' 28 | testCompile group: 'org.assertj', name: 'assertj-core', version: '3.12.2' 29 | 30 | compileOnly 'org.projectlombok:lombok:1.18.8' 31 | annotationProcessor 'org.projectlombok:lombok:1.18.8' 32 | 33 | compile group: 'org.apache.commons', name: 'commons-collections4', version: '4.0' 34 | } 35 | 36 | task javadocJar(type: Jar) { 37 | classifier = 'javadoc' 38 | from javadoc 39 | } 40 | task sourcesJar(type: Jar) { 41 | classifier = 'sources' 42 | from sourceSets.main.allSource 43 | } 44 | artifacts { 45 | archives javadocJar, sourcesJar 46 | } 47 | signing { 48 | setRequired { 49 | // condition for when signing is required 50 | gradle.taskGraph.hasTask("uploadArchives") 51 | } 52 | sign configurations.archives 53 | } 54 | 55 | 56 | // Build, sign, and upload 57 | uploadArchives { 58 | repositories { 59 | mavenDeployer { 60 | 61 | // Sign POM 62 | beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) } 63 | 64 | // Destination 65 | repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") { 66 | authentication(userName: 'username', password: 'password') 67 | } 68 | snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") { 69 | authentication(userName: 'username', password: 'password') 70 | } 71 | 72 | // Add required metadata to POM 73 | pom.project { 74 | name 'mitmproxy-java' 75 | packaging 'jar' 76 | description 'A bridge between Python\'s mitmproxy and Java programs. Built on top of mitmproxy-node' 77 | url 'https://github.com/appium/mitmproxy-java' 78 | 79 | scm { 80 | connection 'scm:git:git://github.com/appium/mitmproxy-java.git' 81 | developerConnection 'scm:git:ssh://github.com/appium/mitmproxy-java.git' 82 | url 'http://github.com/appium/mitmproxy-java/tree/master' 83 | } 84 | 85 | licenses { 86 | license { 87 | name 'The Apache License, Version 2.0' 88 | url 'http://www.apache.org/licenses/LICENSE-2.0.txt' 89 | } 90 | } 91 | 92 | developers { 93 | developer { 94 | id 'jonahss' 95 | name 'Jonah Stiennon' 96 | email 'jonah@cloudgrey.io' 97 | organization 'Cloud Grey' 98 | organizationUrl 'https://cloudgrey.io' 99 | } 100 | } 101 | } 102 | } 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/appium/mitmproxy-java/01aae080fd64e2f9e2e90f304c43dabaf6d17a4d/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Thu Apr 11 14:32:28 PDT 2019 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.10-all.zip 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | websockets==6.0.0 -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'mitmproxy-java' 2 | 3 | -------------------------------------------------------------------------------- /src/main/java/io/appium/mitmproxy/InterceptedMessage.java: -------------------------------------------------------------------------------- 1 | package io.appium.mitmproxy; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | import com.fasterxml.jackson.databind.ObjectMapper; 5 | import lombok.Data; 6 | 7 | import java.util.List; 8 | 9 | @Data 10 | public class InterceptedMessage { 11 | 12 | private final static ObjectMapper objectMapper = new ObjectMapper(); 13 | 14 | private Request request; 15 | 16 | private Response response; 17 | 18 | @Data 19 | public static class Request { 20 | 21 | private String method; 22 | 23 | private String url; 24 | 25 | private List headers; 26 | 27 | @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 28 | private byte[] body; 29 | } 30 | 31 | @Data 32 | public static class Response { 33 | 34 | @JsonProperty("status_code") 35 | private int statusCode; 36 | 37 | private List headers; 38 | 39 | @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 40 | private byte[] body; 41 | } 42 | } -------------------------------------------------------------------------------- /src/main/java/io/appium/mitmproxy/MessageSerializer.java: -------------------------------------------------------------------------------- 1 | package io.appium.mitmproxy; 2 | 3 | import com.fasterxml.jackson.core.JsonProcessingException; 4 | import com.fasterxml.jackson.databind.ObjectMapper; 5 | import lombok.SneakyThrows; 6 | 7 | import java.io.IOException; 8 | import java.net.URL; 9 | import java.nio.ByteBuffer; 10 | import java.nio.ByteOrder; 11 | 12 | public class MessageSerializer { 13 | 14 | private final static ObjectMapper objectMapper = new ObjectMapper(); 15 | private static final int START_BYTES = 8; 16 | 17 | @SneakyThrows(IOException.class) 18 | public InterceptedMessage deserializeMessage(ByteBuffer buffer) { 19 | buffer.order(ByteOrder.LITTLE_ENDIAN); 20 | 21 | int metadataSize = buffer.getInt(); 22 | int request_content_size = buffer.getInt(); 23 | int response_content_size = buffer.getInt(); 24 | 25 | byte[] metadataBytes = new byte[metadataSize]; 26 | buffer.get(metadataBytes); 27 | 28 | byte[] requestBody = new byte[request_content_size]; 29 | buffer.get(requestBody); 30 | 31 | byte[] responseBody = new byte[response_content_size]; 32 | buffer.get(responseBody); 33 | 34 | InterceptedMessage interceptedMessage = objectMapper.readValue(metadataBytes, InterceptedMessage.class); 35 | interceptedMessage.getRequest().setBody(requestBody); 36 | interceptedMessage.getResponse().setBody(responseBody); 37 | 38 | return interceptedMessage; 39 | } 40 | 41 | public ByteBuffer serializeMessage(InterceptedMessage message) throws JsonProcessingException { 42 | byte[] responseBody = message.getResponse().getBody(); 43 | 44 | int contentLength = responseBody.length; 45 | 46 | byte[] metadata = objectMapper.writeValueAsBytes(message.getResponse()); 47 | int metadataLength = metadata.length; 48 | 49 | ByteBuffer buffer = ByteBuffer.allocate(START_BYTES + metadataLength + contentLength); 50 | buffer.order(ByteOrder.LITTLE_ENDIAN); 51 | buffer.putInt(metadataLength); 52 | buffer.putInt(contentLength); 53 | buffer.put(metadata); 54 | buffer.put(message.getResponse().getBody()); 55 | 56 | return (ByteBuffer) buffer.rewind(); 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/io/appium/mitmproxy/MitmproxyJava.java: -------------------------------------------------------------------------------- 1 | package io.appium.mitmproxy; 2 | 3 | import lombok.SneakyThrows; 4 | import lombok.extern.slf4j.Slf4j; 5 | import org.apache.commons.io.IOUtils; 6 | import org.zeroturnaround.exec.ProcessExecutor; 7 | import org.zeroturnaround.exec.ProcessResult; 8 | import org.zeroturnaround.exec.stream.slf4j.Slf4jStream; 9 | 10 | import java.io.File; 11 | import java.io.FileOutputStream; 12 | import java.io.IOException; 13 | import java.io.InputStream; 14 | import java.net.InetSocketAddress; 15 | import java.net.Socket; 16 | import java.time.LocalDateTime; 17 | import java.util.ArrayList; 18 | import java.util.List; 19 | import java.util.concurrent.Future; 20 | import java.util.concurrent.TimeoutException; 21 | import java.util.function.Function; 22 | 23 | import static org.apache.commons.collections4.CollectionUtils.isNotEmpty; 24 | 25 | @Slf4j 26 | public class MitmproxyJava { 27 | 28 | private static final String LOCALHOST_IP = "127.0.0.1"; 29 | private static final int WEBSOCKET_PORT = 8765; 30 | private static final int TIMEOUT_FOR_SOCKET_CHECKING_MINS = 5; 31 | 32 | private final String mitmproxyPath; 33 | 34 | private final Function messageInterceptor; 35 | 36 | private final int proxyPort; 37 | 38 | private MitmproxyServer server; 39 | 40 | private final List extraMitmdumpParams; 41 | 42 | private Future mitmproxyProcess; 43 | 44 | public MitmproxyJava(String mitmproxyPath, Function messageInterceptor, int proxyPort, List extraMitmdumpParams) { 45 | this.mitmproxyPath = mitmproxyPath; 46 | this.messageInterceptor = messageInterceptor; 47 | this.proxyPort = proxyPort; 48 | this.extraMitmdumpParams = extraMitmdumpParams; 49 | } 50 | 51 | public MitmproxyJava(String mitmproxyPath, Function messageInterceptor) { 52 | this(mitmproxyPath, messageInterceptor, 8080, null); 53 | } 54 | 55 | public MitmproxyJava start() throws IOException, TimeoutException { 56 | log.info("Starting mitmproxy on port {}", proxyPort); 57 | 58 | server = new MitmproxyServer(new InetSocketAddress(LOCALHOST_IP, WEBSOCKET_PORT), messageInterceptor); 59 | server.start(); 60 | 61 | // python script file is zipped inside our jar. extract it into a temporary file. 62 | String pythonScriptPath = extractPythonScriptToFile(); 63 | 64 | final List mitmproxyStartParams = new ArrayList<>(); 65 | mitmproxyStartParams.add(mitmproxyPath); 66 | mitmproxyStartParams.add("--anticache"); 67 | mitmproxyStartParams.add("-p"); 68 | mitmproxyStartParams.add(String.valueOf(proxyPort)); 69 | mitmproxyStartParams.add("-s"); 70 | mitmproxyStartParams.add(pythonScriptPath); 71 | 72 | // adding params if needed for mitmproxy 73 | if (isNotEmpty(this.extraMitmdumpParams)) { 74 | mitmproxyStartParams.addAll(this.extraMitmdumpParams); 75 | } 76 | 77 | mitmproxyProcess = new ProcessExecutor() 78 | .command(mitmproxyStartParams) 79 | .redirectOutput(Slf4jStream.ofCaller().asInfo()) 80 | .destroyOnExit() 81 | .start() 82 | .getFuture(); 83 | 84 | waitForPortToBeInUse(proxyPort); 85 | log.info("Mitmproxy started on port {}", proxyPort); 86 | return this; 87 | } 88 | 89 | private String extractPythonScriptToFile() throws IOException { 90 | File outfile = File.createTempFile("mitmproxy-python-plugin", ".py"); 91 | 92 | try ( 93 | InputStream inputStream = getClass().getClassLoader().getResourceAsStream("scripts/proxy.py"); 94 | FileOutputStream outputStream = new FileOutputStream(outfile)) { 95 | 96 | IOUtils.copy(inputStream, outputStream); 97 | } 98 | 99 | return outfile.getCanonicalPath(); 100 | } 101 | 102 | public void stop() throws InterruptedException { 103 | if (mitmproxyProcess != null) { 104 | mitmproxyProcess.cancel(true); 105 | } 106 | server.stop(1000); 107 | waitForPortToBeFree(proxyPort); 108 | } 109 | 110 | @SneakyThrows 111 | private void waitForPortToBeFree(int port) { 112 | final LocalDateTime timeoutTime = LocalDateTime.now().plusMinutes(TIMEOUT_FOR_SOCKET_CHECKING_MINS); 113 | 114 | while (true) { 115 | if(timeoutTime.isBefore(LocalDateTime.now())){ 116 | throw new TimeoutException("Timed out waiting for mitmproxy to stop"); 117 | } 118 | try (Socket s = new Socket(LOCALHOST_IP, port)) { 119 | } catch (IOException ioe) { 120 | return; 121 | } 122 | 123 | try { 124 | Thread.sleep(100); 125 | } catch (InterruptedException e) { 126 | e.printStackTrace(); 127 | } 128 | } 129 | } 130 | 131 | @SneakyThrows 132 | private void waitForPortToBeInUse(int port) { 133 | final LocalDateTime timeoutTime = LocalDateTime.now().plusMinutes(TIMEOUT_FOR_SOCKET_CHECKING_MINS); 134 | 135 | while (true) { 136 | 137 | if(timeoutTime.isBefore(LocalDateTime.now())){ 138 | throw new TimeoutException("Timed out waiting for mitmproxy to start"); 139 | } 140 | 141 | try (Socket s = new Socket(LOCALHOST_IP, port)) { 142 | return; 143 | } catch (IOException ioe) { 144 | try { 145 | Thread.sleep(100); 146 | } catch (InterruptedException e) { 147 | e.printStackTrace(); 148 | } 149 | } 150 | } 151 | } 152 | } 153 | -------------------------------------------------------------------------------- /src/main/java/io/appium/mitmproxy/MitmproxyServer.java: -------------------------------------------------------------------------------- 1 | package io.appium.mitmproxy; 2 | 3 | import com.fasterxml.jackson.core.JsonProcessingException; 4 | import org.java_websocket.WebSocket; 5 | import org.java_websocket.handshake.ClientHandshake; 6 | import org.java_websocket.server.WebSocketServer; 7 | import org.slf4j.Logger; 8 | import org.slf4j.LoggerFactory; 9 | 10 | import java.net.InetSocketAddress; 11 | import java.nio.ByteBuffer; 12 | import java.util.function.Function; 13 | 14 | public class MitmproxyServer extends WebSocketServer { 15 | 16 | private static final Logger LOGGER = LoggerFactory.getLogger(WebSocketServer.class); 17 | 18 | private final Function interceptor; 19 | 20 | private final MessageSerializer messageSerializer; 21 | 22 | MitmproxyServer(InetSocketAddress address, Function interceptor) { 23 | super(address); 24 | this.interceptor = interceptor; 25 | this.messageSerializer = new MessageSerializer(); 26 | } 27 | 28 | @Override 29 | public void onOpen(WebSocket conn, ClientHandshake handshake) { 30 | LOGGER.debug("new connection to websocket server" + conn.getRemoteSocketAddress()); 31 | } 32 | 33 | @Override 34 | public void onClose(WebSocket conn, int code, String reason, boolean remote) { 35 | LOGGER.debug("closed " + conn.getRemoteSocketAddress() + " with exit code " + code + " additional info: " + reason); 36 | } 37 | 38 | @Override 39 | public void onMessage(WebSocket conn, String message) { 40 | LOGGER.debug("received message from " + conn.getRemoteSocketAddress() + " : " + message); 41 | } 42 | 43 | @Override 44 | public void onMessage(WebSocket conn, ByteBuffer rawInputMessage) { 45 | InterceptedMessage incomingMessage = this.messageSerializer.deserializeMessage(rawInputMessage); 46 | 47 | InterceptedMessage modifiedMessage = interceptor.apply(incomingMessage); 48 | 49 | // if the supplied interceptor function does not return a message, assume no changes were intended and just 50 | // complete the request 51 | InterceptedMessage messageToSendBack = modifiedMessage; 52 | 53 | if (modifiedMessage == null) { 54 | messageToSendBack = incomingMessage; 55 | } 56 | 57 | try { 58 | conn.send(this.messageSerializer.serializeMessage(messageToSendBack)); 59 | } catch (JsonProcessingException e) { 60 | LOGGER.error(e.getMessage()); 61 | } 62 | } 63 | 64 | @Override 65 | public void onError(WebSocket conn, Exception ex) { 66 | LOGGER.error("an error occured on connection " + conn.getRemoteSocketAddress() + ":" + ex); 67 | } 68 | 69 | @Override 70 | public void onStart() { 71 | LOGGER.info("websocket server started successfully"); 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /src/main/resources/scripts/install_python_deps.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Sanity checks the Python environment 4 | """ 5 | import sys 6 | from subprocess import check_call, check_output 7 | 8 | # Check Python version 9 | if sys.version_info < (3,6): 10 | sys.exit("mitmproxy-node requires a Python version >= 3.6, but found {}.{}".format(sys.version_info[0], sys.version_info[1])) 11 | 12 | # Verify that mitmproxy is installed 13 | try: 14 | mitmdump_output = str(check_output(["mitmdump", "--version"])) 15 | version = mitmdump_output.split("\\n")[0].split(" ")[1].split('.') 16 | print(version) 17 | version[0] = int(version[0]) 18 | version[1] = int(version[1]) 19 | version[2] = int(version[2]) 20 | if tuple(version) < (4,0,0): 21 | sys.exit("mitmproxy-node requires mitmproxy >= 4.0.0, but found {}.{}.{}".format(version[0], version[1], version[2])) 22 | except FileNotFoundError: 23 | sys.exit("mitmproxy-node requires mitmproxy to be installed. See http://docs.mitmproxy.org/en/stable/install.html for instructions.") 24 | 25 | # Install dependencies with pip3 first. 26 | # If pip3 isn't found, use pip. 27 | try: 28 | check_call(["pip3", "install", "-r", "requirements.txt"]) 29 | except FileNotFoundError: 30 | check_call(["pip", "install", "-r", "requirements.txt"]) 31 | -------------------------------------------------------------------------------- /src/main/resources/scripts/proxy.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | """ 3 | Interception proxy using mitmproxy (https://mitmproxy.org). 4 | Communicates to NodeJS via websockets. 5 | """ 6 | 7 | import argparse 8 | import asyncio 9 | import queue 10 | import json 11 | import threading 12 | import typing 13 | import traceback 14 | import sys 15 | import struct 16 | import websockets 17 | from mitmproxy import ctx 18 | from mitmproxy import http 19 | 20 | def convert_headers_to_bytes(header_entry): 21 | """ 22 | Converts a tuple of strings into a tuple of bytes. 23 | """ 24 | return [bytes(header_entry[0], "utf8"), bytes(header_entry[1], "utf8")] 25 | 26 | def convert_body_to_bytes(body): 27 | """ 28 | Converts a HTTP request/response body into a list of numbers. 29 | """ 30 | if body is None: 31 | return bytes() 32 | else: 33 | return body 34 | 35 | def is_text_response(headers): 36 | if 'content-type' in headers: 37 | ct = headers['content-type'].lower() 38 | # Allow all application/ and text/ MIME types. 39 | return 'application' in ct or 'text' in ct or ct.strip() == "" 40 | return True 41 | 42 | class WebSocketAdapter: 43 | """ 44 | Relays HTTP/HTTPS requests to a websocket server. 45 | Enables using MITMProxy from outside of Python. 46 | """ 47 | 48 | def websocket_thread(self): 49 | """ 50 | Main function of the websocket thread. Runs the websocket event loop 51 | until MITMProxy shuts down. 52 | """ 53 | self.worker_event_loop = asyncio.new_event_loop() 54 | self.worker_event_loop.run_until_complete(self.websocket_loop()) 55 | 56 | def __init__(self): 57 | self.queue = queue.Queue() 58 | self.intercept_paths = frozenset([]) 59 | self.only_intercept_text_files = False 60 | self.finished = False 61 | # Start websocket thread 62 | threading.Thread(target=self.websocket_thread).start() 63 | 64 | def load(self, loader): 65 | loader.add_option( 66 | "intercept", str, "", 67 | """ 68 | A list of HTTP paths, delimited by a comma, to intercept and pass to Node without hitting the server. 69 | E.g.: /foo,/bar 70 | """ 71 | ) 72 | loader.add_option( 73 | name = "onlyInterceptTextFiles", 74 | typespec = bool, 75 | default = False, 76 | help = "If true, the plugin only intercepts text files and passes through other types of files", 77 | ) 78 | return 79 | 80 | def configure(self, updates): 81 | if "intercept" in updates: 82 | self.intercept_paths = frozenset(ctx.options.intercept.split(",")) 83 | #print("Intercept paths:") 84 | #print(self.intercept_paths) 85 | if "onlyInterceptTextFiles" in updates: 86 | self.only_intercept_text_files = ctx.options.onlyInterceptTextFiles 87 | #print("Only intercept text files:") 88 | #print(self.only_intercept_text_files) 89 | return 90 | 91 | def send_message(self, metadata, data1, data2): 92 | """ 93 | Sends the given message on the WebSocket connection, 94 | and awaits a response. Metadata is a JSONable object, 95 | and data is bytes. 96 | """ 97 | metadata_bytes = bytes(json.dumps(metadata), 'utf8') 98 | data1_size = len(data1) 99 | data2_size = len(data2) 100 | metadata_size = len(metadata_bytes) 101 | 102 | msg = struct.pack(" { 33 | System.out.println(m.getRequest().getUrl()); 34 | return m; 35 | }); 36 | proxy.start(); 37 | System.out.println("advanced in test"); 38 | proxy.stop(); 39 | } 40 | 41 | @Test 42 | public void SimpleTest() throws InterruptedException, TimeoutException, IOException, UnirestException { 43 | List messages = new ArrayList<>(); 44 | 45 | MitmproxyJava proxy = new MitmproxyJava(MITMDUMP_PATH, (InterceptedMessage m) -> { 46 | messages.add(m); 47 | return m; 48 | }); 49 | proxy.start(); 50 | 51 | Unirest.setProxy(new HttpHost("localhost", 8080)); 52 | Unirest.get("http://appium.io").header("myTestHeader", "myTestValue").asString(); 53 | 54 | proxy.stop(); 55 | final InterceptedMessage firstMessage = messages.get(0); 56 | 57 | assertThat(firstMessage.getRequest().getUrl()).startsWith("http://appium.io"); 58 | assertThat(firstMessage.getRequest().getHeaders()).containsOnlyOnce(new String[]{"myTestHeader", "myTestValue"}); 59 | assertThat(firstMessage.getResponse().getStatusCode()).isEqualTo(200); 60 | } 61 | 62 | @Test 63 | public void NullInterceptorReturnTest() throws InterruptedException, TimeoutException, IOException, UnirestException { 64 | List messages = new ArrayList<>(); 65 | 66 | MitmproxyJava proxy = new MitmproxyJava(MITMDUMP_PATH, (InterceptedMessage m) -> { 67 | messages.add(m); 68 | return null; 69 | }, 8087, null); 70 | proxy.start(); 71 | 72 | Unirest.setProxy(new HttpHost("localhost", 8087)); 73 | Unirest.get("http://appium.io").header("myTestHeader", "myTestValue").asString(); 74 | 75 | proxy.stop(); 76 | 77 | assertThat(messages).isNotEmpty(); 78 | 79 | final InterceptedMessage firstMessage = messages.get(0); 80 | 81 | assertThat(firstMessage.getRequest().getUrl()).startsWith("http://appium.io"); 82 | assertThat(firstMessage.getRequest().getHeaders()).containsOnlyOnce(new String[]{"myTestHeader", "myTestValue"}); 83 | assertThat(firstMessage.getResponse().getStatusCode()).isEqualTo(200); 84 | } 85 | 86 | @Test 87 | public void ResponseModificationTest() throws InterruptedException, TimeoutException, IOException, UnirestException { 88 | List messages = new ArrayList<>(); 89 | 90 | MitmproxyJava proxy = new MitmproxyJava(MITMDUMP_PATH, (InterceptedMessage m) -> { 91 | messages.add(m); 92 | m.getResponse().setBody("Hi from Test".getBytes(StandardCharsets.UTF_8)); 93 | m.getResponse().getHeaders().add(new String[]{"myTestResponseHeader", "myTestResponseHeaderValue"}); 94 | m.getResponse().setStatusCode(208); 95 | return m; 96 | }); 97 | proxy.start(); 98 | 99 | Unirest.setProxy(new HttpHost("localhost", 8080)); 100 | HttpResponse response = Unirest.get("http://appium.io").header("myTestHeader", "myTestValue").asString(); 101 | proxy.stop(); 102 | 103 | assertThat(response.getBody()).isEqualTo("Hi from Test"); 104 | 105 | final InterceptedMessage firstMessage = messages.get(0); 106 | 107 | assertThat(firstMessage.getRequest().getUrl()).startsWith("http://appium.io"); 108 | assertThat(firstMessage.getRequest().getHeaders()).containsOnlyOnce(new String[]{"myTestHeader", "myTestValue"}); 109 | assertThat(firstMessage.getResponse().getHeaders()).containsOnlyOnce(new String[]{"myTestResponseHeader", "myTestResponseHeaderValue"}); 110 | assertThat(firstMessage.getResponse().getStatusCode()).isEqualTo(208); 111 | } 112 | 113 | @Test 114 | public void shouldAddParametersToMitmdumpStart() throws IOException, TimeoutException, InterruptedException { 115 | List mitmdumpParams = new ArrayList<>(); 116 | mitmdumpParams.add("testParam"); 117 | 118 | List spiedParams = spy(mitmdumpParams); 119 | 120 | MitmproxyJava proxy = new MitmproxyJava(MITMDUMP_PATH, (InterceptedMessage m) -> { 121 | m.getResponse().setBody("Hi from Test".getBytes(StandardCharsets.UTF_8)); 122 | m.getResponse().getHeaders().add(new String[]{"myTestResponseHeader", "myTestResponseHeaderValue"}); 123 | m.getResponse().setStatusCode(208); 124 | return m; 125 | }, 8087, spiedParams); 126 | 127 | proxy.start(); 128 | proxy.stop(); 129 | 130 | //to verify that additional params were actually included to start path 131 | verify(spiedParams).toArray(); 132 | 133 | } 134 | } --------------------------------------------------------------------------------