mirror of https://gitee.com/pnoker/iot-dc3.git synced 2026-08-29 06:31:14 +08:00

Files

T

History

pnoker 769d1cb977 style: apply repository-wide formatting

- expand single-line Javadocs to multi-line blocks, rewrap Markdown prose, and reflow POM, YAML, and TypeScript formatting
- formatting only: no Java code lines changed, no build-file semantics changed
- verified: backend compile and check_documentation.py pass, pnpm check and pnpm lint:check pass, and the dc3 YAML files parse

2026-08-25 13:35:00 +08:00

src/main/protobuf/api/common/auth

refactor(api): type OAuth grant_type as proto enum (#198 )

2026-08-06 19:03:50 +08:00

pom.xml

refactor(api): reorganize proto files from center to common package

2026-07-09 12:43:48 +08:00

README.md

style: apply repository-wide formatting

2026-08-25 13:35:00 +08:00

README.md

DC3 API Auth

dc3-api-auth defines the authentication and authorization gRPC contracts. Generated Java types use the io.github.pnoker.api.center.auth package; proto sources live under src/main/protobuf/api/common/auth/.

Services

Service	RPCs	Purpose
`TenantApi`	`GetByCode`	resolve tenant metadata
`UserApi`	`GetById`, `GetByPrincipalId`	resolve user identity
`TokenApi`	`CheckValid`	validate login/token material
`LocalCredentialApi`	`GetByLoginName`	resolve local credentials
`PermissionApi`	`ListPermissionCodes`	resolve effective permission codes
`ResourceRegistryApi`	`Sync`	synchronize annotated API/menu resources
`McpRuntimeApi`	`Introspect`, `ListTools`, `ResolveTool`, `AuthorizeToolCall`, `Audit`	authorize and audit MCP tools

Every response uses a contract-specific wrapper containing GrpcR. Callers must inspect the result envelope before reading response data.

Consumers and implementation

dc3-common-auth implements the servers as Spring @Service beans extending generated *ImplBase classes.
dc3-common-facade-grpc creates shared blocking stubs and exposes transport-independent auth facades.
dc3-gateway uses auth facades for ingress authentication and authorization.

Business code should depend on facade interfaces instead of generated stubs unless it is itself a transport adapter.

Build and Verification

Run from the repository root:

mvn -s .mvn/settings.xml -q -pl dc3-api/dc3-api-auth -am compile

This module has no handwritten runtime code or module-specific tests. A successful compile verifies proto syntax and generated Java sources; server/facade behaviour is tested in the implementing modules.

When changing the contract, preserve field numbers, update implementations and clients together, and verify that tenant and authorization context remain explicit.