Veracode Java API包装器

Veracode Java API包装器可将Veracode API集成到开发流水线和项目中，通过将多组API调用封装为易用函数，简化项目自动化流程。Veracode提供的API可映射Veracode平台上的主要步骤，支持自动化扫描、结果审查与缓解以及管理任务执行。有关所有API调用及如何创建API服务账户访问Veracode API的信息，请访问Veracode帮助中心。

镜像详情

该镜像提供两个变体：

• veracode/api-wrapper-java
  环境变体，提供shell环境，适用于流水线或其他需要shell的场景。latest标签指向此变体。
• veracode/api-wrapper-java:cmd
  命令变体，用于直接从命令行运行工具，通过shell别名运行时尤为实用。

镜像基于AdoptOpenJDK 11 JRE Docker***镜像构建。Veracode Java API包装器JAR文件安装在/opt/veracode/目录下。默认情况下，容器以非特权本地用户身份运行。

以环境模式运行

在GitLab流水线中（通过环境变量提供API凭证）：

yaml
scan-my-java-app:
  image: veracode/api-wrapper-java:latest
  script:
    - java -jar /opt/veracode/api-wrapper.jar 
        -vid ${VERACODE_API_KEY_ID}
        -vkey ${VERACODE_API_KEY_SECRET} 
        -action UploadAndScan
        -createprofile true
        -appname ${CI_PROJECT_NAME}
        -version ${CI_BUILD_TAG}
        -filepath /path/to/built/app.jar

scan-my-python-app:
  image: veracode/api-wrapper-java:latest
  script:
    - zip myapp.zip ./src/
    - java -jar /opt/veracode/api-wrapper.jar
        -vid ${VERACODE_API_KEY_ID}
        -vkey ${VERACODE_API_KEY_SECRET}
        -action UploadAndScan
        -createprofile true
        -appname ${CI_PROJECT_NAME}
        -version ${CI_BUILD_TAG}
        -filepath myapp.zip

本地shell模式（挂载当前主机目录到容器内）：

bash
docker run -it --rm -v $PWD:/home/luser veracode/api-wrapper-java

默认情况下，容器以非特权本地用户身份在/home/luser目录运行。如需修改，可使用--user参数获取root shell，使用--workdir参数更改工作目录：

bash
docker run -it --rm --user root veracode/api-wrapper-java
docker run -it --rm --workdir /my/app/path veracode/api-wrapper-java
docker run -it --rm --user root --workdir /my/app/path veracode/api-wrapper-java

以命令模式运行

挂载Veracode凭证文件运行：

bash
docker run -it --rm \
    -v ~/.veracode/credentials:/home/luser/.veracode/credentials \
    -v /host/os/path/to/myapp/:/myapp/ \
    veracode/api-wrapper-java:cmd \
        -action UploadAndScan \
        -createprofile true \
        -appname "My App" \
        -version "v0.1" \
        -filepath /myapp/myapp.jar

通过环境变量提供API凭证运行：

bash
docker run -it --rm \
    --env VERACODE_API_KEY_ID=c2db7664... \
    --env VERACODE_API_KEY_SECRET=24f62c81... \
    -v /host/os/path/to/myapp/:/myapp/ \
    veracode/api-wrapper-java:cmd \
        -action UploadAndScan \
        -createprofile true \
        -appname "My App" \
        -version "v0.1" \
        -filepath /myapp/myapp.jar

查看所有可用选项及帮助：

bash
docker run -it --rm veracode/api-wrapper-java:cmd -help

别名设置

命令变体通过shell别名使用时尤为便捷：

bash
alias 'veracode-api'='docker run -it --rm -v $PWD:/home/luser -v ~/.veracode/credentials:/home/luser/.veracode/credentials veracode/api-wrapper-java:cmd'

之后可像本地可执行程序一样运行容器：

bash
veracode-api -help
veracode-api -action GetAppList
veracode-api -action UploadAndScan -createprofile true -appname "My App" -version "v0.1" -filepath /myapp/myapp.jar