mirror of https://github.com/lfnovo/open-notebook.git synced 2026-04-28 11:30:00 +00:00

feat: credential-based API key management (#477 ) (#540 )

* feat: replace provider config with credential-based system (#477)

Introduce a new credential management system replacing the old
ProviderConfig singleton and standalone Models page. Each credential
stores encrypted API keys and provider-specific configuration with
full CRUD support via a unified settings UI.

Backend:
- Add Credential domain model with encrypted API key storage
- Add credentials API router (CRUD, discovery, registration, testing)
- Add encryption utilities for secure key storage
- Add key_provider for DB-first env-var fallback provisioning
- Add connection tester and model discovery services
- Integrate ModelManager with credential-based config
- Add provider name normalization for Esperanto compatibility
- Add database migrations 11-12 for credential schema

Frontend:
- Rewrite settings/api-keys page with credential management UI
- Add model discovery dialog with search and custom model support
- Add compact default model assignments (primary/advanced layout)
- Add inline model testing and credential connection testing
- Add env-var migration banner
- Update navigation to unified settings page
- Remove standalone models page and old settings components

i18n:
- Update all 7 locale files with credential and model management keys

Closes #477

Co-Authored-By: JFMD <git@jfmd.us>
Co-Authored-By: OraCatQAQ <570768706@qq.com>

* fix: address PR #540 review comments

- Fix docs referencing removed Models page
- Fix error-handler returning raw messages instead of i18n keys
- Fix auth.py misleading docstring and missing no-password guard
- Fix connection_tester using wrong env var for openai_compatible
- Add provision_provider_keys before model discovery/sync
- Update CLAUDE.md to reflect credential-based system
- Fix missing closing brace in api-keys page useEffect

* fix: add logging to credential migration and surface errors in UI

- Add comprehensive logging to migrate-from-env and
  migrate-from-provider-config endpoints (start, per-provider
  progress, success/failure with stack traces, final summary)
- Fix frontend migration hooks ignoring errors array from response
- Show error toast when migration fails instead of "nothing to migrate"
- Invalidate status/envStatus queries after migration so banner updates

* docs: update CLAUDE.md files for credential system

Replace stale ProviderConfig and /api-keys/ references across 8 CLAUDE.md
files to reflect the new Credential-based system from PR #540.

* docs: update user documentation for credential-based system

Replace env var API key instructions with Settings UI credential
workflow across all user-facing documentation. The new flow is:
set OPEN_NOTEBOOK_ENCRYPTION_KEY → start services → add credential
in Settings UI → test → discover models → register.

- Rewrite ai-providers.md, api-configuration.md, environment-reference.md
- Update all quick-start guides and installation docs
- Update ollama.md, openai-compatible.md, local-tts/stt networking sections
- Update reverse-proxy.md, development-setup.md, security.md
- Fix broken links to non-existent docs/deployment/ paths
- Add credentials endpoints to api-reference.md
- Move all API key env vars to deprecated/legacy sections

* chore: bump version to 1.7.0-rc1

Release candidate for credential-based provider management system.

* fix: initialize provider before try block in test_credential

Prevents UnboundLocalError when Credential.get() throws (e.g.,
invalid credential_id) before provider is assigned.

* fix: reorder down migration to drop index before table

Removes duplicate REMOVE FIELD statement and reorders so the index
is dropped before the table, preventing rollback failures.

* refactor: simplify encryption key to always derive via SHA-256

Remove the dual code path in _ensure_fernet_key() that detected native
Fernet keys. Since the credential system is new, always deriving via
SHA-256 removes unnecessary complexity. Also removes the generate_key()
function and Fernet.generate_key() references from docs.

* fix: correct mock patch targets in embedding tests and URL validation

Fix embedding tests patching wrong module path for model_manager
(was targeting open_notebook.utils.embedding.model_manager but it's
imported locally from open_notebook.ai.models). Also fix URL validation
to allow unresolvable hostnames since they may be valid in the
deployment environment (e.g., Azure endpoints, internal DNS).

* feat: add global setup banner for encryption and migration status

Show a persistent banner in AppShell when encryption key is missing
(red) or env var API keys can be migrated (amber), so users see
these prompts on every page instead of only on Settings > API Keys.

Includes a docs link for the encryption banner and i18n support
across all 7 locales.

* docs: several improvements to docker-compose e env examples

* Update README.md

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>

* docs: fix env var format in README and update model setup instructions

Align the encryption key snippet in README Step 2 with the list
format used in the compose file. Replace deprecated "Settings →
Models" instructions with credential-based Discover Models flow.

* fix: address credential system review issues

- Fix SSRF bypass via IPv4-mapped IPv6 addresses (::ffff:169.254.x.x)
- Fix TTS connection test missing config parameter
- Add Azure-specific model discovery using api-key auth header
- Add Vertex static model list for credential-based discovery
- Fix PROVIDER_DISCOVERY_FUNCTIONS incorrect azure/vertex mapping
- Extract business logic to api/credentials_service.py (service layer)
- Move credential Pydantic schemas to api/models.py
- Update tests to use new service imports and ValueError assertions

* fix: sanitize error responses and migrate key_provider to Credential

- Replace raw exception messages in all credential router 500 responses
  with generic error strings (internal details logged server-side only)
- Refactor key_provider.py to use Credential.get_by_provider() instead
  of deprecated ProviderConfig.get_instance()
- Remove unused functions (get_provider_configs, get_default_api_key,
  get_provider_config) that were dead code

---------

Co-authored-by: JFMD <git@jfmd.us>
Co-authored-by: OraCatQAQ <570768706@qq.com>

2026-02-10 08:30:22 -03:00

3.1 KiB

Raw Blame History

Security Review - API Configuration UI

Date: 2026-01-27 (Updated: 2026-01-28)

Reviewer: Security Audit

Summary

Security review of the API key management implementation for Open Notebook. The implementation uses a database-first approach with environment variable fallback.

Encryption

Item	Status	Notes
Fernet encryption implemented	PASS	`open_notebook/utils/encryption.py` uses AES-128-CBC + HMAC-SHA256
Keys encrypted before DB storage	PASS	`encrypt_value()` applied on save
Keys decrypted only when needed	PASS	`decrypt_value()` called when reading
Encryption key required	PASS	No default key; ValueError if not configured
Docker secrets support	PASS	`_FILE` suffix pattern supported
Documented in .env.example	PASS	Encryption key documented

API Security

Item	Status	Notes
Test endpoint implemented	PASS	`connection_tester.py` validates keys
Test doesn't expose keys	PASS	Only returns success/failure
Error messages don't leak info	PASS	Generic error messages
URL validation for SSRF	PASS	Blocks private IPs (except Ollama)
Rate limiting	NOT IMPL	Future enhancement

Frontend Security

Item	Status	Notes
No keys in localStorage	PASS	Keys only in React state during entry
Keys masked in UI	PASS	Shows `************` placeholder
No keys in console.log	PASS	No logging of sensitive data
autocomplete attributes	PARTIAL	Some forms missing autocomplete="off"

Authentication

Item	Status	Notes
Password protection	PASS	Bearer token authentication
Default password	PASS	"open-notebook-change-me" when not set
Docker secrets support	PASS	`_FILE` suffix for password
Security warnings	PASS	Logged when using defaults

Files Reviewed

Component	Path	Status
Encryption	`open_notebook/utils/encryption.py`	PASS
Credential model	`open_notebook/domain/credential.py`	PASS
Credentials router	`api/routers/credentials.py`	PASS
Key provider	`open_notebook/ai/key_provider.py`	PASS
Connection tester	`open_notebook/ai/connection_tester.py`	PASS
Auth middleware	`api/auth.py`	PASS
Frontend forms	`frontend/src/components/settings/*.tsx`	PASS
Environment example	`.env.example`	PASS

Remaining Recommendations

Future Improvements

Rate limiting - Add rate limiting on /credentials/* endpoints
Autocomplete attributes - Add autocomplete="new-password" to all password inputs
Show last 4 characters - Display ********xxxx format for key identification
Audit logging - Log API key changes with timestamps

Conclusion

The API Configuration UI implementation meets security requirements:

API keys encrypted at rest using Fernet (key must be explicitly configured)
Keys never returned to frontend
URL validation prevents SSRF attacks
Docker secrets supported for production deployments

Review Status: PASS

3.1 KiB Raw Blame History