用户认证与授权：在 Symfony 中实现安全控制

embedded/2024/11/17 12:53:10/

用户认证与授权：在 Symfony 中实现安全控制

Symfony 是一个功能强大且高度可扩展的 PHP 框架，广泛用于开发复杂的 Web 应用程序。在现代 Web 应用程序中，用户认证和授权是不可或缺的功能，用于确保应用程序的安全性和数据的隐私性。本文将详细介绍如何在 Symfony 中实现用户认证和授权，具体到源码示例，帮助您全面掌握这一重要技能。

一、项目初始化

首先，我们需要创建一个 Symfony 项目。如果您还没有安装 Symfony，可以使用以下命令进行安装：

composer create-project symfony/skeleton my_project
cd my_project

接下来，安装用于用户认证和授权的必要包：

composer require symfony/security-bundle
composer require symfony/orm-pack
composer require symfony/maker-bundle --dev

二、创建用户实体

在 Symfony 中，用户实体通常用来表示应用程序中的用户。我们可以使用 maker-bundle 快速生成用户实体：

php bin/console make:user

按照提示输入必要的信息，例如用户类名 User，是否需要存储密码等。生成的用户实体类如下：

php"><?phpnamespace App\Entity;use App\Repository\UserRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
use Symfony\Component\Security\Core\User\UserInterface;#[ORM\Entity(repositoryClass: UserRepository::class)]
class User implements UserInterface, PasswordAuthenticatedUserInterface
{#[ORM\Id]#[ORM\GeneratedValue]#[ORM\Column(type: 'integer')]private $id;#[ORM\Column(type: 'string', length: 180, unique: true)]private $email;#[ORM\Column(type: 'json')]private $roles = [];#[ORM\Column(type: 'string')]private $password;public function getId(): ?int{return $id;}public function getEmail(): ?string{return $email;}public function setEmail(string $email): self{$this->email = $email;return $this;}/*** A visual identifier that represents this user.** @see UserInterface*/public function getUserIdentifier(): string{return (string) $this->email;}/*** @see UserInterface*/public function getRoles(): array{$roles = $this->roles;// guarantee every user at least has ROLE_USER$roles[] = 'ROLE_USER';return array_unique($roles);}public function setRoles(array $roles): self{$this->roles = $roles;return $this;}/*** @see PasswordAuthenticatedUserInterface*/public function getPassword(): string{return $this->password;}public function setPassword(string $password): self{$this->password = $password;return $this;}/*** @see UserInterface*/public function eraseCredentials(){// If you store any temporary, sensitive data on the user, clear it here// $this->plainPassword = null;}
}

三、数据库配置与迁移

接下来，我们需要配置数据库连接并进行迁移。首先，在 .env 文件中配置数据库连接信息：

DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name"

然后，运行以下命令以创建数据库和迁移用户实体：

php bin/console doctrine:database:create
php bin/console make:migration
php bin/console doctrine:migrations:migrate

四、实现用户注册功能

用户注册功能允许新用户在应用程序中创建账户。首先，我们需要创建一个注册表单。使用以下命令生成表单：

php bin/console make:registration-form

按照提示选择生成表单所需的选项。生成的表单类如下：

php"><?phpnamespace App\Form;use App\Entity\User;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\PasswordType;
use Symfony\Component\Form\Extension\Core\Type\RepeatedType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Length;class RegistrationFormType extends AbstractType
{public function buildForm(FormBuilderInterface $builder, array $options): void{$builder->add('email', EmailType::class)->add('plainPassword', RepeatedType::class, ['type' => PasswordType::class,'first_options' => ['label' => 'Password'],'second_options' => ['label' => 'Repeat Password'],'invalid_message' => 'The password fields must match.','options' => ['attr' => ['class' => 'password-field']],'required' => true,'mapped' => false,'constraints' => [new NotBlank(['message' => 'Please enter a password',]),new Length(['min' => 6,'minMessage' => 'Your password should be at least {{ limit }} characters','max' => 4096,]),],]);}public function configureOptions(OptionsResolver $resolver): void{$resolver->setDefaults(['data_class' => User::class,]);}
}

接下来，创建一个控制器来处理用户注册请求：

php"><?phpnamespace App\Controller;use App\Entity\User;
use App\Form\RegistrationFormType;
use App\Security\LoginFormAuthenticator;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Http\Authentication\UserAuthenticatorInterface;class RegistrationController extends AbstractController
{#[Route('/register', name: 'app_register')]public function register(Request $request, UserPasswordHasherInterface $userPasswordHasher, UserAuthenticatorInterface $userAuthenticator, LoginFormAuthenticator $authenticator, EntityManagerInterface $entityManager): Response{$user = new User();$form = $this->createForm(RegistrationFormType::class, $user);$form->handleRequest($request);if ($form->isSubmitted() && $form->isValid()) {// encode the plain password$user->setPassword($userPasswordHasher->hashPassword($user,$form->get('plainPassword')->getData()));$entityManager->persist($user);$entityManager->flush();// do anything else you need here, like send an emailreturn $userAuthenticator->authenticateUser($user,$authenticator,$request);}return $this->render('registration/register.html.twig', ['registrationForm' => $form->createView(),]);}
}

创建注册页面模板 templates/registration/register.html.twig：

{% extends 'base.html.twig' %}{% block body %}
<h1>Register</h1>{{ form_start(registrationForm) }}{{ form_widget(registrationForm) }}<button type="submit" class="btn">Register</button>
{{ form_end(registrationForm) }}
{% endblock %}

五、实现用户登录功能

用户登录功能允许已注册用户访问受保护的资源。首先，使用以下命令生成登录表单：

php bin/console make:auth

按照提示选择 Login form authenticator 选项并提供必要的信息。生成的 LoginFormAuthenticator 类如下：

php"><?phpnamespace App\Security;use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\Security;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Guard\Authenticator\AbstractFormLoginAuthenticator;
use Symfony\Component\Security\Http\Util\TargetPathTrait;class LoginFormAuthenticator extends AbstractFormLoginAuthenticator
{use TargetPathTrait;private RouterInterface $router;public function __construct(RouterInterface $router){$this->router = $router;}public function supports(Request $request): bool{return 'app_login' === $request->attributes->get('_route') && $request->isMethod('POST');}public function getCredentials(Request $request){$credentials = ['email' => $request->request->get('email'),'password' => $request->request->get('password'),];$request->getSession()->set(Security::LAST_USERNAME, $credentials['email']);return $credentials;}public function getUser($credentials, UserProviderInterface $userProvider): ?UserInterface{return $userProvider->loadUserByUsername($credentials['email']);}public function checkCredentials($credentials, UserInterface $user): bool{// Check the user's password, return true if it's valid// For example:// return $this->passwordEncoder->isPasswordValid($user, $credentials['password']);return true;}public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $providerKey): ?RedirectResponse{if ($targetPath = $this->getTargetPath($request->getSession(), $providerKey)) {return new RedirectResponse($targetPath);}return new RedirectResponse($this->router->generate('homepage'));}protected function getLoginUrl(): string{return $this->router->generate('app_login');}
}

接下来，创建一个控制器来处理登录请求：

php"><?phpnamespace App\Controller;use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;class SecurityController extends AbstractController
{#[Route('/login', name: 'app_login')]public function login(AuthenticationUtils $authenticationUtils): Response{// get the login error if there is one$error = $authenticationUtils->getLastAuthenticationError();// last username entered by the user$lastUsername = $authenticationUtils->getLastUsername();return $this->render('security/login.html.twig', ['last_username' => $lastUsername, 'error' => $error]);}#[Route('/logout', name: 'app_logout')]public function logout(): void{throw new \Exception('This method can be blank - it will be intercepted by the logout key on your firewall');}
}

创建登录页面模板 templates/security/login.html.twig：

{% extends 'base.html.twig' %}{% block body %}
<h1>Login</h1><form action="{{ path('app_login') }}" method="post"><label for="email">Email:</label><input type="text" id="email" name="_username" value="{{ last_username }}" required autofocus><label for="password">Password:</label><input type="password" id="password" name="_password" required><button type="submit">Login</button>{% if error %}<div>{{ error.messageKey|trans(error.messageData, 'security') }}</div>{% endif %}
</form>
{% endblock %}

六、配置安全策略

为了保护应用程序的某些部分，我们需要配置安全策略。在 config/packages/security.yaml 文件中进行以下配置：

security:encoders:App\Entity\User:algorithm: autoproviders:app_user_provider:entity:class: App\Entity\Userproperty: emailfirewalls:dev:pattern: ^/(_(profiler|wdt)|css|images|js)/security: falsemain:anonymous: truelazy: trueprovider: app_user_providerform_login:login_path: app_logincheck_path: app_logincsrf_token_generator: security.csrf.token_managerlogout:path: app_logouttarget: /access_control:- { path: ^/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }- { path: ^/register, roles: IS_AUTHENTICATED_ANONYMOUSLY }- { path: ^/, roles: ROLE_USER }

七、实现角色授权

在许多应用程序中，用户的权限根据其角色而不同。我们可以在用户实体中定义角色，并在控制器中根据角色进行授权。例如：

php"><?phpnamespace App\Controller;use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;class AdminController extends AbstractController
{#[Route('/admin', name: 'admin')]#[IsGranted('ROLE_ADMIN')]public function index(): Response{return new Response('Admin area');}
}

在上述示例中，只有具有 ROLE_ADMIN 角色的用户才能访问 /admin 路由。

八、保护特定资源

您可以使用注释来保护特定的控制器方法。例如：

php"><?phpnamespace App\Controller;use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\IsGranted;class AccountController extends AbstractController
{#[Route('/account', name: 'account')]#[IsGranted('ROLE_USER')]public function index(): Response{return new Response('Account area');}
}

在上述示例中，只有具有 ROLE_USER 角色的用户才能访问 /account 路由。

九、总结

本文详细介绍了在 Symfony 中实现用户认证与授权的全过程。从项目初始化、创建用户实体、配置数据库、实现用户注册和登录功能，到配置安全策略和实现角色授权，涵盖了每个步骤的具体代码和配置示例。通过这些示例，您可以全面掌握在 Symfony 中实现安全控制的技巧，为构建安全的 Web 应用程序奠定坚实的基础。

希望本文能对您有所帮助，如果您有任何问题或需要进一步的帮助，请随时与我联系。


http://www.ppmy.cn/embedded/90802.html

相关文章

新版本matlab将模糊PID规则表导出离线查询表

新版本matlab将模糊PID规则表导出离线查询表

前言 为了将仿真的模糊PID规则应用到硬件现实中去,需要把模糊PID规则表导出为离线查询表的模式,对于这个问题在很久之前就有人尝试解决过. 🚪:李会先.如何在MATLAB下把模糊推理系统转化为查询表（原创） 🚪:李会先.在SIMULINK里把模糊控制逻辑生成查询表（原创） 最先提…
阅读更多...
Android网络编程中的Http协议总结

Android网络编程中的Http协议总结

1.Android与互联网交互的三种方式 2.初识Http协议 实际开发中我们和服务端打交道一般用得都是基于Http协议的通信&#xff0c;所以学好Http协议是非常 重要的&#xff0c;当然&#xff0c;我们不用过于考究一些细节的东西&#xff0c;有个大体的了解即可&#xff01;都是一些概…
阅读更多...
医院体检信息管理系统，C#体检系统源码，健康体检系统PEIS

医院体检信息管理系统，C#体检系统源码，健康体检系统PEIS

体检服务全流程 检前 检前注意事项提醒-体检预约-套餐选择-体检签到-费用缴纳 检中 科室队列提醒-增项检中支付 检后 报告查询-体检百科-报告解读-问卷调查 体检管理系统模块介绍 一、登记管理模块 登记体检者基本信息&#xff0c;包括唯一的体检编号&#xff0c;姓名、…
阅读更多...
机器学习用python还是R，哪个更好？

机器学习用python还是R，哪个更好？

选择使用Python还是R进行机器学习取决于多个因素，包括您的具体需求、项目要求、个人偏好以及团队的技能水平。以下是一些关键点，可以帮助您做出决定： Python的优势 广泛使用：Python是目前最流行的编程语言之一，特别是在数据科学和机器学习领域。它有一个庞大的社区和丰富…
阅读更多...
MyBatis-Plus知识笔记

MyBatis-Plus知识笔记

一、mybatis-plus导入依赖 SpringBoot2导入依赖 <dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.7</version> </dependency> SpringBoot3导入依赖 <dep…
阅读更多...
python学习(day1)

python学习(day1)

1.Python 是大小写敏感的语言。 比如 print 函数名&#xff0c;该函数定义就是全部小写的&#xff0c; 不能写成 Print 或者 PRINT。 2.在Python语言中也会涉及到 对象&#xff0c; 这些对象包含了一定的数据信息。 Python语言中&#xff0c;所有的 数据 都被称之为 对象。 …
阅读更多...
C#初级——List 容器

C#初级——List 容器

容器 在C#中&#xff0c;容器通常指的是用于存储和组织数据的集合类。 本文介绍的容器是动态数组&#xff1a;List<T> 内部使用数组来存储元素&#xff0c;当添加元素超出当前数组容量时&#xff0c;会自动调整大小&#xff08;扩容&#xff09;。 list容器 List<&g…
阅读更多...
C++商店管理系统

C++商店管理系统

代码中使用了C11的特性 后面有些输出(cout输出的)的提示文本是英文&#xff0c;因为懒得敲中文 源码在最后面 文末投票参与一下谢谢 商品数据保存在 items.txt 用户数据保存在 users.txt 实现功能 1.添加商品&#xff08;商品ID,商品名&#xff0c;库存数量&#xff0c;价格&a…
阅读更多...
最新文章

Copyright @ 2022~2023