@greenpandastudios/aug-cli 0.19.0
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.
- package/LICENSE +21 -0
- package/README.md +13 -0
- package/THIRD_PARTY_NOTICES.md +18 -0
- package/bin/aug.mjs +3 -0
- package/docs/api/crypto.md +351 -0
- package/docs/api/io.md +207 -0
- package/docs/api/json.md +21 -0
- package/docs/api/memory.md +109 -0
- package/docs/api/time.md +54 -0
- package/docs/api/web.md +184 -0
- package/docs/assets/benchmarks/execution.svg +2978 -0
- package/docs/assets/benchmarks/http.svg +1674 -0
- package/docs/assets/benchmarks/improvements.svg +2315 -0
- package/docs/assets/benchmarks/memory.svg +1891 -0
- package/docs/benchmark-baseline.json +1087 -0
- package/docs/benchmark-results.json +91123 -0
- package/docs/benchmarks.json +38 -0
- package/docs/compatibility.md +42 -0
- package/docs/concurrency-implementation.md +18 -0
- package/docs/diagnostics.md +97 -0
- package/docs/docker.md +35 -0
- package/docs/example-projects.json +26 -0
- package/docs/examples/approved-design/counters.md +253 -0
- package/docs/examples/approved-design/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/approved-design/domain/app.md +165 -0
- package/docs/examples/approved-design/domain/export.md +83 -0
- package/docs/examples/approved-design/domain/models.md +80 -0
- package/docs/examples/approved-design/domain/numbers.md +248 -0
- package/docs/examples/approved-design/index.md +39 -0
- package/docs/examples/approved-design/main-yaml.md +24 -0
- package/docs/examples/approved-design/main.md +215 -0
- package/docs/examples/benchmark/index.md +33 -0
- package/docs/examples/benchmark/main-yaml.md +17 -0
- package/docs/examples/benchmark/main.md +117 -0
- package/docs/examples/cli-args/index.md +32 -0
- package/docs/examples/cli-args/main.md +107 -0
- package/docs/examples/collections/index.md +32 -0
- package/docs/examples/collections/main.md +118 -0
- package/docs/examples/collections-benchmark/index.md +34 -0
- package/docs/examples/collections-benchmark/main.md +115 -0
- package/docs/examples/cpu-benchmark/index.md +34 -0
- package/docs/examples/cpu-benchmark/main.md +90 -0
- package/docs/examples/developer-workflow/calculator.md +357 -0
- package/docs/examples/developer-workflow/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/developer-workflow/index.md +37 -0
- package/docs/examples/developer-workflow/logging/console.md +124 -0
- package/docs/examples/developer-workflow/logging/export.md +70 -0
- package/docs/examples/developer-workflow/logging/logger.md +111 -0
- package/docs/examples/developer-workflow/main.md +172 -0
- package/docs/examples/drop/index.md +33 -0
- package/docs/examples/drop/main.md +85 -0
- package/docs/examples/drop/resource.md +95 -0
- package/docs/examples/errors/errors.md +85 -0
- package/docs/examples/errors/index.md +33 -0
- package/docs/examples/errors/main.md +92 -0
- package/docs/examples/ffi/index.md +33 -0
- package/docs/examples/ffi/main.md +75 -0
- package/docs/examples/ffi/native.md +93 -0
- package/docs/examples/generic-di/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/generic-di/index.md +33 -0
- package/docs/examples/generic-di/main.md +111 -0
- package/docs/examples/generic-di/types.md +180 -0
- package/docs/examples/generics/index.md +33 -0
- package/docs/examples/generics/main.md +120 -0
- package/docs/examples/generics/types.md +189 -0
- package/docs/examples/hello/app/export.md +67 -0
- package/docs/examples/hello/app/greeter.md +190 -0
- package/docs/examples/hello/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/hello/index.md +37 -0
- package/docs/examples/hello/logging/console.md +121 -0
- package/docs/examples/hello/logging/export.md +71 -0
- package/docs/examples/hello/logging/logger.md +120 -0
- package/docs/examples/hello/main.md +115 -0
- package/docs/examples/http-benchmark/index.md +35 -0
- package/docs/examples/http-benchmark/main.md +79 -0
- package/docs/examples/http-benchmark/routes.md +88 -0
- package/docs/examples/index.md +60 -0
- package/docs/examples/interceptors/app.md +250 -0
- package/docs/examples/interceptors/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/interceptors/index.md +35 -0
- package/docs/examples/interceptors/interceptors.md +284 -0
- package/docs/examples/interceptors/logging.md +155 -0
- package/docs/examples/interceptors/main.md +162 -0
- package/docs/examples/json-benchmark/data.md +71 -0
- package/docs/examples/json-benchmark/dependencies/august/0.19.0/json/contracts.md +103 -0
- package/docs/examples/json-benchmark/index.md +35 -0
- package/docs/examples/json-benchmark/main.md +131 -0
- package/docs/examples/new-syntax/console.md +118 -0
- package/docs/examples/new-syntax/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/new-syntax/greeter.md +145 -0
- package/docs/examples/new-syntax/index.md +36 -0
- package/docs/examples/new-syntax/logger.md +111 -0
- package/docs/examples/new-syntax/main.md +135 -0
- package/docs/examples/new-syntax/math.md +79 -0
- package/docs/examples/oidc-login/client/contracts.md +151 -0
- package/docs/examples/oidc-login/client/endpoints.md +263 -0
- package/docs/examples/oidc-login/client/export.md +107 -0
- package/docs/examples/oidc-login/client/login.md +515 -0
- package/docs/examples/oidc-login/client/logout.md +249 -0
- package/docs/examples/oidc-login/client/protocol.md +595 -0
- package/docs/examples/oidc-login/client/session.md +297 -0
- package/docs/examples/oidc-login/client/views.md +144 -0
- package/docs/examples/oidc-login/common/export.md +115 -0
- package/docs/examples/oidc-login/common/headers.md +162 -0
- package/docs/examples/oidc-login/common/keys.md +336 -0
- package/docs/examples/oidc-login/common/settings.md +116 -0
- package/docs/examples/oidc-login/common/views.md +103 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/crypto/contracts.md +925 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/crypto/jose.md +434 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/json/contracts.md +103 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/memory/store.md +374 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/time/contracts.md +150 -0
- package/docs/examples/oidc-login/dependencies/august/0.19.0/web/contracts.md +532 -0
- package/docs/examples/oidc-login/index.md +57 -0
- package/docs/examples/oidc-login/main-yaml.md +28 -0
- package/docs/examples/oidc-login/main.md +283 -0
- package/docs/examples/oidc-login/provider/authorization.md +457 -0
- package/docs/examples/oidc-login/provider/contracts.md +267 -0
- package/docs/examples/oidc-login/provider/credentials.md +148 -0
- package/docs/examples/oidc-login/provider/discovery.md +215 -0
- package/docs/examples/oidc-login/provider/export.md +131 -0
- package/docs/examples/oidc-login/provider/token.md +364 -0
- package/docs/examples/oidc-login/provider/userinfo.md +228 -0
- package/docs/examples/oidc-login/provider/views.md +137 -0
- package/docs/examples/ownership/counter.md +140 -0
- package/docs/examples/ownership/index.md +33 -0
- package/docs/examples/ownership/main.md +90 -0
- package/docs/examples/ownership-transfer/dependencies/august/0.19.0/io/contracts.md +395 -0
- package/docs/examples/ownership-transfer/index.md +33 -0
- package/docs/examples/ownership-transfer/main.md +125 -0
- package/docs/examples/ownership-transfer/resource.md +150 -0
- package/docs/examples/packages-app/dependencies/packages/@example/aug-math/0.1.0/arithmetic.md +117 -0
- package/docs/examples/packages-app/index.md +34 -0
- package/docs/examples/packages-app/main-yaml.md +18 -0
- package/docs/examples/packages-app/main.md +80 -0
- package/docs/examples/packages-math/aug-package-json.md +24 -0
- package/docs/examples/packages-math/index.md +36 -0
- package/docs/examples/packages-math/package-json.md +25 -0
- package/docs/examples/packages-math/src/arithmetic.md +121 -0
- package/docs/examples/packages-math/src/export.md +63 -0
- package/docs/examples/startup-benchmark/index.md +34 -0
- package/docs/examples/startup-benchmark/main.md +68 -0
- package/docs/examples/visibility/counter.md +142 -0
- package/docs/examples/visibility/index.md +33 -0
- package/docs/examples/visibility/main.md +96 -0
- package/docs/examples.json +47 -0
- package/docs/getting-started.md +5 -0
- package/docs/grammar.md +136 -0
- package/docs/implementation-map.md +106 -0
- package/docs/index.md +46 -0
- package/docs/language-conformance.md +30 -0
- package/docs/language-constructs.md +1461 -0
- package/docs/language-design-audit.md +147 -0
- package/docs/maintaining-docs.md +43 -0
- package/docs/packages.md +184 -0
- package/docs/performance.md +535 -0
- package/docs/production-readiness.md +39 -0
- package/docs/reference.md +361 -0
- package/docs/release-review.md +23 -0
- package/docs/releasing.md +79 -0
- package/docs/roadmap.md +13 -0
- package/docs/specifications.md +86 -0
- package/docs/testing.md +120 -0
- package/docs/tooling.md +197 -0
- package/docs/web-implementation-plan.md +39 -0
- package/docs/web-library-gaps.md +27 -0
- package/docs/web.md +197 -0
- package/examples/approved-design/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/approved-design/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/approved-design/.aug-spec/manifest.json +14 -0
- package/examples/approved-design/counters.aug +22 -0
- package/examples/approved-design/counters.aug.md +177 -0
- package/examples/approved-design/domain/app.aug +12 -0
- package/examples/approved-design/domain/app.aug.md +97 -0
- package/examples/approved-design/domain/export.aug +5 -0
- package/examples/approved-design/domain/export.aug.md +25 -0
- package/examples/approved-design/domain/models.aug +2 -0
- package/examples/approved-design/domain/models.aug.md +30 -0
- package/examples/approved-design/domain/numbers.aug +29 -0
- package/examples/approved-design/domain/numbers.aug.md +141 -0
- package/examples/approved-design/main.aug +26 -0
- package/examples/approved-design/main.aug.md +108 -0
- package/examples/approved-design/main.yaml +8 -0
- package/examples/benchmark/.aug-spec/manifest.json +7 -0
- package/examples/benchmark/main.aug +17 -0
- package/examples/benchmark/main.aug.md +43 -0
- package/examples/benchmark/main.yaml +1 -0
- package/examples/cli-args/.aug-spec/manifest.json +7 -0
- package/examples/cli-args/main.aug +15 -0
- package/examples/cli-args/main.aug.md +38 -0
- package/examples/collections/.aug-spec/manifest.json +7 -0
- package/examples/collections/main.aug +18 -0
- package/examples/collections/main.aug.md +43 -0
- package/examples/developer-workflow/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/developer-workflow/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/developer-workflow/.aug-spec/manifest.json +13 -0
- package/examples/developer-workflow/calculator.aug +55 -0
- package/examples/developer-workflow/calculator.aug.md +228 -0
- package/examples/developer-workflow/logging/console.aug +8 -0
- package/examples/developer-workflow/logging/console.aug.md +67 -0
- package/examples/developer-workflow/logging/export.aug +2 -0
- package/examples/developer-workflow/logging/export.aug.md +19 -0
- package/examples/developer-workflow/logging/logger.aug +6 -0
- package/examples/developer-workflow/logging/logger.aug.md +57 -0
- package/examples/developer-workflow/main.aug +25 -0
- package/examples/developer-workflow/main.aug.md +79 -0
- package/examples/drop/.aug-spec/manifest.json +8 -0
- package/examples/drop/main.aug +3 -0
- package/examples/drop/main.aug.md +35 -0
- package/examples/drop/resource.aug +8 -0
- package/examples/drop/resource.aug.md +44 -0
- package/examples/errors/.aug-spec/manifest.json +8 -0
- package/examples/errors/errors.aug +6 -0
- package/examples/errors/errors.aug.md +33 -0
- package/examples/errors/main.aug +7 -0
- package/examples/errors/main.aug.md +36 -0
- package/examples/ffi/.aug-spec/manifest.json +8 -0
- package/examples/ffi/main.aug +2 -0
- package/examples/ffi/main.aug.md +27 -0
- package/examples/ffi/native.aug +6 -0
- package/examples/ffi/native.aug.md +43 -0
- package/examples/generic-di/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/generic-di/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/generic-di/.aug-spec/manifest.json +10 -0
- package/examples/generic-di/main.aug +9 -0
- package/examples/generic-di/main.aug.md +49 -0
- package/examples/generic-di/types.aug +17 -0
- package/examples/generic-di/types.aug.md +124 -0
- package/examples/generics/.aug-spec/manifest.json +8 -0
- package/examples/generics/main.aug +9 -0
- package/examples/generics/main.aug.md +58 -0
- package/examples/generics/types.aug +19 -0
- package/examples/generics/types.aug.md +132 -0
- package/examples/hello/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/hello/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/hello/.aug-spec/manifest.json +14 -0
- package/examples/hello/app/export.aug +1 -0
- package/examples/hello/app/export.aug.md +17 -0
- package/examples/hello/app/greeter.aug +22 -0
- package/examples/hello/app/greeter.aug.md +109 -0
- package/examples/hello/logging/console.aug +7 -0
- package/examples/hello/logging/console.aug.md +65 -0
- package/examples/hello/logging/export.aug +2 -0
- package/examples/hello/logging/export.aug.md +19 -0
- package/examples/hello/logging/logger.aug +9 -0
- package/examples/hello/logging/logger.aug.md +59 -0
- package/examples/hello/main.aug +9 -0
- package/examples/hello/main.aug.md +49 -0
- package/examples/interceptors/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/interceptors/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/interceptors/.aug-spec/manifest.json +12 -0
- package/examples/interceptors/app.aug +28 -0
- package/examples/interceptors/app.aug.md +162 -0
- package/examples/interceptors/interceptors.aug +40 -0
- package/examples/interceptors/interceptors.aug.md +180 -0
- package/examples/interceptors/logging.aug +12 -0
- package/examples/interceptors/logging.aug.md +96 -0
- package/examples/interceptors/main.aug +22 -0
- package/examples/interceptors/main.aug.md +76 -0
- package/examples/new-syntax/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/new-syntax/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/new-syntax/.aug-spec/manifest.json +13 -0
- package/examples/new-syntax/console.aug +7 -0
- package/examples/new-syntax/console.aug.md +63 -0
- package/examples/new-syntax/greeter.aug +10 -0
- package/examples/new-syntax/greeter.aug.md +89 -0
- package/examples/new-syntax/logger.aug +6 -0
- package/examples/new-syntax/logger.aug.md +57 -0
- package/examples/new-syntax/main.aug +12 -0
- package/examples/new-syntax/main.aug.md +64 -0
- package/examples/new-syntax/math.aug +3 -0
- package/examples/new-syntax/math.aug.md +29 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/contracts.aug +73 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/contracts.aug.md +791 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/jose.aug +68 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/jose.aug.md +266 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/json/contracts.aug +6 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/json/contracts.aug.md +55 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/memory/store.aug +45 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/memory/store.aug.md +250 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/time/contracts.aug +11 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/time/contracts.aug.md +96 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/web/contracts.aug +58 -0
- package/examples/oidc-login/.aug-spec/august/0.19.0/web/contracts.aug.md +420 -0
- package/examples/oidc-login/.aug-spec/manifest.json +40 -0
- package/examples/oidc-login/README.md +29 -0
- package/examples/oidc-login/client/contracts.aug +7 -0
- package/examples/oidc-login/client/contracts.aug.md +80 -0
- package/examples/oidc-login/client/endpoints.aug +21 -0
- package/examples/oidc-login/client/endpoints.aug.md +161 -0
- package/examples/oidc-login/client/export.aug +7 -0
- package/examples/oidc-login/client/export.aug.md +29 -0
- package/examples/oidc-login/client/login.aug +58 -0
- package/examples/oidc-login/client/login.aug.md +331 -0
- package/examples/oidc-login/client/logout.aug +18 -0
- package/examples/oidc-login/client/logout.aug.md +150 -0
- package/examples/oidc-login/client/protocol.aug +106 -0
- package/examples/oidc-login/client/protocol.aug.md +326 -0
- package/examples/oidc-login/client/session.aug +34 -0
- package/examples/oidc-login/client/session.aug.md +155 -0
- package/examples/oidc-login/client/views.aug +21 -0
- package/examples/oidc-login/client/views.aug.md +68 -0
- package/examples/oidc-login/common/export.aug +9 -0
- package/examples/oidc-login/common/export.aug.md +33 -0
- package/examples/oidc-login/common/headers.aug +11 -0
- package/examples/oidc-login/common/headers.aug.md +79 -0
- package/examples/oidc-login/common/keys.aug +37 -0
- package/examples/oidc-login/common/keys.aug.md +207 -0
- package/examples/oidc-login/common/settings.aug +4 -0
- package/examples/oidc-login/common/settings.aug.md +47 -0
- package/examples/oidc-login/common/views.aug +16 -0
- package/examples/oidc-login/common/views.aug.md +34 -0
- package/examples/oidc-login/main.aug +39 -0
- package/examples/oidc-login/main.aug.md +166 -0
- package/examples/oidc-login/main.yaml +12 -0
- package/examples/oidc-login/provider/authorization.aug +59 -0
- package/examples/oidc-login/provider/authorization.aug.md +264 -0
- package/examples/oidc-login/provider/contracts.aug +15 -0
- package/examples/oidc-login/provider/contracts.aug.md +193 -0
- package/examples/oidc-login/provider/credentials.aug +10 -0
- package/examples/oidc-login/provider/credentials.aug.md +64 -0
- package/examples/oidc-login/provider/discovery.aug +13 -0
- package/examples/oidc-login/provider/discovery.aug.md +133 -0
- package/examples/oidc-login/provider/export.aug +13 -0
- package/examples/oidc-login/provider/export.aug.md +41 -0
- package/examples/oidc-login/provider/token.aug +37 -0
- package/examples/oidc-login/provider/token.aug.md +223 -0
- package/examples/oidc-login/provider/userinfo.aug +26 -0
- package/examples/oidc-login/provider/userinfo.aug.md +104 -0
- package/examples/oidc-login/provider/views.aug +18 -0
- package/examples/oidc-login/provider/views.aug.md +63 -0
- package/examples/ownership/.aug-spec/manifest.json +8 -0
- package/examples/ownership/counter.aug +14 -0
- package/examples/ownership/counter.aug.md +85 -0
- package/examples/ownership/main.aug +4 -0
- package/examples/ownership/main.aug.md +38 -0
- package/examples/ownership-transfer/.aug-spec/august/0.19.0/io/contracts.aug +36 -0
- package/examples/ownership-transfer/.aug-spec/august/0.19.0/io/contracts.aug.md +316 -0
- package/examples/ownership-transfer/.aug-spec/manifest.json +10 -0
- package/examples/ownership-transfer/main.aug +9 -0
- package/examples/ownership-transfer/main.aug.md +63 -0
- package/examples/ownership-transfer/resource.aug +16 -0
- package/examples/ownership-transfer/resource.aug.md +89 -0
- package/examples/packages/README.md +15 -0
- package/examples/packages/app/.aug-spec/manifest.json +9 -0
- package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug +9 -0
- package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug.md +63 -0
- package/examples/packages/app/main.aug +2 -0
- package/examples/packages/app/main.aug.md +33 -0
- package/examples/packages/app/main.yaml +2 -0
- package/examples/packages/math/.aug-spec/manifest.json +8 -0
- package/examples/packages/math/README.md +3 -0
- package/examples/packages/math/aug-package.json +8 -0
- package/examples/packages/math/package.json +9 -0
- package/examples/packages/math/src/arithmetic.aug +8 -0
- package/examples/packages/math/src/arithmetic.aug.md +63 -0
- package/examples/packages/math/src/export.aug +1 -0
- package/examples/packages/math/src/export.aug.md +17 -0
- package/examples/visibility/.aug-spec/manifest.json +8 -0
- package/examples/visibility/counter.aug +14 -0
- package/examples/visibility/counter.aug.md +87 -0
- package/examples/visibility/main.aug +7 -0
- package/examples/visibility/main.aug.md +39 -0
- package/package.json +50 -0
- package/runtime/aug_crypto.c +121 -0
- package/runtime/aug_html.c +93 -0
- package/runtime/aug_http.c +829 -0
- package/runtime/aug_json.c +165 -0
- package/runtime/aug_runtime.c +792 -0
- package/runtime/aug_runtime.h +245 -0
- package/runtime/aug_tasks.c +172 -0
- package/runtime/aug_time.c +5 -0
- package/runtime/aug_values.c +80 -0
- package/scripts/bootstrap-native.mjs +121 -0
- package/scripts/native-dependencies.lock.json +65 -0
- package/scripts/native-home.mjs +11 -0
- package/src/actions.js +109 -0
- package/src/ast.js +19 -0
- package/src/builtins.js +93 -0
- package/src/checker.js +2896 -0
- package/src/cli.js +344 -0
- package/src/codegen.js +1159 -0
- package/src/config.js +149 -0
- package/src/continuation.js +110 -0
- package/src/di.js +24 -0
- package/src/documentation.js +27 -0
- package/src/editor.js +782 -0
- package/src/effects.js +29 -0
- package/src/fixes.js +222 -0
- package/src/formatter.js +296 -0
- package/src/freshness.js +154 -0
- package/src/help.js +212 -0
- package/src/html.js +27 -0
- package/src/http-policies.js +90 -0
- package/src/inference.js +16 -0
- package/src/interceptors.js +70 -0
- package/src/javadoc.js +67 -0
- package/src/lexer.js +199 -0
- package/src/libraries.js +31 -0
- package/src/lsp.js +180 -0
- package/src/native.js +144 -0
- package/src/navigation.js +162 -0
- package/src/openapi.js +220 -0
- package/src/ownership.js +232 -0
- package/src/package-manager.js +299 -0
- package/src/parser.js +1155 -0
- package/src/policies.js +130 -0
- package/src/project-init.js +19 -0
- package/src/project.js +292 -0
- package/src/schemas.js +62 -0
- package/src/semantic.js +255 -0
- package/src/spec.js +738 -0
- package/src/testing.js +186 -0
- package/src/types.js +10 -0
|
@@ -0,0 +1,434 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "august/0.19.0/crypto/jose.aug · OpenID Connect login application"
|
|
3
|
+
generated: true
|
|
4
|
+
source: "examples/oidc-login/.aug-spec/august/0.19.0/crypto/jose.aug"
|
|
5
|
+
editLink: false
|
|
6
|
+
prev: false
|
|
7
|
+
next: false
|
|
8
|
+
outline: [2, 3]
|
|
9
|
+
search: false
|
|
10
|
+
pageClass: aug-example-page
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# `august/0.19.0/crypto/jose.aug`
|
|
14
|
+
|
|
15
|
+
[OpenID Connect login application](../../../../index.md) · Dependency source and specification
|
|
16
|
+
|
|
17
|
+
This is the exact dependency version used by this example.
|
|
18
|
+
|
|
19
|
+
::::: example-compare
|
|
20
|
+
|
|
21
|
+
:::: example-code
|
|
22
|
+
|
|
23
|
+
## Code {#code}
|
|
24
|
+
|
|
25
|
+
::: code-group
|
|
26
|
+
|
|
27
|
+
```aug [Indentation]
|
|
28
|
+
import Crypto from contracts
|
|
29
|
+
import parse from august.json
|
|
30
|
+
/** A failed JOSE validation reveals no unverified claims. */
|
|
31
|
+
JwtError() implements Error:
|
|
32
|
+
pass
|
|
33
|
+
/** This profile accepts only RS256, a configured key id, and an explicit token type. */
|
|
34
|
+
record JwtHeader(string alg, string kid, string typ)
|
|
35
|
+
/** Public signing-key metadata in RFC 7517 / RFC 7518 form. */
|
|
36
|
+
record RsaJwk(string kty, string kid, string alg, string use, string n, string e)
|
|
37
|
+
record RsaJwks(List<RsaJwk> keys)
|
|
38
|
+
/** Export public parameters. Private key material never enters the JSON document. */
|
|
39
|
+
rsaJwk(RsaPublicKey publicKey, string kid, resolve Crypto crypto) returns RsaJwk uses crypto.exportRsa unless CryptoError:
|
|
40
|
+
(modulus, exponent) = crypto.exportRsa(publicKey)
|
|
41
|
+
return RsaJwk(kty="RSA", kid=kid, alg="RS256", use="sig", n=modulus.base64url(), e=exponent.base64url())
|
|
42
|
+
/** Import only an RSA signing key for RS256. The transport caller selects the trusted JWKS URL. */
|
|
43
|
+
importJwk(RsaJwk jwk, resolve Crypto crypto) returns RsaPublicKey uses crypto.decodeBase64url and crypto.importRsa unless JwtError:
|
|
44
|
+
if jwk.kty != "RSA" or jwk.alg != "RS256" or jwk.use != "sig":
|
|
45
|
+
throw JwtError()
|
|
46
|
+
try:
|
|
47
|
+
modulus = crypto.decodeBase64url(input=jwk.n)
|
|
48
|
+
exponent = crypto.decodeBase64url(input=jwk.e)
|
|
49
|
+
return crypto.importRsa(modulus, exponent)
|
|
50
|
+
catch CryptoError error:
|
|
51
|
+
throw JwtError()
|
|
52
|
+
/** Sign immutable JSON with an explicit key id and token type. Claims are validated by the protocol that consumes the token. */
|
|
53
|
+
signJwt(RsaPrivateKey key, Json claims, string kid, string tokenType, resolve Crypto crypto) returns string uses crypto.signRsa unless JwtError:
|
|
54
|
+
try:
|
|
55
|
+
header = Json(value=JwtHeader(alg="RS256", kid=kid, typ=tokenType)).stringify()
|
|
56
|
+
payload = claims.stringify()
|
|
57
|
+
signing = header.bytes().base64url() + "." + payload.bytes().base64url()
|
|
58
|
+
signature = crypto.signRsa(key=key, input=signing.bytes())
|
|
59
|
+
return signing + "." + signature.base64url()
|
|
60
|
+
catch CryptoError error:
|
|
61
|
+
throw JwtError()
|
|
62
|
+
catch JsonError error:
|
|
63
|
+
throw JwtError()
|
|
64
|
+
/** Verify the signature and configured algorithm, key id, and type before exposing the JSON payload. Never follows token-supplied URLs. */
|
|
65
|
+
verifyJwt(string token, RsaPublicKey publicKey, string kid, string tokenType, resolve Crypto crypto) returns Json uses crypto.decodeBase64url and crypto.verifyRsa unless JwtError:
|
|
66
|
+
if token.length() > 16384:
|
|
67
|
+
throw JwtError()
|
|
68
|
+
parts = token.split(separator=".")
|
|
69
|
+
if parts.length() != 3:
|
|
70
|
+
throw JwtError()
|
|
71
|
+
try:
|
|
72
|
+
first = parts.get(index=0)
|
|
73
|
+
second = parts.get(index=1)
|
|
74
|
+
third = parts.get(index=2)
|
|
75
|
+
header = parse(input=crypto.decodeBase64url(input=first).text()).decode<JwtHeader>()
|
|
76
|
+
if header.alg != "RS256" or header.kid != kid or header.typ != tokenType:
|
|
77
|
+
throw JwtError()
|
|
78
|
+
signature = crypto.decodeBase64url(input=third)
|
|
79
|
+
if not crypto.verifyRsa(publicKey=publicKey, input=(first + "." + second).bytes(), signature=signature):
|
|
80
|
+
throw JwtError()
|
|
81
|
+
return parse(input=crypto.decodeBase64url(input=second).text())
|
|
82
|
+
catch CryptoError error:
|
|
83
|
+
throw JwtError()
|
|
84
|
+
catch ConversionError error:
|
|
85
|
+
throw JwtError()
|
|
86
|
+
catch JsonError error:
|
|
87
|
+
throw JwtError()
|
|
88
|
+
catch IndexError error:
|
|
89
|
+
throw JwtError()
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
```aug [Braces]
|
|
93
|
+
import Crypto from contracts
|
|
94
|
+
import parse from august.json
|
|
95
|
+
/** A failed JOSE validation reveals no unverified claims. */
|
|
96
|
+
JwtError() implements Error {
|
|
97
|
+
pass
|
|
98
|
+
}
|
|
99
|
+
/** This profile accepts only RS256, a configured key id, and an explicit token type. */
|
|
100
|
+
record JwtHeader(string alg, string kid, string typ)
|
|
101
|
+
/** Public signing-key metadata in RFC 7517 / RFC 7518 form. */
|
|
102
|
+
record RsaJwk(string kty, string kid, string alg, string use, string n, string e)
|
|
103
|
+
record RsaJwks(List<RsaJwk> keys)
|
|
104
|
+
/** Export public parameters. Private key material never enters the JSON document. */
|
|
105
|
+
rsaJwk(RsaPublicKey publicKey, string kid, resolve Crypto crypto) returns RsaJwk uses crypto.exportRsa unless CryptoError {
|
|
106
|
+
(modulus, exponent) = crypto.exportRsa(publicKey)
|
|
107
|
+
return RsaJwk(kty="RSA", kid=kid, alg="RS256", use="sig", n=modulus.base64url(), e=exponent.base64url())
|
|
108
|
+
}
|
|
109
|
+
/** Import only an RSA signing key for RS256. The transport caller selects the trusted JWKS URL. */
|
|
110
|
+
importJwk(RsaJwk jwk, resolve Crypto crypto) returns RsaPublicKey uses crypto.decodeBase64url and crypto.importRsa unless JwtError {
|
|
111
|
+
if jwk.kty != "RSA" or jwk.alg != "RS256" or jwk.use != "sig" {
|
|
112
|
+
throw JwtError()
|
|
113
|
+
}
|
|
114
|
+
try {
|
|
115
|
+
modulus = crypto.decodeBase64url(input=jwk.n)
|
|
116
|
+
exponent = crypto.decodeBase64url(input=jwk.e)
|
|
117
|
+
return crypto.importRsa(modulus, exponent)
|
|
118
|
+
}
|
|
119
|
+
catch CryptoError error {
|
|
120
|
+
throw JwtError()
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
/** Sign immutable JSON with an explicit key id and token type. Claims are validated by the protocol that consumes the token. */
|
|
124
|
+
signJwt(RsaPrivateKey key, Json claims, string kid, string tokenType, resolve Crypto crypto) returns string uses crypto.signRsa unless JwtError {
|
|
125
|
+
try {
|
|
126
|
+
header = Json(value=JwtHeader(alg="RS256", kid=kid, typ=tokenType)).stringify()
|
|
127
|
+
payload = claims.stringify()
|
|
128
|
+
signing = header.bytes().base64url() + "." + payload.bytes().base64url()
|
|
129
|
+
signature = crypto.signRsa(key=key, input=signing.bytes())
|
|
130
|
+
return signing + "." + signature.base64url()
|
|
131
|
+
}
|
|
132
|
+
catch CryptoError error {
|
|
133
|
+
throw JwtError()
|
|
134
|
+
}
|
|
135
|
+
catch JsonError error {
|
|
136
|
+
throw JwtError()
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
/** Verify the signature and configured algorithm, key id, and type before exposing the JSON payload. Never follows token-supplied URLs. */
|
|
140
|
+
verifyJwt(string token, RsaPublicKey publicKey, string kid, string tokenType, resolve Crypto crypto) returns Json uses crypto.decodeBase64url and crypto.verifyRsa unless JwtError {
|
|
141
|
+
if token.length() > 16384 {
|
|
142
|
+
throw JwtError()
|
|
143
|
+
}
|
|
144
|
+
parts = token.split(separator=".")
|
|
145
|
+
if parts.length() != 3 {
|
|
146
|
+
throw JwtError()
|
|
147
|
+
}
|
|
148
|
+
try {
|
|
149
|
+
first = parts.get(index=0)
|
|
150
|
+
second = parts.get(index=1)
|
|
151
|
+
third = parts.get(index=2)
|
|
152
|
+
header = parse(input=crypto.decodeBase64url(input=first).text()).decode<JwtHeader>()
|
|
153
|
+
if header.alg != "RS256" or header.kid != kid or header.typ != tokenType {
|
|
154
|
+
throw JwtError()
|
|
155
|
+
}
|
|
156
|
+
signature = crypto.decodeBase64url(input=third)
|
|
157
|
+
if not crypto.verifyRsa(publicKey=publicKey, input=(first + "." + second).bytes(), signature=signature) {
|
|
158
|
+
throw JwtError()
|
|
159
|
+
}
|
|
160
|
+
return parse(input=crypto.decodeBase64url(input=second).text())
|
|
161
|
+
}
|
|
162
|
+
catch CryptoError error {
|
|
163
|
+
throw JwtError()
|
|
164
|
+
}
|
|
165
|
+
catch ConversionError error {
|
|
166
|
+
throw JwtError()
|
|
167
|
+
}
|
|
168
|
+
catch JsonError error {
|
|
169
|
+
throw JwtError()
|
|
170
|
+
}
|
|
171
|
+
catch IndexError error {
|
|
172
|
+
throw JwtError()
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
:::
|
|
178
|
+
|
|
179
|
+
::::
|
|
180
|
+
|
|
181
|
+
:::: example-spec
|
|
182
|
+
|
|
183
|
+
## Compiled specification {#specification}
|
|
184
|
+
|
|
185
|
+
August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
|
|
186
|
+
|
|
187
|
+
### In this file
|
|
188
|
+
|
|
189
|
+
- [`JwtError`](jose.md#symbol-JwtError) is a class implementing `Error`.
|
|
190
|
+
- [`JwtHeader`](jose.md#symbol-JwtHeader) is an immutable record.
|
|
191
|
+
- [`RsaJwk`](jose.md#symbol-RsaJwk) is an immutable record.
|
|
192
|
+
- [`RsaJwks`](jose.md#symbol-RsaJwks) is an immutable record.
|
|
193
|
+
- [`rsaJwk`](jose.md#symbol-rsaJwk) is a function returning `RsaJwk`.
|
|
194
|
+
- [`importJwk`](jose.md#symbol-importJwk) is a function returning `RsaPublicKey`.
|
|
195
|
+
- [`signJwt`](jose.md#symbol-signJwt) is a function returning `string`.
|
|
196
|
+
- [`verifyJwt`](jose.md#symbol-verifyJwt) is a function returning `Json`.
|
|
197
|
+
|
|
198
|
+
### `JwtError` {#symbol-JwtError}
|
|
199
|
+
|
|
200
|
+
[source](jose.md#code)
|
|
201
|
+
|
|
202
|
+
Behavioral class.
|
|
203
|
+
|
|
204
|
+
Satisfies `Error`.
|
|
205
|
+
|
|
206
|
+
**Author documentation**
|
|
207
|
+
|
|
208
|
+
A failed JOSE validation reveals no unverified claims.
|
|
209
|
+
|
|
210
|
+
### `JwtHeader` {#symbol-JwtHeader}
|
|
211
|
+
|
|
212
|
+
[source](jose.md#code)
|
|
213
|
+
|
|
214
|
+
Immutable record.
|
|
215
|
+
|
|
216
|
+
**Author documentation**
|
|
217
|
+
|
|
218
|
+
This profile accepts only RS256, a configured key id, and an explicit token type.
|
|
219
|
+
|
|
220
|
+
**Inputs**
|
|
221
|
+
|
|
222
|
+
- `alg` (`string`) — required labeled input — stored as `alg` and read-only after initialization.
|
|
223
|
+
- `kid` (`string`) — required labeled input — stored as `kid` and read-only after initialization.
|
|
224
|
+
- `typ` (`string`) — required labeled input — stored as `typ` and read-only after initialization.
|
|
225
|
+
|
|
226
|
+
### `RsaJwk` {#symbol-RsaJwk}
|
|
227
|
+
|
|
228
|
+
[source](jose.md#code)
|
|
229
|
+
|
|
230
|
+
Immutable record.
|
|
231
|
+
|
|
232
|
+
**Author documentation**
|
|
233
|
+
|
|
234
|
+
Public signing-key metadata in RFC 7517 / RFC 7518 form.
|
|
235
|
+
|
|
236
|
+
**Inputs**
|
|
237
|
+
|
|
238
|
+
- `kty` (`string`) — required labeled input — stored as `kty` and read-only after initialization.
|
|
239
|
+
- `kid` (`string`) — required labeled input — stored as `kid` and read-only after initialization.
|
|
240
|
+
- `alg` (`string`) — required labeled input — stored as `alg` and read-only after initialization.
|
|
241
|
+
- `use` (`string`) — required labeled input — stored as `use` and read-only after initialization.
|
|
242
|
+
- `n` (`string`) — required labeled input — stored as `n` and read-only after initialization.
|
|
243
|
+
- `e` (`string`) — required labeled input — stored as `e` and read-only after initialization.
|
|
244
|
+
|
|
245
|
+
### `RsaJwks` {#symbol-RsaJwks}
|
|
246
|
+
|
|
247
|
+
[source](jose.md#code)
|
|
248
|
+
|
|
249
|
+
Immutable record.
|
|
250
|
+
|
|
251
|
+
**Inputs**
|
|
252
|
+
|
|
253
|
+
- `keys` (`List<RsaJwk>`) — required labeled input — stored as `keys` and read-only after initialization.
|
|
254
|
+
|
|
255
|
+
### `rsaJwk` {#symbol-rsaJwk}
|
|
256
|
+
|
|
257
|
+
[source](jose.md#code)
|
|
258
|
+
|
|
259
|
+
**Inputs**
|
|
260
|
+
|
|
261
|
+
- `publicKey` (`RsaPublicKey`) — required labeled input.
|
|
262
|
+
- `kid` (`string`) — required labeled input.
|
|
263
|
+
- `crypto` ([`Crypto`](contracts.md#symbol-Crypto)) — injected; callers omit it.
|
|
264
|
+
|
|
265
|
+
Returns: [`RsaJwk`](jose.md#symbol-RsaJwk).
|
|
266
|
+
|
|
267
|
+
Capabilities: [`crypto.exportRsa`](contracts.md#symbol-Crypto.exportRsa).
|
|
268
|
+
|
|
269
|
+
Can fail with `CryptoError`. Callers must catch or propagate these errors.
|
|
270
|
+
|
|
271
|
+
**What it does**
|
|
272
|
+
|
|
273
|
+
- Split call [`Crypto.exportRsa`](contracts.md#symbol-Crypto.exportRsa) on `crypto` with `publicKey` = `publicKey` into `modulus`, `exponent`, in that order.
|
|
274
|
+
- Return call [`RsaJwk`](jose.md#symbol-RsaJwk) with `kty` = `"RSA"`; `kid` = `kid`; `alg` = `"RS256"`; `use` = `"sig"`; `n` = call `base64url` on `modulus`; `e` = call `base64url` on `exponent`.
|
|
275
|
+
|
|
276
|
+
**Author documentation**
|
|
277
|
+
|
|
278
|
+
Export public parameters. Private key material never enters the JSON document.
|
|
279
|
+
|
|
280
|
+
### `importJwk` {#symbol-importJwk}
|
|
281
|
+
|
|
282
|
+
[source](jose.md#code)
|
|
283
|
+
|
|
284
|
+
**Inputs**
|
|
285
|
+
|
|
286
|
+
- `jwk` ([`RsaJwk`](jose.md#symbol-RsaJwk)) — required labeled input.
|
|
287
|
+
- `crypto` ([`Crypto`](contracts.md#symbol-Crypto)) — injected; callers omit it.
|
|
288
|
+
|
|
289
|
+
Returns: `RsaPublicKey`.
|
|
290
|
+
|
|
291
|
+
Capabilities: [`crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url), [`crypto.importRsa`](contracts.md#symbol-Crypto.importRsa).
|
|
292
|
+
|
|
293
|
+
Can fail with `JwtError`. Callers must catch or propagate these errors.
|
|
294
|
+
|
|
295
|
+
**What it does**
|
|
296
|
+
|
|
297
|
+
- If ((`kty` of `jwk` does not equal `"RSA"`) or (`alg` of `jwk` does not equal `"RS256"`)) or (`use` of `jwk` does not equal `"sig"`):
|
|
298
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
299
|
+
- Try these operations:
|
|
300
|
+
- Set `modulus` to call [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) on `crypto` with `input` = `n` of `jwk`.
|
|
301
|
+
- Set `exponent` to call [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) on `crypto` with `input` = `e` of `jwk`.
|
|
302
|
+
- Return call [`Crypto.importRsa`](contracts.md#symbol-Crypto.importRsa) on `crypto` with `modulus` = `modulus`; `exponent` = `exponent`.
|
|
303
|
+
- If they fail with `CryptoError`, name the failure `error` and recover:
|
|
304
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
305
|
+
|
|
306
|
+
**Author documentation**
|
|
307
|
+
|
|
308
|
+
Import only an RSA signing key for RS256. The transport caller selects the trusted JWKS URL.
|
|
309
|
+
|
|
310
|
+
### `signJwt` {#symbol-signJwt}
|
|
311
|
+
|
|
312
|
+
[source](jose.md#code)
|
|
313
|
+
|
|
314
|
+
**Inputs**
|
|
315
|
+
|
|
316
|
+
- `key` (`RsaPrivateKey`) — required labeled input.
|
|
317
|
+
- `claims` (`Json`) — required labeled input.
|
|
318
|
+
- `kid` (`string`) — required labeled input.
|
|
319
|
+
- `tokenType` (`string`) — required labeled input.
|
|
320
|
+
- `crypto` ([`Crypto`](contracts.md#symbol-Crypto)) — injected; callers omit it.
|
|
321
|
+
|
|
322
|
+
Returns: `string`.
|
|
323
|
+
|
|
324
|
+
Capabilities: [`crypto.signRsa`](contracts.md#symbol-Crypto.signRsa).
|
|
325
|
+
|
|
326
|
+
Can fail with `JwtError`. Callers must catch or propagate these errors.
|
|
327
|
+
|
|
328
|
+
**What it does**
|
|
329
|
+
|
|
330
|
+
- Try these operations:
|
|
331
|
+
- Set `header` to call `stringify` on call `Json` with `value` = call [`JwtHeader`](jose.md#symbol-JwtHeader) with `alg` = `"RS256"`; `kid` = `kid`; `typ` = `tokenType`.
|
|
332
|
+
- Set `payload` to call `stringify` on `claims`.
|
|
333
|
+
- Set `signing` to text formed by joining call `base64url` on call `bytes` on `header`, `"."`, call `base64url` on call `bytes` on `payload` in order.
|
|
334
|
+
- Set `signature` to call [`Crypto.signRsa`](contracts.md#symbol-Crypto.signRsa) on `crypto` with `key` = `key`; `input` = call `bytes` on `signing`.
|
|
335
|
+
- Return text formed by joining `signing`, `"."`, call `base64url` on `signature` in order.
|
|
336
|
+
- If they fail with `CryptoError`, name the failure `error` and recover:
|
|
337
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
338
|
+
- If they fail with `JsonError`, name the failure `error` and recover:
|
|
339
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
340
|
+
|
|
341
|
+
**Author documentation**
|
|
342
|
+
|
|
343
|
+
Sign immutable JSON with an explicit key id and token type. Claims are validated by the protocol that consumes the token.
|
|
344
|
+
|
|
345
|
+
### `verifyJwt` {#symbol-verifyJwt}
|
|
346
|
+
|
|
347
|
+
[source](jose.md#code)
|
|
348
|
+
|
|
349
|
+
**Inputs**
|
|
350
|
+
|
|
351
|
+
- `token` (`string`) — required labeled input.
|
|
352
|
+
- `publicKey` (`RsaPublicKey`) — required labeled input.
|
|
353
|
+
- `kid` (`string`) — required labeled input.
|
|
354
|
+
- `tokenType` (`string`) — required labeled input.
|
|
355
|
+
- `crypto` ([`Crypto`](contracts.md#symbol-Crypto)) — injected; callers omit it.
|
|
356
|
+
|
|
357
|
+
Returns: `Json`.
|
|
358
|
+
|
|
359
|
+
Capabilities: [`crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url), [`crypto.verifyRsa`](contracts.md#symbol-Crypto.verifyRsa).
|
|
360
|
+
|
|
361
|
+
Can fail with `JwtError`. Callers must catch or propagate these errors.
|
|
362
|
+
|
|
363
|
+
**What it does**
|
|
364
|
+
|
|
365
|
+
- If call `length` on `token` is greater than `16384`:
|
|
366
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
367
|
+
- Set `parts` to call `split` on `token` with `separator` = `"."`.
|
|
368
|
+
- If call `length` on `parts` does not equal `3`:
|
|
369
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
370
|
+
- Try these operations:
|
|
371
|
+
- Set `first` to call `get` on `parts` with `index` = `0`.
|
|
372
|
+
- Set `second` to call `get` on `parts` with `index` = `1`.
|
|
373
|
+
- Set `third` to call `get` on `parts` with `index` = `2`.
|
|
374
|
+
- Set `header` to call `decode` on call [`parse`](../json/contracts.md#symbol-parse) with `input` = call `text` on call [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) on `crypto` with `input` = `first` with type arguments [`JwtHeader`](jose.md#symbol-JwtHeader).
|
|
375
|
+
- If ((`alg` of `header` does not equal `"RS256"`) or (`kid` of `header` does not equal `kid`)) or (`typ` of `header` does not equal `tokenType`):
|
|
376
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
377
|
+
- Set `signature` to call [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) on `crypto` with `input` = `third`.
|
|
378
|
+
- If not (call [`Crypto.verifyRsa`](contracts.md#symbol-Crypto.verifyRsa) on `crypto` with `publicKey` = `publicKey`; `input` = call `bytes` on text formed by joining `first`, `"."`, `second` in order; `signature` = `signature`):
|
|
379
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
380
|
+
- Return call [`parse`](../json/contracts.md#symbol-parse) with `input` = call `text` on call [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) on `crypto` with `input` = `second`.
|
|
381
|
+
- If they fail with `CryptoError`, name the failure `error` and recover:
|
|
382
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
383
|
+
- If they fail with `ConversionError`, name the failure `error` and recover:
|
|
384
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
385
|
+
- If they fail with `JsonError`, name the failure `error` and recover:
|
|
386
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
387
|
+
- If they fail with `IndexError`, name the failure `error` and recover:
|
|
388
|
+
- Fail with call [`JwtError`](jose.md#symbol-JwtError). Transfer control to a matching catch or propagate the failure.
|
|
389
|
+
|
|
390
|
+
**Author documentation**
|
|
391
|
+
|
|
392
|
+
Verify the signature and configured algorithm, key id, and type before exposing the JSON payload. Never follows token-supplied URLs.
|
|
393
|
+
|
|
394
|
+
### Dependencies used by this file
|
|
395
|
+
|
|
396
|
+
Only referenced types and operations appear here. Each name links to its complete specification.
|
|
397
|
+
|
|
398
|
+
#### [`Crypto`](contracts.md#symbol-Crypto)
|
|
399
|
+
|
|
400
|
+
Capability interface from `contracts`.
|
|
401
|
+
|
|
402
|
+
- [`Crypto.decodeBase64url`](contracts.md#symbol-Crypto.decodeBase64url) (`input`: `string`) → `Bytes`; can fail with `CryptoError`.
|
|
403
|
+
- [`Crypto.exportRsa`](contracts.md#symbol-Crypto.exportRsa) (`publicKey`: `RsaPublicKey`) → `Tuple<Bytes,Bytes>`; can fail with `CryptoError`.
|
|
404
|
+
- [`Crypto.importRsa`](contracts.md#symbol-Crypto.importRsa) (`modulus`: `Bytes`, `exponent`: `Bytes`) → `RsaPublicKey`; can fail with `CryptoError`.
|
|
405
|
+
- [`Crypto.signRsa`](contracts.md#symbol-Crypto.signRsa) (`key`: `RsaPrivateKey`, `input`: `Bytes`) → `Bytes`; can fail with `CryptoError`.
|
|
406
|
+
- [`Crypto.verifyRsa`](contracts.md#symbol-Crypto.verifyRsa) (`publicKey`: `RsaPublicKey`, `input`: `Bytes`, `signature`: `Bytes`) → `bool`; can fail with `CryptoError`.
|
|
407
|
+
|
|
408
|
+
#### [`parse`](../json/contracts.md#symbol-parse)
|
|
409
|
+
|
|
410
|
+
Function from `august.json`.
|
|
411
|
+
|
|
412
|
+
- [`parse`](../json/contracts.md#symbol-parse) (`input`: `string`) → `Json`; can fail with `JsonError`.
|
|
413
|
+
|
|
414
|
+
### Built-in operations used by this file
|
|
415
|
+
|
|
416
|
+
- `Bytes.base64url` (no inputs) → `string`: Encode immutable bytes as unpadded RFC 4648 URL-safe base64.
|
|
417
|
+
- `Bytes.text` (no inputs) → `string`: Decode UTF-8 strictly. Invalid input raises ConversionError; embedded NUL is preserved. Can fail with `ConversionError`.
|
|
418
|
+
- `Json.decode` (no inputs) → `JwtHeader`: Decode a checked record or data type: json.decode<Profile>(). Unknown fields, type mismatches, and validation errors are rejected. Can fail with `JsonError`.
|
|
419
|
+
- `Json.stringify` (no inputs) → `string`: Serialize this JSON value with checked UTF-8 escaping and exact int64 values. Can fail with `JsonError`.
|
|
420
|
+
- `List<string>.get` (`index`: `int`) → `string`: Read a zero-based position. An invalid index raises checked IndexError. Reference results grant reading. Can fail with `IndexError`.
|
|
421
|
+
- `List<string>.length` (no inputs) → `int`: Read the number of elements.
|
|
422
|
+
- `string.bytes` (no inputs) → `Bytes`: Encode this string as immutable UTF-8 bytes.
|
|
423
|
+
- `string.length` (no inputs) → `int`: Read the number of UTF-8 bytes. Unicode text is preserved losslessly.
|
|
424
|
+
- `string.split` (`separator`: `string`) → `List<string>`: Split at an exact separator, preserving empty parts.
|
|
425
|
+
|
|
426
|
+
[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
427
|
+
|
|
428
|
+
### Shared language rules
|
|
429
|
+
|
|
430
|
+
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
431
|
+
|
|
432
|
+
::::
|
|
433
|
+
|
|
434
|
+
:::::
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "august/0.19.0/json/contracts.aug · OpenID Connect login application"
|
|
3
|
+
generated: true
|
|
4
|
+
source: "examples/oidc-login/.aug-spec/august/0.19.0/json/contracts.aug"
|
|
5
|
+
editLink: false
|
|
6
|
+
prev: false
|
|
7
|
+
next: false
|
|
8
|
+
outline: [2, 3]
|
|
9
|
+
search: false
|
|
10
|
+
pageClass: aug-example-page
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# `august/0.19.0/json/contracts.aug`
|
|
14
|
+
|
|
15
|
+
[OpenID Connect login application](../../../../index.md) · Dependency source and specification
|
|
16
|
+
|
|
17
|
+
This is the exact dependency version used by this example.
|
|
18
|
+
|
|
19
|
+
::::: example-compare
|
|
20
|
+
|
|
21
|
+
:::: example-code
|
|
22
|
+
|
|
23
|
+
## Code {#code}
|
|
24
|
+
|
|
25
|
+
::: code-group
|
|
26
|
+
|
|
27
|
+
```aug [Indentation]
|
|
28
|
+
extern C value pure _aug_json_parse(string input) returns Json unless JsonError
|
|
29
|
+
/** Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError. */
|
|
30
|
+
parse(string input) returns Json unless JsonError:
|
|
31
|
+
unsafe:
|
|
32
|
+
return _aug_json_parse(input)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```aug [Braces]
|
|
36
|
+
extern C value pure _aug_json_parse(string input) returns Json unless JsonError
|
|
37
|
+
/** Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError. */
|
|
38
|
+
parse(string input) returns Json unless JsonError {
|
|
39
|
+
unsafe {
|
|
40
|
+
return _aug_json_parse(input)
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
:::
|
|
46
|
+
|
|
47
|
+
::::
|
|
48
|
+
|
|
49
|
+
:::: example-spec
|
|
50
|
+
|
|
51
|
+
## Compiled specification {#specification}
|
|
52
|
+
|
|
53
|
+
August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
|
|
54
|
+
|
|
55
|
+
### In this file
|
|
56
|
+
|
|
57
|
+
- [`_aug_json_parse`](contracts.md#symbol-_aug_json_parse) is a function returning `Json`.
|
|
58
|
+
- [`parse`](contracts.md#symbol-parse) is a function returning `Json`.
|
|
59
|
+
|
|
60
|
+
### `parse` {#symbol-parse}
|
|
61
|
+
|
|
62
|
+
[source](contracts.md#code)
|
|
63
|
+
|
|
64
|
+
**Inputs**
|
|
65
|
+
|
|
66
|
+
- `input` (`string`) — required labeled input.
|
|
67
|
+
|
|
68
|
+
Returns: `Json`.
|
|
69
|
+
|
|
70
|
+
Can fail with `JsonError`. Callers must catch or propagate these errors.
|
|
71
|
+
|
|
72
|
+
**What it does**
|
|
73
|
+
|
|
74
|
+
- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
|
|
75
|
+
- Return call [`_aug_json_parse`](contracts.md#symbol-_aug_json_parse) with `input` = `input`.
|
|
76
|
+
|
|
77
|
+
**Author documentation**
|
|
78
|
+
|
|
79
|
+
Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError.
|
|
80
|
+
|
|
81
|
+
### `_aug_json_parse` {#symbol-_aug_json_parse}
|
|
82
|
+
|
|
83
|
+
[source](contracts.md#code)
|
|
84
|
+
|
|
85
|
+
Private to its defining scope.
|
|
86
|
+
|
|
87
|
+
**Inputs**
|
|
88
|
+
|
|
89
|
+
- `input` (`string`) — required labeled input.
|
|
90
|
+
|
|
91
|
+
Returns: `Json`.
|
|
92
|
+
|
|
93
|
+
Can fail with `JsonError`. Callers must catch or propagate these errors.
|
|
94
|
+
|
|
95
|
+
Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
|
|
96
|
+
|
|
97
|
+
### Shared language rules
|
|
98
|
+
|
|
99
|
+
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
100
|
+
|
|
101
|
+
::::
|
|
102
|
+
|
|
103
|
+
:::::
|