did-webs-resolver 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (119) hide show
  1. did_webs_resolver-0.3.2/.coveragerc +8 -0
  2. did_webs_resolver-0.3.2/.github/workflows/ci.yml +40 -0
  3. did_webs_resolver-0.3.2/.gitignore +146 -0
  4. did_webs_resolver-0.3.2/CHANGELOG.md +54 -0
  5. did_webs_resolver-0.3.2/LICENSE +201 -0
  6. did_webs_resolver-0.3.2/Makefile +107 -0
  7. did_webs_resolver-0.3.2/PKG-INFO +110 -0
  8. did_webs_resolver-0.3.2/README.md +91 -0
  9. did_webs_resolver-0.3.2/codecov.yaml +20 -0
  10. did_webs_resolver-0.3.2/docker/artifacts/EEMVke69ZjQAXoK3FTLtCwpyWOXx5qkhzIDqXAgYfPgh/did.json +1 -0
  11. did_webs_resolver-0.3.2/docker/config/controller/incept-with-wan-wit.json +11 -0
  12. did_webs_resolver-0.3.2/docker/config/controller/keri/cf/dws-resolver.json +13 -0
  13. did_webs_resolver-0.3.2/docker/config/controller/keri/cf/dws.json +0 -0
  14. did_webs_resolver-0.3.2/docker/config/controller/keri/cf/get-started.json +13 -0
  15. did_webs_resolver-0.3.2/docker/config/controller/keri/cf/my-keystore.json +13 -0
  16. did_webs_resolver-0.3.2/docker/config/controller/keri/cf/static-host-keystore.json +13 -0
  17. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wan.json +9 -0
  18. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wes.json +9 -0
  19. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wil.json +9 -0
  20. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wit.json +9 -0
  21. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wub.json +9 -0
  22. did_webs_resolver-0.3.2/docker/config/witnesses/keri/cf/main/wyz.json +9 -0
  23. did_webs_resolver-0.3.2/docker/controller-init.sh +192 -0
  24. did_webs_resolver-0.3.2/docker/resolver-init.sh +30 -0
  25. did_webs_resolver-0.3.2/docker/scripts/color-printing.sh +32 -0
  26. did_webs_resolver-0.3.2/docker/scripts/example-acdc-and-data/desig-aliases-attr-public.json +1 -0
  27. did_webs_resolver-0.3.2/docker/scripts/example-acdc-and-data/desig-aliases-public.json +30 -0
  28. did_webs_resolver-0.3.2/docker/scripts/get_started.sh +121 -0
  29. did_webs_resolver-0.3.2/docker/scripts/schema/rules/desig-aliases-public-schema-rules.json +15 -0
  30. did_webs_resolver-0.3.2/docker/test-resolutions.sh +128 -0
  31. did_webs_resolver-0.3.2/docker-compose.yml +219 -0
  32. did_webs_resolver-0.3.2/docs/commands.md +307 -0
  33. did_webs_resolver-0.3.2/docs/did-webs.md +110 -0
  34. did_webs_resolver-0.3.2/docs/getting_started.md +756 -0
  35. did_webs_resolver-0.3.2/docs/troubleshooting.md +278 -0
  36. did_webs_resolver-0.3.2/images/dws-base.dockerfile +32 -0
  37. did_webs_resolver-0.3.2/images/dws-dynamic-service.dockerfile +15 -0
  38. did_webs_resolver-0.3.2/images/dws-resolver-service.dockerfile +36 -0
  39. did_webs_resolver-0.3.2/images/dws-static-service.dockerfile +22 -0
  40. did_webs_resolver-0.3.2/images/dws.json +6 -0
  41. did_webs_resolver-0.3.2/local/.gitignore +1 -0
  42. did_webs_resolver-0.3.2/local/color-printing.sh +32 -0
  43. did_webs_resolver-0.3.2/local/config/controller/incept-with-wan-wit.json +11 -0
  44. did_webs_resolver-0.3.2/local/config/controller/keri/cf/dws-controller.json +10 -0
  45. did_webs_resolver-0.3.2/local/config/controller/keri/cf/dws-other.json +4 -0
  46. did_webs_resolver-0.3.2/local/config/controller/keri/cf/dws-resolver.json +10 -0
  47. did_webs_resolver-0.3.2/local/config/controller/keri/cf/static-service.json +10 -0
  48. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wan.json +9 -0
  49. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wes.json +9 -0
  50. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wil.json +9 -0
  51. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wit.json +9 -0
  52. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wub.json +9 -0
  53. did_webs_resolver-0.3.2/local/config/witnesses/keri/cf/main/wyz.json +9 -0
  54. did_webs_resolver-0.3.2/local/designated_aliases.json +1 -0
  55. did_webs_resolver-0.3.2/local/did_webs_workflow.sh +338 -0
  56. did_webs_resolver-0.3.2/local/schema/designated-aliases-public-schema.json +156 -0
  57. did_webs_resolver-0.3.2/local/schema/rules/desig-aliases-public-schema-rules.json +15 -0
  58. did_webs_resolver-0.3.2/local/web/.gitignore +2 -0
  59. did_webs_resolver-0.3.2/local/web/dws/EBFn5ge82EQwxp9eeje-UMEXF-v-3dlfbdVMX_PNjSft/did.json +1 -0
  60. did_webs_resolver-0.3.2/pyproject.toml +47 -0
  61. did_webs_resolver-0.3.2/pytest.ini +5 -0
  62. did_webs_resolver-0.3.2/roadmap.md +19 -0
  63. did_webs_resolver-0.3.2/ruff.toml +32 -0
  64. did_webs_resolver-0.3.2/src/__init__.py +0 -0
  65. did_webs_resolver-0.3.2/src/dws/__init__.py +42 -0
  66. did_webs_resolver-0.3.2/src/dws/app/__init__.py +0 -0
  67. did_webs_resolver-0.3.2/src/dws/app/cli/__init__.py +0 -0
  68. did_webs_resolver-0.3.2/src/dws/app/cli/commands/__init__.py +0 -0
  69. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/__init__.py +0 -0
  70. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/keri/__init__.py +0 -0
  71. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/keri/resolve.py +69 -0
  72. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/keri/resolver-service.py +64 -0
  73. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/webs/__init__.py +0 -0
  74. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/webs/generate.py +78 -0
  75. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/webs/resolve.py +100 -0
  76. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/webs/resolver-service.py +125 -0
  77. did_webs_resolver-0.3.2/src/dws/app/cli/commands/did/webs/service.py +119 -0
  78. did_webs_resolver-0.3.2/src/dws/app/cli/commands/version.py +36 -0
  79. did_webs_resolver-0.3.2/src/dws/app/cli/dws.py +39 -0
  80. did_webs_resolver-0.3.2/src/dws/app/logs.py +22 -0
  81. did_webs_resolver-0.3.2/src/dws/core/__init__.py +1 -0
  82. did_webs_resolver-0.3.2/src/dws/core/artifacting.py +242 -0
  83. did_webs_resolver-0.3.2/src/dws/core/didding.py +563 -0
  84. did_webs_resolver-0.3.2/src/dws/core/didkeri.py +123 -0
  85. did_webs_resolver-0.3.2/src/dws/core/ends/__init__.py +3 -0
  86. did_webs_resolver-0.3.2/src/dws/core/ends/did_webs_resource_end.py +60 -0
  87. did_webs_resolver-0.3.2/src/dws/core/ends/keri_cesr_resource_end.py +64 -0
  88. did_webs_resolver-0.3.2/src/dws/core/ends/monitoring.py +10 -0
  89. did_webs_resolver-0.3.2/src/dws/core/generating.py +94 -0
  90. did_webs_resolver-0.3.2/src/dws/core/habs.py +76 -0
  91. did_webs_resolver-0.3.2/src/dws/core/requesting.py +222 -0
  92. did_webs_resolver-0.3.2/src/dws/core/resolving.py +610 -0
  93. did_webs_resolver-0.3.2/src/dws/core/webbing.py +29 -0
  94. did_webs_resolver-0.3.2/src/dws/didcomm/__init__.py +0 -0
  95. did_webs_resolver-0.3.2/src/dws/didcomm/hello-world.py +92 -0
  96. did_webs_resolver-0.3.2/src/dws/didcomm/utils.py +142 -0
  97. did_webs_resolver-0.3.2/tests/__init__.py +0 -0
  98. did_webs_resolver-0.3.2/tests/artifact_output_dir/.gitkeep +0 -0
  99. did_webs_resolver-0.3.2/tests/conftest.py +269 -0
  100. did_webs_resolver-0.3.2/tests/dws/__init__.py +0 -0
  101. did_webs_resolver-0.3.2/tests/dws/app/__init__.py +0 -0
  102. did_webs_resolver-0.3.2/tests/dws/app/test_logs.py +48 -0
  103. did_webs_resolver-0.3.2/tests/dws/core/__init__.py +0 -0
  104. did_webs_resolver-0.3.2/tests/dws/core/ends/__init__.py +0 -0
  105. did_webs_resolver-0.3.2/tests/dws/core/ends/test_did_webs_resource_end.py +98 -0
  106. did_webs_resolver-0.3.2/tests/dws/core/ends/test_keri_cesr_resource_end.py +193 -0
  107. did_webs_resolver-0.3.2/tests/dws/core/test_artifacting.py +70 -0
  108. did_webs_resolver-0.3.2/tests/dws/core/test_clienting.py +56 -0
  109. did_webs_resolver-0.3.2/tests/dws/core/test_didding.py +1117 -0
  110. did_webs_resolver-0.3.2/tests/dws/core/test_generating.py +201 -0
  111. did_webs_resolver-0.3.2/tests/dws/core/test_habs.py +33 -0
  112. did_webs_resolver-0.3.2/tests/dws/core/test_requesting.py +66 -0
  113. did_webs_resolver-0.3.2/tests/dws/core/test_resolving.py +1148 -0
  114. did_webs_resolver-0.3.2/tests/dws/core/test_vrd_verify.py +88 -0
  115. did_webs_resolver-0.3.2/tests/dws/core/test_webbing.py +25 -0
  116. did_webs_resolver-0.3.2/tests/schema/designated-aliases-public-schema.json +156 -0
  117. did_webs_resolver-0.3.2/tests/schema/rules/desig-aliases-public-schema-rules.json +15 -0
  118. did_webs_resolver-0.3.2/tests/test_dkr.py +10 -0
  119. did_webs_resolver-0.3.2/uv.lock +637 -0
@@ -0,0 +1,8 @@
1
+ [run]
2
+ omit =
3
+ # omit anything in src/dws/didcomm
4
+ src/dws/didcomm/**/*
5
+ # omit cli code
6
+ src/dws/app/cli/**/*
7
+ # omit tests
8
+ tests/**/*
@@ -0,0 +1,40 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - 'main'
7
+ pull_request:
8
+
9
+ jobs:
10
+ tests-and-coverage:
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v2
14
+
15
+ - name: Clear databases
16
+ run: |
17
+ rm -Rf /usr/local/var/keri/*
18
+
19
+ - name: Install uv
20
+ uses: astral-sh/setup-uv@v5
21
+
22
+ - name: Set up Python
23
+ run: uv python install
24
+
25
+ - name: Install dependencies
26
+ run: |
27
+ uv sync --dev
28
+
29
+ - name: Pretty
30
+ run: |
31
+ make check
32
+
33
+ - name: Tests
34
+ run: |
35
+ uv run pytest --cov --cov-branch --cov-report=xml
36
+
37
+ - name: Upload coverage reports to Codecov
38
+ uses: codecov/codecov-action@v5
39
+ with:
40
+ token: ${{ secrets.CODECOV_TOKEN }}
@@ -0,0 +1,146 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ pip-wheel-metadata/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ target/
76
+
77
+ # Jupyter Notebook
78
+ .ipynb_checkpoints
79
+
80
+ # IPython
81
+ profile_default/
82
+ ipython_config.py
83
+
84
+ # pyenv
85
+ .python-version
86
+
87
+ # pipenv
88
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
90
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
91
+ # install all needed dependencies.
92
+ #Pipfile.lock
93
+
94
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95
+ __pypackages__/
96
+
97
+ # Celery stuff
98
+ celerybeat-schedule
99
+ celerybeat.pid
100
+
101
+ # SageMath parsed files
102
+ *.sage.py
103
+
104
+ # Environments
105
+ .env
106
+ .venv
107
+ env/
108
+ venv/
109
+ ENV/
110
+ env.bak/
111
+ venv.bak/
112
+
113
+ # Spyder project settings
114
+ .spyderproject
115
+ .spyproject
116
+
117
+ # Rope project settings
118
+ .ropeproject
119
+
120
+ # mkdocs documentation
121
+ site/
122
+
123
+ # mypy
124
+ .mypy_cache/
125
+ .dmypy.json
126
+ dmypy.json
127
+
128
+ # Pyre type checker
129
+ .pyre/
130
+
131
+ # IntelliJ Files:
132
+ .idea/
133
+
134
+ # Ignore runtime files
135
+ docker/artifacts/E*
136
+ docker/scripts/designated_aliases.json
137
+ # But allow the specific directory "EEMVke69ZjQAXoK3FTLtCwpyWOXx5qkhzIDqXAgYfPgh" for pytest
138
+ docker/artifacts/EEMVke69ZjQAXoK3FTLtCwpyWOXx5qkhzIDqXAgYfPgh/keri.cesr
139
+ !docker/artifacts/EEMVke69ZjQAXoK3FTLtCwpyWOXx5qkhzIDqXAgYfPgh/
140
+ .DS_Store
141
+ keri.cesr
142
+
143
+ tests/artifact_output_dir/**/*.json
144
+ tests/artifact_output_dir/**/*.cesr
145
+ tests/artifact_output_dir/dws/*
146
+ tests/artifact_output_dir/dws/**/*
@@ -0,0 +1,54 @@
1
+ # Changelog for did:webs resolver
2
+
3
+ ## Version History
4
+
5
+ ### Versions prior to 0.3.0 (hyperledger-labs/did-webs-resolver history)
6
+
7
+ ### 0.3.2 Delegation and alsoKnownAs features
8
+
9
+ - Added support for delegator blocks in `service` section.
10
+ - Added default `did:keri` and `did:web` alsoKnownAs entries in DID doc generation.
11
+
12
+ ### 0.3.1 repackage from dkr -> dws
13
+
14
+ - Changed root package name to `dws` from `dkr` to reflect semantic name of did:webs.
15
+
16
+ ### 0.3.0 First release under GLEIF-IT/did-webs-resolver
17
+
18
+ - Fixed broken constant imports, added missing constants.
19
+ - Upgraded to KERI 1.2x.
20
+ - Added `version` command.
21
+ - Fixed logging and used TruncatedFormatter.
22
+ - Refactored to use small functions all around for readability and testability.
23
+ - Added unit and integration tests.
24
+ - Added output dir for DID artifacts instead of just default output dir.
25
+ - Added sample script for local DID doc generation.
26
+ - Fixed static file hosting and resolution to default to HTTPS and fall back to HTTP.
27
+ - `--loglevel` arg added to CLI.
28
+ - Idiomatic Hio usage for DoDoers
29
+ - Corrected the `meta` field usage throughout the resolver.
30
+ - `--verbose` argument added to CLI for more detailed output.
31
+ - Fixed HTTP port conversion.
32
+ - Removed all shelling out and replaced it with using the appropriate Doers for did:webs resolution.
33
+ - Added code formatting.
34
+ - Cleaned up the getting started docs.
35
+ - Fixed the designated alias ACDC processing.
36
+ - Removed the `--regname` argument in favor of scanning all local ACDC registries for self-attested designated alias ACDCs.
37
+ - Added a complete end-to-end workflow script.
38
+ - Added a health check endpoint to the did:webs resolver server.
39
+ - Got rid of old, unused scripts and config.
40
+ - Add support for path segments to the core.ends endpoints.
41
+ - Add did_path for specifying where to host DID assets.
42
+ - Fix HIO's urllib.parse of path in environ PATH_INFO.
43
+ - Add integration style resolution tests and witness integration tests.
44
+ - Make did:keri resolution work with OOBI resolution.
45
+ - Get test coverage to 100%
46
+ - Fix the docker compose setup to work with local test did:webs resolutions.
47
+ - `X-Forwarded-Port` for supporting resolver deployments behind HTTP proxies.
48
+ - Fix Location Scheme record save bug.
49
+
50
+ #### 0.0.7 and before
51
+
52
+ Initial draft.
53
+ - Partial implementation of did:webs resolver.
54
+ - did:keri resolver imported from https://github.com/WebOfTrust/did-keri-resolver
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,107 @@
1
+ .PHONY: build-dws-base publish-dws-base tag-dws-base-latest \
2
+ build-dynamic-service publish-dynamic-service tag-dynamic-service-latest \
3
+ build-did-webs-resolver-service publish-did-webs-resolver-service tag-did-webs-resolver-latest \
4
+ run-agent build-all publish-latest warn tag fmt check tag-latest-all
5
+ VERSION=0.3.2 # also change in pyproject.toml and src/dws/__init__.py
6
+
7
+ RED="\033[0;31m"
8
+ NO_COLOUR="\033[0m"
9
+
10
+ define DOCKER_WARNING
11
+ In order to use the multi-platform build enable the containerd image store
12
+ The containerd image store is not enabled by default.
13
+ To enable the feature for Docker Desktop:
14
+ Navigate to Settings in Docker Desktop.
15
+ In the General tab, check Use containerd for pulling and storing images.
16
+ Select Apply and Restart."
17
+ endef
18
+ export DOCKER_WARNING
19
+
20
+ .warn:
21
+ @echo -e ${RED}"$$DOCKER_WARNING"${NO_COLOUR}
22
+
23
+ # Base Image for all other did:webs images
24
+ BASE_IMAGE=gleif/dws-base
25
+ build-dws-base: .warn
26
+ @docker build \
27
+ --platform=linux/amd64,linux/arm64 \
28
+ -f images/dws-base.dockerfile \
29
+ -t $(BASE_IMAGE):$(VERSION) .
30
+
31
+ publish-dws-base:
32
+ @docker push $(BASE_IMAGE):$(VERSION)
33
+
34
+ tag-dws-base-latest:
35
+ @$(MAKE) tag IMAGE_NAME=$(BASE_IMAGE) VERSION=$(VERSION)
36
+
37
+ tag-latest-all: tag-dws-base-latest tag-dynamic-service-latest tag-did-webs-resolver-latest
38
+
39
+ # Build did:webs service that dynamically generates did:webs assets
40
+ DYN_IMAGE=gleif/did-webs-service
41
+ build-dynamic-service: .warn
42
+ @docker build \
43
+ --platform=linux/amd64,linux/arm64 \
44
+ -f images/dws-dynamic-service.dockerfile \
45
+ -t $(DYN_IMAGE):$(VERSION) .
46
+
47
+ publish-dynamic-service:
48
+ @docker push $(DYN_IMAGE):$(VERSION)
49
+
50
+ tag-dynamic-service-latest:
51
+ @$(MAKE) tag IMAGE_NAME=$(DYN_IMAGE) VERSION=$(VERSION)
52
+
53
+ # build did:webs resolver service
54
+ RSLV_IMAGE=gleif/did-webs-resolver-service
55
+ build-did-webs-resolver-service: .warn
56
+ @docker build \
57
+ --platform=linux/amd64,linux/arm64 \
58
+ -f images/dws-resolver-service.dockerfile \
59
+ -t $(RSLV_IMAGE):$(VERSION) .
60
+
61
+ publish-did-webs-resolver-service:
62
+ @docker push $(RSLV_IMAGE):$(VERSION)
63
+
64
+ tag-did-webs-resolver-latest:
65
+ @$(MAKE) tag IMAGE_NAME=$(RSLV_IMAGE) VERSION=$(VERSION)
66
+
67
+ # Other targets
68
+ build-all:
69
+ # Base image
70
+ @$(MAKE) build-dws-base
71
+ @$(MAKE) tag-dws-base-latest
72
+ # Dynamic service
73
+ @$(MAKE) build-dynamic-service
74
+ @$(MAKE) tag-dynamic-service-latest
75
+ # Resolver service
76
+ @$(MAKE) build-did-webs-resolver-service
77
+ @$(MAKE) tag-did-webs-resolver-latest
78
+
79
+ publish-latest:
80
+ @docker push $(BASE_IMAGE):latest
81
+ @docker push $(DYN_IMAGE):latest
82
+ @docker push $(RSLV_IMAGE):latest
83
+
84
+ tag:
85
+ @IMAGE_ID=$$(docker images --format "{{.ID}}" $(IMAGE_NAME):$(VERSION) | head -n 1); \
86
+ if [ -z "$$IMAGE_ID" ]; then \
87
+ echo "Error: No local image found for '$(IMAGE_NAME)'"; \
88
+ exit 1; \
89
+ fi; \
90
+ docker tag $$IMAGE_ID $(IMAGE_NAME):latest; \
91
+ echo "Successfully tagged $(IMAGE_NAME) ($$IMAGE_ID) as $(IMAGE_NAME):latest"
92
+
93
+ # Formatting targets
94
+ fmt:
95
+ @uv tool run ruff check --select I --fix
96
+ @uv tool run ruff format
97
+
98
+ # used by ci
99
+ check:
100
+ uv tool run ruff check --select I
101
+ uv tool run ruff format --check
102
+
103
+ build-pkg:
104
+ uv build
105
+
106
+ publish-pkg:
107
+ uv publish
@@ -0,0 +1,110 @@
1
+ Metadata-Version: 2.4
2
+ Name: did-webs-resolver
3
+ Version: 0.3.2
4
+ Summary: did:webs DID Method Resolver
5
+ Project-URL: Documentation, https://github.com/GLEIF-IT/did-webs-resolver/docs
6
+ Project-URL: Changelog, https://github.com/GLEIF-IT/did-webs-resolver/CHANGELOG.md
7
+ Project-URL: Issue Tracker, https://github.com/GLEIF-IT/did-webs-resolver/issues
8
+ Author-email: "Philip S. Feairheller" <pfeairheller@gmail.com>, "Kent O. P. Bull" <kent@kentbull.com>
9
+ License: Apache Software License 2.0
10
+ License-File: LICENSE
11
+ Keywords: acdc,cesr,did,did:webs,keri,resolver,vlei,webs
12
+ Requires-Python: ==3.12.6
13
+ Requires-Dist: falcon>=4.0.2
14
+ Requires-Dist: keri==1.2.7
15
+ Requires-Dist: multicommand>=1.0.0
16
+ Requires-Dist: requests>=2.32.5
17
+ Requires-Dist: viking>=0.1.1
18
+ Description-Content-Type: text/markdown
19
+
20
+ # did:webs resolver
21
+
22
+ A DID resolver did:webs and did:keri DIDs also compatible with the Universal Resolver.
23
+
24
+ A demonstration of a `did:webs` service and resolver. Implements the
25
+ `did:webs` [specification](https://trustoverip.github.io/tswg-did-method-webs-specification/).
26
+
27
+ [![CI](https://github.com/GLEIF-IT/did-webs-resolver/actions/workflows/ci.yml/badge.svg)](https://github.com/GLEIF-IT/did-webs-resolver/actions/workflows/ci.yml)
28
+ [![codecov](https://codecov.io/gh/GLEIF-IT/did-webs-resolver/branch/main/graph/badge.svg?token=sUADtbanWC)](https://codecov.io/gh/GLEIF-IT/did-webs-resolver)
29
+
30
+ Components:
31
+ - **did:webs** static artifact generator - generates did.json and keri.cesr for did:webs DIDs.
32
+ - **did:webs** resolver in **static server mode** - serves static `did.json` and `keri.cesr` files from a local directory for did:webs DIDs. Works with the Universal Resolver subcomponent of the did:webs resolver below.
33
+ - **did:webs** dynamic artifact resolver - dynamically generates `did.json` and `keri.cesr` files upon receiving HTTP requests to `/{did path}/{aid}/{did.json,keri.cesr}`.
34
+ - **did:webs** resolver service - supports the DIF [Universal Resolver](https://dev.uniresolver.io/) at `/1.0/identifiers/{did}`
35
+ - supports both **did:webs** and **did:keri** DID resolution.
36
+
37
+ ## Quick Start
38
+
39
+ The quick start shows you how to use either the Docker Compose setup or the local shell script setup to:
40
+ 1. Generate did:webs artifacts (did.json, keri.cesr)
41
+ 2. Host those artifacts using a static server
42
+ 3. Resolve a did:webs DID against those artifacts using the `dws did webs resolve` command.
43
+ 4. Resolve a did:keri DID against those artifacts using the `dws did keri resolve` command.
44
+ 5. Run the `did:webs` resolver service in static server mode supporting the Universal Resolver.
45
+
46
+ ### Docker
47
+
48
+ 1. `docker compose up` - this will generate the did:webs assets (did.json, keri.cesr), start the static server, start the `did:webs` resolver service, and boot up the `dws-shell` container.
49
+ 2. `docker compose exec -it dws-shell /bin/bash` - drop in to the shell container to run commands.
50
+ 3. review the `./docker/test-resolutions.sh` for a guide on how to use either the universal resolver resource or the `dws did webs resolve` command to resolve did:webs DIDs.
51
+
52
+ ### Local Shell Script
53
+
54
+ 1. `kli witness demo` to start the witnesses up. Run this from the root of the `keripy` respository in a separate terminal window.
55
+ 2. Create a local Python virtual environment with `uv lock` and `uv sync` to install the dependencies.
56
+ 3. Source the uv environment with `source .venv/bin/activate`.
57
+ 4. Run the local script with `./local/did_webs_workflow.sh` to view the end-to-end resolution process.
58
+
59
+ ## Developers - Getting Started
60
+
61
+ Developers who want to jump into using the `did:webs` reference implementation should follow
62
+ the [Getting Started](docs/getting_started) guide.
63
+
64
+ A breakdown of the commands can be found [here](./docs/commands.md).
65
+
66
+ #### did:webs service
67
+
68
+ For a `did:webs` service to operate securely it should only serve AIDs whose KELs have been processed into the service's database.
69
+
70
+ There are two methods to do this:
71
+
72
+ 1. Local only support - start the service using an existing local keystore.
73
+
74
+ This is useful for development and can be done by provide an existing named keystore to the `did:webs` service.
75
+
76
+ For example, to start the service using the `multisig1` keystore (https://github.com/WebOfTrust/keripy/blob/v1.2.4/scripts/demo/basic/multisig.sh)
77
+
78
+ ```bash
79
+ dws did webs service --name multisig1
80
+ ```
81
+
82
+ 2. Import supported - start the service using an empty local keystore, and import AID KELs. The following workflow can be applied to start the service, export an existing keystore and import it to the service.
83
+
84
+ ```bash
85
+ dws did webs service --name dws
86
+ ```
87
+
88
+ ```bash
89
+ kli export --name multisig1 --files
90
+ ```
91
+
92
+ to import an AID to the service securely we use a IPEX Grant to present the exported KEL to the service.
93
+
94
+ ```bash
95
+ kli grant
96
+ ```
97
+
98
+
99
+ #### Bootstrapping
100
+
101
+ ### Prior art
102
+
103
+ did:keri resolver by Philip Feairheller @pfeairheller [here](https://github.com/WebOfTrust/did-keri-resolver)
104
+
105
+ Thank you to Markus Sabadello @peacekeeper from DanubeTech who started the original tutorial for
106
+ IIW37 [here](https://github.com/peacekeeper/did-webs-iiw-tutorial)
107
+
108
+ # Development Warnings
109
+
110
+ - Some of the tests in test_habs.py and test_clienting.py are flaky, so re-running the tests is fine. We need to use more mocks there. The problem in habbing gets down to how the "temp=False" option causes Filer to use or not use temporary filesystem files. We should just mock this out. The problem in clienter is likely due to timeouts not being set with enough of a margin of error. Mocking here might be the best solution as well.