Java 版本

获取源码

你可以使用 git 命令，也可以直接在 Github 下载 ZIP 包

  1. git clone https://github.com/baidu/openrasp.git

准备环境

为了保证最大兼容性，我们建议使用 JDK 6 进行编译

为编译所依赖的JNI模块，需要安装 c++ 编译器和 cmake 生成器

以 CentOS 为例，使用如下命令，安装 g++ 5.3.1

  1. yum install -y centos-release-scl
  2. yum install -y devtoolset-4-gcc-c++

安装完成后，执行如下命令进入编译环境

  1. scl enable devtoolset-4 bash

安装高版本 cmake

  1. # 下载并解压到 /tmp，避免与已有 cmake 冲突
  2. curl -L  https://github.com/Kitware/CMake/releases/download/v3.15.3/cmake-3.15.3-Linux-x86_64.tar.gz | tar zx -C /tmp
  4. # 增加临时 PATH
  5. export PATH=/tmp/cmake-3.15.3-Linux-x86_64/bin:$PATH

编译 openrasp-v8 基础库

以 64位 Linux 系统为例，在OpenRASP仓库根目录执行以下命令

  1. # 更新 git submodule
  2. git submodule update --init
  4. # 编译 openrasp-v8
  5. mkdir -p openrasp-v8/build64 && cd openrasp-v8/build64
  6. cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_LANGUAGES=java ..
  7. make
  9. # 复制动态链接库到 resources 目录
  10. mkdir -p ../java/src/main/resources/natives/linux_64 && cp java/libopenrasp_v8_java.so $_
  12. # 编译 v8-1.0-SNAPSHOT.jar，安装 v8-1.0-SNAPSHOT.jar 到 maven 本地仓库
  13. cd ../java
  14. mvn install

更多平台的编译细节请参考

开始编译

  1. 方案1 - 使用 IDEA Intellij 进行操作

    导入 maven 工程，目录选 agent/java，正常编译即可

  2. 方案2 - 使用 mvn 命令编译

    进入命令行，

    1. cd <openrasp_path>/agent/java
    2. mvn versions:use-latest-releases -Dincludes=com.baidu.openrasp:sqlparser
    3. mvn clean package

    最终生成的 JAR 包在 boot/target 和 engine/target 目录下，aka： $openrasp_path/agent/java/boot/target/rasp.jar和$openrasp_path/agent/java/engine/target/rasp.jar

  3. 方案3 - 使用 build-java.sh 生成安装包

    如果你使用 Linux 进行编译，可以执行源代码目录下面的 build-java.sh 进行编译和打包操作。这个脚本会在源代码根目录，生成 rasp-java.tar.gz 和 rasp-java.zip 两个文件

常见问题

1. maven 超时

如果总是出现超时错误，你可以考虑使用阿里云的镜像。

[ERROR] Plugin org.apache.maven.plugins:maven-resources-plugin:3.0.2 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.apache.maven.plugins:maven-resources-plugin:jar:3.0.2: Could not transfer artifact org.apache.maven.plugins:maven-resources-plugin:pom:3.0.2 from/to central (https://repo.maven.apache.org/maven2): Connect to repo.maven.apache.org:443 [repo.maven.apache.org/151.101.196.215] failed: Operation timed out (Connection timed out) -> [Help 1]

修改方法是编辑 ~/.m2/settings.xml，并填写如下内容

  1. <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  2.   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.   xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
  4.                       http://maven.apache.org/xsd/settings-1.0.0.xsd">
  5.   <localRepository/>
  6.   <interactiveMode/>
  7.   <usePluginRegistry/>
  8.   <offline/>
  9.   <pluginGroups/>
  10.   <servers/>
  11.   <mirrors>
  12.     <mirror>
  13.      <id>aliyunmaven</id>
  14.      <mirrorOf>central</mirrorOf>
  15.      <name>阿里云公共仓库</name>
  16.      <url>https://maven.aliyun.com/repository/central</url>
  17.     </mirror>
  18.     <mirror>
  19.       <id>repo1</id>
  20.       <mirrorOf>central</mirrorOf>
  21.       <name>central repo</name>
  22.       <url>http://repo1.maven.org/maven2/</url>
  23.     </mirror>
  24.     <mirror>
  25.      <id>aliyunmaven</id>
  26.      <mirrorOf>apache snapshots</mirrorOf>
  27.      <name>阿里云阿帕奇仓库</name>
  28.      <url>https://maven.aliyun.com/repository/apache-snapshots</url>
  29.     </mirror>
  30.   </mirrors>
  31.   <proxies/>
  32.   <activeProfiles/>
  33.   <profiles>
  34.     <profile>
  35.         <repositories>
  36.            <repository>
  37.                 <id>aliyunmaven</id>
  38.                 <name>aliyunmaven</name>
  39.                 <url>https://maven.aliyun.com/repository/public</url>
  40.                 <layout>default</layout>
  41.                 <releases>
  42.                         <enabled>true</enabled>
  43.                 </releases>
  44.                 <snapshots>
  45.                         <enabled>true</enabled>
  46.                 </snapshots>
  47.             </repository>
  48.             <repository>
  49.                 <id>MavenCentral</id>
  50.                 <url>http://repo1.maven.org/maven2/</url>
  51.             </repository>
  52.             <repository>
  53.                 <id>aliyunmavenApache</id>
  54.                 <url>https://maven.aliyun.com/repository/apache-snapshots</url>
  55.             </repository>
  56.         </repositories>
  57.      </profile>
  58.   </profiles>
  59. </settings>

2. git-commit-id-plugin 错误

如果你使用 JDK 1.6 编译，可能会遇到如下错误:

[ERROR] Plugin pl.project13.maven:git-commit-id-plugin:2.1.5 or one of its dependencies could not be resolved: Failed to read artifact descriptor for pl.project13.maven:git-commit-id-plugin:jar:2.1.5: Could not transfer artifact pl.project13.maven:git-commit-id-plugin:pom:2.1.5 from/to central (https://repo.maven.apache.org/maven2): Received fatal alert: protocol_version -> [Help 1]

这是一个 https 证书错误，解决方法是替换 maven 仓库地址为 http 版本。可以考虑修改 ~/.m2/settings.xml，并添加如下内容

  1. <?xml version="1.0"?>
  2. <settings>
  3.   <mirrors>
  4.     <mirror>
  5.       <id>central-no-ssl</id>
  6.       <name>Central without ssl</name>
  7.       <url>http://repo.maven.apache.org/maven2</url>
  8.       <mirrorOf>central</mirrorOf>
  9.     </mirror>
  10.   </mirrors>
  11. </settings>

3. 缺少 Premain-Class 属性

如果你使用IDE编译，最终可能出现这样的错误:

Failed to find Premain-Class manifest attribute in D:\apache-tomcat-7.0.82\rasp\rasp.jar

这是因为IDE没有修改 META-INF 下面的文件。我们建议你使用 maven 编译，或者直接导入 maven 工程