Merged
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@Flo4604 is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
📝 Walkthrough## Walkthrough
This update introduces encrypted key support and multi-rate limit enhancements to the API, database schema, and handlers. It adds new API endpoints for retrieving keys, supports batch operations for rate limits and audit logs, and introduces the `autoApply` flag for ratelimits. The OpenAPI spec and generated Go types are refactored for clearer request/response separation.
## Changes
| Files/Paths (grouped) | Change Summary |
|-------------------------------------------------------------------------------------|----------------|
| `go/pkg/db/schema.sql`<br>`go/pkg/db/queries/key_encryption_*.sql`<br>`go/pkg/db/key_encryption_*.sql_generated.go`<br>`go/pkg/db/key_find_by_id_or_hash.sql`<br>`go/pkg/db/key_find_by_id_or_hash.sql_generated.go`<br>`go/pkg/db/key_insert.sql`<br>`go/pkg/db/key_insert.sql_generated.go`<br>`go/pkg/db/identity_list_ratelimits_by_ids.sql`<br>`go/pkg/db/identity_list_ratelimits_by_ids.sql_generated.go`<br>`go/pkg/db/keyring_update_key_encryption.sql`<br>`go/pkg/db/keyring_update_key_encryption.sql_generated.go`<br>`go/pkg/db/ratelimit_list_by_key_id.sql`<br>`go/pkg/db/ratelimit_list_by_key_id.sql_generated.go` | Database schema changes for encrypted keys, batch ratelimit queries, and new fields; new SQL queries and generated Go code for key encryption, ratelimit, and keyring updates. |
| `go/pkg/db/models_generated.go`<br>`go/pkg/db/identity_insert_ratelimit.sql_generated.go`<br>`go/pkg/db/key_insert_ratelimit.sql_generated.go`<br>`go/pkg/db/ratelimit_update.sql_generated.go`<br>`go/pkg/db/ratelimit_list_by_key_ids.sql_generated.go`<br>`go/pkg/db/identity_list_ratelimits.sql_generated.go`<br>`go/pkg/db/identity_list_ratelimits_by_id.sql_generated.go` | Add `AutoApply` to ratelimit models and generated query structs; update ratelimit insert/update/query logic for new field. |
| `go/pkg/db/querier_generated.go` | Extend interface with new query methods for encrypted keys, ratelimits, and batch operations; update signatures for new fields. |
| `go/pkg/db/bulk_insert.go` | Add generic `BulkInsert` utility for batch SQL inserts. |
| `go/apps/api/routes/v2_keys_create_key/handler.go`<br>`go/apps/api/routes/v2_keys_get_key/handler.go`<br>`go/apps/api/routes/v2_apis_list_keys/handler.go`<br>`go/apps/api/routes/v2_identities_create_identity/handler.go`<br>`go/apps/api/routes/v2_identities_update_identity/handler.go` | Handlers updated for encrypted key support, batch ratelimit/permission/role inserts, new ratelimit fields, and improved permission checks. |
| `go/apps/api/routes/v2_keys_create_key/200_test.go`<br>`go/apps/api/routes/v2_keys_create_key/403_test.go`<br>`go/apps/api/routes/v2_keys_create_key/412_test.go`<br>`go/apps/api/routes/v2_keys_get_key/200_test.go`<br>`go/apps/api/routes/v2_keys_get_key/400_test.go`<br>`go/apps/api/routes/v2_keys_get_key/401_test.go`<br>`go/apps/api/routes/v2_keys_get_key/403_test.go`<br>`go/apps/api/routes/v2_keys_get_key/404_test.go`<br>`go/apps/api/routes/v2_keys_get_key/412_test.go`<br>`go/apps/api/routes/v2_apis_list_keys/200_test.go`<br>`go/apps/api/routes/v2_apis_list_keys/403_test.go`<br>`go/apps/api/routes/v2_apis_list_keys/404_test.go`<br>`go/apps/api/routes/v2_apis_list_keys/412_test.go`<br>`go/apps/api/routes/v2_identities_create_identity/200_test.go`<br>`go/apps/api/routes/v2_identities_create_identity/400_test.go`<br>`go/apps/api/routes/v2_identities_get_identity/200_test.go`<br>`go/apps/api/routes/v2_identities_get_identity/400_test.go`<br>`go/apps/api/routes/v2_identities_update_identity/200_test.go`<br>`go/apps/api/routes/v2_identities_update_identity/400_test.go` | Add/modify tests for encrypted keys, ratelimit `autoApply`, batch operations, and new handler logic. |
| `go/apps/api/routes/v2_keys_get_key/handler.go`<br>`go/apps/api/routes/v2_keys_get_key/200_test.go`<br>`go/apps/api/routes/v2_keys_get_key/400_test.go`<br>`go/apps/api/routes/v2_keys_get_key/401_test.go`<br>`go/apps/api/routes/v2_keys_get_key/403_test.go`<br>`go/apps/api/routes/v2_keys_get_key/404_test.go`<br>`go/apps/api/routes/v2_keys_get_key/412_test.go` | New API endpoint for retrieving key details by ID or plaintext, with permission and decryption support. |
| `go/apps/api/routes/register.go` | Register new routes for key retrieval and OpenAPI handler. |
| `go/apps/api/routes/openapi/handler.go`<br>`apps/agent/pkg/api/routes/openapi/handler.go` | Add OpenAPI reference endpoint handler and minor formatting cleanup. |
| `go/apps/api/openapi/gen.go`<br>`go/apps/api/openapi/openapi.yaml` | Refactor OpenAPI spec and generated types for ratelimits, credits, endpoints, and remove deprecated whoami endpoint. |
| `go/internal/services/auditlogs/insert.go` | Refactor audit log insertion for batch/bulk operations and improved transaction handling. |
| `go/pkg/testutil/seed/seed.go` | Update test seed for new key fields and error handling. |
| `go/pkg/testutil/http.go` | Minor formatting change (whitespace). |
| `apps/agent/services/vault/service.go`<br>`go/apps/api/routes/v2_apis_get_api/handler.go`<br>`go/internal/services/keys/verify.go` | Minor formatting/whitespace-only changes. |
| `go/apps/api/routes/v2_apis_create_api/handler.go`<br>`go/apps/api/routes/v2_apis_delete_api/handler.go`<br>`go/apps/api/routes/v2_identities_delete_identity/handler.go`<br>`go/apps/api/routes/v2_keys_add_permissions/handler.go`<br>`go/apps/api/routes/v2_keys_add_roles/handler.go`<br>`go/apps/api/routes/v2_keys_remove_permissions/handler.go`<br>`go/apps/api/routes/v2_keys_remove_roles/handler.go`<br>`go/apps/api/routes/v2_keys_set_permissions/handler.go`<br>`go/apps/api/routes/v2_keys_set_roles/handler.go`<br>`go/apps/api/routes/v2_permissions_create_permission/handler.go`<br>`go/apps/api/routes/v2_permissions_create_role/handler.go`<br>`go/apps/api/routes/v2_permissions_delete_permission/handler.go`<br>`go/apps/api/routes/v2_permissions_delete_role/handler.go`<br>`go/apps/api/routes/v2_ratelimit_delete_override/handler.go`<br>`go/apps/api/routes/v2_ratelimit_set_override/handler.go` | Simplify error handling for audit log insertion (return raw error instead of wrapping). |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant Client
participant API_Server
participant DB
participant Vault
Client->>API_Server: POST /v2/keys.createKey (with Recoverable=true)
API_Server->>DB: Validate API, Keyring, Permissions
API_Server->>Vault: Encrypt key (if Recoverable)
Vault-->>API_Server: Encrypted key data
API_Server->>DB: Insert key, encrypted key, ratelimits, permissions, roles (batch)
API_Server->>DB: Insert audit logs (batch)
API_Server-->>Client: 200 OK (key metadata)
Client->>API_Server: POST /v2/keys.getKey (with Decrypt=true)
API_Server->>DB: Find key by ID or hash
API_Server->>DB: Fetch API, Keyring, Permissions
API_Server->>Vault: Decrypt key (if encrypted and permitted)
Vault-->>API_Server: Plaintext key
API_Server->>DB: Fetch ratelimits, roles, permissions, identity info (batch)
API_Server-->>Client: 200 OK (key details, plaintext if allowed)Possibly related PRs
Suggested reviewers
|
|
Deployment failed with the following error: |
Flo4604
commented
Jul 2, 2025
Flo4604
commented
Jul 2, 2025
Flo4604
commented
Jul 2, 2025
…specify credit interval
This was referenced Jul 22, 2025
Merged
This was referenced Jul 29, 2025
Merged
This was referenced Aug 14, 2025
Merged
18 tasks
This was referenced Oct 16, 2025
This was referenced Oct 24, 2025
This was referenced Nov 4, 2025
Merged
19 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Is one of the endpoints for #3419 and adds the keys.getKey endpoint.
This also kills the need for the
whoamiendpoint by accepting both akeyIdand akeyparameter.Other changes are:
Some of the existing endpoints still need work, but ill do that in seperate branches.
Type of change
How should this be tested?
Unit tests
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
New Features
autoApplyoption and more detailed response data.enabled,apiId, and inclusion of identity ratelimits.Bug Fixes
Refactor
Chores
Documentation