* Host documents on github page

* Update .gitignore
WeBankBlockchain · Feb 18, 2020 · 77a858f · 77a858f
1 parent bcf493c
commit 77a858f
Show file tree

Hide file tree

Showing 220 changed files with 86,740 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -194,7 +194,6 @@ doc/bak/
 
 # for the files generated by the readthedocs build tool
 *pdf
-_build
 _templates
 /docs/zh_CN/docs/.idea/
 .vscode/
diff --git a/docs/zh_CN/_build/doctrees/README.doctree b/docs/zh_CN/_build/doctrees/README.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/capacity-estimation.doctree b/docs/zh_CN/_build/doctrees/docs/capacity-estimation.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/cpt-templates.doctree b/docs/zh_CN/_build/doctrees/docs/cpt-templates.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/exclude-toctree-warning.doctree b/docs/zh_CN/_build/doctrees/docs/exclude-toctree-warning.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/faq-java.doctree b/docs/zh_CN/_build/doctrees/docs/faq-java.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/faq.doctree b/docs/zh_CN/_build/doctrees/docs/faq.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/from-application-context-to-properties.doctree b/docs/zh_CN/_build/doctrees/docs/from-application-context-to-properties.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/how-to-deploy-w-groupid.doctree b/docs/zh_CN/_build/doctrees/docs/how-to-deploy-w-groupid.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/how-to-run-unit-test.doctree b/docs/zh_CN/_build/doctrees/docs/how-to-run-unit-test.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/how-to-run-without-internet.doctree b/docs/zh_CN/_build/doctrees/docs/how-to-run-without-internet.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/miscellaneous.doctree b/docs/zh_CN/_build/doctrees/docs/miscellaneous.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/one-stop-experience.doctree b/docs/zh_CN/_build/doctrees/docs/one-stop-experience.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/produce-pdf-template-by-acrobat.doctree b/docs/zh_CN/_build/doctrees/docs/produce-pdf-template-by-acrobat.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/security-suggestion.doctree b/docs/zh_CN/_build/doctrees/docs/security-suggestion.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/styleguides/styleguides.doctree b/docs/zh_CN/_build/doctrees/docs/styleguides/styleguides.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/styleguides/versioning-management.doctree b/docs/zh_CN/_build/doctrees/docs/styleguides/versioning-management.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/terminologies.doctree b/docs/zh_CN/_build/doctrees/docs/terminologies.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/use-cases.doctree b/docs/zh_CN/_build/doctrees/docs/use-cases.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weId-compatibility-test.doctree b/docs/zh_CN/_build/doctrees/docs/weId-compatibility-test.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weid-timeline.doctree b/docs/zh_CN/_build/doctrees/docs/weid-timeline.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-build-with-deploy.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-build-with-deploy.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-build-without-deploy.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-build-without-deploy.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-contract-design.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-contract-design.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-endpoint-deploy.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-endpoint-deploy.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-endpoint.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-endpoint.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-installation-by-sourcecode.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-installation-by-sourcecode.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-installation.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-installation.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-ports.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-ports.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-quick-tools.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-quick-tools.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-rest-api.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-rest-api.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-rest-deploy.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-rest-deploy.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-rest-design.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-rest-design.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-rest.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-rest.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-sample-commandline.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-sample-commandline.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-sample-springboot.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-sample-springboot.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-sample.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-sample.doctree
diff --git a/docs/zh_CN/_build/doctrees/docs/weidentity-spec.doctree b/docs/zh_CN/_build/doctrees/docs/weidentity-spec.doctree
diff --git a/docs/zh_CN/_build/doctrees/environment.pickle b/docs/zh_CN/_build/doctrees/environment.pickle
diff --git a/docs/zh_CN/_build/doctrees/index.doctree b/docs/zh_CN/_build/doctrees/index.doctree
diff --git a/docs/zh_CN/_build/html/.buildinfo b/docs/zh_CN/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2b53afe4f2bf69130864cffb3e1eb38c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/zh_CN/_build/html/README.html b/docs/zh_CN/_build/html/README.html
@@ -0,0 +1,334 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="zh-CN" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="zh-CN" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>什么是 WeIdentity？ &mdash; WeIdentity  文档</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
+  <link rel="stylesheet" href="_static/index.css" type="text/css" />
+    <link rel="index" title="索引" href="genindex.html" />
+    <link rel="search" title="搜索" href="search.html" />
+    <link rel="next" title="WeIdentity 一站式体验" href="docs/one-stop-experience.html" />
+    <link rel="prev" title="WeIdentity文档" href="index.html" /> 
+
+
+  <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search">
+
+
+
+            <a href="index.html" class="icon icon-home"> WeIdentity
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="current reference internal" href="#">什么是 WeIdentity？</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#id1">模块介绍</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#weidentity-did">分布式身份标识 (WeIdentity DID)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#weidentity-credential">可验证数字凭证 (WeIdentity Credential)</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#id2">当前状态</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id3">感受WeIdentity</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id5">联系我们</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id6">如何贡献</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="docs/one-stop-experience.html">WeIdentity 一站式体验</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/terminologies.html">术语</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/use-cases.html">使用场景</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-spec.html">WeIdentity 规范</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-installation.html">WeIdentity Java SDK 安装部署</a></li>
+<li class="toctree-l1"><a class="reference external" href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/">WeIdentity Java SDK 文档</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-sample.html">WeIdentity Sample 开发样例</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/miscellaneous.html">杂项</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/faq.html">FAQ</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-rest.html">WeIdentity RestService</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-endpoint.html">WeIdentity Endpoint Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/weidentity-contract-design.html">WeIdentity 智能合约设计与实现</a></li>
+</ul>
+
+
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">WeIdentity</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html">Docs</a> &raquo;</li>
+
+      <li>什么是 WeIdentity？</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/README.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <img alt="weidentity-logo.png" src="_images/weidentity-logo.png" />
+<hr class="docutils" />
+<div class="section" id="weidentity">
+<h1>什么是 WeIdentity？<a class="headerlink" href="#weidentity" title="永久链接至标题">¶</a></h1>
+<p>WeIdentity是一套分布式多中心的技术解决方案，可承载实体对象（人或者物）的现实身份与链上身份的可信映射、以及实现实体对象之间安全的访问授权与数据交换。WeIdentity由微众银行自主研发并完全开源，秉承公众联盟链整合资源、交换价值、服务公众的理念，致力于成为链接多个垂直行业领域的分布式商业基础设施，促进泛行业、跨机构、跨地域间的身份认证和数据合作。</p>
+<div class="section" id="id1">
+<h2>模块介绍<a class="headerlink" href="#id1" title="永久链接至标题">¶</a></h2>
+<p>WeIdentity目前主要包含两大模块：WeIdentity DID以及WeIdentity Credential。</p>
+<div class="section" id="weidentity-did">
+<h3>分布式身份标识 (WeIdentity DID)<a class="headerlink" href="#weidentity-did" title="永久链接至标题">¶</a></h3>
+<p>传统方式中，用户的注册和身份管理完全依赖于单一中心的注册机构；随着分布式账本技术（例如区块链）的出现，分布式多中心的身份注册、标识和管理成为可能。
+WeIdentity DID模块在<a class="reference external" href="https://fisco-bcos-documentation.readthedocs.io/zh_CN/latest/">FISCO-BCOS区块链底层平台</a>上实现了一套符合<a class="reference external" href="https://w3c-ccg.github.io/did-spec/">W3C DID规范</a>的分布式多中心的身份标识协议，使实体（人或物）的现实身份实现了链上的身份标识；同时，WeIdentity DID给与Entity（人或者物）直接拥有和控制自己身份ID的能力。</p>
+<p>WeIdentity DID秉承以下设计理念：</p>
+<embed>
+  <table border='1' style="border-collapse:collapse" class='tables'>
+     <tr>
+        <th width="100">目标</th>
+        <th>说明</th>
+     </tr>
+     <tr>
+        <td>多中心</td>
+        <td>分布式多中心的ID注册机制，摆脱对传统模式下单一中心ID注册的依赖</td>
+     </tr>
+     <tr>
+        <td>开源开放</td>
+        <td>技术方案完全开源，面向政府、企业、开发者服务</td>
+     </tr>
+     <tr>
+        <td>隐私保护</td>
+        <td>实体的现实身份和可验证数字凭证的内容进行链下存储。支持实体将信息最小化或者选择性披露给其他机构，同时防止任何第三方反向推测出实体在现实世界或其他场景语义中的身份</td>
+     </tr>
+     <tr>
+        <td>可移植性</td>
+        <td>基于WeIdentity规范，数据可移植至遵循同样规范的其他平台，兼容业务主流区块链底层平台</td>
+     </tr>
+     <tr>
+        <td>互操作性</td>
+        <td>提供标准化接口，支持跨链、跨平台互操作</td>
+     </tr>
+     <tr>
+        <td>可扩展性</td>
+        <td>保证操作性，可移植性或简单性的情况下，数据模型可以通过多种不同方式进行扩展</td>
+     </tr>
+  </table>
+  <br />
+</embed></div>
+<div class="section" id="weidentity-credential">
+<h3>可验证数字凭证 (WeIdentity Credential)<a class="headerlink" href="#weidentity-credential" title="永久链接至标题">¶</a></h3>
+<p>现实世界中存在着各种各样用于描述实体身份、实体间关系的数据，如身份证、行驶证、存款证明、处方、毕业证、房产证、信用报告等。WeIdentity Credential提供了一整套基于<a class="reference external" href="https://w3c.github.io/vc-data-model/">W3C VC规范</a>的解决方案，旨在对这一类数据进行标准化、电子化，生成可验证、可交换的「凭证」（Credential），支持对凭证的属性进行选择性披露，及生成链上存证（Evidence）。</p>
+<p>WeIdentity支持认证机构自行注册标准化凭证模板，共同丰富公众联盟链的生态。</p>
+</div>
+</div>
+<div class="section" id="id2">
+<h2>当前状态<a class="headerlink" href="#id2" title="永久链接至标题">¶</a></h2>
+<p>WeIdentity目前支持基于FISCO-BCOS的区块链，并提供Java SDK及RestService方式供部署。具体的规范文档、安装部署和使用指引如下表所示：</p>
+<embed>
+  <table border='1' style="border-collapse:collapse" class='tables'>
+     <tr>
+        <th width="20%">集成方法</th>
+        <th width="30%">文档入口</th>
+        <th width="50%">当前状态</th>
+     </tr>
+     <tr>
+        <td style="text-align:center"><a href="https://github.com/WeBankFinTech/WeIdentity">Java SDK</a></td>
+        <td>
+           <ul>
+             <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-installation.html">安装部署文档</a></li>
+             <li><a href="https://weidentity.readthedocs.io/projects/javasdk/zh_CN/latest/docs/weidentity-java-sdk-doc.html">SDK使用文档</a></li>
+             <li><a href="https://weidentity.readthedocs.io/zh_CN/latest/docs/weidentity-rest.html">RestService集成文档</a></li>
+           </ul>
+        </td>
+        <td>
+           <a href="https://travis-ci.org/WeBankFinTech/WeIdentity"><img src="https://travis-ci.org/WeBankFinTech/WeIdentity.svg?branch=master" /></a>
+           <a href="https://github.com/WeBankFinTech/WeIdentity/releases/latest"><img src="https://img.shields.io/github/release/WeBankFinTech/WeIdentity.svg" /></a>
+           <a href="https://search.maven.org/search?q=g:%22com.webank%22%20AND%20a:%22weid-java-sdk%22"><img src="https://img.shields.io/maven-central/v/com.webank/weid-java-sdk.svg?label=Maven%20Central" /></a>
+           <a href="https://www.codacy.com/manual/chaoxinhu/WeIdentity?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=WeBankFinTech/WeIdentity&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/37d3bc478ede4839ba16ccac469ad3f2" /></a>
+           <a href="https://www.codefactor.io/repository/github/webankfintech/weidentity"><img src="https://www.codefactor.io/repository/github/webankfintech/weidentity/badge" /></a>
+           <a href="https://codecov.io/gh/WeBankFinTech/WeIdentity"><img src="https://codecov.io/gh/WeBankFinTech/WeIdentity/branch/master/graph/badge.svg" /></a>
+           <a href="https://www.gnu.org/licenses/lgpl-3.0"><img src="https://img.shields.io/badge/license-GNU%20LGPL%20v3.0-blue.svg" /></a>
+           <a href="https://github.com/WeBankFinTech/WeIdentity"><img src="https://sloc.xyz/github/WeBankFinTech/WeIdentity" /></a>
+        </td>
+     </tr>
+  </table>
+  <br/>
+</embed></div>
+<div class="section" id="id3">
+<h2>感受WeIdentity<a class="headerlink" href="#id3" title="永久链接至标题">¶</a></h2>
+<p>接下来，您可以在<a class="reference external" href="https://weidentity.readthedocs.io/zh_CN/latest/docs/one-stop-experience.html">此页</a>，一站式了解WeIdentity的参考场景，体验Demo流程，并了解完整的部署方式及参考实现。</p>
+</div>
+<div class="section" id="id5">
+<h2>联系我们<a class="headerlink" href="#id5" title="永久链接至标题">¶</a></h2>
+<p>邮箱：<a class="reference external" href="mailto:weidentity&#37;&#52;&#48;webank&#46;com">weidentity<span>&#64;</span>webank<span>&#46;</span>com</a></p>
+</div>
+<div class="section" id="id6">
+<h2>如何贡献<a class="headerlink" href="#id6" title="永久链接至标题">¶</a></h2>
+<ul class="simple">
+<li><p>详见：<a class="reference external" href="https://github.com/WeBankFinTech/WeIdentity/blob/master/.github/CONTRIBUTING.md">如何贡献</a></p></li>
+</ul>
+</div>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+        <a href="docs/one-stop-experience.html" class="btn btn-neutral float-right" title="WeIdentity 一站式体验" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+        <a href="index.html" class="btn btn-neutral" title="WeIdentity文档" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright (2018) WeBank Co., Ltd.
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+
+
+
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/language_data.js"></script>
+        <script src="_static/translations.js"></script>
+
+
+
+
+  <script type="text/javascript" src="_static/js/theme.js"></script>
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/zh_CN/_build/html/_images/after-revocation.png b/docs/zh_CN/_build/html/_images/after-revocation.png