microsoft
/
CCF
зеркало из https://github.com/microsoft/CCF.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Add gov API version 2024-07-01 (#6321)

This commit is contained in:
Eddy Ashton 2024-07-11 10:15:22 +01:00 коммит произвёл GitHub
Родитель 79618c215f
Коммит ccf21db2d2
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
75 изменённых файлов: 3370 добавлений и 95 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

2
CHANGELOG.md
Просмотреть файл

@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Added
- The `cchost` configuration file now includes an `idle_connection_timeout` option. This controls how long the node will keep idle connections (for user TLS sessions) before automatically closing them. This may be set to `null` to restore the previous behaviour, where idle connections are never closed. By default connections will be closed after 60s of idle time.
- New endpoints `GET /gov/service/javascript-modules` and `GET /gov/service/javascript-modules/{moduleName}` to retrieve the raw JS code of the currently installed app. Note that the `{moduleName}` path parameter will need to be URL-encoded to escape any `/` characters (eg - `/foo/bar.js` should become `%2Ffoo%2Fbar.js`).
- New gov API version `2024-07-01`. This is near-identical to `2023-06-01-preview`, but additionally offers the new `javascript-modules` endpoints.
### Changed

29
CMakeLists.txt
Просмотреть файл

@ -577,14 +577,23 @@ configure_file(
@ONLY
)
file(READ ${CCF_DIR}/doc/schemas/mccf/2023-06-01-preview/mccfgov.json
file(READ ${CCF_DIR}/doc/schemas/gov/2023-06-01-preview/gov.json
GOV_API_SCHEMA_2023_06_01_PREVIEW
)
set_property(
DIRECTORY
APPEND
PROPERTY CMAKE_CONFIGURE_DEPENDS
${CCF_DIR}/doc/schemas/mccf/2023-06-01-preview/mccfgov.json
${CCF_DIR}/doc/schemas/gov/2023-06-01-preview/gov.json
)
file(READ ${CCF_DIR}/doc/schemas/gov/2024-07-01/gov.json
GOV_API_SCHEMA_2024_07_01
)
set_property(
DIRECTORY
APPEND
PROPERTY CMAKE_CONFIGURE_DEPENDS
${CCF_DIR}/doc/schemas/gov/2024-07-01/gov.json
)
configure_file(
${CCF_DIR}/src/node/gov/api_schema.h.in ${CCF_DIR}/src/node/gov/api_schema.h
@ -1160,19 +1169,19 @@ if(BUILD_TESTS)
if(LONG_TESTS)
set(ADDITIONAL_RECOVERY_ARGS --with-load)
endif()
add_e2e_test(
NAME recovery_test_cft_api_0
PYTHON_SCRIPT ${CMAKE_SOURCE_DIR}/tests/recovery.py
ADDITIONAL_ARGS ${ADDITIONAL_RECOVERY_ARGS} --gov-api-version "classic"
)
add_e2e_test(
NAME recovery_test_cft_api_0
PYTHON_SCRIPT ${CMAKE_SOURCE_DIR}/tests/recovery.py
ADDITIONAL_ARGS ${ADDITIONAL_RECOVERY_ARGS} --gov-api-version "classic"
)
endif()
add_e2e_test(
NAME recovery_test_cft_api_1
PYTHON_SCRIPT ${CMAKE_SOURCE_DIR}/tests/recovery.py
ADDITIONAL_ARGS ${ADDITIONAL_RECOVERY_ARGS} --gov-api-version
"2023-06-01-preview"
"2024-07-01"
)
add_e2e_test(
@ -1384,7 +1393,7 @@ if(BUILD_TESTS)
add_e2e_test(
NAME membership_api_1
PYTHON_SCRIPT ${CMAKE_SOURCE_DIR}/tests/membership.py
ADDITIONAL_ARGS --gov-api-version "2023-06-01-preview"
ADDITIONAL_ARGS --gov-api-version "2024-07-01"
)
set(PARTITIONS_TEST_ARGS

2
doc/build_apps/run_app.rst
Просмотреть файл

@ -91,7 +91,7 @@ This should look much like a standard HTTP server, with error codes for missing
$ curl https://127.0.0.1:8000/app/not/a/real/resource -X GET --cacert service_cert.pem --cert user0_cert.pem --key user0_privk.pem -i
HTTP/1.1 404 Not Found
$ curl https://127.0.0.1:8000/gov/members/proposals:create?api-version=2023-06-01-preview -X POST --cacert service_cert.pem --cert user0_cert.pem --key user0_privk.pem -i
$ curl https://127.0.0.1:8000/gov/members/proposals:create?api-version=2024-07-01 -X POST --cacert service_cert.pem --cert user0_cert.pem --key user0_privk.pem -i
HTTP/1.1 403 Forbidden
Logging App Commands

10
doc/governance/accept_recovery.rst
Просмотреть файл

@ -35,7 +35,7 @@ A member proposes to recover the network and other members can vote on the propo
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content transition_service_to_open.json \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -53,7 +53,7 @@ A member proposes to recover the network and other members can vote on the propo
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content vote_accept.json \
| curl https://<ccf-node-address>/gov/members/proposals/1b7cae1585077104e99e1860ad740efe28ebd498dbf9988e0e7b299e720c5377/ballots/d5d7d5fed6f839028456641ad5c3df18ce963bd329bd8a21df16ccdbdbba1eb1:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/1b7cae1585077104e99e1860ad740efe28ebd498dbf9988e0e7b299e720c5377/ballots/d5d7d5fed6f839028456641ad5c3df18ce963bd329bd8a21df16ccdbdbba1eb1:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -71,7 +71,7 @@ A member proposes to recover the network and other members can vote on the propo
--signing-key member2_privk.pem \
--signing-cert member2_cert.pem \
--content vote_accept.json
| curl https://<ccf-node-address>/gov/members/proposals/1b7cae1585077104e99e1860ad740efe28ebd498dbf9988e0e7b299e720c5377/ballots/e306e3a6eead2f4a3854302b41c3015bf12db9535ac0be1b8cf6584f84bca92b:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/1b7cae1585077104e99e1860ad740efe28ebd498dbf9988e0e7b299e720c5377/ballots/e306e3a6eead2f4a3854302b41c3015bf12db9535ac0be1b8cf6584f84bca92b:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -104,7 +104,7 @@ The recovery share retrieval, decryption and submission steps can be convenientl
$ submit_recovery_share.sh https://<ccf-node-address> \
--member-enc-privk member0_enc_privk.pem \
--cert member0_cert.pem \
--api-version 2023-06-01-preview \
--api-version 2024-07-01 \
--key member0_privk.pem \
--cacert service_cert.pem
HTTP/1.1 200 OK
@ -115,7 +115,7 @@ The recovery share retrieval, decryption and submission steps can be convenientl
$ submit_recovery_share.sh https://<ccf-node-address> \
--member-enc-privk member1_enc_privk.pem \
--cert member1_cert.pem \
--api-version 2023-06-01-preview \
--api-version 2024-07-01 \
--key member1_privk.pem \
--cacert service_cert.pem
HTTP/1.1 200 OK

6
doc/governance/adding_member.rst
Просмотреть файл

@ -64,7 +64,7 @@ First, the new member should update and retrieve the latest state digest via the
--signing-key new_member_privk.pem \
--signing-cert new_member_cert.pem \
--content empty_file \ # Note that passing an empty file is required
| curl https://<ccf-node-address>/gov/members/state-digests/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6:update?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/state-digests/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6:update?api-version=2024-07-01 \
-X POST \
--cacert service_cert.pem \
--key new_member_privk.pem \
@ -86,7 +86,7 @@ Then, the new member should sign the state digest returned by :http:POST:`/gov/m
--signing-key new_member_privk.pem \
--signing-cert new_member_cert.pem \
--content request.json \
| curl https://<ccf-node-address>/gov/members/state-digests/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6:ack?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/state-digests/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6:ack?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -95,7 +95,7 @@ Once the command completes, the new member becomes active and can take part in g
.. code-block:: bash
$ curl https://<ccf-node-address>/gov/service/members/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6?api-version=2023-06-01-preview?api-version=2023-06-01-preview --silent | jq
$ curl https://<ccf-node-address>/gov/service/members/7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6?api-version=2024-07-01 --silent | jq
{
"memberId": "7f46110b62ccbbd5f18b4c9bda876024399fd538133f8c26d4bfe5a9d80e59e6",
"certificate": <...>,

6
doc/governance/common_member_operations.rst
Просмотреть файл

@ -61,7 +61,7 @@ To limit the scope of key compromise, members of the consortium can refresh the
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content trigger_ledger_rekey.json \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -79,7 +79,7 @@ To limit the scope of key compromise, members of the consortium can refresh the
--signing-key member2_privk.pem \
--signing-cert member2_cert.pem \
--content vote_accept_1.json \
| curl https://<ccf-node-address>/gov/members/proposals/2f739d154b8cddacd7fc6d03cc8d4d20626e477ec4b1af10a74c670bb38bed5e/ballots/fe6ed012e8184f28afb48d0d58dca7f461dc997c43179acf97362dc0b76ddeb7:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/2f739d154b8cddacd7fc6d03cc8d4d20626e477ec4b1af10a74c670bb38bed5e/ballots/fe6ed012e8184f28afb48d0d58dca7f461dc997c43179acf97362dc0b76ddeb7:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -97,7 +97,7 @@ To limit the scope of key compromise, members of the consortium can refresh the
--signing-key member3_privk.pem \
--signing-cert member3_cert.pem \
--content vote_accept_1.json \
| curl https://<ccf-node-address>/gov/members/proposals/2f739d154b8cddacd7fc6d03cc8d4d20626e477ec4b1af10a74c670bb38bed5e/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/2f739d154b8cddacd7fc6d03cc8d4d20626e477ec4b1af10a74c670bb38bed5e/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"

2
doc/governance/gov_api_schemas/2023-06-01-preview.rst
Просмотреть файл

@ -5,5 +5,5 @@ This API is available by passing the query parameter ``api-version=2023-06-01-pr
This is available from CCF 5.0.0-dev3.
.. openapi:: ../../schemas/mccf/2023-06-01-preview/mccfgov.json
.. openapi:: ../../schemas/gov/2023-06-01-preview/gov.json

8
doc/governance/gov_api_schemas/2024-07-01.rst Normal file
Просмотреть файл

@ -0,0 +1,8 @@
2024-07-01
==========
This API is available by passing the query parameter ``api-version=2024-07-01`` to endpoints under the ``/gov`` prefix.
This is available from CCF 5.0.0-rc1.
.. openapi:: ../../schemas/gov/2024-07-01/gov.json

4
doc/governance/gov_api_schemas/classic.rst
Просмотреть файл

@ -1,5 +1,5 @@
Classic API
===========
Classic API (Deprecated)
========================
Available in CCF versions before 5.0.0.

2
doc/governance/hsm_keys.rst
Просмотреть файл

@ -121,7 +121,7 @@ Like ``ccf_cose_sign1``, the output can be sent directly to the service via curl
--content proposal.json \
--signing-cert $IDENTITY_CERT_NAME.pem \
--signature signature \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"

1
doc/governance/member_rpc_api.rst
Просмотреть файл

@ -7,6 +7,7 @@ Multiple API versions are available, with the versions supported by the current
.. toctree::
gov_api_schemas/2024-07-01
gov_api_schemas/2023-06-01-preview
gov_api_schemas/classic
gov_api_schemas/upgrading_from_classic

8
doc/governance/open_network.rst
Просмотреть файл

@ -35,7 +35,7 @@ Then, the certificates of trusted users should be registered in CCF via the memb
--signing-key member0_privk.pem \
--signing-cert member0_cert.pem \
--content set_user.json \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -64,7 +64,7 @@ Other members are then allowed to vote for the proposal, using the proposal id r
--signing-key member0_privk.pem \
--signing-cert member0_cert.pem \
--content vote_accept.json \
| curl https://<ccf-node-address>/gov/members/proposals/f665047e3d1eb184a7b7921944a8ab543cfff117aab5b6358dc87f9e70278253/ballots/2af6cb6c0af07818186f7ef7151061174c3cb74b4a4c30a04a434f0c2b00a8c0:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/f665047e3d1eb184a7b7921944a8ab543cfff117aab5b6358dc87f9e70278253/ballots/2af6cb6c0af07818186f7ef7151061174c3cb74b4a4c30a04a434f0c2b00a8c0:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -84,7 +84,7 @@ Other members are then allowed to vote for the proposal, using the proposal id r
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content vote_accept.json \
| curl https://<ccf-node-address>/gov/members/proposals/f665047e3d1eb184a7b7921944a8ab543cfff117aab5b6358dc87f9e70278253/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/f665047e3d1eb184a7b7921944a8ab543cfff117aab5b6358dc87f9e70278253/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -177,7 +177,7 @@ Once users are added to the opening network, members should create a proposal to
--signing-key member0_privk.pem \
--signing-cert member0_cert.pem \
--content transition_service_to_open.json
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"

12
doc/governance/proposals.rst
Просмотреть файл

@ -280,7 +280,7 @@ For example, ``member1`` may submit a proposal to add a new member (``member4``)
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content add_member.json \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals:create?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -315,7 +315,7 @@ Here a new proposal has successfully been created, and nobody has yet voted for
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
--content vote_accept.json \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/52af2620fa1b005a93d55d7d819a249ee2cb79f5262f54e8db794c5281a0ce73:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/52af2620fa1b005a93d55d7d819a249ee2cb79f5262f54e8db794c5281a0ce73:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -334,7 +334,7 @@ Here a new proposal has successfully been created, and nobody has yet voted for
--signing-key member2_privk.pem \
--signing-cert member2_cert.pem \
--content vote_reject.json \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/fe6ed012e8184f28afb48d0d58dca7f461dc997c43179acf97362dc0b76ddeb7:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/fe6ed012e8184f28afb48d0d58dca7f461dc997c43179acf97362dc0b76ddeb7:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -353,7 +353,7 @@ Here a new proposal has successfully been created, and nobody has yet voted for
--signing-key member3_privk.pem \
--signing-cert member3_cert.pem \
--content vote_accept.json \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd/ballots/75b86775f1253c308f4e9aeddf912d40b8d77db9eaa9a0f0026f581920d5e9b8:submit?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"
@ -377,7 +377,7 @@ The details of pending proposals, can be queried from the service by calling :ht
.. code-block:: bash
$ curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd?api-version=2023-06-01-preview --cacert service_cert.pem -X GET
$ curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd?api-version=2024-07-01 --cacert service_cert.pem -X GET
{
"ballotCount": 3,
"finalVotes": {
@ -403,7 +403,7 @@ At any stage during the voting process, before the proposal is accepted, the pro
--ccf-gov-msg-proposal_id d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd \
--signing-key member1_privk.pem \
--signing-cert member1_cert.pem \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd:withdraw?api-version=2023-06-01-preview \
| curl https://<ccf-node-address>/gov/members/proposals/d4ec2de82267f97d3d1b464020af0bd3241f1bedf769f0fee73cd00f08e9c7fd:withdraw?api-version=2024-07-01 \
--cacert service_cert.pem \
--data-binary @- \
-H "content-type: application/cose"

0
doc/schemas/mccf/2023-06-01-preview/examples/Ballots_Get.json → doc/schemas/gov/2023-06-01-preview/examples/Ballots_Get.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Ballots_Submit.json → doc/schemas/gov/2023-06-01-preview/examples/Ballots_Submit.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/EncryptedShares_Get.json → doc/schemas/gov/2023-06-01-preview/examples/EncryptedShares_Get.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Proposals_Create.json → doc/schemas/gov/2023-06-01-preview/examples/Proposals_Create.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Proposals_Get.json → doc/schemas/gov/2023-06-01-preview/examples/Proposals_Get.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Proposals_GetActions.json → doc/schemas/gov/2023-06-01-preview/examples/Proposals_GetActions.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Proposals_List.json → doc/schemas/gov/2023-06-01-preview/examples/Proposals_List.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Proposals_Withdraw.json → doc/schemas/gov/2023-06-01-preview/examples/Proposals_Withdraw.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetConstitution.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetConstitution.json
Просмотреть файл

2
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetJoinPolicies.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetJoinPolicies.json
Просмотреть файл

@ -30,4 +30,4 @@
}
}
}
}
}

0
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetJsApp.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetJsApp.json
Просмотреть файл

29
doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetJwkInfo.json Normal file
Просмотреть файл

@ -0,0 +1,29 @@
{
"title": "ServiceState_GetJwkInfo",
"operationId": "ServiceState_GetJwkInfo",
"parameters": {
"api-version": "2023-06-01-preview"
},
"responses": {
"200": {
"body": {
"issuers": {
"idprovider.myservice.example.com": {
"keyFilter": "All",
"autoRefresh": true,
"caCertBundleName": "MyIdProviderCa"
}
},
"caCertBundles": {
"MyIdProviderCa": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n"
},
"keys": {
"idprovider_kida": {
"certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
"issuer": "idprovider.myservice.example.com"
}
}
}
}
}
}

0
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetMember.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetMember.json
Просмотреть файл

29
doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetNode.json Normal file
Просмотреть файл

@ -0,0 +1,29 @@
{
"title": "ServiceState_GetNode",
"operationId": "ServiceState_GetNode",
"parameters": {
"api-version": "2023-06-01-preview",
"nodeId": "7e87b5de68f7edb26d2c31b69eda2cb3fac6ec125fdaafecdbe184abc5f61573"
},
"responses": {
"200": {
"body": {
"nodeId": "7e87b5de68f7edb26d2c31b69eda2cb3fac6ec125fdaafecdbe184abc5f61573",
"status": "Trusted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIByDCCAU6gAwIBAgIQBU64KAw8A7HsEUJCvArBWDAKBggqhkjOPQQDAzATMREw\nDwYDVQQDDAhDQ0YgTm9kZTAeFw0yMzA1MTcxMzUwMzBaFw0yMzA1MTgxMzUwMjla\nMBMxETAPBgNVBAMMCENDRiBOb2RlMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqo97\nwuOBeYkmXGcDXAuGSQfDbTplLGyvls42TcwntLN/GkHxj6pe0l6h7BC0VV828J5/\na21q6sATQsXyFpZxIxIB6R/5s2blslk6INVuq03qkGz8hmGrpI/MJh//89Wjo2cw\nZTASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBR7QYSt32ibJwNKLAbfdeMu\nuyy6uDAfBgNVHSMEGDAWgBR7QYSt32ibJwNKLAbfdeMuuyy6uDAPBgNVHREECDAG\nhwR/yGnoMAoGCCqGSM49BAMDA2gAMGUCMBS9Hhd4mHjPjJ16n1L6KBshAzlT1IAA\n4jiVaTXqc6shnvfoHljw54jCVm/KpKAzRQIxANS8KrmXhW3cr4rkYWHipJEXzMJe\n8ZL6xWgCY6Fb63JNEYpQP+W3HZqaqKJrdvgTyw==\n-----END CERTIFICATE-----\n",
"retiredCommitted": false,
"quoteInfo": {
"format": "OE_SGX_v1",
"quote": "iqCn2D8gcLapGOmaS/wFlg==",
"endorsements": "xIuY7WOg/FR7/tlqDAWcxQ=="
},
"rpcInterfaces": {
"publicHttps": {
"publishedAddress": "ccf.dev:12345",
"protocol": "HTTP1"
}
}
}
}
}
}

0
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetServiceInfo.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_GetServiceInfo.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_ListMembers.json → doc/schemas/gov/2023-06-01-preview/examples/ServiceState_ListMembers.json
Просмотреть файл

50
doc/schemas/gov/2023-06-01-preview/examples/ServiceState_ListNodes.json Normal file
Просмотреть файл

@ -0,0 +1,50 @@
{
"title": "ServiceState_ListNodes",
"operationId": "ServiceState_ListNodes",
"parameters": {
"api-version": "2023-06-01-preview"
},
"responses": {
"200": {
"body": {
"value": [
{
"nodeId": "7e87b5de68f7edb26d2c31b69eda2cb3fac6ec125fdaafecdbe184abc5f61573",
"status": "Trusted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIByDCCAU6gAwIBAgIQBU64KAw8A7HsEUJCvArBWDAKBggqhkjOPQQDAzATMREw\nDwYDVQQDDAhDQ0YgTm9kZTAeFw0yMzA1MTcxMzUwMzBaFw0yMzA1MTgxMzUwMjla\nMBMxETAPBgNVBAMMCENDRiBOb2RlMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqo97\nwuOBeYkmXGcDXAuGSQfDbTplLGyvls42TcwntLN/GkHxj6pe0l6h7BC0VV828J5/\na21q6sATQsXyFpZxIxIB6R/5s2blslk6INVuq03qkGz8hmGrpI/MJh//89Wjo2cw\nZTASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBR7QYSt32ibJwNKLAbfdeMu\nuyy6uDAfBgNVHSMEGDAWgBR7QYSt32ibJwNKLAbfdeMuuyy6uDAPBgNVHREECDAG\nhwR/yGnoMAoGCCqGSM49BAMDA2gAMGUCMBS9Hhd4mHjPjJ16n1L6KBshAzlT1IAA\n4jiVaTXqc6shnvfoHljw54jCVm/KpKAzRQIxANS8KrmXhW3cr4rkYWHipJEXzMJe\n8ZL6xWgCY6Fb63JNEYpQP+W3HZqaqKJrdvgTyw==\n-----END CERTIFICATE-----\n",
"retiredCommitted": false,
"quoteInfo": {
"format": "OE_SGX_v1",
"quote": "iqCn2D8gcLapGOmaS/wFlg==",
"endorsements": "xIuY7WOg/FR7/tlqDAWcxQ=="
},
"rpcInterfaces": {
"publicHttps": {
"publishedAddress": "ccf.dev:12345",
"protocol": "HTTP1"
}
}
},
{
"nodeId": "5bc78bd280bbd86387bbc448b5b7defbc2ecded715537b3aa742ceae35ab4302",
"status": "Retired",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIByDCCAU6gAwIBAgIQOBe5SrcwReWmSzTjzj2HDjAKBggqhkjOPQQDAzATMREw\nDwYDVQQDDAhDQ0YgTm9kZTAeFw0yMzA1MTcxMzUwMzFaFw0yMzA1MTgxMzUwMzBa\nMBMxETAPBgNVBAMMCENDRiBOb2RlMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAE74qL\nAc/45tiriN5MuquYhHVdMGQRvYSm08HBfYcODtET88qC0A39o6Y2TmfbIn6BdjMG\nkD58o377ZMTaApQu/oJcwt7qZ9/LE8j8WU2qHn0cPTlpwH/2tiud2w+U3voSo2cw\nZTASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQWBBS9FJNwWSXtUpHaBV57EwTW\noM8vHjAfBgNVHSMEGDAWgBS9FJNwWSXtUpHaBV57EwTWoM8vHjAPBgNVHREECDAG\nhwR/xF96MAoGCCqGSM49BAMDA2gAMGUCMQDKxpjPToJ7VSqKqQSeMuW9tr4iL+9I\n7gTGdGwiIYV1qTSS35Sk9XQZ0VpSa58c/5UCMEgmH71k7XlTGVUypm4jAgjpC46H\ns+hJpGMvyD9dKzEpZgmZYtghbyakUkwBiqmFQA==\n-----END CERTIFICATE-----\n",
"retiredCommitted": true,
"quoteInfo": {
"format": "OE_SGX_v1",
"quote": "4n3t9RVQZomjwsAZyiyAuQ==",
"endorsements": "lvpmei0YwtfvVa4RaK8n+g=="
},
"rpcInterfaces": {
"publicHttps": {
"publishedAddress": "ccf.dev:12345",
"protocol": "HTTP1"
}
}
}
],
"nextLink": "https://microsoft.com/a"
}
}
}
}

0
doc/schemas/mccf/2023-06-01-preview/examples/Shares_Submit.json → doc/schemas/gov/2023-06-01-preview/examples/Shares_Submit.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/StateDigests_Acknowledge.json → doc/schemas/gov/2023-06-01-preview/examples/StateDigests_Acknowledge.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/StateDigests_Get.json → doc/schemas/gov/2023-06-01-preview/examples/StateDigests_Get.json
Просмотреть файл

2
doc/schemas/mccf/2023-06-01-preview/examples/StateDigests_Update.json → doc/schemas/gov/2023-06-01-preview/examples/StateDigests_Update.json
Просмотреть файл

@ -14,4 +14,4 @@
}
}
}
}
}

0
doc/schemas/mccf/2023-06-01-preview/examples/Transactions_Get.json → doc/schemas/gov/2023-06-01-preview/examples/Transactions_Get.json
Просмотреть файл

0
doc/schemas/mccf/2023-06-01-preview/examples/Transactions_GetCommit.json → doc/schemas/gov/2023-06-01-preview/examples/Transactions_GetCommit.json
Просмотреть файл

70
doc/schemas/mccf/2023-06-01-preview/mccfgov.json → doc/schemas/gov/2023-06-01-preview/gov.json
Просмотреть файл

@ -1164,14 +1164,22 @@
"type": "object",
"description": "A compact summary of the service's state up to a certain point in time, updated and signed by members to indicate their participation in and approval of the service.",
"properties": {
"digest": {
"memberId": {
"$ref": "#/definitions/memberId",
"description": "Identifier for member this stateDigest applies to.",
"x-ms-mutability": [
"read"
]
},
"stateDigest": {
"type": "string",
"description": "Hex-encoding of SHA-256 hash of the root of the service's merkle tree. This should be signed by a new member and submitted as an ACK to mark that member as Active.",
"pattern": "^[a-f0-9]{64}$"
}
},
"required": [
"digest"
"memberId",
"stateDigest"
]
},
"Azure.Core.Foundations.Error": {
@ -1534,6 +1542,19 @@
"constitution"
]
},
"ServiceState.FeedInfo": {
"type": "object",
"description": "Collection of claims regarding a specific feed.",
"properties": {
"svn": {
"type": "string",
"description": "Security version number claimed by this endorser."
}
},
"required": [
"svn"
]
},
"ServiceState.ForwardingRequired": {
"type": "string",
"description": "Describes the forwarding behavior of a specific endpoint. Write requests cannot be executed on a backup, so will generally be forwarded by any backup node which receives them to the current primary. Future requests on the same session may then be forwarded to maintain session consistency.",
@ -1694,6 +1715,23 @@
"$ref": "#/definitions/ServiceState.JsEndpointInfo"
}
},
"ServiceState.Jwk": {
"type": "object",
"description": "Describes a single JWK.",
"properties": {
"certificate": {
"$ref": "#/definitions/ServiceState.pem",
"description": "x509 cert used to validate claims made by this key."
},
"issuer": {
"type": "string",
"description": "Issuer ID of entity who issued this key."
}
},
"required": [
"certificate"
]
},
"ServiceState.JwkInfo": {
"type": "object",
"description": "Describes what Javascript Web Tokens (JWTs) are accepted by the service, and how they will be validated.",
@ -1711,11 +1749,19 @@
"additionalProperties": {
"$ref": "#/definitions/ServiceState.caCertBundle"
}
},
"keys": {
"type": "object",
"description": "Collection of retrieved JWKs. Keyed by kid.",
"additionalProperties": {
"$ref": "#/definitions/ServiceState.Jwk"
}
}
},
"required": [
"issuers",
"caCertBundles"
"caCertBundles",
"keys"
]
},
"ServiceState.JwtIssuer": {
@ -1789,6 +1835,10 @@
"certificate": {
"$ref": "#/definitions/ServiceState.pem",
"description": "x509 certificate used as this member's identity."
},
"publicEncryptionKey": {
"$ref": "#/definitions/ServiceState.pem",
"description": "x509 key used to encrypt this member's key shares, if they are a recovery member."
}
},
"required": [
@ -1948,7 +1998,7 @@
"description": "Transaction ID at which this service was first created. If this is a recovery of a previous service, this will indicate when the current service was recovered."
},
"previousServiceCreationTransactionId": {
"$ref": "#/definitions/ServiceState.pem",
"$ref": "#/definitions/transactionId",
"description": "Transaction ID at which the predecessor service was created, if this service is a recovery. If this is an original service rather than a recovery, this will be omitted."
},
"serviceData": {
@ -2063,10 +2113,9 @@
},
"uvmEndorsements": {
"type": "object",
"description": "Collection of acceptable UVM endorsements.",
"description": "Collection of acceptable UVM endorsements. Keyed by endorser's did.",
"additionalProperties": {
"format": "byte",
"type": "string"
"$ref": "#/definitions/ServiceState.UvmEndorsementFeeds"
}
}
},
@ -2102,6 +2151,13 @@
],
"x-ms-discriminator-value": "AMD_SEV_SNP_v1"
},
"ServiceState.UvmEndorsementFeeds": {
"type": "object",
"description": "Collection of endorsement feeds, keyed by feed name.",
"additionalProperties": {
"$ref": "#/definitions/ServiceState.FeedInfo"
}
},
"ServiceState.caCertBundle": {
"type": "string",
"description": "Chain of endorsed certificates (PEM format) leading to a CA."

16
doc/schemas/gov/2024-07-01/examples/Ballots_Get.json Normal file
Просмотреть файл

@ -0,0 +1,16 @@
{
"title": "Ballots_Get",
"operationId": "Ballots_Get",
"parameters": {
"api-version": "2024-07-01",
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970"
},
"responses": {
"200": {
"body": {
"script": "export function vote (rawProposal, proposerId) { return true }"
}
}
}
}

24
doc/schemas/gov/2024-07-01/examples/Ballots_Submit.json Normal file
Просмотреть файл

@ -0,0 +1,24 @@
{
"title": "Ballots_Submit",
"operationId": "Ballots_Submit",
"parameters": {
"api-version": "2024-07-01",
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"body": "{binary COSE Sign1}"
},
"responses": {
"200": {
"body": {
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"proposerId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"proposalState": "Open",
"ballotCount": 2,
"finalVotes": {
"f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970": true,
"b9626e3856b3ef3b433e612d59fbb9edd71cfa2efc772bcfbb50aaa9b6e033f7": false
}
}
}
}
}

15
doc/schemas/gov/2024-07-01/examples/EncryptedShares_Get.json Normal file
Просмотреть файл

@ -0,0 +1,15 @@
{
"title": "EncryptedShares_Get",
"operationId": "EncryptedShares_Get",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970"
},
"responses": {
"200": {
"body": {
"encryptedShare": "ZW5jcnlwdGVkU2hhcmUx"
}
}
}
}

19
doc/schemas/gov/2024-07-01/examples/Proposals_Create.json Normal file
Просмотреть файл

@ -0,0 +1,19 @@
{
"title": "Proposals_Create",
"operationId": "Proposals_Create",
"parameters": {
"api-version": "2024-07-01",
"body": "{binary COSE Sign1}"
},
"responses": {
"200": {
"body": {
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"proposerId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"proposalState": "Open",
"ballotCount": 0,
"finalVotes": {}
}
}
}
}

22
doc/schemas/gov/2024-07-01/examples/Proposals_Get.json Normal file
Просмотреть файл

@ -0,0 +1,22 @@
{
"title": "Proposals_Get",
"operationId": "Proposals_Get",
"parameters": {
"api-version": "2024-07-01",
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b"
},
"responses": {
"200": {
"body": {
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"proposerId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"proposalState": "Open",
"ballotCount": 2,
"finalVotes": {
"f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970": true,
"b9626e3856b3ef3b433e612d59fbb9edd71cfa2efc772bcfbb50aaa9b6e033f7": false
}
}
}
}
}

23
doc/schemas/gov/2024-07-01/examples/Proposals_GetActions.json Normal file
Просмотреть файл

@ -0,0 +1,23 @@
{
"title": "Proposals_GetActions",
"operationId": "Proposals_GetActions",
"parameters": {
"api-version": "2024-07-01",
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b"
},
"responses": {
"200": {
"body": {
"actions": [
{
"name": "set_member",
"args": {
"cert": "-----BEGIN CERTIFICATE-----\nMIIBtzCCATygAwIBAgIUYqXLFcT1aCENVpgp2K+Vv53cauEwCgYIKoZIzj0EAwMw\nEjEQMA4GA1UEAwwHbWVtYmVyMzAeFw0yMzA1MTcxMzUwMzJaFw0yNDA1MTYxMzUw\nMzJaMBIxEDAOBgNVBAMMB21lbWJlcjMwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQI\ngWV8Lcf+eegGXVj1I4N8jWcfTb6MRt0Znl8aFOBBwZ5lgRlTePYLHBb81wOJaX+k\nIYqHRaI3Wblg72gV/dhf4qBYw9ENqJtE2ClenYkRFAX2/1GwjxTOf9XGpBUt5Rij\nUzBRMB0GA1UdDgQWBBT7oAebRrqSDSG89jW0nFF5fHRRTzAfBgNVHSMEGDAWgBT7\noAebRrqSDSG89jW0nFF5fHRRTzAPBgNVHRMBAf8EBTADAQH/MAoGCCqGSM49BAMD\nA2kAMGYCMQCmCKWLEbCooecDiuMyUf/B2vppNZ75U96B2ypg88Xy5y4xhRV1qoCT\nRT4sUCFl6ioCMQCKm0df2DzlRbhX6+0i6KikBkUf9kFowb5ctikJsym0rTigpPZC\nHaZlaQD2pNBud/0=\n-----END CERTIFICATE-----\n",
"encryption_pub_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzIh4oWoiTFCu/8tsfmo9\njTDryaTrL7wo8+HJAGUTL827CiZ8Rm9wgo7iJDOza7UPaPnXpR6kIlZbdItDOx9k\nmJSVWbDMufaqqs+y/i+WrTiDqL02zbT/lI4kx5l7Wyu0VEHT5GmSKQiVyJt/Q4vE\n1b9rKNy3Ol1g5VuW9PKOHFz3tvjWksVWXi16qulN3IjAhSFVRtasbqdNSNdDbirv\nLTe24Y9v7UP8CI3qgjr3x8qLYM/X0ou4ZcJvXWVtxZfQLGVgyZcgHD6OtbYJr9Iy\neh/x+G3pPFg2eQY8xNZgqqtH1StKcI++eD7iSDosKRkN3efCKLeKStg6F/xluarc\nkQIDAQAB\n-----END PUBLIC KEY-----\n"
}
}
]
}
}
}
}

26
doc/schemas/gov/2024-07-01/examples/Proposals_List.json Normal file
Просмотреть файл

@ -0,0 +1,26 @@
{
"title": "Proposals_List",
"operationId": "Proposals_List",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"proposerId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"proposalState": "Open",
"ballotCount": 2,
"finalVotes": {
"f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970": true,
"b9626e3856b3ef3b433e612d59fbb9edd71cfa2efc772bcfbb50aaa9b6e033f7": false
}
}
],
"nextLink": "https://microsoft.com/avwpnzmy"
}
}
}
}

23
doc/schemas/gov/2024-07-01/examples/Proposals_Withdraw.json Normal file
Просмотреть файл

@ -0,0 +1,23 @@
{
"title": "Proposals_Withdraw",
"operationId": "Proposals_Withdraw",
"parameters": {
"api-version": "2024-07-01",
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"body": "{binary COSE Sign1}"
},
"responses": {
"200": {
"body": {
"proposalId": "1c04c5bb4bdc207dbf35bc4b32dbf92cbc23eabb34a6e8b163b2de2c7833e87b",
"proposerId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"proposalState": "Withdrawn",
"ballotCount": 2,
"finalVotes": {
"f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970": true,
"b9626e3856b3ef3b433e612d59fbb9edd71cfa2efc772bcfbb50aaa9b6e033f7": false
}
}
}
}
}

14
doc/schemas/gov/2024-07-01/examples/ServiceState_GetConstitution.json Normal file
Просмотреть файл

@ -0,0 +1,14 @@
{
"title": "ServiceState_GetConstitution",
"operationId": "ServiceState_GetConstitution",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"constitution": "export function validate(input) {\n ...\n}\n\nexport function resolve(proposal, proposerId, votes) {\n ...\n}\n\nexport function apply(proposal, proposalId) {\n ...\n}\n"
}
}
}
}

33
doc/schemas/gov/2024-07-01/examples/ServiceState_GetJoinPolicies.json Normal file
Просмотреть файл

@ -0,0 +1,33 @@
{
"title": "ServiceState_GetJoinPolicies",
"operationId": "ServiceState_GetJoinPolicies",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"sgx": {
"measurements": [
"cs/RoNCp2UCxpN+i1UnVYw=="
]
},
"snp": {
"measurements": [
"XqJZLOA9/xCx9nnsDch4vw=="
],
"hostData": {
"key9497": "NiNrjmA9/aSj4F076mVdrA=="
},
"uvmEndorsements": {
"did:x509:0:sha256:I__iuL25oXEVFdTP_aBLx_eT1RPHbCQ_ECBQfYZpt9s::eku:1.3.6.1.4.1.311.76.59.1.2": {
"ContainerPlat-AMD-UVM": {
"svn": "100"
}
}
}
}
}
}
}
}

27
doc/schemas/gov/2024-07-01/examples/ServiceState_GetJsApp.json Normal file
Просмотреть файл

@ -0,0 +1,27 @@
{
"title": "ServiceState_GetJsApp",
"operationId": "ServiceState_GetJsApp",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"endpoints": {
"/compute": {
"post": {
"jsModule": "math.js",
"jsFunction": "compute",
"forwardingRequired": "Sometimes",
"authnPolicies": [
"user_cert"
],
"mode": "ReadOnly",
"openApi": {}
}
}
}
}
}
}
}

2
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetJwkInfo.json → doc/schemas/gov/2024-07-01/examples/ServiceState_GetJwkInfo.json
Просмотреть файл

@ -2,7 +2,7 @@
"title": "ServiceState_GetJwkInfo",
"operationId": "ServiceState_GetJwkInfo",
"parameters": {
"api-version": "2023-06-01-preview"
"api-version": "2024-07-01"
},
"responses": {
"200": {

17
doc/schemas/gov/2024-07-01/examples/ServiceState_GetMember.json Normal file
Просмотреть файл

@ -0,0 +1,17 @@
{
"title": "ServiceState_GetMember",
"operationId": "ServiceState_GetMember",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970"
},
"responses": {
"200": {
"body": {
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"status": "Accepted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIBtjCCATygAwIBAgIUQReVbbmYi3jwIKLajvRSSazrlHgwCgYIKoZIzj0EAwMw\nEjEQMA4GA1UEAwwHbWVtYmVyMDAeFw0yMzA1MTcxMzUwMzBaFw0yNDA1MTYxMzUw\nMzBaMBIxEDAOBgNVBAMMB21lbWJlcjAwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQL\nHTNizYCCd+qvH5hMkikWRRb9s3cmD1PIkeoqRIqJ98FF2PgW/cPhM8wyJ3KK8tqS\n7MI6rW8AFgRf2CV3nJ3uNwVrbdgbmmGef8WTyFBXX3VvypntT+jCHDg9HURROAmj\nUzBRMB0GA1UdDgQWBBSljyQ0GfGDm8ODrpcWy364SPRUHjAfBgNVHSMEGDAWgBSl\njyQ0GfGDm8ODrpcWy364SPRUHjAPBgNVHRMBAf8EBTADAQH/MAoGCCqGSM49BAMD\nA2gAMGUCMDUoePU2bJxAt9lXDX0TCQrt1xMBZc5BNvVi2ROEQEKHSetVgzAADzFC\n/8Te+S/+kwIxAJMFEeGSbXaUNxvQLHJehaORV0Bw2FJN+zkb3FAltwlua+REfl/t\nPcn7nq5mpQ0RNQ==\n-----END CERTIFICATE-----\n"
}
}
}
}

2
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_GetNode.json → doc/schemas/gov/2024-07-01/examples/ServiceState_GetNode.json
Просмотреть файл

@ -2,7 +2,7 @@
"title": "ServiceState_GetNode",
"operationId": "ServiceState_GetNode",
"parameters": {
"api-version": "2023-06-01-preview",
"api-version": "2024-07-01",
"nodeId": "7e87b5de68f7edb26d2c31b69eda2cb3fac6ec125fdaafecdbe184abc5f61573"
},
"responses": {

22
doc/schemas/gov/2024-07-01/examples/ServiceState_GetServiceInfo.json Normal file
Просмотреть файл

@ -0,0 +1,22 @@
{
"title": "ServiceState_GetServiceInfo",
"operationId": "ServiceState_GetServiceInfo",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"status": "Open",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIBvjCCAUSgAwIBAgIRAKMpqEu0tXPD9gmJTV/RDdcwCgYIKoZIzj0EAwMwFjEU\nMBIGA1UEAwwLQ0NGIE5ldHdvcmswHhcNMjMwNTE2MTUxNzIyWhcNMjMwNTE3MTUx\nNzIxWjAWMRQwEgYDVQQDDAtDQ0YgTmV0d29yazB2MBAGByqGSM49AgEGBSuBBAAi\nA2IABKGiSg+X2EofhkL9rmpnvRAsRDMRW1cErnYA7gv3Y1s+g0srVPG5Fh85I2GO\nxVgj/hICXsR/bPPjDW3NLJ7gvzbtU4XnLsixkRPa9mkWM9GePaimUNs6NnbWI/5/\ndZkkSqNWMFQwEgYDVR0TAQH/BAgwBgEB/wIBADAdBgNVHQ4EFgQUglDhOi9RqGAj\nwT2EFycWlLeZnrIwHwYDVR0jBBgwFoAUglDhOi9RqGAjwT2EFycWlLeZnrIwCgYI\nKoZIzj0EAwMDaAAwZQIwR6PFt+sC1nbFGskq8D+o8dBPihhZGxrthRIUtROYFTWU\ncfw59zRFYGffJH0qXV3tAjEAzldbGZNiFL6sTEmv+lfKdeSfZphZmVQttJ0yQ+l8\nM4qqgkU90BWODS/7RIDFMB73\n-----END CERTIFICATE-----\n",
"recoveryCount": 1,
"creationTransactionId": "7.1672",
"previousServiceCreationTransactionId": "2.1",
"configuration": {
"maximumNodeCertificateValidityDays": 180,
"recentCoseProposalsWindowSize": 100
}
}
}
}
}

31
doc/schemas/gov/2024-07-01/examples/ServiceState_ListMembers.json Normal file
Просмотреть файл

@ -0,0 +1,31 @@
{
"title": "ServiceState_ListMembers",
"operationId": "ServiceState_ListMembers",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"value": [
{
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"status": "Accepted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIBtjCCATygAwIBAgIUQReVbbmYi3jwIKLajvRSSazrlHgwCgYIKoZIzj0EAwMw\nEjEQMA4GA1UEAwwHbWVtYmVyMDAeFw0yMzA1MTcxMzUwMzBaFw0yNDA1MTYxMzUw\nMzBaMBIxEDAOBgNVBAMMB21lbWJlcjAwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQL\nHTNizYCCd+qvH5hMkikWRRb9s3cmD1PIkeoqRIqJ98FF2PgW/cPhM8wyJ3KK8tqS\n7MI6rW8AFgRf2CV3nJ3uNwVrbdgbmmGef8WTyFBXX3VvypntT+jCHDg9HURROAmj\nUzBRMB0GA1UdDgQWBBSljyQ0GfGDm8ODrpcWy364SPRUHjAfBgNVHSMEGDAWgBSl\njyQ0GfGDm8ODrpcWy364SPRUHjAPBgNVHRMBAf8EBTADAQH/MAoGCCqGSM49BAMD\nA2gAMGUCMDUoePU2bJxAt9lXDX0TCQrt1xMBZc5BNvVi2ROEQEKHSetVgzAADzFC\n/8Te+S/+kwIxAJMFEeGSbXaUNxvQLHJehaORV0Bw2FJN+zkb3FAltwlua+REfl/t\nPcn7nq5mpQ0RNQ==\n-----END CERTIFICATE-----\n"
},
{
"memberId": "b9626e3856b3ef3b433e612d59fbb9edd71cfa2efc772bcfbb50aaa9b6e033f7",
"status": "Accepted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIBtTCCATygAwIBAgIUbMeV2BFlZO11PM0FoiuJjmLVSiIwCgYIKoZIzj0EAwMw\nEjEQMA4GA1UEAwwHbWVtYmVyMTAeFw0yMzA1MTcxMzUwMzBaFw0yNDA1MTYxMzUw\nMzBaMBIxEDAOBgNVBAMMB21lbWJlcjEwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAR3\nGPE7tBnEj5MwMMO6y376VQLfPFCVI9+LI4Ndc1ieLRIii+oydrwzthxv10juy+Nl\nSoD67n1y6ehbMB9JKEGMnkBfuZNKuXAqb2h371y2d/jrX/pZmyy3AIICnKYTQ7Oj\nUzBRMB0GA1UdDgQWBBQf2ImVBp4MWgpLz6OlOUY65VGbRTAfBgNVHSMEGDAWgBQf\n2ImVBp4MWgpLz6OlOUY65VGbRTAPBgNVHRMBAf8EBTADAQH/MAoGCCqGSM49BAMD\nA2cAMGQCMDCW/sHEGuxowkv1x1q+/8cRO9YAa3HxASkqz9/MK2r+jyOFawKtaRpc\n7QwvBOkLFwIwEK6Q9aCTrjGkoxITnFmIc+nnv+wh4xRkUNam/nQebMRQSHI9TUXN\n8sQwxjb50U7L\n-----END CERTIFICATE-----\n"
},
{
"memberId": "ecf07a6c69266e14cedea8cfc0049c04201501f5c7ea5cf7180ad56efbd84714",
"status": "Accepted",
"certificate": "-----BEGIN CERTIFICATE-----\nMIIBtjCCATygAwIBAgIUbpzHWRHXRoDOjyqYlFk7itQ5qWgwCgYIKoZIzj0EAwMw\nEjEQMA4GA1UEAwwHbWVtYmVyMjAeFw0yMzA1MTcxMzUwMzBaFw0yNDA1MTYxMzUw\nMzBaMBIxEDAOBgNVBAMMB21lbWJlcjIwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAASA\n4495qU2huzUZHWCf/ovT+C28AlDIaGejvc9qxaRKJ+dXAdZ10C6Z3TMXYGKlpE2K\nCz/VyOMsdwBiN8rJs4L1bLWRh3vZnyoVyp3quq34wc90UINv3lNK8XnxcONtkaGj\nUzBRMB0GA1UdDgQWBBQeZ+IKLpQ4nd3CSxxaj+8X+eV+TTAfBgNVHSMEGDAWgBQe\nZ+IKLpQ4nd3CSxxaj+8X+eV+TTAPBgNVHRMBAf8EBTADAQH/MAoGCCqGSM49BAMD\nA2gAMGUCMGWloVqJ7mvY7bFp5vfSPICnpMUL6sat62Ag/2ZZ1FRqWTXokuqRH2UI\nOJyLpI245QIxAKXY58sTZIVzlXkYGp0z3TrTkVQ/pipWD7MpNzr1+7afQWj1Dw+r\npznvF6OHoz0fTA==\n-----END CERTIFICATE-----\n"
}
],
"nextLink": "https://microsoft.com/ak"
}
}
}
}

2
doc/schemas/mccf/2023-06-01-preview/examples/ServiceState_ListNodes.json → doc/schemas/gov/2024-07-01/examples/ServiceState_ListNodes.json
Просмотреть файл

@ -2,7 +2,7 @@
"title": "ServiceState_ListNodes",
"operationId": "ServiceState_ListNodes",
"parameters": {
"api-version": "2023-06-01-preview"
"api-version": "2024-07-01"
},
"responses": {
"200": {

18
doc/schemas/gov/2024-07-01/examples/Shares_Submit.json Normal file
Просмотреть файл

@ -0,0 +1,18 @@
{
"title": "Shares_Submit",
"operationId": "Shares_Submit",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"body": "{binary COSE Sign1}"
},
"responses": {
"200": {
"body": {
"message": "3/3 recovery shares successfully submitted.",
"submittedCount": 0,
"recoveryThreshold": 0
}
}
}
}

12
doc/schemas/gov/2024-07-01/examples/StateDigests_Acknowledge.json Normal file
Просмотреть файл

@ -0,0 +1,12 @@
{
"title": "StateDigests_Acknowledge",
"operationId": "StateDigests_Acknowledge",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"body": "{binary COSE Sign1}"
},
"responses": {
"204": {}
}
}

16
doc/schemas/gov/2024-07-01/examples/StateDigests_Get.json Normal file
Просмотреть файл

@ -0,0 +1,16 @@
{
"title": "StateDigests_Get",
"operationId": "StateDigests_Get",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970"
},
"responses": {
"200": {
"body": {
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"stateDigest": "1cdc59855bb6b7edee42769ca3767bc9684b7a62ffcfcb8751a75dbe71c28e49"
}
}
}
}

17
doc/schemas/gov/2024-07-01/examples/StateDigests_Update.json Normal file
Просмотреть файл

@ -0,0 +1,17 @@
{
"title": "StateDigests_Update",
"operationId": "StateDigests_Update",
"parameters": {
"api-version": "2024-07-01",
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"body": "{binary COSE Sign1}"
},
"responses": {
"200": {
"body": {
"memberId": "f8ac7c60c164f7f13c04ba41645b18eabcc55a8f799c83a90d001f4e89907970",
"stateDigest": "1cdc59855bb6b7edee42769ca3767bc9684b7a62ffcfcb8751a75dbe71c28e49"
}
}
}
}

15
doc/schemas/gov/2024-07-01/examples/Transactions_Get.json Normal file
Просмотреть файл

@ -0,0 +1,15 @@
{
"title": "Transactions_Get",
"operationId": "Transactions_Get",
"parameters": {
"api-version": "2024-07-01",
"transactionId": "2.42"
},
"responses": {
"200": {
"body": {
"status": "Committed"
}
}
}
}

15
doc/schemas/gov/2024-07-01/examples/Transactions_GetCommit.json Normal file
Просмотреть файл

@ -0,0 +1,15 @@
{
"title": "Transactions_GetCommit",
"operationId": "Transactions_GetCommit",
"parameters": {
"api-version": "2024-07-01"
},
"responses": {
"200": {
"body": {
"status": "Committed",
"transactionId": "7.2385"
}
}
}
}

2455
doc/schemas/gov/2024-07-01/gov.json Normal file
Просмотреть файл

Разница между файлами не показана из-за своего большого размера Загрузить разницу

3
src/node/gov/api_schema.h.in
Просмотреть файл

@ -18,6 +18,9 @@ namespace ccf::gov::endpoints::schema
static constexpr auto v2023_06_01_preview =
R"!!!(@GOV_API_SCHEMA_2023_06_01_PREVIEW@)!!!";
static constexpr auto v2024_07_01 =
R"!!!(@GOV_API_SCHEMA_2024_07_01@)!!!";
#pragma clang diagnostic pop
// clang-format on

56
src/node/gov/api_version.h
Просмотреть файл

@ -12,30 +12,38 @@ namespace ccf::gov::endpoints
enum class ApiVersion
{
preview_v1,
MIN = preview_v1,
v1,
};
static constexpr std::pair<ApiVersion, char const*> api_version_strings[] = {
{ApiVersion::preview_v1, "2023-06-01-preview"}};
{ApiVersion::preview_v1, "2023-06-01-preview"},
{ApiVersion::v1, "2024-07-01"}};
std::optional<ApiVersion> get_api_version(
ccf::endpoints::CommandEndpointContext& ctx)
ccf::endpoints::CommandEndpointContext& ctx,
ApiVersion min_accepted,
// Optional out-parameter indicating why API version wasn't found
const char** error_code = nullptr)
{
static std::string accepted_versions_suffix = "";
if (accepted_versions_suffix.empty())
std::string accepted_versions_suffix = "The supported api-versions are: ";
auto first = true;
for (const auto& p : api_version_strings)
{
accepted_versions_suffix = "The supported api-versions are: ";
auto first = true;
for (const auto& p : api_version_strings)
if (p.first < min_accepted)
{
if (first)
{
accepted_versions_suffix += p.second;
first = false;
}
else
{
accepted_versions_suffix += fmt::format(", {}", p.second);
}
continue;
}
if (first)
{
accepted_versions_suffix += p.second;
first = false;
}
else
{
accepted_versions_suffix += fmt::format(", {}", p.second);
}
}
@ -53,6 +61,10 @@ namespace ccf::gov::endpoints
"requests. {}",
param_name,
accepted_versions_suffix));
if (error_code != nullptr)
{
*error_code = ccf::errors::MissingApiVersionParameter;
}
return std::nullopt;
}
@ -60,7 +72,7 @@ namespace ccf::gov::endpoints
std::begin(api_version_strings),
std::end(api_version_strings),
[&qit](const auto& p) { return p.second == qit->second; });
if (it == std::end(api_version_strings))
if (it == std::end(api_version_strings) || it->first < min_accepted)
{
auto message = fmt::format(
"Unsupported api-version '{}'. {}",
@ -70,6 +82,10 @@ namespace ccf::gov::endpoints
HTTP_STATUS_BAD_REQUEST,
ccf::errors::UnsupportedApiVersionValue,
std::move(message));
if (error_code != nullptr)
{
*error_code = ccf::errors::UnsupportedApiVersionValue;
}
return std::nullopt;
}
@ -82,10 +98,10 @@ namespace ccf::gov::endpoints
// without validating the given API version, so long as the behaviour is the
// same for *all* accepted versions.
template <typename Fn>
auto api_version_adapter(Fn&& f)
auto api_version_adapter(Fn&& f, ApiVersion min_accepted = ApiVersion::MIN)
{
return [f](auto& ctx) {
const auto api_version = get_api_version(ctx);
return [f, min_accepted](auto& ctx) {
const auto api_version = get_api_version(ctx, min_accepted);
if (api_version.has_value())
{
f(ctx, api_version.value());

22
src/node/gov/gov_endpoint_registry.h
Просмотреть файл

@ -73,7 +73,10 @@ namespace ccf
void api_endpoint(ccf::endpoints::ReadOnlyEndpointContext& ctx) override
{
using namespace ccf::gov::endpoints;
const auto api_version = get_api_version(ctx);
const char* error_code = nullptr;
const auto api_version =
get_api_version(ctx, ApiVersion::MIN, &error_code);
if (api_version.has_value())
{
switch (api_version.value())
@ -87,10 +90,27 @@ namespace ccf
ctx.rpc_ctx->set_response_status(HTTP_STATUS_OK);
break;
}
case ApiVersion::v1:
{
ctx.rpc_ctx->set_response_body(schema::v2024_07_01);
ctx.rpc_ctx->set_response_header(
http::headers::CONTENT_TYPE,
http::headervalues::contenttype::JSON);
ctx.rpc_ctx->set_response_status(HTTP_STATUS_OK);
break;
}
}
}
else
{
// If an _invalid_ API version was passed, then an error response has
// already been populated
if (error_code == ccf::errors::UnsupportedApiVersionValue)
{
return;
}
// Else (API version parameter was missing) return the classic API
CommonEndpointRegistry::api_endpoint(ctx);
}
}

3
src/node/gov/handlers/acks.h
Просмотреть файл

@ -19,6 +19,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
// Get memberId from path parameter
@ -74,6 +75,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
// Get memberId from path parameter
@ -161,6 +163,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
// Get memberId from path parameter

7
src/node/gov/handlers/proposals.h
Просмотреть файл

@ -394,6 +394,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
const auto& cose_ident =
@ -664,6 +665,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
const auto& cose_ident =
@ -758,6 +760,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::ProposalId proposal_id;
@ -801,6 +804,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto proposal_info_handle =
@ -838,6 +842,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::ProposalId proposal_id;
@ -882,6 +887,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
const auto& cose_ident =
@ -1054,6 +1060,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::ProposalId proposal_id;

2
src/node/gov/handlers/recovery.h
Просмотреть файл

@ -19,6 +19,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::MemberId member_id;
@ -64,6 +65,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
if (

114
src/node/gov/handlers/service_state.h
Просмотреть файл

@ -142,6 +142,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto constitution_handle =
@ -181,6 +182,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -272,6 +274,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -325,7 +328,108 @@ namespace ccf::gov::endpoints
.make_read_only_endpoint(
"/service/javascript-app",
HTTP_GET,
api_version_adapter(get_javascript_app),
api_version_adapter(get_javascript_app, ApiVersion::v1),
no_auth_required)
.set_openapi_hidden(true)
.install();
auto get_javascript_modules = [&](auto& ctx, ApiVersion api_version) {
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
{
auto module_list = nlohmann::json::array();
auto modules_handle =
ctx.tx.template ro<ccf::Modules>(ccf::Tables::MODULES);
modules_handle->foreach_key(
[&module_list](const std::string& module_name) {
auto entry = nlohmann::json::object();
entry["moduleName"] = module_name;
module_list.push_back(entry);
return true;
});
response_body["value"] = module_list;
}
ctx.rpc_ctx->set_response_json(response_body, HTTP_STATUS_OK);
return;
}
}
};
registry
.make_read_only_endpoint(
"/service/javascript-modules",
HTTP_GET,
api_version_adapter(get_javascript_modules, ApiVersion::v1),
no_auth_required)
.set_openapi_hidden(true)
.install();
auto get_javascript_module_by_name =
[&](auto& ctx, ApiVersion api_version) {
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
std::string module_name;
{
std::string error;
if (!ccf::endpoints::get_path_param(
ctx.rpc_ctx->get_request_path_params(),
"moduleName",
module_name,
error))
{
detail::set_gov_error(
ctx.rpc_ctx,
HTTP_STATUS_BAD_REQUEST,
ccf::errors::InvalidResourceName,
std::move(error));
return;
}
}
module_name = ::http::url_decode(module_name);
auto modules_handle =
ctx.tx.template ro<ccf::Modules>(ccf::Tables::MODULES);
auto module = modules_handle->get(module_name);
if (!module.has_value())
{
detail::set_gov_error(
ctx.rpc_ctx,
HTTP_STATUS_NOT_FOUND,
ccf::errors::ResourceNotFound,
fmt::format("Module {} does not exist.", module_name));
return;
}
// Return raw JS module content in body
ctx.rpc_ctx->set_response_status(HTTP_STATUS_OK);
ctx.rpc_ctx->set_response_body(std::move(module.value()));
ctx.rpc_ctx->set_response_header(
ccf::http::headers::CONTENT_TYPE,
http::headervalues::contenttype::JAVASCRIPT);
return;
}
}
};
registry
.make_read_only_endpoint(
"/service/javascript-modules/{moduleName}",
HTTP_GET,
api_version_adapter(get_javascript_module_by_name, ApiVersion::v1),
no_auth_required)
.set_openapi_hidden(true)
.install();
@ -334,6 +438,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -424,6 +529,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -531,6 +637,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -579,6 +686,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::MemberId member_id;
@ -630,6 +738,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -671,6 +780,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::UserId user_id;
@ -717,6 +827,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
auto response_body = nlohmann::json::object();
@ -759,6 +870,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
ccf::NodeId node_id;

2
src/node/gov/handlers/transactions.h
Просмотреть файл

@ -16,6 +16,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
// Extract transaction ID from path parameter
@ -89,6 +90,7 @@ namespace ccf::gov::endpoints
switch (api_version)
{
case ApiVersion::preview_v1:
case ApiVersion::v1:
default:
{
// Lookup committed

8
tests/infra/clients.py
Просмотреть файл

@ -36,8 +36,9 @@ import infra.commit
from infra.log_capture import flush_info
import ccf.cose
API_VERSION_PREVIEW_01 = "2023-06-01-preview"
API_VERSION_CLASSIC = "classic"
API_VERSION_PREVIEW_01 = "2023-06-01-preview"
API_VERSION_01 = "2024-07-01"
class OffSettableSecondsSinceEpoch:
@ -1284,7 +1285,10 @@ class APIVersionedCCFClient(CCFClient):
def __init__(self, *args, api_version=None, **kwargs):
super(APIVersionedCCFClient, self).__init__(*args, **kwargs)
self.api_version = api_version
if self.api_version == API_VERSION_PREVIEW_01:
if self.api_version in (
API_VERSION_PREVIEW_01,
API_VERSION_01,
):
self.client_impl.cose_header_builder = cose_protected_headers_api_v1
else:
LOG.error(

1
tests/infra/consortium.py
Просмотреть файл

@ -143,6 +143,7 @@ class Consortium:
def set_gov_api_version(self, version_s):
for cls in (
infra.member.MemberAPI.Preview_v1,
infra.member.MemberAPI.v1,
infra.member.MemberAPI.Classic,
):
if version_s == cls.API_VERSION:

2
tests/infra/e2e_args.py
Просмотреть файл

@ -424,7 +424,7 @@ def cli_args(
"--gov-api-version",
help="api-version to be used for accessing /gov endpoints",
type=str,
default=infra.clients.API_VERSION_PREVIEW_01,
default=infra.clients.API_VERSION_01,
)
add(parser)

10
tests/infra/member.py
Просмотреть файл

@ -38,9 +38,7 @@ class MemberStatus(Enum):
class MemberAPI:
class Preview_v1:
API_VERSION = infra.clients.API_VERSION_PREVIEW_01
class v1_Base:
def propose(self, member, remote_node, proposal):
with remote_node.api_versioned_client(
*member.auth(write=True),
@ -133,6 +131,12 @@ class MemberAPI:
raise NoRecoveryShareFound(r)
return r.body.json()["encryptedShare"]
class Preview_v1(v1_Base):
API_VERSION = infra.clients.API_VERSION_PREVIEW_01
class v1(v1_Base):
API_VERSION = infra.clients.API_VERSION_01
class Classic:
API_VERSION = infra.clients.API_VERSION_CLASSIC

37
tests/js-modules/modules.py
Просмотреть файл

@ -12,6 +12,7 @@ import infra.net
import infra.e2e_args
import infra.crypto
import suite.test_requirements as reqs
import urllib.parse
from e2e_logging import test_multi_auth
from npm_tests import build_npm_app, deploy_npm_app, test_npm_app, validate_openapi
@ -38,6 +39,41 @@ def test_module_import(network, args):
return network
@reqs.description("Test module access")
def test_module_access(network, args):
primary, _ = network.find_nodes()
bundle_dir = os.path.join(THIS_DIR, "basic-module-import")
bundle = network.consortium.read_bundle_from_dir(bundle_dir)
network.consortium.set_js_app_from_bundle(primary, bundle)
expected_modules = bundle["modules"]
with primary.api_versioned_client(api_version=args.gov_api_version) as c:
r = c.get("/gov/service/javascript-modules")
assert r.status_code == http.HTTPStatus.OK, r.status_code
modules = [e["moduleName"] for e in r.body.json()["value"]]
assert len(modules) == len(expected_modules)
for module_def in expected_modules:
raw_name = module_def["name"]
norm_name = f"/{raw_name}"
assert norm_name in modules, f"{norm_name} not in {modules}"
r = c.get(
f"/gov/service/javascript-modules/{urllib.parse.quote_plus(norm_name)}"
)
assert r.status_code == http.HTTPStatus.OK, r
content = r.body.text()
assert content == module_def["module"]
return network
@reqs.description("Test module bytecode caching")
@reqs.installed_package("libjs_generic")
def test_bytecode_cache(network, args):
@ -424,6 +460,7 @@ def run(args):
network = test_js_exception_output(network, args)
network = test_module_import(network, args)
network = test_module_access(network, args)
network = test_bytecode_cache(network, args)
network = test_app_bundle(network, args)
network = test_dynamic_endpoints(network, args)

58
tests/schema.py
Просмотреть файл

@ -11,6 +11,7 @@ import openapi_spec_validator
from packaging import version
from infra.runner import ConcurrentRunner
import nobuiltins
import packaging.version
import e2e_tutorial
import e2e_operations
@ -30,10 +31,7 @@ def run(args):
documents_valid = True
all_methods = []
def fetch_schema(client, prefix, file_prefix=None):
if file_prefix is None:
file_prefix = prefix
api_response = client.get(f"/{prefix}/api")
def fetch_schema(api_response, target_file_path):
check(
api_response, error=lambda status, msg: status == http.HTTPStatus.OK.value
)
@ -44,9 +42,7 @@ def run(args):
fetched_version = response_body["info"]["version"]
formatted_schema = json.dumps(response_body, indent=2)
openapi_target_file = os.path.join(
args.schema_dir, f"{file_prefix}_openapi.json"
)
openapi_target_file = os.path.join(args.schema_dir, target_file_path)
try:
old_schema.remove(openapi_target_file)
@ -55,15 +51,26 @@ def run(args):
with open(openapi_target_file, "a+", encoding="utf-8") as f:
f.seek(0)
previous = f.read()
previous = f.read().strip()
if previous != formatted_schema:
file_version = "0.0.0"
try:
from_file = json.loads(previous)
file_version = from_file["info"]["version"]
except (json.JSONDecodeError, KeyError):
file_version = version.parse(file_version)
except (
json.JSONDecodeError,
KeyError,
packaging.version.InvalidVersion,
):
pass
if version.parse(fetched_version) > version.parse(file_version):
try:
fetched_version = version.parse(fetched_version)
except packaging.version.InvalidVersion:
pass
if fetched_version > file_version:
LOG.debug(
f"Writing schema to {openapi_target_file} - overwriting {file_version} with {fetched_version}"
)
@ -74,9 +81,8 @@ def run(args):
LOG.error(
f"Found differences in {openapi_target_file}, but not overwriting as retrieved version is not newer ({fetched_version} <= {file_version})"
)
alt_file = os.path.join(
args.schema_dir, f"{file_prefix}_{fetched_version}_openapi.json"
)
prefix, ext = os.path.splitext(openapi_target_file)
alt_file = f"{prefix}_{fetched_version}{ext}"
LOG.error(f"Writing to {alt_file} for comparison")
with open(alt_file, "w", encoding="utf-8") as f2:
f2.write(formatted_schema)
@ -105,19 +111,33 @@ def run(args):
check = infra.checker.Checker()
with primary.client("user0") as user_client:
with primary.client() as client:
LOG.info("user frontend")
if not fetch_schema(user_client, "app"):
if not fetch_schema(client.get("/app/api"), "app_openapi.json"):
documents_valid = False
with primary.client() as node_client:
LOG.info("node frontend")
if not fetch_schema(node_client, "node"):
if not fetch_schema(client.get("/node/api"), "node_openapi.json"):
documents_valid = False
with primary.client("member0") as member_client:
LOG.info("member frontend")
if not fetch_schema(member_client, "gov"):
if not fetch_schema(client.get("/gov/api"), "gov_openapi.json"):
documents_valid = False
with primary.api_versioned_client(
api_version=infra.clients.API_VERSION_PREVIEW_01
) as client:
LOG.info("gov API - preview v1")
if not fetch_schema(
client.get("/gov/api"), "gov/2023-06-01-preview/gov.json"
):
documents_valid = False
with primary.api_versioned_client(
api_version=infra.clients.API_VERSION_01
) as client:
LOG.info("gov API - v1")
if not fetch_schema(client.get("/gov/api"), "gov/2024-07-01/gov.json"):
documents_valid = False
made_changes = False