mirror of
https://github.com/Sea-Haven-Industries/procurement-ingest.git
synced 2026-09-30 23:33:13 +00:00
Some checks are pending
Deploy / deploy (push) Waiting to run
* feat(api): add procurement-api stack - read API + OpenAPI docs page Third CDK stack: API Gateway REST API (IAM SigV4) over both pipelines' tables, replacing SHOC's retired SyncController cross-account DynamoDB scan as the reconciliation/backfill path. - lambdas/api/: handler (healthcheck + docs-token gate + router dispatch), router (single route table), pagination (opaque cursor, hostile -> 400), Decimal-safe serialization, wo_repo/po_repo reads. No VendorReplies. - OpenAPI 3.1 spec as source of truth incl. top-level webhooks section documenting the outbound SHOC feed; phase-2 write endpoints x-planned (router answers 501). Self-contained /docs page, no CDN. - Auth: AWS_IAM on data routes + resource policy scoped to exactly arn:aws:iam::396287094661:role/shoc-backend-dev on GET/*; /docs and /openapi.json carve-out is token-gated in the Lambda via shared web_ui_auth (fail-closed, INFRA-74 posture). - KMS: explicit Decrypt/DescribeKey on the DynamoDB CMK from SSM (name-imported table drops the key association - INFRA-104 class). - Alarms: errors/throttles/duration(p99>=22.5s) + gateway 5xx, ALARM-only to site-alerts. No access logging in v1 (docs ?token= shim stays out of logs); cloud_watch_role=False. - Tests: handler auth-seam + routing + Decimal round-trip; moto cursor pagination incl. hostile cursors; spec<->router drift gate; bundle AST pins for the api command; pytest.ini --cov + loader siblings. - Deploy role: third stack DescribeStacks ARN + procurement-api smoke invoke ARN (re-run create-deploy-role.sh before merge). * harden(api): apply sh-security-review findings to procurement-api Fan-out (6 detectors) + review findings resolved: Correctness / DoS: - pagination: require EXACT key-set match (was subset) so a partial/foreign composite cursor can't reach DynamoDB as an inconsistent ExclusiveStartKey -> ValidationException -> 500; comments Query now pins the cursor's work_order_id to the path entity. - handler: map botocore ValidationException to 400 (defense in depth) so a crafted cursor can't drive the zero-threshold 5xx alarm. - web_ui_auth: compare tokens as bytes; a non-ASCII presented token now fails closed (401) instead of crashing hmac.compare_digest into a 500. Resolves the pre-existing xfail(strict) follow-up test; hardens the web UIs too. Docs page: - typeStr() now escapes the one spec-derived string that reached innerHTML. - spec inlined into the docs <script> block escapes "<" -> < (</script> breakout guard); /openapi.json still served byte-faithful. - Cache-Control: no-store + Referrer-Policy: no-referrer on docs responses so the ?token= URL stays out of caches/Referer. - spec-drift test asserts the committed spec carries no "</" / "<!--". IAM / IaC: - resource policy enumerates the 7 data GET resources instead of GET/* so a future GET route can't silently inherit SHOC cross-account reach. - kms:Decrypt grant gains a kms:ViaService=dynamodb condition. - stage throttling (50 rps / 100 burst) bounds the unauthenticated /docs blast radius below the 10k account default. - corrected the PATCH/POST comment (same-account callers aren't blocked by the resource policy; 501 handler + absent write grant are the gate). - documented the RETAIN log-group first-deploy rollback trap and the resource-policy-needs-redeploy gotcha in-stack. Mandatory GPT-4.1 cross-family review of the full policy surface: no BLOCK/FIX. 675 tests pass, ruff clean, cdk synth green.
43 lines
1.5 KiB
Python
43 lines
1.5 KiB
Python
"""JSON response helpers for the procurement API.
|
|
|
|
DynamoDB items come back through boto3 with numeric attributes as
|
|
``decimal.Decimal`` (e.g. purchase-orders ``total_amount``/``line_items``
|
|
prices), which ``json.dumps`` rejects. The encoder below renders integral
|
|
Decimals as JSON integers (exact) and non-integral Decimals as floats. For the
|
|
values this API serves -- currency amounts at PO magnitudes, well under ~15
|
|
significant digits -- the shortest-float repr round-trips the original digits
|
|
exactly. A Decimal carrying more precision than a float can hold (DynamoDB
|
|
Number supports 38 digits) would be truncated silently; the pipeline never
|
|
writes such values, but if that ever changes, switch non-integral Decimals to
|
|
``str(o)`` and update the OpenAPI number types.
|
|
"""
|
|
|
|
import decimal
|
|
import json
|
|
|
|
|
|
class _DecimalSafeEncoder(json.JSONEncoder):
|
|
def default(self, o):
|
|
if isinstance(o, decimal.Decimal):
|
|
if o == o.to_integral_value():
|
|
return int(o)
|
|
return float(o)
|
|
if isinstance(o, set):
|
|
return sorted(o)
|
|
return super().default(o)
|
|
|
|
|
|
def dumps(payload) -> str:
|
|
return json.dumps(payload, cls=_DecimalSafeEncoder)
|
|
|
|
|
|
def json_response(status_code: int, payload) -> dict:
|
|
return {
|
|
"statusCode": status_code,
|
|
"headers": {"Content-Type": "application/json"},
|
|
"body": dumps(payload),
|
|
}
|
|
|
|
|
|
def error_response(status_code: int, message: str) -> dict:
|
|
return json_response(status_code, {"error": message})
|