36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207 | def configure_app(
app: FastAPI,
settings: Optional[Settings] = None,
**settings_kwargs: Any,
) -> FastAPI:
"""
Apply routes and middleware to a FastAPI app.
Parameters
----------
app : FastAPI
The FastAPI app to configure.
settings : Settings | None, optional
Pre-built settings instance. If omitted, a new one is constructed from
``settings_kwargs``.
**settings_kwargs : Any
Keyword arguments used to configure the health and conformance checks if
``settings`` is not provided.
"""
settings = settings or Settings(**settings_kwargs)
#
# Route Handlers
#
# If we have customized Swagger UI Init settings (e.g. a provided client_id)
# then we need to serve our own Swagger UI in place of the upstream's. This requires
# that we know the Swagger UI endpoint and the OpenAPI spec endpoint.
if all(
[
settings.swagger_ui_endpoint,
settings.openapi_spec_endpoint,
settings.swagger_ui_init_oauth,
]
):
app.add_route(
settings.swagger_ui_endpoint,
SwaggerUI(
openapi_url=settings.openapi_spec_endpoint, # type: ignore
init_oauth=settings.swagger_ui_init_oauth,
).route,
include_in_schema=False,
)
if settings.healthz_prefix:
app.include_router(
HealthzHandler(upstream_url=str(settings.upstream_url)).router,
prefix=settings.healthz_prefix,
)
#
# Middleware (order is important, last added = first to run)
#
if settings.enable_authentication_extension:
app.add_middleware(
AuthenticationExtensionMiddleware,
default_public=settings.default_public,
public_endpoints=settings.public_endpoints,
private_endpoints=settings.private_endpoints,
oidc_discovery_url=str(settings.oidc_discovery_url),
)
if settings.openapi_spec_endpoint:
app.add_middleware(
OpenApiMiddleware,
openapi_spec_path=settings.openapi_spec_endpoint,
oidc_discovery_url=str(settings.oidc_discovery_url),
public_endpoints=settings.public_endpoints,
private_endpoints=settings.private_endpoints,
default_public=settings.default_public,
root_path=settings.root_path,
auth_scheme_name=settings.openapi_auth_scheme_name,
auth_scheme_override=settings.openapi_auth_scheme_override,
items_filter_path=(
settings.items_filter_path if settings.items_filter else None
),
collections_filter_path=(
settings.collections_filter_path
if settings.collections_filter
else None
),
)
if settings.items_filter or settings.collections_filter:
app.add_middleware(Cql2ValidateResponseBodyMiddleware)
app.add_middleware(
Cql2ValidateTransactionMiddleware,
upstream_url=str(settings.upstream_url),
)
app.add_middleware(Cql2ApplyFilterBodyMiddleware)
app.add_middleware(Cql2ApplyFilterQueryStringMiddleware)
app.add_middleware(Cql2RewriteLinksFilterMiddleware)
app.add_middleware(
Cql2BuildFilterMiddleware,
items_filter=settings.items_filter() if settings.items_filter else None,
collections_filter=(
settings.collections_filter() if settings.collections_filter else None
),
collections_filter_path=settings.collections_filter_path,
items_filter_path=settings.items_filter_path,
)
app.add_middleware(
AddProcessTimeHeaderMiddleware,
)
app.add_middleware(
EnforceAuthMiddleware,
public_endpoints=settings.public_endpoints,
private_endpoints=settings.private_endpoints,
default_public=settings.default_public,
oidc_discovery_url=settings.oidc_discovery_internal_url,
allowed_jwt_audiences=settings.allowed_jwt_audiences,
)
if settings.root_path or settings.upstream_url.path != "/":
app.add_middleware(
ProcessLinksMiddleware,
upstream_url=str(settings.upstream_url),
root_path=settings.root_path,
)
if settings.root_path:
app.add_middleware(
RemoveRootPathMiddleware,
root_path=settings.root_path,
)
if settings.enable_compression:
app.add_middleware(
CompressionMiddleware,
)
if not settings.proxy_options:
# When credentials are enabled and origins are wildcarded, use
# allow_origin_regex to force Starlette to reflect the request's
# Origin header instead of sending "Access-Control-Allow-Origin: *".
# The CORS spec forbids "*" when credentials are allowed, and while
# Starlette handles this correctly for preflight requests, its
# simple-response path does not — using a regex avoids the issue.
origins = list(settings.cors.allow_origins)
origin_regex = None
if settings.cors.allow_credentials and origins == ["*"]:
origins = []
origin_regex = ".*"
logger.debug(
"CORS: credentials enabled with wildcard origins, using origin reflection"
)
logger.info(
"CORS: handling locally (allow_origins=%s, allow_methods=%s, allow_credentials=%s)",
settings.cors.allow_origins,
settings.cors.allow_methods,
settings.cors.allow_credentials,
)
app.add_middleware(
CORSMiddleware,
allow_origins=origins,
allow_origin_regex=origin_regex,
allow_methods=list(settings.cors.allow_methods),
allow_headers=list(settings.cors.allow_headers),
allow_credentials=settings.cors.allow_credentials,
expose_headers=list(settings.cors.expose_headers),
max_age=settings.cors.max_age,
)
else:
logger.info("CORS: proxying OPTIONS to upstream")
return app
|