README

基于Evan Coury和ZF-Commons团队开发的ZfcUser

介绍

LmcUser是Laminas的用户注册和认证模块。LmcUser为向您的Laminas网站添加用户认证和注册提供了基础。它设计得非常简单，易于扩展。

更多信息和示例可以在LmcUser Wiki中找到

要求

Laminas (最新master版本)

功能/目标

通过用户名、电子邮件或两者同时认证（可以选择不使用用户名，仅使用电子邮件）[完成]
用户注册[完成]
表单保护免受CSRF攻击[完成]
开箱即用的Doctrine2 和 Laminas\Db支持[完成]
强大的事件系统，允许扩展[完成]
提供ActionController插件和视图助手[完成]

安装

主要设置

使用Composer

在您的composer.json中添加此项目

"require": {  
    "lm-commons/lmc-user": "^3.1"  
}

现在运行以下命令来让Composer下载LmcUser
```
$ php composer.phar update
```

安装后

在您的application.config.php文件中启用它。

<?php
return [
    'modules' => [
        // ...
        'LmcUser',
    ],
    // ...
];

安装后：Laminas\Db

如果您在服务管理器配置中还没有有效的Laminas\Db\Adapter\Adapter，请在./config/autoload/database.local.php中添加以下内容

<?php
return [
    'db' => [
        'driver'    => 'PdoMysql',
        'hostname'  => 'changeme',
        'database'  => 'changeme',
        'username'  => 'changeme',
        'password'  => 'changeme',
    ],
    'service_manager' =>[
        'factories' => [
            \Laminas\Db\Adapter\Adapter::class => \Laminas\Db\Adapter\AdapterServiceFactory::class,
        ],
    ],
];

导航到http://yourproject/user，您应该会看到一个登录页面。

从ZfcUser迁移

如果使用Zend DB，更新表名为lmc_user

将所有ZfcUser命名空间引用替换为LmcUser

更新对键zfcuser的引用为lmcuser

密码安全性

不要更改密码散列设置默认值，除非A)您已经进行了足够的研究并完全了解您正在更改的内容，并且 B)您有非常具体的理由偏离默认设置。

如果您计划更改默认密码散列设置，请阅读以下内容

可以在任何时候更改密码散列设置，而不会使现有用户帐户无效。现有用户密码将在下一次成功登录时自动重新散列。

警告：更改默认密码散列设置可能会导致严重问题，例如使散列密码更容易受到暴力攻击或使散列过程变得如此昂贵，以至于登录和注册对用户来说太慢，并给您的服务器带来很大负担。提供的默认设置在两者之间提供了非常好的平衡，适合2013年的计算能力。

选项

LmcUser模块提供了一些选项，让您可以快速自定义基本功能。安装LmcUser后，将./vendor/lm-commons/lmc-user/config/lmcuser.global.php.dist复制到./config/autoload/lmcuser.global.php，并根据需要更改值。

以下选项可用

user_entity_class - 要使用的实体类名称。对于使用您自己的实体类而不是提供的默认类很有用。默认值为LmcUser\Entity\User。
enable_username - 布尔值，启用注册表单中的用户名字段。默认值为false。
auth_identity_fields - 数组值，指定用户在登录时可以使用哪些字段作为“身份”字段。可接受的值：username，email。默认值为`false``。
enable_display_name - 布尔值，启用注册表单上的显示名称字段。默认值是 false。
enable_registration - 布尔值，确定用户是否允许注册。默认值是 true。
login_after_registration - 布尔值，用户成功注册后自动登录。默认值是 true。
use_registration_form_captcha - 布尔值，确定用户注册表单上是否使用验证码。默认值是 false。（注意，目前这仅使用弱Laminas\Text\Figlet验证码。）
login_form_timeout - 整数值，指定登录表单的CSRF安全字段的超时时间（秒）。默认值是300秒。
user_form_timeout - 整数值，指定注册表单的CSRF安全字段的超时时间（秒）。默认值是300秒。
use_redirect_parameter_if_present - 布尔值，如果指定了重定向GET参数，且认证成功，用户将被重定向到指定的URL（如果存在，GET参数将覆盖下面指定的login_redirect_route）。默认是 true。
login_redirect_route 字符串值，用户成功登录后被重定向到应用程序中的路由名称。默认是 lmcuser。
logout_redirect_route 字符串值，用户注销后被重定向到应用程序中的路由名称。默认是 lmcuser/login。
password_cost - 这应该是一个介于4和31之间的整数。这个数字表示用于散列的迭代计数的以2为底的对数。默认是 14。
enable_user_state - 布尔值，启用用户状态使用。在注册/登录过程中是否应使用用户状态？默认是 false。
default_user_state - 整数值，注册时的默认用户状态。注册时用户应处于什么状态？默认是 1。
allowed_login_states - 数组值，允许用户登录的状态。当用户尝试登录时，他的状态是否是以下之一？如果要允许没有状态的用户登录，请包含null。默认值是 null 和 1。

更改注册验证码元素

注意这些说明目前已过时。

默认情况下，用户注册使用Figlet验证码引擎。这是因为它是唯一不需要API密钥的验证码引擎。可以通过DI更换验证码引擎。例如，要更换为Recaptcha，您可以将以下内容添加到配置文件之一（global.config.php、module.config.php或recaptcha.config.php）。

<?php
// ./config/autoload/recaptcha.config.php
return  [
    'di'=>  [
        'instance'=> [
            'alias'=> [
                // OTHER ELEMENTS....
                'recaptcha_element' => \Laminas\Form\Element\Captcha::class,
            ],
            'recaptcha_element' =>  [
                'parameters' => [
                    'spec' => 'captcha',
                    'options'=> [
                        'label'      => '',
                        'required'   => true,
                        'order'      => 500,
                        'captcha'    =>  [
                            'captcha' => 'ReCaptcha',
                            'privkey' => RECAPTCHA_PRIVATE_KEY,
                            'pubkey'  => RECAPTCHA_PUBLIC_KEY,
                        ],
                    ],
                ],
            ],
            \LmcUser\Form\Register::class => [
                'parameters' => [
                    'captcha_element'=>'recaptcha_element',
                ],
            ],
        ],
    ],
];

timurturdyev / lmc-user

维护者

详细信息