This guide explains how to implement encryption and decryption for sensitive data in Laravel models. By following these steps, you can secure data before storing it in the database and decrypt it when retrieving it.
? ?Prerequisites
- Laravel: Ensure you're using a Laravel project.
- Encryption Key: Laravel automatically generates an APP_KEY in the .env file. This key is used by Laravel's encryption service.
? ?Step 1: Setup Encryption in the Model
In the model, we will use Laravel's encrypt() and decrypt() functions to handle encryption and decryption automatically for specified fields.
? ?Doctor Model
Create or update the Doctor model with encryption and decryption methods. We will encrypt fields such as first_name, last_name, email, and mobile before saving them in the database.
<?phpnamespace AppModels;use IlluminateDatabaseEloquentModel;use IlluminateSupportFacadesCrypt;class Doctor extends Model{
protected $fillable = [
'first_name', 'last_name', 'email', 'mobile', 'hashed_email', 'password'
];
// Automatically encrypt attributes when setting them
public function setFirstNameAttribute($value)
{
$this->attributes['first_name']?=?encrypt($value);
????}
????public?function?setLastNameAttribute($value)
????{
????????$this->attributes['last_name']?=?encrypt($value);
????}
????public?function?setEmailAttribute($value)
????{
????????$this->attributes['email']?=?encrypt($value);
????}
????public?function?setMobileAttribute($value)
????{
????????$this->attributes['mobile']?=?encrypt($value);
????}
????//?Automatically?decrypt?attributes?when?getting?them
????public?function?getFirstNameAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getLastNameAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getEmailAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getMobileAttribute($value)
????{
????????return?decrypt($value);
????}}
?????Explanation
- Setter Methods: Use set{AttributeName}Attribute() to encrypt data before it is stored in the database.
- Getter Methods: Use get{AttributeName}Attribute() to decrypt data when it is retrieved from the database.
Step 2: Controller for Data Storage and Retrieval
In the controller, you can handle validation and call the model’s encrypted attributes directly without additional encryption/decryption steps.
? ?????DoctorController
The DoctorController handles registration by validating
input data, encrypting it via the model, and saving it in the database.
When fetching the doctor data, it will automatically decrypt the
sensitive fields.
<?phpnamespace AppHttpControllers;use IlluminateHttpRequest;use AppModelsDoctor;use IlluminateSupportFacadesHash;class DoctorController extends Controller{
public function register(Request $request)
{
// Validate the incoming request
$validatedData = $request->validate([
????????????'first_name'?=>?'required|string|max:255',
????????????'last_name'?=>?'required|string|max:255',
????????????'email'?=>?'required|string|email|max:255|unique:doctors,email',
????????????'mobile'?=>?'required|string|size:10|unique:doctors,mobile',
????????????'password'?=>?'required|string|min:8|confirmed',
????????]);
????????//?Hash?the?email?to?ensure?uniqueness
????????$hashedEmail?=?hash('sha256',?$validatedData['email']);
????????//?Create?a?new?doctor?record?(model?will?handle?encryption)
????????$doctor?=?Doctor::create([
????????????'first_name'?=>?$validatedData['first_name'],
????????????'last_name'?=>?$validatedData['last_name'],
????????????'email'?=>?$validatedData['email'],
????????????'hashed_email'?=>?$hashedEmail,
????????????'mobile'?=>?$validatedData['mobile'],
????????????'password'?=>?Hash::make($validatedData['password']),
????????]);
????????return?response()->json([
????????????'message'?=>?'Doctor?registered?successfully',
????????????'doctor'?=>?$doctor
????????],?201);
????}
????public?function?show($id)
????{
????????//?Fetch?the?doctor?record?(model?will?decrypt?the?data?automatically)
????????$doctor?=?Doctor::findOrFail($id);
????????return?response()->json($doctor);
????}}
? ?Explanation
- register Method: Validates the incoming request, creates a new doctor record, and automatically encrypts fields like first_name, last_name, email, and mobile due to the model's encryption methods.
- show Method: Retrieves a doctor record by ID. The model's getter methods decrypt the sensitive fields automatically before returning the data.
? ?Step 3: Database Configuration
Ensure that the doctors table columns for sensitive data are of a sufficient length to handle encrypted data (typically, TEXT or LONGTEXT).
Example migration setup:
Schema::create('doctors',?function?(Blueprint?$table)?{
????$table->id();
????$table->text('first_name');
????$table->text('last_name');
????$table->text('email');
????$table->string('hashed_email')->unique();?//?SHA-256?hashed?email
????$table->text('mobile');
????$table->string('password');
????$table->timestamps();});
Note: Since encrypted values can be significantly longer than plaintext values, TEXT is preferred for encrypted fields.
? ?Step 4: Handling Decryption Exceptions
For enhanced error handling, wrap decryption logic in try-catch blocks in the model’s getters:
<?phpnamespace AppModels;use IlluminateDatabaseEloquentModel;use IlluminateSupportFacadesCrypt;class Doctor extends Model{
protected $fillable = [
'first_name', 'last_name', 'email', 'mobile', 'hashed_email', 'password'
];
// Automatically encrypt attributes when setting them
public function setFirstNameAttribute($value)
{
$this->attributes['first_name']?=?encrypt($value);
????}
????public?function?setLastNameAttribute($value)
????{
????????$this->attributes['last_name']?=?encrypt($value);
????}
????public?function?setEmailAttribute($value)
????{
????????$this->attributes['email']?=?encrypt($value);
????}
????public?function?setMobileAttribute($value)
????{
????????$this->attributes['mobile']?=?encrypt($value);
????}
????//?Automatically?decrypt?attributes?when?getting?them
????public?function?getFirstNameAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getLastNameAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getEmailAttribute($value)
????{
????????return?decrypt($value);
????}
????public?function?getMobileAttribute($value)
????{
????????return?decrypt($value);
????}}
? ?Additional Notes
- Environment Security: Ensure the APP_KEY is stored securely in the .env file. This key is critical for encryption/decryption.
- Data Backup: If data integrity is crucial, ensure you have a backup mechanism, as encrypted data cannot be recovered without the correct APP_KEY.
? ?Summary
- Model Encryption: Use setter methods to encrypt data before storing and getter methods to decrypt data upon retrieval.
- Controller Logic: The controller can handle encrypted fields directly without additional encryption code.
- Database Configuration: Use TEXT or LONGTEXT columns for encrypted fields.
- Security Considerations: Secure your APP_KEY and use exception handling in getters for decryption errors.
The above is the detailed content of Data Encryption and Decryption in Laravel. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undress AI Tool
Undress images for free
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
Laravel Vue.js single page application (SPA) tutorial
May 15, 2025 pm 09:54 PM
Single-page applications (SPAs) can be built using Laravel and Vue.js. 1) Define API routing and controller in Laravel to process data logic. 2) Create a componentized front-end in Vue.js to realize user interface and data interaction. 3) Configure CORS and use axios for data interaction. 4) Use VueRouter to implement routing management and improve user experience.
How to test Laravel API interface?
May 22, 2025 pm 09:45 PM
Efficient methods for testing Laravel API interfaces include: 1) using Laravel's own testing framework and third-party tools such as Postman or Insomnia; 2) writing unit tests, functional tests and integration tests; 3) emulating a real request environment and managing database status. Through these steps, the stability and functional integrity of the API can be ensured.
How to customize Laravel's user authentication logic?
May 22, 2025 pm 09:36 PM
Custom Laravel user authentication logic can be implemented through the following steps: 1. Add additional verification conditions when logging in, such as mailbox verification. 2. Create a custom Guard class and expand the authentication process. Custom authentication logic requires a deep understanding of Laravel's authentication system and pay attention to security, performance and maintenance.
How to create Laravel package (Package) development?
May 29, 2025 pm 09:12 PM
The steps to create a package in Laravel include: 1) Understanding the advantages of packages, such as modularity and reuse; 2) following Laravel naming and structural specifications; 3) creating a service provider using artisan command; 4) publishing configuration files correctly; 5) managing version control and publishing to Packagist; 6) performing rigorous testing; 7) writing detailed documentation; 8) ensuring compatibility with different Laravel versions.
Laravel integration with social media login (OAuth)
May 22, 2025 pm 09:27 PM
Integrating social media login in the Laravel framework can be achieved by using the LaravelSocialite package. 1. Install the Socialite package: use composerrequirelaravel/socialite. 2. Configure the service provider and alias: add relevant configuration in config/app.php. 3. Set API credentials: Configure social media API credentials in .env and config/services.php. 4. Write controller method: Add redirection and callback methods to handle social media login process. 5. Handle FAQs: Ensure user uniqueness, data synchronization, security and error handling. 6. Optimization practice:
How to implement password reset function in Laravel?
May 22, 2025 pm 09:42 PM
Implementing password reset function in Laravel requires the following steps: 1. Configure the email service and set relevant parameters in the .env file; 2. Define password reset routes in routes/web.php; 3. Customize email templates; 4. Pay attention to email sending problems and the validity period of tokens, and adjust the configuration if necessary; 5. Consider security to prevent brute-force attacks; 6. After the password reset is successful, force the user to log out of other devices.
Common security threats and protection measures for Laravel applications
May 22, 2025 pm 09:33 PM
Common security threats in Laravel applications include SQL injection, cross-site scripting attacks (XSS), cross-site request forgery (CSRF), and file upload vulnerabilities. Protection measures include: 1. Use EloquentORM and QueryBuilder for parameterized queries to avoid SQL injection. 2. Verify and filter user input to ensure the security of output and prevent XSS attacks. 3. Set CSRF tokens in forms and AJAX requests to protect the application from CSRF attacks. 4. Strictly verify and process file uploads to ensure file security. 5. Regular code audits and security tests are carried out to discover and fix potential security vulnerabilities.
What is Middleware in Laravel? How to use it?
May 29, 2025 pm 09:27 PM
Middleware is a filtering mechanism in Laravel that is used to intercept and process HTTP requests. Use steps: 1. Create middleware: Use the command "phpartisanmake:middlewareCheckRole". 2. Define processing logic: Write specific logic in the generated file. 3. Register middleware: Add middleware in Kernel.php. 4. Use middleware: Apply middleware in routing definition.
