Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove JWT key filter from docs #6864

Merged
merged 3 commits into from
Feb 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/audit/builtin_maps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -376,9 +376,6 @@ JWT issuers.
:project: CCF
:members:

.. doxygenenum:: ccf::JwtIssuerKeyFilter
:project: CCF

``jwt.public_signing_keys``
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
2 changes: 0 additions & 2 deletions doc/build_apps/auth/jwt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Before adding public token signing keys to a running CCF network, the IdP has to
"name": "set_jwt_issuer",
"args": {
"issuer": "my_issuer",
"key_filter": "all",
"auto_refresh": false
}
}
Expand Down Expand Up @@ -95,7 +94,6 @@ Now the issuer can be created with auto-refresh enabled:
"name": "set_jwt_issuer",
"args": {
"issuer": "https://login.microsoftonline.com/common/v2.0",
"key_filter": "all",
"ca_cert_bundle_name": "jwt_ms",
"auto_refresh": true
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
"body": {
"issuers": {
"idprovider.myservice.example.com": {
"keyFilter": "All",
"autoRefresh": true,
"caCertBundleName": "MyIdProviderCa"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
"body": {
"issuers": {
"idprovider.myservice.example.com": {
"keyFilter": "All",
"autoRefresh": true,
"caCertBundleName": "MyIdProviderCa"
}
Expand Down
29 changes: 0 additions & 29 deletions doc/schemas/gov/2024-07-01/gov.json
Original file line number Diff line number Diff line change
Expand Up @@ -1914,10 +1914,6 @@
"type": "object",
"description": "Description of a JWT issuer or identity provider that the current service will trust tokens from.",
"properties": {
"keyFilter": {
"$ref": "#/definitions/ServiceState.JwtIssuerKeyFilter",
"description": "Adds restrictions on whether keys should be accepted from this issuer."
},
"keyPolicy": {
"type": "object",
"description": "Collection of claims which must be present in SGX attestation to permit updates from this issuer.",
Expand All @@ -1935,34 +1931,9 @@
}
},
"required": [
"keyFilter",
"autoRefresh"
]
},
"ServiceState.JwtIssuerKeyFilter": {
"type": "string",
"description": "Possible restrictions on what keys will be accepted from a JWT issuer.",
"enum": [
"All",
"Sgx"
],
"x-ms-enum": {
"name": "JwtIssuerKeyFilter",
"modelAsString": true,
"values": [
{
"name": "All",
"value": "All",
"description": "Accepts any JWT issuer."
},
{
"name": "Sgx",
"value": "Sgx",
"description": "Only accepts JWTs issued by a token provider running in SGX, which provides a suitable attestation and additional claims."
}
]
}
},
"ServiceState.Member": {
"type": "object",
"description": "Information on individual members within a consortium.",
Expand Down
11 changes: 1 addition & 10 deletions doc/schemas/gov_openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -271,22 +271,13 @@
},
"type": "object"
},
"JwtIssuerKeyFilter": {
"enum": [
"all"
],
"type": "string"
},
"JwtIssuerMetadata": {
"properties": {
"auto_refresh": {
"$ref": "#/components/schemas/boolean"
},
"ca_cert_bundle_name": {
"$ref": "#/components/schemas/string"
},
"key_filter": {
"$ref": "#/components/schemas/JwtIssuerKeyFilter"
}
},
"type": "object"
Expand Down Expand Up @@ -1348,7 +1339,7 @@
"info": {
"description": "This API is used to submit and query proposals which affect CCF's public governance tables.",
"title": "CCF Governance API",
"version": "4.6.0"
"version": "4.6.1"
},
"openapi": "3.0.0",
"paths": {
Expand Down
4 changes: 1 addition & 3 deletions include/ccf/service/tables/jwt.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ namespace ccf

struct JwtIssuerMetadata
{
/// JWT issuer key filter, kept for compatibility with existing ledgers
JwtIssuerKeyFilter key_filter = JwtIssuerKeyFilter::All;
/// Optional CA bundle name used for authentication when auto-refreshing
std::optional<std::string> ca_cert_bundle_name;
/// Whether to auto-refresh keys from the issuer
Expand All @@ -32,7 +30,7 @@ namespace ccf
DECLARE_JSON_TYPE_WITH_OPTIONAL_FIELDS(JwtIssuerMetadata);
DECLARE_JSON_REQUIRED_FIELDS(JwtIssuerMetadata);
DECLARE_JSON_OPTIONAL_FIELDS(
JwtIssuerMetadata, key_filter, ca_cert_bundle_name, auto_refresh);
JwtIssuerMetadata, ca_cert_bundle_name, auto_refresh);

using JwtIssuer = std::string;
using JwtKeyId = std::string;
Expand Down
2 changes: 1 addition & 1 deletion src/node/rpc/member_frontend.h
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ namespace ccf
openapi_info.description =
"This API is used to submit and query proposals which affect CCF's "
"public governance tables.";
openapi_info.document_version = "4.6.0";
openapi_info.document_version = "4.6.1";
}

static std::optional<MemberId> get_caller_member_id(
Expand Down