Implement Hashing for API Key Storage to Enhance Security #142 #158

priyanshu6238 · 2025-04-17T13:18:05Z

Description

This PR implements a secure and efficient approach for API key management, focusing on maintaining the original key format while ensuring security. The implementation uses a streamlined encryption process:
API keys are generated with a consistent format (prefixed with "ApiKey ")
The original key is encrypted using Fernet encryption before storage
The encryption key is derived from the application's secret key using PBKDF2HMAC
When retrieved, keys are automatically decrypted and returned in their original format

Changes Made

Implemented a simplified key management flow:
Raw key generation with "ApiKey " prefix
Direct encryption of the original key
Secure storage of the encrypted key
Automatic decryption on retrieval
Updated API key CRUD operations to:
Store encrypted original keys
Return keys in their original format
Maintain consistent key format across all operations
Modified test cases to verify:
Key format consistency
Proper encryption/decryption
Correct key retrieval
Ensured all API endpoints return keys in their original format

Benefits

Consistent Key Format: All API keys maintain the "ApiKey " prefix and original format
Secure Storage: Original keys are encrypted before storage
Simplified Verification: Direct comparison of decrypted keys
Improved Usability: Keys are always returned in their original, usable format
Maintained Security: Encryption ensures keys remain protected in the database
Better Developer Experience: No need to handle hashed or transformed keys

Ran fastapi run --reload app/main.py or docker compose up in the repository root and test.
If you've fixed a bug or added code that is tested and has test cases.

This pull request aims to enhance the security of API key storage in the priyanshu6238/ai-platform repository by implementing hashing and encryption mechanisms. The changes are made across several files:

backend/app/alembic/versions/77dc462dc6b0_seed_organization_table.py: The database seeding script is updated to hash and encrypt API keys before storage. This involves importing security utility functions and modifying the create_api_key function to incorporate these security measures. The update also addresses potential issues with the hashing strategy and the complexity of the hash-then-encrypt approach.
backend/app/core/security.py: New functionality is introduced for encrypting and decrypting API keys using Fernet symmetric encryption. An encryption key is derived from the application's SECRET_KEY using PBKDF2HMAC, and utility functions for encryption and decryption are provided, including basic error handling.
backend/app/crud/api_key.py: API key security is enhanced by storing encrypted hashes instead of raw keys. The key creation process is updated to store an encrypted hash, and retrieval functions are modified to handle this new format. A verification function iterates through keys, using get_password_hash and custom encryption/decryption functions. While this improves security, it introduces performance concerns in key verification, potential issues with encrypting hashes, and lacks error handling for decryption.

Overall, this pull request significantly improves the security posture of API key management by ensuring that raw keys are not stored and by implementing robust encryption and hashing techniques.

- Added encryption for API keys during storage using Fernet. - Implemented decryption for API keys when retrieved. - Updated API key creation to store encrypted keys. - Modified tests to verify the integrity of decrypted keys. - Introduced utility functions for key encryption and decryption in the security module.

kody-ai · 2025-04-17T13:19:02Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

codecov · 2025-04-17T13:20:01Z

Codecov Report

Attention: Patch coverage is 99.30070% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
backend/app/crud/api_key.py	97.72%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

backend/app/core/security.py

backend/app/alembic/versions/77dc462dc6b0_seed_organization_table.py

backend/app/core/security.py

backend/app/crud/api_key.py

kody-ai · 2025-04-17T13:37:49Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-17T14:09:10Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-17T14:11:32Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

…ption logic

kody-ai · 2025-04-17T14:57:41Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-17T15:09:21Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-17T15:10:06Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-18T10:18:34Z

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

kody-ai · 2025-04-18T10:33:46Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

…ng up whitespace for improved readability.

kody-ai · 2025-04-18T10:46:52Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

…d code clarity.

kody-ai · 2025-04-18T10:47:26Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

…ashed keys, ensuring keys are stored and retrieved in their original format. Update tests to verify the integrity of the raw keys.

kody-ai · 2025-04-19T07:23:27Z

Kody Review Complete

Great news! 🎉
No issues were found that match your current review configurations.

Keep up the excellent work! 🚀

Kody Guide: Usage and Configuration

Interacting with Kody

Request a Review: Ask Kody to review your PR manually by adding a comment with the @kody start-review command at the root of your PR.
Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Current Kody Configuration

Review Options

The following review options are enabled or disabled:

Options	Enabled
Security	✅
Code Style	✅
Kody Rules	✅
Refactoring	✅
Error Handling	✅
Maintainability	✅
Potential Issues	✅
Documentation And Comments	✅
Performance And Optimization	✅
Breaking Changes	❌

Access your configuration settings here.

…ion ID, user ID, and raw key format to ensure comprehensive validation of retrieved keys.

priyanshu6238 and others added 3 commits April 17, 2025 16:55

Merge branch 'ProjectTech4DevAI:main' into Cryptography

3c5b9b6

Refactor security imports and clean up code formatting

8e23397

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/core/security.py Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/alembic/versions/77dc462dc6b0_seed_organization_table.py Outdated Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/alembic/versions/77dc462dc6b0_seed_organization_table.py Outdated Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/core/security.py Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/crud/api_key.py Outdated Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/crud/api_key.py Show resolved Hide resolved

kody-ai bot reviewed Apr 17, 2025

View reviewed changes

backend/app/crud/api_key.py Outdated Show resolved Hide resolved

Refactor API key generation to use helper function

9f42ea5

priyanshu6238 added 3 commits April 17, 2025 19:28

Add unit tests for API key encryption and decryption

f8a88f3

Refactor test cases for API key encryption and decryption

a28c3ef

Refactor API key generation and enhance validation tests

d279edb

Clean up whitespace in API key generation and validation tests

a4aa7de

Refactor API key retrieval to use database session and simplify decry…

41bcec3

…ption logic

priyanshu6238 force-pushed the Cryptography branch from 4e71d89 to 41bcec3 Compare April 18, 2025 10:32

Merge branch 'ProjectTech4DevAI:main' into Cryptography

9a14268

Refactor API key creation by removing unnecessary comments and cleani…

f464314

…ng up whitespace for improved readability.

Fix whitespace inconsistency in API key creation function for improve…

2fd1b8c

…d code clarity.

Refactor API key handling to encrypt and return raw keys instead of h…

d5fbc9e

…ashed keys, ensuring keys are stored and retrieved in their original format. Update tests to verify the integrity of the raw keys.

Enhance test for API key retrieval by adding assertions for organizat…

30174f3

…ion ID, user ID, and raw key format to ensure comprehensive validation of retrieved keys.

avirajsingh7 approved these changes Apr 21, 2025

View reviewed changes

nishika26 approved these changes Apr 22, 2025

View reviewed changes

nishika26 merged commit d4b39fd into ProjectTech4DevAI:main Apr 22, 2025
2 checks passed

AkhileshNegi mentioned this pull request Apr 23, 2025

Hash API Key Before Storing #116

Closed

Implement Hashing for API Key Storage to Enhance Security #142 #158

Implement Hashing for API Key Storage to Enhance Security #142 #158

Uh oh!

Conversation

priyanshu6238 commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes Made

Benefits

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

codecov bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Completed! 🔥

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

kody-ai bot commented Apr 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Kody Review Complete

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

priyanshu6238 commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

codecov bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 17, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 18, 2025 •

edited

Loading

kody-ai bot commented Apr 19, 2025 •

edited

Loading