China E-Port Data Signature

**电子口岸（海口海关）报文加签推送应用

前言

After nearly two years of open-source code maintenance and exploration, we have successfully developed an all-in-one solution that offers free access and usage for a wide range of businesses. This solution aims to digitally sign and forward XML messages to the General Administration of Customs at the Chinese Electronic Port (HaiKou Customs), facilitating cross-border e-commerce operations and import-export trade for enterprises.

经过长达近两年的开源代码维护和探索，我们终于成功开发出一站式解决方案，为更多企业提供免费接入和使用。该解决方案的目标是对**电子口岸海关（海口海关）总署的XML报文进行加签推送，以促进企业的跨境电商业务和进出口贸易。

Weasley J（2023-07）

该项目为**电子口岸海关（海口海关）总署XML报文和海关179数据上报加签服务，提供一站式的免费解决方案，开箱即用，无需使用中间件。本项目遵守GNU 3.0协议。需要注意的是，项目中的测试用例所涉及的企业信息已经获得企业批准。当接入企业使用测试用例进行报文申报调试时，应将报文数据中涉及到的报文传输编码（DXPID）、copCode、copName、电商平台代码ebpCode等主体信息，替换成企业在**电子口岸后台注册的有效信息。

业务场景

**境内的跨境电商业务，进出口贸易

使用提示

对于单体应用，您可以直接下载release中的二进制文件使用（使用较多），根据您的实际情况适当修改运行参数。
对于分布式微服务，建议切换到feature_microservice分支进行构建（较少使用）。
您还可以通过Docker镜像快速搭建报文加签推送的环境。
如果您的电商后台系统也是使用Java语言开发，我们在Maven仓库中上传了项目中用到的数据模型，可帮助您的系统与本项目快速集成。您只需要使用这些数据模型填充数据，然后使用JSON进行数据交互，从而降低对接成本。

功能概述

系统架构

报文加签推送流程

当我们决定将此项目开源的时候，地球上的搜索引擎在2022年2月14日之前还无法搜索到任何有价值的信息。当面对付费解决方案时，ChatGPT是否能提供帮助呢……

Previews of China E-Port Sata Signature

在项目开始之前，让我们先了解一下海关总署XML报文的加签服务在市场上的定价。虽然在百度和CSDN上，您可以找到海关179数据上报的接口对接方式，但是唯独没有关于XML报文加签的信息，请参考下图：

没错，您没有看错：当您尝试寻求乙方（服务提供方）的对接时，乙方可能不会提供加签所使用的算法，因此需要接入方（您）自己进行开发。好吧，那就让我们开始开发吧！

电子口岸的操作员u-key图片资料:

启动项目：chinaport-data-signature

Windows终端日志会乱码，推荐通过Git Bash启动

右键启动

sh start.sh 启动

加签失败邮件告警

此功能需手动开启，开关属性: spring.mail.enable, 取值: on/off，也可以告警消息接入企业微信、钉钉、飞书、Discord等企业沟通软件。

加签失败邮件通知

1 支持的电子口岸

核心加签接口理论上支持**内地的大部分地方电子口岸

电子口岸	是否支持	是否验证
海口电子口岸	✅	✅
广州电子口岸	✅	✅
郑州电子口岸	✅	待验证
上海电子口岸	✅	待验证
杭州电子口岸	✅	待验证
...

2 项目代码质量

3 软件运行概况

序号	类目	版本	备注
1	软件运行环境	Java SE Development Kit 17	基础软件运行的`JDK`环境要求
2	硬件运行环境	`Windows-10-x64`/`Windows-11-x64`/`Windows-server-x64`/`Linux`(自行解决内网穿透问题,ukey只能插Windows电脑上)
3	硬件性能要求	> =1核CPU+2G运行内存	最低配置
4	对技术人员的要求	会把电子口岸ukey插入安装好【**电子口岸C卡/Key客户端控件】的`Windows`电脑上，会改启动脚本里面的参数，会用鼠标双击启动脚本	卡介质登录可进入【**电子口岸C卡/Key客户端控件】下载界面

不推荐使用国产浏览器蓝开以上超链，会出现页面找不到，建议使用：Microsoft Edge、Chrome、Fire Fox

4 运行参数配置

本应用是标准的springboot应用，支持springboot 的所有配置参数，推荐通过在线yaml转properties将配置元数据复制到命令行参数中按需使用,

配置参数	是否必须（Y/N）	解释
eport.signature.algorithm	N	XML签名的算法类型，不指定时使用程序自动推断的算法, 推荐使用程序自动推断的算法
eport.signature.ukey.ws-url	Y	`u-key`所连接的`Windows`电脑的`socket`链接`url`,如: `ws://127.0.0.1:61232`,下载`release`直接运行的修改全局配置的`UKEY_HOST`即可
eport.signature.ukey.password	N	u-key密码的密码，默认: `88888888`, 如果密码改过，需要指定下，下载`release`直接运行的修改全局配置的`UKEY_PASSWORD`即可
eport.signature.ukey.health.endpoint.client-name	N	Windows上重启的ukey可执行文件全限定文件名称，不指定将自动查找（将程序安装到Windows平台上会生效，Linux、Uni环境无效）
eport.signature.auth.enable	N	是否启用token鉴权，取值：on/off，生产环境建议开启
eport.signature.auth.token	N	客户端请求鉴权token, 默认值: DefaultAuthToken, 请求头，生产环境不建议使用默认值
eport.signature.report.ceb-message.cop-code	Y	电子口岸XML报文传输企业代码
eport.signature.report.ceb-message.cop-name	Y	传输企业名称，报文传输的企业名称
eport.signature.report.ceb-message.dxp-id	Y	文传输编号，向**电子口岸数据中心申请数据交换平台的用户编号
eport.signature.report.ceb-message.server	N	海关服务器地址，缺省则采用Client中的密文作文默认Server URL
eport.signature.report.customs179.ebp-code	Y	海关 179 数据上报的电商平台代码
eport.signature.report.customs179.server	N	数据上报服务器URL地址，链接格式: https://域名联系海关/ceb2grab/grab/realTimeDataUpload，没有配置的话采用项目内置的URL密文地址

5 项目启动脚本

5.1 Windows环境

正确配置方式

5.2 Linux/MacOS环境

运行方式：终端执行sh start.sh启动程序

#!/bin/bash

# Environment args
APP="chinaport-data-signature-webapp"
UKEY_HOST="127.0.0.1"
UKEY_PASSWORD="88888888"
JVM_ARGS="-Xms1g -Xmx1g"

java -Dfile.encoding=utf-8 ${JVM_ARGS} -jar ${APP}.jar \
  --server.port=8080 \
  --spring.profiles.active=prod \
  --eport.signature.ukey.ws-url=ws://${UKEY_HOST}:61232 \
  --eport.signature.ukey.password=${UKEY_PASSWORD} \
  --spring.mail.enable=false \
  --spring.mail.to=abc@qq.com \
  --spring.mail.cc=abc@outlook.com,cbd@qq.com \
  --spring.mail.host=smtp.189.cn \
  --spring.mail.port=465 \
  --spring.mail.username=xxx@189.cn \
  --spring.mail.password=your_password \
  --spring.mail.protocol=smtp \
  --spring.mail.properties.mail.smtp.ssl.enable=true \
  --spring.mail.properties.mail.debug=false

6 软件架构

类目	版本	备注
JDK 17	17.0.7 LTS	软件运行的最低JDK版本
spring-boot	3.1.1
spring-cloud	2022.0.0-M1
smart-doc	2.7.3	一个自动化的API文档输出工具，效率word、rap2、swagger高
sonar	3.9.0.2155	一款开源的代码质量分析工具，能编码是规避很多潜在bug
spring-boot-starter-validation	3.1.1	spring新一代的参数校验器，替代javax JSR303的工具
spring-boot-starter-websocket	3.1.1	spring官方维护的websocket starter

单体架构，可直接开箱即用，支持集群部署，也可与分布式微服务集成，可拔插注入配置中心，通过远程RPC调用接口加签。

7 开发文档

本项目已支持直接使用JSON数据加签上报，告别XML数据、179特殊数据组装那样三拜九叩的繁琐！

启动项目，浏览器访问: http://127.0.0.1:8080 ,会打开接口文档的H5页面，可直接在页面给ukey发送请求进行调试，注意请求参数的字符串转义问题。

部分响应数据示例

XML加签响应示例

{
  "message": "操作成功",
  "success": true,
  "timestamp": "2023-07-15 12:15:47",
  "code": 200,
  "data": {
    "success": true,
    "certNo": "03000000000cde6f",
    "x509Certificate": "MIIEoDCCBESgAwIBAgIIAwAAAAAM3m8wDAYIKoEcz1UBg3UFADCBmDELMAkGA1UEBhMCQ04xDzANBgNVBAgMBuWMl+S6rDEPMA0GA1UEBwwG5YyX5LqsMRswGQYDVQQKDBLkuK3lm73nlLXlrZDlj6PlsrgxGzAZBgNVBAsMEuivgeS5pueuoeeQhuS4reW/gzEtMCsGA1UEAwwk5Lit5Zu955S15a2Q5Lia5Yqh6K+B5Lmm566h55CG5Lit5b+DMB4XDTIzMDMyOTAwMDAwMFoXDTMzMDMyOTAwMDAwMFowVjELMAkGA1UEBhMCQ04xMzAxBgNVBAsMKua1t+WNl+ecgeiNo+iqiei/m+WHuuWPo+i0uOaYk+aciemZkOWFrOWPuDESMBAGA1UEAwwJ5p2o5aaC6YeRMFkwEwYHKoZIzj0CAQYIKoEcz1UBgi0DQgAE0vOQmplAr9igPZrA8F1msqnFd0U++6G6NhG5rNuIUWft0BwQn7eSJkt5/fvSSoe7pUg2/awHUWPnzkeeQc7oVqOCArUwggKxMBEGCWCGSAGG+EIBAQQEAwIFoDAOBgNVHQ8BAf8EBAMCBsAwCQYDVR0TBAIwADApBgNVHSUEIjAgBggrBgEFBQcDAgYIKwYBBQUHAwQGCisGAQQBgjcUAgIwHwYDVR0jBBgwFoAURCQxt0wEvoAVXmuo4N1bjKXTh0UwHQYDVR0OBBYEFAytGob5L0WqhOCZ5l6Lf2jUdNrAMGgGA1UdIARhMF8wXQYEVR0gADBVMFMGCCsGAQUFBwIBFkdodHRwczovL3d3dy5jaGluYXBvcnQuZ292LmNuL3RjbXNmaWxlL3UvY21zL3d3dy8yMDIyMDQvMTIxMzI5NDh4dDZwLnBkZjB/BgNVHR8EeDB2MHSgcqBwhm5sZGFwOi8vbGRhcC5jaGluYXBvcnQuZ292LmNuOjM4OS9jbj1jcmwwMzAwMDAsb3U9Y3JsMDAsb3U9Y3JsLGM9Y24/Y2VydGlmaWNhdGVSZXZvY2F0aW9uTGlzdD9iYXNlP2NuPWNybDAzMDAwMDA+BggrBgEFBQcBAQQyMDAwLgYIKwYBBQUHMAGGImh0dHA6Ly9vY3NwLmNoaW5hcG9ydC5nb3YuY246ODgwMC8wOgYKKwYBBAGpQ2QFAQQsDCrmtbfljZfnnIHojaPoqonov5vlh7rlj6PotLjmmJPmnInpmZDlhazlj7gwEgYKKwYBBAGpQ2QFAwQEDAIwMTAiBgorBgEEAalDZAUIBBQMEjUxMjMyNDE5NjQxMDE3Mjk3WDAgBgorBgEEAalDZAUJBBIMEDAzLUpKMEc5MDAyMjA3NTIwGQYKKwYBBAGpQ2QFCwQLDAlNQTVUTkZHWTkwEgYKKwYBBAGpQ2QFDAQEDAIwMDASBgorBgEEAalDZAIBBAQMAjEyMBIGCisGAQQBqUNkAgQEBAwCMTQwDAYIKoEcz1UBg3UFAANIADBFAiBM4OVAc8aaCZU4XFfcVMkC7bWIIenRnPLxrnwVeYO3CQIhANQ767YIurkJCoLtwyqQPbUZe/+3BjGZcIWqB1mAl9T+",
    "digestValue": "b2FtM/jHvW4fnJpMMPWk/177RwA=",
    "signatureValue": "Pa2Ge3A1iH9e+85jIraVccvf2MB4ykjgC1MjObNd/MbPOSZRWTaizlnfReH3ErRMH5Wc3m60ZM6h56v7t7lIWg==",
    "signatureNode": "<ds:SignedInfo xmlns:ceb=\"http://www.chinaport.gov.cn/ceb\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><ds:CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"></ds:CanonicalizationMethod><ds:SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sm2-sm3\"></ds:SignatureMethod><ds:Reference URI=\"\"><ds:Transforms><ds:Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"></ds:Transform></ds:Transforms><ds:DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"></ds:DigestMethod><ds:DigestValue>b2FtM/jHvW4fnJpMMPWk/177RwA=</ds:DigestValue></ds:Reference></ds:SignedInfo>"
  }
}

海关179加签返回示例

提示：179加签只需要两个字即可

{
  "message": "操作成功",
  "success": true,
  "timestamp": "2023-07-15 12:16:36",
  "code": 200,
  "data": {
    "success": true,
    "certNo": "03000000000cde6f",
    "signatureValue": "pVWbjCXqCy2zk0RRqbw16hWZozjTSP444fdT2k5MjqigJDsLZ/Vfgout3o/Gg0WrPbJnH/2wlI8I0n3niqYiqw=="
  }
}

感谢您使用本开源项目！为了持续改进并为更多企业提供免费的加签解决方案，我们诚恳地邀请您考虑赞助支持我们的项目。您的慷慨赞助将直接帮助我们维护和改进该项目，使其能够为更多企业节省成本、提高效率。

支持赞助

为什么赞助

降低企业成本：我们的项目为企业提供了一站式解决方案，摆脱了每年支付高额费用购买加签设备的负担。您的赞助可以帮助更多企业降低经营成本，提高竞争力。
促进技术共享：通过开源，我们希望能够促进技术共享和合作。您的赞助将鼓励我们继续开发和分享更多优质的解决方案，使得整个行业都能从中受益。
支持项目发展：我们致力于不断改进和完善该项目，包括修复漏洞、添加新功能和提供更好的文档支持。您的赞助将直接用于项目的开发、测试和维护，确保项目的持续稳定和可靠性。

如何赞助

我们非常感激您对我们项目的赞助支持！您可以通过以下方式进行赞助：

您可以根据自身能力自由选择捐赠金额，无论您选择捐赠的金额大小，我们都非常感激，您的每一份赞助都对本项目发展都起到了重要的作用。

捐赠：您可以通过以下链接进行捐赠:
- PayPal
- AliPay
  
  WeChatPay
技术贡献：如果您是开发者，您也可以通过提交代码、报告问题或者提供改进建议等方式来支持我们的项目。
宣传推广：如果您无法提供直接的赞助，您还可以通过在社交媒体上宣传、分享我们的项目，帮助我们扩大影响力。

感谢您的支持

我们衷心感谢您对我们项目的关注和支持！您的赞助将鼓励我们继续改进和提供更好的解决方案，造福更多的企业和开发者。如果您有任何问题或者疑问，请随时联系我们, 联系邮箱: 1432689025@qq.com

接入企业登记

感谢您对我们项目的赞助支持！为了更好地记录和感谢每一家接入企业，我们在此邀请您在捐赠时留下您的公司名，以便我们将您的公司列入接入企业名单中。您可以在捐赠备注中提供您的公司名，或者在捐赠后通过邮件等方式将公司名发送给我们。

您的公司名将在我们的 README 中特别标注，并列入接入企业名单，以展示对您的感激之情。同时，我们也欢迎您提供您公司的官方网站链接，以便其他用户了解更多关于您公司的信息。

感谢您的配合和支持，我们将竭诚为您提供更好的服务！

接入企业

排名不分先后，从2023-07-11开始登记

感谢以下公司对我们项目的赞助和支持：

海南省荣誉进出口贸易有限公司：官方网站
广州市汇客物流有限公司
海南嗨亿购科技有限公司
...

如果您的公司已赞助我们的项目，但在列表中没有找到，请及时与我们联系，我们将尽快添加您的公司名。

Weasley-J / chinaport-data-signature