# cryptoguard

**Repository Path**: han0nly/cryptoguard

## Basic Information

- **Project Name**: cryptoguard
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-06
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CryptoGuard: Source Code

An program analysis tool to find cryptographic misuse in Java and Android.

### Prerequisites to use CryptoGuard on Source code:

1. Download and Install JDK 7.
2. Set `JAVA7_HOME` environment variable.
3. Download and Install Gradle.

### Prerequisites to use CryptoGuard on Jar:

1. Download and Install JDK (version >= 7).
2. Set `JAVA_HOME` environment variable.
3. Download and Install Gradle.

### Prerequisites to use CryptoGuard on Apk:

1. Download and Install JDK (version >= 7).
2. Set `JAVA_HOME` environment variable.
3. Download and Install Android SDK
4. Set `ANDROID_SDK_HOME`
5. Download and Install Gradle.

### Build CryptoGuard
1. Run `cd /path/to/octopus`
2. Run `gradle clean build`

### Run CryptoGuard to analyze source code:

You need to run CryptoGuard on JDK 7 to analyze source codes. If the project does not have any external dependencies then run,
     
`cd /path/to/octopus &&  /usr/local/jdk1.7.0_80/bin/java -jar main/build/libs/main.jar "source" "/path/to/project/root" ""`

If the project have external dependencies then first gather the dependencies under a folder that is relative to the project root (e.g., “build/dependencies”), then run

`cd /path/to/octopus && /usr/local/jdk1.7.0_80/bin/java -jar main/build/libs/main.jar "source" "/path/to/project/root" "build/dependencies"`

Note that if you have multiple subprojects with external dependencies, then you have to gather all the corresponding subproject dependencies under a path that is relative to each of the subprojects.

### Run CryptoGuard to analyze Jar:

`cd /path/to/octopus && java -jar main/build/libs/main.jar "jar" "/path/to/jar/my-jar.jar" ""`

### Run CryptoGuard to analyze Apk:

`cd /path/to/octopus && java -jar main/build/libs/main.jar "apk" "/path/to/apk/my-apk.apk" `

## Disclaimer

##### CryptoGuard is a research prototype under GNU General Public License 3.0

 Copyright © 2018 CryptoGuard

 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
 
 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License 3.0 for more details.
 
 You should have received a copy of the GNU General Public License 3.0 along with this program.  If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.

## Reference

If you find this project useful, please cite our CCS'19 [CryptoGuard](https://dl.acm.org/citation.cfm?doid=3319535.3345659) paper.